2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
22 * UNI-T UT71x protocol parser.
24 * Communication parameters: Unidirectional, 2400/7o1
32 #include <libsigrok/libsigrok.h>
33 #include "libsigrok-internal.h"
35 #define LOG_PREFIX "ut71x"
38 * Factors for the respective measurement mode (0 means "invalid").
40 * The Conrad/Voltcraft protocol descriptions have a typo (they suggest
41 * index 0 for the 10A range (which is incorrect, it's range 1).
43 static const float factors[16][8] = {
44 {1e-5, 0, 0, 0, 0, 0, 0, 0 }, /* AC mV */
45 {0, 1e-4, 1e-3, 1e-2, 1e-1, 0, 0, 0 }, /* DC V */
46 {0, 1e-4, 1e-3, 1e-2, 1e-1, 0, 0, 0 }, /* AC V */
47 {1e-5, 0, 0, 0, 0, 0, 0, 0 }, /* DC mV */
48 {0, 1e-1, 1, 1e1, 1e2, 1e3, 1e4, 0 }, /* Resistance */
49 {0, 1e-12, 1e-11, 1e-10, 1e-9, 1e-8, 1e-7, 1e-6}, /* Capacitance */
50 {1e-1, 0, 0, 0, 0, 0, 0, 0 }, /* Temp (C) */
51 {1e-8, 1e-7, 0, 0, 0, 0, 0, 0 }, /* uA */
52 {1e-6, 1e-5, 0, 0, 0, 0, 0, 0 }, /* mA */
53 {0, 1e-3, 0, 0, 0, 0, 0, 0 }, /* 10A */
54 {1e-1, 0, 0, 0, 0, 0, 0, 0 }, /* Continuity */
55 {1e-4, 0, 0, 0, 0, 0, 0, 0 }, /* Diode */
56 {1e-3, 1e-2, 1e-1, 1, 1e1, 1e2, 1e3, 1e4 }, /* Frequency */
57 {1e-1, 0, 0, 0, 0, 0, 0, 0 }, /* Temp (F) */
58 {0, 0, 0, 1, 0, 0, 0, 0 }, /* Power */
59 {1e-2, 0, 0, 0, 0, 0, 0, 0 }, /* Loop current */
62 static int parse_value(const uint8_t *buf, struct ut71x_info *info, float *result)
64 int i, intval, num_digits = 5;
66 /* Bytes 0-4: Value (5 decimal digits) */
67 if (!strncmp((const char *)buf, "::0<:", 5)) {
68 sr_spew("Over limit.");
71 } else if (!strncmp((const char *)buf, ":<0::", 5)) {
72 sr_spew("Under limit.");
75 } else if (buf[4] == ':') {
76 sr_dbg("4000 count mode, only 4 digits used.");
78 } else if (!isdigit(buf[0]) || !isdigit(buf[1]) ||
79 !isdigit(buf[2]) || !isdigit(buf[3]) || !isdigit(buf[4])) {
80 sr_dbg("Invalid digits: %02x %02x %02x %02x %02x (%c %c "
81 "%c %c %c).", buf[0], buf[1], buf[2], buf[3], buf[4],
82 buf[0], buf[1], buf[2], buf[3], buf[4]);
85 for (i = 0, intval = 0; i < num_digits; i++)
86 intval = 10 * intval + (buf[i] - '0');
89 intval *= info->is_sign ? -1 : 1;
91 /* Note: The decimal point position will be parsed later. */
92 *result = (float)intval;
93 sr_spew("The display value is %f.", *result);
98 static int parse_range(const uint8_t *buf, float *floatval)
104 if (idx < 0 || idx > 7) {
105 sr_dbg("Invalid range byte 0x%02x (idx 0x%02x).", buf[5], idx);
110 if (mode < 0 || mode > 15) {
111 sr_dbg("Invalid mode byte 0x%02x (idx 0x%02x).", buf[6], mode);
115 sr_spew("mode/idx = %d/%d", mode, idx);
117 factor = factors[mode][idx];
119 sr_dbg("Invalid factor for range byte: 0x%02x.", buf[5]);
123 /* Apply respective factor (mode-dependent) on the value. */
125 sr_dbg("Applying factor %f, new value is %f.", factor, *floatval);
130 static void parse_flags(const uint8_t *buf, struct ut71x_info *info)
133 switch (buf[6] - '0') {
135 info->is_voltage = info->is_ac = TRUE;
138 info->is_voltage = info->is_dc = TRUE;
141 info->is_voltage = info->is_ac = TRUE;
144 info->is_voltage = info->is_dc = TRUE;
146 case 4: /* Resistance */
147 info->is_resistance = TRUE;
149 case 5: /* Capacitance */
150 info->is_capacitance = TRUE;
152 case 6: /* Temperature (Celsius) */
153 info->is_temperature = info->is_celsius = TRUE;
156 info->is_current = info->is_dc = TRUE;
159 info->is_current = info->is_dc = TRUE;
162 info->is_current = info->is_dc = TRUE;
164 case 10: /* Continuity */
165 info->is_continuity = TRUE;
168 info->is_diode = TRUE;
170 case 12: /* Frequency */
171 info->is_frequency = TRUE;
173 case 13: /* Temperature (F) */
174 info->is_temperature = info->is_fahrenheit = TRUE;
177 /* Note: Only available on UT71E (range 0-2500W). */
178 info->is_power = TRUE;
180 case 15: /* DC loop current, percentage display (range 4-20mA) */
181 info->is_loop_current = TRUE;
184 sr_dbg("Invalid function byte: 0x%02x.", buf[6]);
189 * State 1 byte: bit 0 = AC, bit 1 = DC
190 * Either AC or DC or both or none can be set at the same time.
192 info->is_ac = (buf[7] & (1 << 0)) != 0;
193 info->is_dc = (buf[7] & (1 << 1)) != 0;
196 * State 2 byte: bit 0 = auto, bit 1 = manual, bit 2 = sign
198 * The Conrad/Voltcraft protocol descriptions have a typo
199 * (they suggest bit 3 as sign bit, which is incorrect).
201 * For modes where there's only one possible range (e.g. AC mV)
202 * neither the "auto" nor the "manual" bits will be set.
204 info->is_auto = (buf[8] & (1 << 0)) != 0;
205 info->is_manual = (buf[8] & (1 << 1)) != 0;
206 info->is_sign = (buf[8] & (1 << 2)) != 0;
208 /* Note: "Frequency mode + sign bit" means "duty cycle mode". */
209 if (info->is_frequency && info->is_sign) {
210 info->is_duty_cycle = TRUE;
211 info->is_frequency = info->is_sign = FALSE;
215 static void handle_flags(struct sr_datafeed_analog *analog,
216 float *floatval, const struct ut71x_info *info)
218 /* Measurement modes */
219 if (info->is_voltage) {
220 analog->meaning->mq = SR_MQ_VOLTAGE;
221 analog->meaning->unit = SR_UNIT_VOLT;
223 if (info->is_current) {
224 analog->meaning->mq = SR_MQ_CURRENT;
225 analog->meaning->unit = SR_UNIT_AMPERE;
227 if (info->is_resistance) {
228 analog->meaning->mq = SR_MQ_RESISTANCE;
229 analog->meaning->unit = SR_UNIT_OHM;
231 if (info->is_frequency) {
232 analog->meaning->mq = SR_MQ_FREQUENCY;
233 analog->meaning->unit = SR_UNIT_HERTZ;
235 if (info->is_capacitance) {
236 analog->meaning->mq = SR_MQ_CAPACITANCE;
237 analog->meaning->unit = SR_UNIT_FARAD;
239 if (info->is_temperature && info->is_celsius) {
240 analog->meaning->mq = SR_MQ_TEMPERATURE;
241 analog->meaning->unit = SR_UNIT_CELSIUS;
243 if (info->is_temperature && info->is_fahrenheit) {
244 analog->meaning->mq = SR_MQ_TEMPERATURE;
245 analog->meaning->unit = SR_UNIT_FAHRENHEIT;
247 if (info->is_continuity) {
248 analog->meaning->mq = SR_MQ_CONTINUITY;
249 analog->meaning->unit = SR_UNIT_BOOLEAN;
250 *floatval = (*floatval < 0.0 || *floatval > 60.0) ? 0.0 : 1.0;
252 if (info->is_diode) {
253 analog->meaning->mq = SR_MQ_VOLTAGE;
254 analog->meaning->unit = SR_UNIT_VOLT;
256 if (info->is_duty_cycle) {
257 analog->meaning->mq = SR_MQ_DUTY_CYCLE;
258 analog->meaning->unit = SR_UNIT_PERCENTAGE;
260 if (info->is_power) {
261 analog->meaning->mq = SR_MQ_POWER;
262 analog->meaning->unit = SR_UNIT_WATT;
264 if (info->is_loop_current) {
265 /* 4mA = 0%, 20mA = 100% */
266 analog->meaning->mq = SR_MQ_CURRENT;
267 analog->meaning->unit = SR_UNIT_PERCENTAGE;
270 /* Measurement related flags */
272 analog->meaning->mqflags |= SR_MQFLAG_AC;
274 analog->meaning->mqflags |= SR_MQFLAG_DC;
276 /* All AC modes do True-RMS measurements. */
277 analog->meaning->mqflags |= SR_MQFLAG_RMS;
279 analog->meaning->mqflags |= SR_MQFLAG_AUTORANGE;
281 analog->meaning->mqflags |= SR_MQFLAG_DIODE;
284 static gboolean flags_valid(const struct ut71x_info *info)
288 /* Does the packet "measure" more than one type of value? */
289 count = (info->is_voltage) ? 1 : 0;
290 count += (info->is_current) ? 1 : 0;
291 count += (info->is_resistance) ? 1 : 0;
292 count += (info->is_capacitance) ? 1 : 0;
293 count += (info->is_frequency) ? 1 : 0;
294 count += (info->is_temperature) ? 1 : 0;
295 count += (info->is_continuity) ? 1 : 0;
296 count += (info->is_diode) ? 1 : 0;
297 count += (info->is_power) ? 1 : 0;
298 count += (info->is_loop_current) ? 1 : 0;
300 sr_dbg("More than one measurement type detected in packet.");
304 /* Auto and manual can't be active at the same time. */
305 if (info->is_auto && info->is_manual) {
306 sr_dbg("Auto and manual modes are both active.");
313 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf)
315 struct ut71x_info info;
317 memset(&info, 0, sizeof(struct ut71x_info));
319 if (buf[9] != '\r' || buf[10] != '\n')
322 parse_flags(buf, &info);
324 return flags_valid(&info);
327 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
328 struct sr_datafeed_analog *analog, void *info)
331 struct ut71x_info *info_local;
333 info_local = (struct ut71x_info *)info;
334 memset(info_local, 0, sizeof(struct ut71x_info));
336 if (!sr_ut71x_packet_valid(buf))
339 parse_flags(buf, info_local);
341 if ((ret = parse_value(buf, info, floatval)) != SR_OK) {
342 sr_dbg("Error parsing value: %d.", ret);
346 if ((ret = parse_range(buf, floatval)) != SR_OK)
349 handle_flags(analog, floatval, info);