Change SR_T_MQLIST to SR_T_MQ.

[libsigrok.git] / include / libsigrok / libsigrok.h

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 233e04a6ce969dd881c02f3c6d5092536e9a356e..63e60fba3ef5ea796a1a97b6038b266652c49aa3 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -78,10 +78,7 @@ enum sr_error_code {
        SR_ERR_DATA          =-10, /**< Data is invalid.  */
        SR_ERR_IO            =-11, /**< Input/output error. */
 
-       /*
-        * Note: When adding entries here, don't forget to also update the
-        * sr_strerror() and sr_strerror_name() functions in error.c.
-        */
+       /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
 };
 
 #define SR_MAX_CHANNELNAME_LEN 32
@@ -149,6 +146,9 @@ enum sr_datatype {
        SR_T_UINT64_RANGE,
        SR_T_DOUBLE_RANGE,
        SR_T_INT32,
+       SR_T_MQ,
+
+       /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
 };
 
 /** Value for sr_datafeed_packet.type. */
@@ -171,6 +171,8 @@ enum sr_packettype {
        SR_DF_FRAME_END,
        /** Payload is struct sr_datafeed_analog2. */
        SR_DF_ANALOG2,
+
+       /* Update datafeed_dump() (session.c) upon changes! */
 };
 
 /** Measured quantity, sr_datafeed_analog.mq. */
@@ -230,6 +232,10 @@ enum sr_mq {
        SR_MQ_POWER_FACTOR,
        /** Apparent power */
        SR_MQ_APPARENT_POWER,
+       /** Mass */
+       SR_MQ_MASS,
+
+       /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
 };
 
 /** Unit of measured quantity, sr_datafeed_analog.unit. */
@@ -297,6 +303,33 @@ enum sr_unit {
        SR_UNIT_DEGREE,
        /** Henry (inductance). */
        SR_UNIT_HENRY,
+       /** Mass in gram [g]. */
+       SR_UNIT_GRAM,
+       /** Mass in carat [ct]. */
+       SR_UNIT_CARAT,
+       /** Mass in ounce [oz]. */
+       SR_UNIT_OUNCE,
+       /** Mass in troy ounce [oz t]. */
+       SR_UNIT_TROY_OUNCE,
+       /** Mass in pound [lb]. */
+       SR_UNIT_POUND,
+       /** Mass in pennyweight [dwt]. */
+       SR_UNIT_PENNYWEIGHT,
+       /** Mass in grain [gr]. */
+       SR_UNIT_GRAIN,
+       /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
+       SR_UNIT_TAEL,
+       /** Mass in momme. */
+       SR_UNIT_MOMME,
+       /** Mass in tola. */
+       SR_UNIT_TOLA,
+       /** Pieces (number of items). */
+       SR_UNIT_PIECE,
+
+       /*
+        * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
+        * upon changes!
+        */
 };
 
 /** Values for sr_datafeed_analog.flags. */
@@ -349,6 +382,13 @@ enum sr_mqflag {
        SR_MQFLAG_AVG = 0x40000,
        /** Reference value shown. */
        SR_MQFLAG_REFERENCE = 0x80000,
+       /** Unstable value (hasn't settled yet). */
+       SR_MQFLAG_UNSTABLE = 0x100000,
+
+       /*
+        * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
+        * upon changes!
+        */
 };
 
 enum sr_trigger_matches {
@@ -518,6 +558,12 @@ struct sr_option {
        GSList *values;
 };
 
+/** Output module flags. */
+enum sr_output_flag {
+       /** If set, this output module writes the output itself. */
+       SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
+};
+
 struct sr_input;
 struct sr_input_module;
 struct sr_output;
@@ -568,15 +614,21 @@ struct sr_config {
        GVariant *data;
 };
 
-/** Information about a config key. */
-struct sr_config_info {
-       /** Config key like SR_CONF_CONN, etc. */
+enum sr_keytype {
+       SR_KEY_CONFIG,
+       SR_KEY_MQ,
+       SR_KEY_MQFLAGS,
+};
+
+/** Information about a key. */
+struct sr_key_info {
+       /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
        uint32_t key;
-       /** Data type like SR_T_STRING, etc. */
+       /** Data type like SR_T_STRING, etc if applicable. */
        int datatype;
-       /** Id string, e.g. "serialcomm". */
+       /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
        char *id;
-       /** Name, e.g. "Serial communication". */
+       /** Full capitalized name, e.g. "Serial communication". */
        char *name;
        /** Verbose description (unused currently). */
        char *description;
@@ -627,6 +679,11 @@ enum sr_configkey {
        /** The device can act as an electronic load. */
        SR_CONF_ELECTRONIC_LOAD,
 
+       /** The device can act as a scale. */
+       SR_CONF_SCALE,
+
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
        /*--- Driver scan options -------------------------------------------*/
 
        /**
@@ -670,6 +727,8 @@ enum sr_configkey {
         */
        SR_CONF_MODBUSADDR,
 
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
        /*--- Device (or channel group) configuration -----------------------*/
 
        /** The device supports setting its samplerate, in Hz. */
@@ -882,6 +941,9 @@ enum sr_configkey {
        /** Output frequency in Hz. */
        SR_CONF_OUTPUT_FREQUENCY,
 
+       /** Output frequency target in Hz. */
+       SR_CONF_OUTPUT_FREQUENCY_TARGET,
+
        /** Measured quantity. */
        SR_CONF_MEASURED_QUANTITY,
 
@@ -891,12 +953,11 @@ enum sr_configkey {
        /** Equivalent circuit model. */
        SR_CONF_EQUIV_CIRCUIT_MODEL,
 
-       /* Output frequency target in Hz. */
-       SR_CONF_OUTPUT_FREQUENCY_TARGET,
-
        /** Over-temperature protection (OTP) active. */
        SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
 
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -934,6 +995,8 @@ enum sr_configkey {
        /** The device supports setting a probe factor. */
        SR_CONF_PROBE_FACTOR,
 
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
+
        /*--- Acquisition modes, sample limiting ----------------------------*/
 
        /**
@@ -970,6 +1033,8 @@ enum sr_configkey {
 
        /** Self test mode. */
        SR_CONF_TEST_MODE,
+
+       /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 };
 
 /**
@@ -1023,13 +1088,13 @@ struct sr_dev_driver {
        int (*cleanup) (const struct sr_dev_driver *driver);
        /** Scan for devices. Driver should do all initialisation required.
         *  Can be called several times, e.g. with different port options.
-        *  \retval NULL Error or no devices found.
-        *  \retval other GSList of a struct sr_dev_inst for each device.
+        *  @retval NULL Error or no devices found.
+        *  @retval other GSList of a struct sr_dev_inst for each device.
         *                Must be freed by caller!
         */
        GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
        /** Get list of device instances the driver knows about.
-        *  \returns NULL or GSList of a struct sr_dev_inst for each device.
+        *  @returns NULL or GSList of a struct sr_dev_inst for each device.
         *           Must not be freed by caller!
         */
        GSList *(*dev_list) (const struct sr_dev_driver *driver);
@@ -1093,8 +1158,8 @@ struct sr_serial_port {
        char *description;
 };
 
-#include "proto.h"
-#include "version.h"
+#include <libsigrok/proto.h>
+#include <libsigrok/version.h>
 
 #ifdef __cplusplus
 }