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