src/dmm/fs9922.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
   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  * Fortune Semiconductor FS9922-DMM3/FS9922-DMM4 protocol parser.
  23  */
  24
  25 #include <string.h>
  26 #include <ctype.h>
  27 #include <math.h>
  28 #include <glib.h>
  29 #include <libsigrok/libsigrok.h>
  30 #include "libsigrok-internal.h"
  31
  32 #define LOG_PREFIX "fs9922"
  33
  34 static gboolean flags_valid(const struct fs9922_info *info)
  35 {
  36         int count;
  37
  38         /* Does the packet have more than one multiplier? */
  39         count = 0;
  40         count += (info->is_nano) ? 1 : 0;
  41         count += (info->is_micro) ? 1 : 0;
  42         count += (info->is_milli) ? 1 : 0;
  43         count += (info->is_kilo) ? 1 : 0;
  44         count += (info->is_mega) ? 1 : 0;
  45         if (count > 1) {
  46                 sr_dbg("More than one multiplier detected in packet.");
  47                 return FALSE;
  48         }
  49
  50         /*
  51          * Does the packet "measure" more than one type of value?
  52          *
  53          * Note: In "diode mode", both is_diode and is_volt will be set.
  54          * That is a valid use-case, so we don't want to error out below
  55          * if it happens. Thus, we don't check for is_diode here.
  56          */
  57         count = 0;
  58         // count += (info->is_diode) ? 1 : 0;
  59         count += (info->is_percent) ? 1 : 0;
  60         count += (info->is_volt) ? 1 : 0;
  61         count += (info->is_ampere) ? 1 : 0;
  62         count += (info->is_ohm) ? 1 : 0;
  63         count += (info->is_hfe) ? 1 : 0;
  64         count += (info->is_hertz) ? 1 : 0;
  65         count += (info->is_farad) ? 1 : 0;
  66         count += (info->is_celsius) ? 1 : 0;
  67         count += (info->is_fahrenheit) ? 1 : 0;
  68         if (count > 1) {
  69                 sr_dbg("More than one measurement type detected in packet.");
  70                 return FALSE;
  71         }
  72
  73         /* Both AC and DC set? */
  74         if (info->is_ac && info->is_dc) {
  75                 sr_dbg("Both AC and DC flags detected in packet.");
  76                 return FALSE;
  77         }
  78
  79         /* Both Celsius and Fahrenheit set? */
  80         if (info->is_celsius && info->is_fahrenheit) {
  81                 sr_dbg("Both Celsius and Fahrenheit flags detected in packet.");
  82                 return FALSE;
  83         }
  84
  85         return TRUE;
  86 }
  87
  88 static int parse_value(const uint8_t *buf, float *result)
  89 {
  90         int sign, intval;
  91         float floatval;
  92
  93         /* Byte 0: Sign ('+' or '-') */
  94         if (buf[0] == '+') {
  95                 sign = 1;
  96         } else if (buf[0] == '-') {
  97                 sign = -1;
  98         } else {
  99                 sr_dbg("Invalid sign byte: 0x%02x.", buf[0]);
 100                 return SR_ERR;
 101         }
 102
 103         /*
 104          * Bytes 1-4: Value (4 decimal digits)
 105          *
 106          * Over limit: "0.L" on the display, "?0:?" as protocol "digits".
 107          */
 108         if (buf[1] == '?' && buf[2] == '0' && buf[3] == ':' && buf[4] == '?') {
 109                 sr_spew("Over limit.");
 110                 *result = INFINITY;
 111                 return SR_OK;
 112         } else if (!isdigit(buf[1]) || !isdigit(buf[2]) ||
 113                    !isdigit(buf[3]) || !isdigit(buf[4])) {
 114                 sr_dbg("Value contained invalid digits: %02x %02x %02x %02x ("
 115                         "%c %c %c %c).",
 116                         buf[1], buf[2], buf[3], buf[4],
 117                         buf[1], buf[2], buf[3], buf[4]);
 118                 return SR_ERR;
 119         }
 120         intval = 0;
 121         intval += (buf[1] - '0') * 1000;
 122         intval += (buf[2] - '0') * 100;
 123         intval += (buf[3] - '0') * 10;
 124         intval += (buf[4] - '0') * 1;
 125
 126         floatval = (float)intval;
 127
 128         /* Byte 5: Always ' ' (space, 0x20) */
 129
 130         /*
 131          * Byte 6: Decimal point position ('0', '1', '2', or '4')
 132          *
 133          * Note: The Fortune Semiconductor FS9922-DMM3/4 datasheets both have
 134          * an error/typo here. They claim that the values '0'/'1'/'2'/'3' are
 135          * used, but '0'/'1'/'2'/'4' is actually correct.
 136          */
 137         if (buf[6] != '0' && buf[6] != '1' && buf[6] != '2' && buf[6] != '4') {
 138                 sr_dbg("Invalid decimal point value: 0x%02x.", buf[6]);
 139                 return SR_ERR;
 140         }
 141         if (buf[6] == '0')
 142                 floatval /= 1;
 143         else if (buf[6] == '1')
 144                 floatval /= 1000;
 145         else if (buf[6] == '2')
 146                 floatval /= 100;
 147         else if (buf[6] == '4')
 148                 floatval /= 10;
 149
 150         /* Apply sign. */
 151         floatval *= sign;
 152
 153         sr_spew("The display value is %f.", floatval);
 154
 155         *result = floatval;
 156
 157         return SR_OK;
 158 }
 159
 160 static void parse_flags(const uint8_t *buf, struct fs9922_info *info)
 161 {
 162         /* Z1/Z2/Z3/Z4 are bits for user-defined LCD symbols (on/off). */
 163
 164         /* Byte 7 */
 165         /* Bit 7: Always 0 */
 166         /* Bit 6: Always 0 */
 167         info->is_auto       = (buf[7] & (1 << 5)) != 0;
 168         info->is_dc         = (buf[7] & (1 << 4)) != 0;
 169         info->is_ac         = (buf[7] & (1 << 3)) != 0;
 170         info->is_rel        = (buf[7] & (1 << 2)) != 0;
 171         info->is_hold       = (buf[7] & (1 << 1)) != 0;
 172         info->is_bpn        = (buf[7] & (1 << 0)) != 0; /* Bargraph shown */
 173
 174         /* Byte 8 */
 175         info->is_z1         = (buf[8] & (1 << 7)) != 0; /* User symbol 1 */
 176         info->is_z2         = (buf[8] & (1 << 6)) != 0; /* User symbol 2 */
 177         info->is_max        = (buf[8] & (1 << 5)) != 0;
 178         info->is_min        = (buf[8] & (1 << 4)) != 0;
 179         info->is_apo        = (buf[8] & (1 << 3)) != 0; /* Auto-poweroff on */
 180         info->is_bat        = (buf[8] & (1 << 2)) != 0; /* Battery low */
 181         info->is_nano       = (buf[8] & (1 << 1)) != 0;
 182         info->is_z3         = (buf[8] & (1 << 0)) != 0; /* User symbol 3 */
 183
 184         /* Byte 9 */
 185         info->is_micro      = (buf[9] & (1 << 7)) != 0;
 186         info->is_milli      = (buf[9] & (1 << 6)) != 0;
 187         info->is_kilo       = (buf[9] & (1 << 5)) != 0;
 188         info->is_mega       = (buf[9] & (1 << 4)) != 0;
 189         info->is_beep       = (buf[9] & (1 << 3)) != 0;
 190         info->is_diode      = (buf[9] & (1 << 2)) != 0;
 191         info->is_percent    = (buf[9] & (1 << 1)) != 0;
 192         info->is_z4         = (buf[9] & (1 << 0)) != 0; /* User symbol 4 */
 193
 194         /* Byte 10 */
 195         info->is_volt       = (buf[10] & (1 << 7)) != 0;
 196         info->is_ampere     = (buf[10] & (1 << 6)) != 0;
 197         info->is_ohm        = (buf[10] & (1 << 5)) != 0;
 198         info->is_hfe        = (buf[10] & (1 << 4)) != 0;
 199         info->is_hertz      = (buf[10] & (1 << 3)) != 0;
 200         info->is_farad      = (buf[10] & (1 << 2)) != 0;
 201         info->is_celsius    = (buf[10] & (1 << 1)) != 0; /* Only FS9922-DMM4 */
 202         info->is_fahrenheit = (buf[10] & (1 << 0)) != 0; /* Only FS9922-DMM4 */
 203
 204         /*
 205          * Byte 11: Bar graph
 206          *
 207          * Bit 7 contains the sign of the bargraph number (if the bit is set,
 208          * the number is negative), bits 6..0 contain the actual number.
 209          * Valid range: 0-40 (FS9922-DMM3), 0-60 (FS9922-DMM4).
 210          *
 211          * Upon "over limit" the bargraph value is 1 count above the highest
 212          * valid number (i.e. 41 or 61, depending on chip).
 213          */
 214         if (info->is_bpn) {
 215                 info->bargraph_sign = ((buf[11] & (1 << 7)) != 0) ? -1 : 1;
 216                 info->bargraph_value = (buf[11] & 0x7f);
 217                 info->bargraph_value *= info->bargraph_sign;
 218         }
 219
 220         /* Byte 12: Always '\r' (carriage return, 0x0d, 13) */
 221
 222         /* Byte 13: Always '\n' (newline, 0x0a, 10) */
 223 }
 224
 225 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
 226                          const struct fs9922_info *info)
 227 {
 228         /* Factors */
 229         if (info->is_nano)
 230                 *floatval /= 1000000000;
 231         if (info->is_micro)
 232                 *floatval /= 1000000;
 233         if (info->is_milli)
 234                 *floatval /= 1000;
 235         if (info->is_kilo)
 236                 *floatval *= 1000;
 237         if (info->is_mega)
 238                 *floatval *= 1000000;
 239
 240         /* Measurement modes */
 241         if (info->is_volt || info->is_diode) {
 242                 /* Note: In "diode mode" both is_diode and is_volt are set. */
 243                 analog->mq = SR_MQ_VOLTAGE;
 244                 analog->unit = SR_UNIT_VOLT;
 245         }
 246         if (info->is_ampere) {
 247                 analog->mq = SR_MQ_CURRENT;
 248                 analog->unit = SR_UNIT_AMPERE;
 249         }
 250         if (info->is_ohm) {
 251                 analog->mq = SR_MQ_RESISTANCE;
 252                 analog->unit = SR_UNIT_OHM;
 253         }
 254         if (info->is_hfe) {
 255                 analog->mq = SR_MQ_GAIN;
 256                 analog->unit = SR_UNIT_UNITLESS;
 257         }
 258         if (info->is_hertz) {
 259                 analog->mq = SR_MQ_FREQUENCY;
 260                 analog->unit = SR_UNIT_HERTZ;
 261         }
 262         if (info->is_farad) {
 263                 analog->mq = SR_MQ_CAPACITANCE;
 264                 analog->unit = SR_UNIT_FARAD;
 265         }
 266         if (info->is_celsius) {
 267                 analog->mq = SR_MQ_TEMPERATURE;
 268                 analog->unit = SR_UNIT_CELSIUS;
 269         }
 270         if (info->is_fahrenheit) {
 271                 analog->mq = SR_MQ_TEMPERATURE;
 272                 analog->unit = SR_UNIT_FAHRENHEIT;
 273         }
 274         if (info->is_beep) {
 275                 analog->mq = SR_MQ_CONTINUITY;
 276                 analog->unit = SR_UNIT_BOOLEAN;
 277                 *floatval = (*floatval == INFINITY) ? 0.0 : 1.0;
 278         }
 279         if (info->is_percent) {
 280                 analog->mq = SR_MQ_DUTY_CYCLE;
 281                 analog->unit = SR_UNIT_PERCENTAGE;
 282         }
 283
 284         /* Measurement related flags */
 285         if (info->is_ac)
 286                 analog->mqflags |= SR_MQFLAG_AC;
 287         if (info->is_dc)
 288                 analog->mqflags |= SR_MQFLAG_DC;
 289         if (info->is_auto)
 290                 analog->mqflags |= SR_MQFLAG_AUTORANGE;
 291         if (info->is_diode)
 292                 analog->mqflags |= SR_MQFLAG_DIODE;
 293         if (info->is_hold)
 294                 analog->mqflags |= SR_MQFLAG_HOLD;
 295         if (info->is_max)
 296                 analog->mqflags |= SR_MQFLAG_MAX;
 297         if (info->is_min)
 298                 analog->mqflags |= SR_MQFLAG_MIN;
 299         if (info->is_rel)
 300                 analog->mqflags |= SR_MQFLAG_RELATIVE;
 301
 302         /* Other flags */
 303         if (info->is_apo)
 304                 sr_spew("Automatic power-off function is active.");
 305         if (info->is_bat)
 306                 sr_spew("Battery is low.");
 307         if (info->is_z1)
 308                 sr_spew("User-defined LCD symbol 1 is active.");
 309         if (info->is_z2)
 310                 sr_spew("User-defined LCD symbol 2 is active.");
 311         if (info->is_z3)
 312                 sr_spew("User-defined LCD symbol 3 is active.");
 313         if (info->is_z4)
 314                 sr_spew("User-defined LCD symbol 4 is active.");
 315         if (info->is_bpn)
 316                 sr_spew("The bargraph value is %d.", info->bargraph_value);
 317         else
 318                 sr_spew("The bargraph is not active.");
 319
 320 }
 321
 322 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf)
 323 {
 324         struct fs9922_info info;
 325
 326         /* Byte 0: Sign (must be '+' or '-') */
 327         if (buf[0] != '+' && buf[0] != '-')
 328                 return FALSE;
 329
 330         /* Byte 12: Always '\r' (carriage return, 0x0d, 13) */
 331         /* Byte 13: Always '\n' (newline, 0x0a, 10) */
 332         if (buf[12] != '\r' || buf[13] != '\n')
 333                 return FALSE;
 334
 335         parse_flags(buf, &info);
 336
 337         return flags_valid(&info);
 338 }
 339
 340 /**
 341  * Parse a protocol packet.
 342  *
 343  * @param buf Buffer containing the protocol packet. Must not be NULL.
 344  * @param floatval Pointer to a float variable. That variable will contain the
 345  *                 result value upon parsing success. Must not be NULL.
 346  * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
 347  *               filled with data according to the protocol packet.
 348  *               Must not be NULL.
 349  * @param info Pointer to a struct fs9922_info. The struct will be filled
 350  *             with data according to the protocol packet. Must not be NULL.
 351  *
 352  * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
 353  *         'analog' variable contents are undefined and should not be used.
 354  */
 355 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
 356                             struct sr_datafeed_analog *analog, void *info)
 357 {
 358         int ret;
 359         struct fs9922_info *info_local;
 360
 361         info_local = (struct fs9922_info *)info;
 362
 363         if ((ret = parse_value(buf, floatval)) != SR_OK) {
 364                 sr_dbg("Error parsing value: %d.", ret);
 365                 return ret;
 366         }
 367
 368         parse_flags(buf, info_local);
 369         handle_flags(analog, floatval, info_local);
 370
 371         return SR_OK;
 372 }
 373
 374 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info)
 375 {
 376         struct fs9922_info *info_local;
 377
 378         info_local = (struct fs9922_info *)info;
 379
 380         /* User-defined z1 flag means "diode mode". */
 381         if (info_local->is_z1) {
 382                 analog->mq = SR_MQ_VOLTAGE;
 383                 analog->unit = SR_UNIT_VOLT;
 384                 analog->mqflags |= SR_MQFLAG_DIODE;
 385         }
 386 }