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.
27 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
28 { NMADMM_REQ_IDN, "IDN?" },
29 { NMADMM_REQ_IDN, "STATUS?" },
33 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
35 struct sr_serial_dev_inst *serial;
36 struct dev_context *devc;
37 char buf[NMADMM_BUFSIZE];
40 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
43 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
44 nmadmm_requests[req].req_str, params ? params : "");
46 sr_spew("Sending request: '%s'.", buf);
49 devc->last_req_pending = TRUE;
51 if (serial_write(serial, buf, len) == -1) {
52 sr_err("Unable to send request: %d %s.",
53 errno, strerror(errno));
54 devc->last_req_pending = FALSE;
58 devc->req_sent_at = g_get_monotonic_time();
64 * Convert hexadecimal digit to int.
66 * @param[in] xgit Hexadecimal digit to convert.
67 * @return Int value of xgit (0 on invalid xgit).
69 SR_PRIV int xgittoint(char xgit)
71 if ((xgit >= '0') && (xgit <= '9'))
74 if ((xgit >= 'a') && (xgit <= 'f'))
80 * Process received line. It consists of 20 hex digits + \\r\\n,
81 * e.g. '08100400018100400000'.
83 static void nma_process_line(const struct sr_dev_inst *sdi)
85 struct dev_context *devc;
87 int vt, range; /* Measurement value type, range in device format */
88 int mmode, devstat; /* Measuring mode, device status */
89 float value; /* Measured value */
90 float scale; /* Scaling factor depending on range and function */
91 struct sr_datafeed_analog analog;
92 struct sr_datafeed_packet packet;
98 sr_spew("Received line '%s'.", devc->buf);
101 if (strlen((const char *)devc->buf) != 20) {
102 sr_err("line: Invalid status '%s', must be 20 hex digits.",
108 for (pos = 0; pos < 20; pos++) {
109 if (!isxdigit(devc->buf[pos])) {
110 sr_err("line: Expected hex digit in '%s' at pos %d!",
117 /* Start decoding. */
120 memset(&analog, 0, sizeof(analog));
123 * The numbers are hex digits, starting from 0.
124 * 0: Keyboard status, currently not interesting.
125 * 1: Central switch status, currently not interesting.
126 * 2: Type of measured value.
128 vt = xgittoint(devc->buf[2]);
131 analog.mq = SR_MQ_VOLTAGE;
134 analog.mq = SR_MQ_CURRENT; /* 2A */
137 analog.mq = SR_MQ_RESISTANCE;
140 analog.mq = SR_MQ_CAPACITANCE;
143 analog.mq = SR_MQ_TEMPERATURE;
146 analog.mq = SR_MQ_FREQUENCY;
149 analog.mq = SR_MQ_CURRENT; /* 10A */
152 analog.mq = SR_MQ_GAIN; /* TODO: Scale factor */
155 analog.mq = SR_MQ_GAIN; /* Percentage */
159 analog.mq = SR_MQ_GAIN; /* dB */
163 sr_err("Unknown value type: 0x%02x.", vt);
167 /* 3: Measurement range for measured value */
168 range = xgittoint(devc->buf[3]);
171 scale *= pow(10.0, range - 5);
174 scale *= pow(10.0, range - 7);
177 scale *= pow(10.0, range - 2);
180 scale *= pow(10.0, range - 12);
183 scale *= pow(10.0, range - 1);
186 scale *= pow(10.0, range - 2);
188 // No default, other value types have fixed display format.
191 /* 5: Sign and 1st digit */
192 flags = xgittoint(devc->buf[5]);
193 value = (flags & 0x03);
197 /* 6-9: 2nd-4th digit */
198 for (pos = 6; pos < 10; pos++)
199 value = value * 10 + xgittoint(devc->buf[pos]);
202 /* 10: Display counter */
203 mmode = xgittoint(devc->buf[10]);
205 case 0: /* Frequency */
206 analog.unit = SR_UNIT_HERTZ;
208 case 1: /* V TRMS, only type 5 */
209 analog.unit = SR_UNIT_VOLT;
210 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
213 analog.unit = SR_UNIT_VOLT;
214 analog.mqflags |= SR_MQFLAG_AC;
216 analog.mqflags |= SR_MQFLAG_RMS;
219 analog.unit = SR_UNIT_VOLT;
220 analog.mqflags |= SR_MQFLAG_DC;
223 analog.unit = SR_UNIT_OHM;
225 case 5: /* Continuity */
226 analog.unit = SR_UNIT_BOOLEAN;
227 analog.mq = SR_MQ_CONTINUITY;
228 /* TODO: Continuity handling is a bit odd in libsigrok. */
230 case 6: /* Degree Celsius */
231 analog.unit = SR_UNIT_CELSIUS;
233 case 7: /* Capacity */
234 analog.unit = SR_UNIT_FARAD;
236 case 8: /* Current DC */
237 analog.unit = SR_UNIT_AMPERE;
238 analog.mqflags |= SR_MQFLAG_DC;
240 case 9: /* Current AC */
241 analog.unit = SR_UNIT_AMPERE;
242 analog.mqflags |= SR_MQFLAG_AC;
244 analog.mqflags |= SR_MQFLAG_RMS;
246 case 0xa: /* Current TRMS, only type 5 */
247 analog.unit = SR_UNIT_AMPERE;
248 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
250 case 0xb: /* Diode */
251 analog.unit = SR_UNIT_VOLT;
252 analog.mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
255 sr_err("Unknown mmode: 0x%02x.", mmode);
259 /* 11: Device status */
260 devstat = xgittoint(devc->buf[11]);
263 case 1: /* Normal measurement */
265 case 2: /* Input loop (limit, reference values) */
267 case 3: /* TRANS/SENS */
270 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
272 return; /* Cannot continue. */
274 sr_err("Unknown device status: 0x%02x", devstat);
278 /* 12-19: Flags and display symbols */
280 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
281 /* 0x80: PRINT TODO: Stop polling when discovered? */
283 if (analog.mq == SR_MQ_CONTINUITY) {
285 value = 1.0; /* Beep */
291 if (flags & 0x04) /* REL */
292 analog.mqflags |= SR_MQFLAG_RELATIVE;
294 if (flags & 0x01) /* % */
295 analog.unit = SR_UNIT_PERCENTAGE;
298 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
299 if (!(flags & 0x80)) /* MAN: Manual range */
300 analog.mqflags |= SR_MQFLAG_AUTORANGE;
301 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
305 if (flags & 0x08) /* HOLD */
306 analog.mqflags |= SR_MQFLAG_HOLD;
308 if (flags & 0x02) /* MAX */
309 analog.mqflags |= SR_MQFLAG_MAX;
310 if (flags & 0x01) /* MIN */
311 analog.mqflags |= SR_MQFLAG_MIN;
314 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
315 /* 0xe0: undefined */
316 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
318 sr_warn("Low battery, measurement quality degraded!");
321 /* 0x04: RATE (=lower resolution, allows higher rata rate up to 10/s. */
322 /* 0x02: Current clamp */
323 if (flags & 0x01) { /* dB */
325 * TODO: The Norma has an adjustable dB reference value. If
326 * changed from default, this is not correct.
328 if (analog.unit == SR_UNIT_VOLT)
329 analog.unit = SR_UNIT_DECIBEL_VOLT;
331 analog.unit = SR_UNIT_UNITLESS;
335 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
336 /* 0x80: Undefined. */
337 /* 0x40: Remote mode, keyboard locked */
338 /* 0x38: Undefined. */
339 /* 0x04: MIN > MAX */
340 /* 0x02: Measured value < Min */
341 /* 0x01: Measured value > Max */
343 /* 4: Flags. Evaluating this after setting value! */
344 flags = xgittoint(devc->buf[4]);
345 if (flags & 0x04) /* Invalid value */
347 else if (flags & 0x01) /* Overload */
349 if (flags & 0x02) { /* Duplicate value, has been sent before. */
350 sr_spew("Duplicate value, dismissing!");
355 sr_spew("range=%d/scale=%f/value=%f", range,
356 (double)scale, (double)value);
358 /* Finish and send packet. */
359 analog.channels = sdi->channels;
360 analog.num_samples = 1;
361 analog.data = &value;
363 memset(&packet, 0, sizeof(packet));
364 packet.type = SR_DF_ANALOG;
365 packet.payload = &analog;
366 sr_session_send(devc->cb_data, &packet);
368 /* Finish processing. */
373 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
375 struct sr_dev_inst *sdi;
376 struct dev_context *devc;
377 struct sr_serial_dev_inst *serial;
379 gboolean terminating;
384 if (!(sdi = cb_data))
387 if (!(devc = sdi->priv))
391 if (revents == G_IO_IN) {
392 /* Serial data arrived. */
393 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
394 len = serial_read(serial, devc->buf + devc->buflen, 1);
398 *(devc->buf + devc->buflen) = '\0';
399 if (*(devc->buf + devc->buflen - 1) == '\n') {
401 * TODO: According to specs, should be \r, but
402 * then we'd have to get rid of the \n.
404 devc->last_req_pending = FALSE;
405 nma_process_line(sdi);
411 /* If number of samples or time limit reached, stop acquisition. */
413 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
414 sdi->driver->dev_acquisition_stop(sdi, cb_data);
418 if (devc->limit_msec) {
419 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
420 if ((elapsed_s * 1000) >= devc->limit_msec) {
421 sdi->driver->dev_acquisition_stop(sdi, cb_data);
426 /* Request next package. */
428 if (devc->last_req_pending) {
429 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
430 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
431 sr_spew("Request timeout!");
432 devc->last_req_pending = FALSE;
435 if (!devc->last_req_pending) {
436 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)