src/hardware/fluke-dmm/api.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 <config.h>
  21 #include <glib.h>
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <fcntl.h>
  25 #include <string.h>
  26 #include <libsigrok/libsigrok.h>
  27 #include "libsigrok-internal.h"
  28 #include "protocol.h"
  29
  30 static const uint32_t scanopts[] = {
  31         SR_CONF_CONN,
  32         SR_CONF_SERIALCOMM,
  33 };
  34
  35 static const uint32_t devopts[] = {
  36         SR_CONF_MULTIMETER,
  37         SR_CONF_CONTINUOUS,
  38         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  39         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  40 };
  41
  42 static const char *scan_conn[] = {
  43         /* 287/289 */
  44         "115200/8n1",
  45         /* 187/189 */
  46         "9600/8n1",
  47         /* Scopemeter 190 series */
  48         "1200/8n1",
  49         NULL
  50 };
  51
  52 static const struct flukedmm_profile supported_flukedmm[] = {
  53         { FLUKE_187, "187", 100, 1000 },
  54         { FLUKE_189, "189", 100, 1000 },
  55         { FLUKE_287, "287", 100, 1000 },
  56         { FLUKE_190, "199B", 1000, 3500 },
  57         { FLUKE_289, "289", 100, 1000 },
  58 };
  59
  60 static GSList *fluke_scan(struct sr_dev_driver *di, const char *conn,
  61                 const char *serialcomm)
  62 {
  63         struct sr_dev_inst *sdi;
  64         struct dev_context *devc;
  65         struct sr_serial_dev_inst *serial;
  66         GSList *devices;
  67         int retry, len, i, s;
  68         char buf[128], *b, **tokens;
  69
  70         serial = sr_serial_dev_inst_new(conn, serialcomm);
  71
  72         if (serial_open(serial, SERIAL_RDWR) != SR_OK)
  73                 return NULL;
  74
  75         b = buf;
  76         retry = 0;
  77         devices = NULL;
  78         /* We'll try the discovery sequence three times in case the device
  79          * is not in an idle state when we send ID. */
  80         while (!devices && retry < 3) {
  81                 retry++;
  82                 serial_flush(serial);
  83                 if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
  84                         sr_err("Unable to send ID string");
  85                         continue;
  86                 }
  87
  88                 /* Response is first a CMD_ACK byte (ASCII '0' for OK,
  89                  * or '1' to signify an error. */
  90                 len = 128;
  91                 serial_readline(serial, &b, &len, 150);
  92                 if (len != 1)
  93                         continue;
  94                 if (buf[0] != '0')
  95                         continue;
  96
  97                 /* If CMD_ACK was OK, ID string follows. */
  98                 len = 128;
  99                 serial_readline(serial, &b, &len, 850);
 100                 if (len < 10)
 101                         continue;
 102                 if (strcspn(buf, ",") < 15)
 103                         /* Looks like it's comma-separated. */
 104                         tokens = g_strsplit(buf, ",", 3);
 105                 else
 106                         /* Fluke 199B, at least, uses semicolon. */
 107                         tokens = g_strsplit(buf, ";", 3);
 108                 if (!strncmp("FLUKE", tokens[0], 5)
 109                                 && tokens[1] && tokens[2]) {
 110                         for (i = 0; supported_flukedmm[i].model; i++) {
 111                                 if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
 112                                         continue;
 113                                 /* Skip leading spaces in version number. */
 114                                 for (s = 0; tokens[1][s] == ' '; s++);
 115                                 sdi = g_malloc0(sizeof(struct sr_dev_inst));
 116                                 sdi->status = SR_ST_INACTIVE;
 117                                 sdi->vendor = g_strdup("Fluke");
 118                                 sdi->model = g_strdup(tokens[0] + 6);
 119                                 sdi->version = g_strdup(tokens[1] + s);
 120                                 devc = g_malloc0(sizeof(struct dev_context));
 121                                 sr_sw_limits_init(&devc->limits);
 122                                 devc->profile = &supported_flukedmm[i];
 123                                 sdi->inst_type = SR_INST_SERIAL;
 124                                 sdi->conn = serial;
 125                                 sdi->priv = devc;
 126                                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
 127                                 devices = g_slist_append(devices, sdi);
 128                                 break;
 129                         }
 130                 }
 131                 g_strfreev(tokens);
 132                 if (devices)
 133                         /* Found one. */
 134                         break;
 135         }
 136         serial_close(serial);
 137         if (!devices)
 138                 sr_serial_dev_inst_free(serial);
 139
 140         return std_scan_complete(di, devices);
 141 }
 142
 143 static GSList *scan(struct sr_dev_driver *di, GSList *options)
 144 {
 145         struct sr_config *src;
 146         GSList *l, *devices;
 147         int i;
 148         const char *conn, *serialcomm;
 149
 150         conn = serialcomm = NULL;
 151         for (l = options; l; l = l->next) {
 152                 src = l->data;
 153                 switch (src->key) {
 154                 case SR_CONF_CONN:
 155                         conn = g_variant_get_string(src->data, NULL);
 156                         break;
 157                 case SR_CONF_SERIALCOMM:
 158                         serialcomm = g_variant_get_string(src->data, NULL);
 159                         break;
 160                 }
 161         }
 162         if (!conn)
 163                 return NULL;
 164
 165         devices = NULL;
 166         if (serialcomm) {
 167                 /* Use the provided comm specs. */
 168                 devices = fluke_scan(di, conn, serialcomm);
 169         } else {
 170                 for (i = 0; scan_conn[i]; i++) {
 171                         if ((devices = fluke_scan(di, conn, scan_conn[i])))
 172                                 break;
 173                         /* The Scopemeter 199B, at least, requires this
 174                          * after all the 115k/9.6k confusion. */
 175                         g_usleep(5 * 1000);
 176                 }
 177         }
 178
 179         return devices;
 180 }
 181
 182 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 183                 const struct sr_channel_group *cg)
 184 {
 185         struct dev_context *devc;
 186
 187         (void)cg;
 188
 189         devc = sdi->priv;
 190
 191         return sr_sw_limits_config_set(&devc->limits, key, data);
 192 }
 193
 194 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 195                 const struct sr_channel_group *cg)
 196 {
 197         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, devopts);
 198 }
 199
 200 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 201 {
 202         struct dev_context *devc;
 203         struct sr_serial_dev_inst *serial;
 204
 205         devc = sdi->priv;
 206
 207         sr_sw_limits_acquisition_start(&devc->limits);
 208         std_session_send_df_header(sdi);
 209
 210         /* Poll every 100ms, or whenever some data comes in. */
 211         serial = sdi->conn;
 212         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 213                         fluke_receive_data, (void *)sdi);
 214
 215         if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
 216                 sr_err("Unable to send QM.");
 217                 return SR_ERR;
 218         }
 219         devc->cmd_sent_at = g_get_monotonic_time() / 1000;
 220         devc->expect_response = TRUE;
 221
 222         return SR_OK;
 223 }
 224
 225 static struct sr_dev_driver flukedmm_driver_info = {
 226         .name = "fluke-dmm",
 227         .longname = "Fluke 18x/28x series DMMs",
 228         .api_version = 1,
 229         .init = std_init,
 230         .cleanup = std_cleanup,
 231         .scan = scan,
 232         .dev_list = std_dev_list,
 233         .dev_clear = std_dev_clear,
 234         .config_get = NULL,
 235         .config_set = config_set,
 236         .config_list = config_list,
 237         .dev_open = std_serial_dev_open,
 238         .dev_close = std_serial_dev_close,
 239         .dev_acquisition_start = dev_acquisition_start,
 240         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 241         .context = NULL,
 242 };
 243 SR_REGISTER_DEV_DRIVER(flukedmm_driver_info);