X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=include%2Flibsigrok%2Flibsigrok.h;h=6c5dea08ab0d3ca3eeaa7fe45f1761876f1da353;hp=070107eeef294b6d5463bb9c94ae9572ca2f31c4;hb=HEAD;hpb=d643e6bc3942d7b7149a53b3091034d64eac0ad3

diff --git a/include/libsigrok/libsigrok.h b/include/libsigrok/libsigrok.h
index 070107ee..6c5dea08 100644
--- 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 */
@@ -146,6 +153,7 @@ enum sr_datatype {
 	SR_T_DOUBLE_RANGE,
 	SR_T_INT32,
 	SR_T_MQ,
+	SR_T_UINT32,
 
 	/* Update sr_variant_type_get() (hwdriver.c) upon changes! */
 };
@@ -235,6 +243,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 +302,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 +336,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)
@@ -513,9 +529,22 @@ struct sr_analog_encoding {
 	gboolean is_float;
 	gboolean is_bigendian;
 	/**
-	 * Number of significant digits after the decimal point if positive,
-	 * or number of non-significant digits before the decimal point if
-	 * negative (refers to the value we actually read on the wire).
+	 * Number of significant digits after the decimal point, if positive.
+	 * When negative, exponent with reversed polarity that is necessary to
+	 * express the value with all digits without a decimal point.
+	 * Refers to the value we actually read on the wire.
+	 *
+	 * Examples:
+	 *
+	 * | Disp. value | Exp. notation       | Exp. not. normalized | digits |
+	 * |-------------|---------------------|----------------------|--------|
+	 * |  12.34 MOhm |  1.234 * 10^7   Ohm |    1234 * 10^4   Ohm |     -4 |
+	 * | 1.2345 MOhm | 1.2345 * 10^6   Ohm |   12345 * 10^2   Ohm |     -2 |
+	 * |  123.4 kOhm |  1.234 * 10^5   Ohm |    1234 * 10^2   Ohm |     -2 |
+	 * |   1234  Ohm |  1.234 * 10^3   Ohm |    1234 * 10^0   Ohm |      0 |
+	 * |  12.34  Ohm |  1.234 * 10^1   Ohm |    1234 * 10^-2  Ohm |      2 |
+	 * | 0.0123  Ohm |   1.23 * 10^-2  Ohm |     123 * 10^-4  Ohm |      4 |
+	 * |  1.234 pF   |  1.234 * 10^-12 F   |    1234 * 10^-15 F   |     15 |
 	 */
 	int8_t digits;
 	gboolean is_digits_decimal;
@@ -532,10 +561,22 @@ struct sr_analog_meaning {
 
 struct sr_analog_spec {
 	/**
-	 * Number of significant digits after the decimal point if positive,
-	 * or number of non-significant digits before the decimal point if
-	 * negative (refers to vendor specifications/datasheet or actual
-	 * device display).
+	 * Number of significant digits after the decimal point, if positive.
+	 * When negative, exponent with reversed polarity that is necessary to
+	 * express the value with all digits without a decimal point.
+	 * Refers to vendor specifications/datasheet or actual device display.
+	 *
+	 * Examples:
+	 *
+	 * | On the wire | Exp. notation       | Exp. not. normalized | spec_digits |
+	 * |-------------|---------------------|----------------------|-------------|
+	 * |  12.34 MOhm |  1.234 * 10^7   Ohm |    1234 * 10^4   Ohm |          -4 |
+	 * | 1.2345 MOhm | 1.2345 * 10^6   Ohm |   12345 * 10^2   Ohm |          -2 |
+	 * |  123.4 kOhm |  1.234 * 10^5   Ohm |    1234 * 10^2   Ohm |          -2 |
+	 * |   1234  Ohm |  1.234 * 10^3   Ohm |    1234 * 10^0   Ohm |           0 |
+	 * |  12.34  Ohm |  1.234 * 10^1   Ohm |    1234 * 10^-2  Ohm |           2 |
+	 * | 0.0123  Ohm |   1.23 * 10^-2  Ohm |     123 * 10^-4  Ohm |           4 |
+	 * |  1.234 pF   |  1.234 * 10^-12 F   |    1234 * 10^-15 F   |          15 |
 	 */
 	int8_t spec_digits;
 };
@@ -708,6 +749,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 -------------------------------------------*/
@@ -763,6 +810,26 @@ enum sr_configkey {
 	 */
 	SR_CONF_FORCE_DETECT,
 
+	/**
+	 * Override builtin probe names from user specs.
+	 *
+	 * Users may want to override the names which are assigned to
+	 * probes during scan (these usually match the vendor's labels
+	 * on the device). This avoids the interactive tedium of
+	 * changing channel names after device creation and before
+	 * protocol decoder attachment. Think of IEEE488 recorders or
+	 * parallel computer bus loggers. The scan option eliminates
+	 * the issue of looking up previously assigned names before
+	 * renaming a channel (see sigrok-cli -C), which depends on
+	 * the device as well as the application, and is undesirable.
+	 * The scan option is limited to those drivers which implement
+	 * support for it, but works identically across those drivers.
+	 *
+	 * The value is a string, either a comma separated list of
+	 * probe names, or an alias for a typical set of names.
+	 */
+	SR_CONF_PROBE_NAMES,
+
 	/* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
 	/*--- Device (or channel group) configuration -----------------------*/
@@ -1033,6 +1100,43 @@ 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,
+
+	/**
+	 * Over-current protection (OCP) delay
+	 * @arg type: double (time)
+	 * @arg get: get current delay
+	 * @arg set: set new delay
+	 */
+	SR_CONF_OVER_CURRENT_PROTECTION_DELAY,
+
 	/* Update sr_key_info_config[] (hwdriver.c) upon changes! */
 
 	/*--- Special stuff -------------------------------------------------*/