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/>.
23 * Norma DM9x0/Siemens B102x DMMs driver.
31 #define LINE_LENGTH 20
33 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
34 { NMADMM_REQ_IDN, "IDN?" },
35 { NMADMM_REQ_IDN, "STATUS?" },
39 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
41 struct sr_serial_dev_inst *serial;
42 struct dev_context *devc;
43 char buf[NMADMM_BUFSIZE];
46 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
49 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
50 nmadmm_requests[req].req_str, params ? params : "");
52 sr_spew("Sending request: '%s'.", buf);
55 devc->last_req_pending = TRUE;
57 if (serial_write_blocking(serial, buf, len,
58 serial_timeout(serial, len)) < 0) {
59 sr_err("Unable to send request.");
60 devc->last_req_pending = FALSE;
64 devc->req_sent_at = g_get_monotonic_time();
70 * Convert hexadecimal digit to int.
72 * @param[in] xgit Hexadecimal digit to convert.
73 * @return Int value of xgit (0 on invalid xgit).
75 SR_PRIV int xgittoint(char xgit)
77 if ((xgit >= '0') && (xgit <= '9'))
80 if ((xgit >= 'a') && (xgit <= 'f'))
86 * Process received line. It consists of 20 hex digits + \\r\\n,
87 * e.g. '08100400018100400000'.
89 static void nma_process_line(const struct sr_dev_inst *sdi)
91 struct dev_context *devc;
93 int vt, range; /* Measurement value type, range in device format */
94 int mmode, devstat; /* Measuring mode, device status */
95 float value; /* Measured value */
96 float scale; /* Scaling factor depending on range and function */
97 struct sr_datafeed_analog analog;
98 struct sr_analog_encoding encoding;
99 struct sr_analog_meaning meaning;
100 struct sr_analog_spec spec;
101 struct sr_datafeed_packet packet;
105 devc->buf[LINE_LENGTH] = '\0';
107 sr_spew("Received line '%s'.", devc->buf);
110 if (strlen((const char *)devc->buf) != LINE_LENGTH) {
111 sr_err("line: Invalid status '%s', must be 20 hex digits.",
117 for (pos = 0; pos < LINE_LENGTH; pos++) {
118 if (!isxdigit(devc->buf[pos])) {
119 sr_err("line: Expected hex digit in '%s' at pos %d!",
126 /* Start decoding. */
129 /* TODO: Use proper 'digits' value for this device (and its modes). */
130 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
133 * The numbers are hex digits, starting from 0.
134 * 0: Keyboard status, currently not interesting.
135 * 1: Central switch status, currently not interesting.
136 * 2: Type of measured value.
138 vt = xgittoint(devc->buf[2]);
141 analog.meaning->mq = SR_MQ_VOLTAGE;
144 analog.meaning->mq = SR_MQ_CURRENT; /* 2A */
147 analog.meaning->mq = SR_MQ_RESISTANCE;
150 analog.meaning->mq = SR_MQ_CAPACITANCE;
153 analog.meaning->mq = SR_MQ_TEMPERATURE;
156 analog.meaning->mq = SR_MQ_FREQUENCY;
159 analog.meaning->mq = SR_MQ_CURRENT; /* 10A */
162 analog.meaning->mq = SR_MQ_GAIN; /* TODO: Scale factor */
165 analog.meaning->mq = SR_MQ_GAIN; /* Percentage */
169 analog.meaning->mq = SR_MQ_GAIN; /* dB */
173 sr_err("Unknown value type: 0x%02x.", vt);
177 /* 3: Measurement range for measured value */
178 range = xgittoint(devc->buf[3]);
181 scale *= pow(10.0, range - 5);
184 scale *= pow(10.0, range - 7);
187 scale *= pow(10.0, range - 2);
190 scale *= pow(10.0, range - 12);
193 scale *= pow(10.0, range - 1);
196 scale *= pow(10.0, range - 2);
198 // No default, other value types have fixed display format.
201 /* 5: Sign and 1st digit */
202 flags = xgittoint(devc->buf[5]);
203 value = (flags & 0x03);
207 /* 6-9: 2nd-4th digit */
208 for (pos = 6; pos < 10; pos++)
209 value = value * 10 + xgittoint(devc->buf[pos]);
212 /* 10: Display counter */
213 mmode = xgittoint(devc->buf[10]);
215 case 0: /* Frequency */
216 analog.meaning->unit = SR_UNIT_HERTZ;
218 case 1: /* V TRMS, only type 5 */
219 analog.meaning->unit = SR_UNIT_VOLT;
220 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
223 analog.meaning->unit = SR_UNIT_VOLT;
224 analog.meaning->mqflags |= SR_MQFLAG_AC;
226 analog.meaning->mqflags |= SR_MQFLAG_RMS;
229 analog.meaning->unit = SR_UNIT_VOLT;
230 analog.meaning->mqflags |= SR_MQFLAG_DC;
233 analog.meaning->unit = SR_UNIT_OHM;
235 case 5: /* Continuity */
236 analog.meaning->unit = SR_UNIT_BOOLEAN;
237 analog.meaning->mq = SR_MQ_CONTINUITY;
238 /* TODO: Continuity handling is a bit odd in libsigrok. */
240 case 6: /* Degree Celsius */
241 analog.meaning->unit = SR_UNIT_CELSIUS;
243 case 7: /* Capacity */
244 analog.meaning->unit = SR_UNIT_FARAD;
246 case 8: /* Current DC */
247 analog.meaning->unit = SR_UNIT_AMPERE;
248 analog.meaning->mqflags |= SR_MQFLAG_DC;
250 case 9: /* Current AC */
251 analog.meaning->unit = SR_UNIT_AMPERE;
252 analog.meaning->mqflags |= SR_MQFLAG_AC;
254 analog.meaning->mqflags |= SR_MQFLAG_RMS;
256 case 0xa: /* Current TRMS, only type 5 */
257 analog.meaning->unit = SR_UNIT_AMPERE;
258 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
260 case 0xb: /* Diode */
261 analog.meaning->unit = SR_UNIT_VOLT;
262 analog.meaning->mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
265 sr_err("Unknown mmode: 0x%02x.", mmode);
269 /* 11: Device status */
270 devstat = xgittoint(devc->buf[11]);
273 case 1: /* Normal measurement */
275 case 2: /* Input loop (limit, reference values) */
277 case 3: /* TRANS/SENS */
280 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
282 return; /* Cannot continue. */
284 sr_err("Unknown device status: 0x%02x", devstat);
288 /* 12-19: Flags and display symbols */
290 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
291 /* 0x80: PRINT TODO: Stop polling when discovered? */
293 if (analog.meaning->mq == SR_MQ_CONTINUITY) {
295 value = 1.0; /* Beep */
301 if (flags & 0x04) /* REL */
302 analog.meaning->mqflags |= SR_MQFLAG_RELATIVE;
304 if (flags & 0x01) /* % */
305 analog.meaning->unit = SR_UNIT_PERCENTAGE;
308 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
309 if (!(flags & 0x80)) /* MAN: Manual range */
310 analog.meaning->mqflags |= SR_MQFLAG_AUTORANGE;
311 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
315 if (flags & 0x08) /* HOLD */
316 analog.meaning->mqflags |= SR_MQFLAG_HOLD;
318 if (flags & 0x02) /* MAX */
319 analog.meaning->mqflags |= SR_MQFLAG_MAX;
320 if (flags & 0x01) /* MIN */
321 analog.meaning->mqflags |= SR_MQFLAG_MIN;
324 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
325 /* 0xe0: undefined */
326 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
328 sr_warn("Low battery, measurement quality degraded!");
331 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
332 /* 0x02: Current clamp */
333 if (flags & 0x01) { /* dB */
335 * TODO: The Norma has an adjustable dB reference value. If
336 * changed from default, this is not correct.
338 if (analog.meaning->unit == SR_UNIT_VOLT)
339 analog.meaning->unit = SR_UNIT_DECIBEL_VOLT;
341 analog.meaning->unit = SR_UNIT_UNITLESS;
345 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
346 /* 0x80: Undefined. */
347 /* 0x40: Remote mode, keyboard locked */
348 /* 0x38: Undefined. */
349 /* 0x04: MIN > MAX */
350 /* 0x02: Measured value < Min */
351 /* 0x01: Measured value > Max */
353 /* 4: Flags. Evaluating this after setting value! */
354 flags = xgittoint(devc->buf[4]);
355 if (flags & 0x04) /* Invalid value */
357 else if (flags & 0x01) /* Overload */
359 if (flags & 0x02) { /* Duplicate value, has been sent before. */
360 sr_spew("Duplicate value, dismissing!");
365 sr_spew("range=%d/scale=%f/value=%f", range,
366 (double)scale, (double)value);
368 /* Finish and send packet. */
369 analog.meaning->channels = sdi->channels;
370 analog.num_samples = 1;
371 analog.data = &value;
373 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
374 packet.type = SR_DF_ANALOG;
375 packet.payload = &analog;
376 sr_session_send(sdi, &packet);
378 /* Finish processing. */
379 sr_sw_limits_update_samples_read(&devc->limits, 1);
383 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
385 struct sr_dev_inst *sdi;
386 struct dev_context *devc;
387 struct sr_serial_dev_inst *serial;
392 if (!(sdi = cb_data))
395 if (!(devc = sdi->priv))
399 if (revents == G_IO_IN) {
400 /* Serial data arrived. */
401 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
402 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
406 *(devc->buf + devc->buflen) = '\0';
407 if (*(devc->buf + devc->buflen - 1) == '\n') {
409 * TODO: According to specs, should be \r, but
410 * then we'd have to get rid of the \n.
412 devc->last_req_pending = FALSE;
413 nma_process_line(sdi);
419 if (sr_sw_limits_check(&devc->limits)) {
420 sr_dev_acquisition_stop(sdi);
422 /* Request next package. */
423 if (devc->last_req_pending) {
424 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
425 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
426 sr_spew("Request timeout!");
427 devc->last_req_pending = FALSE;
430 if (!devc->last_req_pending) {
431 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)