src/dmm/ut71x.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * UNI-T UT71x protocol parser.
  22  *
  23  * Communication parameters: Unidirectional, 2400/7o1
  24  */
  25
  26 #include <config.h>
  27 #include <string.h>
  28 #include <ctype.h>
  29 #include <math.h>
  30 #include <glib.h>
  31 #include <libsigrok/libsigrok.h>
  32 #include "libsigrok-internal.h"
  33
  34 #define LOG_PREFIX "ut71x"
  35
  36 /*
  37  * Exponents for the respective measurement mode.
  38  *
  39  * The Conrad/Voltcraft protocol descriptions have a typo (they suggest
  40  * index 0 for the 10A range (which is incorrect, it's range 1).
  41  */
  42 static const int exponents[16][8] = {
  43         { -5,   0,   0,   0,  0,  0,  0,  0 }, /* AC mV */
  44         {  0,  -4,  -3,  -2, -1,  0,  0,  0 }, /* DC V */
  45         {  0,  -4,  -3,  -2, -1,  0,  0,  0 }, /* AC V */
  46         { -5,   0,   0,   0,  0,  0,  0,  0 }, /* DC mV */
  47         {  0,  -2,  -1,   0,  1,  2,  3,  0 }, /* Resistance */
  48         {  0, -12, -11, -10, -9, -8, -7, -6 }, /* Capacitance */
  49         { -1,   0,   0,   0,  0,  0,  0,  0 }, /* Temp (C) */
  50         { -8,  -7,   0,   0,  0,  0,  0,  0 }, /* uA */
  51         { -6,  -5,   0,   0,  0,  0,  0,  0 }, /* mA */
  52         {  0,  -3,   0,   0,  0,  0,  0,  0 }, /* 10A */
  53         { -1,   0,   0,   0,  0,  0,  0,  0 }, /* Continuity */
  54         { -4,   0,   0,   0,  0,  0,  0,  0 }, /* Diode */
  55         { -3,  -2,  -1,   0,  1,  2,  3,  4 }, /* Frequency */
  56         { -1,   0,   0,   0,  0,  0,  0,  0 }, /* Temp (F) */
  57         {  0,   0,   0,   0,  0,  0,  0,  0 }, /* Power */
  58         { -2,   0,   0,   0,  0,  0,  0,  0 }, /* Loop current */
  59 };
  60
  61 static int parse_value(const uint8_t *buf, struct ut71x_info *info, float *result)
  62 {
  63         int i, intval, num_digits = 5;
  64
  65         /* Bytes 0-4: Value (5 decimal digits) */
  66         if (!strncmp((const char *)buf, "::0<:", 5)) {
  67                 sr_spew("Over limit.");
  68                 *result = INFINITY;
  69                 return SR_OK;
  70         } else if (!strncmp((const char *)buf, ":<0::", 5)) {
  71                 sr_spew("Under limit.");
  72                 *result = INFINITY;
  73                 return SR_OK;
  74         } else if (buf[4] == ':') {
  75                 sr_dbg("4000 count mode, only 4 digits used.");
  76                 num_digits = 4;
  77         } else if (!isdigit(buf[0]) || !isdigit(buf[1]) ||
  78                    !isdigit(buf[2]) || !isdigit(buf[3]) || !isdigit(buf[4])) {
  79                 sr_dbg("Invalid digits: %02x %02x %02x %02x %02x (%c %c "
  80                        "%c %c %c).", buf[0], buf[1], buf[2], buf[3], buf[4],
  81                        buf[0], buf[1], buf[2], buf[3], buf[4]);
  82                 return SR_ERR;
  83         }
  84
  85         for (i = 0, intval = 0; i < num_digits; i++)
  86                 intval = 10 * intval + (buf[i] - '0');
  87
  88         /*
  89          * For measurements that only have 4000 instead of 40000 counts
  90          * (resistance, continuity) we have to use an additional factor of 10.
  91          *
  92          * This seems to vary between DMMs. E.g. the Voltcraft VC920 and VC940
  93          * have 4000 counts for resistance, whereas the Tenma 72-9380A,
  94          * 72-7730 and 72-7732 have 40000 counts for resistance.
  95          */
  96         if (num_digits == 4)
  97                 intval *= 10;
  98
  99         /* Apply sign. */
 100         intval *= info->is_sign ? -1 : 1;
 101
 102         /* Note: The decimal point position will be parsed later. */
 103         *result = (float)intval;
 104         sr_spew("The display value is %f.", *result);
 105
 106         return SR_OK;
 107 }
 108
 109 static int parse_range(const uint8_t *buf, float *floatval, int *exponent)
 110 {
 111         int idx, mode;
 112
 113         idx = buf[5] - '0';
 114         if (idx < 0 || idx > 7) {
 115                 sr_dbg("Invalid range byte 0x%02x (idx 0x%02x).", buf[5], idx);
 116                 return SR_ERR;
 117         }
 118
 119         mode = buf[6] - '0';
 120         if (mode < 0 || mode > 15) {
 121                 sr_dbg("Invalid mode byte 0x%02x (idx 0x%02x).", buf[6], mode);
 122                 return SR_ERR;
 123         }
 124
 125         sr_spew("mode/idx = %d/%d", mode, idx);
 126
 127         *exponent = exponents[mode][idx];
 128
 129         /* Apply respective exponent (mode-dependent) on the value. */
 130         *floatval *= powf(10, *exponent);
 131         sr_dbg("Applying exponent %d, new value is %g.", *exponent, *floatval);
 132
 133         return SR_OK;
 134 }
 135
 136 static void parse_flags(const uint8_t *buf, struct ut71x_info *info)
 137 {
 138         /* Function byte */
 139         switch (buf[6] - '0') {
 140         case 0: /* AC mV */
 141                 info->is_voltage = info->is_ac = TRUE;
 142                 break;
 143         case 1: /* DC V */
 144                 info->is_voltage = info->is_dc = TRUE;
 145                 break;
 146         case 2: /* AC V */
 147                 info->is_voltage = info->is_ac = TRUE;
 148                 break;
 149         case 3: /* DC mV */
 150                 info->is_voltage = info->is_dc = TRUE;
 151                 break;
 152         case 4: /* Resistance */
 153                 info->is_resistance = TRUE;
 154                 break;
 155         case 5: /* Capacitance */
 156                 info->is_capacitance = TRUE;
 157                 break;
 158         case 6: /* Temperature (Celsius) */
 159                 info->is_temperature = info->is_celsius = TRUE;
 160                 break;
 161         case 7: /* uA */
 162                 info->is_current = info->is_dc = TRUE;
 163                 break;
 164         case 8: /* mA */
 165                 info->is_current = info->is_dc = TRUE;
 166                 break;
 167         case 9: /* 10A */
 168                 info->is_current = info->is_dc = TRUE;
 169                 break;
 170         case 10: /* Continuity */
 171                 info->is_continuity = TRUE;
 172                 break;
 173         case 11: /* Diode */
 174                 info->is_diode = TRUE;
 175                 break;
 176         case 12: /* Frequency */
 177                 info->is_frequency = TRUE;
 178                 break;
 179         case 13: /* Temperature (F) */
 180                 info->is_temperature = info->is_fahrenheit = TRUE;
 181                 break;
 182         case 14: /* Power */
 183                 /* Note: Only available on UT71E (range 0-2500W). */
 184                 info->is_power = TRUE;
 185                 break;
 186         case 15: /* DC loop current, percentage display (range 4-20mA) */
 187                 info->is_loop_current = TRUE;
 188                 break;
 189         default:
 190                 sr_dbg("Invalid function byte: 0x%02x.", buf[6]);
 191                 break;
 192         }
 193
 194         /*
 195          * State 1 byte: bit 0 = AC, bit 1 = DC
 196          * Either AC or DC or both or none can be set at the same time.
 197          */
 198         info->is_ac = (buf[7] & (1 << 0)) != 0;
 199         info->is_dc = (buf[7] & (1 << 1)) != 0;
 200
 201         /*
 202          * State 2 byte: bit 0 = auto, bit 1 = manual, bit 2 = sign
 203          *
 204          * The Conrad/Voltcraft protocol descriptions have a typo
 205          * (they suggest bit 3 as sign bit, which is incorrect).
 206          *
 207          * For modes where there's only one possible range (e.g. AC mV)
 208          * neither the "auto" nor the "manual" bits will be set.
 209          */
 210         info->is_auto   = (buf[8] & (1 << 0)) != 0;
 211         info->is_manual = (buf[8] & (1 << 1)) != 0;
 212         info->is_sign   = (buf[8] & (1 << 2)) != 0;
 213
 214         /* Note: "Frequency mode + sign bit" means "duty cycle mode". */
 215         if (info->is_frequency && info->is_sign) {
 216                 info->is_duty_cycle = TRUE;
 217                 info->is_frequency = info->is_sign = FALSE;
 218         }
 219 }
 220
 221 static void handle_flags(struct sr_datafeed_analog *analog,
 222                 float *floatval, const struct ut71x_info *info)
 223 {
 224         /* Measurement modes */
 225         if (info->is_voltage) {
 226                 analog->meaning->mq = SR_MQ_VOLTAGE;
 227                 analog->meaning->unit = SR_UNIT_VOLT;
 228         }
 229         if (info->is_current) {
 230                 analog->meaning->mq = SR_MQ_CURRENT;
 231                 analog->meaning->unit = SR_UNIT_AMPERE;
 232         }
 233         if (info->is_resistance) {
 234                 analog->meaning->mq = SR_MQ_RESISTANCE;
 235                 analog->meaning->unit = SR_UNIT_OHM;
 236         }
 237         if (info->is_frequency) {
 238                 analog->meaning->mq = SR_MQ_FREQUENCY;
 239                 analog->meaning->unit = SR_UNIT_HERTZ;
 240         }
 241         if (info->is_capacitance) {
 242                 analog->meaning->mq = SR_MQ_CAPACITANCE;
 243                 analog->meaning->unit = SR_UNIT_FARAD;
 244         }
 245         if (info->is_temperature && info->is_celsius) {
 246                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 247                 analog->meaning->unit = SR_UNIT_CELSIUS;
 248         }
 249         if (info->is_temperature && info->is_fahrenheit) {
 250                 analog->meaning->mq = SR_MQ_TEMPERATURE;
 251                 analog->meaning->unit = SR_UNIT_FAHRENHEIT;
 252         }
 253         if (info->is_continuity) {
 254                 analog->meaning->mq = SR_MQ_CONTINUITY;
 255                 analog->meaning->unit = SR_UNIT_BOOLEAN;
 256                 *floatval = (*floatval < 0.0 || *floatval > 60.0) ? 0.0 : 1.0;
 257         }
 258         if (info->is_diode) {
 259                 analog->meaning->mq = SR_MQ_VOLTAGE;
 260                 analog->meaning->unit = SR_UNIT_VOLT;
 261         }
 262         if (info->is_duty_cycle) {
 263                 analog->meaning->mq = SR_MQ_DUTY_CYCLE;
 264                 analog->meaning->unit = SR_UNIT_PERCENTAGE;
 265         }
 266         if (info->is_power) {
 267                 analog->meaning->mq = SR_MQ_POWER;
 268                 analog->meaning->unit = SR_UNIT_WATT;
 269         }
 270         if (info->is_loop_current) {
 271                 /* 4mA = 0%, 20mA = 100% */
 272                 analog->meaning->mq = SR_MQ_CURRENT;
 273                 analog->meaning->unit = SR_UNIT_PERCENTAGE;
 274         }
 275
 276         /* Measurement related flags */
 277         if (info->is_ac)
 278                 analog->meaning->mqflags |= SR_MQFLAG_AC;
 279         if (info->is_dc)
 280                 analog->meaning->mqflags |= SR_MQFLAG_DC;
 281         if (info->is_ac)
 282                 /* All AC modes do True-RMS measurements. */
 283                 analog->meaning->mqflags |= SR_MQFLAG_RMS;
 284         if (info->is_auto)
 285                 analog->meaning->mqflags |= SR_MQFLAG_AUTORANGE;
 286         if (info->is_diode)
 287                 analog->meaning->mqflags |= SR_MQFLAG_DIODE;
 288 }
 289
 290 static gboolean flags_valid(const struct ut71x_info *info)
 291 {
 292         int count;
 293
 294         /* Does the packet "measure" more than one type of value? */
 295         count  = (info->is_voltage) ? 1 : 0;
 296         count += (info->is_current) ? 1 : 0;
 297         count += (info->is_resistance) ? 1 : 0;
 298         count += (info->is_capacitance) ? 1 : 0;
 299         count += (info->is_frequency) ? 1 : 0;
 300         count += (info->is_temperature) ? 1 : 0;
 301         count += (info->is_continuity) ? 1 : 0;
 302         count += (info->is_diode) ? 1 : 0;
 303         count += (info->is_power) ? 1 : 0;
 304         count += (info->is_loop_current) ? 1 : 0;
 305         if (count > 1) {
 306                 sr_dbg("More than one measurement type detected in packet.");
 307                 return FALSE;
 308         }
 309
 310         /* Auto and manual can't be active at the same time. */
 311         if (info->is_auto && info->is_manual) {
 312                 sr_dbg("Auto and manual modes are both active.");
 313                 return FALSE;
 314         }
 315
 316         return TRUE;
 317 }
 318
 319 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf)
 320 {
 321         struct ut71x_info info;
 322
 323         memset(&info, 0, sizeof(struct ut71x_info));
 324
 325         if (buf[9] != '\r' || buf[10] != '\n')
 326                 return FALSE;
 327
 328         parse_flags(buf, &info);
 329
 330         return flags_valid(&info);
 331 }
 332
 333 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
 334                 struct sr_datafeed_analog *analog, void *info)
 335 {
 336         int ret, exponent = 0;
 337         struct ut71x_info *info_local;
 338
 339         info_local = (struct ut71x_info *)info;
 340         memset(info_local, 0, sizeof(struct ut71x_info));
 341
 342         if (!sr_ut71x_packet_valid(buf))
 343                 return SR_ERR;
 344
 345         parse_flags(buf, info_local);
 346
 347         if ((ret = parse_value(buf, info, floatval)) != SR_OK) {
 348                 sr_dbg("Error parsing value: %d.", ret);
 349                 return ret;
 350         }
 351
 352         if ((ret = parse_range(buf, floatval, &exponent)) != SR_OK)
 353                 return ret;
 354
 355         handle_flags(analog, floatval, info);
 356
 357         analog->encoding->digits = -exponent;
 358         analog->spec->spec_digits = -exponent;
 359
 360         return SR_OK;
 361 }