libsigrok  0.4.0
sigrok hardware access and backend library
libsigrok.h
Go to the documentation of this file.
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef LIBSIGROK_LIBSIGROK_H
21 #define LIBSIGROK_LIBSIGROK_H
22 
23 #include <stdio.h>
24 #include <sys/time.h>
25 #include <stdint.h>
26 #include <inttypes.h>
27 #include <glib.h>
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /**
34  * @file
35  *
36  * The public libsigrok header file to be used by frontends.
37  *
38  * This is the only file that libsigrok users (frontends) are supposed to
39  * use and \#include. There are other header files which get installed with
40  * libsigrok, but those are not meant to be used directly by frontends.
41  *
42  * The correct way to get/use the libsigrok API functions is:
43  *
44  * @code{.c}
45  * #include <libsigrok/libsigrok.h>
46  * @endcode
47  */
48 
49 /*
50  * All possible return codes of libsigrok functions must be listed here.
51  * Functions should never return hardcoded numbers as status, but rather
52  * use these enum values. All error codes are negative numbers.
53  *
54  * The error codes are globally unique in libsigrok, i.e. if one of the
55  * libsigrok functions returns a "malloc error" it must be exactly the same
56  * return value as used by all other functions to indicate "malloc error".
57  * There must be no functions which indicate two different errors via the
58  * same return code.
59  *
60  * Also, for compatibility reasons, no defined return codes are ever removed
61  * or reused for different errors later. You can only add new entries and
62  * return codes, but never remove or redefine existing ones.
63  */
64 
65 /** Status/error codes returned by libsigrok functions. */
67  SR_OK = 0, /**< No error. */
68  SR_ERR = -1, /**< Generic/unspecified error. */
69  SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
70  SR_ERR_ARG = -3, /**< Function argument error. */
71  SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
72  SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
73  SR_ERR_NA = -6, /**< Not applicable. */
74  SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but must be open. */
75  SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
76  SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
77  SR_ERR_DATA =-10, /**< Data is invalid. */
78  SR_ERR_IO =-11, /**< Input/output error. */
79 
80  /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
81 };
82 
83 #define SR_MAX_CHANNELNAME_LEN 32
84 
85 /* Handy little macros */
86 #define SR_HZ(n) (n)
87 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
88 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
89 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
90 
91 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
92 
93 /** libsigrok loglevels. */
95  SR_LOG_NONE = 0, /**< Output no messages at all. */
96  SR_LOG_ERR = 1, /**< Output error messages. */
97  SR_LOG_WARN = 2, /**< Output warnings. */
98  SR_LOG_INFO = 3, /**< Output informational messages. */
99  SR_LOG_DBG = 4, /**< Output debug messages. */
100  SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
101 };
102 
103 /*
104  * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
105  *
106  * Variables and functions marked 'static' are private already and don't
107  * need SR_PRIV. However, functions which are not static (because they need
108  * to be used in other libsigrok-internal files) but are also not meant to
109  * be part of the public libsigrok API, must use SR_PRIV.
110  *
111  * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
112  *
113  * This feature is not available on MinGW/Windows, as it is a feature of
114  * ELF files and MinGW/Windows uses PE files.
115  *
116  * Details: http://gcc.gnu.org/wiki/Visibility
117  */
118 
119 /* Marks public libsigrok API symbols. */
120 #ifndef _WIN32
121 #define SR_API __attribute__((visibility("default")))
122 #else
123 #define SR_API
124 #endif
125 
126 /* Marks private, non-public libsigrok symbols (not part of the API). */
127 #ifndef _WIN32
128 #define SR_PRIV __attribute__((visibility("hidden")))
129 #else
130 #define SR_PRIV
131 #endif
132 
133 /** Type definition for callback function for data reception. */
134 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
135 
136 /** Data types used by sr_config_info(). */
138  SR_T_UINT64 = 10000,
149 
150  /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
151 };
152 
153 /** Value for sr_datafeed_packet.type. */
155  /** Payload is sr_datafeed_header. */
156  SR_DF_HEADER = 10000,
157  /** End of stream (no further data). */
159  /** Payload is struct sr_datafeed_meta */
161  /** The trigger matched at this point in the data feed. No payload. */
163  /** Payload is struct sr_datafeed_logic. */
165  /** DEPRECATED! Use SR_DF_ANALOG instead. */
167  /** Beginning of frame. No payload. */
169  /** End of frame. No payload. */
171  /** Payload is struct sr_datafeed_analog. */
173 
174  /* Update datafeed_dump() (session.c) upon changes! */
175 };
176 
177 /** Measured quantity, sr_analog_meaning.mq. */
178 enum sr_mq {
179  SR_MQ_VOLTAGE = 10000,
185  /** Duty cycle, e.g. on/off ratio. */
187  /** Continuity test. */
191  /** Electrical power, usually in W, or dBm. */
193  /** Gain (a transistor's gain, or hFE, for example). */
195  /** Logarithmic representation of sound pressure relative to a
196  * reference value. */
198  /** Carbon monoxide level */
200  /** Humidity */
202  /** Time */
204  /** Wind speed */
206  /** Pressure */
208  /** Parallel inductance (LCR meter model). */
210  /** Parallel capacitance (LCR meter model). */
212  /** Parallel resistance (LCR meter model). */
214  /** Series inductance (LCR meter model). */
216  /** Series capacitance (LCR meter model). */
218  /** Series resistance (LCR meter model). */
220  /** Dissipation factor. */
222  /** Quality factor. */
224  /** Phase angle. */
226  /** Difference from reference value. */
228  /** Count. */
230  /** Power factor. */
232  /** Apparent power */
234  /** Mass */
236 
237  /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
238 };
239 
240 /** Unit of measured quantity, sr_analog_meaning.unit. */
241 enum sr_unit {
242  /** Volt */
243  SR_UNIT_VOLT = 10000,
244  /** Ampere (current). */
246  /** Ohm (resistance). */
248  /** Farad (capacity). */
250  /** Kelvin (temperature). */
252  /** Degrees Celsius (temperature). */
254  /** Degrees Fahrenheit (temperature). */
256  /** Hertz (frequency, 1/s, [Hz]). */
258  /** Percent value. */
260  /** Boolean value. */
262  /** Time in seconds. */
264  /** Unit of conductance, the inverse of resistance. */
266  /**
267  * An absolute measurement of power, in decibels, referenced to
268  * 1 milliwatt (dBu).
269  */
271  /** Voltage in decibel, referenced to 1 volt (dBV). */
273  /**
274  * Measurements that intrinsically do not have units attached, such
275  * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
276  * a unitless quantity, for example.
277  */
279  /** Sound pressure level, in decibels, relative to 20 micropascals. */
281  /**
282  * Normalized (0 to 1) concentration of a substance or compound with 0
283  * representing a concentration of 0%, and 1 being 100%. This is
284  * represented as the fraction of number of particles of the substance.
285  */
287  /** Revolutions per minute. */
289  /** Apparent power [VA]. */
291  /** Real power [W]. */
293  /** Consumption [Wh]. */
295  /** Wind speed in meters per second. */
297  /** Pressure in hectopascal */
299  /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
301  /** Plane angle in 1/360th of a full circle. */
303  /** Henry (inductance). */
305  /** Mass in gram [g]. */
307  /** Mass in carat [ct]. */
309  /** Mass in ounce [oz]. */
311  /** Mass in troy ounce [oz t]. */
313  /** Mass in pound [lb]. */
315  /** Mass in pennyweight [dwt]. */
317  /** Mass in grain [gr]. */
319  /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
321  /** Mass in momme. */
323  /** Mass in tola. */
325  /** Pieces (number of items). */
327 
328  /*
329  * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
330  * upon changes!
331  */
332 };
333 
334 /** Values for sr_analog_meaning.mqflags. */
335 enum sr_mqflag {
336  /** Voltage measurement is alternating current (AC). */
337  SR_MQFLAG_AC = 0x01,
338  /** Voltage measurement is direct current (DC). */
339  SR_MQFLAG_DC = 0x02,
340  /** This is a true RMS measurement. */
342  /** Value is voltage drop across a diode, or NAN. */
344  /** Device is in "hold" mode (repeating the last measurement). */
346  /** Device is in "max" mode, only updating upon a new max value. */
348  /** Device is in "min" mode, only updating upon a new min value. */
350  /** Device is in autoranging mode. */
352  /** Device is in relative mode. */
354  /** Sound pressure level is A-weighted in the frequency domain,
355  * according to IEC 61672:2003. */
357  /** Sound pressure level is C-weighted in the frequency domain,
358  * according to IEC 61672:2003. */
360  /** Sound pressure level is Z-weighted (i.e. not at all) in the
361  * frequency domain, according to IEC 61672:2003. */
363  /** Sound pressure level is not weighted in the frequency domain,
364  * albeit without standards-defined low and high frequency limits. */
366  /** Sound pressure level measurement is S-weighted (1s) in the
367  * time domain. */
369  /** Sound pressure level measurement is F-weighted (125ms) in the
370  * time domain. */
372  /** Sound pressure level is time-averaged (LAT), also known as
373  * Equivalent Continuous A-weighted Sound Level (LEQ). */
375  /** Sound pressure level represented as a percentage of measurements
376  * that were over a preset alarm level. */
378  /** Time is duration (as opposed to epoch, ...). */
380  /** Device is in "avg" mode, averaging upon each new value. */
381  SR_MQFLAG_AVG = 0x40000,
382  /** Reference value shown. */
384  /** Unstable value (hasn't settled yet). */
385  SR_MQFLAG_UNSTABLE = 0x100000,
386 
387  /*
388  * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
389  * upon changes!
390  */
391 };
392 
401 };
402 
403 /** The representation of a trigger, consisting of one or more stages
404  * containing one or more matches on a channel.
405  */
406 struct sr_trigger {
407  /** A name for this trigger. This may be NULL if none is needed. */
408  char *name;
409  /** List of pointers to struct sr_trigger_stage. */
410  GSList *stages;
411 };
412 
413 /** A trigger stage. */
415  /** Starts at 0. */
416  int stage;
417  /** List of pointers to struct sr_trigger_match. */
418  GSList *matches;
419 };
420 
421 /** A channel to match and what to match it on. */
423  /** The channel to trigger on. */
425  /** The trigger match to use.
426  * For logic channels, only the following matches may be used:
427  * SR_TRIGGER_ZERO
428  * SR_TRIGGER_ONE
429  * SR_TRIGGER_RISING
430  * SR_TRIGGER_FALLING
431  * SR_TRIGGER_EDGE
432  *
433  * For analog channels, only these matches may be used:
434  * SR_TRIGGER_RISING
435  * SR_TRIGGER_FALLING
436  * SR_TRIGGER_OVER
437  * SR_TRIGGER_UNDER
438  *
439  */
440  int match;
441  /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
442  * this contains the value to compare against. */
443  float value;
444 };
445 
446 /**
447  * @struct sr_context
448  * Opaque structure representing a libsigrok context.
449  *
450  * None of the fields of this structure are meant to be accessed directly.
451  *
452  * @see sr_init(), sr_exit().
453  */
454 struct sr_context;
455 
456 /**
457  * @struct sr_session
458  * Opaque structure representing a libsigrok session.
459  *
460  * None of the fields of this structure are meant to be accessed directly.
461  *
462  * @see sr_session_new(), sr_session_destroy().
463  */
464 struct sr_session;
465 
466 struct sr_rational {
467  /** Numerator of the rational number. */
468  int64_t p;
469  /** Denominator of the rational number. */
470  uint64_t q;
471 };
472 
473 /** Packet in a sigrok data feed. */
475  uint16_t type;
476  const void *payload;
477 };
478 
479 /** Header of a sigrok data feed. */
482  struct timeval starttime;
483 };
484 
485 /** Datafeed payload for type SR_DF_META. */
487  GSList *config;
488 };
489 
490 /** Logic datafeed payload for type SR_DF_LOGIC. */
492  uint64_t length;
493  uint16_t unitsize;
494  void *data;
495 };
496 
497 /** Analog datafeed payload for type SR_DF_ANALOG_OLD. */
499  /** The channels for which data is included in this packet. */
500  GSList *channels;
501  /** Number of samples in data */
503  /** Measured quantity (voltage, current, temperature, and so on).
504  * Use SR_MQ_VOLTAGE, ... */
505  int mq;
506  /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
507  int unit;
508  /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
509  uint64_t mqflags;
510  /** The analog value(s). The data is interleaved according to
511  * the channels list. */
512  float *data;
513 };
514 
515 /** Analog datafeed payload for type SR_DF_ANALOG. */
517  void *data;
518  uint32_t num_samples;
522 };
523 
525  uint8_t unitsize;
526  gboolean is_signed;
527  gboolean is_float;
528  gboolean is_bigendian;
529  uint8_t digits;
533 };
534 
536  enum sr_mq mq;
537  enum sr_unit unit;
539  GSList *channels;
540 };
541 
543  uint8_t spec_digits;
544 };
545 
546 /** Generic option struct used by various subsystems. */
547 struct sr_option {
548  /* Short name suitable for commandline usage, [a-z0-9-]. */
549  const char *id;
550  /* Short name suitable for GUI usage, can contain UTF-8. */
551  const char *name;
552  /* Description of the option, in a sentence. */
553  const char *desc;
554  /* Default value for this option. */
555  GVariant *def;
556  /* List of possible values, if this is an option with few values. */
557  GSList *values;
558 };
559 
560 /** Resource type.
561  * @since 0.4.0
562  */
565 };
566 
567 /** Resource descriptor.
568  * @since 0.4.0
569  */
570 struct sr_resource {
571  /** Size of resource in bytes; set by resource open callback. */
572  uint64_t size;
573  /** File handle or equivalent; set by resource open callback. */
574  void *handle;
575  /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
576  int type;
577 };
578 
579 /** Output module flags. */
581  /** If set, this output module writes the output itself. */
583 };
584 
585 struct sr_input;
586 struct sr_input_module;
587 struct sr_output;
588 struct sr_output_module;
589 struct sr_transform;
590 struct sr_transform_module;
591 
592 /** Constants for channel type. */
594  /** Channel type is logic channel. */
596  /** Channel type is analog channel. */
598 };
599 
600 /** Information on single channel. */
601 struct sr_channel {
602  /** The device this channel is attached to. */
603  struct sr_dev_inst *sdi;
604  /** The index of this channel, starting at 0. Logic channels will
605  * be encoded according to this index in SR_DF_LOGIC packets. */
606  int index;
607  /** Channel type (SR_CHANNEL_LOGIC, ...) */
608  int type;
609  /** Is this channel enabled? */
610  gboolean enabled;
611  /** Name of channel. */
612  char *name;
613  /** Private data for driver use. */
614  void *priv;
615 };
616 
617 /** Structure for groups of channels that have common properties. */
619  /** Name of the channel group. */
620  char *name;
621  /** List of sr_channel structs of the channels belonging to this group. */
622  GSList *channels;
623  /** Private data for driver use. */
624  void *priv;
625 };
626 
627 /** Used for setting or getting value of a config item. */
628 struct sr_config {
629  /** Config key like SR_CONF_CONN, etc. */
630  uint32_t key;
631  /** Key-specific data. */
632  GVariant *data;
633 };
634 
639 };
640 
641 /** Information about a key. */
642 struct sr_key_info {
643  /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
644  uint32_t key;
645  /** Data type like SR_T_STRING, etc if applicable. */
646  int datatype;
647  /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
648  const char *id;
649  /** Full capitalized name, e.g. "Serial communication". */
650  const char *name;
651  /** Verbose description (unused currently). */
652  const char *description;
653 };
654 
655 /** Configuration capabilities. */
657  /** Value can be read. */
658  SR_CONF_GET = (1 << 31),
659  /** Value can be written. */
660  SR_CONF_SET = (1 << 30),
661  /** Possible values can be enumerated. */
662  SR_CONF_LIST = (1 << 29),
663 };
664 
665 /** Configuration keys */
667  /*--- Device classes ------------------------------------------------*/
668 
669  /** The device can act as logic analyzer. */
671 
672  /** The device can act as an oscilloscope. */
674 
675  /** The device can act as a multimeter. */
677 
678  /** The device is a demo device. */
680 
681  /** The device can act as a sound level meter. */
683 
684  /** The device can measure temperature. */
686 
687  /** The device can measure humidity. */
689 
690  /** The device can measure energy consumption. */
692 
693  /** The device can act as a signal demodulator. */
695 
696  /** The device can act as a programmable power supply. */
698 
699  /** The device can act as an LCR meter. */
701 
702  /** The device can act as an electronic load. */
704 
705  /** The device can act as a scale. */
707 
708  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
709 
710  /*--- Driver scan options -------------------------------------------*/
711 
712  /**
713  * Specification on how to connect to a device.
714  *
715  * In combination with SR_CONF_SERIALCOMM, this is a serial port in
716  * the form which makes sense to the OS (e.g., /dev/ttyS0).
717  * Otherwise this specifies a USB device, either in the form of
718  * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
719  * @verbatim <vendorid>.<productid> @endverbatim
720  * (hexadecimal, e.g. 1d6b.0001).
721  */
722  SR_CONF_CONN = 20000,
723 
724  /**
725  * Serial communication specification, in the form:
726  *
727  * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
728  *
729  * Example: 9600/8n1
730  *
731  * The string may also be followed by one or more special settings,
732  * in the form "/key=value". Supported keys and their values are:
733  *
734  * rts 0,1 set the port's RTS pin to low or high
735  * dtr 0,1 set the port's DTR pin to low or high
736  * flow 0 no flow control
737  * 1 hardware-based (RTS/CTS) flow control
738  * 2 software-based (XON/XOFF) flow control
739  *
740  * This is always an optional parameter, since a driver typically
741  * knows the speed at which the device wants to communicate.
742  */
744 
745  /**
746  * Modbus slave address specification.
747  *
748  * This is always an optional parameter, since a driver typically
749  * knows the default slave address of the device.
750  */
752 
753  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
754 
755  /*--- Device (or channel group) configuration -----------------------*/
756 
757  /** The device supports setting its samplerate, in Hz. */
759 
760  /** The device supports setting a pre/post-trigger capture ratio. */
762 
763  /** The device supports setting a pattern (pattern generator mode). */
765 
766  /** The device supports run-length encoding (RLE). */
768 
769  /** The device supports setting trigger slope. */
771 
772  /** The device supports averaging. */
774 
775  /**
776  * The device supports setting number of samples to be
777  * averaged over.
778  */
780 
781  /** Trigger source. */
783 
784  /** Horizontal trigger position. */
786 
787  /** Buffer size. */
789 
790  /** Time base. */
792 
793  /** Filter. */
795 
796  /** Volts/div. */
798 
799  /** Coupling. */
801 
802  /** Trigger matches. */
804 
805  /** The device supports setting its sample interval, in ms. */
807 
808  /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
810 
811  /** Number of vertical divisions, as related to SR_CONF_VDIV. */
813 
814  /** Sound pressure level frequency weighting. */
816 
817  /** Sound pressure level time weighting. */
819 
820  /** Sound pressure level measurement range. */
822 
823  /** Max hold mode. */
825 
826  /** Min hold mode. */
828 
829  /** Logic low-high threshold range. */
831 
832  /** The device supports using an external clock. */
834 
835  /**
836  * The device supports swapping channels. Typical this is between
837  * buffered and unbuffered channels.
838  */
840 
841  /** Center frequency.
842  * The input signal is downmixed by this frequency before the ADC
843  * anti-aliasing filter.
844  */
846 
847  /** The device supports setting the number of logic channels. */
849 
850  /** The device supports setting the number of analog channels. */
852 
853  /**
854  * Current voltage.
855  * @arg type: double
856  * @arg get: get measured voltage
857  */
859 
860  /**
861  * Maximum target voltage.
862  * @arg type: double
863  * @arg get: get target voltage
864  * @arg set: change target voltage
865  */
867 
868  /**
869  * Current current.
870  * @arg type: double
871  * @arg get: get measured current
872  */
874 
875  /**
876  * Current limit.
877  * @arg type: double
878  * @arg get: get current limit
879  * @arg set: change current limit
880  */
882 
883  /**
884  * Enabling/disabling channel.
885  * @arg type: boolean
886  * @arg get: @b true if currently enabled
887  * @arg set: enable/disable
888  */
890 
891  /**
892  * Channel configuration.
893  * @arg type: string
894  * @arg get: get current setting
895  * @arg set: change current setting
896  * @arg list: array of possible values
897  */
899 
900  /**
901  * Over-voltage protection (OVP) feature
902  * @arg type: boolean
903  * @arg get: @b true if currently enabled
904  * @arg set: enable/disable
905  */
907 
908  /**
909  * Over-voltage protection (OVP) active
910  * @arg type: boolean
911  * @arg get: @b true if device has activated OVP, i.e. the output voltage
912  * exceeds the over-voltage protection threshold.
913  */
915 
916  /**
917  * Over-voltage protection (OVP) threshold
918  * @arg type: double (voltage)
919  * @arg get: get current threshold
920  * @arg set: set new threshold
921  */
923 
924  /**
925  * Over-current protection (OCP) feature
926  * @arg type: boolean
927  * @arg get: @b true if currently enabled
928  * @arg set: enable/disable
929  */
931 
932  /**
933  * Over-current protection (OCP) active
934  * @arg type: boolean
935  * @arg get: @b true if device has activated OCP, i.e. the current current
936  * exceeds the over-current protection threshold.
937  */
939 
940  /**
941  * Over-current protection (OCP) threshold
942  * @arg type: double (current)
943  * @arg get: get current threshold
944  * @arg set: set new threshold
945  */
947 
948  /** Choice of clock edge for external clock ("r" or "f"). */
950 
951  /** Amplitude of a source without strictly-defined MQ. */
953 
954  /**
955  * Channel regulation
956  * get: "CV", "CC" or "UR", denoting constant voltage, constant current
957  * or unregulated.
958  */
960 
961  /** Over-temperature protection (OTP) */
963 
964  /** Output frequency in Hz. */
966 
967  /** Output frequency target in Hz. */
969 
970  /** Measured quantity. */
972 
973  /** Equivalent circuit model. */
975 
976  /** Over-temperature protection (OTP) active. */
978 
979  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
980 
981  /*--- Special stuff -------------------------------------------------*/
982 
983  /** Session filename. */
985 
986  /** The device supports specifying a capturefile to inject. */
988 
989  /** The device supports specifying the capturefile unit size. */
991 
992  /** Power off the device. */
994 
995  /**
996  * Data source for acquisition. If not present, acquisition from
997  * the device is always "live", i.e. acquisition starts when the
998  * frontend asks and the results are sent out as soon as possible.
999  *
1000  * If present, it indicates that either the device has no live
1001  * acquisition capability (for example a pure data logger), or
1002  * there is a choice. sr_config_list() returns those choices.
1003  *
1004  * In any case if a device has live acquisition capabilities, it
1005  * is always the default.
1006  */
1008 
1009  /** The device supports setting a probe factor. */
1011 
1012  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1013 
1014  /*--- Acquisition modes, sample limiting ----------------------------*/
1015 
1016  /**
1017  * The device supports setting a sample time limit (how long
1018  * the sample acquisition should run, in ms).
1019  */
1021 
1022  /**
1023  * The device supports setting a sample number limit (how many
1024  * samples should be acquired).
1025  */
1027 
1028  /**
1029  * The device supports setting a frame limit (how many
1030  * frames should be acquired).
1031  */
1033 
1034  /**
1035  * The device supports continuous sampling. Neither a time limit
1036  * nor a sample number limit has to be supplied, it will just acquire
1037  * samples continuously, until explicitly stopped by a certain command.
1038  */
1040 
1041  /** The device has internal storage, into which data is logged. This
1042  * starts or stops the internal logging. */
1044 
1045  /** Device mode for multi-function devices. */
1047 
1048  /** Self test mode. */
1050 
1051  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1052 };
1053 
1054 /**
1055  * Opaque structure representing a libsigrok device instance.
1056  *
1057  * None of the fields of this structure are meant to be accessed directly.
1058  */
1059 struct sr_dev_inst;
1060 
1061 /** Types of device instance, struct sr_dev_inst.type */
1063  /** Device instance type for USB devices. */
1064  SR_INST_USB = 10000,
1065  /** Device instance type for serial port devices. */
1067  /** Device instance type for SCPI devices. */
1069  /** Device-instance type for user-created "devices". */
1071  /** Device instance type for Modbus devices. */
1073 };
1074 
1075 /** Device instance status, struct sr_dev_inst.status */
1077  /** The device instance was not found. */
1079  /** The device instance was found, but is still booting. */
1081  /** The device instance is live, but not in use. */
1083  /** The device instance is actively in use in a session. */
1085  /** The device is winding down its session. */
1087 };
1088 
1089 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1091  /* Driver-specific */
1092  /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1093  const char *name;
1094  /** Long name. Verbose driver name shown to user. */
1095  const char *longname;
1096  /** API version (currently 1). */
1098  /** Called when driver is loaded, e.g. program startup. */
1099  int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1100  /** Called before driver is unloaded.
1101  * Driver must free all resources held by it. */
1102  int (*cleanup) (const struct sr_dev_driver *driver);
1103  /** Scan for devices. Driver should do all initialisation required.
1104  * Can be called several times, e.g. with different port options.
1105  * @retval NULL Error or no devices found.
1106  * @retval other GSList of a struct sr_dev_inst for each device.
1107  * Must be freed by caller!
1108  */
1109  GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1110  /** Get list of device instances the driver knows about.
1111  * @returns NULL or GSList of a struct sr_dev_inst for each device.
1112  * Must not be freed by caller!
1113  */
1114  GSList *(*dev_list) (const struct sr_dev_driver *driver);
1115  /** Clear list of devices the driver knows about. */
1116  int (*dev_clear) (const struct sr_dev_driver *driver);
1117  /** Query value of a configuration key in driver or given device instance.
1118  * @see sr_config_get().
1119  */
1120  int (*config_get) (uint32_t key, GVariant **data,
1121  const struct sr_dev_inst *sdi,
1122  const struct sr_channel_group *cg);
1123  /** Set value of a configuration key in driver or a given device instance.
1124  * @see sr_config_set(). */
1125  int (*config_set) (uint32_t key, GVariant *data,
1126  const struct sr_dev_inst *sdi,
1127  const struct sr_channel_group *cg);
1128  /** Channel status change.
1129  * @see sr_dev_channel_enable(). */
1130  int (*config_channel_set) (const struct sr_dev_inst *sdi,
1131  struct sr_channel *ch, unsigned int changes);
1132  /** Apply configuration settings to the device hardware.
1133  * @see sr_config_commit().*/
1134  int (*config_commit) (const struct sr_dev_inst *sdi);
1135  /** List all possible values for a configuration key in a device instance.
1136  * @see sr_config_list().
1137  */
1138  int (*config_list) (uint32_t key, GVariant **data,
1139  const struct sr_dev_inst *sdi,
1140  const struct sr_channel_group *cg);
1141 
1142  /* Device-specific */
1143  /** Open device */
1144  int (*dev_open) (struct sr_dev_inst *sdi);
1145  /** Close device */
1146  int (*dev_close) (struct sr_dev_inst *sdi);
1147  /** Begin data acquisition on the specified device. */
1148  int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1149  void *cb_data);
1150  /** End data acquisition on the specified device. */
1151  int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1152  void *cb_data);
1153 
1154  /* Dynamic */
1155  /** Device driver context, considered private. Initialized by init(). */
1156  void *context;
1157 };
1158 
1159 /** Serial port descriptor. */
1161  /** The OS dependent name of the serial port. */
1162  char *name;
1163  /** An end user friendly description for the serial port. */
1165 };
1166 
1167 #include <libsigrok/proto.h>
1168 #include <libsigrok/version.h>
1169 
1170 #ifdef __cplusplus
1171 }
1172 #endif
1173 
1174 #endif
Sound pressure level is Z-weighted (i.e.
Definition: libsigrok.h:362
The representation of a trigger, consisting of one or more stages containing one or more matches on a...
Definition: libsigrok.h:406
Device instance type for USB devices.
Definition: libsigrok.h:1064
char * name
The OS dependent name of the serial port.
Definition: libsigrok.h:1162
Serial port descriptor.
Definition: libsigrok.h:1160
Over-temperature protection (OTP)
Definition: libsigrok.h:962
Logic low-high threshold range.
Definition: libsigrok.h:830
int(* config_commit)(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: libsigrok.h:1134
An absolute measurement of power, in decibels, referenced to 1 milliwatt (dBu).
Definition: libsigrok.h:270
char * name
Name of the channel group.
Definition: libsigrok.h:620
Over-voltage protection (OVP) feature.
Definition: libsigrok.h:906
Difference from reference value.
Definition: libsigrok.h:227
Device is in autoranging mode.
Definition: libsigrok.h:351
Analog datafeed payload for type SR_DF_ANALOG_OLD.
Definition: libsigrok.h:498
sr_datatype
Data types used by sr_config_info().
Definition: libsigrok.h:137
struct sr_analog_encoding * encoding
Definition: libsigrok.h:519
Pieces (number of items).
Definition: libsigrok.h:326
Over-temperature protection (OTP) active.
Definition: libsigrok.h:977
Value is voltage drop across a diode, or NAN.
Definition: libsigrok.h:343
const char * desc
Definition: libsigrok.h:553
Output warnings.
Definition: libsigrok.h:97
Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan)
Definition: libsigrok.h:320
Mass in pennyweight [dwt].
Definition: libsigrok.h:316
Sound pressure level measurement range.
Definition: libsigrok.h:821
sr_unit
Unit of measured quantity, sr_analog_meaning.unit.
Definition: libsigrok.h:241
End of stream (no further data).
Definition: libsigrok.h:158
Device driver data.
Definition: libsigrok.h:1090
Electrical power, usually in W, or dBm.
Definition: libsigrok.h:192
Time in seconds.
Definition: libsigrok.h:263
Beginning of frame.
Definition: libsigrok.h:168
Logarithmic representation of sound pressure relative to a reference value.
Definition: libsigrok.h:197
Consumption [Wh].
Definition: libsigrok.h:294
Device instance type for SCPI devices.
Definition: libsigrok.h:1068
Self test mode.
Definition: libsigrok.h:1049
The device supports specifying a capturefile to inject.
Definition: libsigrok.h:987
Sound pressure level frequency weighting.
Definition: libsigrok.h:815
Errors hinting at internal bugs.
Definition: libsigrok.h:71
Wind speed in meters per second.
Definition: libsigrok.h:296
Voltage measurement is alternating current (AC).
Definition: libsigrok.h:337
The device supports setting a pre/post-trigger capture ratio.
Definition: libsigrok.h:761
uint32_t num_samples
Definition: libsigrok.h:518
enum sr_mqflag mqflags
Definition: libsigrok.h:538
Power off the device.
Definition: libsigrok.h:993
Horizontal trigger position.
Definition: libsigrok.h:785
The device supports specifying the capturefile unit size.
Definition: libsigrok.h:990
Trigger matches.
Definition: libsigrok.h:803
Number of horizontal divisions, as related to SR_CONF_TIMEBASE.
Definition: libsigrok.h:809
Trigger source.
Definition: libsigrok.h:782
Farad (capacity).
Definition: libsigrok.h:249
Mass in ounce [oz].
Definition: libsigrok.h:310
The device can measure energy consumption.
Definition: libsigrok.h:691
Over-current protection (OCP) active.
Definition: libsigrok.h:938
gboolean is_bigendian
Definition: libsigrok.h:528
Choice of clock edge for external clock ("r" or "f").
Definition: libsigrok.h:949
Unstable value (hasn't settled yet).
Definition: libsigrok.h:385
Mass in gram [g].
Definition: libsigrok.h:306
uint64_t mqflags
Bitmap with extra information about the MQ.
Definition: libsigrok.h:509
Dissipation factor.
Definition: libsigrok.h:221
Count.
Definition: libsigrok.h:229
The device supports setting its sample interval, in ms.
Definition: libsigrok.h:806
Generic/unspecified error.
Definition: libsigrok.h:68
Output frequency target in Hz.
Definition: libsigrok.h:968
int(* config_channel_set)(const struct sr_dev_inst *sdi, struct sr_channel *ch, unsigned int changes)
Channel status change.
Definition: libsigrok.h:1130
Device is in "hold" mode (repeating the last measurement).
Definition: libsigrok.h:345
Time is duration (as opposed to epoch, ...).
Definition: libsigrok.h:379
The device has internal storage, into which data is logged.
Definition: libsigrok.h:1043
void * priv
Private data for driver use.
Definition: libsigrok.h:614
int(* dev_acquisition_stop)(struct sr_dev_inst *sdi, void *cb_data)
End data acquisition on the specified device.
Definition: libsigrok.h:1151
sr_resource_type
Resource type.
Definition: libsigrok.h:563
Opaque structure representing a libsigrok session.
Definition: libsigrok.h:454
Sound pressure level is A-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:356
A channel group must be specified.
Definition: libsigrok.h:76
The device supports setting the number of logic channels.
Definition: libsigrok.h:848
Parallel inductance (LCR meter model).
Definition: libsigrok.h:209
const char * name
Definition: libsigrok.h:551
The device supports setting the number of analog channels.
Definition: libsigrok.h:851
sr_configcap
Configuration capabilities.
Definition: libsigrok.h:656
The device supports setting a sample number limit (how many samples should be acquired).
Definition: libsigrok.h:1026
GSList * channels
Definition: libsigrok.h:539
The device supports run-length encoding (RLE).
Definition: libsigrok.h:767
const char * id
Short, lowercase ID string, e.g.
Definition: libsigrok.h:648
int api_version
API version (currently 1).
Definition: libsigrok.h:1097
gboolean enabled
Is this channel enabled?
Definition: libsigrok.h:610
int match
The trigger match to use.
Definition: libsigrok.h:440
Degrees Fahrenheit (temperature).
Definition: libsigrok.h:255
This is a true RMS measurement.
Definition: libsigrok.h:341
Device instance type for Modbus devices.
Definition: libsigrok.h:1072
The device can act as an LCR meter.
Definition: libsigrok.h:700
If set, this output module writes the output itself.
Definition: libsigrok.h:582
Equivalent circuit model.
Definition: libsigrok.h:974
Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulate...
Definition: libsigrok.h:959
Percent value.
Definition: libsigrok.h:259
Min hold mode.
Definition: libsigrok.h:827
The device supports continuous sampling.
Definition: libsigrok.h:1039
int(* dev_acquisition_start)(const struct sr_dev_inst *sdi, void *cb_data)
Begin data acquisition on the specified device.
Definition: libsigrok.h:1148
char * description
An end user friendly description for the serial port.
Definition: libsigrok.h:1164
const char * name
Full capitalized name, e.g.
Definition: libsigrok.h:650
Number of vertical divisions, as related to SR_CONF_VDIV.
Definition: libsigrok.h:812
Ampere (current).
Definition: libsigrok.h:245
const char * id
Definition: libsigrok.h:549
Unit of conductance, the inverse of resistance.
Definition: libsigrok.h:265
uint32_t key
Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc.
Definition: libsigrok.h:644
Carbon monoxide level.
Definition: libsigrok.h:199
The device can act as a multimeter.
Definition: libsigrok.h:676
Sound pressure level measurement is F-weighted (125ms) in the time domain.
Definition: libsigrok.h:371
Not applicable.
Definition: libsigrok.h:73
enum sr_mq mq
Definition: libsigrok.h:536
The device supports using an external clock.
Definition: libsigrok.h:833
Structure for groups of channels that have common properties.
Definition: libsigrok.h:618
int mq
Measured quantity (voltage, current, temperature, and so on).
Definition: libsigrok.h:505
sr_packettype
Value for sr_datafeed_packet.type.
Definition: libsigrok.h:154
Hertz (frequency, 1/s, [Hz]).
Definition: libsigrok.h:257
Channel configuration.
Definition: libsigrok.h:898
No error.
Definition: libsigrok.h:67
Mass.
Definition: libsigrok.h:235
The device can act as logic analyzer.
Definition: libsigrok.h:670
Degrees Celsius (temperature).
Definition: libsigrok.h:253
uint8_t spec_digits
Definition: libsigrok.h:543
The device can act as a signal demodulator.
Definition: libsigrok.h:694
sr_dev_inst_type
Types of device instance, struct sr_dev_inst.type.
Definition: libsigrok.h:1062
int(* config_get)(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
Query value of a configuration key in driver or given device instance.
Definition: libsigrok.h:1120
float * data
The analog value(s).
Definition: libsigrok.h:512
Amplitude of a source without strictly-defined MQ.
Definition: libsigrok.h:952
The device can act as a scale.
Definition: libsigrok.h:706
struct sr_rational offset
Definition: libsigrok.h:532
Kelvin (temperature).
Definition: libsigrok.h:251
Malloc/calloc/realloc error.
Definition: libsigrok.h:69
Continuity test.
Definition: libsigrok.h:188
sr_mqflag
Values for sr_analog_meaning.mqflags.
Definition: libsigrok.h:335
Mass in pound [lb].
Definition: libsigrok.h:314
sr_channeltype
Constants for channel type.
Definition: libsigrok.h:593
The device supports setting a sample time limit (how long the sample acquisition should run...
Definition: libsigrok.h:1020
Over-voltage protection (OVP) active.
Definition: libsigrok.h:914
GVariant * def
Definition: libsigrok.h:555
Data source for acquisition.
Definition: libsigrok.h:1007
The device supports averaging.
Definition: libsigrok.h:773
Mass in momme.
Definition: libsigrok.h:322
Modbus slave address specification.
Definition: libsigrok.h:751
gboolean is_digits_decimal
Definition: libsigrok.h:530
Device is closed, but must be open.
Definition: libsigrok.h:74
Over-current protection (OCP) threshold.
Definition: libsigrok.h:946
Analog datafeed payload for type SR_DF_ANALOG.
Definition: libsigrok.h:516
Sound pressure level is time-averaged (LAT), also known as Equivalent Continuous A-weighted Sound Lev...
Definition: libsigrok.h:374
The device supports swapping channels.
Definition: libsigrok.h:839
char * name
Name of channel.
Definition: libsigrok.h:612
uint64_t length
Definition: libsigrok.h:492
sr_dev_inst_status
Device instance status, struct sr_dev_inst.status.
Definition: libsigrok.h:1076
A trigger stage.
Definition: libsigrok.h:414
Volt.
Definition: libsigrok.h:243
Output informational messages.
Definition: libsigrok.h:98
Pressure.
Definition: libsigrok.h:207
Buffer size.
Definition: libsigrok.h:788
Sound pressure level is C-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:359
GSList * channels
The channels for which data is included in this packet.
Definition: libsigrok.h:500
const char * name
Driver name.
Definition: libsigrok.h:1093
GVariant * data
Key-specific data.
Definition: libsigrok.h:632
sr_loglevel
libsigrok loglevels.
Definition: libsigrok.h:94
Quality factor.
Definition: libsigrok.h:223
Packet in a sigrok data feed.
Definition: libsigrok.h:474
int type
Resource type (SR_RESOURCE_FIRMWARE, ...)
Definition: libsigrok.h:576
Sound pressure level time weighting.
Definition: libsigrok.h:818
Voltage measurement is direct current (DC).
Definition: libsigrok.h:339
The device can act as a sound level meter.
Definition: libsigrok.h:682
Pressure in hectopascal.
Definition: libsigrok.h:298
Filter.
Definition: libsigrok.h:794
struct sr_analog_meaning * meaning
Definition: libsigrok.h:520
Coupling.
Definition: libsigrok.h:800
sr_trigger_matches
Definition: libsigrok.h:393
The device supports setting trigger slope.
Definition: libsigrok.h:770
Logic datafeed payload for type SR_DF_LOGIC.
Definition: libsigrok.h:491
The device is a demo device.
Definition: libsigrok.h:679
Device is in "min" mode, only updating upon a new min value.
Definition: libsigrok.h:349
GSList * values
Definition: libsigrok.h:557
Sound pressure level represented as a percentage of measurements that were over a preset alarm level...
Definition: libsigrok.h:377
float value
If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER, this contains the value to compar...
Definition: libsigrok.h:443
uint64_t q
Denominator of the rational number.
Definition: libsigrok.h:470
Mass in tola.
Definition: libsigrok.h:324
const char * longname
Long name.
Definition: libsigrok.h:1095
Version number definitions and macros.
Payload is sr_datafeed_header.
Definition: libsigrok.h:156
uint16_t unitsize
Definition: libsigrok.h:493
gboolean is_float
Definition: libsigrok.h:527
Generic option struct used by various subsystems.
Definition: libsigrok.h:547
char * name
A name for this trigger.
Definition: libsigrok.h:408
Output frequency in Hz.
Definition: libsigrok.h:965
Current voltage.
Definition: libsigrok.h:858
int type
Channel type (SR_CHANNEL_LOGIC, ...)
Definition: libsigrok.h:608
The trigger matched at this point in the data feed.
Definition: libsigrok.h:162
Specification on how to connect to a device.
Definition: libsigrok.h:722
The device supports setting a pattern (pattern generator mode).
Definition: libsigrok.h:764
Information on single channel.
Definition: libsigrok.h:601
Output error messages.
Definition: libsigrok.h:96
Current limit.
Definition: libsigrok.h:881
A timeout occurred.
Definition: libsigrok.h:75
Output debug messages.
Definition: libsigrok.h:99
const void * payload
Definition: libsigrok.h:476
Channel type is analog channel.
Definition: libsigrok.h:597
int64_t p
Numerator of the rational number.
Definition: libsigrok.h:468
Voltage in decibel, referenced to 1 volt (dBV).
Definition: libsigrok.h:272
Data is invalid.
Definition: libsigrok.h:77
The device supports setting a probe factor.
Definition: libsigrok.h:1010
sr_configkey
Configuration keys.
Definition: libsigrok.h:666
The device can act as a programmable power supply.
Definition: libsigrok.h:697
Enabling/disabling channel.
Definition: libsigrok.h:889
Over-voltage protection (OVP) threshold.
Definition: libsigrok.h:922
sr_output_flag
Output module flags.
Definition: libsigrok.h:580
Time base.
Definition: libsigrok.h:791
Ohm (resistance).
Definition: libsigrok.h:247
struct sr_analog_spec * spec
Definition: libsigrok.h:521
Center frequency.
Definition: libsigrok.h:845
Value can be read.
Definition: libsigrok.h:658
Real power [W].
Definition: libsigrok.h:292
Possible values can be enumerated.
Definition: libsigrok.h:662
Relative humidity assuming air temperature of 293 Kelvin (rF).
Definition: libsigrok.h:300
int unit
Unit in which the MQ is measured.
Definition: libsigrok.h:507
Device-instance type for user-created "devices".
Definition: libsigrok.h:1070
The device instance is actively in use in a session.
Definition: libsigrok.h:1084
Wind speed.
Definition: libsigrok.h:205
A channel to match and what to match it on.
Definition: libsigrok.h:422
int(* sr_receive_data_callback)(int fd, int revents, void *cb_data)
Type definition for callback function for data reception.
Definition: libsigrok.h:134
GSList * channels
List of sr_channel structs of the channels belonging to this group.
Definition: libsigrok.h:622
Time.
Definition: libsigrok.h:203
void * priv
Private data for driver use.
Definition: libsigrok.h:624
Datafeed payload for type SR_DF_META.
Definition: libsigrok.h:486
struct sr_rational scale
Definition: libsigrok.h:531
Parallel resistance (LCR meter model).
Definition: libsigrok.h:213
Input/output error.
Definition: libsigrok.h:78
Series resistance (LCR meter model).
Definition: libsigrok.h:219
GSList * config
Definition: libsigrok.h:487
int(* cleanup)(const struct sr_dev_driver *driver)
Called before driver is unloaded.
Definition: libsigrok.h:1102
Header of a sigrok data feed.
Definition: libsigrok.h:480
Sound pressure level, in decibels, relative to 20 micropascals.
Definition: libsigrok.h:280
Parallel capacitance (LCR meter model).
Definition: libsigrok.h:211
The device can measure humidity.
Definition: libsigrok.h:688
Device is in "max" mode, only updating upon a new max value.
Definition: libsigrok.h:347
The device instance is live, but not in use.
Definition: libsigrok.h:1082
int stage
Starts at 0.
Definition: libsigrok.h:416
Device is in relative mode.
Definition: libsigrok.h:353
The device supports setting a frame limit (how many frames should be acquired).
Definition: libsigrok.h:1032
The device can act as an electronic load.
Definition: libsigrok.h:703
enum sr_unit unit
Definition: libsigrok.h:537
The device supports setting its samplerate, in Hz.
Definition: libsigrok.h:758
Value can be written.
Definition: libsigrok.h:660
The device instance was found, but is still booting.
Definition: libsigrok.h:1080
Current current.
Definition: libsigrok.h:873
sr_keytype
Definition: libsigrok.h:635
Device instance type for serial port devices.
Definition: libsigrok.h:1066
Boolean value.
Definition: libsigrok.h:261
int(* config_set)(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
Set value of a configuration key in driver or a given device instance.
Definition: libsigrok.h:1125
Opaque structure representing a libsigrok context.
Session filename.
Definition: libsigrok.h:984
sr_error_code
Status/error codes returned by libsigrok functions.
Definition: libsigrok.h:66
int(* init)(struct sr_dev_driver *driver, struct sr_context *sr_ctx)
Called when driver is loaded, e.g.
Definition: libsigrok.h:1099
Phase angle.
Definition: libsigrok.h:225
GSList * stages
List of pointers to struct sr_trigger_stage.
Definition: libsigrok.h:410
Measurements that intrinsically do not have units attached, such as ratios, gains, etc.
Definition: libsigrok.h:278
Mass in carat [ct].
Definition: libsigrok.h:308
struct timeval starttime
Definition: libsigrok.h:482
Maximum target voltage.
Definition: libsigrok.h:866
void * handle
File handle or equivalent; set by resource open callback.
Definition: libsigrok.h:574
Reference value shown.
Definition: libsigrok.h:383
Sound pressure level is not weighted in the frequency domain, albeit without standards-defined low an...
Definition: libsigrok.h:365
Device is in "avg" mode, averaging upon each new value.
Definition: libsigrok.h:381
The device is winding down its session.
Definition: libsigrok.h:1086
struct sr_dev_inst * sdi
The device this channel is attached to.
Definition: libsigrok.h:603
Device mode for multi-function devices.
Definition: libsigrok.h:1046
End of frame.
Definition: libsigrok.h:170
uint64_t size
Size of resource in bytes; set by resource open callback.
Definition: libsigrok.h:572
int datatype
Data type like SR_T_STRING, etc if applicable.
Definition: libsigrok.h:646
The device can measure temperature.
Definition: libsigrok.h:685
void * context
Device driver context, considered private.
Definition: libsigrok.h:1156
Serial communication specification, in the form:
Definition: libsigrok.h:743
int index
The index of this channel, starting at 0.
Definition: libsigrok.h:606
Apparent power.
Definition: libsigrok.h:233
Header file containing API function prototypes.
int(* dev_close)(struct sr_dev_inst *sdi)
Close device.
Definition: libsigrok.h:1146
uint32_t key
Config key like SR_CONF_CONN, etc.
Definition: libsigrok.h:630
The device can act as an oscilloscope.
Definition: libsigrok.h:673
Measured quantity.
Definition: libsigrok.h:971
Information about a key.
Definition: libsigrok.h:642
Series inductance (LCR meter model).
Definition: libsigrok.h:215
Revolutions per minute.
Definition: libsigrok.h:288
Max hold mode.
Definition: libsigrok.h:824
int(* config_list)(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
List all possible values for a configuration key in a device instance.
Definition: libsigrok.h:1138
Mass in troy ounce [oz t].
Definition: libsigrok.h:312
Apparent power [VA].
Definition: libsigrok.h:290
Payload is struct sr_datafeed_meta.
Definition: libsigrok.h:160
Series capacitance (LCR meter model).
Definition: libsigrok.h:217
Mass in grain [gr].
Definition: libsigrok.h:318
Normalized (0 to 1) concentration of a substance or compound with 0 representing a concentration of 0...
Definition: libsigrok.h:286
Plane angle in 1/360th of a full circle.
Definition: libsigrok.h:302
Output no messages at all.
Definition: libsigrok.h:95
struct sr_channel * channel
The channel to trigger on.
Definition: libsigrok.h:424
Sound pressure level measurement is S-weighted (1s) in the time domain.
Definition: libsigrok.h:368
Henry (inductance).
Definition: libsigrok.h:304
Incorrect samplerate.
Definition: libsigrok.h:72
sr_mq
Measured quantity, sr_analog_meaning.mq.
Definition: libsigrok.h:178
int(* dev_clear)(const struct sr_dev_driver *driver)
Clear list of devices the driver knows about.
Definition: libsigrok.h:1116
DEPRECATED! Use SR_DF_ANALOG instead.
Definition: libsigrok.h:166
Payload is struct sr_datafeed_analog.
Definition: libsigrok.h:172
Payload is struct sr_datafeed_logic.
Definition: libsigrok.h:164
Duty cycle, e.g.
Definition: libsigrok.h:186
int num_samples
Number of samples in data.
Definition: libsigrok.h:502
Output very noisy debug messages.
Definition: libsigrok.h:100
Gain (a transistor's gain, or hFE, for example).
Definition: libsigrok.h:194
int(* dev_open)(struct sr_dev_inst *sdi)
Open device.
Definition: libsigrok.h:1144
The device supports setting number of samples to be averaged over.
Definition: libsigrok.h:779
The device instance was not found.
Definition: libsigrok.h:1078
Over-current protection (OCP) feature.
Definition: libsigrok.h:930
Channel type is logic channel.
Definition: libsigrok.h:595
Resource descriptor.
Definition: libsigrok.h:570
Power factor.
Definition: libsigrok.h:231
Function argument error.
Definition: libsigrok.h:70
const char * description
Verbose description (unused currently).
Definition: libsigrok.h:652
Volts/div.
Definition: libsigrok.h:797
gboolean is_signed
Definition: libsigrok.h:526
GSList * matches
List of pointers to struct sr_trigger_match.
Definition: libsigrok.h:418
Used for setting or getting value of a config item.
Definition: libsigrok.h:628