X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=17d7fc17d7a5249dff9d11c585ec95891bb596d9;hb=21d464a7e53efc9ac9810d9301a12b6a56fdb061;hp=24934baab44f09cde065b83edbd07037269ece17;hpb=b9470914d045f05e445e9f25a3b4f0cc79bc6681;p=libsigrok.git
diff --git a/libsigrok.h b/libsigrok.h
index 24934baa..17d7fc17 100644
--- a/libsigrok.h
+++ b/libsigrok.h
@@ -72,9 +72,14 @@ enum {
SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
SR_ERR_NA = -6, /**< Not applicable. */
SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */
+ SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
+
+ /*
+ * Note: When adding entries here, don't forget to also update the
+ * sr_strerror() and sr_strerror_name() functions in error.c.
+ */
};
-#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
#define SR_MAX_PROBENAME_LEN 32
/* Handy little macros */
@@ -136,6 +141,8 @@ enum {
SR_T_RATIONAL_PERIOD,
SR_T_RATIONAL_VOLT,
SR_T_KEYVALUE,
+ SR_T_UINT64_RANGE,
+ SR_T_DOUBLE_RANGE,
};
/** Value for sr_datafeed_packet.type. */
@@ -209,6 +216,10 @@ enum {
* represented as the fraction of number of particles of the substance.
*/
SR_UNIT_CONCENTRATION,
+ SR_UNIT_REVOLUTIONS_PER_MINUTE,
+ SR_UNIT_VOLT_AMPERE,
+ SR_UNIT_WATT,
+ SR_UNIT_WATT_HOUR,
};
/** Values for sr_datafeed_analog.flags. */
@@ -450,7 +461,7 @@ struct sr_output_format {
* data_out
parameter, so the caller knows not to try
* and g_free() it.
*
- * Note: This API call is obsolete, use recv() instead.
+ * Note: This API call is obsolete, use receive() instead.
*
* @param o Pointer to the respective 'struct sr_output'.
* @param data_in Pointer to the input data buffer.
@@ -482,7 +493,7 @@ struct sr_output_format {
* it stored in the data_out
and length_out
* parameters, or NULL if no output was generated.
*
- * Note: This API call is obsolete, use recv() instead.
+ * Note: This API call is obsolete, use receive() instead.
*
* @param o Pointer to the respective 'struct sr_output'.
* @param event_type Type of event that occured.
@@ -492,11 +503,35 @@ struct sr_output_format {
* @return SR_OK upon success, a negative error code otherwise.
*/
int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
- uint64_t *length_out);
+ uint64_t *length_out);
- GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
- const struct sr_datafeed_packet *packet);
+ /**
+ * This function is passed a copy of every packed in the data feed.
+ * Any output generated by the output module in response to the
+ * packet should be returned in a newly allocated GString
+ * out
, which will be freed by the caller.
+ *
+ * Packets not of interest to the output module can just be ignored,
+ * and the out
parameter set to NULL.
+ *
+ * @param o Pointer to the respective 'struct sr_output'.
+ * @param sdi The device instance that generated the packet.
+ * @param packet The complete packet.
+ * @param out A pointer where a GString * should be stored if
+ * the module generates output, or NULL if not.
+ *
+ * @return SR_OK upon success, a negative error code otherwise.
+ */
+ int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi,
+ const struct sr_datafeed_packet *packet, GString **out);
+ /**
+ * This function is called after the caller is finished using
+ * the output module, and can be used to free any internal
+ * resources the module may keep.
+ *
+ * @return SR_OK upon success, a negative error code otherwise.
+ */
int (*cleanup) (struct sr_output *o);
};
@@ -551,6 +586,9 @@ enum {
/** The device can measure humidity. */
SR_CONF_HYGROMETER,
+ /** The device can measure energy consumption. */
+ SR_CONF_ENERGYMETER,
+
/*--- Driver scan options -------------------------------------------*/
/**
@@ -636,6 +674,33 @@ enum {
/** Number of vertical divisions, as related to SR_CONF_VDIV. */
SR_CONF_NUM_VDIV,
+ /** Sound pressure level frequency weighting. */
+ SR_CONF_SPL_WEIGHT_FREQ,
+
+ /** Sound pressure level time weighting. */
+ SR_CONF_SPL_WEIGHT_TIME,
+
+ /** Sound pressure level measurement range. */
+ SR_CONF_SPL_MEASUREMENT_RANGE,
+
+ /** Max hold mode. */
+ SR_CONF_HOLD_MAX,
+
+ /** Min hold mode. */
+ SR_CONF_HOLD_MIN,
+
+ /** Logic low-high threshold range. */
+ SR_CONF_VOLTAGE_THRESHOLD,
+
+ /** The device supports using a external clock. */
+ SR_CONF_EXTERNAL_CLOCK,
+
+ /**
+ * The device supports swapping channels. Typical this is between
+ * buffered and unbuffered channels.
+ */
+ SR_CONF_SWAP,
+
/*--- Special stuff -------------------------------------------------*/
/** Scan options supported by the driver. */
@@ -656,6 +721,21 @@ enum {
/** The device supports setting the number of probes. */
SR_CONF_CAPTURE_NUM_PROBES,
+ /** Power off the device. */
+ SR_CONF_POWER_OFF,
+
+ /** Data source for acquisition. If not present, acquisition from
+ * the device is always "live", i.e. acquisition starts when the
+ * frontend asks and the results are sent out as soon as possible.
+ *
+ * If present, it indicates that either the device has no live
+ * acquisition capability (for example a pure data logger), or
+ * there is a choice. sr_config_list() returns those choices.
+ *
+ * In any case if a device has live acquisition capabilities, it
+ * is always the default. */
+ SR_CONF_DATA_SOURCE,
+
/*--- Acquisition modes ---------------------------------------------*/
/**
@@ -758,6 +838,7 @@ struct sr_session {
/** List of struct datafeed_callback pointers. */
GSList *datafeed_callbacks;
GTimeVal starttime;
+ gboolean running;
unsigned int num_sources;