2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
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.
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.
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/>.
23 * Gossen Metrawatt Metrahit 1x/2x drivers
32 /* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
33 #define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
34 #define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
35 #define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
36 #define VENDOR_GMC "Gossen Metrawatt"
38 static const uint32_t scanopts[] = {
43 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
44 static const uint32_t devopts_sm[] = {
46 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
48 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
49 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
52 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
53 static const uint32_t devopts_bd[] = {
55 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
57 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
58 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
59 SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
63 * - For the 29S SR_CONF_ENERGYMETER, too.
64 * - SR_CONF_PATTERN_MODE for some 2x devices
65 * - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
66 * Need to implement device-specific lists.
70 * Read single byte from serial port.
72 * @retval -1 Timeout or error.
75 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
81 rc = serial_read_nonblocking(serial, &result, 1);
83 sr_spew("read: 0x%02x/%d", result, result);
86 if (g_get_monotonic_time() > timeout)
93 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
95 * @param serial Configured, open serial port.
97 * @retval NULL Detection failed.
98 * @retval other Model code.
100 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
102 int byte, bytecnt, cnt;
106 model = METRAHIT_NONE;
107 timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
110 * Try to find message consisting of device code and several
111 * (at least 4) data bytes.
113 for (bytecnt = 0; bytecnt < 100; bytecnt++) {
114 byte = read_byte(serial, timeout_us);
115 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
117 if ((byte & MSGID_MASK) == MSGID_INF) {
118 if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
120 /* Now expect (at least) 4 data bytes. */
121 for (cnt = 0; cnt < 4; cnt++) {
122 byte = read_byte(serial, timeout_us);
124 ((byte & MSGID_MASK) != MSGID_DATA))
126 model = METRAHIT_NONE;
139 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
142 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
143 * The DMM usually sends up to about 20 messages per second. However, depending
144 * on configuration and measurement mode the intervals can be much larger and
145 * then the detection might not work.
147 static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
149 struct sr_dev_inst *sdi;
150 struct dev_context *devc;
151 struct sr_config *src;
152 struct sr_serial_dev_inst *serial;
154 const char *conn, *serialcomm;
156 gboolean serialcomm_given;
159 conn = serialcomm = NULL;
160 serialcomm_given = FALSE;
162 sr_spew("scan_1x_2x_rs232() called!");
164 for (l = options; l; l = l->next) {
168 conn = g_variant_get_string(src->data, NULL);
170 case SR_CONF_SERIALCOMM:
171 serialcomm = g_variant_get_string(src->data, NULL);
172 serialcomm_given = TRUE;
179 serialcomm = SERIALCOMM_2X_RS232;
181 serial = sr_serial_dev_inst_new(conn, serialcomm);
183 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
184 sr_serial_dev_inst_free(serial);
188 serial_flush(serial);
190 model = scan_model_sm(serial);
193 * If detection failed and no user-supplied parameters,
194 * try second baud rate.
196 if ((model == METRAHIT_NONE) && !serialcomm_given) {
197 serialcomm = SERIALCOMM_1X_RS232;
198 g_free(serial->serialcomm);
199 serial->serialcomm = g_strdup(serialcomm);
200 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
201 serial_flush(serial);
202 model = scan_model_sm(serial);
206 if (model != METRAHIT_NONE) {
207 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
208 sdi = g_malloc0(sizeof(struct sr_dev_inst));
209 sdi->status = SR_ST_INACTIVE;
210 sdi->vendor = g_strdup(VENDOR_GMC);
211 sdi->model = g_strdup(gmc_model_str(model));
212 devc = g_malloc0(sizeof(struct dev_context));
213 sr_sw_limits_init(&devc->limits);
215 devc->settings_ok = FALSE;
218 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
219 devices = g_slist_append(devices, sdi);
222 return std_scan_complete(di, devices);
226 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
227 * 'BD 232' interface.
229 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
231 struct sr_dev_inst *sdi;
232 struct dev_context *devc;
233 struct sr_config *src;
234 struct sr_serial_dev_inst *serial;
236 const char *conn, *serialcomm;
242 conn = serialcomm = NULL;
245 sr_spew("scan_2x_bd232() called!");
247 for (l = options; l; l = l->next) {
251 conn = g_variant_get_string(src->data, NULL);
253 case SR_CONF_SERIALCOMM:
254 serialcomm = g_variant_get_string(src->data, NULL);
261 serialcomm = SERIALCOMM_2X;
263 serial = sr_serial_dev_inst_new(conn, serialcomm);
265 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
268 devc = g_malloc0(sizeof(struct dev_context));
270 sdi = g_malloc0(sizeof(struct sr_dev_inst));
271 sdi->status = SR_ST_INACTIVE;
272 sdi->vendor = g_strdup(VENDOR_GMC);
275 /* Send message 03 "Query multimeter version and status" */
277 if (req_stat14(sdi, TRUE) != SR_OK)
280 /* Wait for reply from device(s) for up to 2s. */
281 timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
283 while (timeout_us > g_get_monotonic_time()) {
284 /* Receive reply (14 bytes) */
286 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
287 byte = read_byte(serial, timeout_us);
289 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
292 if (devc->buflen != GMC_REPLY_SIZE)
295 devc->addr = devc->buf[0];
299 if (devc->model != METRAHIT_NONE) {
300 sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
301 sr_sw_limits_init(&devc->limits);
302 sdi->model = g_strdup(gmc_model_str(devc->model));
303 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
306 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
307 devices = g_slist_append(devices, sdi);
308 devc = g_malloc0(sizeof(struct dev_context));
309 sdi = g_malloc0(sizeof(struct sr_dev_inst));
310 sdi->status = SR_ST_INACTIVE;
311 sdi->vendor = g_strdup(VENDOR_GMC);
315 /* Free last alloc if no device found */
316 if (devc->model == METRAHIT_NONE) {
318 sr_dev_inst_free(sdi);
321 return std_scan_complete(di, devices);
324 sr_info("scan_2x_bd232(): Error!");
326 sr_serial_dev_inst_free(serial);
328 sr_dev_inst_free(sdi);
333 static int dev_close(struct sr_dev_inst *sdi)
335 struct dev_context *devc;
337 std_serial_dev_close(sdi);
339 sdi->status = SR_ST_INACTIVE;
340 if ((devc = sdi->priv))
341 devc->model = METRAHIT_NONE;
346 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
347 const struct sr_channel_group *cg)
350 struct dev_context *devc;
361 case SR_CONF_LIMIT_SAMPLES:
362 case SR_CONF_LIMIT_MSEC:
363 return sr_sw_limits_config_get(&devc->limits, key, data);
364 case SR_CONF_POWER_OFF:
365 *data = g_variant_new_boolean(FALSE);
374 /** Implementation of config_list, auxiliary function for common parts. */
375 static int config_list_common(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
376 const struct sr_channel_group *cg)
382 case SR_CONF_SCAN_OPTIONS:
383 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
384 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
393 /** Implementation of config_list for Metrahit 1x/2x send mode */
394 static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
395 const struct sr_channel_group *cg)
398 case SR_CONF_DEVICE_OPTIONS:
399 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
400 devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
403 return config_list_common(key, data, sdi, cg);
409 /** Implementation of config_list for Metrahit 2x bidirectional mode */
410 static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
411 const struct sr_channel_group *cg)
414 case SR_CONF_DEVICE_OPTIONS:
415 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
416 devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
419 return config_list_common(key, data, sdi, cg);
425 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi)
427 struct dev_context *devc;
428 struct sr_serial_dev_inst *serial;
431 devc->settings_ok = FALSE;
434 sr_sw_limits_acquisition_start(&devc->limits);
435 std_session_send_df_header(sdi);
437 /* Poll every 40ms, or whenever some data comes in. */
439 serial_source_add(sdi->session, serial, G_IO_IN, 40,
440 gmc_mh_1x_2x_receive_data, (void *)sdi);
445 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi)
447 struct dev_context *devc;
448 struct sr_serial_dev_inst *serial;
451 devc->settings_ok = FALSE;
454 sr_sw_limits_acquisition_start(&devc->limits);
455 std_session_send_df_header(sdi);
457 /* Poll every 40ms, or whenever some data comes in. */
459 serial_source_add(sdi->session, serial, G_IO_IN, 40,
460 gmc_mh_2x_receive_data, (void *)sdi);
462 /* Send start message */
463 return req_meas14(sdi);
466 static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
467 .name = "gmc-mh-1x-2x-rs232",
468 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
471 .cleanup = std_cleanup,
472 .scan = scan_1x_2x_rs232,
473 .dev_list = std_dev_list,
475 .config_get = config_get,
476 .config_set = config_set,
477 .config_list = config_list_sm,
478 .dev_open = std_serial_dev_open,
479 .dev_close = dev_close,
480 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
481 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
484 SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info);
486 static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
487 .name = "gmc-mh-2x-bd232",
488 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
491 .cleanup = std_cleanup,
492 .scan = scan_2x_bd232,
493 .dev_list = std_dev_list,
495 .config_get = config_get,
496 .config_set = config_set,
497 .config_list = config_list_bd,
498 .dev_open = std_serial_dev_open,
499 .dev_close = dev_close,
500 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
501 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
504 SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);