[libsigrok.git] / src / dmm / metex14.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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/>.
 */

/**
 * @file
 *
 * Metex 14-bytes ASCII protocol parser.
 *
 * This should work for various multimeters which use this kind of protocol,
 * even though there is some variation in which modes each DMM supports.
 *
 * It does _not_ work for all Metex DMMs, some use a quite different protocol.
 */

#include <config.h>
#include <string.h>
#include <strings.h>
#include <ctype.h>
#include <math.h>
#include <glib.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"

#define LOG_PREFIX "metex14"

/** Parse value from buf, byte 2-8. */
static int parse_value(const uint8_t *buf, struct metex14_info *info,
			float *result, int *exponent)
{
	int i, is_ol, cnt, dot_pos;
	char valstr[7 + 1];

	/* Strip all spaces from bytes 2-8. */
	memset(&valstr, 0, 7 + 1);
	for (i = 0, cnt = 0; i < 7; i++) {
		if (buf[2 + i] != ' ')
			valstr[cnt++] = buf[2 + i];
	}

	/* Bytes 5-7: Over limit (various forms) */
	is_ol = 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, ".OL")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "O.L")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL.")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-.OL")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-O.L")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL.")) ? 1 : 0;
	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL")) ? 1 : 0;
	if (is_ol != 0) {
		sr_spew("Over limit.");
		*result = INFINITY;
		return SR_OK;
	}

	/* Logic functions */
	if (!strcmp((const char *)&valstr, "READY") ||
			!strcmp((const char *)&valstr, "FLOAT")) {
		*result = INFINITY;
		info->is_logic = TRUE;
	} else if (!strcmp((const char *)&valstr, "Hi")) {
		*result = 1.0;
		info->is_logic = TRUE;
	} else if (!strcmp((const char *)&valstr, "Lo")) {
		*result = 0.0;
		info->is_logic = TRUE;
	}
	if (info->is_logic)
		return SR_OK;

	/* Bytes 2-8: Sign, value (up to 5 digits) and decimal point */
	sr_atof_ascii((const char *)&valstr, result);

	dot_pos = strcspn(valstr, ".");
	if (dot_pos < cnt)
		*exponent = -(cnt - dot_pos - 1);
	else
		*exponent = 0;

	sr_spew("The display value is %f.", *result);

	return SR_OK;
}

static void parse_flags(const char *buf, struct metex14_info *info)
{
	int i, cnt;
	char unit[4 + 1];
	const char *u;

	/* Bytes 0-1: Measurement mode AC, DC */
	info->is_ac = !strncmp(buf, "AC", 2);
	info->is_dc = !strncmp(buf, "DC", 2);

	/* Bytes 2-8: See parse_value(). */

	/* Strip all spaces from bytes 9-12. */
	memset(&unit, 0, 4 + 1);
	for (i = 0, cnt = 0; i < 4; i++) {
		if (buf[9 + i] != ' ')
			unit[cnt++] = buf[9 + i];
	}

	/* Bytes 9-12: Unit */
	u = (const char *)&unit;
	if (!g_ascii_strcasecmp(u, "A"))
		info->is_ampere = TRUE;
	else if (!g_ascii_strcasecmp(u, "mA"))
		info->is_milli = info->is_ampere = TRUE;
	else if (!g_ascii_strcasecmp(u, "uA"))
		info->is_micro = info->is_ampere = TRUE;
	else if (!g_ascii_strcasecmp(u, "V"))
		info->is_volt = TRUE;
	else if (!g_ascii_strcasecmp(u, "mV"))
		info->is_milli = info->is_volt = TRUE;
	else if (!g_ascii_strcasecmp(u, "Ohm"))
		info->is_ohm = TRUE;
	else if (!g_ascii_strcasecmp(u, "KOhm"))
		info->is_kilo = info->is_ohm = TRUE;
	else if (!g_ascii_strcasecmp(u, "MOhm"))
		info->is_mega = info->is_ohm = TRUE;
	else if (!g_ascii_strcasecmp(u, "pF"))
		info->is_pico = info->is_farad = TRUE;
	else if (!g_ascii_strcasecmp(u, "nF"))
		info->is_nano = info->is_farad = TRUE;
	else if (!g_ascii_strcasecmp(u, "uF"))
		info->is_micro = info->is_farad = TRUE;
	else if (!g_ascii_strcasecmp(u, "KHz"))
		info->is_kilo = info->is_hertz = TRUE;
	else if (!g_ascii_strcasecmp(u, "C"))
		info->is_celsius = TRUE;
	else if (!g_ascii_strcasecmp(u, "F"))
		info->is_fahrenheit = TRUE;
	else if (!g_ascii_strcasecmp(u, "DB"))
		info->is_decibel = TRUE;
	else if (!g_ascii_strcasecmp(u, "dBm"))
		info->is_decibel_mw = TRUE;
	else if (!g_ascii_strcasecmp(u, "W"))
		info->is_watt = TRUE;
	else if (!g_ascii_strcasecmp(u, ""))
		info->is_unitless = TRUE;

	/* Bytes 0-1: Measurement mode, except AC/DC */
	info->is_resistance = !strncmp(buf, "OH", 2) ||
		(!strncmp(buf, "  ", 2) && info->is_ohm);
	info->is_capacity = !strncmp(buf, "CA", 2) ||
		(!strncmp(buf, "  ", 2) && info->is_farad);
	info->is_temperature = !strncmp(buf, "TE", 2) ||
		info->is_celsius || info->is_fahrenheit;
	info->is_diode = !strncmp(buf, "DI", 2) ||
		(!strncmp(buf, "  ", 2) && info->is_volt && info->is_milli);
	info->is_frequency = !strncmp(buf, "FR", 2) ||
		(!strncmp(buf, "  ", 2) && info->is_hertz);
	info->is_gain = !strncmp(buf, "DB", 2) && info->is_decibel;
	info->is_power = (!strncmp(buf, "dB", 2) && info->is_decibel_mw) ||
		((!strncmp(buf, "WT", 2) && info->is_watt));
	info->is_power_factor = !strncmp(buf, "CO", 2) && info->is_unitless;
	info->is_hfe = !strncmp(buf, "HF", 2) ||
		(!strncmp(buf, "  ", 2) && !info->is_ampere &&!info->is_volt &&
		!info->is_resistance && !info->is_capacity && !info->is_frequency &&
		!info->is_temperature && !info->is_power && !info->is_power_factor &&
		!info->is_gain && !info->is_logic && !info->is_diode);
	info->is_min = !strncmp(buf, "MN", 2);
	info->is_max = !strncmp(buf, "MX", 2);
	info->is_avg = !strncmp(buf, "AG", 2);

	/*
	 * Note:
	 * - Protocol doesn't distinguish "resistance" from "beep" mode.
	 * - "DB" shows the logarithmic ratio of input voltage to a
	 *   pre-stored (user-changeable) value in the DMM.
	 */

	/* Byte 13: Always '\r' (carriage return, 0x0d, 13) */
}

