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/>.
25 static guchar calc_chksum_14(guchar *dta);
26 static int chk_msg14(struct sr_dev_inst *sdi);
28 /** Set or clear flags in devc->mqflags. */
29 static void setmqf(struct dev_context *devc, uint64_t flags, gboolean set)
32 devc->mqflags |= flags;
34 devc->mqflags &= ~flags;
37 /** Decode current type and measured value, Metrahit 12-16. */
38 static void decode_ctmv_16(uint8_t ctmv, struct dev_context *devc)
45 case 0x00: /* 0000 - */
47 case 0x01: /* 0001 mV DC */
48 devc->scale1000 = -1; /* Fall through */
49 case 0x02: /* 0010 V DC */
50 case 0x03: /* 0011 V AC+DC */
51 case 0x04: /* 0100 V AC */
52 devc->mq = SR_MQ_VOLTAGE;
53 devc->unit = SR_UNIT_VOLT;
55 devc->mqflags |= SR_MQFLAG_DC;
57 devc->mqflags |= SR_MQFLAG_AC;
58 if (devc->model >= METRAHIT_16S)
59 devc->mqflags |= SR_MQFLAG_RMS;
62 case 0x05: /* 0101 Hz (15S/16S only) */
63 case 0x06: /* 0110 kHz (15S/16S only) */
64 devc->mq = SR_MQ_FREQUENCY;
65 devc->unit = SR_UNIT_HERTZ;
69 case 0x07: /* 0111 % (15S/16S only) */
70 devc->mq = SR_MQ_DUTY_CYCLE;
71 devc->unit = SR_UNIT_PERCENTAGE;
73 case 0x08: /* 1000 Diode */
74 devc->mq = SR_MQ_VOLTAGE;
75 devc->unit = SR_UNIT_VOLT;
76 devc->mqflags |= SR_MQFLAG_DIODE;
78 case 0x09: /* 1001 Ohm, °C */
79 case 0x0a: /* 1010 kOhm */
80 case 0x0b: /* 1011 MOhm */
81 devc->mq = SR_MQ_RESISTANCE; /* Changed to temp. later if req.*/
82 devc->unit = SR_UNIT_OHM;
83 devc->scale1000 = ctmv - 0x09;
85 case 0x0c: /* 1100 nF (15S/16S only) */
86 case 0x0d: /* 1101 µF (15S/16S only) */
87 devc->mq = SR_MQ_CAPACITANCE;
88 devc->unit = SR_UNIT_FARAD;
89 devc->scale1000 = (ctmv == 0x0c) ? -3 : -2;
91 case 0x0e: /* mA, µA */
92 devc->scale1000 = -1; /* Fall through. */
94 devc->mq = SR_MQ_CURRENT;
95 devc->unit = SR_UNIT_AMPERE;
96 if (devc->model == METRAHIT_16S)
97 devc->mqflags |= SR_MQFLAG_RMS;
98 /* 16I A only with clamp, RMS questionable. */
104 * Decode range/sign/acdc byte special chars (Metrahit 12-16).
106 * @param[in] rs Range and sign byte.
108 static void decode_rs_16(uint8_t rs, struct dev_context *devc)
110 sr_spew("decode_rs_16(%d) scale = %d", rs, devc->scale);
112 if (rs & 0x04) /* Sign */
113 devc->scale = -devc->scale;
115 if (devc->mq == SR_MQ_CURRENT)
116 devc->mqflags |= (rs & 0x08) ? SR_MQFLAG_AC : SR_MQFLAG_DC;
120 if (devc->mq == SR_MQ_VOLTAGE) /* V */
122 else if (devc->mq == SR_MQ_CURRENT) /* 000.0 µA */
124 else if (devc->mq == SR_MQ_RESISTANCE) {
125 if (devc->buflen >= 10) {
126 /* °C with 10 byte msg type, otherwise GOhm. */
127 devc->mq = SR_MQ_TEMPERATURE;
128 devc->unit = SR_UNIT_CELSIUS;
130 } else if (devc->scale1000 == 2) {
131 /* 16I Iso 500/1000V 3 GOhm */
149 * Decode special chars, Metrahit 12-16.
151 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
153 static void decode_spc_16(uint8_t spc, struct dev_context *devc)
156 /* TODO: What does that mean? Power on? The 16I sets this. */
158 /* xxxxxx1x Low battery */
161 setmqf(devc, SR_MQFLAG_MIN, spc & 0x80);
164 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x40));
167 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x20);
170 setmqf(devc, SR_MQFLAG_MAX, spc & 0x10);
173 /** Decode current type and measured value, Metrahit 18. */
174 static void decode_ctmv_18(uint8_t ctmv, struct dev_context *devc)
181 case 0x00: /* 0000 - */
183 case 0x01: /* 0001 V AC */
184 case 0x02: /* 0010 V AC+DC */
185 case 0x03: /* 0011 V DC */
186 devc->mq = SR_MQ_VOLTAGE;
187 devc->unit = SR_UNIT_VOLT;
189 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
191 devc->mqflags |= SR_MQFLAG_DC;
193 case 0x04: /* 0100 Ohm/Ohm with buzzer */
194 devc->mq = SR_MQ_RESISTANCE;
195 devc->unit = SR_UNIT_OHM;
197 case 0x05: /* 0101 Diode/Diode with buzzer */
198 devc->mq = SR_MQ_VOLTAGE;
199 devc->unit = SR_UNIT_VOLT;
200 devc->mqflags |= SR_MQFLAG_DIODE;
202 case 0x06: /* 0110 °C */
203 devc->mq = SR_MQ_TEMPERATURE;
204 devc->unit = SR_UNIT_CELSIUS;
206 case 0x07: /* 0111 F */
207 devc->mq = SR_MQ_CAPACITANCE;
208 devc->unit = SR_UNIT_FARAD;
210 case 0x08: /* 1000 mA DC */
211 case 0x09: /* 1001 A DC */
212 case 0x0a: /* 1010 mA AC+DC */
213 case 0x0b: /* 1011 A AC+DC */
214 devc->mq = SR_MQ_CURRENT;
215 devc->unit = SR_UNIT_AMPERE;
216 devc->mqflags |= SR_MQFLAG_DC;
218 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
219 if ((ctmv == 0x08) || (ctmv == 0x0a))
220 devc->scale1000 = -1;
222 case 0x0c: /* 1100 Hz */
223 devc->mq = SR_MQ_FREQUENCY;
224 devc->unit = SR_UNIT_HERTZ;
226 case 0x0d: /* 1101 dB */
227 devc->mq = SR_MQ_VOLTAGE;
228 devc->unit = SR_UNIT_DECIBEL_VOLT;
229 devc->mqflags |= SR_MQFLAG_AC; /* dB available for AC only */
231 case 0x0e: /* 1110 Events AC, Events AC+DC. Actually delivers just
232 * current voltage via IR, nothing more. */
233 devc->mq = SR_MQ_VOLTAGE;
234 devc->unit = SR_UNIT_VOLT;
235 devc->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS;
237 case 0x0f: /* 1111 Clock */
238 devc->mq = SR_MQ_TIME;
239 devc->unit = SR_UNIT_SECOND;
240 devc->mqflags |= SR_MQFLAG_DURATION;
246 * Decode range/sign/acdc byte special chars, Metrahit 18.
248 * @param[in] rs Range/sign byte.
250 static void decode_rs_18(uint8_t rs, struct dev_context *devc)
255 if (((devc->scale > 0) && (rs & 0x08)) ||
256 ((devc->scale < 0) && !(rs & 0x08)))
257 devc->scale = -devc->scale;
263 if (devc->unit == SR_UNIT_DECIBEL_VOLT) {
266 * When entering relative mode, the device switches
267 * from 10 byte to 6 byte msg format. Unfortunately
268 * it switches back to 10 byte when the second value
269 * is measured, so that's not sufficient to
270 * identify relative mode.
274 devc->scale += range - 5;
277 devc->scale += (devc->scale1000 == -1) ? range - 5 : range - 4;
279 case SR_MQ_RESISTANCE:
280 devc->scale += range - 2;
282 case SR_MQ_FREQUENCY:
283 devc->scale += range - 2;
285 case SR_MQ_TEMPERATURE:
286 devc->scale += range - 2;
288 case SR_MQ_CAPACITANCE:
289 devc->scale += range - 13;
291 /* TODO: 29S Mains measurements. */
293 /* Avoid certain compiler warnings due to (-Wswitch). */
299 * Decode special chars, Metrahit 18.
301 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
303 static void decode_spc_18(uint8_t spc, struct dev_context *devc)
307 /* xxxxxx1x Low battery */
310 if (devc->mq == SR_MQ_TIME) {
311 /* xxx1xxxx Clock running: 1; stop: 0 */
312 sr_spew("Clock running: %d", spc >> 4);
315 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
318 setmqf(devc, SR_MQFLAG_MIN, spc & 0x40);
321 setmqf(devc, SR_MQFLAG_MAX, spc & 0x20);
324 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
329 * Decode current type and measured value, Metrahit 2x.
331 * @param[in] ctmv Current type and measured value (v1 | (v2 << 4)).
333 static void decode_ctmv_2x(uint8_t ctmv, struct dev_context *devc)
335 if ((ctmv > 0x20) || (!devc)) {
336 sr_err("decode_ctmv_2x(0x%x): invalid param(s)!", ctmv);
346 case 0x01: /* 00001 V DC */
347 case 0x02: /* 00010 V AC+DC */
348 case 0x03: /* 00011 V AC */
349 devc->mq = SR_MQ_VOLTAGE;
350 devc->unit = SR_UNIT_VOLT;
352 devc->mqflags |= SR_MQFLAG_DC;
354 devc->mqflags |= SR_MQFLAG_AC;
355 if (devc->model >= METRAHIT_24S)
356 devc->mqflags |= SR_MQFLAG_RMS;
359 case 0x04: /* 00100 mA DC */
360 case 0x05: /* 00101 mA AC+DC */
361 devc->scale1000 = -1;
363 case 0x06: /* 00110 A DC */
364 case 0x07: /* 00111 A AC+DC */
365 devc->mq = SR_MQ_CURRENT;
366 devc->unit = SR_UNIT_AMPERE;
367 devc->mqflags |= SR_MQFLAG_DC;
368 if ((ctmv == 0x05) || (ctmv == 0x07)) {
369 devc->mqflags |= SR_MQFLAG_AC;
370 if (devc->model >= METRAHIT_24S)
371 devc->mqflags |= SR_MQFLAG_RMS;
374 case 0x08: /* 01000 Ohm */
375 devc->mq = SR_MQ_RESISTANCE;
376 devc->unit = SR_UNIT_OHM;
378 case 0x09: /* 01001 F */
379 devc->mq = SR_MQ_CAPACITANCE;
380 devc->unit = SR_UNIT_FARAD;
383 case 0x0a: /* 01010 V dB */
384 devc->mq = SR_MQ_VOLTAGE;
385 devc->unit = SR_UNIT_DECIBEL_VOLT;
386 devc->mqflags |= SR_MQFLAG_AC;
387 if (devc->model >= METRAHIT_24S)
388 devc->mqflags |= SR_MQFLAG_RMS;
390 case 0x0b: /* 01011 Hz U ACDC */
391 case 0x0c: /* 01100 Hz U AC */
392 devc->mq = SR_MQ_FREQUENCY;
393 devc->unit = SR_UNIT_HERTZ;
394 devc->mqflags |= SR_MQFLAG_AC;
396 devc->mqflags |= SR_MQFLAG_DC;
398 case 0x0d: /* 01101 W on power, mA range (29S only) */
401 case 0x0e: /* 01110 W on power, A range (29S only) */
403 devc->scale1000 = -1;
404 devc->mq = SR_MQ_POWER;
405 devc->unit = SR_UNIT_WATT;
406 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
408 case 0x0f: /* 01111 Diode */
409 case 0x10: /* 10000 Diode with buzzer (actually cont. with voltage) */
410 devc->unit = SR_UNIT_VOLT;
412 devc->mq = SR_MQ_VOLTAGE;
413 devc->mqflags |= SR_MQFLAG_DIODE;
415 devc->mq = SR_MQ_CONTINUITY;
418 devc->unit = SR_UNIT_VOLT;
420 case 0x11: /* 10001 Ohm with buzzer */
421 devc->mq = SR_MQ_CONTINUITY;
422 devc->unit = SR_UNIT_OHM;
423 devc->scale1000 = -1;
425 case 0x12: /* 10010 Temperature */
426 devc->mq = SR_MQ_TEMPERATURE;
427 devc->unit = SR_UNIT_CELSIUS;
428 /* This can be Fahrenheit. That is detected by range=4 later. */
430 /* 0x13 10011 unused */
431 /* 0x14 10100 unused */
432 case 0x15: /* 10101 Press (29S only) */
433 /* TODO: What does that mean? Possibly phase shift?
434 Then we need a unit/flag for it. */
435 devc->mq = SR_MQ_GAIN;
436 devc->unit = SR_UNIT_PERCENTAGE;
438 case 0x16: /* 10110 Pulse W (29S only) */
439 /* TODO: Own unit and flag for this! */
440 devc->mq = SR_MQ_POWER;
441 devc->unit = SR_UNIT_WATT;
443 case 0x17: /* 10111 TRMS V on mains (29S only) */
444 devc->mq = SR_MQ_VOLTAGE;
445 devc->unit = SR_UNIT_VOLT;
446 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
448 case 0x18: /* 11000 Counter (zero crossings of a signal) */
449 devc->mq = SR_MQ_VOLTAGE;
450 devc->unit = SR_UNIT_UNITLESS;
452 case 0x19: /* 11001 Events U ACDC */
453 case 0x1a: /* 11010 Events U AC */
454 /* TODO: No unit or flags for this yet! */
455 devc->mq = SR_MQ_VOLTAGE;
456 devc->unit = SR_UNIT_UNITLESS;
457 devc->mqflags |= SR_MQFLAG_AC;
459 devc->mqflags |= SR_MQFLAG_DC;
461 case 0x1b: /* 11011 Milliamperes in power mode (29S only); error in docs, "pulse on mains" */
462 devc->mq = SR_MQ_CURRENT;
463 devc->unit = SR_UNIT_AMPERE;
464 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
465 devc->scale1000 = -1;
467 case 0x1c: /* 11100 dropout on mains (29S only) */
468 /* TODO: No unit or flags for this yet! */
469 devc->mq = SR_MQ_VOLTAGE;
470 devc->unit = SR_UNIT_UNITLESS;
471 devc->mqflags |= SR_MQFLAG_AC;
473 case 0x1d: /* 11101 Voltage in power mode (29S); undocumented! */
474 devc->mq = SR_MQ_VOLTAGE;
475 devc->unit = SR_UNIT_VOLT;
476 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
478 /* 0x1e: 11110 Undocumented */
479 case 0x1f: /* 11111 25S in stopwatch mode; undocumented!
480 The value is voltage, not time, so treat it such. */
481 devc->mq = SR_MQ_VOLTAGE;
482 devc->unit = SR_UNIT_VOLT;
483 devc->mqflags |= SR_MQFLAG_DC;
485 case 0x20: /* 100000 25S in event count mode; undocumented!
486 Value is 0 anyway. */
487 devc->mq = SR_MQ_VOLTAGE;
488 devc->unit = SR_UNIT_UNITLESS;
491 sr_err("decode_ctmv_2x(%d, ...): Unknown ctmv!", ctmv);
497 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR.
499 * @param[in] rs Range/sign byte.
501 static void decode_rs_2x(uint8_t rs, struct dev_context *devc)
506 if (((devc->scale > 0) && (rs & 0x08)) ||
507 ((devc->scale < 0) && !(rs & 0x08)))
508 devc->scale = -devc->scale;
514 devc->scale += (devc->unit == SR_UNIT_DECIBEL_VOLT) ? -3 : range - 6;
517 if (devc->scale1000 != -1) /* uA, mA */
518 range += 1;/* mA and A ranges differ by 10^4, not 10^3!*/
519 devc->scale += range - 6;
521 case SR_MQ_RESISTANCE:
522 devc->scale += range - 3;
524 case SR_MQ_FREQUENCY:
525 devc->scale += range - 3;
527 case SR_MQ_TEMPERATURE:
528 if (range == 4) /* Indicator for °F */
529 devc->unit = SR_UNIT_FAHRENHEIT;
532 case SR_MQ_CAPACITANCE:
534 range -= 1; /* Same value as range 6 */
535 devc->scale += range - 13;
537 /* TODO: 29S Mains measurements. */
539 /* Avoid certain compiler warnings due to (-Wswitch). */
545 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR 2.
547 * @param[in] rs Range/sign byte.
549 static void decode_rs_2x_TR2(uint8_t rs, struct dev_context *devc)
557 if (devc->scale1000 == -1) /* mA */
560 case 1: /* 100, 300 µA */
564 case 3: /* 1, 3 mA */
568 case 5: /* 10, 30 mA */
572 case 7: /* 100, 300 mA */
588 decode_rs_2x(rs, devc);
593 if (((devc->scale > 0) && (rs & 0x08)) ||
594 ((devc->scale < 0) && !(rs & 0x08)))
595 devc->scale = -devc->scale;
599 * Decode special chars (Metrahit 2x).
601 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
603 static void decode_spc_2x(uint8_t spc, struct dev_context *devc)
607 /* xxxxxx1x Low battery */
614 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
616 /* x11xxxxx unused */
618 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
621 /** Clean range and sign. */
622 static void clean_rs_v(struct dev_context *devc)
628 /** Clean current type, measured variable, range and sign. */
629 static void clean_ctmv_rs_v(struct dev_context *devc)
638 /** Send prepared value. */
639 static void send_value(struct sr_dev_inst *sdi)
641 struct dev_context *devc;
642 struct sr_datafeed_analog analog;
643 struct sr_analog_encoding encoding;
644 struct sr_analog_meaning meaning;
645 struct sr_analog_spec spec;
646 struct sr_datafeed_packet packet;
651 digits = -(devc->scale + 3 * devc->scale1000);
652 sr_analog_init(&analog, &encoding, &meaning, &spec, digits);
653 analog.meaning->channels = sdi->channels;
654 analog.num_samples = 1;
655 analog.meaning->mq = devc->mq;
656 analog.meaning->unit = devc->unit;
657 analog.meaning->mqflags = devc->mqflags;
658 analog.data = &devc->value;
660 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
661 packet.type = SR_DF_ANALOG;
662 packet.payload = &analog;
663 sr_session_send(sdi, &packet);
665 sr_sw_limits_update_samples_read(&devc->limits, 1);
668 /** Process 6-byte data message, Metrahit 1x/2x send mode. */
669 static void process_msg_dta_6(struct sr_dev_inst *sdi)
671 struct dev_context *devc;
678 /* Byte 0, range and sign */
679 if (devc->model <= METRAHIT_16X)
680 decode_rs_16(bc(devc->buf[0]), devc);
681 else if (devc->model < METRAHIT_2X)
682 decode_rs_18(bc(devc->buf[0]), devc);
684 decode_rs_2x(bc(devc->buf[0]), devc);
685 devc->scale += 1; /* Compensate for format having only 5 digits, decode_rs_2x() assumes 6. */
688 /* Bytes 1-5, digits (ls first). */
689 for (cnt = 0; cnt < 5; cnt++) {
690 dgt = bc(devc->buf[1 + cnt]);
692 /* 10 Overload; on model <= 16X also 11 possible. */
697 devc->value += pow(10.0, cnt) * dgt;
700 sr_spew("process_msg_dta_6() value=%f scale=%d scale1000=%d",
701 devc->value, devc->scale, devc->scale1000);
702 if (devc->value != NAN)
703 devc->value *= pow(10.0, devc->scale) * pow(1000.0, devc->scale1000);
705 /* Create and send packet. */
709 /** Process 5-byte info message, Metrahit 1x/2x. */
710 static void process_msg_inf_5(struct sr_dev_inst *sdi)
712 struct dev_context *devc;
717 clean_ctmv_rs_v(devc);
720 model = gmc_decode_model_sm(bc(devc->buf[0]));
721 if (model != devc->model) {
722 sr_warn("Model mismatch in data: Detected %s, now %s",
723 gmc_model_str(devc->model), gmc_model_str(model));
726 /* Process bytes 1-4 */
727 if (devc->model <= METRAHIT_16X) {
728 decode_ctmv_16(bc(devc->buf[1]), devc);
729 decode_spc_16(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
730 decode_rs_16(bc(devc->buf[4]), devc);
731 } else if (devc->model <= METRAHIT_18S) {
732 decode_ctmv_18(bc(devc->buf[1]), devc);
733 decode_spc_18(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
734 decode_rs_18(bc(devc->buf[4]), devc);
735 } else { /* Must be Metrahit 2x */
736 decode_ctmv_2x(bc(devc->buf[1]), devc);
737 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
738 decode_rs_2x(bc(devc->buf[4]), devc);
742 /** Process 10-byte info/data message, Metrahit 15+. */
743 static void process_msg_inf_10(struct sr_dev_inst *sdi)
745 struct dev_context *devc;
751 process_msg_inf_5(sdi);
753 /* Now decode numbers */
754 for (cnt = 0; cnt < 5; cnt++) {
755 dgt = bc(devc->buf[5 + cnt]);
756 if (dgt == 11) { /* Empty digit */
759 else if (dgt >= 12) { /* Overload */
764 devc->value += pow(10.0, cnt) * dgt;
766 sr_spew("process_msg_inf_10() value=%f scale=%d scalet=%d",
767 devc->value, devc->scale, devc->scale1000);
769 if (devc->value != NAN)
770 devc->value *= pow(10, devc->scale) * pow(1000.0, devc->scale1000);
772 /* Create and send packet. */
776 /** Decode send interval (Metrahit 2x only). */
777 static const char *decode_send_interval(uint8_t si)
813 return "Unknown value";
817 /** Process 13-byte info/data message, Metrahit 2x. */
818 static void process_msg_inf_13(struct sr_dev_inst *sdi)
820 struct dev_context *devc;
827 clean_ctmv_rs_v(devc);
830 model = gmc_decode_model_sm(bc(devc->buf[0]));
831 if (model != devc->model) {
832 sr_warn("Model mismatch in data: Detected %s, now %s",
833 gmc_model_str(devc->model), gmc_model_str(model));
837 decode_ctmv_2x(bc(devc->buf[1]) | (bc(devc->buf[11]) << 4), devc);
838 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
839 decode_rs_2x(bc(devc->buf[4]), devc);
841 /* Bytes 5-10, digits (ls first). */
842 for (cnt = 0; cnt < 6; cnt++) {
843 dgt = bc(devc->buf[5 + cnt]);
844 if (dgt == 10) { /* Overload */
849 devc->value += pow(10.0, cnt) * dgt;
851 sr_spew("process_msg_inf_13() value=%f scale=%d scale1000=%d mq=%d "
852 "unit=%d mqflags=0x%02" PRIx64, devc->value, devc->scale,
853 devc->scale1000, devc->mq, devc->unit, (uint64_t)devc->mqflags);
854 if (devc->value != NAN)
855 devc->value *= pow(10, devc->scale) * pow(1000.0, devc->scale1000);
857 /* Byte 12, Send Interval */
858 sr_spew("Send interval: %s", decode_send_interval(bc(devc->buf[12])));
860 /* Create and send packet. */
865 * Dump contents of 14-byte message.
867 * @param buf Pointer to array of 14 data bytes.
868 * @param[in] raw Write only data bytes, no interpretation.
870 static void dump_msg14(guchar *buf, gboolean raw)
876 sr_spew("msg14: 0x %02x %02x %02x %02x %02x %02x %02x %02x "
877 "%02x %02x %02x %02x %02x %02x",
878 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
879 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12],
882 sr_spew("msg14: 0x a=%d c1=%02x c2=%02x cmd=%02x dta=%02x "
883 "%02x %02x %02x %02x %02x %02x %02x %02x chs=%02x",
884 buf[1] == 0x2b?buf[0] >> 2:buf[0] % 0x0f, buf[1], buf[2], buf[3], buf[4], buf[5],
885 buf[6], buf[7], buf[8], buf[9], buf[10], buf[11],
890 * Calc checksum for 14 byte message type.
892 * @param[in] dta Pointer to array of 13 data bytes.
895 static guchar calc_chksum_14(guchar *dta)
899 for (chs = 0, cnt = 0; cnt < (GMC_REPLY_SIZE - 1); cnt++)
902 return (64 - chs) & MASK_6BITS;
905 /** Check 14-byte message, Metrahit 2x. */
906 static int chk_msg14(struct sr_dev_inst *sdi)
908 struct dev_context *devc;
910 gboolean isreq; /* Message is request to multimeter (otherwise response) */
911 uint8_t addr; /* Adaptor address */
915 /* Check parameters and message */
916 if (!sdi || !(devc = sdi->priv))
919 if (devc->buflen != 14) {
920 sr_err("process_msg_14(): Msg len 14 expected!");
924 isreq = devc->buf[1] == 0x2b;
926 addr = devc->buf[0] >> 2;
928 addr = devc->buf[0] & 0x0f;
930 if ((devc->addr != addr) && !(isreq && (addr == 0))) {
931 sr_err("process_msg_14(): Address mismatch, msg for other device!");
935 if (devc->buf[1] == 0) { /* Error msg from device! */
936 switch (devc->buf[2]) {
937 case 1: /* Not used */
938 sr_err("Device: Illegal error code!");
940 case 2: /* Incorrect check sum of received block */
941 sr_err("Device: Incorrect checksum in cmd!");
943 case 3: /* Incorrect length of received block */
944 sr_err("Device: Incorrect block length in cmd!");
946 case 4: /* Incorrect 2nd or 3rd byte */
947 sr_err("Device: Incorrect byte 2 or 3 in cmd!");
949 case 5: /* Parameter out of range */
950 sr_err("Device: Parameter out of range!");
953 sr_err("Device: Unknown error code!");
957 else if (!isreq && ((devc->buf[1] != 0x27) || (devc->buf[2] != 0x3f))) {
958 sr_err("process_msg_14(): byte 1/2 unexpected!");
962 if (calc_chksum_14(devc->buf) != devc->buf[13]) {
963 sr_err("process_msg_14(): Invalid checksum!");
968 dump_msg14(devc->buf, TRUE);
973 /** Check 14-byte message, Metrahit 2x. */
974 SR_PRIV int process_msg14(struct sr_dev_inst *sdi)
976 struct dev_context *devc;
981 if ((retc = chk_msg14(sdi)) != SR_OK)
986 clean_ctmv_rs_v(devc);
987 addr = devc->buf[0] & MASK_6BITS;
988 if (addr != devc->addr)
989 sr_info("Device address mismatch %d/%d!", addr, devc->addr);
991 switch (devc->buf[3]) { /* That's the command this reply is for */
992 /* 0 cannot occur, the respective message is not a 14-byte message */
993 case 1: /* Read first free and occupied address */
994 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
996 case 2: /* Clear all RAM in multimeter */
997 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
999 case 3: /* Read firmware version and status */
1000 sr_spew("Cmd 3, Read firmware and status");
1001 switch (devc->cmd_idx) {
1003 devc->fw_ver_maj = devc->buf[5];
1004 devc->fw_ver_min = devc->buf[4];
1005 sr_spew("Firmware version %d.%d", (int)devc->fw_ver_maj, (int)devc->fw_ver_min);
1006 sr_spew("Rotary Switch Position (1..10): %d", (int)devc->buf[6]);
1007 /** Docs say values 0..9, but that's not true */
1008 sr_spew("Measurement Function: %d ", (int)devc->buf[7]);
1009 decode_ctmv_2x(devc->buf[7], devc);
1010 sr_spew("Range: 0x%x", devc->buf[8]);
1011 decode_rs_2x_TR2(devc->buf[8] & 0x0f, devc); /* Docs wrong, uses conversion table TR_2! */
1012 devc->autorng = (devc->buf[8] & 0x20) == 0;
1013 // TODO 9, 10: 29S special functions
1014 devc->ubatt = 0.1 * (float)devc->buf[11];
1015 devc->model = gmc_decode_model_bd(devc->buf[12]);
1016 sr_spew("Model=%s, battery voltage=%2.1f V", gmc_model_str(devc->model), (double)devc->ubatt);
1019 sr_spew("Internal version %d.%d", (int)devc->buf[5], (int)devc->buf[4]);
1020 sr_spew("Comm mode: 0x%x", (int)devc->buf[6]);
1021 sr_spew("Block cnt%%64: %d", (int)devc->buf[7]);
1022 sr_spew("drpCi: %d drpCh: %d", (int)devc->buf[8], (int)devc->buf[9]);
1023 // Semantics undocumented. Possibly Metrahit 29S dropouts stuff?
1026 sr_spew("Cmd 3: Unknown cmd_idx=%d", devc->cmd_idx);
1030 case 4: /* Set real time, date, sample rate, trigger, ... */
1031 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1033 case 5: /* Read real time, date, sample rate, trigger... */
1034 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1036 case 6: /* Set modes or power off */
1037 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1039 case 7: /* Set measurement function, range, autom/man. */
1040 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1042 case 8: /* Get one measurement value */
1043 sr_spew("Cmd 8, get one measurement value");
1044 sr_spew("Measurement Function: %d ", (int)devc->buf[5]);
1045 decode_ctmv_2x(devc->buf[5], devc);
1046 if (!(devc->buf[6] & 0x10)) /* If bit4=0, old data. */
1049 decode_rs_2x_TR2(devc->buf[6] & 0x0f, devc); // The docs say conversion table TR_3, but that does not work
1050 setmqf(devc, SR_MQFLAG_AUTORANGE, devc->autorng);
1052 for (cnt = 0; cnt < 6; cnt++) {
1053 dgt = bc(devc->buf[7 + cnt]);
1054 if (dgt == 10) { /* Overload */
1059 else if (dgt == 13) { /* FUSE */
1062 else if (dgt == 14) { /* Function recognition mode, OPEN */
1063 sr_info("Function recognition mode, OPEN!");
1068 devc->value += pow(10.0, cnt) * dgt;
1070 sr_spew("process_msg14() value=%f scale=%d scale1000=%d mq=%d "
1071 "unit=%d mqflags=0x%02" PRIx64, devc->value, devc->scale,
1072 devc->scale1000, devc->mq, devc->unit, (uint64_t)devc->mqflags);
1073 if (devc->value != NAN)
1074 devc->value *= pow(10, devc->scale) * pow(1000.0, devc->scale1000);
1080 sr_spew("Unknown cmd %d!", devc->buf[3]);
1087 /** Data reception callback function. */
1088 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data)
1090 struct sr_dev_inst *sdi;
1091 struct dev_context *devc;
1092 struct sr_serial_dev_inst *serial;
1098 if (!(sdi = cb_data))
1101 if (!(devc = sdi->priv))
1106 if (revents == G_IO_IN) { /* Serial data arrived. */
1107 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
1108 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
1111 buf = *(devc->buf + devc->buflen);
1112 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MSGC_MASK);
1113 devc->buflen += len;
1114 if (!devc->settings_ok) {
1116 * If no device type/settings record processed
1117 * yet, wait for one.
1119 if ((devc->buf[0] & MSGID_MASK) != MSGID_INF) {
1123 devc->settings_ok = TRUE;
1126 msgt = devc->buf[0] & MSGID_MASK;
1129 if (devc->buflen == 13) {
1130 process_msg_inf_13(sdi);
1133 } else if ((devc->buflen == 10) &&
1134 (devc->model <= METRAHIT_18S)) {
1135 process_msg_inf_10(sdi);
1139 else if ((devc->buflen >= 5) &&
1140 (devc->buf[devc->buflen - 1] &
1141 MSGID_MASK) != MSGID_DATA) {
1143 * Char just received is beginning
1146 process_msg_inf_5(sdi);
1148 devc->buf[devc->buflen - 1];
1155 if (devc->buflen == 6) {
1156 process_msg_dta_6(sdi);
1161 sr_err("Comm error, unexpected data byte!");
1168 if (sr_sw_limits_check(&devc->limits))
1169 sr_dev_acquisition_stop(sdi);
1174 SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data)
1176 struct sr_dev_inst *sdi;
1177 struct dev_context *devc;
1178 struct sr_serial_dev_inst *serial;
1184 if (!(sdi = cb_data))
1187 if (!(devc = sdi->priv))
1192 if (revents == G_IO_IN) { /* Serial data arrived. */
1193 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
1194 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
1197 buf = *(devc->buf + devc->buflen);
1198 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MASK_6BITS);
1199 devc->buf[devc->buflen] &= MASK_6BITS;
1200 devc->buflen += len;
1202 if (devc->buflen == 14) {
1203 devc->response_pending = FALSE;
1204 sr_spew("gmc_mh_2x_receive_data processing msg");
1211 if (sr_sw_limits_check(&devc->limits))
1212 sr_dev_acquisition_stop(sdi);
1214 /* Request next data set, if required */
1215 if (sdi->status == SR_ST_ACTIVE) {
1216 if (devc->response_pending) {
1217 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
1218 if (elapsed_us > (1 * 1000 * 1000)) /* Timeout! */
1219 devc->response_pending = FALSE;
1221 if (!devc->response_pending) {
1223 if (devc->cmd_seq % 10 == 0) {
1224 if (req_stat14(sdi, FALSE) != SR_OK)
1227 else if (req_meas14(sdi) != SR_OK)
1236 * Create 14 (42) byte command for Metrahit 2x multimeter in bidir mode.
1238 * Actually creates 42 bytes due to the encoding method used.
1240 * @param[in] addr Device address (0=adapter, 1..15 multimeter; for byte 0).
1241 * @param[in] func Function code (byte 3).
1242 * @param[in] params Further parameters (9 bytes)
1243 * @param[out] buf Buffer to create msg in (42 bytes).
1245 static void create_cmd_14(guchar addr, guchar func, guchar *params, guchar *buf)
1247 uint8_t dta[GMC_REPLY_SIZE]; /* Unencoded message */
1250 if (!params || !buf)
1254 dta[0] = ((addr << 2) | 0x03) & MASK_6BITS;
1256 /* 1-3: Set command header */
1261 /* 4-12: Copy further parameters */
1262 for (cnt = 0; cnt < 9; cnt++)
1263 dta[cnt + 4] = (params[cnt] & MASK_6BITS);
1265 /* 13: Checksum (b complement) */
1266 dta[13] = calc_chksum_14(dta);
1268 /* The whole message is packed into 3 bytes per byte now (lower 6 bits only) the most
1269 * peculiar way I have ever seen. Possibly to improve IR communication? */
1270 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
1271 buf[(3 * cnt) + 0] = (dta[cnt] & 0x01 ? 0x0f : 0) | (dta[cnt] & 0x02 ? 0xf0 : 0);
1272 buf[(3 * cnt) + 1] = (dta[cnt] & 0x04 ? 0x0f : 0) | (dta[cnt] & 0x08 ? 0xf0 : 0);
1273 buf[(3 * cnt) + 2] = (dta[cnt] & 0x10 ? 0x0f : 0) | (dta[cnt] & 0x20 ? 0xf0 : 0);
1277 /** Request one measurement from 2x multimeter (msg 8). */
1278 int req_meas14(const struct sr_dev_inst *sdi)
1280 struct dev_context *devc;
1281 struct sr_serial_dev_inst *serial;
1285 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1288 memset(params, 0, sizeof(params));
1291 create_cmd_14(devc->addr, 8, params, msg);
1292 devc->req_sent_at = g_get_monotonic_time();
1293 if (serial_write_blocking(serial, msg, sizeof(msg),
1294 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1298 devc->response_pending = TRUE;
1304 * Request status from 2x multimeter (msg 3).
1306 * @param[in] power_on Try to power on powered off multimeter by sending
1307 * additional messages.
1309 int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on)
1311 struct dev_context *devc;
1312 struct sr_serial_dev_inst *serial;
1316 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1319 memset(params, 0, sizeof(params));
1322 create_cmd_14(devc->addr, 3, params, msg);
1325 sr_info("Write some data and wait 3s to turn on powered off device...");
1326 if (serial_write_blocking(serial, msg, sizeof(msg),
1327 serial_timeout(serial, sizeof(msg))) < 0)
1329 g_usleep(1 * 1000 * 1000);
1330 if (serial_write_blocking(serial, msg, sizeof(msg),
1331 serial_timeout(serial, sizeof(msg))) < 0)
1333 g_usleep(1 * 1000 * 1000);
1334 if (serial_write_blocking(serial, msg, sizeof(msg),
1335 serial_timeout(serial, sizeof(msg))) < 0)
1337 g_usleep(1 * 1000 * 1000);
1338 serial_flush(serial);
1341 /* Write message and wait for reply */
1342 devc->req_sent_at = g_get_monotonic_time();
1343 if (serial_write_blocking(serial, msg, sizeof(msg),
1344 serial_timeout(serial, sizeof(msg))) < (int)sizeof(msg)) {
1348 devc->response_pending = TRUE;
1354 * Decode model in "send mode".
1356 * @param[in] mcode Model code.
1357 * @return Model code.
1359 SR_PRIV int gmc_decode_model_sm(uint8_t mcode)
1362 sr_err("decode_model(%d): Model code 0..15 expected!", mcode);
1363 return METRAHIT_NONE;
1367 case 0x04: /* 0100b */
1368 return METRAHIT_12S;
1369 case 0x08: /* 1000b */
1370 return METRAHIT_13S14A;
1371 case 0x09: /* 1001b */
1372 return METRAHIT_14S;
1373 case 0x0A: /* 1010b */
1374 return METRAHIT_15S;
1375 case 0x0B: /* 1011b */
1376 return METRAHIT_16S;
1377 case 0x06: /* 0110b (undocumented by GMC!) */
1378 return METRAHIT_16I;
1379 case 0x07: /* 0111b (undocumented by GMC!) */
1380 return METRAHIT_16T;
1381 case 0x0D: /* 1101b */
1382 return METRAHIT_18S;
1383 case 0x02: /* 0010b */
1384 return METRAHIT_22SM;
1385 case 0x03: /* 0011b */
1386 return METRAHIT_23S;
1387 case 0x0F: /* 1111b */
1388 return METRAHIT_24S;
1389 case 0x05: /* 0101b */
1390 return METRAHIT_25S;
1391 case 0x01: /* 0001b */
1392 return METRAHIT_26SM;
1393 case 0x0C: /* 1100b */
1394 return METRAHIT_28S;
1395 case 0x0E: /* 1110b */
1396 return METRAHIT_29S;
1398 sr_err("Unknown model code %d!", mcode);
1399 return METRAHIT_NONE;
1404 * Convert GMC model code in bidirectional mode to sigrok-internal one.
1406 * @param[in] mcode Model code.
1408 * @return Model code.
1410 SR_PRIV int gmc_decode_model_bd(uint8_t mcode)
1412 switch (mcode & 0x1f) {
1414 return (mcode & 0x20) ? METRAHIT_22M : METRAHIT_22S;
1416 return METRAHIT_23S;
1418 return METRAHIT_24S;
1420 return METRAHIT_25S;
1422 return (mcode & 0x20) ? METRAHIT_26M : METRAHIT_26S;
1424 return METRAHIT_28S;
1426 return METRAHIT_29S;
1428 sr_err("Unknown model code %d!", mcode);
1429 return METRAHIT_NONE;
1434 * Convert sigrok-internal model code to string.
1436 * @param[in] mcode Model code.
1438 * @return Model code string.
1440 SR_PRIV const char *gmc_model_str(enum model mcode)
1444 return "-uninitialized model variable-";
1446 return "METRAHit 12S";
1447 case METRAHIT_13S14A:
1448 return "METRAHit 13S/14A";
1450 return "METRAHit 14S";
1452 return "METRAHit 15S";
1454 return "METRAHit 16S";
1456 return "METRAHit 16I/16L";
1458 return "METRAHit 16T/16U/KMM2002";
1460 return "METRAHit 18S";
1462 return "METRAHit 22S/M";
1464 return "METRAHit 22S";
1466 return "METRAHit 22M";
1468 return "METRAHit 23S";
1470 return "METRAHit 24S";
1472 return "METRAHit 25S";
1474 return "METRAHit 26S/M";
1476 return "METRAHit 26S";
1478 return "METRAHit 26M";
1480 return "METRAHit 28S";
1482 return "METRAHit 29S";
1484 return "Unknown model code";
1488 /** @copydoc sr_dev_driver.config_set */
1489 SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
1490 const struct sr_channel_group *cg)
1492 struct dev_context *devc;
1501 case SR_CONF_POWER_OFF:
1502 if (devc->model < METRAHIT_2X)
1504 if (!g_variant_get_boolean(data))
1506 sr_info("Powering device off.");
1508 memset(params, 0, sizeof(params));
1511 create_cmd_14(devc->addr, 6, params, msg);
1512 if (serial_write_blocking(sdi->conn, msg, sizeof(msg),
1513 serial_timeout(sdi->conn, sizeof(msg))) < 0)
1516 g_usleep(2 * 1000 * 1000); /* Wait to ensure transfer before interface switched off. */
1518 case SR_CONF_LIMIT_SAMPLES:
1519 case SR_CONF_LIMIT_MSEC:
1520 return sr_sw_limits_config_set(&devc->limits, key, data);