src/hardware/norma-dmm/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   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 3 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 /** @file
  21  *  Norma DM9x0/Siemens B102x DMMs driver.
  22  *  @internal
  23  */
  24
  25 #include <config.h>
  26 #include "protocol.h"
  27
  28 #define LINE_LENGTH 20
  29
  30 SR_PRIV const struct nmadmm_req nmadmm_requests[] = {
  31         { NMADMM_REQ_IDN, "IDN?" },
  32         { NMADMM_REQ_IDN, "STATUS?" },
  33         ALL_ZERO
  34 };
  35
  36 static int nma_send_req(const struct sr_dev_inst *sdi, int req, char *params)
  37 {
  38         struct sr_serial_dev_inst *serial;
  39         struct dev_context *devc;
  40         char buf[NMADMM_BUFSIZE];
  41         int len;
  42
  43         if (!sdi || !(serial = sdi->conn) || !(devc = sdi->priv))
  44                 return SR_ERR_BUG;
  45
  46         len = snprintf(buf, sizeof(buf), "%s%s\r\n",
  47                 nmadmm_requests[req].req_str, params ? params : "");
  48
  49         sr_spew("Sending request: '%s'.", buf);
  50
  51         devc->last_req = req;
  52         devc->last_req_pending = TRUE;
  53
  54         if (serial_write_blocking(serial, buf, len,
  55                         serial_timeout(serial, len)) < 0) {
  56                 sr_err("Unable to send request.");
  57                 devc->last_req_pending = FALSE;
  58                 return SR_ERR;
  59         }
  60
  61         devc->req_sent_at = g_get_monotonic_time();
  62
  63         return SR_OK;
  64 }
  65
  66 /**
  67  * Convert hexadecimal digit to int.
  68  *
  69  * @param[in] xgit Hexadecimal digit to convert.
  70  * @return Int value of xgit (0 on invalid xgit).
  71  */
  72 SR_PRIV int xgittoint(char xgit)
  73 {
  74         if ((xgit >= '0') && (xgit <= '9'))
  75                 return xgit - '0';
  76         xgit = tolower(xgit);
  77         if ((xgit >= 'a') && (xgit <= 'f'))
  78                 return xgit - 'a';
  79         return 0;
  80 }
  81
  82 /**
  83  * Process received line. It consists of 20 hex digits + \\r\\n,
  84  * e.g. '08100400018100400000'.
  85  */
  86 static void nma_process_line(const struct sr_dev_inst *sdi)
  87 {
  88         struct dev_context *devc;
  89         int pos, flags;
  90         int vt, range;  /* Measurement value type, range in device format */
  91         int mmode, devstat;     /* Measuring mode, device status */
  92         float value;    /* Measured value */
  93         float scale;    /* Scaling factor depending on range and function */
  94         struct sr_datafeed_analog analog;
  95         struct sr_analog_encoding encoding;
  96         struct sr_analog_meaning meaning;
  97         struct sr_analog_spec spec;
  98         struct sr_datafeed_packet packet;
  99
 100         devc = sdi->priv;
 101
 102         devc->buf[LINE_LENGTH] = '\0';
 103
 104         sr_spew("Received line '%s'.", devc->buf);
 105
 106         /* Check line. */
 107         if (strlen((const char *)devc->buf) != LINE_LENGTH) {
 108                 sr_err("line: Invalid status '%s', must be 20 hex digits.",
 109                        devc->buf);
 110                 devc->buflen = 0;
 111                 return;
 112         }
 113
 114         for (pos = 0; pos < LINE_LENGTH; pos++) {
 115                 if (!isxdigit(devc->buf[pos])) {
 116                         sr_err("line: Expected hex digit in '%s' at pos %d!",
 117                                 devc->buf, pos);
 118                         devc->buflen = 0;
 119                         return;
 120                 }
 121         }
 122
 123         /* Start decoding. */
 124         value = 0.0;
 125         scale = 1.0;
 126         sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
 127
 128         /*
 129          * The numbers are hex digits, starting from 0.
 130          * 0: Keyboard status, currently not interesting.
 131          * 1: Central switch status, currently not interesting.
 132          * 2: Type of measured value.
 133          */
 134         vt = xgittoint(devc->buf[2]);
 135         switch (vt) {
 136         case 0:
 137                 analog.meaning->mq = SR_MQ_VOLTAGE;
 138                 break;
 139         case 1:
 140                 analog.meaning->mq = SR_MQ_CURRENT;     /* 2A */
 141                 break;
 142         case 2:
 143                 analog.meaning->mq = SR_MQ_RESISTANCE;
 144                 break;
 145         case 3:
 146                 analog.meaning->mq = SR_MQ_CAPACITANCE;
 147                 break;
 148         case 4:
 149                 analog.meaning->mq = SR_MQ_TEMPERATURE;
 150                 break;
 151         case 5:
 152                 analog.meaning->mq = SR_MQ_FREQUENCY;
 153                 break;
 154         case 6:
 155                 analog.meaning->mq = SR_MQ_CURRENT;     /* 10A */
 156                 break;
 157         case 7:
 158                 analog.meaning->mq = SR_MQ_GAIN;                /* TODO: Scale factor */
 159                 break;
 160         case 8:
 161                 analog.meaning->mq = SR_MQ_GAIN;                /* Percentage */
 162                 scale /= 100.0;
 163                 break;
 164         case 9:
 165                 analog.meaning->mq = SR_MQ_GAIN;                /* dB */
 166                 scale /= 100.0;
 167                 break;
 168         default:
 169                 sr_err("Unknown value type: 0x%02x.", vt);
 170                 break;
 171         }
 172
 173         /* 3: Measurement range for measured value */
 174         range = xgittoint(devc->buf[3]);
 175         switch (vt) {
 176         case 0: /* V */
 177                 scale *= pow(10.0, range - 5);
 178                 break;
 179         case 1: /* A */
 180                 scale *= pow(10.0, range - 7);
 181                 break;
 182         case 2: /* Ω */
 183                 scale *= pow(10.0, range - 2);
 184                 break;
 185         case 3: /* F */
 186                 scale *= pow(10.0, range - 12);
 187                 break;
 188         case 4: /* °C */
 189                 scale *= pow(10.0, range - 1);
 190                 break;
 191         case 5: /* Hz */
 192                 scale *= pow(10.0, range - 2);
 193                 break;
 194         // No default, other value types have fixed display format.
 195         }
 196
 197         /* 5: Sign and 1st digit */
 198         flags = xgittoint(devc->buf[5]);
 199         value = (flags & 0x03);
 200         if (flags & 0x04)
 201                 scale *= -1;
 202
 203         /* 6-9: 2nd-4th digit */
 204         for (pos = 6; pos < 10; pos++)
 205                 value = value * 10 + xgittoint(devc->buf[pos]);
 206         value *= scale;
 207
 208         /* 10: Display counter */
 209         mmode = xgittoint(devc->buf[10]);
 210         switch (mmode) {
 211         case 0: /* Frequency */
 212                 analog.meaning->unit = SR_UNIT_HERTZ;
 213                 break;
 214         case 1: /* V TRMS, only type 5 */
 215                 analog.meaning->unit = SR_UNIT_VOLT;
 216                 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
 217                 break;
 218         case 2: /* V AC */
 219                 analog.meaning->unit = SR_UNIT_VOLT;
 220                 analog.meaning->mqflags |= SR_MQFLAG_AC;
 221                 if (devc->type >= 3)
 222                         analog.meaning->mqflags |= SR_MQFLAG_RMS;
 223                 break;
 224         case 3: /* V DC */
 225                 analog.meaning->unit = SR_UNIT_VOLT;
 226                 analog.meaning->mqflags |= SR_MQFLAG_DC;
 227                 break;
 228         case 4: /* Ohm */
 229                 analog.meaning->unit = SR_UNIT_OHM;
 230                 break;
 231         case 5: /* Continuity */
 232                 analog.meaning->unit = SR_UNIT_BOOLEAN;
 233                 analog.meaning->mq = SR_MQ_CONTINUITY;
 234                 /* TODO: Continuity handling is a bit odd in libsigrok. */
 235                 break;
 236         case 6: /* Degree Celsius */
 237                 analog.meaning->unit = SR_UNIT_CELSIUS;
 238                 break;
 239         case 7: /* Capacity */
 240                 analog.meaning->unit = SR_UNIT_FARAD;
 241                 break;
 242         case 8: /* Current DC */
 243                 analog.meaning->unit = SR_UNIT_AMPERE;
 244                 analog.meaning->mqflags |= SR_MQFLAG_DC;
 245                 break;
 246         case 9: /* Current AC */
 247                 analog.meaning->unit = SR_UNIT_AMPERE;
 248                 analog.meaning->mqflags |= SR_MQFLAG_AC;
 249                 if (devc->type >= 3)
 250                         analog.meaning->mqflags |= SR_MQFLAG_RMS;
 251                 break;
 252         case 0xa: /* Current TRMS, only type 5 */
 253                 analog.meaning->unit = SR_UNIT_AMPERE;
 254                 analog.meaning->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
 255                 break;
 256         case 0xb: /* Diode */
 257                 analog.meaning->unit = SR_UNIT_VOLT;
 258                 analog.meaning->mqflags |= (SR_MQFLAG_DIODE | SR_MQFLAG_DC);
 259                 break;
 260         default:
 261                 sr_err("Unknown mmode: 0x%02x.", mmode);
 262                 break;
 263         }
 264
 265         /* 11: Device status */
 266         devstat = xgittoint(devc->buf[11]);
 267
 268         switch (devstat) {
 269         case 1: /* Normal measurement */
 270                 break;
 271         case 2: /* Input loop (limit, reference values) */
 272                 break;
 273         case 3: /* TRANS/SENS */
 274                 break;
 275         case 4: /* Error */
 276                 sr_err("Device error. Fuse?"); /* TODO: Really abort? */
 277                 devc->buflen = 0;
 278                 return; /* Cannot continue. */
 279         default:
 280                 sr_err("Unknown device status: 0x%02x", devstat);
 281                 break;
 282         }
 283
 284         /* 12-19: Flags and display symbols */
 285         /* 12, 13 */
 286         flags = (xgittoint(devc->buf[12]) << 8) | xgittoint(devc->buf[13]);
 287         /* 0x80: PRINT TODO: Stop polling when discovered? */
 288         /* 0x40: EXTR */
 289         if (analog.meaning->mq == SR_MQ_CONTINUITY) {
 290                 if (flags & 0x20)
 291                         value = 1.0; /* Beep */
 292                 else
 293                         value = 0.0;
 294         }
 295         /* 0x10: AVG */
 296         /* 0x08: Diode */
 297         if (flags & 0x04) /* REL */
 298                 analog.meaning->mqflags |= SR_MQFLAG_RELATIVE;
 299         /* 0x02: SHIFT  */
 300         if (flags & 0x01) /* % */
 301                 analog.meaning->unit = SR_UNIT_PERCENTAGE;
 302
 303         /* 14, 15 */
 304         flags = (xgittoint(devc->buf[14]) << 8) | xgittoint(devc->buf[15]);
 305         if (!(flags & 0x80))    /* MAN: Manual range */
 306                 analog.meaning->mqflags |= SR_MQFLAG_AUTORANGE;
 307         if (flags & 0x40) /* LOBATT1: Low battery, measurement still within specs */
 308                 devc->lowbatt = 1;
 309         /* 0x20: PEAK */
 310         /* 0x10: COUNT */
 311         if (flags & 0x08)       /* HOLD */
 312                 analog.meaning->mqflags |= SR_MQFLAG_HOLD;
 313         /* 0x04: LIMIT  */
 314         if (flags & 0x02)       /* MAX */
 315                 analog.meaning->mqflags |= SR_MQFLAG_MAX;
 316         if (flags & 0x01)       /* MIN */
 317                 analog.meaning->mqflags |= SR_MQFLAG_MIN;
 318
 319         /* 16, 17 */
 320         flags = (xgittoint(devc->buf[16]) << 8) | xgittoint(devc->buf[17]);
 321         /* 0xe0: undefined */
 322         if (flags & 0x10) { /* LOBATT2: Low battery, measurement inaccurate */
 323                 devc->lowbatt = 2;
 324                 sr_warn("Low battery, measurement quality degraded!");
 325         }
 326         /* 0x08: SCALED */
 327         /* 0x04: RATE (=lower resolution, allows higher data rate up to 10/s. */
 328         /* 0x02: Current clamp */
 329         if (flags & 0x01) { /* dB */
 330                 /*
 331                  * TODO: The Norma has an adjustable dB reference value. If
 332                  * changed from default, this is not correct.
 333                  */
 334                 if (analog.meaning->unit == SR_UNIT_VOLT)
 335                         analog.meaning->unit = SR_UNIT_DECIBEL_VOLT;
 336                 else
 337                         analog.meaning->unit = SR_UNIT_UNITLESS;
 338         }
 339
 340         /* 18, 19 */
 341         /* flags = (xgittoint(devc->buf[18]) << 8) | xgittoint(devc->buf[19]); */
 342         /* 0x80: Undefined. */
 343         /* 0x40: Remote mode, keyboard locked */
 344         /* 0x38: Undefined. */
 345         /* 0x04: MIN > MAX */
 346         /* 0x02: Measured value < Min */
 347         /* 0x01: Measured value > Max */
 348
 349         /* 4: Flags. Evaluating this after setting value! */
 350         flags = xgittoint(devc->buf[4]);
 351         if (flags & 0x04) /* Invalid value */
 352             value = NAN;
 353         else if (flags & 0x01) /* Overload */
 354             value =  INFINITY;
 355         if (flags & 0x02) { /* Duplicate value, has been sent before. */
 356             sr_spew("Duplicate value, dismissing!");
 357             devc->buflen = 0;
 358             return;
 359         }
 360
 361         sr_spew("range=%d/scale=%f/value=%f", range,
 362                 (double)scale, (double)value);
 363
 364         /* Finish and send packet. */
 365         analog.meaning->channels = sdi->channels;
 366         analog.num_samples = 1;
 367         analog.data = &value;
 368
 369         memset(&packet, 0, sizeof(struct sr_datafeed_packet));
 370         packet.type = SR_DF_ANALOG;
 371         packet.payload = &analog;
 372         sr_session_send(sdi, &packet);
 373
 374         /* Finish processing. */
 375         sr_sw_limits_update_samples_read(&devc->limits, 1);
 376         devc->buflen = 0;
 377 }
 378
 379 SR_PRIV int norma_dmm_receive_data(int fd, int revents, void *cb_data)
 380 {
 381         struct sr_dev_inst *sdi;
 382         struct dev_context *devc;
 383         struct sr_serial_dev_inst *serial;
 384         int len;
 385
 386         (void)fd;
 387
 388         if (!(sdi = cb_data))
 389                 return TRUE;
 390
 391         if (!(devc = sdi->priv))
 392                 return TRUE;
 393
 394         serial = sdi->conn;
 395         if (revents == G_IO_IN) {
 396                 /* Serial data arrived. */
 397                 while (NMADMM_BUFSIZE - devc->buflen - 1 > 0) {
 398                         len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
 399                         if (len < 1)
 400                                 break;
 401                         devc->buflen += len;
 402                         *(devc->buf + devc->buflen) = '\0';
 403                         if (*(devc->buf + devc->buflen - 1) == '\n') {
 404                                 /*
 405                                  * TODO: According to specs, should be \r, but
 406                                  * then we'd have to get rid of the \n.
 407                                  */
 408                                 devc->last_req_pending = FALSE;
 409                                 nma_process_line(sdi);
 410                                 break;
 411                         }
 412                 }
 413         }
 414
 415         if (sr_sw_limits_check(&devc->limits)) {
 416                 sdi->driver->dev_acquisition_stop(sdi);
 417         } else {
 418                 /* Request next package. */
 419                 if (devc->last_req_pending) {
 420                         gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
 421                         if (elapsed_us > NMADMM_TIMEOUT_MS * 1000) {/* Timeout! */
 422                                 sr_spew("Request timeout!");
 423                                 devc->last_req_pending = FALSE;
 424                         }
 425                 }
 426                 if (!devc->last_req_pending) {
 427                         if (nma_send_req(sdi, NMADMM_REQ_STATUS, NULL) != SR_OK)
 428                                 return FALSE;
 429                 }
 430         }
 431
 432         return TRUE;
 433 }