static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
			 int *exponent, const struct metex14_info *info)
{
	int factor;

	(void)exponent;

	/* Factors */
	factor = 0;
	if (info->is_pico)
		factor -= 12;
	if (info->is_nano)
		factor -= 9;
	if (info->is_micro)
		factor -= 6;
	if (info->is_milli)
		factor -= 3;
	if (info->is_kilo)
		factor += 3;
	if (info->is_mega)
		factor += 6;
	*floatval *= powf(10, factor);

	/* Measurement modes */
	if (info->is_volt) {
		analog->meaning->mq = SR_MQ_VOLTAGE;
		analog->meaning->unit = SR_UNIT_VOLT;
	}
	if (info->is_ampere) {
		analog->meaning->mq = SR_MQ_CURRENT;
		analog->meaning->unit = SR_UNIT_AMPERE;
	}
	if (info->is_ohm) {
		analog->meaning->mq = SR_MQ_RESISTANCE;
		analog->meaning->unit = SR_UNIT_OHM;
	}
	if (info->is_hertz) {
		analog->meaning->mq = SR_MQ_FREQUENCY;
		analog->meaning->unit = SR_UNIT_HERTZ;
	}
	if (info->is_farad) {
		analog->meaning->mq = SR_MQ_CAPACITANCE;
		analog->meaning->unit = SR_UNIT_FARAD;
	}
	if (info->is_temperature) {
		analog->meaning->mq = SR_MQ_TEMPERATURE;
		if (info->is_celsius)
			analog->meaning->unit = SR_UNIT_CELSIUS;
		else if (info->is_fahrenheit)
			analog->meaning->unit = SR_UNIT_FAHRENHEIT;
		else
			analog->meaning->unit = SR_UNIT_UNITLESS;
	}
	if (info->is_diode) {
		analog->meaning->mq = SR_MQ_VOLTAGE;
		analog->meaning->unit = SR_UNIT_VOLT;
	}
	if (info->is_power) {
		analog->meaning->mq = SR_MQ_POWER;
		if (info->is_decibel_mw)
			analog->meaning->unit = SR_UNIT_DECIBEL_MW;
		else if (info->is_watt)
			analog->meaning->unit = SR_UNIT_WATT;
		else
			analog->meaning->unit = SR_UNIT_UNITLESS;
	}
	if (info->is_power_factor) {
		analog->meaning->mq = SR_MQ_POWER_FACTOR;
		analog->meaning->unit = SR_UNIT_UNITLESS;
	}
	if (info->is_gain) {
		analog->meaning->mq = SR_MQ_GAIN;
		analog->meaning->unit = SR_UNIT_DECIBEL_VOLT;
	}
	if (info->is_hfe) {
		analog->meaning->mq = SR_MQ_GAIN;
		analog->meaning->unit = SR_UNIT_UNITLESS;
	}
	if (info->is_logic) {
		analog->meaning->mq = SR_MQ_GAIN;
		analog->meaning->unit = SR_UNIT_UNITLESS;
	}

	/* Measurement related flags */
	if (info->is_ac)
		analog->meaning->mqflags |= SR_MQFLAG_AC;
	if (info->is_dc)
		analog->meaning->mqflags |= SR_MQFLAG_DC;
	if (info->is_diode)
		analog->meaning->mqflags |= SR_MQFLAG_DIODE | SR_MQFLAG_DC;
	if (info->is_min)
		analog->meaning->mqflags |= SR_MQFLAG_MIN;
	if (info->is_max)
		analog->meaning->mqflags |= SR_MQFLAG_MAX;
	if (info->is_avg)
		analog->meaning->mqflags |= SR_MQFLAG_AVG;
}

