[libsigrok.git] / src / hardware / fluke-dmm / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t drvopts[] = {
	SR_CONF_MULTIMETER,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

static const char *scan_conn[] = {
	/* 287/289 */
	"115200/8n1",
	/* 187/189 */
	"9600/8n1",
	/* Scopemeter 190 series */
	"1200/8n1",
	NULL
};

static const struct flukedmm_profile supported_flukedmm[] = {
	{ FLUKE_187, "187", 100, 1000 },
	{ FLUKE_189, "189", 100, 1000 },
	{ FLUKE_287, "287", 100, 1000 },
	{ FLUKE_190, "199B", 1000, 3500 },
	{ FLUKE_289, "289", 100, 1000 },
};

static GSList *fluke_scan(struct sr_dev_driver *di, const char *conn,
		const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int retry, len, i, s;
	char buf[128], *b, **tokens;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	b = buf;
	retry = 0;
	devices = NULL;
	/* We'll try the discovery sequence three times in case the device
	 * is not in an idle state when we send ID. */
	while (!devices && retry < 3) {
		retry++;
		serial_flush(serial);
		if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
			sr_err("Unable to send ID string");
			continue;
		}

		/* Response is first a CMD_ACK byte (ASCII '0' for OK,
		 * or '1' to signify an error. */
		len = 128;
		serial_readline(serial, &b, &len, 150);
		if (len != 1)
			continue;
		if (buf[0] != '0')
			continue;

		/* If CMD_ACK was OK, ID string follows. */
		len = 128;
		serial_readline(serial, &b, &len, 850);
		if (len < 10)
			continue;
		if (strcspn(buf, ",") < 15)
			/* Looks like it's comma-separated. */
			tokens = g_strsplit(buf, ",", 3);
		else
			/* Fluke 199B, at least, uses semicolon. */
			tokens = g_strsplit(buf, ";", 3);
		if (!strncmp("FLUKE", tokens[0], 5)
				&& tokens[1] && tokens[2]) {
			for (i = 0; supported_flukedmm[i].model; i++) {
				if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
					continue;
				/* Skip leading spaces in version number. */
				for (s = 0; tokens[1][s] == ' '; s++);
				sdi = g_malloc0(sizeof(struct sr_dev_inst));
				sdi->status = SR_ST_INACTIVE;
				sdi->vendor = g_strdup("Fluke");
				sdi->model = g_strdup(tokens[0] + 6);
				sdi->version = g_strdup(tokens[1] + s);
				devc = g_malloc0(sizeof(struct dev_context));
				sr_sw_limits_init(&devc->limits);
				devc->profile = &supported_flukedmm[i];
				sdi->inst_type = SR_INST_SERIAL;
				sdi->conn = serial;
				sdi->priv = devc;
				sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
				devices = g_slist_append(devices, sdi);
				break;
			}
		}
		g_strfreev(tokens);
		if (devices)
			/* Found one. */
			break;
	}
	serial_close(serial);
	if (!devices)
		sr_serial_dev_inst_free(serial);

	return std_scan_complete(di, devices);
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct sr_config *src;
	GSList *l, *devices;
	int i;
	const char *conn, *serialcomm;

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (!conn)
		return NULL;

	devices = NULL;
	if (serialcomm) {
		/* Use the provided comm specs. */
		devices = fluke_scan(di, conn, serialcomm);
	} else {
		for (i = 0; scan_conn[i]; i++) {
			if ((devices = fluke_scan(di, conn, scan_conn[i])))
				break;
			/* The Scopemeter 199B, at least, requires this
			 * after all the 115k/9.6k confusion. */
			g_usleep(5 * 1000);
		}
	}

	return devices;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	devc = sdi->priv;

	return sr_sw_limits_config_set(&devc->limits, key, data);
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

	devc = sdi->priv;

	sr_sw_limits_acquisition_start(&devc->limits);
	std_session_send_df_header(sdi);

	/* Poll every 100ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			fluke_receive_data, (void *)sdi);

	if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
		sr_err("Unable to send QM.");
		return SR_ERR;
	}
	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	devc->expect_response = TRUE;

	return SR_OK;
}

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