2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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.
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.
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/>.
21 * Gossen Metrawatt Metrahit 1x/2x drivers
29 /* Internal Headers */
30 static guchar calc_chksum_14(guchar* dta);
31 static int chk_msg14(struct sr_dev_inst *sdi);
33 /** Set or clear flags in devc->mqflags. */
34 static void setmqf(struct dev_context *devc, uint64_t flags, gboolean set)
37 devc->mqflags |= flags;
39 devc->mqflags &= ~flags;
42 /** Decode current type and measured value, Metrahit 12-16. */
43 static void decode_ctmv_16(uint8_t ctmv, struct dev_context *devc)
50 case 0x00: /* 0000 - */
52 case 0x01: /* 0001 mV DC */
53 devc->scale1000 = -1; /* Fall through */
54 case 0x02: /* 0010 V DC */
55 case 0x03: /* 0011 V AC+DC */
56 case 0x04: /* 0100 V AC */
57 devc->mq = SR_MQ_VOLTAGE;
58 devc->unit = SR_UNIT_VOLT;
60 devc->mqflags |= SR_MQFLAG_DC;
62 devc->mqflags |= SR_MQFLAG_AC;
63 if (devc->model >= METRAHIT_16S)
64 devc->mqflags |= SR_MQFLAG_RMS;
67 case 0x05: /* 0101 Hz (15S/16S only) */
68 case 0x06: /* 0110 kHz (15S/16S only) */
69 devc->mq = SR_MQ_FREQUENCY;
70 devc->unit = SR_UNIT_HERTZ;
74 case 0x07: /* 0111 % (15S/16S only) */
75 devc->mq = SR_MQ_DUTY_CYCLE;
76 devc->unit = SR_UNIT_PERCENTAGE;
78 case 0x08: /* 1000 Diode */
79 devc->mq = SR_MQ_VOLTAGE;
80 devc->unit = SR_UNIT_VOLT;
81 devc->mqflags |= SR_MQFLAG_DIODE;
83 case 0x09: /* 1001 Ohm, °C */
84 case 0x0a: /* 1010 kOhm */
85 case 0x0b: /* 1011 MOhm */
86 devc->mq = SR_MQ_RESISTANCE; /* Changed to temp. later if req.*/
87 devc->unit = SR_UNIT_OHM;
88 devc->scale1000 = ctmv - 0x09;
90 case 0x0c: /* 1100 nF (15S/16S only) */
91 case 0x0d: /* 1101 µF (15S/16S only) */
92 devc->mq = SR_MQ_CAPACITANCE;
93 devc->unit = SR_UNIT_FARAD;
99 case 0x0e: /* mA, µA */
100 devc->scale1000 = -1; /* Fall through. */
102 devc->mq = SR_MQ_CURRENT;
103 devc->unit = SR_UNIT_AMPERE;
104 if (devc->model == METRAHIT_16S)
105 devc->mqflags |= SR_MQFLAG_RMS;
106 /* 16I A only with clamp, RMS questionable. */
112 * Decode range/sign/acdc byte special chars (Metrahit 12-16).
114 * @param[in] rs Range and sign byte.
116 static void decode_rs_16(uint8_t rs, struct dev_context *devc)
118 sr_spew("decode_rs_16(%d) scale = %f", rs, devc->scale);
120 if (rs & 0x04) /* Sign */
123 if (devc->mq == SR_MQ_CURRENT) {
124 if (rs & 0x08) /* Current is AC */
125 devc->mqflags |= SR_MQFLAG_AC;
127 devc->mqflags |= SR_MQFLAG_DC;
132 if (devc->mq == SR_MQ_VOLTAGE) /* V */
134 else if (devc->mq == SR_MQ_CURRENT) /* 000.0 µA */
135 devc->scale *= 0.00001;
136 else if (devc->mq == SR_MQ_RESISTANCE) {
137 if (devc->buflen >= 10) {
138 /* °C with 10 byte msg type, otherwise GOhm. */
139 devc->mq = SR_MQ_TEMPERATURE;
140 devc->unit = SR_UNIT_CELSIUS;
142 } else if (devc->scale1000 == 2) {
143 /* 16I Iso 500/1000V 3 GOhm */
149 devc->scale *= 0.0001;
152 devc->scale *= 0.001;
161 * Decode special chars, Metrahit 12-16.
163 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
165 static void decode_spc_16(uint8_t spc, struct dev_context *devc)
168 /* TODO: What does that mean? Power on? The 16I sets this. */
170 /* xxxxxx1x Low battery */
173 setmqf(devc, SR_MQFLAG_MIN, spc & 0x80);
176 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x40));
179 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x20);
182 setmqf(devc, SR_MQFLAG_MAX, spc & 0x10);
185 /** Decode current type and measured value, Metrahit 18. */
186 static void decode_ctmv_18(uint8_t ctmv, struct dev_context *devc)
193 case 0x00: /* 0000 - */
195 case 0x01: /* 0001 V AC */
196 case 0x02: /* 0010 V AC+DC */
197 case 0x03: /* 0011 V DC */
198 devc->mq = SR_MQ_VOLTAGE;
199 devc->unit = SR_UNIT_VOLT;
201 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
203 devc->mqflags |= SR_MQFLAG_DC;
205 case 0x04: /* 0100 Ohm/Ohm with buzzer */
206 devc->mq = SR_MQ_RESISTANCE;
207 devc->unit = SR_UNIT_OHM;
209 case 0x05: /* 0101 Diode/Diode with buzzer */
210 devc->mq = SR_MQ_VOLTAGE;
211 devc->unit = SR_UNIT_VOLT;
212 devc->mqflags |= SR_MQFLAG_DIODE;
214 case 0x06: /* 0110 °C */
215 devc->mq = SR_MQ_TEMPERATURE;
216 devc->unit = SR_UNIT_CELSIUS;
218 case 0x07: /* 0111 F */
219 devc->mq = SR_MQ_CAPACITANCE;
220 devc->unit = SR_UNIT_FARAD;
222 case 0x08: /* 1000 mA DC */
223 case 0x09: /* 1001 A DC */
224 case 0x0a: /* 1010 mA AC+DC */
225 case 0x0b: /* 1011 A AC+DC */
226 devc->mq = SR_MQ_CURRENT;
227 devc->unit = SR_UNIT_AMPERE;
228 devc->mqflags |= SR_MQFLAG_DC;
230 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
231 if ((ctmv == 0x08) || (ctmv == 0x0a))
232 devc->scale1000 = -1;
234 case 0x0c: /* 1100 Hz */
235 devc->mq = SR_MQ_FREQUENCY;
236 devc->unit = SR_UNIT_HERTZ;
238 case 0x0d: /* 1101 dB */
239 devc->mq = SR_MQ_VOLTAGE;
240 devc->unit = SR_UNIT_DECIBEL_VOLT;
241 devc->mqflags |= SR_MQFLAG_AC; /* dB available for AC only */
243 case 0x0e: /* 1110 Events AC, Events AC+DC. Actually delivers just
244 * current voltage via IR, nothing more. */
245 devc->mq = SR_MQ_VOLTAGE;
246 devc->unit = SR_UNIT_VOLT;
247 devc->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS;
249 case 0x0f: /* 1111 Clock */
250 devc->mq = SR_MQ_TIME;
251 devc->unit = SR_UNIT_SECOND;
252 devc->mqflags |= SR_MQFLAG_DURATION;
258 * Decode range/sign/acdc byte special chars, Metrahit 18.
260 * @param[in] rs Range/sign byte.
262 static void decode_rs_18(uint8_t rs, struct dev_context *devc)
267 if (((devc->scale > 0) && (rs & 0x08)) ||
268 ((devc->scale < 0) && !(rs & 0x08)))
275 if (devc->unit == SR_UNIT_DECIBEL_VOLT) {
276 devc->scale *= pow(10.0, -2);
278 * When entering relative mode, the device switches
279 * from 10 byte to 6 byte msg format. Unfortunately
280 * it switches back to 10 byte when the second value
281 * is measured, so that's not sufficient to
282 * identify relative mode.
286 devc->scale *= pow(10.0, range - 5);
289 if (devc->scale1000 == -1)
290 devc->scale *= pow(10.0, range - 5);
292 devc->scale *= pow(10.0, range - 4);
294 case SR_MQ_RESISTANCE:
295 devc->scale *= pow(10.0, range - 2);
297 case SR_MQ_FREQUENCY:
298 devc->scale *= pow(10.0, range - 2);
300 case SR_MQ_TEMPERATURE:
301 devc->scale *= pow(10.0, range - 2);
303 case SR_MQ_CAPACITANCE:
304 devc->scale *= pow(10.0, range - 13);
306 /* TODO: 29S Mains measurements. */
311 * Decode special chars, Metrahit 18.
313 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
315 static void decode_spc_18(uint8_t spc, struct dev_context *devc)
319 /* xxxxxx1x Low battery */
322 if (devc->mq == SR_MQ_TIME) {
323 /* xxx1xxxx Clock running: 1; stop: 0 */
324 sr_spew("Clock running: %d", spc >> 4);
327 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
330 setmqf(devc, SR_MQFLAG_MIN, spc & 0x40);
333 setmqf(devc, SR_MQFLAG_MAX, spc & 0x20);
336 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
341 * Decode current type and measured value, Metrahit 2x.
343 * @param[in] ctmv Current type and measured value (v1 | (v2 << 4)).
345 static void decode_ctmv_2x(uint8_t ctmv, struct dev_context *devc)
347 if ((ctmv > 0x20) || (!devc)) {
348 sr_err("decode_ctmv_2x(0x%x): invalid param(s)!", ctmv);
358 case 0x01: /* 00001 V DC */
359 case 0x02: /* 00010 V AC+DC */
360 case 0x03: /* 00011 V AC */
361 devc->mq = SR_MQ_VOLTAGE;
362 devc->unit = SR_UNIT_VOLT;
364 devc->mqflags |= SR_MQFLAG_DC;
366 devc->mqflags |= SR_MQFLAG_AC;
367 if (devc->model >= METRAHIT_24S)
368 devc->mqflags |= SR_MQFLAG_RMS;
371 case 0x04: /* 00100 mA DC */
372 case 0x05: /* 00101 mA AC+DC */
373 devc->scale1000 = -1;
375 case 0x06: /* 00110 A DC */
376 case 0x07: /* 00111 A AC+DC */
377 devc->mq = SR_MQ_CURRENT;
378 devc->unit = SR_UNIT_AMPERE;
379 devc->mqflags |= SR_MQFLAG_DC;
380 if ((ctmv == 0x05) || (ctmv == 0x07)) {
381 devc->mqflags |= SR_MQFLAG_AC;
382 if (devc->model >= METRAHIT_24S)
383 devc->mqflags |= SR_MQFLAG_RMS;
386 case 0x08: /* 01000 Ohm */
387 devc->mq = SR_MQ_RESISTANCE;
388 devc->unit = SR_UNIT_OHM;
390 case 0x09: /* 01001 F */
391 devc->mq = SR_MQ_CAPACITANCE;
392 devc->unit = SR_UNIT_FARAD;
395 case 0x0a: /* 01010 V dB */
396 devc->mq = SR_MQ_VOLTAGE;
397 devc->unit = SR_UNIT_DECIBEL_VOLT;
398 devc->mqflags |= SR_MQFLAG_AC;
399 if (devc->model >= METRAHIT_24S)
400 devc->mqflags |= SR_MQFLAG_RMS;
402 case 0x0b: /* 01011 Hz U ACDC */
403 case 0x0c: /* 01100 Hz U AC */
404 devc->mq = SR_MQ_FREQUENCY;
405 devc->unit = SR_UNIT_HERTZ;
406 devc->mqflags |= SR_MQFLAG_AC;
408 devc->mqflags |= SR_MQFLAG_DC;
410 case 0x0d: /* 01101 W on power, mA range (29S only) */
413 case 0x0e: /* 01110 W on power, A range (29S only) */
415 devc->scale1000 = -1;
416 devc->mq = SR_MQ_POWER;
417 devc->unit = SR_UNIT_WATT;
418 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
420 case 0x0f: /* 01111 Diode */
421 case 0x10: /* 10000 Diode with buzzer (actually cont. with voltage) */
422 devc->unit = SR_UNIT_VOLT;
424 devc->mq = SR_MQ_VOLTAGE;
425 devc->mqflags |= SR_MQFLAG_DIODE;
427 devc->mq = SR_MQ_CONTINUITY;
428 devc->scale *= 0.00001;
430 devc->unit = SR_UNIT_VOLT;
432 case 0x11: /* 10001 Ohm with buzzer */
433 devc->mq = SR_MQ_CONTINUITY;
434 devc->unit = SR_UNIT_OHM;
435 devc->scale1000 = -1;
437 case 0x12: /* 10010 Temperature */
438 devc->mq = SR_MQ_TEMPERATURE;
439 devc->unit = SR_UNIT_CELSIUS;
440 /* This can be Fahrenheit. That is detected by range=4 later. */
442 /* 0x13 10011 unused */
443 /* 0x14 10100 unused */
444 case 0x15: /* 10101 Press (29S only) */
445 /* TODO: What does that mean? Possibly phase shift?
446 Then we need a unit/flag for it. */
447 devc->mq = SR_MQ_GAIN;
448 devc->unit = SR_UNIT_PERCENTAGE;
450 case 0x16: /* 10110 Pulse W (29S only) */
451 /* TODO: Own unit and flag for this! */
452 devc->mq = SR_MQ_POWER;
453 devc->unit = SR_UNIT_WATT;
455 case 0x17: /* 10111 TRMS V on mains (29S only) */
456 devc->mq = SR_MQ_VOLTAGE;
457 devc->unit = SR_UNIT_VOLT;
458 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
460 case 0x18: /* 11000 Counter (zero crossings of a signal) */
461 devc->mq = SR_MQ_VOLTAGE;
462 devc->unit = SR_UNIT_UNITLESS;
464 case 0x19: /* 11001 Events U ACDC */
465 case 0x1a: /* 11010 Events U AC */
466 /* TODO: No unit or flags for this yet! */
467 devc->mq = SR_MQ_VOLTAGE;
468 devc->unit = SR_UNIT_UNITLESS;
469 devc->mqflags |= SR_MQFLAG_AC;
471 devc->mqflags |= SR_MQFLAG_DC;
473 case 0x1b: /* 11011 Milliamperes in power mode (29S only); error in docs, "pulse on mains" */
474 devc->mq = SR_MQ_CURRENT;
475 devc->unit = SR_UNIT_AMPERE;
476 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
477 devc->scale1000 = -1;
479 case 0x1c: /* 11100 dropout on mains (29S only) */
480 /* TODO: No unit or flags for this yet! */
481 devc->mq = SR_MQ_VOLTAGE;
482 devc->unit = SR_UNIT_UNITLESS;
483 devc->mqflags |= SR_MQFLAG_AC;
485 case 0x1d: /* 11101 Voltage in power mode (29S); undocumented! */
486 devc->mq = SR_MQ_VOLTAGE;
487 devc->unit = SR_UNIT_VOLT;
488 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
490 /* 0x1e: 11110 Undocumented */
491 case 0x1f: /* 11111 25S in stopwatch mode; undocumented!
492 The value is voltage, not time, so treat it such. */
493 devc->mq = SR_MQ_VOLTAGE;
494 devc->unit = SR_UNIT_VOLT;
495 devc->mqflags |= SR_MQFLAG_DC;
497 case 0x20: /* 100000 25S in event count mode; undocumented!
498 Value is 0 anyway. */
499 devc->mq = SR_MQ_VOLTAGE;
500 devc->unit = SR_UNIT_UNITLESS;
503 sr_err("decode_ctmv_2x(%d, ...): Unknown ctmv!", ctmv);
509 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR.
511 * @param[in] rs Range/sign byte.
513 static void decode_rs_2x(uint8_t rs, struct dev_context *devc)
518 if (((devc->scale > 0) && (rs & 0x08)) ||
519 ((devc->scale < 0) && !(rs & 0x08)))
526 if (devc->unit == SR_UNIT_DECIBEL_VOLT)
527 devc->scale *= pow(10.0, -3);
529 devc->scale *= pow(10.0, range - 6);
532 if (devc->scale1000 != -1) /* uA, mA */
533 range += 1;/* mA and A ranges differ by 10^4, not 10^3!*/
534 devc->scale *= pow(10.0, range - 6);
536 case SR_MQ_RESISTANCE:
537 devc->scale *= pow(10.0, range - 3);
539 case SR_MQ_FREQUENCY:
540 devc->scale *= pow(10.0, range - 3);
542 case SR_MQ_TEMPERATURE:
543 if (range == 4) /* Indicator for °F */
544 devc->unit = SR_UNIT_FAHRENHEIT;
545 devc->scale *= pow(10.0, - 2);
547 case SR_MQ_CAPACITANCE:
549 range -= 1; /* Same value as range 6 */
550 devc->scale *= pow(10.0, range - 13);
552 /* TODO: 29S Mains measurements. */
557 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR 2.
559 * @param[in] rs Range/sign byte.
561 static void decode_rs_2x_TR2(uint8_t rs, struct dev_context *devc)
569 if (devc->scale1000 == -1) /* mA */
572 case 1: /* 100, 300 µA */
573 devc->scale *= pow(10.0, -6);
576 case 3: /* 1, 3 mA */
577 devc->scale *= pow(10.0, -5);
580 case 5: /* 10, 30 mA */
581 devc->scale *= pow(10.0, -4);
584 case 7: /* 100, 300 mA */
585 devc->scale *= pow(10.0, -3);
592 devc->scale *= pow(10.0, -5);
595 devc->scale *= pow(10.0, -4);
600 decode_rs_2x(rs, devc);
605 if (((devc->scale > 0) && (rs & 0x08)) ||
606 ((devc->scale < 0) && !(rs & 0x08)))
611 * Decode special chars (Metrahit 2x).
613 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
615 static void decode_spc_2x(uint8_t spc, struct dev_context *devc)
619 /* xxxxxx1x Low battery */
626 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
628 /* x11xxxxx unused */
630 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
633 /** Clean range and sign. */
634 static void clean_rs_v(struct dev_context *devc)
640 /** Clean current type, measured variable, range and sign. */
641 static void clean_ctmv_rs_v(struct dev_context *devc)
650 /** Send prepared value. */
651 static void send_value(struct sr_dev_inst *sdi)
653 struct dev_context *devc;
654 struct sr_datafeed_analog analog;
655 struct sr_datafeed_packet packet;
659 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
660 analog.channels = sdi->channels;
661 analog.num_samples = 1;
662 analog.mq = devc->mq;
663 analog.unit = devc->unit;
664 analog.mqflags = devc->mqflags;
665 analog.data = &devc->value;
667 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
668 packet.type = SR_DF_ANALOG;
669 packet.payload = &analog;
670 sr_session_send(devc->cb_data, &packet);
675 /** Process 6-byte data message, Metrahit 1x/2x send mode. */
676 static void process_msg_dta_6(struct sr_dev_inst *sdi)
678 struct dev_context *devc;
685 /* Byte 0, range and sign */
686 if (devc->model <= METRAHIT_16X)
687 decode_rs_16(bc(devc->buf[0]), devc);
688 else if (devc->model < METRAHIT_2X)
689 decode_rs_18(bc(devc->buf[0]), devc);
691 decode_rs_2x(bc(devc->buf[0]), devc);
692 devc->scale *= 10; /* Compensate for format having only 5 digits, decode_rs_2x() assumes 6. */
695 /* Bytes 1-5, digits (ls first). */
696 for (cnt = 0; cnt < 5; cnt++) {
697 dgt = bc(devc->buf[1 + cnt]);
699 /* 10 Overload; on model <= 16X also 11 possible. */
704 devc->value += pow(10.0, cnt) * dgt;
707 sr_spew("process_msg_dta_6() value=%f scale=%f scale1000=%d",
708 devc->value, devc->scale, devc->scale1000);
709 if (devc->value != NAN)
710 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
712 /* Create and send packet. */
716 /** Process 5-byte info message, Metrahit 1x/2x. */
717 static void process_msg_inf_5(struct sr_dev_inst *sdi)
719 struct dev_context *devc;
724 clean_ctmv_rs_v(devc);
727 model = gmc_decode_model_sm(bc(devc->buf[0]));
728 if (model != devc->model) {
729 sr_warn("Model mismatch in data: Detected %s, now %s",
730 gmc_model_str(devc->model), gmc_model_str(model));
733 /* Process bytes 1-4 */
734 if (devc->model <= METRAHIT_16X) {
735 decode_ctmv_16(bc(devc->buf[1]), devc);
736 decode_spc_16(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
737 decode_rs_16(bc(devc->buf[4]), devc);
738 } else if (devc->model <= METRAHIT_18S) {
739 decode_ctmv_18(bc(devc->buf[1]), devc);
740 decode_spc_18(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
741 decode_rs_18(bc(devc->buf[4]), devc);
742 } else { /* Must be Metrahit 2x */
743 decode_ctmv_2x(bc(devc->buf[1]), devc);
744 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
745 decode_rs_2x(bc(devc->buf[4]), devc);
749 /** Process 10-byte info/data message, Metrahit 15+. */
750 static void process_msg_inf_10(struct sr_dev_inst *sdi)
752 struct dev_context *devc;
758 process_msg_inf_5(sdi);
760 /* Now decode numbers */
761 for (cnt = 0; cnt < 5; cnt++) {
762 dgt = bc(devc->buf[5 + cnt]);
763 if (dgt == 11) { /* Empty digit */
766 else if (dgt >= 12) { /* Overload */
771 devc->value += pow(10.0, cnt) * dgt;
773 sr_spew("process_msg_inf_10() value=%f scale=%f scalet=%d",
774 devc->value, devc->scale, devc->scale1000);
776 if (devc->value != NAN)
777 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
779 /* Create and send packet. */
783 /** Decode send interval (Metrahit 2x only). */
784 static const char *decode_send_interval(uint8_t si)
820 return "Unknown value";
824 /** Process 13-byte info/data message, Metrahit 2x. */
825 static void process_msg_inf_13(struct sr_dev_inst *sdi)
827 struct dev_context *devc;
834 clean_ctmv_rs_v(devc);
837 model = gmc_decode_model_sm(bc(devc->buf[0]));
838 if (model != devc->model) {
839 sr_warn("Model mismatch in data: Detected %s, now %s",
840 gmc_model_str(devc->model), gmc_model_str(model));
844 decode_ctmv_2x(bc(devc->buf[1]) | (bc(devc->buf[11]) << 4), devc);
845 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
846 decode_rs_2x(bc(devc->buf[4]), devc);
848 /* Bytes 5-10, digits (ls first). */
849 for (cnt = 0; cnt < 6; cnt++) {
850 dgt = bc(devc->buf[5 + cnt]);
851 if (dgt == 10) { /* Overload */
856 devc->value += pow(10.0, cnt) * dgt;
858 sr_spew("process_msg_inf_13() value=%f scale=%f scale1000=%d mq=%d "
859 "unit=%d mqflags=0x%02llx", devc->value, devc->scale,
860 devc->scale1000, devc->mq, devc->unit, devc->mqflags);
861 if (devc->value != NAN)
862 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
864 /* Byte 12, Send Interval */
865 sr_spew("Send interval: %s", decode_send_interval(bc(devc->buf[12])));
867 /* Create and send packet. */
871 /** Dump contents of 14-byte message.
872 * @param buf Pointer to array of 14 data bytes.
873 * @param[in] raw Write only data bytes, no interpretation.
875 void dump_msg14(guchar* buf, gboolean raw)
881 sr_spew("msg14: 0x %02x %02x %02x %02x %02x %02x %02x %02x "
882 "%02x %02x %02x %02x %02x %02x",
883 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
884 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12],
887 sr_spew("msg14: 0x a=%d c1=%02x c2=%02x cmd=%02x dta=%02x "
888 "%02x %02x %02x %02x %02x %02x %02x %02x chs=%02x",
889 buf[1] == 0x2b?buf[0] >> 2:buf[0] % 0x0f, buf[1], buf[2], buf[3], buf[4], buf[5],
890 buf[6], buf[7], buf[8], buf[9], buf[10], buf[11],
894 /** Calc checksum for 14 byte message type.
896 * @param[in] dta Pointer to array of 13 data bytes.
899 static guchar calc_chksum_14(guchar* dta)
903 for (chs = 0, cnt = 0; cnt < (GMC_REPLY_SIZE - 1); cnt++)
906 return (64 - chs) & MASK_6BITS;
909 /** Check 14-byte message, Metrahit 2x. */
910 static int chk_msg14(struct sr_dev_inst *sdi)
912 struct dev_context *devc;
914 gboolean isreq; /* Message is request to multimeter (otherwise response) */
915 uint8_t addr; /* Adaptor address */
919 /* Check parameters and message */
920 if (!sdi || !(devc = sdi->priv))
923 if (devc->buflen != 14) {
924 sr_err("process_msg_14(): Msg len 14 expected!");
928 isreq = devc->buf[1] == 0x2b;
930 addr = devc->buf[0] >> 2;
932 addr = devc->buf[0] & 0x0f;
934 if ((devc->addr != addr) && !(isreq && (addr == 0))) {
935 sr_err("process_msg_14(): Address mismatch, msg for other device!");
939 if (devc->buf[1] == 0) { /* Error msg from device! */
941 switch (devc->buf[2]) {
942 case 1: /* Not used */
943 sr_err("Device: Illegal error code!");
945 case 2: /* Incorrect check sum of received block */
946 sr_err("Device: Incorrect checksum in cmd!");
948 case 3: /* Incorrect length of received block */
949 sr_err("Device: Incorrect block length in cmd!");
951 case 4: /* Incorrect 2nd or 3rd byte */
952 sr_err("Device: Incorrect byte 2 or 3 in cmd!");
954 case 5: /* Parameter out of range */
955 sr_err("Device: Parameter out of range!");
958 sr_err("Device: Unknown error code!");
962 else if (!isreq && ((devc->buf[1] != 0x27) || (devc->buf[2] != 0x3f))) {
963 sr_err("process_msg_14(): byte 1/2 unexpected!");
967 if (calc_chksum_14(devc->buf) != devc->buf[13]) {
968 sr_err("process_msg_14(): Invalid checksum!");
973 dump_msg14(devc->buf, TRUE);
978 /** Check 14-byte message, Metrahit 2x. */
979 SR_PRIV int process_msg14(struct sr_dev_inst *sdi)
981 struct dev_context *devc;
986 if ((retc = chk_msg14(sdi)) != SR_OK)
991 clean_ctmv_rs_v(devc);
992 addr = devc->buf[0] & MASK_6BITS;
993 if (addr != devc->addr)
994 sr_info("Device address mismatch %d/%d!", addr, devc->addr);
996 switch (devc->buf[3]) { /* That's the command this reply is for */
997 /* 0 cannot occur, the respective message is not a 14-byte message */
998 case 1: /* Read first free and occupied address */
999 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1001 case 2: /* Clear all RAM in multimeter */
1002 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1004 case 3: /* Read firmware version and status */
1005 sr_spew("Cmd 3, Read firmware and status", devc->buf[3]);
1006 switch (devc->cmd_idx) {
1008 devc->fw_ver_maj = devc->buf[5];
1009 devc->fw_ver_min = devc->buf[4];
1010 sr_spew("Firmware version %d.%d", (int)devc->fw_ver_maj, (int)devc->fw_ver_min);
1011 sr_spew("Rotary Switch Position (1..10): %d", (int)devc->buf[6]);
1012 /** Docs say values 0..9, but that's not true */
1013 sr_spew("Measurement Function: %d ", (int)devc->buf[7]);
1014 decode_ctmv_2x(devc->buf[7], devc);
1015 sr_spew("Range: 0x%x", devc->buf[8]);
1016 decode_rs_2x_TR2(devc->buf[8] & 0x0f, devc); /* Docs wrong, uses conversion table TR_2! */
1017 devc->autorng = (devc->buf[8] & 0x20) == 0;
1018 // TODO 9, 10: 29S special functions
1019 devc->ubatt = 0.1 * (float)devc->buf[11];
1020 devc->model = gmc_decode_model_bd(devc->buf[12]);
1021 sr_spew("Model=%s, battery voltage=%2.1f V", gmc_model_str(devc->model), (double)devc->ubatt);
1024 sr_spew("Internal version %d.%d", (int)devc->buf[5], (int)devc->buf[4]);
1025 sr_spew("Comm mode: 0x%x", (int)devc->buf[6]);
1026 sr_spew("Block cnt%%64: %d", (int)devc->buf[7]);
1027 sr_spew("drpCi: %d drpCh: %d", (int)devc->buf[8], (int)devc->buf[9]);
1028 // Semantics undocumented. Possibly Metrahit 29S dropouts stuff?
1031 sr_spew("Cmd 3: Unknown cmd_idx=%d", devc->cmd_idx);
1035 case 4: /* Set real time, date, sample rate, trigger, ... */
1036 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1038 case 5: /* Read real time, date, sample rate, trigger... */
1039 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1041 case 6: /* Set modes or power off */
1042 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1044 case 7: /* Set measurement function, range, autom/man. */
1045 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1047 case 8: /* Get one measurement value */
1048 sr_spew("Cmd 8, get one measurement value");
1049 sr_spew("Measurement Function: %d ", (int)devc->buf[5]);
1050 decode_ctmv_2x(devc->buf[5], devc);
1051 if (!(devc->buf[6] & 0x10)) /* If bit4=0, old data. */
1054 decode_rs_2x_TR2(devc->buf[6] & 0x0f, devc); // The docs say conversion table TR_3, but that does not work
1055 setmqf(devc, SR_MQFLAG_AUTORANGE, devc->autorng);
1057 for (cnt = 0; cnt < 6; cnt++) {
1058 dgt = bc(devc->buf[7 + cnt]);
1059 if (dgt == 10) { /* Overload */
1064 else if (dgt == 13) { /* FUSE */
1067 else if (dgt == 14) { /* Function recognition mode, OPEN */
1068 sr_info("Function recognition mode, OPEN!");
1073 devc->value += pow(10.0, cnt) * dgt;
1075 sr_spew("process_msg14() value=%f scale=%f scale1000=%d mq=%d "
1076 "unit=%d mqflags=0x%02llx", devc->value, devc->scale,
1077 devc->scale1000, devc->mq, devc->unit, devc->mqflags);
1078 if (devc->value != NAN)
1079 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
1085 sr_spew("Unknown cmd %d!", devc->buf[3]);
1092 /** Data reception callback function. */
1093 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data)
1095 struct sr_dev_inst *sdi;
1096 struct dev_context *devc;
1097 struct sr_serial_dev_inst *serial;
1104 if (!(sdi = cb_data))
1107 if (!(devc = sdi->priv))
1112 if (revents == G_IO_IN) { /* Serial data arrived. */
1113 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
1114 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
1117 buf = *(devc->buf + devc->buflen);
1118 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MSGC_MASK);
1119 devc->buflen += len;
1120 if (!devc->settings_ok) {
1122 * If no device type/settings record processed
1123 * yet, wait for one.
1125 if ((devc->buf[0] & MSGID_MASK) != MSGID_INF) {
1129 devc->settings_ok = TRUE;
1132 msgt = devc->buf[0] & MSGID_MASK;
1135 if (devc->buflen == 13) {
1136 process_msg_inf_13(sdi);
1139 } else if ((devc->buflen == 10) &&
1140 (devc->model <= METRAHIT_18S)) {
1141 process_msg_inf_10(sdi);
1145 else if ((devc->buflen >= 5) &&
1146 (devc->buf[devc->buflen - 1] &
1147 MSGID_MASK) != MSGID_DATA) {
1149 * Char just received is beginning
1152 process_msg_inf_5(sdi);
1154 devc->buf[devc->buflen - 1];
1161 if (devc->buflen == 6) {
1162 process_msg_dta_6(sdi);
1167 sr_err("Comm error, unexpected data byte!");
1174 /* If number of samples or time limit reached, stop acquisition. */
1175 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples))
1176 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1178 if (devc->limit_msec) {
1179 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
1180 if ((elapsed_s * 1000) >= devc->limit_msec)
1181 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1187 SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data)
1189 struct sr_dev_inst *sdi;
1190 struct dev_context *devc;
1191 struct sr_serial_dev_inst *serial;
1198 if (!(sdi = cb_data))
1201 if (!(devc = sdi->priv))
1206 if (revents == G_IO_IN) { /* Serial data arrived. */
1207 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
1208 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
1211 buf = *(devc->buf + devc->buflen);
1212 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MASK_6BITS);
1213 devc->buf[devc->buflen] &= MASK_6BITS;
1214 devc->buflen += len;
1216 if (devc->buflen == 14) {
1217 devc->response_pending = FALSE;
1218 sr_spew("gmc_mh_2x_receive_data processing msg");
1225 /* If number of samples or time limit reached, stop acquisition. */
1226 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples))
1227 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1229 if (devc->limit_msec) {
1230 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
1231 if ((elapsed_s * 1000) >= devc->limit_msec)
1232 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1235 /* Request next data set, if required */
1236 if (sdi->status == SR_ST_ACTIVE) {
1237 if (devc->response_pending) {
1238 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
1239 if (elapsed_us > (1 * 1000 * 1000)) /* Timeout! */
1240 devc->response_pending = FALSE;
1242 if (!devc->response_pending) {
1244 if (devc->cmd_seq % 10 == 0) {
1245 if (req_stat14(sdi, FALSE) != SR_OK)
1248 else if (req_meas14(sdi) != SR_OK)
1256 /** Create 14 (42) byte command for Metrahit 2x multimeter in bidir mode.
1258 * Actually creates 42 bytes due to the encoding method used.
1259 * @param[in] addr Device address (0=adapter, 1..15 multimeter; for byte 0).
1260 * @param[in] func Function code (byte 3).
1261 * @param[in] params Further parameters (9 bytes)
1262 * @param[out] buf Buffer to create msg in (42 bytes).
1264 void create_cmd_14(guchar addr, guchar func, guchar* params, guchar* buf)
1266 uint8_t dta[GMC_REPLY_SIZE]; /* Unencoded message */
1269 if (!params || !buf)
1273 dta[0] = ((addr << 2) | 0x03) & MASK_6BITS;
1275 /* 1-3: Set command header */
1280 /* 4-12: Copy further parameters */
1281 for (cnt = 0; cnt < 9; cnt++)
1282 dta[cnt + 4] = (params[cnt] & MASK_6BITS);
1284 /* 13: Checksum (b complement) */
1285 dta[13] = calc_chksum_14(dta);
1287 /* The whole message is packed into 3 bytes per byte now (lower 6 bits only) the most
1288 * peculiar way I have ever seen. Possibly to improve IR communication? */
1289 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
1290 buf[(3 * cnt) + 0] = (dta[cnt] & 0x01 ? 0x0f : 0) | (dta[cnt] & 0x02 ? 0xf0 : 0);
1291 buf[(3 * cnt) + 1] = (dta[cnt] & 0x04 ? 0x0f : 0) | (dta[cnt] & 0x08 ? 0xf0 : 0);
1292 buf[(3 * cnt) + 2] = (dta[cnt] & 0x10 ? 0x0f : 0) | (dta[cnt] & 0x20 ? 0xf0 : 0);
1296 /** Request one measurement from 2x multimeter (msg 8).
1299 int req_meas14(const struct sr_dev_inst *sdi)
1301 struct dev_context *devc;
1302 struct sr_serial_dev_inst *serial;
1306 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1309 memset(params, 0, sizeof(params));
1312 create_cmd_14(devc->addr, 8, params, msg);
1313 devc->req_sent_at = g_get_monotonic_time();
1314 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < (int)sizeof(msg)) {
1318 devc->response_pending = TRUE;
1323 /** Request status from 2x multimeter (msg 3).
1324 * @param[in] power_on Try to power on powered off multimeter by sending additional messages.
1326 int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on)
1328 struct dev_context *devc;
1329 struct sr_serial_dev_inst *serial;
1333 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1336 memset(params, 0, sizeof(params));
1339 create_cmd_14(devc->addr, 3, params, msg);
1342 sr_info("Write some data and wait 3s to turn on powered off device...");
1343 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
1345 g_usleep(1 * 1000 * 1000);
1346 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
1348 g_usleep(1 * 1000 * 1000);
1349 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
1351 g_usleep(1 * 1000 * 1000);
1352 serial_flush(serial);
1355 /* Write message and wait for reply */
1356 devc->req_sent_at = g_get_monotonic_time();
1357 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < (int)sizeof(msg)) {
1361 devc->response_pending = TRUE;
1366 /** Decode model in "send mode".
1368 * @param[in] mcode Model code.
1369 * @return Model code.
1371 SR_PRIV int gmc_decode_model_sm(uint8_t mcode)
1374 sr_err("decode_model(%d): Model code 0..15 expected!", mcode);
1375 return METRAHIT_NONE;
1379 case 0x04: /* 0100b */
1380 return METRAHIT_12S;
1381 case 0x08: /* 1000b */
1382 return METRAHIT_13S14A;
1383 case 0x09: /* 1001b */
1384 return METRAHIT_14S;
1385 case 0x0A: /* 1010b */
1386 return METRAHIT_15S;
1387 case 0x0B: /* 1011b */
1388 return METRAHIT_16S;
1389 case 0x06: /* 0110b (undocumented by GMC!) */
1390 return METRAHIT_16I;
1391 case 0x07: /* 0111b (undocumented by GMC!) */
1392 return METRAHIT_16T;
1393 case 0x0D: /* 1101b */
1394 return METRAHIT_18S;
1395 case 0x02: /* 0010b */
1396 return METRAHIT_22SM;
1397 case 0x03: /* 0011b */
1398 return METRAHIT_23S;
1399 case 0x0F: /* 1111b */
1400 return METRAHIT_24S;
1401 case 0x05: /* 0101b */
1402 return METRAHIT_25S;
1403 case 0x01: /* 0001b */
1404 return METRAHIT_26SM;
1405 case 0x0C: /* 1100b */
1406 return METRAHIT_28S;
1407 case 0x0E: /* 1110b */
1408 return METRAHIT_29S;
1410 sr_err("Unknown model code %d!", mcode);
1411 return METRAHIT_NONE;
1415 /** Convert GMC model code in bidirectional mode to sigrok-internal one.
1417 * @param[in] mcode Model code.
1419 * @return Model code.
1421 SR_PRIV int gmc_decode_model_bd(uint8_t mcode)
1423 switch (mcode & 0x1f) {
1426 return METRAHIT_22M;
1428 return METRAHIT_22S;
1430 return METRAHIT_23S;
1432 return METRAHIT_24S;
1434 return METRAHIT_25S;
1437 return METRAHIT_26M;
1439 return METRAHIT_26S;
1441 return METRAHIT_28S;
1443 return METRAHIT_29S;
1445 sr_err("Unknown model code %d!", mcode);
1446 return METRAHIT_NONE;
1450 /** Convert sigrok-internal model code to string.
1452 * @param[in] mcode Model code.
1454 * @return Model code string.
1456 SR_PRIV const char *gmc_model_str(enum model mcode)
1460 return "-uninitialized model variable-";
1462 return "METRAHit 12S";
1463 case METRAHIT_13S14A:
1464 return "METRAHit 13S/14A";
1466 return "METRAHit 14S";
1468 return "METRAHit 15S";
1470 return "METRAHit 16S";
1472 return "METRAHit 16I/16L";
1474 return "METRAHit 16T/16U/KMM2002";
1476 return "METRAHit 18S";
1478 return "METRAHit 22S/M";
1480 return "METRAHit 22S";
1482 return "METRAHit 22M";
1484 return "METRAHit 23S";
1486 return "METRAHit 24S";
1488 return "METRAHit 25S";
1490 return "METRAHit 26S/M";
1492 return "METRAHit 26S";
1494 return "METRAHit 26M";
1496 return "METRAHit 28S";
1498 return "METRAHit 29S";
1500 return "Unknown model code";
1504 /** @copydoc sr_dev_driver.config_set */
1505 SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
1506 const struct sr_channel_group *cg)
1508 struct dev_context *devc;
1514 if (sdi->status != SR_ST_ACTIVE)
1515 return SR_ERR_DEV_CLOSED;
1517 if (!(devc = sdi->priv)) {
1518 sr_err("sdi->priv was NULL.");
1523 case SR_CONF_POWER_OFF:
1524 if (devc->model < METRAHIT_2X)
1526 if (!g_variant_get_boolean(data))
1528 sr_info("Powering device off.");
1530 memset(params, 0, sizeof(params));
1533 create_cmd_14(devc->addr, 6, params, msg);
1534 if (serial_write_blocking(sdi->conn, msg, sizeof(msg), 0) < 0)
1537 g_usleep(2 * 1000 * 1000); /* Wait to ensure transfer before interface switched off. */
1539 case SR_CONF_LIMIT_MSEC:
1540 devc->limit_msec = g_variant_get_uint64(data);
1542 case SR_CONF_LIMIT_SAMPLES:
1543 devc->limit_samples = g_variant_get_uint64(data);