static gboolean flags_valid(const struct metex14_info *info)
{
	int count;

	/* Does the packet have more than one multiplier? */
	count = 0;
	count += (info->is_pico) ? 1 : 0;
	count += (info->is_nano) ? 1 : 0;
	count += (info->is_micro) ? 1 : 0;
	count += (info->is_milli) ? 1 : 0;
	count += (info->is_kilo) ? 1 : 0;
	count += (info->is_mega) ? 1 : 0;
	if (count > 1) {
		sr_dbg("More than one multiplier detected in packet.");
		return FALSE;
	}

	/* Does the packet "measure" more than one type of value? */
	count = 0;
	count += (info->is_ac) ? 1 : 0;
	count += (info->is_dc) ? 1 : 0;
	count += (info->is_resistance) ? 1 : 0;
	count += (info->is_capacity) ? 1 : 0;
	count += (info->is_temperature) ? 1 : 0;
	count += (info->is_diode) ? 1 : 0;
	count += (info->is_frequency) ? 1 : 0;
	if (count > 1) {
		sr_dbg("More than one measurement type detected in packet.");
		return FALSE;
	}

	/* Both AC and DC set? */
	if (info->is_ac && info->is_dc) {
		sr_dbg("Both AC and DC flags detected in packet.");
		return FALSE;
	}

	return TRUE;
}

#ifdef HAVE_SERIAL_COMM
SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial)
{
	const uint8_t wbuf = 'D';

	sr_spew("Requesting DMM packet.");

	return serial_write_blocking(serial, &wbuf, 1, 0);
}
#endif

SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf)
{
	struct metex14_info info;

	memset(&info, 0x00, sizeof(struct metex14_info));
	parse_flags((const char *)buf, &info);

	if (!flags_valid(&info))
		return FALSE;

	if (buf[13] != '\r')
		return FALSE;

	return TRUE;
}

SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf)
{
	struct metex14_info info;
	size_t ch_idx;
	const uint8_t *ch_buf;

	ch_buf = buf;
	for (ch_idx = 0; ch_idx < 4; ch_idx++) {
		if (ch_buf[13] != '\r')
			return FALSE;
		memset(&info, 0x00, sizeof(info));
		parse_flags((const char *)ch_buf, &info);
		if (!flags_valid(&info))
			return FALSE;
		ch_buf += METEX14_PACKET_SIZE;
	}
	return TRUE;
}

/**
 * Parse a protocol packet.
 *
 * @param buf Buffer containing the protocol packet. Must not be NULL.
 * @param floatval Pointer to a float variable. That variable will be modified
 *                 in-place depending on the protocol packet. Must not be NULL.
 * @param analog Pointer to a struct sr_datafeed_analog. The struct will be
 *               filled with data according to the protocol packet.
 *               Must not be NULL.
 * @param info Pointer to a struct metex14_info. The struct will be filled
 *             with data according to the protocol packet. Must not be NULL.
 *
 * @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
 *         'analog' variable contents are undefined and should not be used.
 */
SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
			     struct sr_datafeed_analog *analog, void *info)
{
	int ret, exponent = 0;
	struct metex14_info *info_local;

	info_local = info;

	/* Don't print byte 13. That one contains the carriage return. */
	sr_dbg("DMM packet: \"%.13s\"", buf);

	memset(info_local, 0x00, sizeof(struct metex14_info));

