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_blocking(serial, buf, len, 0) < 0) {
52 sr_err("Unable to send request.");
53 devc->last_req_pending = FALSE;
57 devc->req_sent_at = g_get_monotonic_time();
63 * Convert hexadecimal digit to int.
65 * @param[in] xgit Hexadecimal digit to convert.
66 * @return Int value of xgit (0 on invalid xgit).
68 SR_PRIV int xgittoint(char xgit)
70 if ((xgit >= '0') && (xgit <= '9'))
73 if ((xgit >= 'a') && (xgit <= 'f'))
79 * Process received line. It consists of 20 hex digits + \\r\\n,
80 * e.g. '08100400018100400000'.
82 static void nma_process_line(const struct sr_dev_inst *sdi)
84 struct dev_context *devc;
86 int vt, range; /* Measurement value type, range in device format */
87 int mmode, devstat; /* Measuring mode, device status */
88 float value; /* Measured value */
89 float scale; /* Scaling factor depending on range and function */
90 struct sr_datafeed_analog analog;
91 struct sr_datafeed_packet packet;
97 sr_spew("Received line '%s'.", devc->buf);
100 if (strlen((const char *)devc->buf) != 20) {
101 sr_err("line: Invalid status '%s', must be 20 hex digits.",
107 for (pos = 0; pos < 20; pos++) {
108 if (!isxdigit(devc->buf[pos])) {
109 sr_err("line: Expected hex digit in '%s' at pos %d!",
116 /* Start decoding. */
119 memset(&analog, 0, sizeof(analog));
122 * The numbers are hex digits, starting from 0.
123 * 0: Keyboard status, currently not interesting.
124 * 1: Central switch status, currently not interesting.
125 * 2: Type of measured value.
127 vt = xgittoint(devc->buf[2]);
130 analog.mq = SR_MQ_VOLTAGE;
133 analog.mq = SR_MQ_CURRENT; /* 2A */
136 analog.mq = SR_MQ_RESISTANCE;
139 analog.mq = SR_MQ_CAPACITANCE;
142 analog.mq = SR_MQ_TEMPERATURE;
145 analog.mq = SR_MQ_FREQUENCY;
148 analog.mq = SR_MQ_CURRENT; /* 10A */
151 analog.mq = SR_MQ_GAIN; /* TODO: Scale factor */
154 analog.mq = SR_MQ_GAIN; /* Percentage */
158 analog.mq = SR_MQ_GAIN; /* dB */
162 sr_err("Unknown value type: 0x%02x.", vt);
166 /* 3: Measurement range for measured value */
167 range = xgittoint(devc->buf[3]);
170 scale *= pow(10.0, range - 5);
173 scale *= pow(10.0, range - 7);
176 scale *= pow(10.0, range - 2);
179 scale *= pow(10.0, range - 12);
182 scale *= pow(10.0, range - 1);
185 scale *= pow(10.0, range - 2);
187 // No default, other value types have fixed display format.
190 /* 5: Sign and 1st digit */
191 flags = xgittoint(devc->buf[5]);
192 value = (flags & 0x03);
196 /* 6-9: 2nd-4th digit */
197 for (pos = 6; pos < 10; pos++)
198 value = value * 10 + xgittoint(devc->buf[pos]);
201 /* 10: Display counter */
202 mmode = xgittoint(devc->buf[10]);
204 case 0: /* Frequency */
205 analog.unit = SR_UNIT_HERTZ;
207 case 1: /* V TRMS, only type 5 */
208 analog.unit = SR_UNIT_VOLT;
209 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
212 analog.unit = SR_UNIT_VOLT;
213 analog.mqflags |= SR_MQFLAG_AC;
215 analog.mqflags |= SR_MQFLAG_RMS;
218 analog.unit = SR_UNIT_VOLT;
219 analog.mqflags |= SR_MQFLAG_DC;
222 analog.unit = SR_UNIT_OHM;
224 case 5: /* Continuity */
225 analog.unit = SR_UNIT_BOOLEAN;
226 analog.mq = SR_MQ_CONTINUITY;
227 /* TODO: Continuity handling is a bit odd in libsigrok. */
229 case 6: /* Degree Celsius */
230 analog.unit = SR_UNIT_CELSIUS;
232 case 7: /* Capacity */
233 analog.unit = SR_UNIT_FARAD;
235 case 8: /* Current DC */
236 analog.unit = SR_UNIT_AMPERE;
237 analog.mqflags |= SR_MQFLAG_DC;
239 case 9: /* Current AC */
240 analog.unit = SR_UNIT_AMPERE;
241 analog.mqflags |= SR_MQFLAG_AC;
243 analog.mqflags |= SR_MQFLAG_RMS;
245 case 0xa: /* Current TRMS, only type 5 */
246 analog.unit = SR_UNIT_AMPERE;
247 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
249 case 0xb: /* Diode */
250 analog.unit = SR_UNIT_VOLT;
251 analog.mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
254 sr_err("Unknown mmode: 0x%02x.", mmode);
258 /* 11: Device status */
259 devstat = xgittoint(devc->buf[11]);
262 case 1: /* Normal measurement */
264 case 2: /* Input loop (limit, reference values) */
266 case 3: /* TRANS/SENS */
269 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
271 return; /* Cannot continue. */
273 sr_err("Unknown device status: 0x%02x", devstat);
277 /* 12-19: Flags and display symbols */
279 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
280 /* 0x80: PRINT TODO: Stop polling when discovered? */
282 if (analog.mq == SR_MQ_CONTINUITY) {
284 value = 1.0; /* Beep */
290 if (flags & 0x04) /* REL */
291 analog.mqflags |= SR_MQFLAG_RELATIVE;
293 if (flags & 0x01) /* % */
294 analog.unit = SR_UNIT_PERCENTAGE;
297 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
298 if (!(flags & 0x80)) /* MAN: Manual range */
299 analog.mqflags |= SR_MQFLAG_AUTORANGE;
300 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
304 if (flags & 0x08) /* HOLD */
305 analog.mqflags |= SR_MQFLAG_HOLD;
307 if (flags & 0x02) /* MAX */
308 analog.mqflags |= SR_MQFLAG_MAX;
309 if (flags & 0x01) /* MIN */
310 analog.mqflags |= SR_MQFLAG_MIN;
313 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
314 /* 0xe0: undefined */
315 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
317 sr_warn("Low battery, measurement quality degraded!");
320 /* 0x04: RATE (=lower resolution, allows higher rata rate up to 10/s. */
321 /* 0x02: Current clamp */
322 if (flags & 0x01) { /* dB */
324 * TODO: The Norma has an adjustable dB reference value. If
325 * changed from default, this is not correct.
327 if (analog.unit == SR_UNIT_VOLT)
328 analog.unit = SR_UNIT_DECIBEL_VOLT;
330 analog.unit = SR_UNIT_UNITLESS;
334 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
335 /* 0x80: Undefined. */
336 /* 0x40: Remote mode, keyboard locked */
337 /* 0x38: Undefined. */
338 /* 0x04: MIN > MAX */
339 /* 0x02: Measured value < Min */
340 /* 0x01: Measured value > Max */
342 /* 4: Flags. Evaluating this after setting value! */
343 flags = xgittoint(devc->buf[4]);
344 if (flags & 0x04) /* Invalid value */
346 else if (flags & 0x01) /* Overload */
348 if (flags & 0x02) { /* Duplicate value, has been sent before. */
349 sr_spew("Duplicate value, dismissing!");
354 sr_spew("range=%d/scale=%f/value=%f", range,
355 (double)scale, (double)value);
357 /* Finish and send packet. */
358 analog.channels = sdi->channels;
359 analog.num_samples = 1;
360 analog.data = &value;
362 memset(&packet, 0, sizeof(packet));
363 packet.type = SR_DF_ANALOG;
364 packet.payload = &analog;
365 sr_session_send(devc->cb_data, &packet);
367 /* Finish processing. */
372 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
374 struct sr_dev_inst *sdi;
375 struct dev_context *devc;
376 struct sr_serial_dev_inst *serial;
378 gboolean terminating;
383 if (!(sdi = cb_data))
386 if (!(devc = sdi->priv))
390 if (revents == G_IO_IN) {
391 /* Serial data arrived. */
392 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
393 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
397 *(devc->buf + devc->buflen) = '\0';
398 if (*(devc->buf + devc->buflen - 1) == '\n') {
400 * TODO: According to specs, should be \r, but
401 * then we'd have to get rid of the \n.
403 devc->last_req_pending = FALSE;
404 nma_process_line(sdi);
410 /* If number of samples or time limit reached, stop acquisition. */
412 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
413 sdi->driver->dev_acquisition_stop(sdi, cb_data);
417 if (devc->limit_msec) {
418 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
419 if ((elapsed_s * 1000) >= devc->limit_msec) {
420 sdi->driver->dev_acquisition_stop(sdi, cb_data);
425 /* Request next package. */
427 if (devc->last_req_pending) {
428 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
429 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
430 sr_spew("Request timeout!");
431 devc->last_req_pending = FALSE;
434 if (!devc->last_req_pending) {
435 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)