src/hardware/agilent-dmm/sched.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   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 #include <glib.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <errno.h>
  24 #include <math.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27 #include "agilent-dmm.h"
  28
  29 static void dispatch(const struct sr_dev_inst *sdi)
  30 {
  31         struct dev_context *devc;
  32         const struct agdmm_job *jobs;
  33         int64_t now;
  34         int i;
  35
  36         devc = sdi->priv;
  37         jobs = devc->profile->jobs;
  38         now = g_get_monotonic_time() / 1000;
  39         for (i = 0; (&jobs[i])->interval; i++) {
  40                 if (now - devc->jobqueue[i] > (&jobs[i])->interval) {
  41                         sr_spew("Running job %d.", i);
  42                         (&jobs[i])->send(sdi);
  43                         devc->jobqueue[i] = now;
  44                 }
  45         }
  46 }
  47
  48 static void receive_line(const struct sr_dev_inst *sdi)
  49 {
  50         struct dev_context *devc;
  51         const struct agdmm_recv *recvs, *recv;
  52         GRegex *reg;
  53         GMatchInfo *match;
  54         int i;
  55
  56         devc = sdi->priv;
  57
  58         /* Strip CRLF */
  59         while (devc->buflen) {
  60                 if (*(devc->buf + devc->buflen - 1) == '\r'
  61                                 || *(devc->buf + devc->buflen - 1) == '\n')
  62                         *(devc->buf + --devc->buflen) = '\0';
  63                 else
  64                         break;
  65         }
  66         sr_spew("Received '%s'.", devc->buf);
  67
  68         recv = NULL;
  69         recvs = devc->profile->recvs;
  70         for (i = 0; (&recvs[i])->recv_regex; i++) {
  71                 reg = g_regex_new((&recvs[i])->recv_regex, 0, 0, NULL);
  72                 if (g_regex_match(reg, (char *)devc->buf, 0, &match)) {
  73                         recv = &recvs[i];
  74                         break;
  75                 }
  76                 g_match_info_unref(match);
  77                 g_regex_unref(reg);
  78         }
  79         if (recv) {
  80                 recv->recv(sdi, match);
  81                 g_match_info_unref(match);
  82                 g_regex_unref(reg);
  83         } else
  84                 sr_dbg("Unknown line '%s'.", devc->buf);
  85
  86         /* Done with this. */
  87         devc->buflen = 0;
  88 }
  89
  90 SR_PRIV int agdmm_receive_data(int fd, int revents, void *cb_data)
  91 {
  92         struct sr_dev_inst *sdi;
  93         struct dev_context *devc;
  94         struct sr_serial_dev_inst *serial;
  95         int len;
  96
  97         (void)fd;
  98
  99         if (!(sdi = cb_data))
 100                 return TRUE;
 101
 102         if (!(devc = sdi->priv))
 103                 return TRUE;
 104
 105         serial = sdi->conn;
 106         if (revents == G_IO_IN) {
 107                 /* Serial data arrived. */
 108                 while (AGDMM_BUFSIZE - devc->buflen - 1 > 0) {
 109                         len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
 110                         if (len < 1)
 111                                 break;
 112                         devc->buflen += len;
 113                         *(devc->buf + devc->buflen) = '\0';
 114                         if (*(devc->buf + devc->buflen - 1) == '\n') {
 115                                 /* End of line */
 116                                 receive_line(sdi);
 117                                 break;
 118                         }
 119                 }
 120         }
 121
 122         dispatch(sdi);
 123
 124         if (devc->limit_samples && devc->num_samples >= devc->limit_samples)
 125                 sdi->driver->dev_acquisition_stop(sdi, cb_data);
 126
 127         return TRUE;
 128 }
 129
 130 static int agdmm_send(const struct sr_dev_inst *sdi, const char *cmd)
 131 {
 132         struct sr_serial_dev_inst *serial;
 133         char buf[32];
 134
 135         serial = sdi->conn;
 136
 137         sr_spew("Sending '%s'.", cmd);
 138         strncpy(buf, cmd, 28);
 139         if (!strncmp(buf, "*IDN?", 5))
 140                 strcat(buf, "\r\n");
 141         else
 142                 strcat(buf, "\n\r\n");
 143         if (serial_write_blocking(serial, buf, strlen(buf), SERIAL_WRITE_TIMEOUT_MS) < (int)strlen(buf)) {
 144                 sr_err("Failed to send.");
 145                 return SR_ERR;
 146         }
 147
 148         return SR_OK;
 149 }
 150
 151 static int send_stat(const struct sr_dev_inst *sdi)
 152 {
 153         return agdmm_send(sdi, "STAT?");
 154 }
 155
 156 static int recv_stat_u123x(const struct sr_dev_inst *sdi, GMatchInfo *match)
 157 {
 158         struct dev_context *devc;
 159         char *s;
 160
 161         devc = sdi->priv;
 162         s = g_match_info_fetch(match, 1);
 163         sr_spew("STAT response '%s'.", s);
 164
 165         /* Max, Min or Avg mode -- no way to tell which, so we'll
 166          * set both flags to denote it's not a normal measurement. */
 167         if (s[0] == '1')
 168                 devc->cur_mqflags |= SR_MQFLAG_MAX | SR_MQFLAG_MIN;
 169         else
 170                 devc->cur_mqflags &= ~(SR_MQFLAG_MAX | SR_MQFLAG_MIN);
 171
 172         if (s[1] == '1')
 173                 devc->cur_mqflags |= SR_MQFLAG_RELATIVE;
 174         else
 175                 devc->cur_mqflags &= ~SR_MQFLAG_RELATIVE;
 176
 177         /* Triggered or auto hold modes. */
 178         if (s[2] == '1' || s[3] == '1')
 179                 devc->cur_mqflags |= SR_MQFLAG_HOLD;
 180         else
 181                 devc->cur_mqflags &= ~SR_MQFLAG_HOLD;
 182
 183         /* Temp/aux mode. */
 184         if (s[7] == '1')
 185                 devc->mode_tempaux = TRUE;
 186         else
 187                 devc->mode_tempaux = FALSE;
 188
 189         /* Continuity mode. */
 190         if (s[16] == '1')
 191                 devc->mode_continuity = TRUE;
 192         else
 193                 devc->mode_continuity = FALSE;
 194
 195         g_free(s);
 196
 197         return SR_OK;
 198 }
 199
 200 static int recv_stat_u124x(const struct sr_dev_inst *sdi, GMatchInfo *match)
 201 {
 202         struct dev_context *devc;
 203         char *s;
 204
 205         devc = sdi->priv;
 206         s = g_match_info_fetch(match, 1);
 207         sr_spew("STAT response '%s'.", s);
 208
 209         /* Max, Min or Avg mode -- no way to tell which, so we'll
 210          * set both flags to denote it's not a normal measurement. */
 211         if (s[0] == '1')
 212                 devc->cur_mqflags |= SR_MQFLAG_MAX | SR_MQFLAG_MIN;
 213         else
 214                 devc->cur_mqflags &= ~(SR_MQFLAG_MAX | SR_MQFLAG_MIN);
 215
 216         if (s[1] == '1')
 217                 devc->cur_mqflags |= SR_MQFLAG_RELATIVE;
 218         else
 219                 devc->cur_mqflags &= ~SR_MQFLAG_RELATIVE;
 220
 221         /* Hold mode. */
 222         if (s[7] == '1')
 223                 devc->cur_mqflags |= SR_MQFLAG_HOLD;
 224         else
 225                 devc->cur_mqflags &= ~SR_MQFLAG_HOLD;
 226
 227         g_free(s);
 228
 229         return SR_OK;
 230 }
 231
 232 static int recv_stat_u125x(const struct sr_dev_inst *sdi, GMatchInfo *match)
 233 {
 234         struct dev_context *devc;
 235         char *s;
 236
 237         devc = sdi->priv;
 238         s = g_match_info_fetch(match, 1);
 239         sr_spew("STAT response '%s'.", s);
 240
 241         /* Peak hold mode. */
 242         if (s[4] == '1')
 243                 devc->cur_mqflags |= SR_MQFLAG_MAX;
 244         else
 245                 devc->cur_mqflags &= ~SR_MQFLAG_MAX;
 246
 247         /* Triggered hold mode. */
 248         if (s[7] == '1')
 249                 devc->cur_mqflags |= SR_MQFLAG_HOLD;
 250         else
 251                 devc->cur_mqflags &= ~SR_MQFLAG_HOLD;
 252
 253         g_free(s);
 254
 255         return SR_OK;
 256 }
 257
 258 static int send_fetc(const struct sr_dev_inst *sdi)
 259 {
 260         return agdmm_send(sdi, "FETC?");
 261 }
 262
 263 static int recv_fetc(const struct sr_dev_inst *sdi, GMatchInfo *match)
 264 {
 265         struct dev_context *devc;
 266         struct sr_datafeed_packet packet;
 267         struct sr_datafeed_analog analog;
 268         float fvalue;
 269         const char *s;
 270         char *mstr;
 271
 272         sr_spew("FETC reply '%s'.", g_match_info_get_string(match));
 273         devc = sdi->priv;
 274
 275         if (devc->cur_mq == -1)
 276                 /* Haven't seen configuration yet, so can't know what
 277                  * the fetched float means. Not really an error, we'll
 278                  * get metadata soon enough. */
 279                 return SR_OK;
 280
 281         s = g_match_info_get_string(match);
 282         if (!strcmp(s, "-9.90000000E+37") || !strcmp(s, "+9.90000000E+37")) {
 283                 /* An invalid measurement shows up on the display as "O.L", but
 284                  * comes through like this. Since comparing 38-digit floats
 285                  * is rather problematic, we'll cut through this here. */
 286                 fvalue = NAN;
 287         } else {
 288                 mstr = g_match_info_fetch(match, 1);
 289                 if (sr_atof_ascii(mstr, &fvalue) != SR_OK) {
 290                         g_free(mstr);
 291                         sr_dbg("Invalid float.");
 292                         return SR_ERR;
 293                 }
 294                 g_free(mstr);
 295                 if (devc->cur_divider > 0)
 296                         fvalue /= devc->cur_divider;
 297         }
 298
 299         memset(&analog, 0, sizeof(struct sr_datafeed_analog));
 300         analog.mq = devc->cur_mq;
 301         analog.unit = devc->cur_unit;
 302         analog.mqflags = devc->cur_mqflags;
 303         analog.channels = sdi->channels;
 304         analog.num_samples = 1;
 305         analog.data = &fvalue;
 306         packet.type = SR_DF_ANALOG;
 307         packet.payload = &analog;
 308         sr_session_send(devc->cb_data, &packet);
 309
 310         devc->num_samples++;
 311
 312         return SR_OK;
 313 }
 314
 315 static int send_conf(const struct sr_dev_inst *sdi)
 316 {
 317         return agdmm_send(sdi, "CONF?");
 318 }
 319
 320 static int recv_conf_u123x(const struct sr_dev_inst *sdi, GMatchInfo *match)
 321 {
 322         struct dev_context *devc;
 323         char *mstr;
 324
 325         sr_spew("CONF? response '%s'.", g_match_info_get_string(match));
 326         devc = sdi->priv;
 327         mstr = g_match_info_fetch(match, 1);
 328         if (!strcmp(mstr, "V")) {
 329                 devc->cur_mq = SR_MQ_VOLTAGE;
 330                 devc->cur_unit = SR_UNIT_VOLT;
 331                 devc->cur_mqflags = 0;
 332                 devc->cur_divider = 0;
 333         } else if (!strcmp(mstr, "MV")) {
 334                 if (devc->mode_tempaux) {
 335                         devc->cur_mq = SR_MQ_TEMPERATURE;
 336                         /* No way to detect whether Fahrenheit or Celsius
 337                          * is used, so we'll just default to Celsius. */
 338                         devc->cur_unit = SR_UNIT_CELSIUS;
 339                 devc->cur_mqflags = 0;
 340                 devc->cur_divider = 0;
 341                 } else {
 342                         devc->cur_mq = SR_MQ_VOLTAGE;
 343                         devc->cur_unit = SR_UNIT_VOLT;
 344                         devc->cur_mqflags = 0;
 345                         devc->cur_divider = 1000;
 346                 }
 347         } else if (!strcmp(mstr, "A")) {
 348                 devc->cur_mq = SR_MQ_CURRENT;
 349                 devc->cur_unit = SR_UNIT_AMPERE;
 350                 devc->cur_mqflags = 0;
 351                 devc->cur_divider = 0;
 352         } else if (!strcmp(mstr, "UA")) {
 353                 devc->cur_mq = SR_MQ_CURRENT;
 354                 devc->cur_unit = SR_UNIT_AMPERE;
 355                 devc->cur_mqflags = 0;
 356                 devc->cur_divider = 1000000;
 357         } else if (!strcmp(mstr, "FREQ")) {
 358                 devc->cur_mq = SR_MQ_FREQUENCY;
 359                 devc->cur_unit = SR_UNIT_HERTZ;
 360                 devc->cur_mqflags = 0;
 361                 devc->cur_divider = 0;
 362         } else if (!strcmp(mstr, "RES")) {
 363                 if (devc->mode_continuity) {
 364                         devc->cur_mq = SR_MQ_CONTINUITY;
 365                         devc->cur_unit = SR_UNIT_BOOLEAN;
 366                 } else {
 367                         devc->cur_mq = SR_MQ_RESISTANCE;
 368                         devc->cur_unit = SR_UNIT_OHM;
 369                 }
 370                 devc->cur_mqflags = 0;
 371                 devc->cur_divider = 0;
 372         } else if (!strcmp(mstr, "CAP")) {
 373                 devc->cur_mq = SR_MQ_CAPACITANCE;
 374                 devc->cur_unit = SR_UNIT_FARAD;
 375                 devc->cur_mqflags = 0;
 376                 devc->cur_divider = 0;
 377         } else
 378                 sr_dbg("Unknown first argument.");
 379         g_free(mstr);
 380
 381         if (g_match_info_get_match_count(match) == 4) {
 382                 mstr = g_match_info_fetch(match, 3);
 383                 /* Third value, if present, is always AC or DC. */
 384                 if (!strcmp(mstr, "AC")) {
 385                         devc->cur_mqflags |= SR_MQFLAG_AC;
 386                         if (devc->cur_mq == SR_MQ_VOLTAGE)
 387                                 devc->cur_mqflags |= SR_MQFLAG_RMS;
 388                 } else if (!strcmp(mstr, "DC")) {
 389                         devc->cur_mqflags |= SR_MQFLAG_DC;
 390                 } else {
 391                 sr_dbg("Unknown first argument '%s'.", mstr);
 392                 }
 393                 g_free(mstr);
 394         } else
 395                 devc->cur_mqflags &= ~(SR_MQFLAG_AC | SR_MQFLAG_DC);
 396
 397         return SR_OK;
 398 }
 399
 400 static int recv_conf_u124x_5x(const struct sr_dev_inst *sdi, GMatchInfo *match)
 401 {
 402         struct dev_context *devc;
 403         char *mstr, *m2;
 404
 405         sr_spew("CONF? response '%s'.", g_match_info_get_string(match));
 406         devc = sdi->priv;
 407         mstr = g_match_info_fetch(match, 1);
 408         if (!strncmp(mstr, "VOLT", 4)) {
 409                 devc->cur_mq = SR_MQ_VOLTAGE;
 410                 devc->cur_unit = SR_UNIT_VOLT;
 411                 devc->cur_mqflags = 0;
 412                 devc->cur_divider = 0;
 413                 if (mstr[4] == ':') {
 414                         if (!strncmp(mstr + 5, "AC", 2)) {
 415                                 devc->cur_mqflags |= SR_MQFLAG_AC | SR_MQFLAG_RMS;
 416                         } else if (!strncmp(mstr + 5, "DC", 2)) {
 417                                 devc->cur_mqflags |= SR_MQFLAG_DC;
 418                         } else if (!strncmp(mstr + 5, "ACDC", 4)) {
 419                                 /* AC + DC offset */
 420                                 devc->cur_mqflags |= SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS;
 421                         } else {
 422                                 devc->cur_mqflags &= ~(SR_MQFLAG_AC | SR_MQFLAG_DC);
 423                         }
 424                 } else
 425                         devc->cur_mqflags &= ~(SR_MQFLAG_AC | SR_MQFLAG_DC);
 426         } else if (!strcmp(mstr, "CURR")) {
 427                 devc->cur_mq = SR_MQ_CURRENT;
 428                 devc->cur_unit = SR_UNIT_AMPERE;
 429                 devc->cur_mqflags = 0;
 430                 devc->cur_divider = 0;
 431         } else if (!strcmp(mstr, "RES")) {
 432                 devc->cur_mq = SR_MQ_RESISTANCE;
 433                 devc->cur_unit = SR_UNIT_OHM;
 434                 devc->cur_mqflags = 0;
 435                 devc->cur_divider = 0;
 436         } else if (!strcmp(mstr, "CAP")) {
 437                 devc->cur_mq = SR_MQ_CAPACITANCE;
 438                 devc->cur_unit = SR_UNIT_FARAD;
 439                 devc->cur_mqflags = 0;
 440                 devc->cur_divider = 0;
 441         } else if (!strcmp(mstr, "FREQ")) {
 442                 devc->cur_mq = SR_MQ_FREQUENCY;
 443                 devc->cur_unit = SR_UNIT_HERTZ;
 444                 devc->cur_mqflags = 0;
 445                 devc->cur_divider = 0;
 446         } else if (!strcmp(mstr, "CONT")) {
 447                 devc->cur_mq = SR_MQ_CONTINUITY;
 448                 devc->cur_unit = SR_UNIT_BOOLEAN;
 449                 devc->cur_mqflags = 0;
 450                 devc->cur_divider = 0;
 451         } else if (!strncmp(mstr, "T1", 2) || !strncmp(mstr, "T2", 2)) {
 452                 devc->cur_mq = SR_MQ_TEMPERATURE;
 453                 m2 = g_match_info_fetch(match, 2);
 454                 if (!strcmp(m2, "FAR"))
 455                         devc->cur_unit = SR_UNIT_FAHRENHEIT;
 456                 else
 457                         devc->cur_unit = SR_UNIT_CELSIUS;
 458                 g_free(m2);
 459                 devc->cur_mqflags = 0;
 460                 devc->cur_divider = 0;
 461         } else if (!strcmp(mstr, "SCOU")) {
 462                 /*
 463                  * Switch counter, not supported. Not sure what values
 464                  * come from FETC in this mode, or how they would map
 465                  * into libsigrok.
 466                  */
 467         } else if (!strncmp(mstr, "CPER:", 5)) {
 468                 devc->cur_mq = SR_MQ_CURRENT;
 469                 devc->cur_unit = SR_UNIT_PERCENTAGE;
 470                 devc->cur_mqflags = 0;
 471                 devc->cur_divider = 0;
 472         } else {
 473                 sr_dbg("Unknown first argument '%s'.", mstr);
 474         }
 475         g_free(mstr);
 476
 477         return SR_OK;
 478 }
 479
 480 static int recv_conf(const struct sr_dev_inst *sdi, GMatchInfo *match)
 481 {
 482         struct dev_context *devc;
 483         char *mstr;
 484
 485         sr_spew("CONF? response '%s'.", g_match_info_get_string(match));
 486         devc = sdi->priv;
 487         mstr = g_match_info_fetch(match, 1);
 488         if (!strcmp(mstr, "DIOD")) {
 489                 devc->cur_mq = SR_MQ_VOLTAGE;
 490                 devc->cur_unit = SR_UNIT_VOLT;
 491                 devc->cur_mqflags = SR_MQFLAG_DIODE;
 492                 devc->cur_divider = 0;
 493         } else
 494                 sr_dbg("Unknown single argument.");
 495         g_free(mstr);
 496
 497         return SR_OK;
 498 }
 499
 500 /* This comes in whenever the rotary switch is changed to a new position.
 501  * We could use it to determine the major measurement mode, but we already
 502  * have the output of CONF? for that, which is more detailed. However
 503  * we do need to catch this here, or it'll show up in some other output. */
 504 static int recv_switch(const struct sr_dev_inst *sdi, GMatchInfo *match)
 505 {
 506         (void)sdi;
 507
 508         sr_spew("Switch '%s'.", g_match_info_get_string(match));
 509
 510         return SR_OK;
 511 }
 512
 513 /* Poll keys/switches and values at 7Hz, mode at 1Hz. */
 514 SR_PRIV const struct agdmm_job agdmm_jobs_u12xx[] = {
 515         { 143, send_stat },
 516         { 1000, send_conf },
 517         { 143, send_fetc },
 518         { 0, NULL }
 519 };
 520
 521 SR_PRIV const struct agdmm_recv agdmm_recvs_u123x[] = {
 522         { "^\"(\\d\\d.{18}\\d)\"$", recv_stat_u123x },
 523         { "^\\*([0-9])$", recv_switch },
 524         { "^([-+][0-9]\\.[0-9]{8}E[-+][0-9]{2})$", recv_fetc },
 525         { "^\"(V|MV|A|UA|FREQ),(\\d),(AC|DC)\"$", recv_conf_u123x },
 526         { "^\"(RES|CAP),(\\d)\"$", recv_conf_u123x},
 527         { "^\"(DIOD)\"$", recv_conf },
 528         { NULL, NULL }
 529 };
 530
 531 SR_PRIV const struct agdmm_recv agdmm_recvs_u124x[] = {
 532         { "^\"(\\d\\d.{18}\\d)\"$", recv_stat_u124x },
 533         { "^\\*([0-9])$", recv_switch },
 534         { "^([-+][0-9]\\.[0-9]{8}E[-+][0-9]{2})$", recv_fetc },
 535         { "^\"(VOLT|CURR|RES|CAP|FREQ) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 536         { "^\"(VOLT:[ACD]+) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 537         { "^\"(CPER:[40]-20mA) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 538         { "^\"(T[0-9]:[A-Z]+) ([A-Z]+)\"$", recv_conf_u124x_5x },
 539         { "^\"(DIOD)\"$", recv_conf },
 540         { NULL, NULL }
 541 };
 542
 543 SR_PRIV const struct agdmm_recv agdmm_recvs_u125x[] = {
 544         { "^\"(\\d\\d.{18}\\d)\"$", recv_stat_u125x },
 545         { "^\\*([0-9])$", recv_switch },
 546         { "^([-+][0-9]\\.[0-9]{8}E[-+][0-9]{2})$", recv_fetc },
 547         { "^\"(VOLT|CURR|RES|CAP|FREQ) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 548         { "^\"(VOLT:[ACD]+) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 549         { "^\"(CPER:[40]-20mA) ([-+][0-9\\.E\\-+]+),([-+][0-9\\.E\\-+]+)\"$", recv_conf_u124x_5x },
 550         { "^\"(T[0-9]:[A-Z]+) ([A-Z]+)\"$", recv_conf_u124x_5x },
 551         { "^\"(DIOD)\"$", recv_conf },
 552         { NULL, NULL }
 553 };