	if ((ret = parse_value(buf, info_local, floatval, &exponent)) != SR_OK) {
		sr_dbg("Error parsing value: %d.", ret);
		return ret;
	}

	parse_flags((const char *)buf, info_local);
	handle_flags(analog, floatval, &exponent, info_local);

	analog->encoding->digits = -exponent;
	analog->spec->spec_digits = -exponent;

	return SR_OK;
}

/**
 * Parse one out of four values of a four-display Metex14 variant.
 *
 * The caller's 'info' parameter can be used to track the channel index,
 * as long as the information is kept across calls to the 14-byte packet
 * parse routine (which clears the 'info' container).
 *
 * Since analog values have further details in the 'analog' parameter,
 * passing multiple values per parse routine call is problematic. So we
 * prefer the approach of passing one value per call, which is most
 * reliable and shall fit every similar device with multiple displays.
 *
 * The meters which use this parse routine send one 14-byte packet per
 * display. Each packet has the regular Metex14 layout.
 */
SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
	struct sr_datafeed_analog *analog, void *info)
{
	struct metex14_info *info_local;
	size_t ch_idx;
	const uint8_t *ch_buf;
	int rc;

	info_local = info;
	ch_idx = info_local->ch_idx;
	ch_buf = buf + ch_idx * METEX14_PACKET_SIZE;
	rc = sr_metex14_parse(ch_buf, floatval, analog, info);
	info_local->ch_idx = ch_idx + 1;
	return rc;
}
Commit	Line	Data
ac913e5c	1	/*
50985c20	2	* This file is part of the libsigrok project.
ac913e5c	3	*
71f1302b	4	* Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de>
ac913e5c UH	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 2 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
2ea1fdf1	17	* along with this program; if not, see <http://www.gnu.org/licenses/>.
ac913e5c UH	18	*/
ac913e5c UH	19
e83437ae MH	20	/**
	21	* @file
	22	*
ac913e5c UH	23	* Metex 14-bytes ASCII protocol parser.
	24	*
	25	* This should work for various multimeters which use this kind of protocol,
	26	* even though there is some variation in which modes each DMM supports.
	27	*
	28	* It does _not_ work for all Metex DMMs, some use a quite different protocol.
	29	*/
	30
6ec6c43b	31	#include <config.h>
ac913e5c	32	#include <string.h>
ba464a12	33	#include <strings.h>
ac913e5c UH	34	#include <ctype.h>
	35	#include <math.h>
	36	#include <glib.h>
c1aae900	37	#include <libsigrok/libsigrok.h>
ac913e5c UH	38	#include "libsigrok-internal.h"
ac913e5c UH	39
3544f848	40	#define LOG_PREFIX "metex14"
ac913e5c	41
e83437ae MH	42	/** Parse value from buf, byte 2-8. */
e83437ae MH	43	static int parse_value(const uint8_t buf, struct metex14_info info,
e677490e	44	float result, int exponent)
ac913e5c	45	{
e677490e	46	int i, is_ol, cnt, dot_pos;
1a807c13 UH	47	char valstr[7 + 1];
	48
	49	/* Strip all spaces from bytes 2-8. */
	50	memset(&valstr, 0, 7 + 1);
	51	for (i = 0, cnt = 0; i < 7; i++) {
	52	if (buf[2 + i] != ' ')
	53	valstr[cnt++] = buf[2 + i];
ac913e5c UH	54	}
	55
	56	/* Bytes 5-7: Over limit (various forms) */
	57	is_ol = 0;
34577da6 UH	58	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, ".OL")) ? 1 : 0;
	59	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "O.L")) ? 1 : 0;
	60	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL.")) ? 1 : 0;
	61	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "OL")) ? 1 : 0;
	62	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-.OL")) ? 1 : 0;
	63	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-O.L")) ? 1 : 0;
	64	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL.")) ? 1 : 0;
	65	is_ol += (!g_ascii_strcasecmp((const char *)&valstr, "-OL")) ? 1 : 0;
ac913e5c UH	66	if (is_ol != 0) {
	67	sr_spew("Over limit.");
	68	*result = INFINITY;
	69	return SR_OK;
	70	}
	71
e83437ae MH	72	/* Logic functions */
	73	if (!strcmp((const char *)&valstr, "READY") \|\|
	74	!strcmp((const char *)&valstr, "FLOAT")) {
	75	*result = INFINITY;
	76	info->is_logic = TRUE;
	77	} else if (!strcmp((const char *)&valstr, "Hi")) {
	78	*result = 1.0;
	79	info->is_logic = TRUE;
	80	} else if (!strcmp((const char *)&valstr, "Lo")) {
	81	*result = 0.0;
	82	info->is_logic = TRUE;
	83	}
	84	if (info->is_logic)
	85	return SR_OK;
	86
