*
* The correct way to get/use the libsigrok API functions is:
*
- @code{.c}
- #include <libsigrok/libsigrok.h>
- @endcode
+ * @code{.c}
+ * #include <libsigrok/libsigrok.h>
+ * @endcode
*/
/*
*/
/** Status/error codes returned by libsigrok functions. */
-enum {
+enum sr_error_code {
SR_OK = 0, /**< No error. */
SR_ERR = -1, /**< Generic/unspecified error. */
SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
#endif
/** Type definition for callback function for data reception. */
-typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
+typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
/** Data types used by sr_config_info(). */
enum sr_datatype {
SR_T_UINT64 = 10000,
- SR_T_CHAR,
+ SR_T_STRING,
SR_T_BOOL,
SR_T_FLOAT,
SR_T_RATIONAL_PERIOD,
SR_MQ_RELATIVE_HUMIDITY,
/** Time */
SR_MQ_TIME,
+ /** Wind speed */
+ SR_MQ_WIND_SPEED,
+ /** Pressure */
+ SR_MQ_PRESSURE,
};
/** Unit of measured quantity, sr_datafeed_analog.unit. */
* a unitless quantity, for example.
*/
SR_UNIT_UNITLESS,
- /** Sound pressure level relative so 20 micropascals. */
+ /** Sound pressure level, in decibels, relative to 20 micropascals. */
SR_UNIT_DECIBEL_SPL,
/**
* Normalized (0 to 1) concentration of a substance or compound with 0
SR_UNIT_WATT,
/** Consumption [Wh]. */
SR_UNIT_WATT_HOUR,
+ /** Wind speed in meters per second. */
+ SR_UNIT_METER_SECOND,
+ /** Pressure in hectopascal */
+ SR_UNIT_HECTOPASCAL,
+ /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
+ SR_UNIT_HUMIDITY_293K,
};
/** Values for sr_datafeed_analog.flags. */
SR_MQFLAG_AVG = 0x40000,
};
+enum sr_trigger_matches {
+ SR_TRIGGER_ZERO = 1,
+ SR_TRIGGER_ONE,
+ SR_TRIGGER_RISING,
+ SR_TRIGGER_FALLING,
+ SR_TRIGGER_EDGE,
+ SR_TRIGGER_OVER,
+ SR_TRIGGER_UNDER,
+};
+
+/** The representation of a trigger, consisting of one or more stages
+ * containing one or more matches on a channel.
+ */
+struct sr_trigger {
+ /** A name for this trigger. This may be NULL if none is needed. */
+ char *name;
+ /** List of pointers to struct sr_trigger_stage. */
+ GSList *stages;
+};
+
+/** A trigger stage. */
+struct sr_trigger_stage {
+ /** Starts at 0. */
+ int stage;
+ /** List of pointers to struct sr_trigger_match. */
+ GSList *matches;
+};
+
+/** A channel to match and what to match it on. */
+struct sr_trigger_match {
+ /** The channel to trigger on. */
+ struct sr_channel *channel;
+ /** The trigger match to use.
+ * For logic channels, only the following matches may be used:
+ * SR_TRIGGER_ZERO
+ * SR_TRIGGER_ONE
+ * SR_TRIGGER_RISING
+ * SR_TRIGGER_FALLING
+ * SR_TRIGGER_EDGE
+ *
+ * For analog channels, only these matches may be used:
+ * SR_TRIGGER_RISING
+ * SR_TRIGGER_FALLING
+ * SR_TRIGGER_OVER
+ * SR_TRIGGER_UNDER
+ *
+ */
+ int match;
+ /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
+ * this contains the value to compare against. */
+ float value;
+};
+
/**
* @struct sr_context
* Opaque structure representing a libsigrok context.
*/
struct sr_context;
+/**
+ * @struct sr_session
+ * Opaque structure representing a libsigrok session.
+ *
+ * None of the fields of this structure are meant to be accessed directly.
+ *
+ * @see sr_session_new(), sr_session_destroy().
+ */
+struct sr_session;
+
/** Packet in a sigrok data feed. */
struct sr_datafeed_packet {
uint16_t type;
/** Information on single channel. */
struct sr_channel {
- /** Number of channels, starting at 0. */
+ /** The index of this channel, starting at 0. Logic channels will
+ * be encoded according to this index in SR_DF_LOGIC packets. */
int index;
/** Channel type (SR_CHANNEL_LOGIC, ...) */
int type;
gboolean enabled;
/** Name of channel. */
char *name;
- /** Trigger string, format like used by sigrok-cli */
- char *trigger;
};
/** Structure for groups of channels that have common properties. */
struct sr_config_info {
/** Config key like SR_CONF_CONN, etc. */
int key;
- /** Data type like SR_T_CHAR, etc. */
+ /** Data type like SR_T_STRING, etc. */
int datatype;
/** Id string, e.g. "serialcomm". */
char *id;
/** Coupling. */
SR_CONF_COUPLING,
- /** Trigger types. */
- SR_CONF_TRIGGER_TYPE,
+ /** Trigger matches. */
+ SR_CONF_TRIGGER_MATCH,
/** The device supports setting its sample interval, in ms. */
SR_CONF_SAMPLE_INTERVAL,
void *conn;
/** Device instance private data (used?) */
void *priv;
+ /** Session to which this device is currently assigned. */
+ struct sr_session *session;
};
/** Types of device instance, struct sr_dev_inst.type */
-enum {
+enum sr_dev_inst_type {
/** Device instance type for USB devices. */
SR_INST_USB = 10000,
/** Device instance type for serial port devices. */
};
/** Device instance status, struct sr_dev_inst.status */
-enum {
+enum sr_dev_inst_status {
/** The device instance was not found. */
SR_ST_NOT_FOUND = 10000,
/** The device instance was found, but is still booting. */
const struct sr_dev_inst *sdi,
const struct sr_channel_group *cg);
/** Channel status change.
- * @see sr_dev_channel_enable(), sr_dev_trigger_set(). */
+ * @see sr_dev_channel_enable(). */
int (*config_channel_set) (const struct sr_dev_inst *sdi,
struct sr_channel *ch, unsigned int changes);
/** Apply configuration settings to the device hardware.
projects / libsigrok.git / blobdiff