2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 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 * Norma DM9x0/Siemens B102x DMMs driver.
28 #define LINE_LENGTH 20
30 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
31 { NMADMM_REQ_IDN, "IDN?" },
32 { NMADMM_REQ_IDN, "STATUS?" },
36 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
38 struct sr_serial_dev_inst *serial;
39 struct dev_context *devc;
40 char buf[NMADMM_BUFSIZE];
43 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
46 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
47 nmadmm_requests[req].req_str, params ? params : "");
49 sr_spew("Sending request: '%s'.", buf);
52 devc->last_req_pending = TRUE;
54 if (serial_write_blocking(serial, buf, len,
55 serial_timeout(serial, len)) < 0) {
56 sr_err("Unable to send request.");
57 devc->last_req_pending = FALSE;
61 devc->req_sent_at = g_get_monotonic_time();
67 * Convert hexadecimal digit to int.
69 * @param[in] xgit Hexadecimal digit to convert.
70 * @return Int value of xgit (0 on invalid xgit).
72 SR_PRIV int xgittoint(char xgit)
74 if ((xgit >= '0') && (xgit <= '9'))
77 if ((xgit >= 'a') && (xgit <= 'f'))
83 * Process received line. It consists of 20 hex digits + \\r\\n,
84 * e.g. '08100400018100400000'.
86 static void nma_process_line(const struct sr_dev_inst *sdi)
88 struct dev_context *devc;
90 int vt, range; /* Measurement value type, range in device format */
91 int mmode, devstat; /* Measuring mode, device status */
92 float value; /* Measured value */
93 float scale; /* Scaling factor depending on range and function */
94 struct sr_datafeed_analog analog;
95 struct sr_analog_encoding encoding;
96 struct sr_analog_meaning meaning;
97 struct sr_analog_spec spec;
98 struct sr_datafeed_packet packet;
102 devc->buf[LINE_LENGTH] = '\0';
104 sr_spew("Received line '%s'.", devc->buf);
107 if (strlen((const char *)devc->buf) != LINE_LENGTH) {
108 sr_err("line: Invalid status '%s', must be 20 hex digits.",
114 for (pos = 0; pos < LINE_LENGTH; pos++) {
115 if (!isxdigit(devc->buf[pos])) {
116 sr_err("line: Expected hex digit in '%s' at pos %d!",
123 /* Start decoding. */
126 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
129 * The numbers are hex digits, starting from 0.
130 * 0: Keyboard status, currently not interesting.
131 * 1: Central switch status, currently not interesting.
132 * 2: Type of measured value.
134 vt = xgittoint(devc->buf[2]);
137 analog.meaning->mq = SR_MQ_VOLTAGE;
140 analog.meaning->mq = SR_MQ_CURRENT; /* 2A */
143 analog.meaning->mq = SR_MQ_RESISTANCE;
146 analog.meaning->mq = SR_MQ_CAPACITANCE;
149 analog.meaning->mq = SR_MQ_TEMPERATURE;
152 analog.meaning->mq = SR_MQ_FREQUENCY;
155 analog.meaning->mq = SR_MQ_CURRENT; /* 10A */
158 analog.meaning->mq = SR_MQ_GAIN; /* TODO: Scale factor */
161 analog.meaning->mq = SR_MQ_GAIN; /* Percentage */
165 analog.meaning->mq = SR_MQ_GAIN; /* dB */
169 sr_err("Unknown value type: 0x%02x.", vt);
173 /* 3: Measurement range for measured value */
174 range = xgittoint(devc->buf[3]);
177 scale *= pow(10.0, range - 5);
180 scale *= pow(10.0, range - 7);
183 scale *= pow(10.0, range - 2);
186 scale *= pow(10.0, range - 12);
189 scale *= pow(10.0, range - 1);
192 scale *= pow(10.0, range - 2);
194 // No default, other value types have fixed display format.
197 /* 5: Sign and 1st digit */
198 flags = xgittoint(devc->buf[5]);
199 value = (flags & 0x03);
203 /* 6-9: 2nd-4th digit */
204 for (pos = 6; pos < 10; pos++)
205 value = value * 10 + xgittoint(devc->buf[pos]);
208 /* 10: Display counter */
209 mmode = xgittoint(devc->buf[10]);
211 case 0: /* Frequency */
212 analog.meaning->unit = SR_UNIT_HERTZ;
214 case 1: /* V TRMS, only type 5 */
215 analog.meaning->unit = SR_UNIT_VOLT;
216 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
219 analog.meaning->unit = SR_UNIT_VOLT;
220 analog.meaning->mqflags |= SR_MQFLAG_AC;
222 analog.meaning->mqflags |= SR_MQFLAG_RMS;
225 analog.meaning->unit = SR_UNIT_VOLT;
226 analog.meaning->mqflags |= SR_MQFLAG_DC;
229 analog.meaning->unit = SR_UNIT_OHM;
231 case 5: /* Continuity */
232 analog.meaning->unit = SR_UNIT_BOOLEAN;
233 analog.meaning->mq = SR_MQ_CONTINUITY;
234 /* TODO: Continuity handling is a bit odd in libsigrok. */
236 case 6: /* Degree Celsius */
237 analog.meaning->unit = SR_UNIT_CELSIUS;
239 case 7: /* Capacity */
240 analog.meaning->unit = SR_UNIT_FARAD;
242 case 8: /* Current DC */
243 analog.meaning->unit = SR_UNIT_AMPERE;
244 analog.meaning->mqflags |= SR_MQFLAG_DC;
246 case 9: /* Current AC */
247 analog.meaning->unit = SR_UNIT_AMPERE;
248 analog.meaning->mqflags |= SR_MQFLAG_AC;
250 analog.meaning->mqflags |= SR_MQFLAG_RMS;
252 case 0xa: /* Current TRMS, only type 5 */
253 analog.meaning->unit = SR_UNIT_AMPERE;
254 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
256 case 0xb: /* Diode */
257 analog.meaning->unit = SR_UNIT_VOLT;
258 analog.meaning->mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
261 sr_err("Unknown mmode: 0x%02x.", mmode);
265 /* 11: Device status */
266 devstat = xgittoint(devc->buf[11]);
269 case 1: /* Normal measurement */
271 case 2: /* Input loop (limit, reference values) */
273 case 3: /* TRANS/SENS */
276 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
278 return; /* Cannot continue. */
280 sr_err("Unknown device status: 0x%02x", devstat);
284 /* 12-19: Flags and display symbols */
286 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
287 /* 0x80: PRINT TODO: Stop polling when discovered? */
289 if (analog.meaning->mq == SR_MQ_CONTINUITY) {
291 value = 1.0; /* Beep */
297 if (flags & 0x04) /* REL */
298 analog.meaning->mqflags |= SR_MQFLAG_RELATIVE;
300 if (flags & 0x01) /* % */
301 analog.meaning->unit = SR_UNIT_PERCENTAGE;
304 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
305 if (!(flags & 0x80)) /* MAN: Manual range */
306 analog.meaning->mqflags |= SR_MQFLAG_AUTORANGE;
307 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
311 if (flags & 0x08) /* HOLD */
312 analog.meaning->mqflags |= SR_MQFLAG_HOLD;
314 if (flags & 0x02) /* MAX */
315 analog.meaning->mqflags |= SR_MQFLAG_MAX;
316 if (flags & 0x01) /* MIN */
317 analog.meaning->mqflags |= SR_MQFLAG_MIN;
320 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
321 /* 0xe0: undefined */
322 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
324 sr_warn("Low battery, measurement quality degraded!");
327 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
328 /* 0x02: Current clamp */
329 if (flags & 0x01) { /* dB */
331 * TODO: The Norma has an adjustable dB reference value. If
332 * changed from default, this is not correct.
334 if (analog.meaning->unit == SR_UNIT_VOLT)
335 analog.meaning->unit = SR_UNIT_DECIBEL_VOLT;
337 analog.meaning->unit = SR_UNIT_UNITLESS;
341 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
342 /* 0x80: Undefined. */
343 /* 0x40: Remote mode, keyboard locked */
344 /* 0x38: Undefined. */
345 /* 0x04: MIN > MAX */
346 /* 0x02: Measured value < Min */
347 /* 0x01: Measured value > Max */
349 /* 4: Flags. Evaluating this after setting value! */
350 flags = xgittoint(devc->buf[4]);
351 if (flags & 0x04) /* Invalid value */
353 else if (flags & 0x01) /* Overload */
355 if (flags & 0x02) { /* Duplicate value, has been sent before. */
356 sr_spew("Duplicate value, dismissing!");
361 sr_spew("range=%d/scale=%f/value=%f", range,
362 (double)scale, (double)value);
364 /* Finish and send packet. */
365 analog.meaning->channels = sdi->channels;
366 analog.num_samples = 1;
367 analog.data = &value;
369 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
370 packet.type = SR_DF_ANALOG;
371 packet.payload = &analog;
372 sr_session_send(sdi, &packet);
374 /* Finish processing. */
375 sr_sw_limits_update_samples_read(&devc->limits, 1);
379 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
381 struct sr_dev_inst *sdi;
382 struct dev_context *devc;
383 struct sr_serial_dev_inst *serial;
388 if (!(sdi = cb_data))
391 if (!(devc = sdi->priv))
395 if (revents == G_IO_IN) {
396 /* Serial data arrived. */
397 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
398 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
402 *(devc->buf + devc->buflen) = '\0';
403 if (*(devc->buf + devc->buflen - 1) == '\n') {
405 * TODO: According to specs, should be \r, but
406 * then we'd have to get rid of the \n.
408 devc->last_req_pending = FALSE;
409 nma_process_line(sdi);
415 if (sr_sw_limits_check(&devc->limits)) {
416 sdi->driver->dev_acquisition_stop(sdi);
418 /* Request next package. */
419 if (devc->last_req_pending) {
420 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
421 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
422 sr_spew("Request timeout!");
423 devc->last_req_pending = FALSE;
426 if (!devc->last_req_pending) {
427 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)