1a807c13	87	/* Bytes 2-8: Sign, value (up to 5 digits) and decimal point */
4f0463a0	88	sr_atof_ascii((const char *)&valstr, result);
ac913e5c	89
e677490e AJ	90	dot_pos = strcspn(valstr, ".");
	91	if (dot_pos < cnt)
	92	*exponent = -(cnt - dot_pos - 1);
	93	else
	94	*exponent = 0;
	95
1a807c13	96	sr_spew("The display value is %f.", *result);
ac913e5c UH	97
	98	return SR_OK;
	99	}
	100
	101	static void parse_flags(const char buf, struct metex14_info info)
	102	{
71f1302b UH	103	int i, cnt;
	104	char unit[4 + 1];
	105	const char *u;
	106
e83437ae MH	107	/* Bytes 0-1: Measurement mode AC, DC */
	108	info->is_ac = !strncmp(buf, "AC", 2);
	109	info->is_dc = !strncmp(buf, "DC", 2);
ac913e5c	110
1a807c13	111	/* Bytes 2-8: See parse_value(). */
ac913e5c	112
1a807c13	113	/* Strip all spaces from bytes 9-12. */
71f1302b UH	114	memset(&unit, 0, 4 + 1);
	115	for (i = 0, cnt = 0; i < 4; i++) {
	116	if (buf[9 + i] != ' ')
	117	unit[cnt++] = buf[9 + i];
	118	}
1a807c13 UH	119
1a807c13 UH	120	/* Bytes 9-12: Unit */
71f1302b	121	u = (const char *)&unit;
34577da6	122	if (!g_ascii_strcasecmp(u, "A"))
ac913e5c	123	info->is_ampere = TRUE;
34577da6	124	else if (!g_ascii_strcasecmp(u, "mA"))
ac913e5c	125	info->is_milli = info->is_ampere = TRUE;
34577da6	126	else if (!g_ascii_strcasecmp(u, "uA"))
2477fb95	127	info->is_micro = info->is_ampere = TRUE;
34577da6	128	else if (!g_ascii_strcasecmp(u, "V"))
ac913e5c	129	info->is_volt = TRUE;
34577da6	130	else if (!g_ascii_strcasecmp(u, "mV"))
ac913e5c	131	info->is_milli = info->is_volt = TRUE;
34577da6	132	else if (!g_ascii_strcasecmp(u, "Ohm"))
ac913e5c	133	info->is_ohm = TRUE;
34577da6	134	else if (!g_ascii_strcasecmp(u, "KOhm"))
ac913e5c	135	info->is_kilo = info->is_ohm = TRUE;
34577da6	136	else if (!g_ascii_strcasecmp(u, "MOhm"))
ac913e5c	137	info->is_mega = info->is_ohm = TRUE;
34577da6	138	else if (!g_ascii_strcasecmp(u, "pF"))
c02dc3e2	139	info->is_pico = info->is_farad = TRUE;
34577da6	140	else if (!g_ascii_strcasecmp(u, "nF"))
ac913e5c	141	info->is_nano = info->is_farad = TRUE;
34577da6	142	else if (!g_ascii_strcasecmp(u, "uF"))
ac913e5c	143	info->is_micro = info->is_farad = TRUE;
34577da6	144	else if (!g_ascii_strcasecmp(u, "KHz"))
ac913e5c	145	info->is_kilo = info->is_hertz = TRUE;
34577da6	146	else if (!g_ascii_strcasecmp(u, "C"))
ac913e5c	147	info->is_celsius = TRUE;
7fb4ff02 FS	148	else if (!g_ascii_strcasecmp(u, "F"))
7fb4ff02 FS	149	info->is_fahrenheit = TRUE;
34577da6	150	else if (!g_ascii_strcasecmp(u, "DB"))
9871215c	151	info->is_decibel = TRUE;
7fb4ff02 FS	152	else if (!g_ascii_strcasecmp(u, "dBm"))
	153	info->is_decibel_mw = TRUE;
	154	else if (!g_ascii_strcasecmp(u, "W"))
	155	info->is_watt = TRUE;
34577da6	156	else if (!g_ascii_strcasecmp(u, ""))
9871215c	157	info->is_unitless = TRUE;
ac913e5c	158
e83437ae	159	/* Bytes 0-1: Measurement mode, except AC/DC */
d9251a2c	160	info->is_resistance = !strncmp(buf, "OH", 2) \|\|
e83437ae	161	(!strncmp(buf, " ", 2) && info->is_ohm);
d9251a2c	162	info->is_capacity = !strncmp(buf, "CA", 2) \|\|
e83437ae	163	(!strncmp(buf, " ", 2) && info->is_farad);
7fb4ff02 FS	164	info->is_temperature = !strncmp(buf, "TE", 2) \|\|
7fb4ff02 FS	165	info->is_celsius \|\| info->is_fahrenheit;
d9251a2c	166	info->is_diode = !strncmp(buf, "DI", 2) \|\|
e83437ae	167	(!strncmp(buf, " ", 2) && info->is_volt && info->is_milli);
d9251a2c	168	info->is_frequency = !strncmp(buf, "FR", 2) \|\|
e83437ae	169	(!strncmp(buf, " ", 2) && info->is_hertz);
7fb4ff02 FS	170	info->is_gain = !strncmp(buf, "DB", 2) && info->is_decibel;
	171	info->is_power = (!strncmp(buf, "dB", 2) && info->is_decibel_mw) \|\|
	172	((!strncmp(buf, "WT", 2) && info->is_watt));
fd8dc1db	173	info->is_power_factor = !strncmp(buf, "CO", 2) && info->is_unitless;
d9251a2c	174	info->is_hfe = !strncmp(buf, "HF", 2) \|\|
cd97e39d FS	175	(!strncmp(buf, " ", 2) && !info->is_ampere &&!info->is_volt &&
	176	!info->is_resistance && !info->is_capacity && !info->is_frequency &&
	177	!info->is_temperature && !info->is_power && !info->is_power_factor &&
	178	!info->is_gain && !info->is_logic && !info->is_diode);
7fb4ff02 FS	179	info->is_min = !strncmp(buf, "MN", 2);
	180	info->is_max = !strncmp(buf, "MX", 2);
	181	info->is_avg = !strncmp(buf, "AG", 2);
	182
e83437ae MH	183	/*
	184	* Note:
	185	* - Protocol doesn't distinguish "resistance" from "beep" mode.
	186	* - "DB" shows the logarithmic ratio of input voltage to a
	187	* pre-stored (user-changeable) value in the DMM.
	188	*/
	189
ac913e5c UH	190	/* Byte 13: Always '\r' (carriage return, 0x0d, 13) */
	191	}
	192
