Add config key for output frequency.

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 3ecc460a28fa9bb387443ec4e5f180615ebc22cd..56b4f16f1342c8e4e1629266d441bebe691ef855 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -201,6 +201,26 @@ 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,
+       /** Difference from reference value. */
+       SR_MQ_DIFFERENCE,
 };
 
 /** Unit of measured quantity, sr_datafeed_analog.unit. */
@@ -264,6 +284,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. */
@@ -314,6 +338,12 @@ enum sr_mqflag {
        SR_MQFLAG_DURATION = 0x20000,
        /** Device is in "avg" mode, averaging upon each new value. */
        SR_MQFLAG_AVG = 0x40000,
+       /** Reference value shown. */
+       SR_MQFLAG_REFERENCE = 0x80000,
+       /** Device selects the measured quantity automatically. */
+       SR_MQFLAG_AUTOMQ = 0x100000,
+       /** Device selects the measurement model automatically. */
+       SR_MQFLAG_AUTOMODEL = 0x200000,
 };
 
 enum sr_trigger_matches {
@@ -486,7 +516,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;
 };
@@ -494,7 +524,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". */
@@ -505,6 +535,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 ------------------------------------------------*/
@@ -539,6 +574,9 @@ enum sr_configkey {
        /** Programmable power supply. */
        SR_CONF_POWER_SUPPLY,
 
+       /** LCR meter. */
+       SR_CONF_LCR_METER,
+
        /*--- Driver scan options -------------------------------------------*/
 
        /**
@@ -774,6 +812,9 @@ enum sr_configkey {
        /** Over-temperature protection (OTP) */
        SR_CONF_OVER_TEMPERATURE_PROTECTION,
 
+       /** Output frequency in Hz. */
+       SR_CONF_OUTPUT_FREQUENCY,
+
        /*--- Special stuff -------------------------------------------------*/
 
        /** Scan options supported by the driver. */
@@ -851,8 +892,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. */
@@ -863,6 +902,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 */
@@ -930,12 +973,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.
@@ -948,7 +991,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);