hameg-hmo: free memory that was allocated by SCPI get routines

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

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 2779490d9db0134d322e29f3eabfe5d63daf889c..81a831b3b1814d2bc1b46504ce009b6395fc3dd6 100644 (file)
--- a/include/libsigrok/libsigrok.h
+++ b/include/libsigrok/libsigrok.h
@@ -80,6 +80,13 @@ enum sr_error_code {
        /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
 };
 
+/** Ternary return type for DMM/LCR/etc packet parser validity checks. */
+enum sr_valid_code {
+       SR_PACKET_INVALID = -1, /**< Certainly invalid. */
+       SR_PACKET_VALID = 0,    /**< Certainly valid. */
+       SR_PACKET_NEED_RX = +1, /**< Need more RX data. */
+};
+
 #define SR_MAX_CHANNELNAME_LEN 32
 
 /* Handy little macros */
@@ -235,6 +242,8 @@ enum sr_mq {
        SR_MQ_HARMONIC_RATIO,
        /** Energy. */
        SR_MQ_ENERGY,
+       /** Electric charge. */
+       SR_MQ_ELECTRIC_CHARGE,
 
        /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
 };
@@ -292,7 +301,7 @@ enum sr_unit {
        SR_UNIT_VOLT_AMPERE,
        /** Real power [W]. */
        SR_UNIT_WATT,
-       /** Consumption [Wh]. */
+       /** Energy (consumption) in watt hour [Wh]. */
        SR_UNIT_WATT_HOUR,
        /** Wind speed in meters per second. */
        SR_UNIT_METER_SECOND,
@@ -326,6 +335,12 @@ enum sr_unit {
        SR_UNIT_TOLA,
        /** Pieces (number of items). */
        SR_UNIT_PIECE,
+       /** Energy in joule. */
+       SR_UNIT_JOULE,
+       /** Electric charge in coulomb. */
+       SR_UNIT_COULOMB,
+       /** Electric charge in ampere hour [Ah]. */
+       SR_UNIT_AMPERE_HOUR,
 
        /*
         * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
@@ -708,6 +723,12 @@ enum sr_configkey {
        /** The device can measure power. */
        SR_CONF_POWERMETER,
 
+       /**
+        * The device can switch between multiple sources, e.g. a relay actuator
+        * or multiplexer.
+        */
+       SR_CONF_MULTIPLEXER,
+
        /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
        /*--- Driver scan options -------------------------------------------*/
@@ -753,6 +774,16 @@ enum sr_configkey {
         */
        SR_CONF_MODBUSADDR,
 
+       /**
+        * User specified forced driver attachment to unknown devices.
+        *
+        * By design the interpretation of the string depends on the
+        * specific driver. It typically would be either a replacement
+        * '*IDN?' response value, or a sub-driver name. But could also
+        * be anything else and totally arbitrary.
+        */
+       SR_CONF_FORCE_DETECT,
+
        /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
        /*--- Device (or channel group) configuration -----------------------*/
@@ -1023,6 +1054,35 @@ enum sr_configkey {
        /** The number of digits (e.g. for a DMM). */
        SR_CONF_DIGITS,
 
+       /** Phase of a source signal. */
+       SR_CONF_PHASE,
+
+       /** Duty cycle of a source signal. */
+       SR_CONF_DUTY_CYCLE,
+
+       /**
+        * Current power.
+        * @arg type: double
+        * @arg get: get measured power
+        */
+       SR_CONF_POWER,
+
+       /**
+        * Power target.
+        * @arg type: double
+        * @arg get: get power target
+        * @arg set: change power target
+        */
+       SR_CONF_POWER_TARGET,
+
+       /**
+        * Resistance target.
+        * @arg type: double
+        * @arg get: get resistance target
+        * @arg set: change resistance target
+        */
+       SR_CONF_RESISTANCE_TARGET,
+
        /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
        /*--- Special stuff -------------------------------------------------*/