b02bb45f	193	static void handle_flags(struct sr_datafeed_analog analog, float floatval,
e677490e	194	int exponent, const struct metex14_info info)
ac913e5c	195	{
7fb4ff02 FS	196	int factor;
	197
	198	(void)exponent;
	199
ac913e5c	200	/* Factors */
7fb4ff02	201	factor = 0;
c02dc3e2	202	if (info->is_pico)
e677490e	203	factor -= 12;
ac913e5c	204	if (info->is_nano)
e677490e	205	factor -= 9;
ac913e5c	206	if (info->is_micro)
e677490e	207	factor -= 6;
ac913e5c	208	if (info->is_milli)
e677490e	209	factor -= 3;
ac913e5c	210	if (info->is_kilo)
e677490e	211	factor += 3;
ac913e5c	212	if (info->is_mega)
e677490e AJ	213	factor += 6;
e677490e AJ	214	floatval = powf(10, factor);
ac913e5c UH	215
	216	/* Measurement modes */
	217	if (info->is_volt) {
b02bb45f UH	218	analog->meaning->mq = SR_MQ_VOLTAGE;
b02bb45f UH	219	analog->meaning->unit = SR_UNIT_VOLT;
ac913e5c UH	220	}
ac913e5c UH	221	if (info->is_ampere) {
b02bb45f UH	222	analog->meaning->mq = SR_MQ_CURRENT;
b02bb45f UH	223	analog->meaning->unit = SR_UNIT_AMPERE;
ac913e5c UH	224	}
ac913e5c UH	225	if (info->is_ohm) {
b02bb45f UH	226	analog->meaning->mq = SR_MQ_RESISTANCE;
b02bb45f UH	227	analog->meaning->unit = SR_UNIT_OHM;
ac913e5c UH	228	}
ac913e5c UH	229	if (info->is_hertz) {
b02bb45f UH	230	analog->meaning->mq = SR_MQ_FREQUENCY;
b02bb45f UH	231	analog->meaning->unit = SR_UNIT_HERTZ;
ac913e5c UH	232	}
ac913e5c UH	233	if (info->is_farad) {
b02bb45f UH	234	analog->meaning->mq = SR_MQ_CAPACITANCE;
b02bb45f UH	235	analog->meaning->unit = SR_UNIT_FARAD;
ac913e5c	236	}
7fb4ff02	237	if (info->is_temperature) {
b02bb45f	238	analog->meaning->mq = SR_MQ_TEMPERATURE;
7fb4ff02 FS	239	if (info->is_celsius)
	240	analog->meaning->unit = SR_UNIT_CELSIUS;
	241	else if (info->is_fahrenheit)
	242	analog->meaning->unit = SR_UNIT_FAHRENHEIT;
	243	else
	244	analog->meaning->unit = SR_UNIT_UNITLESS;
ac913e5c UH	245	}
ac913e5c UH	246	if (info->is_diode) {
b02bb45f UH	247	analog->meaning->mq = SR_MQ_VOLTAGE;
b02bb45f UH	248	analog->meaning->unit = SR_UNIT_VOLT;
ac913e5c	249	}
7fb4ff02 FS	250	if (info->is_power) {
	251	analog->meaning->mq = SR_MQ_POWER;
	252	if (info->is_decibel_mw)
	253	analog->meaning->unit = SR_UNIT_DECIBEL_MW;
	254	else if (info->is_watt)
	255	analog->meaning->unit = SR_UNIT_WATT;
	256	else
	257	analog->meaning->unit = SR_UNIT_UNITLESS;
	258	}
fd8dc1db FS	259	if (info->is_power_factor) {
	260	analog->meaning->mq = SR_MQ_POWER_FACTOR;
	261	analog->meaning->unit = SR_UNIT_UNITLESS;
	262	}
9871215c	263	if (info->is_gain) {
b02bb45f UH	264	analog->meaning->mq = SR_MQ_GAIN;
b02bb45f UH	265	analog->meaning->unit = SR_UNIT_DECIBEL_VOLT;
9871215c UH	266	}
9871215c UH	267	if (info->is_hfe) {
b02bb45f UH	268	analog->meaning->mq = SR_MQ_GAIN;
b02bb45f UH	269	analog->meaning->unit = SR_UNIT_UNITLESS;
9871215c	270	}
e83437ae	271	if (info->is_logic) {
b02bb45f UH	272	analog->meaning->mq = SR_MQ_GAIN;
b02bb45f UH	273	analog->meaning->unit = SR_UNIT_UNITLESS;
e83437ae	274	}
ac913e5c UH	275
	276	/* Measurement related flags */
	277	if (info->is_ac)
b02bb45f	278	analog->meaning->mqflags \|= SR_MQFLAG_AC;
ac913e5c	279	if (info->is_dc)
b02bb45f	280	analog->meaning->mqflags \|= SR_MQFLAG_DC;
a6ed50f4	281	if (info->is_diode)
64aa214a	282	analog->meaning->mqflags \|= SR_MQFLAG_DIODE \| SR_MQFLAG_DC;
7fb4ff02 FS	283	if (info->is_min)
	284	analog->meaning->mqflags \|= SR_MQFLAG_MIN;
	285	if (info->is_max)
	286	analog->meaning->mqflags \|= SR_MQFLAG_MAX;
	287	if (info->is_avg)
	288	analog->meaning->mqflags \|= SR_MQFLAG_AVG;
ac913e5c UH	289	}
	290
	291	static gboolean flags_valid(const struct metex14_info *info)
	292	{
	293	int count;
	294
	295	/* Does the packet have more than one multiplier? */
	296	count = 0;
c02dc3e2	297	count += (info->is_pico) ? 1 : 0;
ac913e5c UH	298	count += (info->is_nano) ? 1 : 0;
	299	count += (info->is_micro) ? 1 : 0;
	300	count += (info->is_milli) ? 1 : 0;
	301	count += (info->is_kilo) ? 1 : 0;
	302	count += (info->is_mega) ? 1 : 0;
	303	if (count > 1) {
ec5186f9	304	sr_dbg("More than one multiplier detected in packet.");
ac913e5c UH	305	return FALSE;
	306	}
	307
	308	/* Does the packet "measure" more than one type of value? */
	309	count = 0;
	310	count += (info->is_ac) ? 1 : 0;
	311	count += (info->is_dc) ? 1 : 0;
	312	count += (info->is_resistance) ? 1 : 0;
	313	count += (info->is_capacity) ? 1 : 0;
	314	count += (info->is_temperature) ? 1 : 0;
	315	count += (info->is_diode) ? 1 : 0;
	316	count += (info->is_frequency) ? 1 : 0;
	317	if (count > 1) {
ec5186f9	318	sr_dbg("More than one measurement type detected in packet.");
ac913e5c UH	319	return FALSE;
	320	}
	321
	322	/* Both AC and DC set? */
	323	if (info->is_ac && info->is_dc) {
ec5186f9	324	sr_dbg("Both AC and DC flags detected in packet.");
ac913e5c UH	325	return FALSE;
	326	}
	327
	328	return TRUE;
	329	}
	330
