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