]> sigrok.org Git - libsigrok.git/blame - hardware/fluke-dmm/fluke.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / hardware / fluke-dmm / fluke.c
CommitLineData
d38d2ef0 1/*
50985c20 2 * This file is part of the libsigrok project.
d38d2ef0
BV
3 *
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
d38d2ef0
BV
20#include <stdlib.h>
21#include <math.h>
22#include <string.h>
23#include <errno.h>
4cea0ff7
BV
24#include <glib.h>
25#include "libsigrok.h"
26#include "libsigrok-internal.h"
27#include "fluke-dmm.h"
d38d2ef0 28
4cea0ff7 29static struct sr_datafeed_analog *handle_qm_18x(const struct sr_dev_inst *sdi,
fe31f8b9
BV
30 char **tokens)
31{
32 struct sr_datafeed_analog *analog;
33 float fvalue;
34 char *e, *u;
35 gboolean is_oor;
36
4cea0ff7 37 if (strcmp(tokens[0], "QM") || !tokens[1])
fe31f8b9
BV
38 return NULL;
39
40 if ((e = strstr(tokens[1], "Out of range"))) {
41 is_oor = TRUE;
42 fvalue = -1;
357e341d
BV
43 while(*e && *e != '.')
44 e++;
fe31f8b9
BV
45 } else {
46 is_oor = FALSE;
357e341d
BV
47 /* Delimit the float, since sr_atof_ascii() wants only
48 * a valid float here. */
49 e = tokens[1];
50 while(*e && *e != ' ')
51 e++;
52 *e++ = '\0';
53 if (sr_atof_ascii(tokens[1], &fvalue) != SR_OK || fvalue == 0.0) {
fe31f8b9 54 /* Happens all the time, when switching modes. */
31d84da3 55 sr_dbg("Invalid float.");
fe31f8b9
BV
56 return NULL;
57 }
58 }
59 while(*e && *e == ' ')
60 e++;
61
69e19dd7
BV
62 if (!(analog = g_try_malloc0(sizeof(struct sr_datafeed_analog))))
63 return NULL;
64 if (!(analog->data = g_try_malloc(sizeof(float))))
65 return NULL;
ba7dd8bb 66 analog->channels = sdi->channels;
fe31f8b9 67 analog->num_samples = 1;
fe31f8b9
BV
68 if (is_oor)
69 *analog->data = NAN;
70 else
71 *analog->data = fvalue;
72 analog->mq = -1;
73
74 if ((u = strstr(e, "V DC")) || (u = strstr(e, "V AC"))) {
75 analog->mq = SR_MQ_VOLTAGE;
76 analog->unit = SR_UNIT_VOLT;
77 if (!is_oor && e[0] == 'm')
78 *analog->data /= 1000;
79 /* This catches "V AC", "V DC" and "V AC+DC". */
80 if (strstr(u, "AC"))
81 analog->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
82 if (strstr(u, "DC"))
83 analog->mqflags |= SR_MQFLAG_DC;
84 } else if ((u = strstr(e, "dBV")) || (u = strstr(e, "dBm"))) {
85 analog->mq = SR_MQ_VOLTAGE;
86 if (u[2] == 'm')
87 analog->unit = SR_UNIT_DECIBEL_MW;
88 else
89 analog->unit = SR_UNIT_DECIBEL_VOLT;
90 analog->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
91 } else if ((u = strstr(e, "Ohms"))) {
92 analog->mq = SR_MQ_RESISTANCE;
93 analog->unit = SR_UNIT_OHM;
94 if (is_oor)
95 *analog->data = INFINITY;
96 else if (e[0] == 'k')
97 *analog->data *= 1000;
98 else if (e[0] == 'M')
99 *analog->data *= 1000000;
100 } else if (!strcmp(e, "nS")) {
101 analog->mq = SR_MQ_CONDUCTANCE;
102 analog->unit = SR_UNIT_SIEMENS;
103 *analog->data /= 1e+9;
104 } else if ((u = strstr(e, "Farads"))) {
105 analog->mq = SR_MQ_CAPACITANCE;
106 analog->unit = SR_UNIT_FARAD;
107 if (!is_oor) {
108 if (e[0] == 'm')
109 *analog->data /= 1e+3;
110 else if (e[0] == 'u')
111 *analog->data /= 1e+6;
112 else if (e[0] == 'n')
113 *analog->data /= 1e+9;
114 }
115 } else if ((u = strstr(e, "Deg C")) || (u = strstr(e, "Deg F"))) {
116 analog->mq = SR_MQ_TEMPERATURE;
117 if (u[4] == 'C')
118 analog->unit = SR_UNIT_CELSIUS;
119 else
120 analog->unit = SR_UNIT_FAHRENHEIT;
121 } else if ((u = strstr(e, "A AC")) || (u = strstr(e, "A DC"))) {
122 analog->mq = SR_MQ_CURRENT;
123 analog->unit = SR_UNIT_AMPERE;
124 /* This catches "A AC", "A DC" and "A AC+DC". */
125 if (strstr(u, "AC"))
126 analog->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
127 if (strstr(u, "DC"))
128 analog->mqflags |= SR_MQFLAG_DC;
129 if (!is_oor) {
130 if (e[0] == 'm')
131 *analog->data /= 1e+3;
132 else if (e[0] == 'u')
133 *analog->data /= 1e+6;
134 }
135 } else if ((u = strstr(e, "Hz"))) {
136 analog->mq = SR_MQ_FREQUENCY;
137 analog->unit = SR_UNIT_HERTZ;
138 if (e[0] == 'k')
139 *analog->data *= 1e+3;
140 } else if (!strcmp(e, "%")) {
141 analog->mq = SR_MQ_DUTY_CYCLE;
142 analog->unit = SR_UNIT_PERCENTAGE;
143 } else if ((u = strstr(e, "ms"))) {
144 analog->mq = SR_MQ_PULSE_WIDTH;
145 analog->unit = SR_UNIT_SECOND;
146 *analog->data /= 1e+3;
147 }
148
149 if (analog->mq == -1) {
150 /* Not a valid measurement. */
151 g_free(analog->data);
152 g_free(analog);
153 analog = NULL;
154 }
155
156 return analog;
157}
158
4cea0ff7 159static struct sr_datafeed_analog *handle_qm_28x(const struct sr_dev_inst *sdi,
d38d2ef0
BV
160 char **tokens)
161{
162 struct sr_datafeed_analog *analog;
163 float fvalue;
d38d2ef0 164
4cea0ff7
BV
165 if (!tokens[1])
166 return NULL;
167
357e341d
BV
168 if (sr_atof_ascii(tokens[0], &fvalue) != SR_OK || fvalue == 0.0) {
169 sr_err("Invalid float '%s'.", tokens[0]);
d38d2ef0
BV
170 return NULL;
171 }
172
69e19dd7
BV
173 if (!(analog = g_try_malloc0(sizeof(struct sr_datafeed_analog))))
174 return NULL;
175 if (!(analog->data = g_try_malloc(sizeof(float))))
176 return NULL;
ba7dd8bb 177 analog->channels = sdi->channels;
d38d2ef0 178 analog->num_samples = 1;
d38d2ef0
BV
179 *analog->data = fvalue;
180 analog->mq = -1;
181
182 if (!strcmp(tokens[1], "VAC") || !strcmp(tokens[1], "VDC")) {
183 analog->mq = SR_MQ_VOLTAGE;
184 analog->unit = SR_UNIT_VOLT;
185 if (!strcmp(tokens[2], "NORMAL")) {
186 if (tokens[1][1] == 'A') {
187 analog->mqflags |= SR_MQFLAG_AC;
188 analog->mqflags |= SR_MQFLAG_RMS;
189 } else
190 analog->mqflags |= SR_MQFLAG_DC;
191 } else if (!strcmp(tokens[2], "OL") || !strcmp(tokens[2], "OL_MINUS")) {
192 *analog->data = NAN;
193 } else
194 analog->mq = -1;
a28dac0a 195 } else if (!strcmp(tokens[1], "dBV") || !strcmp(tokens[1], "dBm")) {
2c04dede
BV
196 analog->mq = SR_MQ_VOLTAGE;
197 if (tokens[1][2] == 'm')
198 analog->unit = SR_UNIT_DECIBEL_MW;
199 else
200 analog->unit = SR_UNIT_DECIBEL_VOLT;
201 analog->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
a28dac0a 202 } else if (!strcmp(tokens[1], "CEL") || !strcmp(tokens[1], "FAR")) {
d38d2ef0
BV
203 if (!strcmp(tokens[2], "NORMAL")) {
204 analog->mq = SR_MQ_TEMPERATURE;
205 if (tokens[1][0] == 'C')
fe31f8b9 206 analog->unit = SR_UNIT_CELSIUS;
d38d2ef0
BV
207 else
208 analog->unit = SR_UNIT_FAHRENHEIT;
209 }
a28dac0a 210 } else if (!strcmp(tokens[1], "OHM")) {
d38d2ef0
BV
211 if (!strcmp(tokens[3], "NONE")) {
212 analog->mq = SR_MQ_RESISTANCE;
213 analog->unit = SR_UNIT_OHM;
214 if (!strcmp(tokens[2], "OL") || !strcmp(tokens[2], "OL_MINUS")) {
215 *analog->data = INFINITY;
216 } else if (strcmp(tokens[2], "NORMAL"))
217 analog->mq = -1;
218 } else if (!strcmp(tokens[3], "OPEN_CIRCUIT")) {
219 analog->mq = SR_MQ_CONTINUITY;
220 analog->unit = SR_UNIT_BOOLEAN;
221 *analog->data = 0.0;
222 } else if (!strcmp(tokens[3], "SHORT_CIRCUIT")) {
223 analog->mq = SR_MQ_CONTINUITY;
224 analog->unit = SR_UNIT_BOOLEAN;
225 *analog->data = 1.0;
226 }
a28dac0a 227 } else if (!strcmp(tokens[1], "F")
d38d2ef0
BV
228 && !strcmp(tokens[2], "NORMAL")
229 && !strcmp(tokens[3], "NONE")) {
230 analog->mq = SR_MQ_CAPACITANCE;
231 analog->unit = SR_UNIT_FARAD;
232 } else if (!strcmp(tokens[1], "AAC") || !strcmp(tokens[1], "ADC")) {
233 analog->mq = SR_MQ_CURRENT;
234 analog->unit = SR_UNIT_AMPERE;
d38d2ef0
BV
235 if (!strcmp(tokens[2], "NORMAL")) {
236 if (tokens[1][1] == 'A') {
237 analog->mqflags |= SR_MQFLAG_AC;
238 analog->mqflags |= SR_MQFLAG_RMS;
239 } else
240 analog->mqflags |= SR_MQFLAG_DC;
241 } else if (!strcmp(tokens[2], "OL") || !strcmp(tokens[2], "OL_MINUS")) {
242 *analog->data = NAN;
243 } else
244 analog->mq = -1;
245 } if (!strcmp(tokens[1], "Hz") && !strcmp(tokens[2], "NORMAL")) {
246 analog->mq = SR_MQ_FREQUENCY;
247 analog->unit = SR_UNIT_HERTZ;
a28dac0a 248 } else if (!strcmp(tokens[1], "PCT") && !strcmp(tokens[2], "NORMAL")) {
d38d2ef0
BV
249 analog->mq = SR_MQ_DUTY_CYCLE;
250 analog->unit = SR_UNIT_PERCENTAGE;
a28dac0a 251 } else if (!strcmp(tokens[1], "S") && !strcmp(tokens[2], "NORMAL")) {
d38d2ef0
BV
252 analog->mq = SR_MQ_PULSE_WIDTH;
253 analog->unit = SR_UNIT_SECOND;
a28dac0a 254 } else if (!strcmp(tokens[1], "SIE") && !strcmp(tokens[2], "NORMAL")) {
d38d2ef0
BV
255 analog->mq = SR_MQ_CONDUCTANCE;
256 analog->unit = SR_UNIT_SIEMENS;
257 }
258
d38d2ef0
BV
259 if (analog->mq == -1) {
260 /* Not a valid measurement. */
261 g_free(analog->data);
262 g_free(analog);
263 analog = NULL;
264 }
265
266 return analog;
267}
268
11fb7110
BV
269static void handle_qm_19x_meta(const struct sr_dev_inst *sdi, char **tokens)
270{
271 struct dev_context *devc;
272 int meas_type, meas_unit, meas_char, i;
273
274 /* Make sure we have 7 valid tokens. */
275 for (i = 0; tokens[i] && i < 7; i++);
276 if (i != 7)
277 return;
278
279 if (strcmp(tokens[1], "1"))
280 /* Invalid measurement. */
281 return;
282
283 if (strcmp(tokens[2], "3"))
284 /* Only interested in input from the meter mode source. */
285 return;
286
287 devc = sdi->priv;
288
289 /* Measurement type 11 == absolute, 19 = relative */
290 meas_type = strtol(tokens[0], NULL, 10);
291 if (meas_type != 11 && meas_type != 19)
292 /* Device is in some mode we don't support. */
293 return;
294
295 /* We might get metadata for absolute and relative mode (if the device
296 * is in relative mode). In that case, relative takes precedence. */
297 if (meas_type == 11 && devc->meas_type == 19)
298 return;
299
300 meas_unit = strtol(tokens[3], NULL, 10);
301 if (meas_unit == 0)
302 /* Device is turned off. Really. */
303 return;
304 meas_char = strtol(tokens[4], NULL, 10);
305
306 devc->mq = devc->unit = -1;
307 devc->mqflags = 0;
308 switch (meas_unit) {
309 case 1:
310 devc->mq = SR_MQ_VOLTAGE;
311 devc->unit = SR_UNIT_VOLT;
312 if (meas_char == 1)
313 devc->mqflags |= SR_MQFLAG_DC;
314 else if (meas_char == 2)
315 devc->mqflags |= SR_MQFLAG_AC;
316 else if (meas_char == 3)
317 devc->mqflags |= SR_MQFLAG_DC | SR_MQFLAG_AC;
318 else if (meas_char == 15)
319 devc->mqflags |= SR_MQFLAG_DIODE;
320 break;
321 case 2:
322 devc->mq = SR_MQ_CURRENT;
323 devc->unit = SR_UNIT_AMPERE;
324 if (meas_char == 1)
325 devc->mqflags |= SR_MQFLAG_DC;
326 else if (meas_char == 2)
327 devc->mqflags |= SR_MQFLAG_AC;
328 else if (meas_char == 3)
329 devc->mqflags |= SR_MQFLAG_DC | SR_MQFLAG_AC;
330 break;
331 case 3:
332 if (meas_char == 1) {
333 devc->mq = SR_MQ_RESISTANCE;
334 devc->unit = SR_UNIT_OHM;
335 } else if (meas_char == 16) {
336 devc->mq = SR_MQ_CONTINUITY;
337 devc->unit = SR_UNIT_BOOLEAN;
338 }
339 break;
340 case 12:
341 devc->mq = SR_MQ_TEMPERATURE;
342 devc->unit = SR_UNIT_CELSIUS;
343 break;
344 case 13:
345 devc->mq = SR_MQ_TEMPERATURE;
346 devc->unit = SR_UNIT_FAHRENHEIT;
347 break;
348 default:
349 sr_dbg("unknown unit: %d", meas_unit);
350 }
351 if (devc->mq == -1 && devc->unit == -1)
352 return;
353
354 /* If we got here, we know how to interpret the measurement. */
355 devc->meas_type = meas_type;
356 if (meas_type == 11)
357 /* Absolute meter reading. */
358 devc->is_relative = FALSE;
359 else if (!strcmp(tokens[0], "19"))
360 /* Relative meter reading. */
361 devc->is_relative = TRUE;
362
363}
364
365static void handle_qm_19x_data(const struct sr_dev_inst *sdi, char **tokens)
366{
367 struct dev_context *devc;
368 struct sr_datafeed_packet packet;
369 struct sr_datafeed_analog analog;
370 float fvalue;
11fb7110
BV
371
372 if (!strcmp(tokens[0], "9.9E+37")) {
373 /* An invalid measurement shows up on the display as "OL", but
374 * comes through like this. Since comparing 38-digit floats
375 * is rather problematic, we'll cut through this here. */
376 fvalue = NAN;
377 } else {
357e341d 378 if (sr_atof_ascii(tokens[0], &fvalue) != SR_OK || fvalue == 0.0) {
11fb7110
BV
379 sr_err("Invalid float '%s'.", tokens[0]);
380 return;
381 }
382 }
383
384 devc = sdi->priv;
385 if (devc->mq == -1 || devc->unit == -1)
386 /* Don't have valid metadata yet. */
387 return;
388
389
390 if (devc->mq == SR_MQ_RESISTANCE && isnan(fvalue))
391 fvalue = INFINITY;
392 else if (devc->mq == SR_MQ_CONTINUITY) {
393 if (isnan(fvalue))
394 fvalue = 0.0;
395 else
396 fvalue = 1.0;
397 }
398
ba7dd8bb 399 analog.channels = sdi->channels;
11fb7110
BV
400 analog.num_samples = 1;
401 analog.data = &fvalue;
402 analog.mq = devc->mq;
403 analog.unit = devc->unit;
404 analog.mqflags = 0;
405 packet.type = SR_DF_ANALOG;
406 packet.payload = &analog;
407 sr_session_send(devc->cb_data, &packet);
408 devc->num_samples++;
409
410}
411
d38d2ef0
BV
412static void handle_line(const struct sr_dev_inst *sdi)
413{
414 struct dev_context *devc;
919681f0 415 struct sr_serial_dev_inst *serial;
d38d2ef0
BV
416 struct sr_datafeed_packet packet;
417 struct sr_datafeed_analog *analog;
11fb7110
BV
418 int num_tokens, n, i;
419 char cmd[16], **tokens;
d38d2ef0
BV
420
421 devc = sdi->priv;
919681f0 422 serial = sdi->conn;
31d84da3 423 sr_spew("Received line '%s' (%d).", devc->buf, devc->buflen);
d38d2ef0
BV
424
425 if (devc->buflen == 1) {
426 if (devc->buf[0] != '0') {
427 /* Not just a CMD_ACK from the query command. */
31d84da3 428 sr_dbg("Got CMD_ACK '%c'.", devc->buf[0]);
d38d2ef0
BV
429 devc->expect_response = FALSE;
430 }
431 devc->buflen = 0;
432 return;
433 }
434
435 analog = NULL;
436 tokens = g_strsplit(devc->buf, ",", 0);
4cea0ff7 437 if (tokens[0]) {
0bc3ab92 438 if (devc->profile->model == FLUKE_187 || devc->profile->model == FLUKE_189) {
fe31f8b9 439 devc->expect_response = FALSE;
4cea0ff7 440 analog = handle_qm_18x(sdi, tokens);
fe31f8b9 441 } else if (devc->profile->model == FLUKE_287) {
d38d2ef0 442 devc->expect_response = FALSE;
4cea0ff7 443 analog = handle_qm_28x(sdi, tokens);
11fb7110
BV
444 } else if (devc->profile->model == FLUKE_190) {
445 devc->expect_response = FALSE;
446 for (num_tokens = 0; tokens[num_tokens]; num_tokens++);
447 if (num_tokens >= 7) {
448 /* Response to QM: this is a comma-separated list of
449 * fields with metadata about the measurement. This
450 * format can return multiple sets of metadata,
451 * split into sets of 7 tokens each. */
452 devc->meas_type = 0;
453 for (i = 0; i < num_tokens; i += 7)
454 handle_qm_19x_meta(sdi, tokens + i);
455 if (devc->meas_type) {
456 /* Slip the request in now, before the main
457 * timer loop asks for metadata again. */
458 n = sprintf(cmd, "QM %d\r", devc->meas_type);
919681f0 459 if (serial_write(serial, cmd, n) == -1)
11fb7110
BV
460 sr_err("Unable to send QM (measurement): %s.",
461 strerror(errno));
462 }
463 } else {
464 /* Response to QM <n> measurement request. */
465 handle_qm_19x_data(sdi, tokens);
466 }
d38d2ef0 467 }
d38d2ef0
BV
468 }
469 g_strfreev(tokens);
470 devc->buflen = 0;
471
472 if (analog) {
473 /* Got a measurement. */
d38d2ef0
BV
474 packet.type = SR_DF_ANALOG;
475 packet.payload = analog;
476 sr_session_send(devc->cb_data, &packet);
477 devc->num_samples++;
478 g_free(analog->data);
479 g_free(analog);
480 }
481
482}
483
484SR_PRIV int fluke_receive_data(int fd, int revents, void *cb_data)
485{
642e9d62 486 struct sr_dev_inst *sdi;
d38d2ef0 487 struct dev_context *devc;
919681f0 488 struct sr_serial_dev_inst *serial;
d38d2ef0
BV
489 int len;
490 int64_t now, elapsed;
491
58d03f03
BV
492 (void)fd;
493
d38d2ef0
BV
494 if (!(sdi = cb_data))
495 return TRUE;
496
497 if (!(devc = sdi->priv))
498 return TRUE;
499
919681f0 500 serial = sdi->conn;
d38d2ef0
BV
501 if (revents == G_IO_IN) {
502 /* Serial data arrived. */
503 while(FLUKEDMM_BUFSIZE - devc->buflen - 1 > 0) {
919681f0 504 len = serial_read(serial, devc->buf + devc->buflen, 1);
d38d2ef0
BV
505 if (len < 1)
506 break;
507 devc->buflen++;
508 *(devc->buf + devc->buflen) = '\0';
509 if (*(devc->buf + devc->buflen - 1) == '\r') {
510 *(devc->buf + --devc->buflen) = '\0';
511 handle_line(sdi);
512 break;
513 }
514 }
515 }
516
2f1e5c7c 517 if (devc->limit_samples && devc->num_samples >= devc->limit_samples) {
d38d2ef0
BV
518 sdi->driver->dev_acquisition_stop(sdi, cb_data);
519 return TRUE;
520 }
521
522 now = g_get_monotonic_time() / 1000;
523 elapsed = now - devc->cmd_sent_at;
524 /* Send query command at poll_period interval, or after 1 second
d4b11de0
BV
525 * has elapsed. This will make it easier to recover from any
526 * out-of-sync or temporary disconnect issues. */
d38d2ef0 527 if ((devc->expect_response == FALSE && elapsed > devc->profile->poll_period)
d4b11de0 528 || elapsed > devc->profile->timeout) {
919681f0 529 if (serial_write(serial, "QM\r", 3) == -1)
31d84da3 530 sr_err("Unable to send QM: %s.", strerror(errno));
d38d2ef0
BV
531 devc->cmd_sent_at = now;
532 devc->expect_response = TRUE;
533 }
534
535 return TRUE;
536}