]> sigrok.org Git - libsigrok.git/blame - hardware/common/dmm/metex14.c
configure.ac: libserialport is optional.
[libsigrok.git] / hardware / common / dmm / metex14.c
CommitLineData
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
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21/*
22 * Metex 14-bytes ASCII protocol parser.
23 *
24 * This should work for various multimeters which use this kind of protocol,
25 * even though there is some variation in which modes each DMM supports.
26 *
27 * It does _not_ work for all Metex DMMs, some use a quite different protocol.
28 */
29
30#include <string.h>
31#include <ctype.h>
32#include <math.h>
33#include <glib.h>
34#include "libsigrok.h"
35#include "libsigrok-internal.h"
36
29a27196
UH
37/* Message logging helpers with subsystem-specific prefix string. */
38#define LOG_PREFIX "metex14: "
39#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
40#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
41#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
42#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
43#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
44#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
ac913e5c
UH
45
46static int parse_value(const uint8_t *buf, float *result)
47{
1a807c13
UH
48 int i, is_ol, cnt;
49 char valstr[7 + 1];
50
51 /* Strip all spaces from bytes 2-8. */
52 memset(&valstr, 0, 7 + 1);
53 for (i = 0, cnt = 0; i < 7; i++) {
54 if (buf[2 + i] != ' ')
55 valstr[cnt++] = buf[2 + i];
ac913e5c
UH
56 }
57
58 /* Bytes 5-7: Over limit (various forms) */
59 is_ol = 0;
ee6cb5a4
UH
60 is_ol += (!strcasecmp((const char *)&valstr, ".OL")) ? 1 : 0;
61 is_ol += (!strcasecmp((const char *)&valstr, "O.L")) ? 1 : 0;
62 is_ol += (!strcasecmp((const char *)&valstr, "OL.")) ? 1 : 0;
63 is_ol += (!strcasecmp((const char *)&valstr, "OL")) ? 1 : 0;
3a8cad91
UH
64 is_ol += (!strcasecmp((const char *)&valstr, "-.OL")) ? 1 : 0;
65 is_ol += (!strcasecmp((const char *)&valstr, "-O.L")) ? 1 : 0;
66 is_ol += (!strcasecmp((const char *)&valstr, "-OL.")) ? 1 : 0;
67 is_ol += (!strcasecmp((const char *)&valstr, "-OL")) ? 1 : 0;
ac913e5c
UH
68 if (is_ol != 0) {
69 sr_spew("Over limit.");
70 *result = INFINITY;
71 return SR_OK;
72 }
73
1a807c13
UH
74 /* Bytes 2-8: Sign, value (up to 5 digits) and decimal point */
75 sscanf((const char *)&valstr, "%f", result);
ac913e5c 76
1a807c13 77 sr_spew("The display value is %f.", *result);
ac913e5c
UH
78
79 return SR_OK;
80}
81
82static void parse_flags(const char *buf, struct metex14_info *info)
83{
71f1302b
UH
84 int i, cnt;
85 char unit[4 + 1];
86 const char *u;
87
ac913e5c
UH
88 /* Bytes 0-1: Measurement mode */
89 /* Note: Protocol doesn't distinguish "resistance" from "beep" mode. */
90 info->is_ac = !strncmp(buf, "AC", 2);
91 info->is_dc = !strncmp(buf, "DC", 2);
92 info->is_resistance = !strncmp(buf, "OH", 2);
93 info->is_capacity = !strncmp(buf, "CA", 2);
94 info->is_temperature = !strncmp(buf, "TE", 2);
95 info->is_diode = !strncmp(buf, "DI", 2);
96 info->is_frequency = !strncmp(buf, "FR", 2);
9871215c
UH
97 info->is_gain = !strncmp(buf, "DB", 2);
98 info->is_hfe = !strncmp(buf, "HF", 2);
99
100 /*
101 * Note: "DB" shows the logarithmic ratio of input voltage to a
102 * pre-stored (user-changeable) value in the DMM.
103 */
ac913e5c
UH
104
105 if (info->is_dc || info->is_ac)
106 info->is_volt = TRUE;
107
1a807c13 108 /* Bytes 2-8: See parse_value(). */
ac913e5c 109
1a807c13 110 /* Strip all spaces from bytes 9-12. */
71f1302b
UH
111 memset(&unit, 0, 4 + 1);
112 for (i = 0, cnt = 0; i < 4; i++) {
113 if (buf[9 + i] != ' ')
114 unit[cnt++] = buf[9 + i];
115 }
1a807c13
UH
116
117 /* Bytes 9-12: Unit */
71f1302b 118 u = (const char *)&unit;
ee6cb5a4 119 if (!strcasecmp(u, "A"))
ac913e5c 120 info->is_ampere = TRUE;
ee6cb5a4 121 else if (!strcasecmp(u, "mA"))
ac913e5c 122 info->is_milli = info->is_ampere = TRUE;
ee6cb5a4 123 else if (!strcasecmp(u, "uA"))
2477fb95 124 info->is_micro = info->is_ampere = TRUE;
ee6cb5a4 125 else if (!strcasecmp(u, "V"))
ac913e5c 126 info->is_volt = TRUE;
ee6cb5a4 127 else if (!strcasecmp(u, "mV"))
ac913e5c 128 info->is_milli = info->is_volt = TRUE;
ee6cb5a4 129 else if (!strcasecmp(u, "Ohm"))
ac913e5c 130 info->is_ohm = TRUE;
ee6cb5a4 131 else if (!strcasecmp(u, "KOhm"))
ac913e5c 132 info->is_kilo = info->is_ohm = TRUE;
ee6cb5a4 133 else if (!strcasecmp(u, "MOhm"))
ac913e5c 134 info->is_mega = info->is_ohm = TRUE;
c02dc3e2
UH
135 else if (!strcasecmp(u, "pF"))
136 info->is_pico = info->is_farad = TRUE;
ee6cb5a4 137 else if (!strcasecmp(u, "nF"))
ac913e5c 138 info->is_nano = info->is_farad = TRUE;
ee6cb5a4 139 else if (!strcasecmp(u, "uF"))
ac913e5c 140 info->is_micro = info->is_farad = TRUE;
ee6cb5a4 141 else if (!strcasecmp(u, "KHz"))
ac913e5c 142 info->is_kilo = info->is_hertz = TRUE;
ee6cb5a4 143 else if (!strcasecmp(u, "C"))
ac913e5c 144 info->is_celsius = TRUE;
ee6cb5a4 145 else if (!strcasecmp(u, "DB"))
9871215c 146 info->is_decibel = TRUE;
ee6cb5a4 147 else if (!strcasecmp(u, ""))
9871215c 148 info->is_unitless = TRUE;
ac913e5c
UH
149
150 /* Byte 13: Always '\r' (carriage return, 0x0d, 13) */
151}
152
153static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
154 const struct metex14_info *info)
155{
156 /* Factors */
c02dc3e2
UH
157 if (info->is_pico)
158 *floatval /= 1000000000000ULL;
ac913e5c
UH
159 if (info->is_nano)
160 *floatval /= 1000000000;
161 if (info->is_micro)
162 *floatval /= 1000000;
163 if (info->is_milli)
164 *floatval /= 1000;
165 if (info->is_kilo)
166 *floatval *= 1000;
167 if (info->is_mega)
168 *floatval *= 1000000;
169
170 /* Measurement modes */
171 if (info->is_volt) {
172 analog->mq = SR_MQ_VOLTAGE;
173 analog->unit = SR_UNIT_VOLT;
174 }
175 if (info->is_ampere) {
176 analog->mq = SR_MQ_CURRENT;
177 analog->unit = SR_UNIT_AMPERE;
178 }
179 if (info->is_ohm) {
180 analog->mq = SR_MQ_RESISTANCE;
181 analog->unit = SR_UNIT_OHM;
182 }
183 if (info->is_hertz) {
184 analog->mq = SR_MQ_FREQUENCY;
185 analog->unit = SR_UNIT_HERTZ;
186 }
187 if (info->is_farad) {
188 analog->mq = SR_MQ_CAPACITANCE;
189 analog->unit = SR_UNIT_FARAD;
190 }
191 if (info->is_celsius) {
192 analog->mq = SR_MQ_TEMPERATURE;
193 analog->unit = SR_UNIT_CELSIUS;
194 }
195 if (info->is_diode) {
196 analog->mq = SR_MQ_VOLTAGE;
197 analog->unit = SR_UNIT_VOLT;
198 }
9871215c
UH
199 if (info->is_gain) {
200 analog->mq = SR_MQ_GAIN;
201 analog->unit = SR_UNIT_DECIBEL_VOLT;
202 }
203 if (info->is_hfe) {
204 analog->mq = SR_MQ_GAIN;
205 analog->unit = SR_UNIT_UNITLESS;
206 }
ac913e5c
UH
207
208 /* Measurement related flags */
209 if (info->is_ac)
210 analog->mqflags |= SR_MQFLAG_AC;
211 if (info->is_dc)
212 analog->mqflags |= SR_MQFLAG_DC;
a6ed50f4
UH
213 if (info->is_diode)
214 analog->mqflags |= SR_MQFLAG_DIODE;
ac913e5c
UH
215}
216
217static gboolean flags_valid(const struct metex14_info *info)
218{
219 int count;
220
221 /* Does the packet have more than one multiplier? */
222 count = 0;
c02dc3e2 223 count += (info->is_pico) ? 1 : 0;
ac913e5c
UH
224 count += (info->is_nano) ? 1 : 0;
225 count += (info->is_micro) ? 1 : 0;
226 count += (info->is_milli) ? 1 : 0;
227 count += (info->is_kilo) ? 1 : 0;
228 count += (info->is_mega) ? 1 : 0;
229 if (count > 1) {
230 sr_err("More than one multiplier detected in packet.");
231 return FALSE;
232 }
233
234 /* Does the packet "measure" more than one type of value? */
235 count = 0;
236 count += (info->is_ac) ? 1 : 0;
237 count += (info->is_dc) ? 1 : 0;
238 count += (info->is_resistance) ? 1 : 0;
239 count += (info->is_capacity) ? 1 : 0;
240 count += (info->is_temperature) ? 1 : 0;
241 count += (info->is_diode) ? 1 : 0;
242 count += (info->is_frequency) ? 1 : 0;
243 if (count > 1) {
244 sr_err("More than one measurement type detected in packet.");
245 return FALSE;
246 }
247
248 /* Both AC and DC set? */
249 if (info->is_ac && info->is_dc) {
250 sr_err("Both AC and DC flags detected in packet.");
251 return FALSE;
252 }
253
254 return TRUE;
255}
256
c4f2dfd0 257#ifdef HAVE_LIBSERIALPORT
e90cf076
UH
258SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial)
259{
260 const uint8_t wbuf = 'D';
261
262 sr_spew("Requesting DMM packet.");
263
264 return (serial_write(serial, &wbuf, 1) == 1) ? SR_OK : SR_ERR;
265}
c4f2dfd0 266#endif
e90cf076 267
ac913e5c
UH
268SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf)
269{
270 struct metex14_info info;
271
272 memset(&info, 0x00, sizeof(struct metex14_info));
273 parse_flags((const char *)buf, &info);
274
275 if (!flags_valid(&info))
276 return FALSE;
277
278 if (buf[13] != '\r')
279 return FALSE;
280
281 return TRUE;
282}
283
284/**
285 * Parse a protocol packet.
286 *
1fbab466 287 * @param buf Buffer containing the protocol packet. Must not be NULL.
ac913e5c 288 * @param floatval Pointer to a float variable. That variable will be modified
1fbab466 289 * in-place depending on the protocol packet. Must not be NULL.
ac913e5c
UH
290 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
291 * filled with data according to the protocol packet.
1fbab466
UH
292 * Must not be NULL.
293 * @param info Pointer to a struct metex14_info. The struct will be filled
294 * with data according to the protocol packet. Must not be NULL.
ac913e5c
UH
295 *
296 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
297 * 'analog' variable contents are undefined and should not be used.
298 */
299SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
1fbab466 300 struct sr_datafeed_analog *analog, void *info)
ac913e5c
UH
301{
302 int ret;
1fbab466
UH
303 struct metex14_info *info_local;
304
305 info_local = (struct metex14_info *)info;
ac913e5c 306
e82d7dbc
AG
307 /* Don't print byte 13. That one contains the carriage return. */
308 sr_dbg("DMM packet: \"%.13s\"", buf);
309
ac913e5c
UH
310 if ((ret = parse_value(buf, floatval)) != SR_OK) {
311 sr_err("Error parsing value: %d.", ret);
312 return ret;
313 }
314
1fbab466
UH
315 memset(info_local, 0x00, sizeof(struct metex14_info));
316 parse_flags((const char *)buf, info_local);
317 handle_flags(analog, floatval, info_local);
ac913e5c
UH
318
319 return SR_OK;
320}