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_old analog;
95 struct sr_datafeed_packet packet;
99 devc->buf[LINE_LENGTH] = '\0';
101 sr_spew("Received line '%s'.", devc->buf);
104 if (strlen((const char *)devc->buf) != LINE_LENGTH) {
105 sr_err("line: Invalid status '%s', must be 20 hex digits.",
111 for (pos = 0; pos < LINE_LENGTH; pos++) {
112 if (!isxdigit(devc->buf[pos])) {
113 sr_err("line: Expected hex digit in '%s' at pos %d!",
120 /* Start decoding. */
123 memset(&analog, 0, sizeof(struct sr_datafeed_analog_old));
126 * The numbers are hex digits, starting from 0.
127 * 0: Keyboard status, currently not interesting.
128 * 1: Central switch status, currently not interesting.
129 * 2: Type of measured value.
131 vt = xgittoint(devc->buf[2]);
134 analog.mq = SR_MQ_VOLTAGE;
137 analog.mq = SR_MQ_CURRENT; /* 2A */
140 analog.mq = SR_MQ_RESISTANCE;
143 analog.mq = SR_MQ_CAPACITANCE;
146 analog.mq = SR_MQ_TEMPERATURE;
149 analog.mq = SR_MQ_FREQUENCY;
152 analog.mq = SR_MQ_CURRENT; /* 10A */
155 analog.mq = SR_MQ_GAIN; /* TODO: Scale factor */
158 analog.mq = SR_MQ_GAIN; /* Percentage */
162 analog.mq = SR_MQ_GAIN; /* dB */
166 sr_err("Unknown value type: 0x%02x.", vt);
170 /* 3: Measurement range for measured value */
171 range = xgittoint(devc->buf[3]);
174 scale *= pow(10.0, range - 5);
177 scale *= pow(10.0, range - 7);
180 scale *= pow(10.0, range - 2);
183 scale *= pow(10.0, range - 12);
186 scale *= pow(10.0, range - 1);
189 scale *= pow(10.0, range - 2);
191 // No default, other value types have fixed display format.
194 /* 5: Sign and 1st digit */
195 flags = xgittoint(devc->buf[5]);
196 value = (flags & 0x03);
200 /* 6-9: 2nd-4th digit */
201 for (pos = 6; pos < 10; pos++)
202 value = value * 10 + xgittoint(devc->buf[pos]);
205 /* 10: Display counter */
206 mmode = xgittoint(devc->buf[10]);
208 case 0: /* Frequency */
209 analog.unit = SR_UNIT_HERTZ;
211 case 1: /* V TRMS, only type 5 */
212 analog.unit = SR_UNIT_VOLT;
213 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
216 analog.unit = SR_UNIT_VOLT;
217 analog.mqflags |= SR_MQFLAG_AC;
219 analog.mqflags |= SR_MQFLAG_RMS;
222 analog.unit = SR_UNIT_VOLT;
223 analog.mqflags |= SR_MQFLAG_DC;
226 analog.unit = SR_UNIT_OHM;
228 case 5: /* Continuity */
229 analog.unit = SR_UNIT_BOOLEAN;
230 analog.mq = SR_MQ_CONTINUITY;
231 /* TODO: Continuity handling is a bit odd in libsigrok. */
233 case 6: /* Degree Celsius */
234 analog.unit = SR_UNIT_CELSIUS;
236 case 7: /* Capacity */
237 analog.unit = SR_UNIT_FARAD;
239 case 8: /* Current DC */
240 analog.unit = SR_UNIT_AMPERE;
241 analog.mqflags |= SR_MQFLAG_DC;
243 case 9: /* Current AC */
244 analog.unit = SR_UNIT_AMPERE;
245 analog.mqflags |= SR_MQFLAG_AC;
247 analog.mqflags |= SR_MQFLAG_RMS;
249 case 0xa: /* Current TRMS, only type 5 */
250 analog.unit = SR_UNIT_AMPERE;
251 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
253 case 0xb: /* Diode */
254 analog.unit = SR_UNIT_VOLT;
255 analog.mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
258 sr_err("Unknown mmode: 0x%02x.", mmode);
262 /* 11: Device status */
263 devstat = xgittoint(devc->buf[11]);
266 case 1: /* Normal measurement */
268 case 2: /* Input loop (limit, reference values) */
270 case 3: /* TRANS/SENS */
273 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
275 return; /* Cannot continue. */
277 sr_err("Unknown device status: 0x%02x", devstat);
281 /* 12-19: Flags and display symbols */
283 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
284 /* 0x80: PRINT TODO: Stop polling when discovered? */
286 if (analog.mq == SR_MQ_CONTINUITY) {
288 value = 1.0; /* Beep */
294 if (flags & 0x04) /* REL */
295 analog.mqflags |= SR_MQFLAG_RELATIVE;
297 if (flags & 0x01) /* % */
298 analog.unit = SR_UNIT_PERCENTAGE;
301 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
302 if (!(flags & 0x80)) /* MAN: Manual range */
303 analog.mqflags |= SR_MQFLAG_AUTORANGE;
304 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
308 if (flags & 0x08) /* HOLD */
309 analog.mqflags |= SR_MQFLAG_HOLD;
311 if (flags & 0x02) /* MAX */
312 analog.mqflags |= SR_MQFLAG_MAX;
313 if (flags & 0x01) /* MIN */
314 analog.mqflags |= SR_MQFLAG_MIN;
317 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
318 /* 0xe0: undefined */
319 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
321 sr_warn("Low battery, measurement quality degraded!");
324 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
325 /* 0x02: Current clamp */
326 if (flags & 0x01) { /* dB */
328 * TODO: The Norma has an adjustable dB reference value. If
329 * changed from default, this is not correct.
331 if (analog.unit == SR_UNIT_VOLT)
332 analog.unit = SR_UNIT_DECIBEL_VOLT;
334 analog.unit = SR_UNIT_UNITLESS;
338 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
339 /* 0x80: Undefined. */
340 /* 0x40: Remote mode, keyboard locked */
341 /* 0x38: Undefined. */
342 /* 0x04: MIN > MAX */
343 /* 0x02: Measured value < Min */
344 /* 0x01: Measured value > Max */
346 /* 4: Flags. Evaluating this after setting value! */
347 flags = xgittoint(devc->buf[4]);
348 if (flags & 0x04) /* Invalid value */
350 else if (flags & 0x01) /* Overload */
352 if (flags & 0x02) { /* Duplicate value, has been sent before. */
353 sr_spew("Duplicate value, dismissing!");
358 sr_spew("range=%d/scale=%f/value=%f", range,
359 (double)scale, (double)value);
361 /* Finish and send packet. */
362 analog.channels = sdi->channels;
363 analog.num_samples = 1;
364 analog.data = &value;
366 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
367 packet.type = SR_DF_ANALOG_OLD;
368 packet.payload = &analog;
369 sr_session_send(devc->cb_data, &packet);
371 /* Finish processing. */
376 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
378 struct sr_dev_inst *sdi;
379 struct dev_context *devc;
380 struct sr_serial_dev_inst *serial;
382 gboolean terminating;
387 if (!(sdi = cb_data))
390 if (!(devc = sdi->priv))
394 if (revents == G_IO_IN) {
395 /* Serial data arrived. */
396 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
397 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
401 *(devc->buf + devc->buflen) = '\0';
402 if (*(devc->buf + devc->buflen - 1) == '\n') {
404 * TODO: According to specs, should be \r, but
405 * then we'd have to get rid of the \n.
407 devc->last_req_pending = FALSE;
408 nma_process_line(sdi);
414 /* If number of samples or time limit reached, stop acquisition. */
416 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
417 sdi->driver->dev_acquisition_stop(sdi, cb_data);
421 if (devc->limit_msec) {
422 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
423 if ((elapsed_s * 1000) >= devc->limit_msec) {
424 sdi->driver->dev_acquisition_stop(sdi, cb_data);
429 /* Request next package. */
431 if (devc->last_req_pending) {
432 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
433 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
434 sr_spew("Request timeout!");
435 devc->last_req_pending = FALSE;
438 if (!devc->last_req_pending) {
439 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)