]> sigrok.org Git - libsigrok.git/blobdiff - src/dmm/metex14.c
dmm/metex14: unbreak packet request helper return code
[libsigrok.git] / src / dmm / metex14.c
index 90278ffd21646e8eee5e4d833a58f10f2975a060..d93052a85b84bc7cbfbe50b5b3c266df50dbf665 100644 (file)
@@ -14,8 +14,7 @@
  * 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, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
  *
  * Metex 14-bytes ASCII protocol parser.
  *
- * @internal
  * 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>
@@ -42,9 +41,9 @@
 
 /** Parse value from buf, byte 2-8. */
 static int parse_value(const uint8_t *buf, struct metex14_info *info,
-                       float *result)
+                       float *result, int *exponent)
 {
-       int i, is_ol, cnt;
+       int i, is_ol, cnt, dot_pos;
        char valstr[7 + 1];
 
        /* Strip all spaces from bytes 2-8. */
@@ -56,14 +55,14 @@ static int parse_value(const uint8_t *buf, struct metex14_info *info,
 
        /* Bytes 5-7: Over limit (various forms) */
        is_ol = 0;
-       is_ol += (!strcasecmp((const char *)&valstr, ".OL")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "O.L")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "OL.")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "OL")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "-.OL")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "-O.L")) ? 1 : 0;
-       is_ol += (!strcasecmp((const char *)&valstr, "-OL.")) ? 1 : 0;
-       is_ol += (!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;
+       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;
@@ -86,7 +85,13 @@ static int parse_value(const uint8_t *buf, struct metex14_info *info,
                return SR_OK;
 
        /* Bytes 2-8: Sign, value (up to 5 digits) and decimal point */
-       sscanf((const char *)&valstr, "%f", result);
+       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);
 
@@ -114,51 +119,67 @@ static void parse_flags(const char *buf, struct metex14_info *info)
 
        /* Bytes 9-12: Unit */
        u = (const char *)&unit;
-       if (!strcasecmp(u, "A"))
+       if (!g_ascii_strcasecmp(u, "A"))
                info->is_ampere = TRUE;
-       else if (!strcasecmp(u, "mA"))
+       else if (!g_ascii_strcasecmp(u, "mA"))
                info->is_milli = info->is_ampere = TRUE;
-       else if (!strcasecmp(u, "uA"))
+       else if (!g_ascii_strcasecmp(u, "uA"))
                info->is_micro = info->is_ampere = TRUE;
-       else if (!strcasecmp(u, "V"))
+       else if (!g_ascii_strcasecmp(u, "V"))
                info->is_volt = TRUE;
-       else if (!strcasecmp(u, "mV"))
+       else if (!g_ascii_strcasecmp(u, "mV"))
                info->is_milli = info->is_volt = TRUE;
-       else if (!strcasecmp(u, "Ohm"))
+       else if (!g_ascii_strcasecmp(u, "Ohm"))
                info->is_ohm = TRUE;
-       else if (!strcasecmp(u, "KOhm"))
+       else if (!g_ascii_strcasecmp(u, "KOhm"))
                info->is_kilo = info->is_ohm = TRUE;
-       else if (!strcasecmp(u, "MOhm"))
+       else if (!g_ascii_strcasecmp(u, "MOhm"))
                info->is_mega = info->is_ohm = TRUE;
-       else if (!strcasecmp(u, "pF"))
+       else if (!g_ascii_strcasecmp(u, "pF"))
                info->is_pico = info->is_farad = TRUE;
-       else if (!strcasecmp(u, "nF"))
+       else if (!g_ascii_strcasecmp(u, "nF"))
                info->is_nano = info->is_farad = TRUE;
-       else if (!strcasecmp(u, "uF"))
+       else if (!g_ascii_strcasecmp(u, "uF"))
                info->is_micro = info->is_farad = TRUE;
-       else if (!strcasecmp(u, "KHz"))
+       else if (!g_ascii_strcasecmp(u, "KHz"))
                info->is_kilo = info->is_hertz = TRUE;
-       else if (!strcasecmp(u, "C"))
+       else if (!g_ascii_strcasecmp(u, "C"))
                info->is_celsius = TRUE;
-       else if (!strcasecmp(u, "DB"))
+       else if (!g_ascii_strcasecmp(u, "F"))
+               info->is_fahrenheit = TRUE;
+       else if (!g_ascii_strcasecmp(u, "DB"))
                info->is_decibel = TRUE;
-       else if (!strcasecmp(u, ""))
+       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) ||
+       info->is_resistance = !strncmp(buf, "OH", 2) ||
                (!strncmp(buf, "  ", 2) && info->is_ohm);
-       info->is_capacity    = !strncmp(buf, "CA", 2) ||
+       info->is_capacity = !strncmp(buf, "CA", 2) ||
                (!strncmp(buf, "  ", 2) && info->is_farad);
-       info->is_temperature = !strncmp(buf, "TE", 2);
-       info->is_diode       = !strncmp(buf, "DI", 2) ||
+       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) ||
+       info->is_frequency = !strncmp(buf, "FR", 2) ||
                (!strncmp(buf, "  ", 2) && info->is_hertz);