1df81f4b	331	#ifdef HAVE_SERIAL_COMM
e90cf076 UH	332	SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial)
	333	{
	334	const uint8_t wbuf = 'D';
	335
	336	sr_spew("Requesting DMM packet.");
	337
379e95c5	338	return serial_write_blocking(serial, &wbuf, 1, 0);
e90cf076	339	}
c4f2dfd0	340	#endif
e90cf076	341
ac913e5c UH	342	SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf)
	343	{
	344	struct metex14_info info;
	345
	346	memset(&info, 0x00, sizeof(struct metex14_info));
	347	parse_flags((const char *)buf, &info);
	348
	349	if (!flags_valid(&info))
	350	return FALSE;
	351
	352	if (buf[13] != '\r')
	353	return FALSE;
	354
	355	return TRUE;
	356	}
	357
556a926d GS	358	SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf)
	359	{
	360	struct metex14_info info;
	361	size_t ch_idx;
	362	const uint8_t *ch_buf;
	363
	364	ch_buf = buf;
	365	for (ch_idx = 0; ch_idx < 4; ch_idx++) {
	366	if (ch_buf[13] != '\r')
	367	return FALSE;
	368	memset(&info, 0x00, sizeof(info));
	369	parse_flags((const char *)ch_buf, &info);
	370	if (!flags_valid(&info))
	371	return FALSE;
	372	ch_buf += METEX14_PACKET_SIZE;
	373	}
	374	return TRUE;
	375	}
	376
