X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=libsigrok.h;h=88ba2f58139625680c166a553682df5332014f53;hb=4b4474ed6a4701e28961569eb777052d0b74673d;hp=a22b6d18d6a0f37eb1817c5082bf1d942e8caa9c;hpb=d5c5ea2a29d1a7063e26327b87fa820dc1babd16;p=libsigrok.git diff --git a/libsigrok.h b/libsigrok.h index a22b6d18..88ba2f58 100644 --- a/libsigrok.h +++ b/libsigrok.h @@ -73,6 +73,7 @@ enum { 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. */ + SR_ERR_PROBE_GROUP= -9, /**< A probe group must be specified. */ /* * Note: When adding entries here, don't forget to also update the @@ -178,6 +179,7 @@ enum { SR_MQ_SOUND_PRESSURE_LEVEL, SR_MQ_CARBON_MONOXIDE, SR_MQ_RELATIVE_HUMIDITY, + SR_MQ_TIME, /**< Time */ }; /** Values for sr_datafeed_analog.unit. */ @@ -216,6 +218,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. */ @@ -262,6 +268,8 @@ enum { /** Sound pressure level represented as a percentage of measurements * that were over a preset alarm level. */ SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, + /** Time is duration (as opposed to epoch, ...). */ + SR_MQFLAG_DURATION = 0x20000, }; struct sr_context; @@ -545,6 +553,16 @@ struct sr_probe { char *trigger; }; +/** Structure for groups of probes that have common properties. */ +struct sr_probe_group { + /** Name of the probe group. */ + char *name; + /** List of sr_probe structs of the probes belonging to this group. */ + GSList *probes; + /** Private data for driver use. */ + void *priv; +}; + struct sr_config { int key; GVariant *data; @@ -582,6 +600,9 @@ enum { /** The device can measure humidity. */ SR_CONF_HYGROMETER, + /** The device can measure energy consumption. */ + SR_CONF_ENERGYMETER, + /*--- Driver scan options -------------------------------------------*/ /** @@ -770,6 +791,8 @@ struct sr_dev_inst { char *model; char *version; GSList *probes; + /* List of sr_probe_group structs */ + GSList *probe_groups; void *conn; void *priv; }; @@ -780,6 +803,8 @@ enum { SR_INST_USB = 10000, /** Device instance type for serial port devices. */ SR_INST_SERIAL, + /** Device instance type for SCPI devices. */ + SR_INST_SCPI, }; /** Device instance status. */ @@ -807,11 +832,14 @@ struct sr_dev_driver { GSList *(*dev_list) (void); int (*dev_clear) (void); int (*config_get) (int id, GVariant **data, - const struct sr_dev_inst *sdi); + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); int (*config_set) (int id, GVariant *data, - const struct sr_dev_inst *sdi); + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); int (*config_list) (int info_id, GVariant **data, - const struct sr_dev_inst *sdi); + const struct sr_dev_inst *sdi, + const struct sr_probe_group *probe_group); /* Device-specific */ int (*dev_open) (struct sr_dev_inst *sdi); @@ -825,34 +853,11 @@ struct sr_dev_driver { void *priv; }; -struct sr_session { - /** List of struct sr_dev pointers. */ - GSList *devs; - /** List of struct datafeed_callback pointers. */ - GSList *datafeed_callbacks; - GTimeVal starttime; - gboolean running; - - unsigned int num_sources; - - /* - * Both "sources" and "pollfds" are of the same size and contain pairs - * of descriptor and callback function. We can not embed the GPollFD - * into the source struct since we want to be able to pass the array - * of all poll descriptors to g_poll(). - */ - struct source *sources; - GPollFD *pollfds; - int source_timeout; - - /* - * These are our synchronization primitives for stopping the session in - * an async fashion. We need to make sure the session is stopped from - * within the session thread itself. - */ - GMutex stop_mutex; - gboolean abort_session; -}; +/** + * Opaque data structure representing a libsigrok session. None of the fields + * of this structure are meant to be accessed directly. + */ +struct sr_session; #include "proto.h" #include "version.h"