-       info->is_gain        = !strncmp(buf, "DB", 2);
-       info->is_hfe         = !strncmp(buf, "HF", 2) ||
-               (!strncmp(buf, "  ", 2) && !info->is_volt && !info->is_ohm &&
-                !info->is_logic && !info->is_farad && !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.
@@ -170,71 +191,101 @@ static void parse_flags(const char *buf, struct metex14_info *info)
 }
 
 static void handle_flags(struct sr_datafeed_analog *analog, float *floatval,
-                        const struct metex14_info *info)
+                        int *exponent, const struct metex14_info *info)
 {
+       int factor;
+
+       (void)exponent;
+
        /* Factors */
+       factor = 0;
        if (info->is_pico)
-               *floatval /= 1000000000000ULL;
+               factor -= 12;
        if (info->is_nano)
-               *floatval /= 1000000000;
+               factor -= 9;
        if (info->is_micro)
-               *floatval /= 1000000;
+               factor -= 6;
        if (info->is_milli)
-               *floatval /= 1000;
+               factor -= 3;
        if (info->is_kilo)
-               *floatval *= 1000;
+               factor += 3;
        if (info->is_mega)
-               *floatval *= 1000000;
+               factor += 6;
+       *floatval *= powf(10, factor);
 
        /* Measurement modes */
        if (info->is_volt) {
-               analog->mq = SR_MQ_VOLTAGE;
-               analog->unit = SR_UNIT_VOLT;
+               analog->meaning->mq = SR_MQ_VOLTAGE;
+               analog->meaning->unit = SR_UNIT_VOLT;
        }
        if (info->is_ampere) {
-               analog->mq = SR_MQ_CURRENT;
-               analog->unit = SR_UNIT_AMPERE;
+               analog->meaning->mq = SR_MQ_CURRENT;
+               analog->meaning->unit = SR_UNIT_AMPERE;
        }
        if (info->is_ohm) {
-               analog->mq = SR_MQ_RESISTANCE;
-               analog->unit = SR_UNIT_OHM;
+               analog->meaning->mq = SR_MQ_RESISTANCE;
+               analog->meaning->unit = SR_UNIT_OHM;
        }
        if (info->is_hertz) {
-               analog->mq = SR_MQ_FREQUENCY;
-               analog->unit = SR_UNIT_HERTZ;
+               analog->meaning->mq = SR_MQ_FREQUENCY;
+               analog->meaning->unit = SR_UNIT_HERTZ;
        }
        if (info->is_farad) {
-               analog->mq = SR_MQ_CAPACITANCE;
-               analog->unit = SR_UNIT_FARAD;
+               analog->meaning->mq = SR_MQ_CAPACITANCE;
+               analog->meaning->unit = SR_UNIT_FARAD;
        }
-       if (info->is_celsius) {
-               analog->mq = SR_MQ_TEMPERATURE;
-               analog->unit = SR_UNIT_CELSIUS;
+       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->mq = SR_MQ_VOLTAGE;
-               analog->unit = SR_UNIT_VOLT;
+               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->mq = SR_MQ_GAIN;
-               analog->unit = SR_UNIT_DECIBEL_VOLT;
+               analog->meaning->mq = SR_MQ_GAIN;
+               analog->meaning->unit = SR_UNIT_DECIBEL_VOLT;
        }
        if (info->is_hfe) {
-               analog->mq = SR_MQ_GAIN;
-               analog->unit = SR_UNIT_UNITLESS;
+               analog->meaning->mq = SR_MQ_GAIN;
+               analog->meaning->unit = SR_UNIT_UNITLESS;
        }
        if (info->is_logic) {
-               analog->mq = SR_MQ_GAIN;
-               analog->unit = SR_UNIT_UNITLESS;
+               analog->meaning->mq = SR_MQ_GAIN;
+               analog->meaning->unit = SR_UNIT_UNITLESS;
        }
 
        /* Measurement related flags */
        if (info->is_ac)
-               analog->mqflags |= SR_MQFLAG_AC;
+               analog->meaning->mqflags |= SR_MQFLAG_AC;
        if (info->is_dc)
-               analog->mqflags |= SR_MQFLAG_DC;
+               analog->meaning->mqflags |= SR_MQFLAG_DC;
        if (info->is_diode)
-               analog->mqflags |= SR_MQFLAG_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)
@@ -277,14 +328,23 @@ static gboolean flags_valid(const struct metex14_info *info)
        return TRUE;
 }
 
-#ifdef HAVE_LIBSERIALPORT
+#ifdef HAVE_SERIAL_COMM
 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial)
 {
        const uint8_t wbuf = 'D';
+       size_t wrlen;
+       int ret;
 
        sr_spew("Requesting DMM packet.");
 
-       return (serial_write_nonblocking(serial, &wbuf, 1) == 1) ? SR_OK : SR_ERR;
+       wrlen = sizeof(wbuf);
+       ret = serial_write_blocking(serial, &wbuf, wrlen, 0);
+       if (ret < 0)
+               return ret;
+       if ((size_t)ret != wrlen)
+               return SR_ERR_IO;
+
+       return SR_OK;
 }
 #endif
 
@@ -304,6 +364,25 @@ SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf)
        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.
  *
@@ -322,23 +401,57 @@ SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf)
 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
                             struct sr_datafeed_analog *analog, void *info)
 {
-       int ret;
+       int ret, exponent = 0;
        struct metex14_info *info_local;
 
-       info_local = (struct metex14_info *)info;
+       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)) != SR_OK) {
+       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, 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;
+}