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/>.
24 /* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
25 #define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
26 #define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
27 #define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
29 static const uint32_t scanopts[] = {
34 static const uint32_t drvopts[] = {
36 SR_CONF_THERMOMETER, /**< All GMC 1x/2x multimeters seem to support this */
39 /** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
40 static const uint32_t devopts_sm[] = {
42 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
43 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
46 /** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
47 static const uint32_t devopts_bd[] = {
49 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
50 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
51 SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
55 * - For the 29S SR_CONF_ENERGYMETER, too.
56 * - SR_CONF_PATTERN_MODE for some 2x devices
57 * - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
58 * Need to implement device-specific lists.
62 * Read single byte from serial port.
64 * @retval -1 Timeout or error.
67 static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
73 rc = serial_read_nonblocking(serial, &result, 1);
75 sr_spew("read: 0x%02x/%d", result, result);
78 if (g_get_monotonic_time() > timeout)
85 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
87 * @param serial Configured, open serial port.
89 * @retval NULL Detection failed.
90 * @retval other Model code.
92 static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
94 int byte, bytecnt, cnt;
98 model = METRAHIT_NONE;
99 timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
102 * Try to find message consisting of device code and several
103 * (at least 4) data bytes.
105 for (bytecnt = 0; bytecnt < 100; bytecnt++) {
106 byte = read_byte(serial, timeout_us);
107 if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
109 if ((byte & MSGID_MASK) == MSGID_INF) {
110 if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
112 /* Now expect (at least) 4 data bytes. */
113 for (cnt = 0; cnt < 4; cnt++) {
114 byte = read_byte(serial, timeout_us);
116 ((byte & MSGID_MASK) != MSGID_DATA))
118 model = METRAHIT_NONE;
131 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
134 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
135 * The DMM usually sends up to about 20 messages per second. However, depending
136 * on configuration and measurement mode the intervals can be much larger and
137 * then the detection might not work.
139 static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
141 struct sr_dev_inst *sdi;
142 struct dev_context *devc;
143 struct sr_config *src;
144 struct sr_serial_dev_inst *serial;
146 const char *conn, *serialcomm;
148 gboolean serialcomm_given;
151 conn = serialcomm = NULL;
152 serialcomm_given = FALSE;
154 for (l = options; l; l = l->next) {
158 conn = g_variant_get_string(src->data, NULL);
160 case SR_CONF_SERIALCOMM:
161 serialcomm = g_variant_get_string(src->data, NULL);
162 serialcomm_given = TRUE;
169 serialcomm = SERIALCOMM_2X_RS232;
171 serial = sr_serial_dev_inst_new(conn, serialcomm);
173 if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
174 sr_serial_dev_inst_free(serial);
178 serial_flush(serial);
180 model = scan_model_sm(serial);
183 * If detection failed and no user-supplied parameters,
184 * try second baud rate.
186 if ((model == METRAHIT_NONE) && !serialcomm_given) {
187 serialcomm = SERIALCOMM_1X_RS232;
188 g_free(serial->serialcomm);
189 serial->serialcomm = g_strdup(serialcomm);
190 if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
191 serial_flush(serial);
192 model = scan_model_sm(serial);
196 if (model != METRAHIT_NONE) {
197 sr_spew("%s detected!", gmc_model_str(model));
198 sdi = g_malloc0(sizeof(struct sr_dev_inst));
199 sdi->status = SR_ST_INACTIVE;
200 sdi->vendor = g_strdup("Gossen Metrawatt");
201 sdi->model = g_strdup(gmc_model_str(model));
202 devc = g_malloc0(sizeof(struct dev_context));
203 sr_sw_limits_init(&devc->limits);
205 devc->settings_ok = FALSE;
208 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
209 devices = g_slist_append(devices, sdi);
212 return std_scan_complete(di, devices);
216 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
217 * 'BD 232' interface.
219 static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
221 struct sr_dev_inst *sdi;
222 struct dev_context *devc;
223 struct sr_config *src;
224 struct sr_serial_dev_inst *serial;
226 const char *conn, *serialcomm;
232 conn = serialcomm = NULL;
235 for (l = options; l; l = l->next) {
239 conn = g_variant_get_string(src->data, NULL);
241 case SR_CONF_SERIALCOMM:
242 serialcomm = g_variant_get_string(src->data, NULL);
249 serialcomm = SERIALCOMM_2X;
251 serial = sr_serial_dev_inst_new(conn, serialcomm);
253 if (serial_open(serial, SERIAL_RDWR) != SR_OK)
256 devc = g_malloc0(sizeof(struct dev_context));
258 sdi = g_malloc0(sizeof(struct sr_dev_inst));
259 sdi->status = SR_ST_INACTIVE;
260 sdi->vendor = g_strdup("Gossen Metrawatt");
263 /* Send message 03 "Query multimeter version and status" */
265 if (req_stat14(sdi, TRUE) != SR_OK)
268 /* Wait for reply from device(s) for up to 2s. */
269 timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
271 while (timeout_us > g_get_monotonic_time()) {
272 /* Receive reply (14 bytes) */
274 for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
275 byte = read_byte(serial, timeout_us);
277 devc->buf[devc->buflen++] = (byte & MASK_6BITS);
280 if (devc->buflen != GMC_REPLY_SIZE)
283 devc->addr = devc->buf[0];
287 if (devc->model != METRAHIT_NONE) {
288 sr_spew("%s detected!", gmc_model_str(devc->model));
289 sr_sw_limits_init(&devc->limits);
290 sdi->model = g_strdup(gmc_model_str(devc->model));
291 sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
294 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
295 devices = g_slist_append(devices, sdi);
296 devc = g_malloc0(sizeof(struct dev_context));
297 sdi = g_malloc0(sizeof(struct sr_dev_inst));
298 sdi->status = SR_ST_INACTIVE;
299 sdi->vendor = g_strdup("Gossen Metrawatt");
303 /* Free last alloc that was done in preparation. */
305 sr_dev_inst_free(sdi);
307 return std_scan_complete(di, devices);
310 sr_serial_dev_inst_free(serial);
312 sr_dev_inst_free(sdi);
317 static int dev_close(struct sr_dev_inst *sdi)
319 struct dev_context *devc;
323 devc->model = METRAHIT_NONE;
325 return std_serial_dev_close(sdi);
328 static int config_get(uint32_t key, GVariant **data,
329 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
331 struct dev_context *devc;
341 case SR_CONF_LIMIT_SAMPLES:
342 case SR_CONF_LIMIT_MSEC:
343 return sr_sw_limits_config_get(&devc->limits, key, data);
344 case SR_CONF_POWER_OFF:
345 *data = g_variant_new_boolean(FALSE);
354 /** Implementation of config_list for Metrahit 1x/2x send mode */
355 static int config_list_sm(uint32_t key, GVariant **data,
356 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
358 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts_sm);
361 /** Implementation of config_list for Metrahit 2x bidirectional mode */
362 static int config_list_bd(uint32_t key, GVariant **data,
363 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
365 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts_bd);
368 static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi)
370 struct dev_context *devc;
371 struct sr_serial_dev_inst *serial;
374 devc->settings_ok = FALSE;
377 sr_sw_limits_acquisition_start(&devc->limits);
378 std_session_send_df_header(sdi);
381 serial_source_add(sdi->session, serial, G_IO_IN, 40,
382 gmc_mh_1x_2x_receive_data, (void *)sdi);
387 static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi)
389 struct dev_context *devc;
390 struct sr_serial_dev_inst *serial;
393 devc->settings_ok = FALSE;
396 sr_sw_limits_acquisition_start(&devc->limits);
397 std_session_send_df_header(sdi);
400 serial_source_add(sdi->session, serial, G_IO_IN, 40,
401 gmc_mh_2x_receive_data, (void *)sdi);
403 /* Send start message */
404 return req_meas14(sdi);
407 static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
408 .name = "gmc-mh-1x-2x-rs232",
409 .longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
412 .cleanup = std_cleanup,
413 .scan = scan_1x_2x_rs232,
414 .dev_list = std_dev_list,
415 .dev_clear = std_dev_clear,
416 .config_get = config_get,
417 .config_set = config_set,
418 .config_list = config_list_sm,
419 .dev_open = std_serial_dev_open,
420 .dev_close = dev_close,
421 .dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
422 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
425 SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info);
427 static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
428 .name = "gmc-mh-2x-bd232",
429 .longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
432 .cleanup = std_cleanup,
433 .scan = scan_2x_bd232,
434 .dev_list = std_dev_list,
435 .dev_clear = std_dev_clear,
436 .config_get = config_get,
437 .config_set = config_set,
438 .config_list = config_list_bd,
439 .dev_open = std_serial_dev_open,
440 .dev_close = dev_close,
441 .dev_acquisition_start = dev_acquisition_start_2x_bd232,
442 .dev_acquisition_stop = std_serial_dev_acquisition_stop,
445 SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);