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 #define LINE_LENGTH 20
29 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
30 { NMADMM_REQ_IDN, "IDN?" },
31 { NMADMM_REQ_IDN, "STATUS?" },
35 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
37 struct sr_serial_dev_inst *serial;
38 struct dev_context *devc;
39 char buf[NMADMM_BUFSIZE];
42 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
45 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
46 nmadmm_requests[req].req_str, params ? params : "");
48 sr_spew("Sending request: '%s'.", buf);
51 devc->last_req_pending = TRUE;
53 if (serial_write_blocking(serial, buf, len, 0) < 0) {
54 sr_err("Unable to send request.");
55 devc->last_req_pending = FALSE;
59 devc->req_sent_at = g_get_monotonic_time();
65 * Convert hexadecimal digit to int.
67 * @param[in] xgit Hexadecimal digit to convert.
68 * @return Int value of xgit (0 on invalid xgit).
70 SR_PRIV int xgittoint(char xgit)
72 if ((xgit >= '0') && (xgit <= '9'))
75 if ((xgit >= 'a') && (xgit <= 'f'))
81 * Process received line. It consists of 20 hex digits + \\r\\n,
82 * e.g. '08100400018100400000'.
84 static void nma_process_line(const struct sr_dev_inst *sdi)
86 struct dev_context *devc;
88 int vt, range; /* Measurement value type, range in device format */
89 int mmode, devstat; /* Measuring mode, device status */
90 float value; /* Measured value */
91 float scale; /* Scaling factor depending on range and function */
92 struct sr_datafeed_analog analog;
93 struct sr_datafeed_packet packet;
97 devc->buf[LINE_LENGTH] = '\0';
99 sr_spew("Received line '%s'.", devc->buf);
102 if (strlen((const char *)devc->buf) != LINE_LENGTH) {
103 sr_err("line: Invalid status '%s', must be 20 hex digits.",
109 for (pos = 0; pos < LINE_LENGTH; pos++) {
110 if (!isxdigit(devc->buf[pos])) {
111 sr_err("line: Expected hex digit in '%s' at pos %d!",
118 /* Start decoding. */
121 memset(&analog, 0, sizeof(struct sr_datafeed_analog));
124 * The numbers are hex digits, starting from 0.
125 * 0: Keyboard status, currently not interesting.
126 * 1: Central switch status, currently not interesting.
127 * 2: Type of measured value.
129 vt = xgittoint(devc->buf[2]);
132 analog.mq = SR_MQ_VOLTAGE;
135 analog.mq = SR_MQ_CURRENT; /* 2A */
138 analog.mq = SR_MQ_RESISTANCE;
141 analog.mq = SR_MQ_CAPACITANCE;
144 analog.mq = SR_MQ_TEMPERATURE;
147 analog.mq = SR_MQ_FREQUENCY;
150 analog.mq = SR_MQ_CURRENT; /* 10A */
153 analog.mq = SR_MQ_GAIN; /* TODO: Scale factor */
156 analog.mq = SR_MQ_GAIN; /* Percentage */
160 analog.mq = SR_MQ_GAIN; /* dB */
164 sr_err("Unknown value type: 0x%02x.", vt);
168 /* 3: Measurement range for measured value */
169 range = xgittoint(devc->buf[3]);
172 scale *= pow(10.0, range - 5);
175 scale *= pow(10.0, range - 7);
178 scale *= pow(10.0, range - 2);
181 scale *= pow(10.0, range - 12);
184 scale *= pow(10.0, range - 1);
187 scale *= pow(10.0, range - 2);
189 // No default, other value types have fixed display format.
192 /* 5: Sign and 1st digit */
193 flags = xgittoint(devc->buf[5]);
194 value = (flags & 0x03);
198 /* 6-9: 2nd-4th digit */
199 for (pos = 6; pos < 10; pos++)
200 value = value * 10 + xgittoint(devc->buf[pos]);
203 /* 10: Display counter */
204 mmode = xgittoint(devc->buf[10]);
206 case 0: /* Frequency */
207 analog.unit = SR_UNIT_HERTZ;
209 case 1: /* V TRMS, only type 5 */
210 analog.unit = SR_UNIT_VOLT;
211 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
214 analog.unit = SR_UNIT_VOLT;
215 analog.mqflags |= SR_MQFLAG_AC;
217 analog.mqflags |= SR_MQFLAG_RMS;
220 analog.unit = SR_UNIT_VOLT;
221 analog.mqflags |= SR_MQFLAG_DC;
224 analog.unit = SR_UNIT_OHM;
226 case 5: /* Continuity */
227 analog.unit = SR_UNIT_BOOLEAN;
228 analog.mq = SR_MQ_CONTINUITY;
229 /* TODO: Continuity handling is a bit odd in libsigrok. */
231 case 6: /* Degree Celsius */
232 analog.unit = SR_UNIT_CELSIUS;
234 case 7: /* Capacity */
235 analog.unit = SR_UNIT_FARAD;
237 case 8: /* Current DC */
238 analog.unit = SR_UNIT_AMPERE;
239 analog.mqflags |= SR_MQFLAG_DC;
241 case 9: /* Current AC */
242 analog.unit = SR_UNIT_AMPERE;
243 analog.mqflags |= SR_MQFLAG_AC;
245 analog.mqflags |= SR_MQFLAG_RMS;
247 case 0xa: /* Current TRMS, only type 5 */
248 analog.unit = SR_UNIT_AMPERE;
249 analog.mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
251 case 0xb: /* Diode */
252 analog.unit = SR_UNIT_VOLT;
253 analog.mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
256 sr_err("Unknown mmode: 0x%02x.", mmode);
260 /* 11: Device status */
261 devstat = xgittoint(devc->buf[11]);
264 case 1: /* Normal measurement */
266 case 2: /* Input loop (limit, reference values) */
268 case 3: /* TRANS/SENS */
271 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
273 return; /* Cannot continue. */
275 sr_err("Unknown device status: 0x%02x", devstat);
279 /* 12-19: Flags and display symbols */
281 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
282 /* 0x80: PRINT TODO: Stop polling when discovered? */
284 if (analog.mq == SR_MQ_CONTINUITY) {
286 value = 1.0; /* Beep */
292 if (flags & 0x04) /* REL */
293 analog.mqflags |= SR_MQFLAG_RELATIVE;
295 if (flags & 0x01) /* % */
296 analog.unit = SR_UNIT_PERCENTAGE;
299 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
300 if (!(flags & 0x80)) /* MAN: Manual range */
301 analog.mqflags |= SR_MQFLAG_AUTORANGE;
302 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
306 if (flags & 0x08) /* HOLD */
307 analog.mqflags |= SR_MQFLAG_HOLD;
309 if (flags & 0x02) /* MAX */
310 analog.mqflags |= SR_MQFLAG_MAX;
311 if (flags & 0x01) /* MIN */
312 analog.mqflags |= SR_MQFLAG_MIN;
315 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
316 /* 0xe0: undefined */
317 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
319 sr_warn("Low battery, measurement quality degraded!");
322 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
323 /* 0x02: Current clamp */
324 if (flags & 0x01) { /* dB */
326 * TODO: The Norma has an adjustable dB reference value. If
327 * changed from default, this is not correct.
329 if (analog.unit == SR_UNIT_VOLT)
330 analog.unit = SR_UNIT_DECIBEL_VOLT;
332 analog.unit = SR_UNIT_UNITLESS;
336 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
337 /* 0x80: Undefined. */
338 /* 0x40: Remote mode, keyboard locked */
339 /* 0x38: Undefined. */
340 /* 0x04: MIN > MAX */
341 /* 0x02: Measured value < Min */
342 /* 0x01: Measured value > Max */
344 /* 4: Flags. Evaluating this after setting value! */
345 flags = xgittoint(devc->buf[4]);
346 if (flags & 0x04) /* Invalid value */
348 else if (flags & 0x01) /* Overload */
350 if (flags & 0x02) { /* Duplicate value, has been sent before. */
351 sr_spew("Duplicate value, dismissing!");
356 sr_spew("range=%d/scale=%f/value=%f", range,
357 (double)scale, (double)value);
359 /* Finish and send packet. */
360 analog.channels = sdi->channels;
361 analog.num_samples = 1;
362 analog.data = &value;
364 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
365 packet.type = SR_DF_ANALOG;
366 packet.payload = &analog;
367 sr_session_send(devc->cb_data, &packet);
369 /* Finish processing. */
374 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
376 struct sr_dev_inst *sdi;
377 struct dev_context *devc;
378 struct sr_serial_dev_inst *serial;
380 gboolean terminating;
385 if (!(sdi = cb_data))
388 if (!(devc = sdi->priv))
392 if (revents == G_IO_IN) {
393 /* Serial data arrived. */
394 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
395 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
399 *(devc->buf + devc->buflen) = '\0';
400 if (*(devc->buf + devc->buflen - 1) == '\n') {
402 * TODO: According to specs, should be \r, but
403 * then we'd have to get rid of the \n.
405 devc->last_req_pending = FALSE;
406 nma_process_line(sdi);
412 /* If number of samples or time limit reached, stop acquisition. */
414 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples)) {
415 sdi->driver->dev_acquisition_stop(sdi, cb_data);
419 if (devc->limit_msec) {
420 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
421 if ((elapsed_s * 1000) >= devc->limit_msec) {
422 sdi->driver->dev_acquisition_stop(sdi, cb_data);
427 /* Request next package. */
429 if (devc->last_req_pending) {
430 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
431 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
432 sr_spew("Request timeout!");
433 devc->last_req_pending = FALSE;
436 if (!devc->last_req_pending) {
437 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)