ac913e5c UH	377	/**
	378	* Parse a protocol packet.
	379	*
1fbab466	380	* @param buf Buffer containing the protocol packet. Must not be NULL.
ac913e5c	381	* @param floatval Pointer to a float variable. That variable will be modified
1fbab466	382	* in-place depending on the protocol packet. Must not be NULL.
b02bb45f	383	* @param analog Pointer to a struct sr_datafeed_analog. The struct will be
ac913e5c	384	* filled with data according to the protocol packet.
1fbab466 UH	385	* Must not be NULL.
	386	* @param info Pointer to a struct metex14_info. The struct will be filled
	387	* with data according to the protocol packet. Must not be NULL.
ac913e5c UH	388	*
	389	* @return SR_OK upon success, SR_ERR upon failure. Upon errors, the
	390	* 'analog' variable contents are undefined and should not be used.
	391	*/
	392	SR_PRIV int sr_metex14_parse(const uint8_t buf, float floatval,
b02bb45f	393	struct sr_datafeed_analog analog, void info)
ac913e5c	394	{
e677490e	395	int ret, exponent = 0;
1fbab466 UH	396	struct metex14_info *info_local;
1fbab466 UH	397
94b1d506	398	info_local = info;
ac913e5c	399
e82d7dbc AG	400	/* Don't print byte 13. That one contains the carriage return. */
	401	sr_dbg("DMM packet: \"%.13s\"", buf);
	402
e83437ae MH	403	memset(info_local, 0x00, sizeof(struct metex14_info));
e83437ae MH	404
e677490e	405	if ((ret = parse_value(buf, info_local, floatval, &exponent)) != SR_OK) {
ec5186f9	406	sr_dbg("Error parsing value: %d.", ret);
ac913e5c UH	407	return ret;
	408	}
	409
1fbab466	410	parse_flags((const char *)buf, info_local);
e677490e AJ	411	handle_flags(analog, floatval, &exponent, info_local);
e677490e AJ	412
d9251a2c	413	analog->encoding->digits = -exponent;
e677490e	414	analog->spec->spec_digits = -exponent;
ac913e5c UH	415
	416	return SR_OK;
	417	}
556a926d GS	418
	419	/**
	420	* Parse one out of four values of a four-display Metex14 variant.
	421	*
	422	* The caller's 'info' parameter can be used to track the channel index,
	423	* as long as the information is kept across calls to the 14-byte packet
	424	* parse routine (which clears the 'info' container).
	425	*
	426	* Since analog values have further details in the 'analog' parameter,
	427	* passing multiple values per parse routine call is problematic. So we
	428	* prefer the approach of passing one value per call, which is most
	429	* reliable and shall fit every similar device with multiple displays.
	430	*
	431	* The meters which use this parse routine send one 14-byte packet per
	432	* display. Each packet has the regular Metex14 layout.
	433	*/
	434	SR_PRIV int sr_metex14_4packets_parse(const uint8_t buf, float floatval,
	435	struct sr_datafeed_analog analog, void info)
	436	{
	437	struct metex14_info *info_local;
	438	size_t ch_idx;
	439	const uint8_t *ch_buf;
	440	int rc;
	441
	442	info_local = info;
	443	ch_idx = info_local->ch_idx;
	444	ch_buf = buf + ch_idx * METEX14_PACKET_SIZE;
	445	rc = sr_metex14_parse(ch_buf, floatval, analog, info);
	446	info_local->ch_idx = ch_idx + 1;
	447	return rc;
	448	}