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. */
309 /* Avoid certain compiler warnings due to (-Wswitch). */
315 * Decode special chars, Metrahit 18.
317 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
319 static void decode_spc_18(uint8_t spc, struct dev_context *devc)
323 /* xxxxxx1x Low battery */
326 if (devc->mq == SR_MQ_TIME) {
327 /* xxx1xxxx Clock running: 1; stop: 0 */
328 sr_spew("Clock running: %d", spc >> 4);
331 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
334 setmqf(devc, SR_MQFLAG_MIN, spc & 0x40);
337 setmqf(devc, SR_MQFLAG_MAX, spc & 0x20);
340 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
345 * Decode current type and measured value, Metrahit 2x.
347 * @param[in] ctmv Current type and measured value (v1 | (v2 << 4)).
349 static void decode_ctmv_2x(uint8_t ctmv, struct dev_context *devc)
351 if ((ctmv > 0x20) || (!devc)) {
352 sr_err("decode_ctmv_2x(0x%x): invalid param(s)!", ctmv);
362 case 0x01: /* 00001 V DC */
363 case 0x02: /* 00010 V AC+DC */
364 case 0x03: /* 00011 V AC */
365 devc->mq = SR_MQ_VOLTAGE;
366 devc->unit = SR_UNIT_VOLT;
368 devc->mqflags |= SR_MQFLAG_DC;
370 devc->mqflags |= SR_MQFLAG_AC;
371 if (devc->model >= METRAHIT_24S)
372 devc->mqflags |= SR_MQFLAG_RMS;
375 case 0x04: /* 00100 mA DC */
376 case 0x05: /* 00101 mA AC+DC */
377 devc->scale1000 = -1;
379 case 0x06: /* 00110 A DC */
380 case 0x07: /* 00111 A AC+DC */
381 devc->mq = SR_MQ_CURRENT;
382 devc->unit = SR_UNIT_AMPERE;
383 devc->mqflags |= SR_MQFLAG_DC;
384 if ((ctmv == 0x05) || (ctmv == 0x07)) {
385 devc->mqflags |= SR_MQFLAG_AC;
386 if (devc->model >= METRAHIT_24S)
387 devc->mqflags |= SR_MQFLAG_RMS;
390 case 0x08: /* 01000 Ohm */
391 devc->mq = SR_MQ_RESISTANCE;
392 devc->unit = SR_UNIT_OHM;
394 case 0x09: /* 01001 F */
395 devc->mq = SR_MQ_CAPACITANCE;
396 devc->unit = SR_UNIT_FARAD;
399 case 0x0a: /* 01010 V dB */
400 devc->mq = SR_MQ_VOLTAGE;
401 devc->unit = SR_UNIT_DECIBEL_VOLT;
402 devc->mqflags |= SR_MQFLAG_AC;
403 if (devc->model >= METRAHIT_24S)
404 devc->mqflags |= SR_MQFLAG_RMS;
406 case 0x0b: /* 01011 Hz U ACDC */
407 case 0x0c: /* 01100 Hz U AC */
408 devc->mq = SR_MQ_FREQUENCY;
409 devc->unit = SR_UNIT_HERTZ;
410 devc->mqflags |= SR_MQFLAG_AC;
412 devc->mqflags |= SR_MQFLAG_DC;
414 case 0x0d: /* 01101 W on power, mA range (29S only) */
417 case 0x0e: /* 01110 W on power, A range (29S only) */
419 devc->scale1000 = -1;
420 devc->mq = SR_MQ_POWER;
421 devc->unit = SR_UNIT_WATT;
422 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
424 case 0x0f: /* 01111 Diode */
425 case 0x10: /* 10000 Diode with buzzer (actually cont. with voltage) */
426 devc->unit = SR_UNIT_VOLT;
428 devc->mq = SR_MQ_VOLTAGE;
429 devc->mqflags |= SR_MQFLAG_DIODE;
431 devc->mq = SR_MQ_CONTINUITY;
432 devc->scale *= 0.00001;
434 devc->unit = SR_UNIT_VOLT;
436 case 0x11: /* 10001 Ohm with buzzer */
437 devc->mq = SR_MQ_CONTINUITY;
438 devc->unit = SR_UNIT_OHM;
439 devc->scale1000 = -1;
441 case 0x12: /* 10010 Temperature */
442 devc->mq = SR_MQ_TEMPERATURE;
443 devc->unit = SR_UNIT_CELSIUS;
444 /* This can be Fahrenheit. That is detected by range=4 later. */
446 /* 0x13 10011 unused */
447 /* 0x14 10100 unused */
448 case 0x15: /* 10101 Press (29S only) */
449 /* TODO: What does that mean? Possibly phase shift?
450 Then we need a unit/flag for it. */
451 devc->mq = SR_MQ_GAIN;
452 devc->unit = SR_UNIT_PERCENTAGE;
454 case 0x16: /* 10110 Pulse W (29S only) */
455 /* TODO: Own unit and flag for this! */
456 devc->mq = SR_MQ_POWER;
457 devc->unit = SR_UNIT_WATT;
459 case 0x17: /* 10111 TRMS V on mains (29S only) */
460 devc->mq = SR_MQ_VOLTAGE;
461 devc->unit = SR_UNIT_VOLT;
462 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
464 case 0x18: /* 11000 Counter (zero crossings of a signal) */
465 devc->mq = SR_MQ_VOLTAGE;
466 devc->unit = SR_UNIT_UNITLESS;
468 case 0x19: /* 11001 Events U ACDC */
469 case 0x1a: /* 11010 Events U AC */
470 /* TODO: No unit or flags for this yet! */
471 devc->mq = SR_MQ_VOLTAGE;
472 devc->unit = SR_UNIT_UNITLESS;
473 devc->mqflags |= SR_MQFLAG_AC;
475 devc->mqflags |= SR_MQFLAG_DC;
477 case 0x1b: /* 11011 Milliamperes in power mode (29S only); error in docs, "pulse on mains" */
478 devc->mq = SR_MQ_CURRENT;
479 devc->unit = SR_UNIT_AMPERE;
480 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
481 devc->scale1000 = -1;
483 case 0x1c: /* 11100 dropout on mains (29S only) */
484 /* TODO: No unit or flags for this yet! */
485 devc->mq = SR_MQ_VOLTAGE;
486 devc->unit = SR_UNIT_UNITLESS;
487 devc->mqflags |= SR_MQFLAG_AC;
489 case 0x1d: /* 11101 Voltage in power mode (29S); undocumented! */
490 devc->mq = SR_MQ_VOLTAGE;
491 devc->unit = SR_UNIT_VOLT;
492 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
494 /* 0x1e: 11110 Undocumented */
495 case 0x1f: /* 11111 25S in stopwatch mode; undocumented!
496 The value is voltage, not time, so treat it such. */
497 devc->mq = SR_MQ_VOLTAGE;
498 devc->unit = SR_UNIT_VOLT;
499 devc->mqflags |= SR_MQFLAG_DC;
501 case 0x20: /* 100000 25S in event count mode; undocumented!
502 Value is 0 anyway. */
503 devc->mq = SR_MQ_VOLTAGE;
504 devc->unit = SR_UNIT_UNITLESS;
507 sr_err("decode_ctmv_2x(%d, ...): Unknown ctmv!", ctmv);
513 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR.
515 * @param[in] rs Range/sign byte.
517 static void decode_rs_2x(uint8_t rs, struct dev_context *devc)
522 if (((devc->scale > 0) && (rs & 0x08)) ||
523 ((devc->scale < 0) && !(rs & 0x08)))
530 if (devc->unit == SR_UNIT_DECIBEL_VOLT)
531 devc->scale *= pow(10.0, -3);
533 devc->scale *= pow(10.0, range - 6);
536 if (devc->scale1000 != -1) /* uA, mA */
537 range += 1;/* mA and A ranges differ by 10^4, not 10^3!*/
538 devc->scale *= pow(10.0, range - 6);
540 case SR_MQ_RESISTANCE:
541 devc->scale *= pow(10.0, range - 3);
543 case SR_MQ_FREQUENCY:
544 devc->scale *= pow(10.0, range - 3);
546 case SR_MQ_TEMPERATURE:
547 if (range == 4) /* Indicator for °F */
548 devc->unit = SR_UNIT_FAHRENHEIT;
549 devc->scale *= pow(10.0, - 2);
551 case SR_MQ_CAPACITANCE:
553 range -= 1; /* Same value as range 6 */
554 devc->scale *= pow(10.0, range - 13);
556 /* TODO: 29S Mains measurements. */
558 /* Avoid certain compiler warnings due to (-Wswitch). */
564 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR 2.
566 * @param[in] rs Range/sign byte.
568 static void decode_rs_2x_TR2(uint8_t rs, struct dev_context *devc)
576 if (devc->scale1000 == -1) /* mA */
579 case 1: /* 100, 300 µA */
580 devc->scale *= pow(10.0, -6);
583 case 3: /* 1, 3 mA */
584 devc->scale *= pow(10.0, -5);
587 case 5: /* 10, 30 mA */
588 devc->scale *= pow(10.0, -4);
591 case 7: /* 100, 300 mA */
592 devc->scale *= pow(10.0, -3);
599 devc->scale *= pow(10.0, -5);
602 devc->scale *= pow(10.0, -4);
607 decode_rs_2x(rs, devc);
612 if (((devc->scale > 0) && (rs & 0x08)) ||
613 ((devc->scale < 0) && !(rs & 0x08)))
618 * Decode special chars (Metrahit 2x).
620 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
622 static void decode_spc_2x(uint8_t spc, struct dev_context *devc)
626 /* xxxxxx1x Low battery */
633 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
635 /* x11xxxxx unused */
637 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
640 /** Clean range and sign. */
641 static void clean_rs_v(struct dev_context *devc)
647 /** Clean current type, measured variable, range and sign. */
648 static void clean_ctmv_rs_v(struct dev_context *devc)
657 /** Send prepared value. */
658 static void send_value(struct sr_dev_inst *sdi)
660 struct dev_context *devc;
661 struct sr_datafeed_analog analog;
662 struct sr_analog_encoding encoding;
663 struct sr_analog_meaning meaning;
664 struct sr_analog_spec spec;
665 struct sr_datafeed_packet packet;
669 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
670 analog.meaning->channels = sdi->channels;
671 analog.num_samples = 1;
672 analog.meaning->mq = devc->mq;
673 analog.meaning->unit = devc->unit;
674 analog.meaning->mqflags = devc->mqflags;
675 analog.data = &devc->value;
677 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
678 packet.type = SR_DF_ANALOG;
679 packet.payload = &analog;
680 sr_session_send(sdi, &packet);
682 sr_sw_limits_update_samples_read(&devc->limits, 1);
685 /** Process 6-byte data message, Metrahit 1x/2x send mode. */
686 static void process_msg_dta_6(struct sr_dev_inst *sdi)
688 struct dev_context *devc;
695 /* Byte 0, range and sign */
696 if (devc->model <= METRAHIT_16X)
697 decode_rs_16(bc(devc->buf[0]), devc);
698 else if (devc->model < METRAHIT_2X)
699 decode_rs_18(bc(devc->buf[0]), devc);
701 decode_rs_2x(bc(devc->buf[0]), devc);
702 devc->scale *= 10; /* Compensate for format having only 5 digits, decode_rs_2x() assumes 6. */
705 /* Bytes 1-5, digits (ls first). */
706 for (cnt = 0; cnt < 5; cnt++) {
707 dgt = bc(devc->buf[1 + cnt]);
709 /* 10 Overload; on model <= 16X also 11 possible. */
714 devc->value += pow(10.0, cnt) * dgt;
717 sr_spew("process_msg_dta_6() value=%f scale=%f scale1000=%d",
718 devc->value, devc->scale, devc->scale1000);
719 if (devc->value != NAN)
720 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
722 /* Create and send packet. */
726 /** Process 5-byte info message, Metrahit 1x/2x. */
727 static void process_msg_inf_5(struct sr_dev_inst *sdi)
729 struct dev_context *devc;
734 clean_ctmv_rs_v(devc);
737 model = gmc_decode_model_sm(bc(devc->buf[0]));
738 if (model != devc->model) {
739 sr_warn("Model mismatch in data: Detected %s, now %s",
740 gmc_model_str(devc->model), gmc_model_str(model));
743 /* Process bytes 1-4 */
744 if (devc->model <= METRAHIT_16X) {
745 decode_ctmv_16(bc(devc->buf[1]), devc);
746 decode_spc_16(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
747 decode_rs_16(bc(devc->buf[4]), devc);
748 } else if (devc->model <= METRAHIT_18S) {
749 decode_ctmv_18(bc(devc->buf[1]), devc);
750 decode_spc_18(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
751 decode_rs_18(bc(devc->buf[4]), devc);
752 } else { /* Must be Metrahit 2x */
753 decode_ctmv_2x(bc(devc->buf[1]), devc);
754 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
755 decode_rs_2x(bc(devc->buf[4]), devc);
759 /** Process 10-byte info/data message, Metrahit 15+. */
760 static void process_msg_inf_10(struct sr_dev_inst *sdi)
762 struct dev_context *devc;
768 process_msg_inf_5(sdi);
770 /* Now decode numbers */
771 for (cnt = 0; cnt < 5; cnt++) {
772 dgt = bc(devc->buf[5 + cnt]);
773 if (dgt == 11) { /* Empty digit */
776 else if (dgt >= 12) { /* Overload */
781 devc->value += pow(10.0, cnt) * dgt;
783 sr_spew("process_msg_inf_10() value=%f scale=%f scalet=%d",
784 devc->value, devc->scale, devc->scale1000);
786 if (devc->value != NAN)
787 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
789 /* Create and send packet. */
793 /** Decode send interval (Metrahit 2x only). */
794 static const char *decode_send_interval(uint8_t si)
830 return "Unknown value";
834 /** Process 13-byte info/data message, Metrahit 2x. */
835 static void process_msg_inf_13(struct sr_dev_inst *sdi)
837 struct dev_context *devc;
844 clean_ctmv_rs_v(devc);
847 model = gmc_decode_model_sm(bc(devc->buf[0]));
848 if (model != devc->model) {
849 sr_warn("Model mismatch in data: Detected %s, now %s",
850 gmc_model_str(devc->model), gmc_model_str(model));
854 decode_ctmv_2x(bc(devc->buf[1]) | (bc(devc->buf[11]) << 4), devc);
855 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
856 decode_rs_2x(bc(devc->buf[4]), devc);
858 /* Bytes 5-10, digits (ls first). */
859 for (cnt = 0; cnt < 6; cnt++) {
860 dgt = bc(devc->buf[5 + cnt]);
861 if (dgt == 10) { /* Overload */
866 devc->value += pow(10.0, cnt) * dgt;
868 sr_spew("process_msg_inf_13() value=%f scale=%f scale1000=%d mq=%d "
869 "unit=%d mqflags=0x%02" PRIx64, devc->value, devc->scale,
870 devc->scale1000, devc->mq, devc->unit, (uint64_t)devc->mqflags);
871 if (devc->value != NAN)
872 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
874 /* Byte 12, Send Interval */
875 sr_spew("Send interval: %s", decode_send_interval(bc(devc->buf[12])));
877 /* Create and send packet. */
881 /** Dump contents of 14-byte message.
882 * @param buf Pointer to array of 14 data bytes.
883 * @param[in] raw Write only data bytes, no interpretation.
885 static void dump_msg14(guchar *buf, gboolean raw)
891 sr_spew("msg14: 0x %02x %02x %02x %02x %02x %02x %02x %02x "
892 "%02x %02x %02x %02x %02x %02x",
893 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
894 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12],
897 sr_spew("msg14: 0x a=%d c1=%02x c2=%02x cmd=%02x dta=%02x "
898 "%02x %02x %02x %02x %02x %02x %02x %02x chs=%02x",
899 buf[1] == 0x2b?buf[0] >> 2:buf[0] % 0x0f, buf[1], buf[2], buf[3], buf[4], buf[5],
900 buf[6], buf[7], buf[8], buf[9], buf[10], buf[11],
904 /** Calc checksum for 14 byte message type.
906 * @param[in] dta Pointer to array of 13 data bytes.
909 static guchar calc_chksum_14(guchar *dta)
913 for (chs = 0, cnt = 0; cnt < (GMC_REPLY_SIZE - 1); cnt++)
916 return (64 - chs) & MASK_6BITS;
919 /** Check 14-byte message, Metrahit 2x. */
920 static int chk_msg14(struct sr_dev_inst *sdi)
922 struct dev_context *devc;
924 gboolean isreq; /* Message is request to multimeter (otherwise response) */
925 uint8_t addr; /* Adaptor address */
929 /* Check parameters and message */
930 if (!sdi || !(devc = sdi->priv))
933 if (devc->buflen != 14) {
934 sr_err("process_msg_14(): Msg len 14 expected!");
938 isreq = devc->buf[1] == 0x2b;
940 addr = devc->buf[0] >> 2;
942 addr = devc->buf[0] & 0x0f;
944 if ((devc->addr != addr) && !(isreq && (addr == 0))) {
945 sr_err("process_msg_14(): Address mismatch, msg for other device!");
949 if (devc->buf[1] == 0) { /* Error msg from device! */
950 switch (devc->buf[2]) {
951 case 1: /* Not used */
952 sr_err("Device: Illegal error code!");
954 case 2: /* Incorrect check sum of received block */
955 sr_err("Device: Incorrect checksum in cmd!");
957 case 3: /* Incorrect length of received block */
958 sr_err("Device: Incorrect block length in cmd!");
960 case 4: /* Incorrect 2nd or 3rd byte */
961 sr_err("Device: Incorrect byte 2 or 3 in cmd!");
963 case 5: /* Parameter out of range */
964 sr_err("Device: Parameter out of range!");
967 sr_err("Device: Unknown error code!");
971 else if (!isreq && ((devc->buf[1] != 0x27) || (devc->buf[2] != 0x3f))) {
972 sr_err("process_msg_14(): byte 1/2 unexpected!");
976 if (calc_chksum_14(devc->buf) != devc->buf[13]) {
977 sr_err("process_msg_14(): Invalid checksum!");
982 dump_msg14(devc->buf, TRUE);
987 /** Check 14-byte message, Metrahit 2x. */
988 SR_PRIV int process_msg14(struct sr_dev_inst *sdi)
990 struct dev_context *devc;
995 if ((retc = chk_msg14(sdi)) != SR_OK)
1000 clean_ctmv_rs_v(devc);
1001 addr = devc->buf[0] & MASK_6BITS;
1002 if (addr != devc->addr)
1003 sr_info("Device address mismatch %d/%d!", addr, devc->addr);
1005 switch (devc->buf[3]) { /* That's the command this reply is for */
1006 /* 0 cannot occur, the respective message is not a 14-byte message */
1007 case 1: /* Read first free and occupied address */
1008 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1010 case 2: /* Clear all RAM in multimeter */
1011 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1013 case 3: /* Read firmware version and status */
1014 sr_spew("Cmd 3, Read firmware and status");
1015 switch (devc->cmd_idx) {
1017 devc->fw_ver_maj = devc->buf[5];
1018 devc->fw_ver_min = devc->buf[4];
1019 sr_spew("Firmware version %d.%d", (int)devc->fw_ver_maj, (int)devc->fw_ver_min);
1020 sr_spew("Rotary Switch Position (1..10): %d", (int)devc->buf[6]);
1021 /** Docs say values 0..9, but that's not true */
1022 sr_spew("Measurement Function: %d ", (int)devc->buf[7]);
1023 decode_ctmv_2x(devc->buf[7], devc);
1024 sr_spew("Range: 0x%x", devc->buf[8]);
1025 decode_rs_2x_TR2(devc->buf[8] & 0x0f, devc); /* Docs wrong, uses conversion table TR_2! */
1026 devc->autorng = (devc->buf[8] & 0x20) == 0;
1027 // TODO 9, 10: 29S special functions
1028 devc->ubatt = 0.1 * (float)devc->buf[11];
1029 devc->model = gmc_decode_model_bd(devc->buf[12]);
1030 sr_spew("Model=%s, battery voltage=%2.1f V", gmc_model_str(devc->model), (double)devc->ubatt);
1033 sr_spew("Internal version %d.%d", (int)devc->buf[5], (int)devc->buf[4]);
1034 sr_spew("Comm mode: 0x%x", (int)devc->buf[6]);
1035 sr_spew("Block cnt%%64: %d", (int)devc->buf[7]);
1036 sr_spew("drpCi: %d drpCh: %d", (int)devc->buf[8], (int)devc->buf[9]);
1037 // Semantics undocumented. Possibly Metrahit 29S dropouts stuff?
1040 sr_spew("Cmd 3: Unknown cmd_idx=%d", devc->cmd_idx);
1044 case 4: /* Set real time, date, sample rate, trigger, ... */
1045 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1047 case 5: /* Read real time, date, sample rate, trigger... */
1048 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1050 case 6: /* Set modes or power off */
1051 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1053 case 7: /* Set measurement function, range, autom/man. */
1054 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1056 case 8: /* Get one measurement value */
1057 sr_spew("Cmd 8, get one measurement value");
1058 sr_spew("Measurement Function: %d ", (int)devc->buf[5]);
1059 decode_ctmv_2x(devc->buf[5], devc);
1060 if (!(devc->buf[6] & 0x10)) /* If bit4=0, old data. */
1063 decode_rs_2x_TR2(devc->buf[6] & 0x0f, devc); // The docs say conversion table TR_3, but that does not work
1064 setmqf(devc, SR_MQFLAG_AUTORANGE, devc->autorng);
1066 for (cnt = 0; cnt < 6; cnt++) {
1067 dgt = bc(devc->buf[7 + cnt]);
1068 if (dgt == 10) { /* Overload */
1073 else if (dgt == 13) { /* FUSE */
1076 else if (dgt == 14) { /* Function recognition mode, OPEN */
1077 sr_info("Function recognition mode, OPEN!");
1082 devc->value += pow(10.0, cnt) * dgt;
1084 sr_spew("process_msg14() value=%f scale=%f scale1000=%d mq=%d "
1085 "unit=%d mqflags=0x%02" PRIx64, devc->value, devc->scale,
1086 devc->scale1000, devc->mq, devc->unit, (uint64_t)devc->mqflags);
1087 if (devc->value != NAN)
1088 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
1094 sr_spew("Unknown cmd %d!", devc->buf[3]);
1101 /** Data reception callback function. */
1102 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data)
1104 struct sr_dev_inst *sdi;
1105 struct dev_context *devc;
1106 struct sr_serial_dev_inst *serial;
1112 if (!(sdi = cb_data))
1115 if (!(devc = sdi->priv))
1120 if (revents == G_IO_IN) { /* Serial data arrived. */
1121 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
1122 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
1125 buf = *(devc->buf + devc->buflen);
1126 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MSGC_MASK);
1127 devc->buflen += len;
1128 if (!devc->settings_ok) {
1130 * If no device type/settings record processed
1131 * yet, wait for one.
1133 if ((devc->buf[0] & MSGID_MASK) != MSGID_INF) {
1137 devc->settings_ok = TRUE;
1140 msgt = devc->buf[0] & MSGID_MASK;
1143 if (devc->buflen == 13) {
1144 process_msg_inf_13(sdi);
1147 } else if ((devc->buflen == 10) &&
1148 (devc->model <= METRAHIT_18S)) {
1149 process_msg_inf_10(sdi);
1153 else if ((devc->buflen >= 5) &&
1154 (devc->buf[devc->buflen - 1] &
1155 MSGID_MASK) != MSGID_DATA) {
1157 * Char just received is beginning
1160 process_msg_inf_5(sdi);
1162 devc->buf[devc->buflen - 1];
1169 if (devc->buflen == 6) {
1170 process_msg_dta_6(sdi);
1175 sr_err("Comm error, unexpected data byte!");
1182 if (sr_sw_limits_check(&devc->limits))
1183 sdi->driver->dev_acquisition_stop(sdi);
1188 SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data)
1190 struct sr_dev_inst *sdi;
1191 struct dev_context *devc;
1192 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 (sr_sw_limits_check(&devc->limits))
1226 sdi->driver->dev_acquisition_stop(sdi);
1228 /* Request next data set, if required */
1229 if (sdi->status == SR_ST_ACTIVE) {
1230 if (devc->response_pending) {
1231 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
1232 if (elapsed_us > (1 * 1000 * 1000)) /* Timeout! */
1233 devc->response_pending = FALSE;
1235 if (!devc->response_pending) {
1237 if (devc->cmd_seq % 10 == 0) {
1238 if (req_stat14(sdi, FALSE) != SR_OK)
1241 else if (req_meas14(sdi) != SR_OK)
1249 /** Create 14 (42) byte command for Metrahit 2x multimeter in bidir mode.
1251 * Actually creates 42 bytes due to the encoding method used.
1252 * @param[in] addr Device address (0=adapter, 1..15 multimeter; for byte 0).
1253 * @param[in] func Function code (byte 3).
1254 * @param[in] params Further parameters (9 bytes)
1255 * @param[out] buf Buffer to create msg in (42 bytes).
1257 static void create_cmd_14(guchar addr, guchar func, guchar *params, guchar *buf)
1259 uint8_t dta[GMC_REPLY_SIZE]; /* Unencoded message */
1262 if (!params || !buf)
1266 dta[0] = ((addr << 2) | 0x03) & MASK_6BITS;
1268 /* 1-3: Set command header */
1273 /* 4-12: Copy further parameters */
1274 for (cnt = 0; cnt < 9; cnt++)
1275 dta[cnt + 4] = (params[cnt] & MASK_6BITS);
1277 /* 13: Checksum (b complement) */
1278 dta[13] = calc_chksum_14(dta);
1280 /* The whole message is packed into 3 bytes per byte now (lower 6 bits only) the most
1281 * peculiar way I have ever seen. Possibly to improve IR communication? */
1282 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
1283 buf[(3 * cnt) + 0] = (dta[cnt] & 0x01 ? 0x0f : 0) | (dta[cnt] & 0x02 ? 0xf0 : 0);
1284 buf[(3 * cnt) + 1] = (dta[cnt] & 0x04 ? 0x0f : 0) | (dta[cnt] & 0x08 ? 0xf0 : 0);
1285 buf[(3 * cnt) + 2] = (dta[cnt] & 0x10 ? 0x0f : 0) | (dta[cnt] & 0x20 ? 0xf0 : 0);
1289 /** Request one measurement from 2x multimeter (msg 8).
1292 int req_meas14(const struct sr_dev_inst *sdi)
1294 struct dev_context *devc;
1295 struct sr_serial_dev_inst *serial;
1299 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1302 memset(params, 0, sizeof(params));
1305 create_cmd_14(devc->addr, 8, params, msg);
1306 devc->req_sent_at = g_get_monotonic_time();
1307 if (serial_write_blocking(serial, msg, sizeof(msg),
1308 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1312 devc->response_pending = TRUE;
1317 /** Request status from 2x multimeter (msg 3).
1318 * @param[in] power_on Try to power on powered off multimeter by sending additional messages.
1320 int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on)
1322 struct dev_context *devc;
1323 struct sr_serial_dev_inst *serial;
1327 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1330 memset(params, 0, sizeof(params));
1333 create_cmd_14(devc->addr, 3, params, msg);
1336 sr_info("Write some data and wait 3s to turn on powered off device...");
1337 if (serial_write_blocking(serial, msg, sizeof(msg),
1338 serial_timeout(serial, sizeof(msg))) < 0)
1340 g_usleep(1 * 1000 * 1000);
1341 if (serial_write_blocking(serial, msg, sizeof(msg),
1342 serial_timeout(serial, sizeof(msg))) < 0)
1344 g_usleep(1 * 1000 * 1000);
1345 if (serial_write_blocking(serial, msg, sizeof(msg),
1346 serial_timeout(serial, sizeof(msg))) < 0)
1348 g_usleep(1 * 1000 * 1000);
1349 serial_flush(serial);
1352 /* Write message and wait for reply */
1353 devc->req_sent_at = g_get_monotonic_time();
1354 if (serial_write_blocking(serial, msg, sizeof(msg),
1355 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1359 devc->response_pending = TRUE;
1364 /** Decode model in "send mode".
1366 * @param[in] mcode Model code.
1367 * @return Model code.
1369 SR_PRIV int gmc_decode_model_sm(uint8_t mcode)
1372 sr_err("decode_model(%d): Model code 0..15 expected!", mcode);
1373 return METRAHIT_NONE;
1377 case 0x04: /* 0100b */
1378 return METRAHIT_12S;
1379 case 0x08: /* 1000b */
1380 return METRAHIT_13S14A;
1381 case 0x09: /* 1001b */
1382 return METRAHIT_14S;
1383 case 0x0A: /* 1010b */
1384 return METRAHIT_15S;
1385 case 0x0B: /* 1011b */
1386 return METRAHIT_16S;
1387 case 0x06: /* 0110b (undocumented by GMC!) */
1388 return METRAHIT_16I;
1389 case 0x07: /* 0111b (undocumented by GMC!) */
1390 return METRAHIT_16T;
1391 case 0x0D: /* 1101b */
1392 return METRAHIT_18S;
1393 case 0x02: /* 0010b */
1394 return METRAHIT_22SM;
1395 case 0x03: /* 0011b */
1396 return METRAHIT_23S;
1397 case 0x0F: /* 1111b */
1398 return METRAHIT_24S;
1399 case 0x05: /* 0101b */
1400 return METRAHIT_25S;
1401 case 0x01: /* 0001b */
1402 return METRAHIT_26SM;
1403 case 0x0C: /* 1100b */
1404 return METRAHIT_28S;
1405 case 0x0E: /* 1110b */
1406 return METRAHIT_29S;
1408 sr_err("Unknown model code %d!", mcode);
1409 return METRAHIT_NONE;
1413 /** Convert GMC model code in bidirectional mode to sigrok-internal one.
1415 * @param[in] mcode Model code.
1417 * @return Model code.
1419 SR_PRIV int gmc_decode_model_bd(uint8_t mcode)
1421 switch (mcode & 0x1f) {
1424 return METRAHIT_22M;
1426 return METRAHIT_22S;
1428 return METRAHIT_23S;
1430 return METRAHIT_24S;
1432 return METRAHIT_25S;
1435 return METRAHIT_26M;
1437 return METRAHIT_26S;
1439 return METRAHIT_28S;
1441 return METRAHIT_29S;
1443 sr_err("Unknown model code %d!", mcode);
1444 return METRAHIT_NONE;
1448 /** Convert sigrok-internal model code to string.
1450 * @param[in] mcode Model code.
1452 * @return Model code string.
1454 SR_PRIV const char *gmc_model_str(enum model mcode)
1458 return "-uninitialized model variable-";
1460 return "METRAHit 12S";
1461 case METRAHIT_13S14A:
1462 return "METRAHit 13S/14A";
1464 return "METRAHit 14S";
1466 return "METRAHit 15S";
1468 return "METRAHit 16S";
1470 return "METRAHit 16I/16L";
1472 return "METRAHit 16T/16U/KMM2002";
1474 return "METRAHit 18S";
1476 return "METRAHit 22S/M";
1478 return "METRAHit 22S";
1480 return "METRAHit 22M";
1482 return "METRAHit 23S";
1484 return "METRAHit 24S";
1486 return "METRAHit 25S";
1488 return "METRAHit 26S/M";
1490 return "METRAHit 26S";
1492 return "METRAHit 26M";
1494 return "METRAHit 28S";
1496 return "METRAHit 29S";
1498 return "Unknown model code";
1502 /** @copydoc sr_dev_driver.config_set */
1503 SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
1504 const struct sr_channel_group *cg)
1506 struct dev_context *devc;
1512 if (sdi->status != SR_ST_ACTIVE)
1513 return SR_ERR_DEV_CLOSED;
1518 case SR_CONF_POWER_OFF:
1519 if (devc->model < METRAHIT_2X)
1521 if (!g_variant_get_boolean(data))
1523 sr_info("Powering device off.");
1525 memset(params, 0, sizeof(params));
1528 create_cmd_14(devc->addr, 6, params, msg);
1529 if (serial_write_blocking(sdi->conn, msg, sizeof(msg),
1530 serial_timeout(sdi->conn, sizeof(msg))) < 0)
1533 g_usleep(2 * 1000 * 1000); /* Wait to ensure transfer before interface switched off. */
1535 case SR_CONF_LIMIT_SAMPLES:
1536 case SR_CONF_LIMIT_MSEC:
1537 return sr_sw_limits_config_set(&devc->limits, key, data);