]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/korad-kaxxxxp/api.c
Korad-kaxxxxp: Add model Tenma 72-2550
[libsigrok.git] / src / hardware / korad-kaxxxxp / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Hannu Vuolasaho <vuokkosetae@gmail.com>
5 * Copyright (C) 2018-2019 Frank Stettner <frank-stettner@gmx.net>
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <config.h>
22#include "protocol.h"
23
24static const uint32_t scanopts[] = {
25 SR_CONF_CONN,
26 SR_CONF_SERIALCOMM,
27};
28
29static const uint32_t drvopts[] = {
30 SR_CONF_POWER_SUPPLY,
31};
32
33static const uint32_t devopts[] = {
34 SR_CONF_CONTINUOUS,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_VOLTAGE | SR_CONF_GET,
38 SR_CONF_VOLTAGE_TARGET | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
39 SR_CONF_CURRENT | SR_CONF_GET,
40 SR_CONF_CURRENT_LIMIT | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_ENABLED | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_REGULATION | SR_CONF_GET,
43 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
44 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED | SR_CONF_GET | SR_CONF_SET,
45};
46
47static const struct korad_kaxxxxp_model models[] = {
48 /* Device enum, vendor, model, ID reply, channels, voltage, current */
49 {VELLEMAN_PS3005D, "Velleman", "PS3005D",
50 "VELLEMANPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
51 {VELLEMAN_LABPS3005D, "Velleman", "LABPS3005D",
52 "VELLEMANLABPS3005DV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
53 {KORAD_KA3005P, "Korad", "KA3005P",
54 "KORADKA3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
55 /* Sometimes the KA3005P has an extra 0x01 after the ID. */
56 {KORAD_KA3005P_0X01, "Korad", "KA3005P",
57 "KORADKA3005PV2.0\x01", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
58 /* Sometimes the KA3005P has an extra 0xBC after the ID. */
59 {KORAD_KA3005P_0XBC, "Korad", "KA3005P",
60 "KORADKA3005PV2.0\xBC", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
61 {KORAD_KA3005P_V42, "Korad", "KA3005P",
62 "KORAD KA3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
63 {KORAD_KA3005P_V55, "Korad", "KA3005P",
64 "KORAD KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
65 {KORAD_KD3005P, "Korad", "KD3005P",
66 "KORAD KD3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
67 {KORAD_KD3005P_V20_NOSP, "Korad", "KD3005P",
68 "KORADKD3005PV2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
69 {RND_320_KD3005P, "RND", "KD3005P",
70 "RND 320-KD3005P V4.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
71 {RND_320_KA3005P, "RND", "KA3005P",
72 "RND 320-KA3005P V5.5", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
73 {RND_320K30PV, "RND", "KA3005P",
74 "RND 320-KA3005P V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
75 {TENMA_72_2550_V2, "Tenma", "72-2550",
76 "TENMA72-2550V2.0", 1, {0, 61, 0.01}, {0, 3.1, 0.001}},
77 {TENMA_72_2540_V20, "Tenma", "72-2540",
78 "TENMA72-2540V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
79 {TENMA_72_2540_V21, "Tenma", "72-2540",
80 "TENMA 72-2540 V2.1", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
81 {TENMA_72_2540_V52, "Tenma", "72-2540",
82 "TENMA 72-2540 V5.2", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
83 {TENMA_72_2535_V21, "Tenma", "72-2535",
84 "TENMA 72-2535 V2.1", 1, {0, 31, 0.01}, {0, 3.1, 0.001}},
85 {STAMOS_SLS31_V20, "Stamos Soldering", "S-LS-31",
86 "S-LS-31 V2.0", 1, {0, 31, 0.01}, {0, 5.1, 0.001}},
87 {KORAD_KD6005P, "Korad", "KD6005P",
88 "KORAD KD6005P V2.2", 1, {0, 61, 0.01}, {0, 5.1, 0.001}},
89 ALL_ZERO
90};
91
92static GSList *scan(struct sr_dev_driver *di, GSList *options)
93{
94 struct dev_context *devc;
95 GSList *l;
96 struct sr_dev_inst *sdi;
97 struct sr_config *src;
98 const char *conn, *serialcomm;
99 struct sr_serial_dev_inst *serial;
100 char reply[50];
101 int i, model_id;
102 unsigned int len;
103
104 conn = NULL;
105 serialcomm = NULL;
106
107 for (l = options; l; l = l->next) {
108 src = l->data;
109 switch (src->key) {
110 case SR_CONF_CONN:
111 conn = g_variant_get_string(src->data, NULL);
112 break;
113 case SR_CONF_SERIALCOMM:
114 serialcomm = g_variant_get_string(src->data, NULL);
115 break;
116 default:
117 sr_err("Unknown option %d, skipping.", src->key);
118 break;
119 }
120 }
121
122 if (!conn)
123 return NULL;
124 if (!serialcomm)
125 serialcomm = "9600/8n1";
126
127 serial = sr_serial_dev_inst_new(conn, serialcomm);
128 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
129 return NULL;
130
131 serial_flush(serial);
132
133 /* Get the device model. */
134 len = 0;
135 for (i = 0; models[i].id; i++) {
136 if (strlen(models[i].id) > len)
137 len = strlen(models[i].id);
138 }
139
140 /*
141 * Some models also include the serial number:
142 * RND 320-KD3005P V4.2 SN:59834414
143 */
144 len += 12;
145
146 memset(&reply, 0, sizeof(reply));
147 sr_dbg("Want max %d bytes.", len);
148 if ((korad_kaxxxxp_send_cmd(serial, "*IDN?") < 0))
149 return NULL;
150
151 /* i is used here for debug purposes only. */
152 if ((i = korad_kaxxxxp_read_chars(serial, len, reply)) < 0)
153 return NULL;
154 sr_dbg("Received: %d, %s", i, reply);
155 model_id = -1;
156
157 /* Truncate before serial number. */
158 char *sn = g_strrstr(reply, " SN:");
159 if (sn)
160 *sn = '\0';
161
162 for (i = 0; models[i].id; i++) {
163 if (!g_strcmp0(models[i].id, reply))
164 model_id = i;
165 }
166 if (model_id < 0) {
167 sr_err("Unknown model ID '%s' detected, aborting.", reply);
168 return NULL;
169 }
170 sr_dbg("Found: %s %s (idx %d, ID '%s').", models[model_id].vendor,
171 models[model_id].name, model_id, models[model_id].id);
172
173 sdi = g_malloc0(sizeof(struct sr_dev_inst));
174 sdi->status = SR_ST_INACTIVE;
175 sdi->vendor = g_strdup(models[model_id].vendor);
176 sdi->model = g_strdup(models[model_id].name);
177 sdi->inst_type = SR_INST_SERIAL;
178 sdi->conn = serial;
179
180 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "V");
181 sr_channel_new(sdi, 1, SR_CHANNEL_ANALOG, TRUE, "I");
182
183 devc = g_malloc0(sizeof(struct dev_context));
184 sr_sw_limits_init(&devc->limits);
185 g_mutex_init(&devc->rw_mutex);
186 devc->model = &models[model_id];
187 devc->req_sent_at = 0;
188 devc->cc_mode_1_changed = FALSE;
189 devc->cc_mode_2_changed = FALSE;
190 devc->output_enabled_changed = FALSE;
191 devc->ocp_enabled_changed = FALSE;
192 devc->ovp_enabled_changed = FALSE;
193 sdi->priv = devc;
194
195 /* Get current status of device. */
196 if (korad_kaxxxxp_get_all_values(serial, devc) < 0)
197 goto exit_err;
198
199 serial_close(serial);
200
201 return std_scan_complete(di, g_slist_append(NULL, sdi));
202
203exit_err:
204 sr_dev_inst_free(sdi);
205 g_free(devc);
206 sr_dbg("Scan failed.");
207
208 return NULL;
209}
210
211static int config_get(uint32_t key, GVariant **data,
212 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
213{
214 struct dev_context *devc;
215
216 (void)cg;
217
218 if (!sdi || !data)
219 return SR_ERR_ARG;
220
221 devc = sdi->priv;
222
223 switch (key) {
224 case SR_CONF_LIMIT_SAMPLES:
225 case SR_CONF_LIMIT_MSEC:
226 return sr_sw_limits_config_get(&devc->limits, key, data);
227 case SR_CONF_VOLTAGE:
228 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE, devc);
229 *data = g_variant_new_double(devc->voltage);
230 break;
231 case SR_CONF_VOLTAGE_TARGET:
232 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc);
233 *data = g_variant_new_double(devc->voltage_target);
234 break;
235 case SR_CONF_CURRENT:
236 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT, devc);
237 *data = g_variant_new_double(devc->current);
238 break;
239 case SR_CONF_CURRENT_LIMIT:
240 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc);
241 *data = g_variant_new_double(devc->current_limit);
242 break;
243 case SR_CONF_ENABLED:
244 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OUTPUT, devc);
245 *data = g_variant_new_boolean(devc->output_enabled);
246 break;
247 case SR_CONF_REGULATION:
248 /* Dual channel not supported. */
249 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_STATUS, devc);
250 *data = g_variant_new_string((devc->cc_mode[0]) ? "CC" : "CV");
251 break;
252 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
253 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OCP, devc);
254 *data = g_variant_new_boolean(devc->ocp_enabled);
255 break;
256 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
257 korad_kaxxxxp_get_value(sdi->conn, KAXXXXP_OVP, devc);
258 *data = g_variant_new_boolean(devc->ovp_enabled);
259 break;
260 default:
261 return SR_ERR_NA;
262 }
263
264 return SR_OK;
265}
266
267static int config_set(uint32_t key, GVariant *data,
268 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
269{
270 struct dev_context *devc;
271 double dval;
272 gboolean bval;
273
274 (void)cg;
275
276 devc = sdi->priv;
277
278 switch (key) {
279 case SR_CONF_LIMIT_MSEC:
280 case SR_CONF_LIMIT_SAMPLES:
281 return sr_sw_limits_config_set(&devc->limits, key, data);
282 case SR_CONF_VOLTAGE_TARGET:
283 dval = g_variant_get_double(data);
284 if (dval < devc->model->voltage[0] || dval > devc->model->voltage[1])
285 return SR_ERR_ARG;
286 devc->set_voltage_target = dval;
287 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_VOLTAGE_TARGET, devc) < 0)
288 return SR_ERR;
289 break;
290 case SR_CONF_CURRENT_LIMIT:
291 dval = g_variant_get_double(data);
292 if (dval < devc->model->current[0] || dval > devc->model->current[1])
293 return SR_ERR_ARG;
294 devc->set_current_limit = dval;
295 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_CURRENT_LIMIT, devc) < 0)
296 return SR_ERR;
297 break;
298 case SR_CONF_ENABLED:
299 bval = g_variant_get_boolean(data);
300 /* Set always so it is possible turn off with sigrok-cli. */
301 devc->set_output_enabled = bval;
302 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OUTPUT, devc) < 0)
303 return SR_ERR;
304 break;
305 case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
306 bval = g_variant_get_boolean(data);
307 devc->set_ocp_enabled = bval;
308 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OCP, devc) < 0)
309 return SR_ERR;
310 break;
311 case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
312 bval = g_variant_get_boolean(data);
313 devc->set_ovp_enabled = bval;
314 if (korad_kaxxxxp_set_value(sdi->conn, KAXXXXP_OVP, devc) < 0)
315 return SR_ERR;
316 break;
317 default:
318 return SR_ERR_NA;
319 }
320
321 return SR_OK;
322}
323
324static int config_list(uint32_t key, GVariant **data,
325 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
326{
327 struct dev_context *devc;
328
329 devc = (sdi) ? sdi->priv : NULL;
330
331 switch (key) {
332 case SR_CONF_SCAN_OPTIONS:
333 case SR_CONF_DEVICE_OPTIONS:
334 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
335 case SR_CONF_VOLTAGE_TARGET:
336 if (!devc || !devc->model)
337 return SR_ERR_ARG;
338 *data = std_gvar_min_max_step_array(devc->model->voltage);
339 break;
340 case SR_CONF_CURRENT_LIMIT:
341 if (!devc || !devc->model)
342 return SR_ERR_ARG;
343 *data = std_gvar_min_max_step_array(devc->model->current);
344 break;
345 default:
346 return SR_ERR_NA;
347 }
348
349 return SR_OK;
350}
351
352static int dev_close(struct sr_dev_inst *sdi)
353{
354 struct dev_context *devc;
355
356 devc = (sdi) ? sdi->priv : NULL;
357 if (devc)
358 g_mutex_clear(&devc->rw_mutex);
359
360 return std_serial_dev_close(sdi);
361}
362
363static int dev_acquisition_start(const struct sr_dev_inst *sdi)
364{
365 struct dev_context *devc;
366 struct sr_serial_dev_inst *serial;
367
368 devc = sdi->priv;
369
370 sr_sw_limits_acquisition_start(&devc->limits);
371 std_session_send_df_header(sdi);
372
373 devc->req_sent_at = 0;
374 serial = sdi->conn;
375 serial_source_add(sdi->session, serial, G_IO_IN,
376 KAXXXXP_POLL_INTERVAL_MS,
377 korad_kaxxxxp_receive_data, (void *)sdi);
378
379 return SR_OK;
380}
381
382static struct sr_dev_driver korad_kaxxxxp_driver_info = {
383 .name = "korad-kaxxxxp",
384 .longname = "Korad KAxxxxP",
385 .api_version = 1,
386 .init = std_init,
387 .cleanup = std_cleanup,
388 .scan = scan,
389 .dev_list = std_dev_list,
390 .dev_clear = std_dev_clear,
391 .config_get = config_get,
392 .config_set = config_set,
393 .config_list = config_list,
394 .dev_open = std_serial_dev_open,
395 .dev_close = dev_close,
396 .dev_acquisition_start = dev_acquisition_start,
397 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
398 .context = NULL,
399};
400SR_REGISTER_DEV_DRIVER(korad_kaxxxxp_driver_info);