Add measured quantities for LCR meters.

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 5c04221611825240a1b7ecc33abaf6f1a40bf6a9..924ec91219963280e9bd55373f0c497c5ba72572 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -201,6 +201,24 @@ enum sr_mq {
        SR_MQ_WIND_SPEED,
        /** Pressure */
        SR_MQ_PRESSURE,
+       /** Parallel inductance (LCR meter model). */
+       SR_MQ_PARALLEL_INDUCTANCE,
+       /** Parallel capacitance (LCR meter model). */
+       SR_MQ_PARALLEL_CAPACITANCE,
+       /** Parallel resistance (LCR meter model). */
+       SR_MQ_PARALLEL_RESISTANCE,
+       /** Serial inductance (LCR meter model). */
+       SR_MQ_SERIAL_INDUCTANCE,
+       /** Serial capacitance (LCR meter model). */
+       SR_MQ_SERIAL_CAPACITANCE,
+       /** Serial resistance (LCR meter model). */
+       SR_MQ_SERIAL_RESISTANCE,
+       /** Dissipation factor. */
+       SR_MQ_DISSIPATION_FACTOR,
+       /** Quality factor. */
+       SR_MQ_QUALITY_FACTOR,
+       /** Phase angle. */
+       SR_MQ_PHASE_ANGLE,
 };
 
 /** Unit of measured quantity, sr_datafeed_analog.unit. */
@@ -264,6 +282,10 @@ enum sr_unit {
        SR_UNIT_HECTOPASCAL,
        /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
        SR_UNIT_HUMIDITY_293K,
+       /** Plane angle in 1/360th of a full circle. */
+       SR_UNIT_DEGREE,
+       /** Henry (inductance). */
+       SR_UNIT_HENRY,
 };
 
 /** Values for sr_datafeed_analog.flags. */
@@ -469,6 +491,8 @@ struct sr_channel {
        gboolean enabled;
        /** Name of channel. */
        char *name;
+       /** Private data for driver use. */
+       void *priv;
 };
 
 /** Structure for groups of channels that have common properties. */
@@ -484,7 +508,7 @@ struct sr_channel_group {
 /** Used for setting or getting value of a config item. */
 struct sr_config {
        /** Config key like SR_CONF_CONN, etc. */
-       int key;
+       uint32_t key;
        /** Key-specific data. */
        GVariant *data;
 };
@@ -492,7 +516,7 @@ struct sr_config {
 /** Information about a config key. */
 struct sr_config_info {
        /** Config key like SR_CONF_CONN, etc. */
-       int key;
+       uint32_t key;
        /** Data type like SR_T_STRING, etc. */
        int datatype;
        /** Id string, e.g. "serialcomm". */
@@ -503,6 +527,11 @@ struct sr_config_info {
        char *description;
 };
 
+#define SR_CONF_GET  (1 << 31)
+#define SR_CONF_SET  (1 << 30)
+#define SR_CONF_LIST (1 << 29)
+#define SR_CONF_MASK 0x1fffffff
+
 /** Constants for device classes */
 enum sr_configkey {
        /*--- Device classes ------------------------------------------------*/
@@ -849,8 +878,6 @@ enum sr_configkey {
 struct sr_dev_inst {
        /** Device driver. */
        struct sr_dev_driver *driver;
-       /** Index of device in driver. */
-       int index;
        /** Device instance status. SR_ST_NOT_FOUND, etc. */
        int status;
        /** Device instance type. SR_INST_USB, etc. */
@@ -861,6 +888,10 @@ struct sr_dev_inst {
        char *model;
        /** Device version. */
        char *version;
+       /** Serial number. */
+       char *serial_num;
+       /** Connection string to uniquely identify devices. */
+       char *connection_id;
        /** List of channels. */
        GSList *channels;
        /** List of sr_channel_group structs */
@@ -928,12 +959,12 @@ struct sr_dev_driver {
        /** Query value of a configuration key in driver or given device instance.
         *  @see sr_config_get().
         */
-       int (*config_get) (int id, GVariant **data,
+       int (*config_get) (uint32_t key, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);
        /** Set value of a configuration key in driver or a given device instance.
         *  @see sr_config_set(). */
-       int (*config_set) (int id, GVariant *data,
+       int (*config_set) (uint32_t key, GVariant *data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);
        /** Channel status change.
@@ -946,7 +977,7 @@ struct sr_dev_driver {
        /** List all possible values for a configuration key in a device instance.
         *  @see sr_config_list().
         */
-       int (*config_list) (int info_id, GVariant **data,
+       int (*config_list) (uint32_t key, GVariant **data,
                        const struct sr_dev_inst *sdi,
                        const struct sr_channel_group *cg);