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