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 #define LINE_LENGTH 20
25 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
26 { NMADMM_REQ_IDN, "IDN?" },
27 { NMADMM_REQ_IDN, "STATUS?" },
31 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
33 struct sr_serial_dev_inst *serial;
34 struct dev_context *devc;
35 char buf[NMADMM_BUFSIZE];
38 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
41 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
42 nmadmm_requests[req].req_str, params ? params : "");
44 sr_spew("Sending request: '%s'.", buf);
47 devc->last_req_pending = TRUE;
49 if (serial_write_blocking(serial, buf, len,
50 serial_timeout(serial, len)) < 0) {
51 sr_err("Unable to send request.");
52 devc->last_req_pending = FALSE;
56 devc->req_sent_at = g_get_monotonic_time();
62 * Convert hexadecimal digit to int.
64 * @param[in] xgit Hexadecimal digit to convert.
65 * @return Int value of xgit (0 on invalid xgit).
67 SR_PRIV int xgittoint(char xgit)
69 if ((xgit >= '0') && (xgit <= '9'))
72 if ((xgit >= 'a') && (xgit <= 'f'))
78 * Process received line. It consists of 20 hex digits + \\r\\n,
79 * e.g. '08100400018100400000'.
81 static void nma_process_line(const struct sr_dev_inst *sdi)
83 struct dev_context *devc;
85 int vt, range; /* Measurement value type, range in device format */
86 int mmode, devstat; /* Measuring mode, device status */
87 float value; /* Measured value */
88 float scale; /* Scaling factor depending on range and function */
89 struct sr_datafeed_analog analog;
90 struct sr_analog_encoding encoding;
91 struct sr_analog_meaning meaning;
92 struct sr_analog_spec spec;
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 /* TODO: Use proper 'digits' value for this device (and its modes). */
122 sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
125 * The numbers are hex digits, starting from 0.
126 * 0: Keyboard status, currently not interesting.
127 * 1: Central switch status, currently not interesting.
128 * 2: Type of measured value.
130 vt = xgittoint(devc->buf[2]);
133 analog.meaning->mq = SR_MQ_VOLTAGE;
136 analog.meaning->mq = SR_MQ_CURRENT; /* 2A */
139 analog.meaning->mq = SR_MQ_RESISTANCE;
142 analog.meaning->mq = SR_MQ_CAPACITANCE;
145 analog.meaning->mq = SR_MQ_TEMPERATURE;
148 analog.meaning->mq = SR_MQ_FREQUENCY;
151 analog.meaning->mq = SR_MQ_CURRENT; /* 10A */
154 analog.meaning->mq = SR_MQ_GAIN; /* TODO: Scale factor */
157 analog.meaning->mq = SR_MQ_GAIN; /* Percentage */
161 analog.meaning->mq = SR_MQ_GAIN; /* dB */
165 sr_err("Unknown value type: 0x%02x.", vt);
169 /* 3: Measurement range for measured value */
170 range = xgittoint(devc->buf[3]);
173 scale *= pow(10.0, range - 5);
176 scale *= pow(10.0, range - 7);
179 scale *= pow(10.0, range - 2);
182 scale *= pow(10.0, range - 12);
185 scale *= pow(10.0, range - 1);
188 scale *= pow(10.0, range - 2);
190 // No default, other value types have fixed display format.
193 /* 5: Sign and 1st digit */
194 flags = xgittoint(devc->buf[5]);
195 value = (flags & 0x03);
199 /* 6-9: 2nd-4th digit */
200 for (pos = 6; pos < 10; pos++)
201 value = value * 10 + xgittoint(devc->buf[pos]);
204 /* 10: Display counter */
205 mmode = xgittoint(devc->buf[10]);
207 case 0: /* Frequency */
208 analog.meaning->unit = SR_UNIT_HERTZ;
210 case 1: /* V TRMS, only type 5 */
211 analog.meaning->unit = SR_UNIT_VOLT;
212 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
215 analog.meaning->unit = SR_UNIT_VOLT;
216 analog.meaning->mqflags |= SR_MQFLAG_AC;
218 analog.meaning->mqflags |= SR_MQFLAG_RMS;
221 analog.meaning->unit = SR_UNIT_VOLT;
222 analog.meaning->mqflags |= SR_MQFLAG_DC;
225 analog.meaning->unit = SR_UNIT_OHM;
227 case 5: /* Continuity */
228 analog.meaning->unit = SR_UNIT_BOOLEAN;
229 analog.meaning->mq = SR_MQ_CONTINUITY;
230 /* TODO: Continuity handling is a bit odd in libsigrok. */
232 case 6: /* Degree Celsius */
233 analog.meaning->unit = SR_UNIT_CELSIUS;
235 case 7: /* Capacity */
236 analog.meaning->unit = SR_UNIT_FARAD;
238 case 8: /* Current DC */
239 analog.meaning->unit = SR_UNIT_AMPERE;
240 analog.meaning->mqflags |= SR_MQFLAG_DC;
242 case 9: /* Current AC */
243 analog.meaning->unit = SR_UNIT_AMPERE;
244 analog.meaning->mqflags |= SR_MQFLAG_AC;
246 analog.meaning->mqflags |= SR_MQFLAG_RMS;
248 case 0xa: /* Current TRMS, only type 5 */
249 analog.meaning->unit = SR_UNIT_AMPERE;
250 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
252 case 0xb: /* Diode */
253 analog.meaning->unit = SR_UNIT_VOLT;
254 analog.meaning->mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
257 sr_err("Unknown mmode: 0x%02x.", mmode);
261 /* 11: Device status */
262 devstat = xgittoint(devc->buf[11]);
265 case 1: /* Normal measurement */
267 case 2: /* Input loop (limit, reference values) */
269 case 3: /* TRANS/SENS */
272 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
274 return; /* Cannot continue. */
276 sr_err("Unknown device status: 0x%02x", devstat);
280 /* 12-19: Flags and display symbols */
282 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
283 /* 0x80: PRINT TODO: Stop polling when discovered? */
285 if (analog.meaning->mq == SR_MQ_CONTINUITY) {
287 value = 1.0; /* Beep */
293 if (flags & 0x04) /* REL */
294 analog.meaning->mqflags |= SR_MQFLAG_RELATIVE;
296 if (flags & 0x01) /* % */
297 analog.meaning->unit = SR_UNIT_PERCENTAGE;
300 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
301 if (!(flags & 0x80)) /* MAN: Manual range */
302 analog.meaning->mqflags |= SR_MQFLAG_AUTORANGE;
303 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
307 if (flags & 0x08) /* HOLD */
308 analog.meaning->mqflags |= SR_MQFLAG_HOLD;
310 if (flags & 0x02) /* MAX */
311 analog.meaning->mqflags |= SR_MQFLAG_MAX;
312 if (flags & 0x01) /* MIN */
313 analog.meaning->mqflags |= SR_MQFLAG_MIN;
316 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
317 /* 0xe0: undefined */
318 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
320 sr_warn("Low battery, measurement quality degraded!");
323 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
324 /* 0x02: Current clamp */
325 if (flags & 0x01) { /* dB */
327 * TODO: The Norma has an adjustable dB reference value. If
328 * changed from default, this is not correct.
330 if (analog.meaning->unit == SR_UNIT_VOLT)
331 analog.meaning->unit = SR_UNIT_DECIBEL_VOLT;
333 analog.meaning->unit = SR_UNIT_UNITLESS;
337 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
338 /* 0x80: Undefined. */
339 /* 0x40: Remote mode, keyboard locked */
340 /* 0x38: Undefined. */
341 /* 0x04: MIN > MAX */
342 /* 0x02: Measured value < Min */
343 /* 0x01: Measured value > Max */
345 /* 4: Flags. Evaluating this after setting value! */
346 flags = xgittoint(devc->buf[4]);
347 if (flags & 0x04) /* Invalid value */
349 else if (flags & 0x01) /* Overload */
351 if (flags & 0x02) { /* Duplicate value, has been sent before. */
352 sr_spew("Duplicate value, dismissing!");
357 sr_spew("range=%d/scale=%f/value=%f", range,
358 (double)scale, (double)value);
360 /* Finish and send packet. */
361 analog.meaning->channels = sdi->channels;
362 analog.num_samples = 1;
363 analog.data = &value;
365 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
366 packet.type = SR_DF_ANALOG;
367 packet.payload = &analog;
368 sr_session_send(sdi, &packet);
370 /* Finish processing. */
371 sr_sw_limits_update_samples_read(&devc->limits, 1);
375 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
377 struct sr_dev_inst *sdi;
378 struct dev_context *devc;
379 struct sr_serial_dev_inst *serial;
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_nonblocking(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 (sr_sw_limits_check(&devc->limits)) {
412 sr_dev_acquisition_stop(sdi);
414 /* Request next package. */
415 if (devc->last_req_pending) {
416 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
417 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
418 sr_spew("Request timeout!");
419 devc->last_req_pending = FALSE;
422 if (!devc->last_req_pending) {
423 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)