]> sigrok.org Git - libsigrok.git/blame - src/hardware/norma-dmm/protocol.c
norma-dmm: Convert to SR_DF_ANALOG.
[libsigrok.git] / src / hardware / norma-dmm / protocol.c
CommitLineData
bfd48770
MH
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
5 *
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.
10 *
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.
15 *
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/>.
18 */
19
a4e435eb
MH
20/** @file
21 * Norma DM9x0/Siemens B102x DMMs driver.
22 * @internal
23 */
24
6ec6c43b 25#include <config.h>
bfd48770
MH
26#include "protocol.h"
27
07ffa5b3
UH
28#define LINE_LENGTH 20
29
e790bd5c
UH
30SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
31 { NMADMM_REQ_IDN, "IDN?" },
32 { NMADMM_REQ_IDN, "STATUS?" },
1b4aedc0 33 ALL_ZERO
e790bd5c
UH
34};
35
36static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
37{
38 struct sr_serial_dev_inst *serial;
39 struct dev_context *devc;
40 char buf[NMADMM_BUFSIZE];
41 int len;
42
43 if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
44 return SR_ERR_BUG;
f8e76e2e 45
e790bd5c
UH
46 len = snprintf(buf, sizeof(buf), "%s%s\r\n",
47 nmadmm_requests[req].req_str, params ? params : "");
f8e76e2e 48
e790bd5c 49 sr_spew("Sending request: '%s'.", buf);
f8e76e2e 50
e790bd5c
UH
51 devc->last_req = req;
52 devc->last_req_pending = TRUE;
f8e76e2e 53
d545c81c
UH
54 if (serial_write_blocking(serial, buf, len,
55 serial_timeout(serial, len)) < 0) {
92714255 56 sr_err("Unable to send request.");
e790bd5c
UH
57 devc->last_req_pending = FALSE;
58 return SR_ERR;
59 }
60
a4e435eb
MH
61 devc->req_sent_at = g_get_monotonic_time();
62
e790bd5c
UH
63 return SR_OK;
64}
65
66/**
67 * Convert hexadecimal digit to int.
68 *
69 * @param[in] xgit Hexadecimal digit to convert.
70 * @return Int value of xgit (0 on invalid xgit).
f8e76e2e
MH
71 */
72SR_PRIV int xgittoint(char xgit)
73{
74 if ((xgit >= '0') && (xgit <= '9'))
75 return xgit - '0';
76 xgit = tolower(xgit);
77 if ((xgit >= 'a') && (xgit <= 'f'))
78 return xgit - 'a';
79 return 0;
80}
81
e790bd5c 82/**
04cb9157 83 * Process received line. It consists of 20 hex digits + \\r\\n,
e790bd5c
UH
84 * e.g. '08100400018100400000'.
85 */
f8e76e2e
MH
86static void nma_process_line(const struct sr_dev_inst *sdi)
87{
88 struct dev_context *devc;
89 int pos, flags;
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 */
55bee166
UH
94 struct sr_datafeed_analog analog;
95 struct sr_analog_encoding encoding;
96 struct sr_analog_meaning meaning;
97 struct sr_analog_spec spec;
f8e76e2e
MH
98 struct sr_datafeed_packet packet;
99
100 devc = sdi->priv;
101
07ffa5b3 102 devc->buf[LINE_LENGTH] = '\0';
f8e76e2e
MH
103
104 sr_spew("Received line '%s'.", devc->buf);
105
e790bd5c 106 /* Check line. */
07ffa5b3 107 if (strlen((const char *)devc->buf) != LINE_LENGTH) {
e790bd5c
UH
108 sr_err("line: Invalid status '%s', must be 20 hex digits.",
109 devc->buf);
f8e76e2e
MH
110 devc->buflen = 0;
111 return;
112 }
e790bd5c 113
07ffa5b3 114 for (pos = 0; pos < LINE_LENGTH; pos++) {
f8e76e2e
MH
115 if (!isxdigit(devc->buf[pos])) {
116 sr_err("line: Expected hex digit in '%s' at pos %d!",
117 devc->buf, pos);
118 devc->buflen = 0;
119 return;
120 }
e790bd5c 121 }
f8e76e2e
MH
122
123 /* Start decoding. */
124 value = 0.0;
125 scale = 1.0;
55bee166 126 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
f8e76e2e 127
e790bd5c
UH
128 /*
129 * The numbers are hex digits, starting from 0.
130 * 0: Keyboard status, currently not interesting.
131 * 1: Central switch status, currently not interesting.
132 * 2: Type of measured value.
133 */
f8e76e2e
MH
134 vt = xgittoint(devc->buf[2]);
135 switch (vt) {
e790bd5c 136 case 0:
55bee166 137 analog.meaning->mq = SR_MQ_VOLTAGE;
f8e76e2e 138 break;
e790bd5c 139 case 1:
55bee166 140 analog.meaning->mq = SR_MQ_CURRENT; /* 2A */
f8e76e2e 141 break;
e790bd5c 142 case 2:
55bee166 143 analog.meaning->mq = SR_MQ_RESISTANCE;
f8e76e2e 144 break;
e790bd5c 145 case 3:
55bee166 146 analog.meaning->mq = SR_MQ_CAPACITANCE;
f8e76e2e 147 break;
e790bd5c 148 case 4:
55bee166 149 analog.meaning->mq = SR_MQ_TEMPERATURE;
f8e76e2e 150 break;
e790bd5c 151 case 5:
55bee166 152 analog.meaning->mq = SR_MQ_FREQUENCY;
f8e76e2e 153 break;
e790bd5c 154 case 6:
55bee166 155 analog.meaning->mq = SR_MQ_CURRENT; /* 10A */
f8e76e2e 156 break;
e790bd5c 157 case 7:
55bee166 158 analog.meaning->mq = SR_MQ_GAIN; /* TODO: Scale factor */
f8e76e2e 159 break;
e790bd5c 160 case 8:
55bee166 161 analog.meaning->mq = SR_MQ_GAIN; /* Percentage */
f8e76e2e
MH
162 scale /= 100.0;
163 break;
e790bd5c 164 case 9:
55bee166 165 analog.meaning->mq = SR_MQ_GAIN; /* dB */
f8e76e2e
MH
166 scale /= 100.0;
167 break;
e790bd5c
UH
168 default:
169 sr_err("Unknown value type: 0x%02x.", vt);
170 break;
f8e76e2e 171 }
e790bd5c 172
f8e76e2e
MH
173 /* 3: Measurement range for measured value */
174 range = xgittoint(devc->buf[3]);
175 switch (vt) {
e790bd5c 176 case 0: /* V */
f8e76e2e
MH
177 scale *= pow(10.0, range - 5);
178 break;
e790bd5c 179 case 1: /* A */
f8e76e2e
MH
180 scale *= pow(10.0, range - 7);
181 break;
e790bd5c 182 case 2: /* Ω */
f8e76e2e
MH
183 scale *= pow(10.0, range - 2);
184 break;
e790bd5c 185 case 3: /* F */
f8e76e2e
MH
186 scale *= pow(10.0, range - 12);
187 break;
e790bd5c 188 case 4: /* °C */
f8e76e2e
MH
189 scale *= pow(10.0, range - 1);
190 break;
e790bd5c 191 case 5: /* Hz */
f8e76e2e
MH
192 scale *= pow(10.0, range - 2);
193 break;
e790bd5c 194 // No default, other value types have fixed display format.
f8e76e2e
MH
195 }
196
197 /* 5: Sign and 1st digit */
198 flags = xgittoint(devc->buf[5]);
199 value = (flags & 0x03);
e790bd5c
UH
200 if (flags & 0x04)
201 scale *= -1;
202
f8e76e2e
MH
203 /* 6-9: 2nd-4th digit */
204 for (pos = 6; pos < 10; pos++)
205 value = value * 10 + xgittoint(devc->buf[pos]);
206 value *= scale;
207
208 /* 10: Display counter */
209 mmode = xgittoint(devc->buf[10]);
210 switch (mmode) {
e790bd5c 211 case 0: /* Frequency */
55bee166 212 analog.meaning->unit = SR_UNIT_HERTZ;
f8e76e2e 213 break;
e790bd5c 214 case 1: /* V TRMS, only type 5 */
55bee166
UH
215 analog.meaning->unit = SR_UNIT_VOLT;
216 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
f8e76e2e 217 break;
e790bd5c 218 case 2: /* V AC */
55bee166
UH
219 analog.meaning->unit = SR_UNIT_VOLT;
220 analog.meaning->mqflags |= SR_MQFLAG_AC;
e790bd5c 221 if (devc->type >= 3)
55bee166 222 analog.meaning->mqflags |= SR_MQFLAG_RMS;
f8e76e2e 223 break;
e790bd5c 224 case 3: /* V DC */
55bee166
UH
225 analog.meaning->unit = SR_UNIT_VOLT;
226 analog.meaning->mqflags |= SR_MQFLAG_DC;
f8e76e2e 227 break;
e790bd5c 228 case 4: /* Ohm */
55bee166 229 analog.meaning->unit = SR_UNIT_OHM;
f8e76e2e 230 break;
e790bd5c 231 case 5: /* Continuity */
55bee166
UH
232 analog.meaning->unit = SR_UNIT_BOOLEAN;
233 analog.meaning->mq = SR_MQ_CONTINUITY;
e790bd5c 234 /* TODO: Continuity handling is a bit odd in libsigrok. */
f8e76e2e
MH
235 break;
236 case 6: /* Degree Celsius */
55bee166 237 analog.meaning->unit = SR_UNIT_CELSIUS;
f8e76e2e 238 break;
e790bd5c 239 case 7: /* Capacity */
55bee166 240 analog.meaning->unit = SR_UNIT_FARAD;
f8e76e2e
MH
241 break;
242 case 8: /* Current DC */
55bee166
UH
243 analog.meaning->unit = SR_UNIT_AMPERE;
244 analog.meaning->mqflags |= SR_MQFLAG_DC;
f8e76e2e 245 break;
e790bd5c 246 case 9: /* Current AC */
55bee166
UH
247 analog.meaning->unit = SR_UNIT_AMPERE;
248 analog.meaning->mqflags |= SR_MQFLAG_AC;
e790bd5c 249 if (devc->type >= 3)
55bee166 250 analog.meaning->mqflags |= SR_MQFLAG_RMS;
f8e76e2e 251 break;
e790bd5c 252 case 0xa: /* Current TRMS, only type 5 */
55bee166
UH
253 analog.meaning->unit = SR_UNIT_AMPERE;
254 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
f8e76e2e 255 break;
e790bd5c 256 case 0xb: /* Diode */
55bee166
UH
257 analog.meaning->unit = SR_UNIT_VOLT;
258 analog.meaning->mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
f8e76e2e
MH
259 break;
260 default:
e790bd5c 261 sr_err("Unknown mmode: 0x%02x.", mmode);
f8e76e2e
MH
262 break;
263 }
264
265 /* 11: Device status */
266 devstat = xgittoint(devc->buf[11]);
267
268 switch (devstat) {
e790bd5c 269 case 1: /* Normal measurement */
f8e76e2e 270 break;
e790bd5c 271 case 2: /* Input loop (limit, reference values) */
f8e76e2e 272 break;
e790bd5c 273 case 3: /* TRANS/SENS */
f8e76e2e 274 break;
e790bd5c
UH
275 case 4: /* Error */
276 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
f8e76e2e 277 devc->buflen = 0;
e790bd5c 278 return; /* Cannot continue. */
f8e76e2e 279 default:
e790bd5c 280 sr_err("Unknown device status: 0x%02x", devstat);
f8e76e2e
MH
281 break;
282 }
283
284 /* 12-19: Flags and display symbols */
285 /* 12, 13 */
286 flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
287 /* 0x80: PRINT TODO: Stop polling when discovered? */
e790bd5c 288 /* 0x40: EXTR */
55bee166 289 if (analog.meaning->mq == SR_MQ_CONTINUITY) {
e790bd5c
UH
290 if (flags & 0x20)
291 value = 1.0; /* Beep */
292 else
293 value = 0.0;
f8e76e2e
MH
294 }
295 /* 0x10: AVG */
296 /* 0x08: Diode */
297 if (flags & 0x04) /* REL */
55bee166 298 analog.meaning->mqflags |= SR_MQFLAG_RELATIVE;
f8e76e2e
MH
299 /* 0x02: SHIFT */
300 if (flags & 0x01) /* % */
55bee166 301 analog.meaning->unit = SR_UNIT_PERCENTAGE;
f8e76e2e
MH
302
303 /* 14, 15 */
304 flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
e790bd5c 305 if (!(flags & 0x80)) /* MAN: Manual range */
55bee166 306 analog.meaning->mqflags |= SR_MQFLAG_AUTORANGE;
e790bd5c 307 if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
f8e76e2e 308 devc->lowbatt = 1;
e790bd5c
UH
309 /* 0x20: PEAK */
310 /* 0x10: COUNT */
311 if (flags & 0x08) /* HOLD */
55bee166 312 analog.meaning->mqflags |= SR_MQFLAG_HOLD;
f8e76e2e 313 /* 0x04: LIMIT */
e790bd5c 314 if (flags & 0x02) /* MAX */
55bee166 315 analog.meaning->mqflags |= SR_MQFLAG_MAX;
e790bd5c 316 if (flags & 0x01) /* MIN */
55bee166 317 analog.meaning->mqflags |= SR_MQFLAG_MIN;
f8e76e2e
MH
318
319 /* 16, 17 */
320 flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
321 /* 0xe0: undefined */
e790bd5c 322 if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
f8e76e2e
MH
323 devc->lowbatt = 2;
324 sr_warn("Low battery, measurement quality degraded!");
325 }
326 /* 0x08: SCALED */
f3f19d11 327 /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
e790bd5c
UH
328 /* 0x02: Current clamp */
329 if (flags & 0x01) { /* dB */
330 /*
331 * TODO: The Norma has an adjustable dB reference value. If
332 * changed from default, this is not correct.
333 */
55bee166
UH
334 if (analog.meaning->unit == SR_UNIT_VOLT)
335 analog.meaning->unit = SR_UNIT_DECIBEL_VOLT;
f8e76e2e 336 else
55bee166 337 analog.meaning->unit = SR_UNIT_UNITLESS;
f8e76e2e
MH
338 }
339
340 /* 18, 19 */
e790bd5c 341 /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
f8e76e2e
MH
342 /* 0x80: Undefined. */
343 /* 0x40: Remote mode, keyboard locked */
344 /* 0x38: Undefined. */
e790bd5c 345 /* 0x04: MIN > MAX */
f8e76e2e
MH
346 /* 0x02: Measured value < Min */
347 /* 0x01: Measured value > Max */
348
e790bd5c 349 /* 4: Flags. Evaluating this after setting value! */
f8e76e2e 350 flags = xgittoint(devc->buf[4]);
e790bd5c 351 if (flags & 0x04) /* Invalid value */
f8e76e2e 352 value = NAN;
e790bd5c 353 else if (flags & 0x01) /* Overload */
f8e76e2e 354 value = INFINITY;
e790bd5c 355 if (flags & 0x02) { /* Duplicate value, has been sent before. */
f8e76e2e
MH
356 sr_spew("Duplicate value, dismissing!");
357 devc->buflen = 0;
358 return;
359 }
360
e790bd5c
UH
361 sr_spew("range=%d/scale=%f/value=%f", range,
362 (double)scale, (double)value);
f8e76e2e 363
e790bd5c 364 /* Finish and send packet. */
55bee166 365 analog.meaning->channels = sdi->channels;
f8e76e2e
MH
366 analog.num_samples = 1;
367 analog.data = &value;
368
d0148a50 369 memset(&packet, 0, sizeof(struct sr_datafeed_packet));
55bee166 370 packet.type = SR_DF_ANALOG;
f8e76e2e 371 packet.payload = &analog;
695dc859 372 sr_session_send(sdi, &packet);
f8e76e2e 373
e790bd5c 374 /* Finish processing. */
37dbffd1 375 sr_sw_limits_update_samples_read(&devc->limits, 1);
f8e76e2e
MH
376 devc->buflen = 0;
377}
378
bfd48770
MH
379SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
380{
f8e76e2e 381 struct sr_dev_inst *sdi;
bfd48770 382 struct dev_context *devc;
f8e76e2e
MH
383 struct sr_serial_dev_inst *serial;
384 int len;
bfd48770
MH
385
386 (void)fd;
387
388 if (!(sdi = cb_data))
389 return TRUE;
390
391 if (!(devc = sdi->priv))
392 return TRUE;
393
f8e76e2e 394 serial = sdi->conn;
bfd48770 395 if (revents == G_IO_IN) {
f8e76e2e 396 /* Serial data arrived. */
e790bd5c 397 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
32950cc0 398 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
f8e76e2e
MH
399 if (len < 1)
400 break;
401 devc->buflen += len;
402 *(devc->buf + devc->buflen) = '\0';
403 if (*(devc->buf + devc->buflen - 1) == '\n') {
e790bd5c
UH
404 /*
405 * TODO: According to specs, should be \r, but
406 * then we'd have to get rid of the \n.
407 */
f8e76e2e
MH
408 devc->last_req_pending = FALSE;
409 nma_process_line(sdi);
410 break;
411 }
412 }
413 }
414
37dbffd1 415 if (sr_sw_limits_check(&devc->limits)) {
695dc859 416 sdi->driver->dev_acquisition_stop(sdi);
37dbffd1
LPC
417 } else {
418 /* Request next package. */
a4e435eb
MH
419 if (devc->last_req_pending) {
420 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
421 if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
422 sr_spew("Request timeout!");
423 devc->last_req_pending = FALSE;
424 }
425 }
426 if (!devc->last_req_pending) {
427 if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)
428 return FALSE;
429 }
bfd48770
MH
430 }
431
432 return TRUE;
433}