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
30 /* Internal Headers */
31 static guchar calc_chksum_14(guchar *dta);
32 static int chk_msg14(struct sr_dev_inst *sdi);
34 /** Set or clear flags in devc->mqflags. */
35 static void setmqf(struct dev_context *devc, uint64_t flags, gboolean set)
38 devc->mqflags |= flags;
40 devc->mqflags &= ~flags;
43 /** Decode current type and measured value, Metrahit 12-16. */
44 static void decode_ctmv_16(uint8_t ctmv, struct dev_context *devc)
51 case 0x00: /* 0000 - */
53 case 0x01: /* 0001 mV DC */
54 devc->scale1000 = -1; /* Fall through */
55 case 0x02: /* 0010 V DC */
56 case 0x03: /* 0011 V AC+DC */
57 case 0x04: /* 0100 V AC */
58 devc->mq = SR_MQ_VOLTAGE;
59 devc->unit = SR_UNIT_VOLT;
61 devc->mqflags |= SR_MQFLAG_DC;
63 devc->mqflags |= SR_MQFLAG_AC;
64 if (devc->model >= METRAHIT_16S)
65 devc->mqflags |= SR_MQFLAG_RMS;
68 case 0x05: /* 0101 Hz (15S/16S only) */
69 case 0x06: /* 0110 kHz (15S/16S only) */
70 devc->mq = SR_MQ_FREQUENCY;
71 devc->unit = SR_UNIT_HERTZ;
75 case 0x07: /* 0111 % (15S/16S only) */
76 devc->mq = SR_MQ_DUTY_CYCLE;
77 devc->unit = SR_UNIT_PERCENTAGE;
79 case 0x08: /* 1000 Diode */
80 devc->mq = SR_MQ_VOLTAGE;
81 devc->unit = SR_UNIT_VOLT;
82 devc->mqflags |= SR_MQFLAG_DIODE;
84 case 0x09: /* 1001 Ohm, °C */
85 case 0x0a: /* 1010 kOhm */
86 case 0x0b: /* 1011 MOhm */
87 devc->mq = SR_MQ_RESISTANCE; /* Changed to temp. later if req.*/
88 devc->unit = SR_UNIT_OHM;
89 devc->scale1000 = ctmv - 0x09;
91 case 0x0c: /* 1100 nF (15S/16S only) */
92 case 0x0d: /* 1101 µF (15S/16S only) */
93 devc->mq = SR_MQ_CAPACITANCE;
94 devc->unit = SR_UNIT_FARAD;
100 case 0x0e: /* mA, µA */
101 devc->scale1000 = -1; /* Fall through. */
103 devc->mq = SR_MQ_CURRENT;
104 devc->unit = SR_UNIT_AMPERE;
105 if (devc->model == METRAHIT_16S)
106 devc->mqflags |= SR_MQFLAG_RMS;
107 /* 16I A only with clamp, RMS questionable. */
113 * Decode range/sign/acdc byte special chars (Metrahit 12-16).
115 * @param[in] rs Range and sign byte.
117 static void decode_rs_16(uint8_t rs, struct dev_context *devc)
119 sr_spew("decode_rs_16(%d) scale = %f", rs, devc->scale);
121 if (rs & 0x04) /* Sign */
124 if (devc->mq == SR_MQ_CURRENT) {
125 if (rs & 0x08) /* Current is AC */
126 devc->mqflags |= SR_MQFLAG_AC;
128 devc->mqflags |= SR_MQFLAG_DC;
133 if (devc->mq == SR_MQ_VOLTAGE) /* V */
135 else if (devc->mq == SR_MQ_CURRENT) /* 000.0 µA */
136 devc->scale *= 0.00001;
137 else if (devc->mq == SR_MQ_RESISTANCE) {
138 if (devc->buflen >= 10) {
139 /* °C with 10 byte msg type, otherwise GOhm. */
140 devc->mq = SR_MQ_TEMPERATURE;
141 devc->unit = SR_UNIT_CELSIUS;
143 } else if (devc->scale1000 == 2) {
144 /* 16I Iso 500/1000V 3 GOhm */
150 devc->scale *= 0.0001;
153 devc->scale *= 0.001;
162 * Decode special chars, Metrahit 12-16.
164 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
166 static void decode_spc_16(uint8_t spc, struct dev_context *devc)
169 /* TODO: What does that mean? Power on? The 16I sets this. */
171 /* xxxxxx1x Low battery */
174 setmqf(devc, SR_MQFLAG_MIN, spc & 0x80);
177 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x40));
180 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x20);
183 setmqf(devc, SR_MQFLAG_MAX, spc & 0x10);
186 /** Decode current type and measured value, Metrahit 18. */
187 static void decode_ctmv_18(uint8_t ctmv, struct dev_context *devc)
194 case 0x00: /* 0000 - */
196 case 0x01: /* 0001 V AC */
197 case 0x02: /* 0010 V AC+DC */
198 case 0x03: /* 0011 V DC */
199 devc->mq = SR_MQ_VOLTAGE;
200 devc->unit = SR_UNIT_VOLT;
202 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
204 devc->mqflags |= SR_MQFLAG_DC;
206 case 0x04: /* 0100 Ohm/Ohm with buzzer */
207 devc->mq = SR_MQ_RESISTANCE;
208 devc->unit = SR_UNIT_OHM;
210 case 0x05: /* 0101 Diode/Diode with buzzer */
211 devc->mq = SR_MQ_VOLTAGE;
212 devc->unit = SR_UNIT_VOLT;
213 devc->mqflags |= SR_MQFLAG_DIODE;
215 case 0x06: /* 0110 °C */
216 devc->mq = SR_MQ_TEMPERATURE;
217 devc->unit = SR_UNIT_CELSIUS;
219 case 0x07: /* 0111 F */
220 devc->mq = SR_MQ_CAPACITANCE;
221 devc->unit = SR_UNIT_FARAD;
223 case 0x08: /* 1000 mA DC */
224 case 0x09: /* 1001 A DC */
225 case 0x0a: /* 1010 mA AC+DC */
226 case 0x0b: /* 1011 A AC+DC */
227 devc->mq = SR_MQ_CURRENT;
228 devc->unit = SR_UNIT_AMPERE;
229 devc->mqflags |= SR_MQFLAG_DC;
231 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
232 if ((ctmv == 0x08) || (ctmv == 0x0a))
233 devc->scale1000 = -1;
235 case 0x0c: /* 1100 Hz */
236 devc->mq = SR_MQ_FREQUENCY;
237 devc->unit = SR_UNIT_HERTZ;
239 case 0x0d: /* 1101 dB */
240 devc->mq = SR_MQ_VOLTAGE;
241 devc->unit = SR_UNIT_DECIBEL_VOLT;
242 devc->mqflags |= SR_MQFLAG_AC; /* dB available for AC only */
244 case 0x0e: /* 1110 Events AC, Events AC+DC. Actually delivers just
245 * current voltage via IR, nothing more. */
246 devc->mq = SR_MQ_VOLTAGE;
247 devc->unit = SR_UNIT_VOLT;
248 devc->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS;
250 case 0x0f: /* 1111 Clock */
251 devc->mq = SR_MQ_TIME;
252 devc->unit = SR_UNIT_SECOND;
253 devc->mqflags |= SR_MQFLAG_DURATION;
259 * Decode range/sign/acdc byte special chars, Metrahit 18.
261 * @param[in] rs Range/sign byte.
263 static void decode_rs_18(uint8_t rs, struct dev_context *devc)
268 if (((devc->scale > 0) && (rs & 0x08)) ||
269 ((devc->scale < 0) && !(rs & 0x08)))
276 if (devc->unit == SR_UNIT_DECIBEL_VOLT) {
277 devc->scale *= pow(10.0, -2);
279 * When entering relative mode, the device switches
280 * from 10 byte to 6 byte msg format. Unfortunately
281 * it switches back to 10 byte when the second value
282 * is measured, so that's not sufficient to
283 * identify relative mode.
287 devc->scale *= pow(10.0, range - 5);
290 if (devc->scale1000 == -1)
291 devc->scale *= pow(10.0, range - 5);
293 devc->scale *= pow(10.0, range - 4);
295 case SR_MQ_RESISTANCE:
296 devc->scale *= pow(10.0, range - 2);
298 case SR_MQ_FREQUENCY:
299 devc->scale *= pow(10.0, range - 2);
301 case SR_MQ_TEMPERATURE:
302 devc->scale *= pow(10.0, range - 2);
304 case SR_MQ_CAPACITANCE:
305 devc->scale *= pow(10.0, range - 13);
307 /* TODO: 29S Mains measurements. */
312 * Decode special chars, Metrahit 18.
314 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
316 static void decode_spc_18(uint8_t spc, struct dev_context *devc)
320 /* xxxxxx1x Low battery */
323 if (devc->mq == SR_MQ_TIME) {
324 /* xxx1xxxx Clock running: 1; stop: 0 */
325 sr_spew("Clock running: %d", spc >> 4);
328 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
331 setmqf(devc, SR_MQFLAG_MIN, spc & 0x40);
334 setmqf(devc, SR_MQFLAG_MAX, spc & 0x20);
337 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
342 * Decode current type and measured value, Metrahit 2x.
344 * @param[in] ctmv Current type and measured value (v1 | (v2 << 4)).
346 static void decode_ctmv_2x(uint8_t ctmv, struct dev_context *devc)
348 if ((ctmv > 0x20) || (!devc)) {
349 sr_err("decode_ctmv_2x(0x%x): invalid param(s)!", ctmv);
359 case 0x01: /* 00001 V DC */
360 case 0x02: /* 00010 V AC+DC */
361 case 0x03: /* 00011 V AC */
362 devc->mq = SR_MQ_VOLTAGE;
363 devc->unit = SR_UNIT_VOLT;
365 devc->mqflags |= SR_MQFLAG_DC;
367 devc->mqflags |= SR_MQFLAG_AC;
368 if (devc->model >= METRAHIT_24S)
369 devc->mqflags |= SR_MQFLAG_RMS;
372 case 0x04: /* 00100 mA DC */
373 case 0x05: /* 00101 mA AC+DC */
374 devc->scale1000 = -1;
376 case 0x06: /* 00110 A DC */
377 case 0x07: /* 00111 A AC+DC */
378 devc->mq = SR_MQ_CURRENT;
379 devc->unit = SR_UNIT_AMPERE;
380 devc->mqflags |= SR_MQFLAG_DC;
381 if ((ctmv == 0x05) || (ctmv == 0x07)) {
382 devc->mqflags |= SR_MQFLAG_AC;
383 if (devc->model >= METRAHIT_24S)
384 devc->mqflags |= SR_MQFLAG_RMS;
387 case 0x08: /* 01000 Ohm */
388 devc->mq = SR_MQ_RESISTANCE;
389 devc->unit = SR_UNIT_OHM;
391 case 0x09: /* 01001 F */
392 devc->mq = SR_MQ_CAPACITANCE;
393 devc->unit = SR_UNIT_FARAD;
396 case 0x0a: /* 01010 V dB */
397 devc->mq = SR_MQ_VOLTAGE;
398 devc->unit = SR_UNIT_DECIBEL_VOLT;
399 devc->mqflags |= SR_MQFLAG_AC;
400 if (devc->model >= METRAHIT_24S)
401 devc->mqflags |= SR_MQFLAG_RMS;
403 case 0x0b: /* 01011 Hz U ACDC */
404 case 0x0c: /* 01100 Hz U AC */
405 devc->mq = SR_MQ_FREQUENCY;
406 devc->unit = SR_UNIT_HERTZ;
407 devc->mqflags |= SR_MQFLAG_AC;
409 devc->mqflags |= SR_MQFLAG_DC;
411 case 0x0d: /* 01101 W on power, mA range (29S only) */
414 case 0x0e: /* 01110 W on power, A range (29S only) */
416 devc->scale1000 = -1;
417 devc->mq = SR_MQ_POWER;
418 devc->unit = SR_UNIT_WATT;
419 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
421 case 0x0f: /* 01111 Diode */
422 case 0x10: /* 10000 Diode with buzzer (actually cont. with voltage) */
423 devc->unit = SR_UNIT_VOLT;
425 devc->mq = SR_MQ_VOLTAGE;
426 devc->mqflags |= SR_MQFLAG_DIODE;
428 devc->mq = SR_MQ_CONTINUITY;
429 devc->scale *= 0.00001;
431 devc->unit = SR_UNIT_VOLT;
433 case 0x11: /* 10001 Ohm with buzzer */
434 devc->mq = SR_MQ_CONTINUITY;
435 devc->unit = SR_UNIT_OHM;
436 devc->scale1000 = -1;
438 case 0x12: /* 10010 Temperature */
439 devc->mq = SR_MQ_TEMPERATURE;
440 devc->unit = SR_UNIT_CELSIUS;
441 /* This can be Fahrenheit. That is detected by range=4 later. */
443 /* 0x13 10011 unused */
444 /* 0x14 10100 unused */
445 case 0x15: /* 10101 Press (29S only) */
446 /* TODO: What does that mean? Possibly phase shift?
447 Then we need a unit/flag for it. */
448 devc->mq = SR_MQ_GAIN;
449 devc->unit = SR_UNIT_PERCENTAGE;
451 case 0x16: /* 10110 Pulse W (29S only) */
452 /* TODO: Own unit and flag for this! */
453 devc->mq = SR_MQ_POWER;
454 devc->unit = SR_UNIT_WATT;
456 case 0x17: /* 10111 TRMS V on mains (29S only) */
457 devc->mq = SR_MQ_VOLTAGE;
458 devc->unit = SR_UNIT_VOLT;
459 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
461 case 0x18: /* 11000 Counter (zero crossings of a signal) */
462 devc->mq = SR_MQ_VOLTAGE;
463 devc->unit = SR_UNIT_UNITLESS;
465 case 0x19: /* 11001 Events U ACDC */
466 case 0x1a: /* 11010 Events U AC */
467 /* TODO: No unit or flags for this yet! */
468 devc->mq = SR_MQ_VOLTAGE;
469 devc->unit = SR_UNIT_UNITLESS;
470 devc->mqflags |= SR_MQFLAG_AC;
472 devc->mqflags |= SR_MQFLAG_DC;
474 case 0x1b: /* 11011 Milliamperes in power mode (29S only); error in docs, "pulse on mains" */
475 devc->mq = SR_MQ_CURRENT;
476 devc->unit = SR_UNIT_AMPERE;
477 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
478 devc->scale1000 = -1;
480 case 0x1c: /* 11100 dropout on mains (29S only) */
481 /* TODO: No unit or flags for this yet! */
482 devc->mq = SR_MQ_VOLTAGE;
483 devc->unit = SR_UNIT_UNITLESS;
484 devc->mqflags |= SR_MQFLAG_AC;
486 case 0x1d: /* 11101 Voltage in power mode (29S); undocumented! */
487 devc->mq = SR_MQ_VOLTAGE;
488 devc->unit = SR_UNIT_VOLT;
489 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
491 /* 0x1e: 11110 Undocumented */
492 case 0x1f: /* 11111 25S in stopwatch mode; undocumented!
493 The value is voltage, not time, so treat it such. */
494 devc->mq = SR_MQ_VOLTAGE;
495 devc->unit = SR_UNIT_VOLT;
496 devc->mqflags |= SR_MQFLAG_DC;
498 case 0x20: /* 100000 25S in event count mode; undocumented!
499 Value is 0 anyway. */
500 devc->mq = SR_MQ_VOLTAGE;
501 devc->unit = SR_UNIT_UNITLESS;
504 sr_err("decode_ctmv_2x(%d, ...): Unknown ctmv!", ctmv);
510 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR.
512 * @param[in] rs Range/sign byte.
514 static void decode_rs_2x(uint8_t rs, struct dev_context *devc)
519 if (((devc->scale > 0) && (rs & 0x08)) ||
520 ((devc->scale < 0) && !(rs & 0x08)))
527 if (devc->unit == SR_UNIT_DECIBEL_VOLT)
528 devc->scale *= pow(10.0, -3);
530 devc->scale *= pow(10.0, range - 6);
533 if (devc->scale1000 != -1) /* uA, mA */
534 range += 1;/* mA and A ranges differ by 10^4, not 10^3!*/
535 devc->scale *= pow(10.0, range - 6);
537 case SR_MQ_RESISTANCE:
538 devc->scale *= pow(10.0, range - 3);
540 case SR_MQ_FREQUENCY:
541 devc->scale *= pow(10.0, range - 3);
543 case SR_MQ_TEMPERATURE:
544 if (range == 4) /* Indicator for °F */
545 devc->unit = SR_UNIT_FAHRENHEIT;
546 devc->scale *= pow(10.0, - 2);
548 case SR_MQ_CAPACITANCE:
550 range -= 1; /* Same value as range 6 */
551 devc->scale *= pow(10.0, range - 13);
553 /* TODO: 29S Mains measurements. */
558 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR 2.
560 * @param[in] rs Range/sign byte.
562 static void decode_rs_2x_TR2(uint8_t rs, struct dev_context *devc)
570 if (devc->scale1000 == -1) /* mA */
573 case 1: /* 100, 300 µA */
574 devc->scale *= pow(10.0, -6);
577 case 3: /* 1, 3 mA */
578 devc->scale *= pow(10.0, -5);
581 case 5: /* 10, 30 mA */
582 devc->scale *= pow(10.0, -4);
585 case 7: /* 100, 300 mA */
586 devc->scale *= pow(10.0, -3);
593 devc->scale *= pow(10.0, -5);
596 devc->scale *= pow(10.0, -4);
601 decode_rs_2x(rs, devc);
606 if (((devc->scale > 0) && (rs & 0x08)) ||
607 ((devc->scale < 0) && !(rs & 0x08)))
612 * Decode special chars (Metrahit 2x).
614 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
616 static void decode_spc_2x(uint8_t spc, struct dev_context *devc)
620 /* xxxxxx1x Low battery */
627 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
629 /* x11xxxxx unused */
631 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
634 /** Clean range and sign. */
635 static void clean_rs_v(struct dev_context *devc)
641 /** Clean current type, measured variable, range and sign. */
642 static void clean_ctmv_rs_v(struct dev_context *devc)
651 /** Send prepared value. */
652 static void send_value(struct sr_dev_inst *sdi)
654 struct dev_context *devc;
655 struct sr_datafeed_analog_old analog;
656 struct sr_datafeed_packet packet;
660 memset(&analog, 0, sizeof(struct sr_datafeed_analog_old));
661 analog.channels = sdi->channels;
662 analog.num_samples = 1;
663 analog.mq = devc->mq;
664 analog.unit = devc->unit;
665 analog.mqflags = devc->mqflags;
666 analog.data = &devc->value;
668 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
669 packet.type = SR_DF_ANALOG_OLD;
670 packet.payload = &analog;
671 sr_session_send(devc->cb_data, &packet);
676 /** Process 6-byte data message, Metrahit 1x/2x send mode. */
677 static void process_msg_dta_6(struct sr_dev_inst *sdi)
679 struct dev_context *devc;
686 /* Byte 0, range and sign */
687 if (devc->model <= METRAHIT_16X)
688 decode_rs_16(bc(devc->buf[0]), devc);
689 else if (devc->model < METRAHIT_2X)
690 decode_rs_18(bc(devc->buf[0]), devc);
692 decode_rs_2x(bc(devc->buf[0]), devc);
693 devc->scale *= 10; /* Compensate for format having only 5 digits, decode_rs_2x() assumes 6. */
696 /* Bytes 1-5, digits (ls first). */
697 for (cnt = 0; cnt < 5; cnt++) {
698 dgt = bc(devc->buf[1 + cnt]);
700 /* 10 Overload; on model <= 16X also 11 possible. */
705 devc->value += pow(10.0, cnt) * dgt;
708 sr_spew("process_msg_dta_6() value=%f scale=%f scale1000=%d",
709 devc->value, devc->scale, devc->scale1000);
710 if (devc->value != NAN)
711 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
713 /* Create and send packet. */
717 /** Process 5-byte info message, Metrahit 1x/2x. */
718 static void process_msg_inf_5(struct sr_dev_inst *sdi)
720 struct dev_context *devc;
725 clean_ctmv_rs_v(devc);
728 model = gmc_decode_model_sm(bc(devc->buf[0]));
729 if (model != devc->model) {
730 sr_warn("Model mismatch in data: Detected %s, now %s",
731 gmc_model_str(devc->model), gmc_model_str(model));
734 /* Process bytes 1-4 */
735 if (devc->model <= METRAHIT_16X) {
736 decode_ctmv_16(bc(devc->buf[1]), devc);
737 decode_spc_16(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
738 decode_rs_16(bc(devc->buf[4]), devc);
739 } else if (devc->model <= METRAHIT_18S) {
740 decode_ctmv_18(bc(devc->buf[1]), devc);
741 decode_spc_18(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
742 decode_rs_18(bc(devc->buf[4]), devc);
743 } else { /* Must be Metrahit 2x */
744 decode_ctmv_2x(bc(devc->buf[1]), devc);
745 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
746 decode_rs_2x(bc(devc->buf[4]), devc);
750 /** Process 10-byte info/data message, Metrahit 15+. */
751 static void process_msg_inf_10(struct sr_dev_inst *sdi)
753 struct dev_context *devc;
759 process_msg_inf_5(sdi);
761 /* Now decode numbers */
762 for (cnt = 0; cnt < 5; cnt++) {
763 dgt = bc(devc->buf[5 + cnt]);
764 if (dgt == 11) { /* Empty digit */
767 else if (dgt >= 12) { /* Overload */
772 devc->value += pow(10.0, cnt) * dgt;
774 sr_spew("process_msg_inf_10() value=%f scale=%f scalet=%d",
775 devc->value, devc->scale, devc->scale1000);
777 if (devc->value != NAN)
778 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
780 /* Create and send packet. */
784 /** Decode send interval (Metrahit 2x only). */
785 static const char *decode_send_interval(uint8_t si)
821 return "Unknown value";
825 /** Process 13-byte info/data message, Metrahit 2x. */
826 static void process_msg_inf_13(struct sr_dev_inst *sdi)
828 struct dev_context *devc;
835 clean_ctmv_rs_v(devc);
838 model = gmc_decode_model_sm(bc(devc->buf[0]));
839 if (model != devc->model) {
840 sr_warn("Model mismatch in data: Detected %s, now %s",
841 gmc_model_str(devc->model), gmc_model_str(model));
845 decode_ctmv_2x(bc(devc->buf[1]) | (bc(devc->buf[11]) << 4), devc);
846 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
847 decode_rs_2x(bc(devc->buf[4]), devc);
849 /* Bytes 5-10, digits (ls first). */
850 for (cnt = 0; cnt < 6; cnt++) {
851 dgt = bc(devc->buf[5 + cnt]);
852 if (dgt == 10) { /* Overload */
857 devc->value += pow(10.0, cnt) * dgt;
859 sr_spew("process_msg_inf_13() value=%f scale=%f scale1000=%d mq=%d "
860 "unit=%d mqflags=0x%02" PRIx64, devc->value, devc->scale,
861 devc->scale1000, devc->mq, devc->unit, devc->mqflags);
862 if (devc->value != NAN)
863 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
865 /* Byte 12, Send Interval */
866 sr_spew("Send interval: %s", decode_send_interval(bc(devc->buf[12])));
868 /* Create and send packet. */
872 /** Dump contents of 14-byte message.
873 * @param buf Pointer to array of 14 data bytes.
874 * @param[in] raw Write only data bytes, no interpretation.
876 void dump_msg14(guchar *buf, gboolean raw)
882 sr_spew("msg14: 0x %02x %02x %02x %02x %02x %02x %02x %02x "
883 "%02x %02x %02x %02x %02x %02x",
884 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
885 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12],
888 sr_spew("msg14: 0x a=%d c1=%02x c2=%02x cmd=%02x dta=%02x "
889 "%02x %02x %02x %02x %02x %02x %02x %02x chs=%02x",
890 buf[1] == 0x2b?buf[0] >> 2:buf[0] % 0x0f, buf[1], buf[2], buf[3], buf[4], buf[5],
891 buf[6], buf[7], buf[8], buf[9], buf[10], buf[11],
895 /** Calc checksum for 14 byte message type.
897 * @param[in] dta Pointer to array of 13 data bytes.
900 static guchar calc_chksum_14(guchar *dta)
904 for (chs = 0, cnt = 0; cnt < (GMC_REPLY_SIZE - 1); cnt++)
907 return (64 - chs) & MASK_6BITS;
910 /** Check 14-byte message, Metrahit 2x. */
911 static int chk_msg14(struct sr_dev_inst *sdi)
913 struct dev_context *devc;
915 gboolean isreq; /* Message is request to multimeter (otherwise response) */
916 uint8_t addr; /* Adaptor address */
920 /* Check parameters and message */
921 if (!sdi || !(devc = sdi->priv))
924 if (devc->buflen != 14) {
925 sr_err("process_msg_14(): Msg len 14 expected!");
929 isreq = devc->buf[1] == 0x2b;
931 addr = devc->buf[0] >> 2;
933 addr = devc->buf[0] & 0x0f;
935 if ((devc->addr != addr) && !(isreq && (addr == 0))) {
936 sr_err("process_msg_14(): Address mismatch, msg for other device!");
940 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");
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%02" PRIx64, 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),
1315 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1319 devc->response_pending = TRUE;
1324 /** Request status from 2x multimeter (msg 3).
1325 * @param[in] power_on Try to power on powered off multimeter by sending additional messages.
1327 int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on)
1329 struct dev_context *devc;
1330 struct sr_serial_dev_inst *serial;
1334 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1337 memset(params, 0, sizeof(params));
1340 create_cmd_14(devc->addr, 3, params, msg);
1343 sr_info("Write some data and wait 3s to turn on powered off device...");
1344 if (serial_write_blocking(serial, msg, sizeof(msg),
1345 serial_timeout(serial, sizeof(msg))) < 0)
1347 g_usleep(1 * 1000 * 1000);
1348 if (serial_write_blocking(serial, msg, sizeof(msg),
1349 serial_timeout(serial, sizeof(msg))) < 0)
1351 g_usleep(1 * 1000 * 1000);
1352 if (serial_write_blocking(serial, msg, sizeof(msg),
1353 serial_timeout(serial, sizeof(msg))) < 0)
1355 g_usleep(1 * 1000 * 1000);
1356 serial_flush(serial);
1359 /* Write message and wait for reply */
1360 devc->req_sent_at = g_get_monotonic_time();
1361 if (serial_write_blocking(serial, msg, sizeof(msg),
1362 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1366 devc->response_pending = TRUE;
1371 /** Decode model in "send mode".
1373 * @param[in] mcode Model code.
1374 * @return Model code.
1376 SR_PRIV int gmc_decode_model_sm(uint8_t mcode)
1379 sr_err("decode_model(%d): Model code 0..15 expected!", mcode);
1380 return METRAHIT_NONE;
1384 case 0x04: /* 0100b */
1385 return METRAHIT_12S;
1386 case 0x08: /* 1000b */
1387 return METRAHIT_13S14A;
1388 case 0x09: /* 1001b */
1389 return METRAHIT_14S;
1390 case 0x0A: /* 1010b */
1391 return METRAHIT_15S;
1392 case 0x0B: /* 1011b */
1393 return METRAHIT_16S;
1394 case 0x06: /* 0110b (undocumented by GMC!) */
1395 return METRAHIT_16I;
1396 case 0x07: /* 0111b (undocumented by GMC!) */
1397 return METRAHIT_16T;
1398 case 0x0D: /* 1101b */
1399 return METRAHIT_18S;
1400 case 0x02: /* 0010b */
1401 return METRAHIT_22SM;
1402 case 0x03: /* 0011b */
1403 return METRAHIT_23S;
1404 case 0x0F: /* 1111b */
1405 return METRAHIT_24S;
1406 case 0x05: /* 0101b */
1407 return METRAHIT_25S;
1408 case 0x01: /* 0001b */
1409 return METRAHIT_26SM;
1410 case 0x0C: /* 1100b */
1411 return METRAHIT_28S;
1412 case 0x0E: /* 1110b */
1413 return METRAHIT_29S;
1415 sr_err("Unknown model code %d!", mcode);
1416 return METRAHIT_NONE;
1420 /** Convert GMC model code in bidirectional mode to sigrok-internal one.
1422 * @param[in] mcode Model code.
1424 * @return Model code.
1426 SR_PRIV int gmc_decode_model_bd(uint8_t mcode)
1428 switch (mcode & 0x1f) {
1431 return METRAHIT_22M;
1433 return METRAHIT_22S;
1435 return METRAHIT_23S;
1437 return METRAHIT_24S;
1439 return METRAHIT_25S;
1442 return METRAHIT_26M;
1444 return METRAHIT_26S;
1446 return METRAHIT_28S;
1448 return METRAHIT_29S;
1450 sr_err("Unknown model code %d!", mcode);
1451 return METRAHIT_NONE;
1455 /** Convert sigrok-internal model code to string.
1457 * @param[in] mcode Model code.
1459 * @return Model code string.
1461 SR_PRIV const char *gmc_model_str(enum model mcode)
1465 return "-uninitialized model variable-";
1467 return "METRAHit 12S";
1468 case METRAHIT_13S14A:
1469 return "METRAHit 13S/14A";
1471 return "METRAHit 14S";
1473 return "METRAHit 15S";
1475 return "METRAHit 16S";
1477 return "METRAHit 16I/16L";
1479 return "METRAHit 16T/16U/KMM2002";
1481 return "METRAHit 18S";
1483 return "METRAHit 22S/M";
1485 return "METRAHit 22S";
1487 return "METRAHit 22M";
1489 return "METRAHit 23S";
1491 return "METRAHit 24S";
1493 return "METRAHit 25S";
1495 return "METRAHit 26S/M";
1497 return "METRAHit 26S";
1499 return "METRAHit 26M";
1501 return "METRAHit 28S";
1503 return "METRAHit 29S";
1505 return "Unknown model code";
1509 /** @copydoc sr_dev_driver.config_set */
1510 SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
1511 const struct sr_channel_group *cg)
1513 struct dev_context *devc;
1519 if (sdi->status != SR_ST_ACTIVE)
1520 return SR_ERR_DEV_CLOSED;
1522 if (!(devc = sdi->priv)) {
1523 sr_err("sdi->priv was NULL.");
1528 case SR_CONF_POWER_OFF:
1529 if (devc->model < METRAHIT_2X)
1531 if (!g_variant_get_boolean(data))
1533 sr_info("Powering device off.");
1535 memset(params, 0, sizeof(params));
1538 create_cmd_14(devc->addr, 6, params, msg);
1539 if (serial_write_blocking(sdi->conn, msg, sizeof(msg),
1540 serial_timeout(sdi->conn, sizeof(msg))) < 0)
1543 g_usleep(2 * 1000 * 1000); /* Wait to ensure transfer before interface switched off. */
1545 case SR_CONF_LIMIT_MSEC:
1546 devc->limit_msec = g_variant_get_uint64(data);
1548 case SR_CONF_LIMIT_SAMPLES:
1549 devc->limit_samples = g_variant_get_uint64(data);