2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 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 * Fortune Semiconductor FS9922-DMM3/FS9922-DMM4 protocol parser.
30 #include <libsigrok/libsigrok.h>
31 #include "libsigrok-internal.h"
33 #define LOG_PREFIX "fs9922"
35 static gboolean flags_valid(const struct fs9922_info *info)
39 /* Does the packet have more than one multiplier? */
41 count += (info->is_nano) ? 1 : 0;
42 count += (info->is_micro) ? 1 : 0;
43 count += (info->is_milli) ? 1 : 0;
44 count += (info->is_kilo) ? 1 : 0;
45 count += (info->is_mega) ? 1 : 0;
47 sr_dbg("More than one multiplier detected in packet.");
52 * Does the packet "measure" more than one type of value?
54 * Note: In "diode mode", both is_diode and is_volt will be set.
55 * That is a valid use-case, so we don't want to error out below
56 * if it happens. Thus, we don't check for is_diode here.
59 // count += (info->is_diode) ? 1 : 0;
60 count += (info->is_percent) ? 1 : 0;
61 count += (info->is_volt) ? 1 : 0;
62 count += (info->is_ampere) ? 1 : 0;
63 count += (info->is_ohm) ? 1 : 0;
64 count += (info->is_hfe) ? 1 : 0;
65 count += (info->is_hertz) ? 1 : 0;
66 count += (info->is_farad) ? 1 : 0;
67 count += (info->is_celsius) ? 1 : 0;
68 count += (info->is_fahrenheit) ? 1 : 0;
70 sr_dbg("More than one measurement type detected in packet.");
74 /* Both AC and DC set? */
75 if (info->is_ac && info->is_dc) {
76 sr_dbg("Both AC and DC flags detected in packet.");
80 /* Both Celsius and Fahrenheit set? */
81 if (info->is_celsius && info->is_fahrenheit) {
82 sr_dbg("Both Celsius and Fahrenheit flags detected in packet.");
89 static int parse_value(const uint8_t *buf, float *result)
94 /* Byte 0: Sign ('+' or '-') */
97 } else if (buf[0] == '-') {
100 sr_dbg("Invalid sign byte: 0x%02x.", buf[0]);
105 * Bytes 1-4: Value (4 decimal digits)
107 * Over limit: "0.L" on the display, "?0:?" as protocol "digits".
109 if (buf[1] == '?' && buf[2] == '0' && buf[3] == ':' && buf[4] == '?') {
110 sr_spew("Over limit.");
113 } else if (!isdigit(buf[1]) || !isdigit(buf[2]) ||
114 !isdigit(buf[3]) || !isdigit(buf[4])) {
115 sr_dbg("Value contained invalid digits: %02x %02x %02x %02x ("
117 buf[1], buf[2], buf[3], buf[4],
118 buf[1], buf[2], buf[3], buf[4]);
122 intval += (buf[1] - '0') * 1000;
123 intval += (buf[2] - '0') * 100;
124 intval += (buf[3] - '0') * 10;
125 intval += (buf[4] - '0') * 1;
127 floatval = (float)intval;
129 /* Byte 5: Always ' ' (space, 0x20) */
132 * Byte 6: Decimal point position ('0', '1', '2', or '4')
134 * Note: The Fortune Semiconductor FS9922-DMM3/4 datasheets both have
135 * an error/typo here. They claim that the values '0'/'1'/'2'/'3' are
136 * used, but '0'/'1'/'2'/'4' is actually correct.
138 if (buf[6] != '0' && buf[6] != '1' && buf[6] != '2' && buf[6] != '4') {
139 sr_dbg("Invalid decimal point value: 0x%02x.", buf[6]);
144 else if (buf[6] == '1')
146 else if (buf[6] == '2')
148 else if (buf[6] == '4')
154 sr_spew("The display value is %f.", floatval);
161 static void parse_flags(const uint8_t *buf, struct fs9922_info *info)
163 /* Z1/Z2/Z3/Z4 are bits for user-defined LCD symbols (on/off). */
166 /* Bit 7: Always 0 */
167 /* Bit 6: Always 0 */
168 info->is_auto = (buf[7] & (1 << 5)) != 0;
169 info->is_dc = (buf[7] & (1 << 4)) != 0;
170 info->is_ac = (buf[7] & (1 << 3)) != 0;
171 info->is_rel = (buf[7] & (1 << 2)) != 0;
172 info->is_hold = (buf[7] & (1 << 1)) != 0;
173 info->is_bpn = (buf[7] & (1 << 0)) != 0; /* Bargraph shown */
176 info->is_z1 = (buf[8] & (1 << 7)) != 0; /* User symbol 1 */
177 info->is_z2 = (buf[8] & (1 << 6)) != 0; /* User symbol 2 */
178 info->is_max = (buf[8] & (1 << 5)) != 0;
179 info->is_min = (buf[8] & (1 << 4)) != 0;
180 info->is_apo = (buf[8] & (1 << 3)) != 0; /* Auto-poweroff on */
181 info->is_bat = (buf[8] & (1 << 2)) != 0; /* Battery low */
182 info->is_nano = (buf[8] & (1 << 1)) != 0;
183 info->is_z3 = (buf[8] & (1 << 0)) != 0; /* User symbol 3 */
186 info->is_micro = (buf[9] & (1 << 7)) != 0;
187 info->is_milli = (buf[9] & (1 << 6)) != 0;
188 info->is_kilo = (buf[9] & (1 << 5)) != 0;
189 info->is_mega = (buf[9] & (1 << 4)) != 0;
190 info->is_beep = (buf[9] & (1 << 3)) != 0;
191 info->is_diode = (buf[9] & (1 << 2)) != 0;
192 info->is_percent = (buf[9] & (1 << 1)) != 0;
193 info->is_z4 = (buf[9] & (1 << 0)) != 0; /* User symbol 4 */
196 info->is_volt = (buf[10] & (1 << 7)) != 0;
197 info->is_ampere = (buf[10] & (1 << 6)) != 0;
198 info->is_ohm = (buf[10] & (1 << 5)) != 0;
199 info->is_hfe = (buf[10] & (1 << 4)) != 0;
200 info->is_hertz = (buf[10] & (1 << 3)) != 0;
201 info->is_farad = (buf[10] & (1 << 2)) != 0;
202 info->is_celsius = (buf[10] & (1 << 1)) != 0; /* Only FS9922-DMM4 */
203 info->is_fahrenheit = (buf[10] & (1 << 0)) != 0; /* Only FS9922-DMM4 */
208 * Bit 7 contains the sign of the bargraph number (if the bit is set,
209 * the number is negative), bits 6..0 contain the actual number.
210 * Valid range: 0-40 (FS9922-DMM3), 0-60 (FS9922-DMM4).
212 * Upon "over limit" the bargraph value is 1 count above the highest
213 * valid number (i.e. 41 or 61, depending on chip).
216 info->bargraph_sign = ((buf[11] & (1 << 7)) != 0) ? -1 : 1;
217 info->bargraph_value = (buf[11] & 0x7f);
218 info->bargraph_value *= info->bargraph_sign;
221 /* Byte 12: Always '\r' (carriage return, 0x0d, 13) */
223 /* Byte 13: Always '\n' (newline, 0x0a, 10) */
226 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
227 const struct fs9922_info *info)
231 *floatval /= 1000000000;
233 *floatval /= 1000000;
239 *floatval *= 1000000;
241 /* Measurement modes */
242 if (info->is_volt || info->is_diode) {
243 /* Note: In "diode mode" both is_diode and is_volt are set. */
244 analog->mq = SR_MQ_VOLTAGE;
245 analog->unit = SR_UNIT_VOLT;
247 if (info->is_ampere) {
248 analog->mq = SR_MQ_CURRENT;
249 analog->unit = SR_UNIT_AMPERE;
252 analog->mq = SR_MQ_RESISTANCE;
253 analog->unit = SR_UNIT_OHM;
256 analog->mq = SR_MQ_GAIN;
257 analog->unit = SR_UNIT_UNITLESS;
259 if (info->is_hertz) {
260 analog->mq = SR_MQ_FREQUENCY;
261 analog->unit = SR_UNIT_HERTZ;
263 if (info->is_farad) {
264 analog->mq = SR_MQ_CAPACITANCE;
265 analog->unit = SR_UNIT_FARAD;
267 if (info->is_celsius) {
268 analog->mq = SR_MQ_TEMPERATURE;
269 analog->unit = SR_UNIT_CELSIUS;
271 if (info->is_fahrenheit) {
272 analog->mq = SR_MQ_TEMPERATURE;
273 analog->unit = SR_UNIT_FAHRENHEIT;
276 analog->mq = SR_MQ_CONTINUITY;
277 analog->unit = SR_UNIT_BOOLEAN;
278 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
280 if (info->is_percent) {
281 analog->mq = SR_MQ_DUTY_CYCLE;
282 analog->unit = SR_UNIT_PERCENTAGE;
285 /* Measurement related flags */
287 analog->mqflags |= SR_MQFLAG_AC;
289 analog->mqflags |= SR_MQFLAG_DC;
291 analog->mqflags |= SR_MQFLAG_AUTORANGE;
293 analog->mqflags |= SR_MQFLAG_DIODE;
295 analog->mqflags |= SR_MQFLAG_HOLD;
297 analog->mqflags |= SR_MQFLAG_MAX;
299 analog->mqflags |= SR_MQFLAG_MIN;
301 analog->mqflags |= SR_MQFLAG_RELATIVE;
305 sr_spew("Automatic power-off function is active.");
307 sr_spew("Battery is low.");
309 sr_spew("User-defined LCD symbol 1 is active.");
311 sr_spew("User-defined LCD symbol 2 is active.");
313 sr_spew("User-defined LCD symbol 3 is active.");
315 sr_spew("User-defined LCD symbol 4 is active.");
317 sr_spew("The bargraph value is %d.", info->bargraph_value);
319 sr_spew("The bargraph is not active.");
323 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf)
325 struct fs9922_info info;
327 /* Byte 0: Sign (must be '+' or '-') */
328 if (buf[0] != '+' && buf[0] != '-')
331 /* Byte 12: Always '\r' (carriage return, 0x0d, 13) */
332 /* Byte 13: Always '\n' (newline, 0x0a, 10) */
333 if (buf[12] != '\r' || buf[13] != '\n')
336 parse_flags(buf, &info);
338 return flags_valid(&info);
342 * Parse a protocol packet.
344 * @param buf Buffer containing the protocol packet. Must not be NULL.
345 * @param floatval Pointer to a float variable. That variable will contain the
346 * result value upon parsing success. Must not be NULL.
347 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
348 * filled with data according to the protocol packet.
350 * @param info Pointer to a struct fs9922_info. The struct will be filled
351 * with data according to the protocol packet. Must not be NULL.
353 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
354 * 'analog' variable contents are undefined and should not be used.
356 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
357 struct sr_datafeed_analog *analog, void *info)
360 struct fs9922_info *info_local;
362 info_local = (struct fs9922_info *)info;
364 if ((ret = parse_value(buf, floatval)) != SR_OK) {
365 sr_dbg("Error parsing value: %d.", ret);
369 parse_flags(buf, info_local);
370 handle_flags(analog, floatval, info_local);
375 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info)
377 struct fs9922_info *info_local;
379 info_local = (struct fs9922_info *)info;
381 /* User-defined z1 flag means "diode mode". */
382 if (info_local->is_z1) {
383 analog->mq = SR_MQ_VOLTAGE;
384 analog->unit = SR_UNIT_VOLT;
385 analog->mqflags |= SR_MQFLAG_DIODE;