]>
Commit | Line | Data |
---|---|---|
ac913e5c | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
ac913e5c | 3 | * |
71f1302b | 4 | * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de> |
ac913e5c UH |
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 2 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 | |
2ea1fdf1 | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
ac913e5c UH |
18 | */ |
19 | ||
e83437ae MH |
20 | /** |
21 | * @file | |
22 | * | |
ac913e5c UH |
23 | * Metex 14-bytes ASCII protocol parser. |
24 | * | |
e83437ae | 25 | * @internal |
ac913e5c UH |
26 | * This should work for various multimeters which use this kind of protocol, |
27 | * even though there is some variation in which modes each DMM supports. | |
28 | * | |
29 | * It does _not_ work for all Metex DMMs, some use a quite different protocol. | |
30 | */ | |
31 | ||
6ec6c43b | 32 | #include <config.h> |
ac913e5c | 33 | #include <string.h> |
ba464a12 | 34 | #include <strings.h> |
ac913e5c UH |
35 | #include <ctype.h> |
36 | #include <math.h> | |
37 | #include <glib.h> | |
c1aae900 | 38 | #include <libsigrok/libsigrok.h> |
ac913e5c UH |
39 | #include "libsigrok-internal.h" |
40 | ||
3544f848 | 41 | #define LOG_PREFIX "metex14" |
ac913e5c | 42 | |
e83437ae MH |
43 | /** Parse value from buf, byte 2-8. */ |
44 | static int parse_value(const uint8_t *buf, struct metex14_info *info, | |
e677490e | 45 | float *result, int *exponent) |
ac913e5c | 46 | { |
e677490e | 47 | int i, is_ol, cnt, dot_pos; |
1a807c13 UH |
48 | char valstr[7 + 1]; |
49 | ||
50 | /* Strip all spaces from bytes 2-8. */ | |
51 | memset(&valstr, 0, 7 + 1); | |
52 | for (i = 0, cnt = 0; i < 7; i++) { | |
53 | if (buf[2 + i] != ' ') | |
54 | valstr[cnt++] = buf[2 + i]; | |
ac913e5c UH |
55 | } |
56 | ||
57 | /* Bytes 5-7: Over limit (various forms) */ | |
58 | is_ol = 0; | |
34577da6 UH |
59 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, ".OL")) ? 1 : 0; |
60 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "O.L")) ? 1 : 0; | |
61 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL.")) ? 1 : 0; | |
62 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL")) ? 1 : 0; | |
63 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-.OL")) ? 1 : 0; | |
64 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-O.L")) ? 1 : 0; | |
65 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL.")) ? 1 : 0; | |
66 | is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL")) ? 1 : 0; | |
ac913e5c UH |
67 | if (is_ol != 0) { |
68 | sr_spew("Over limit."); | |
69 | *result = INFINITY; | |
70 | return SR_OK; | |
71 | } | |
72 | ||
e83437ae MH |
73 | /* Logic functions */ |
74 | if (!strcmp((const char *)&valstr, "READY") || | |
75 | !strcmp((const char *)&valstr, "FLOAT")) { | |
76 | *result = INFINITY; | |
77 | info->is_logic = TRUE; | |
78 | } else if (!strcmp((const char *)&valstr, "Hi")) { | |
79 | *result = 1.0; | |
80 | info->is_logic = TRUE; | |
81 | } else if (!strcmp((const char *)&valstr, "Lo")) { | |
82 | *result = 0.0; | |
83 | info->is_logic = TRUE; | |
84 | } | |
85 | if (info->is_logic) | |
86 | return SR_OK; | |
87 | ||
1a807c13 | 88 | /* Bytes 2-8: Sign, value (up to 5 digits) and decimal point */ |
4f0463a0 | 89 | sr_atof_ascii((const char *)&valstr, result); |
ac913e5c | 90 | |
e677490e AJ |
91 | dot_pos = strcspn(valstr, "."); |
92 | if (dot_pos < cnt) | |
93 | *exponent = -(cnt - dot_pos - 1); | |
94 | else | |
95 | *exponent = 0; | |
96 | ||
1a807c13 | 97 | sr_spew("The display value is %f.", *result); |
ac913e5c UH |
98 | |
99 | return SR_OK; | |
100 | } | |
101 | ||
102 | static void parse_flags(const char *buf, struct metex14_info *info) | |
103 | { | |
71f1302b UH |
104 | int i, cnt; |
105 | char unit[4 + 1]; | |
106 | const char *u; | |
107 | ||
e83437ae MH |
108 | /* Bytes 0-1: Measurement mode AC, DC */ |
109 | info->is_ac = !strncmp(buf, "AC", 2); | |
110 | info->is_dc = !strncmp(buf, "DC", 2); | |
ac913e5c | 111 | |
1a807c13 | 112 | /* Bytes 2-8: See parse_value(). */ |
ac913e5c | 113 | |
1a807c13 | 114 | /* Strip all spaces from bytes 9-12. */ |
71f1302b UH |
115 | memset(&unit, 0, 4 + 1); |
116 | for (i = 0, cnt = 0; i < 4; i++) { | |
117 | if (buf[9 + i] != ' ') | |
118 | unit[cnt++] = buf[9 + i]; | |
119 | } | |
1a807c13 UH |
120 | |
121 | /* Bytes 9-12: Unit */ | |
71f1302b | 122 | u = (const char *)&unit; |
34577da6 | 123 | if (!g_ascii_strcasecmp(u, "A")) |
ac913e5c | 124 | info->is_ampere = TRUE; |
34577da6 | 125 | else if (!g_ascii_strcasecmp(u, "mA")) |
ac913e5c | 126 | info->is_milli = info->is_ampere = TRUE; |
34577da6 | 127 | else if (!g_ascii_strcasecmp(u, "uA")) |
2477fb95 | 128 | info->is_micro = info->is_ampere = TRUE; |
34577da6 | 129 | else if (!g_ascii_strcasecmp(u, "V")) |
ac913e5c | 130 | info->is_volt = TRUE; |
34577da6 | 131 | else if (!g_ascii_strcasecmp(u, "mV")) |
ac913e5c | 132 | info->is_milli = info->is_volt = TRUE; |
34577da6 | 133 | else if (!g_ascii_strcasecmp(u, "Ohm")) |
ac913e5c | 134 | info->is_ohm = TRUE; |
34577da6 | 135 | else if (!g_ascii_strcasecmp(u, "KOhm")) |
ac913e5c | 136 | info->is_kilo = info->is_ohm = TRUE; |
34577da6 | 137 | else if (!g_ascii_strcasecmp(u, "MOhm")) |
ac913e5c | 138 | info->is_mega = info->is_ohm = TRUE; |
34577da6 | 139 | else if (!g_ascii_strcasecmp(u, "pF")) |
c02dc3e2 | 140 | info->is_pico = info->is_farad = TRUE; |
34577da6 | 141 | else if (!g_ascii_strcasecmp(u, "nF")) |
ac913e5c | 142 | info->is_nano = info->is_farad = TRUE; |
34577da6 | 143 | else if (!g_ascii_strcasecmp(u, "uF")) |
ac913e5c | 144 | info->is_micro = info->is_farad = TRUE; |
34577da6 | 145 | else if (!g_ascii_strcasecmp(u, "KHz")) |
ac913e5c | 146 | info->is_kilo = info->is_hertz = TRUE; |
34577da6 | 147 | else if (!g_ascii_strcasecmp(u, "C")) |
ac913e5c | 148 | info->is_celsius = TRUE; |
7fb4ff02 FS |
149 | else if (!g_ascii_strcasecmp(u, "F")) |
150 | info->is_fahrenheit = TRUE; | |
34577da6 | 151 | else if (!g_ascii_strcasecmp(u, "DB")) |
9871215c | 152 | info->is_decibel = TRUE; |
7fb4ff02 FS |
153 | else if (!g_ascii_strcasecmp(u, "dBm")) |
154 | info->is_decibel_mw = TRUE; | |
155 | else if (!g_ascii_strcasecmp(u, "W")) | |
156 | info->is_watt = TRUE; | |
34577da6 | 157 | else if (!g_ascii_strcasecmp(u, "")) |
9871215c | 158 | info->is_unitless = TRUE; |
ac913e5c | 159 | |
e83437ae | 160 | /* Bytes 0-1: Measurement mode, except AC/DC */ |
d9251a2c | 161 | info->is_resistance = !strncmp(buf, "OH", 2) || |
e83437ae | 162 | (!strncmp(buf, " ", 2) && info->is_ohm); |
d9251a2c | 163 | info->is_capacity = !strncmp(buf, "CA", 2) || |
e83437ae | 164 | (!strncmp(buf, " ", 2) && info->is_farad); |
7fb4ff02 FS |
165 | info->is_temperature = !strncmp(buf, "TE", 2) || |
166 | info->is_celsius || info->is_fahrenheit; | |
d9251a2c | 167 | info->is_diode = !strncmp(buf, "DI", 2) || |
e83437ae | 168 | (!strncmp(buf, " ", 2) && info->is_volt && info->is_milli); |
d9251a2c | 169 | info->is_frequency = !strncmp(buf, "FR", 2) || |
e83437ae | 170 | (!strncmp(buf, " ", 2) && info->is_hertz); |
7fb4ff02 FS |
171 | info->is_gain = !strncmp(buf, "DB", 2) && info->is_decibel; |
172 | info->is_power = (!strncmp(buf, "dB", 2) && info->is_decibel_mw) || | |
173 | ((!strncmp(buf, "WT", 2) && info->is_watt)); | |
d9251a2c | 174 | info->is_hfe = !strncmp(buf, "HF", 2) || |
e83437ae MH |
175 | (!strncmp(buf, " ", 2) && !info->is_volt && !info->is_ohm && |
176 | !info->is_logic && !info->is_farad && !info->is_hertz); | |
7fb4ff02 FS |
177 | info->is_min = !strncmp(buf, "MN", 2); |
178 | info->is_max = !strncmp(buf, "MX", 2); | |
179 | info->is_avg = !strncmp(buf, "AG", 2); | |
180 | ||
e83437ae MH |
181 | /* |
182 | * Note: | |
183 | * - Protocol doesn't distinguish "resistance" from "beep" mode. | |
184 | * - "DB" shows the logarithmic ratio of input voltage to a | |
185 | * pre-stored (user-changeable) value in the DMM. | |
186 | */ | |
187 | ||
ac913e5c UH |
188 | /* Byte 13: Always '\r' (carriage return, 0x0d, 13) */ |
189 | } | |
190 | ||
b02bb45f | 191 | static void handle_flags(struct sr_datafeed_analog *analog, float *floatval, |
e677490e | 192 | int *exponent, const struct metex14_info *info) |
ac913e5c | 193 | { |
7fb4ff02 FS |
194 | int factor; |
195 | ||
196 | (void)exponent; | |
197 | ||
ac913e5c | 198 | /* Factors */ |
7fb4ff02 | 199 | factor = 0; |
c02dc3e2 | 200 | if (info->is_pico) |
e677490e | 201 | factor -= 12; |
ac913e5c | 202 | if (info->is_nano) |
e677490e | 203 | factor -= 9; |
ac913e5c | 204 | if (info->is_micro) |
e677490e | 205 | factor -= 6; |
ac913e5c | 206 | if (info->is_milli) |
e677490e | 207 | factor -= 3; |
ac913e5c | 208 | if (info->is_kilo) |
e677490e | 209 | factor += 3; |
ac913e5c | 210 | if (info->is_mega) |
e677490e AJ |
211 | factor += 6; |
212 | *floatval *= powf(10, factor); | |
ac913e5c UH |
213 | |
214 | /* Measurement modes */ | |
215 | if (info->is_volt) { | |
b02bb45f UH |
216 | analog->meaning->mq = SR_MQ_VOLTAGE; |
217 | analog->meaning->unit = SR_UNIT_VOLT; | |
ac913e5c UH |
218 | } |
219 | if (info->is_ampere) { | |
b02bb45f UH |
220 | analog->meaning->mq = SR_MQ_CURRENT; |
221 | analog->meaning->unit = SR_UNIT_AMPERE; | |
ac913e5c UH |
222 | } |
223 | if (info->is_ohm) { | |
b02bb45f UH |
224 | analog->meaning->mq = SR_MQ_RESISTANCE; |
225 | analog->meaning->unit = SR_UNIT_OHM; | |
ac913e5c UH |
226 | } |
227 | if (info->is_hertz) { | |
b02bb45f UH |
228 | analog->meaning->mq = SR_MQ_FREQUENCY; |
229 | analog->meaning->unit = SR_UNIT_HERTZ; | |
ac913e5c UH |
230 | } |
231 | if (info->is_farad) { | |
b02bb45f UH |
232 | analog->meaning->mq = SR_MQ_CAPACITANCE; |
233 | analog->meaning->unit = SR_UNIT_FARAD; | |
ac913e5c | 234 | } |
7fb4ff02 | 235 | if (info->is_temperature) { |
b02bb45f | 236 | analog->meaning->mq = SR_MQ_TEMPERATURE; |
7fb4ff02 FS |
237 | if (info->is_celsius) |
238 | analog->meaning->unit = SR_UNIT_CELSIUS; | |
239 | else if (info->is_fahrenheit) | |
240 | analog->meaning->unit = SR_UNIT_FAHRENHEIT; | |
241 | else | |
242 | analog->meaning->unit = SR_UNIT_UNITLESS; | |
ac913e5c UH |
243 | } |
244 | if (info->is_diode) { | |
b02bb45f UH |
245 | analog->meaning->mq = SR_MQ_VOLTAGE; |
246 | analog->meaning->unit = SR_UNIT_VOLT; | |
ac913e5c | 247 | } |
7fb4ff02 FS |
248 | if (info->is_power) { |
249 | analog->meaning->mq = SR_MQ_POWER; | |
250 | if (info->is_decibel_mw) | |
251 | analog->meaning->unit = SR_UNIT_DECIBEL_MW; | |
252 | else if (info->is_watt) | |
253 | analog->meaning->unit = SR_UNIT_WATT; | |
254 | else | |
255 | analog->meaning->unit = SR_UNIT_UNITLESS; | |
256 | } | |
9871215c | 257 | if (info->is_gain) { |
b02bb45f UH |
258 | analog->meaning->mq = SR_MQ_GAIN; |
259 | analog->meaning->unit = SR_UNIT_DECIBEL_VOLT; | |
9871215c UH |
260 | } |
261 | if (info->is_hfe) { | |
b02bb45f UH |
262 | analog->meaning->mq = SR_MQ_GAIN; |
263 | analog->meaning->unit = SR_UNIT_UNITLESS; | |
9871215c | 264 | } |
e83437ae | 265 | if (info->is_logic) { |
b02bb45f UH |
266 | analog->meaning->mq = SR_MQ_GAIN; |
267 | analog->meaning->unit = SR_UNIT_UNITLESS; | |
e83437ae | 268 | } |
ac913e5c UH |
269 | |
270 | /* Measurement related flags */ | |
271 | if (info->is_ac) | |
b02bb45f | 272 | analog->meaning->mqflags |= SR_MQFLAG_AC; |
ac913e5c | 273 | if (info->is_dc) |
b02bb45f | 274 | analog->meaning->mqflags |= SR_MQFLAG_DC; |
a6ed50f4 | 275 | if (info->is_diode) |
64aa214a | 276 | analog->meaning->mqflags |= SR_MQFLAG_DIODE | SR_MQFLAG_DC; |
7fb4ff02 FS |
277 | if (info->is_min) |
278 | analog->meaning->mqflags |= SR_MQFLAG_MIN; | |
279 | if (info->is_max) | |
280 | analog->meaning->mqflags |= SR_MQFLAG_MAX; | |
281 | if (info->is_avg) | |
282 | analog->meaning->mqflags |= SR_MQFLAG_AVG; | |
ac913e5c UH |
283 | } |
284 | ||
285 | static gboolean flags_valid(const struct metex14_info *info) | |
286 | { | |
287 | int count; | |
288 | ||
289 | /* Does the packet have more than one multiplier? */ | |
290 | count = 0; | |
c02dc3e2 | 291 | count += (info->is_pico) ? 1 : 0; |
ac913e5c UH |
292 | count += (info->is_nano) ? 1 : 0; |
293 | count += (info->is_micro) ? 1 : 0; | |
294 | count += (info->is_milli) ? 1 : 0; | |
295 | count += (info->is_kilo) ? 1 : 0; | |
296 | count += (info->is_mega) ? 1 : 0; | |
297 | if (count > 1) { | |
ec5186f9 | 298 | sr_dbg("More than one multiplier detected in packet."); |
ac913e5c UH |
299 | return FALSE; |
300 | } | |
301 | ||
302 | /* Does the packet "measure" more than one type of value? */ | |
303 | count = 0; | |
304 | count += (info->is_ac) ? 1 : 0; | |
305 | count += (info->is_dc) ? 1 : 0; | |
306 | count += (info->is_resistance) ? 1 : 0; | |
307 | count += (info->is_capacity) ? 1 : 0; | |
308 | count += (info->is_temperature) ? 1 : 0; | |
309 | count += (info->is_diode) ? 1 : 0; | |
310 | count += (info->is_frequency) ? 1 : 0; | |
311 | if (count > 1) { | |
ec5186f9 | 312 | sr_dbg("More than one measurement type detected in packet."); |
ac913e5c UH |
313 | return FALSE; |
314 | } | |
315 | ||
316 | /* Both AC and DC set? */ | |
317 | if (info->is_ac && info->is_dc) { | |
ec5186f9 | 318 | sr_dbg("Both AC and DC flags detected in packet."); |
ac913e5c UH |
319 | return FALSE; |
320 | } | |
321 | ||
322 | return TRUE; | |
323 | } | |
324 | ||
c4f2dfd0 | 325 | #ifdef HAVE_LIBSERIALPORT |
e90cf076 UH |
326 | SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial) |
327 | { | |
328 | const uint8_t wbuf = 'D'; | |
329 | ||
330 | sr_spew("Requesting DMM packet."); | |
331 | ||
379e95c5 | 332 | return serial_write_blocking(serial, &wbuf, 1, 0); |
e90cf076 | 333 | } |
c4f2dfd0 | 334 | #endif |
e90cf076 | 335 | |
ac913e5c UH |
336 | SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf) |
337 | { | |
338 | struct metex14_info info; | |
339 | ||
340 | memset(&info, 0x00, sizeof(struct metex14_info)); | |
341 | parse_flags((const char *)buf, &info); | |
342 | ||
343 | if (!flags_valid(&info)) | |
344 | return FALSE; | |
345 | ||
346 | if (buf[13] != '\r') | |
347 | return FALSE; | |
348 | ||
349 | return TRUE; | |
350 | } | |
351 | ||
556a926d GS |
352 | SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf) |
353 | { | |
354 | struct metex14_info info; | |
355 | size_t ch_idx; | |
356 | const uint8_t *ch_buf; | |
357 | ||
358 | ch_buf = buf; | |
359 | for (ch_idx = 0; ch_idx < 4; ch_idx++) { | |
360 | if (ch_buf[13] != '\r') | |
361 | return FALSE; | |
362 | memset(&info, 0x00, sizeof(info)); | |
363 | parse_flags((const char *)ch_buf, &info); | |
364 | if (!flags_valid(&info)) | |
365 | return FALSE; | |
366 | ch_buf += METEX14_PACKET_SIZE; | |
367 | } | |
368 | return TRUE; | |
369 | } | |
370 | ||
ac913e5c UH |
371 | /** |
372 | * Parse a protocol packet. | |
373 | * | |
1fbab466 | 374 | * @param buf Buffer containing the protocol packet. Must not be NULL. |
ac913e5c | 375 | * @param floatval Pointer to a float variable. That variable will be modified |
1fbab466 | 376 | * in-place depending on the protocol packet. Must not be NULL. |
b02bb45f | 377 | * @param analog Pointer to a struct sr_datafeed_analog. The struct will be |
ac913e5c | 378 | * filled with data according to the protocol packet. |
1fbab466 UH |
379 | * Must not be NULL. |
380 | * @param info Pointer to a struct metex14_info. The struct will be filled | |
381 | * with data according to the protocol packet. Must not be NULL. | |
ac913e5c UH |
382 | * |
383 | * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the | |
384 | * 'analog' variable contents are undefined and should not be used. | |
385 | */ | |
386 | SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval, | |
b02bb45f | 387 | struct sr_datafeed_analog *analog, void *info) |
ac913e5c | 388 | { |
e677490e | 389 | int ret, exponent = 0; |
1fbab466 UH |
390 | struct metex14_info *info_local; |
391 | ||
94b1d506 | 392 | info_local = info; |
ac913e5c | 393 | |
e82d7dbc AG |
394 | /* Don't print byte 13. That one contains the carriage return. */ |
395 | sr_dbg("DMM packet: \"%.13s\"", buf); | |
396 | ||
e83437ae MH |
397 | memset(info_local, 0x00, sizeof(struct metex14_info)); |
398 | ||
e677490e | 399 | if ((ret = parse_value(buf, info_local, floatval, &exponent)) != SR_OK) { |
ec5186f9 | 400 | sr_dbg("Error parsing value: %d.", ret); |
ac913e5c UH |
401 | return ret; |
402 | } | |
403 | ||
1fbab466 | 404 | parse_flags((const char *)buf, info_local); |
e677490e AJ |
405 | handle_flags(analog, floatval, &exponent, info_local); |
406 | ||
d9251a2c | 407 | analog->encoding->digits = -exponent; |
e677490e | 408 | analog->spec->spec_digits = -exponent; |
ac913e5c UH |
409 | |
410 | return SR_OK; | |
411 | } | |
556a926d GS |
412 | |
413 | /** | |
414 | * Parse one out of four values of a four-display Metex14 variant. | |
415 | * | |
416 | * The caller's 'info' parameter can be used to track the channel index, | |
417 | * as long as the information is kept across calls to the 14-byte packet | |
418 | * parse routine (which clears the 'info' container). | |
419 | * | |
420 | * Since analog values have further details in the 'analog' parameter, | |
421 | * passing multiple values per parse routine call is problematic. So we | |
422 | * prefer the approach of passing one value per call, which is most | |
423 | * reliable and shall fit every similar device with multiple displays. | |
424 | * | |
425 | * The meters which use this parse routine send one 14-byte packet per | |
426 | * display. Each packet has the regular Metex14 layout. | |
427 | */ | |
428 | SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval, | |
429 | struct sr_datafeed_analog *analog, void *info) | |
430 | { | |
431 | struct metex14_info *info_local; | |
432 | size_t ch_idx; | |
433 | const uint8_t *ch_buf; | |
434 | int rc; | |
435 | ||
436 | info_local = info; | |
437 | ch_idx = info_local->ch_idx; | |
438 | ch_buf = buf + ch_idx * METEX14_PACKET_SIZE; | |
439 | rc = sr_metex14_parse(ch_buf, floatval, analog, info); | |
440 | info_local->ch_idx = ch_idx + 1; | |
441 | return rc; | |
442 | } |