libsigrok  0.5.2
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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_C(1000))
88 #define SR_MHZ(n) ((n) * UINT64_C(1000000))
89 #define SR_GHZ(n) ((n) * UINT64_C(1000000000))
90 
91 #define SR_HZ_TO_NS(n) (UINT64_C(1000000000) / (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  /** Beginning of frame. No payload. */
167  /** End of frame. No payload. */
169  /** Payload is struct sr_datafeed_analog. */
171 
172  /* Update datafeed_dump() (session.c) upon changes! */
173 };
174 
175 /** Measured quantity, sr_analog_meaning.mq. */
176 enum sr_mq {
177  SR_MQ_VOLTAGE = 10000,
183  /** Duty cycle, e.g. on/off ratio. */
185  /** Continuity test. */
189  /** Electrical power, usually in W, or dBm. */
191  /** Gain (a transistor's gain, or hFE, for example). */
193  /** Logarithmic representation of sound pressure relative to a
194  * reference value. */
196  /** Carbon monoxide level */
198  /** Humidity */
200  /** Time */
202  /** Wind speed */
204  /** Pressure */
206  /** Parallel inductance (LCR meter model). */
208  /** Parallel capacitance (LCR meter model). */
210  /** Parallel resistance (LCR meter model). */
212  /** Series inductance (LCR meter model). */
214  /** Series capacitance (LCR meter model). */
216  /** Series resistance (LCR meter model). */
218  /** Dissipation factor. */
220  /** Quality factor. */
222  /** Phase angle. */
224  /** Difference from reference value. */
226  /** Count. */
228  /** Power factor. */
230  /** Apparent power */
232  /** Mass */
234  /** Harmonic ratio */
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 (dBm).
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  /** Measurement is four wire (e.g. Kelvin connection). */
388 
389  /*
390  * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
391  * upon changes!
392  */
393 };
394 
403 };
404 
405 /** The representation of a trigger, consisting of one or more stages
406  * containing one or more matches on a channel.
407  */
408 struct sr_trigger {
409  /** A name for this trigger. This may be NULL if none is needed. */
410  char *name;
411  /** List of pointers to struct sr_trigger_stage. */
412  GSList *stages;
413 };
414 
415 /** A trigger stage. */
417  /** Starts at 0. */
418  int stage;
419  /** List of pointers to struct sr_trigger_match. */
420  GSList *matches;
421 };
422 
423 /** A channel to match and what to match it on. */
425  /** The channel to trigger on. */
427  /** The trigger match to use.
428  * For logic channels, only the following matches may be used:
429  * SR_TRIGGER_ZERO
430  * SR_TRIGGER_ONE
431  * SR_TRIGGER_RISING
432  * SR_TRIGGER_FALLING
433  * SR_TRIGGER_EDGE
434  *
435  * For analog channels, only these matches may be used:
436  * SR_TRIGGER_RISING
437  * SR_TRIGGER_FALLING
438  * SR_TRIGGER_OVER
439  * SR_TRIGGER_UNDER
440  *
441  */
442  int match;
443  /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
444  * this contains the value to compare against. */
445  float value;
446 };
447 
448 /**
449  * @struct sr_context
450  * Opaque structure representing a libsigrok context.
451  *
452  * None of the fields of this structure are meant to be accessed directly.
453  *
454  * @see sr_init(), sr_exit().
455  */
456 struct sr_context;
457 
458 /**
459  * @struct sr_session
460  * Opaque structure representing a libsigrok session.
461  *
462  * None of the fields of this structure are meant to be accessed directly.
463  *
464  * @see sr_session_new(), sr_session_destroy().
465  */
466 struct sr_session;
467 
468 struct sr_rational {
469  /** Numerator of the rational number. */
470  int64_t p;
471  /** Denominator of the rational number. */
472  uint64_t q;
473 };
474 
475 /** Packet in a sigrok data feed. */
477  uint16_t type;
478  const void *payload;
479 };
480 
481 /** Header of a sigrok data feed. */
484  struct timeval starttime;
485 };
486 
487 /** Datafeed payload for type SR_DF_META. */
489  GSList *config;
490 };
491 
492 /** Logic datafeed payload for type SR_DF_LOGIC. */
494  uint64_t length;
495  uint16_t unitsize;
496  void *data;
497 };
498 
499 /** Analog datafeed payload for type SR_DF_ANALOG. */
501  void *data;
502  uint32_t num_samples;
506 };
507 
509  uint8_t unitsize;
510  gboolean is_signed;
511  gboolean is_float;
512  gboolean is_bigendian;
513  /**
514  * Number of significant digits after the decimal point if positive,
515  * or number of non-significant digits before the decimal point if
516  * negative (refers to the value we actually read on the wire).
517  */
518  int8_t digits;
522 };
523 
525  enum sr_mq mq;
526  enum sr_unit unit;
528  GSList *channels;
529 };
530 
532  /**
533  * Number of significant digits after the decimal point if positive,
534  * or number of non-significant digits before the decimal point if
535  * negative (refers to vendor specifications/datasheet or actual
536  * device display).
537  */
538  int8_t spec_digits;
539 };
540 
541 /** Generic option struct used by various subsystems. */
542 struct sr_option {
543  /* Short name suitable for commandline usage, [a-z0-9-]. */
544  const char *id;
545  /* Short name suitable for GUI usage, can contain UTF-8. */
546  const char *name;
547  /* Description of the option, in a sentence. */
548  const char *desc;
549  /* Default value for this option. */
550  GVariant *def;
551  /* List of possible values, if this is an option with few values. */
552  GSList *values;
553 };
554 
555 /** Resource type.
556  * @since 0.4.0
557  */
560 };
561 
562 /** Resource descriptor.
563  * @since 0.4.0
564  */
565 struct sr_resource {
566  /** Size of resource in bytes; set by resource open callback. */
567  uint64_t size;
568  /** File handle or equivalent; set by resource open callback. */
569  void *handle;
570  /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
571  int type;
572 };
573 
574 /** Output module flags. */
576  /** If set, this output module writes the output itself. */
578 };
579 
580 struct sr_input;
581 struct sr_input_module;
582 struct sr_output;
583 struct sr_output_module;
584 struct sr_transform;
585 struct sr_transform_module;
586 
587 /** Constants for channel type. */
589  /** Channel type is logic channel. */
591  /** Channel type is analog channel. */
593 };
594 
595 /** Information on single channel. */
596 struct sr_channel {
597  /** The device this channel is attached to. */
598  struct sr_dev_inst *sdi;
599  /** The index of this channel, starting at 0. Logic channels will
600  * be encoded according to this index in SR_DF_LOGIC packets. */
601  int index;
602  /** Channel type (SR_CHANNEL_LOGIC, ...) */
603  int type;
604  /** Is this channel enabled? */
605  gboolean enabled;
606  /** Name of channel. */
607  char *name;
608  /** Private data for driver use. */
609  void *priv;
610 };
611 
612 /** Structure for groups of channels that have common properties. */
614  /** Name of the channel group. */
615  char *name;
616  /** List of sr_channel structs of the channels belonging to this group. */
617  GSList *channels;
618  /** Private data for driver use. */
619  void *priv;
620 };
621 
622 /** Used for setting or getting value of a config item. */
623 struct sr_config {
624  /** Config key like SR_CONF_CONN, etc. */
625  uint32_t key;
626  /** Key-specific data. */
627  GVariant *data;
628 };
629 
634 };
635 
636 /** Information about a key. */
637 struct sr_key_info {
638  /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
639  uint32_t key;
640  /** Data type like SR_T_STRING, etc if applicable. */
641  int datatype;
642  /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
643  const char *id;
644  /** Full capitalized name, e.g. "Serial communication". */
645  const char *name;
646  /** Verbose description (unused currently). */
647  const char *description;
648 };
649 
650 /** Configuration capabilities. */
652  /** Value can be read. */
653  SR_CONF_GET = (1UL << 31),
654  /** Value can be written. */
655  SR_CONF_SET = (1UL << 30),
656  /** Possible values can be enumerated. */
657  SR_CONF_LIST = (1UL << 29),
658 };
659 
660 /** Configuration keys */
662  /*--- Device classes ------------------------------------------------*/
663 
664  /** The device can act as logic analyzer. */
666 
667  /** The device can act as an oscilloscope. */
669 
670  /** The device can act as a multimeter. */
672 
673  /** The device is a demo device. */
675 
676  /** The device can act as a sound level meter. */
678 
679  /** The device can measure temperature. */
681 
682  /** The device can measure humidity. */
684 
685  /** The device can measure energy consumption. */
687 
688  /** The device can act as a signal demodulator. */
690 
691  /** The device can act as a programmable power supply. */
693 
694  /** The device can act as an LCR meter. */
696 
697  /** The device can act as an electronic load. */
699 
700  /** The device can act as a scale. */
702 
703  /** The device can act as a function generator. */
705 
706  /** The device can measure power. */
708 
709  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
710 
711  /*--- Driver scan options -------------------------------------------*/
712 
713  /**
714  * Specification on how to connect to a device.
715  *
716  * In combination with SR_CONF_SERIALCOMM, this is a serial port in
717  * the form which makes sense to the OS (e.g., /dev/ttyS0).
718  * Otherwise this specifies a USB device, either in the form of
719  * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
720  * @verbatim <vendorid>.<productid> @endverbatim
721  * (hexadecimal, e.g. 1d6b.0001).
722  */
723  SR_CONF_CONN = 20000,
724 
725  /**
726  * Serial communication specification, in the form:
727  *
728  * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
729  *
730  * Example: 9600/8n1
731  *
732  * The string may also be followed by one or more special settings,
733  * in the form "/key=value". Supported keys and their values are:
734  *
735  * rts 0,1 set the port's RTS pin to low or high
736  * dtr 0,1 set the port's DTR pin to low or high
737  * flow 0 no flow control
738  * 1 hardware-based (RTS/CTS) flow control
739  * 2 software-based (XON/XOFF) flow control
740  *
741  * This is always an optional parameter, since a driver typically
742  * knows the speed at which the device wants to communicate.
743  */
745 
746  /**
747  * Modbus slave address specification.
748  *
749  * This is always an optional parameter, since a driver typically
750  * knows the default slave address of the device.
751  */
753 
754  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
755 
756  /*--- Device (or channel group) configuration -----------------------*/
757 
758  /** The device supports setting its samplerate, in Hz. */
760 
761  /** The device supports setting a pre/post-trigger capture ratio. */
763 
764  /** The device supports setting a pattern (pattern generator mode). */
766 
767  /** The device supports run-length encoding (RLE). */
769 
770  /** The device supports setting trigger slope. */
772 
773  /** The device supports averaging. */
775 
776  /**
777  * The device supports setting number of samples to be
778  * averaged over.
779  */
781 
782  /** Trigger source. */
784 
785  /** Horizontal trigger position. */
787 
788  /** Buffer size. */
790 
791  /** Time base. */
793 
794  /** Filter. */
796 
797  /** Volts/div. */
799 
800  /** Coupling. */
802 
803  /** Trigger matches. */
805 
806  /** The device supports setting its sample interval, in ms. */
808 
809  /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
811 
812  /** Number of vertical divisions, as related to SR_CONF_VDIV. */
814 
815  /** Sound pressure level frequency weighting. */
817 
818  /** Sound pressure level time weighting. */
820 
821  /** Sound pressure level measurement range. */
823 
824  /** Max hold mode. */
826 
827  /** Min hold mode. */
829 
830  /** Logic low-high threshold range. */
832 
833  /** The device supports using an external clock. */
835 
836  /**
837  * The device supports swapping channels. Typical this is between
838  * buffered and unbuffered channels.
839  */
841 
842  /** Center frequency.
843  * The input signal is downmixed by this frequency before the ADC
844  * anti-aliasing filter.
845  */
847 
848  /** The device supports setting the number of logic channels. */
850 
851  /** The device supports setting the number of analog channels. */
853 
854  /**
855  * Current voltage.
856  * @arg type: double
857  * @arg get: get measured voltage
858  */
860 
861  /**
862  * Maximum target voltage.
863  * @arg type: double
864  * @arg get: get target voltage
865  * @arg set: change target voltage
866  */
868 
869  /**
870  * Current current.
871  * @arg type: double
872  * @arg get: get measured current
873  */
875 
876  /**
877  * Current limit.
878  * @arg type: double
879  * @arg get: get current limit
880  * @arg set: change current limit
881  */
883 
884  /**
885  * Enabling/disabling channel.
886  * @arg type: boolean
887  * @arg get: @b true if currently enabled
888  * @arg set: enable/disable
889  */
891 
892  /**
893  * Channel configuration.
894  * @arg type: string
895  * @arg get: get current setting
896  * @arg set: change current setting
897  * @arg list: array of possible values
898  */
900 
901  /**
902  * Over-voltage protection (OVP) feature
903  * @arg type: boolean
904  * @arg get: @b true if currently enabled
905  * @arg set: enable/disable
906  */
908 
909  /**
910  * Over-voltage protection (OVP) active
911  * @arg type: boolean
912  * @arg get: @b true if device has activated OVP, i.e. the output voltage
913  * exceeds the over-voltage protection threshold.
914  */
916 
917  /**
918  * Over-voltage protection (OVP) threshold
919  * @arg type: double (voltage)
920  * @arg get: get current threshold
921  * @arg set: set new threshold
922  */
924 
925  /**
926  * Over-current protection (OCP) feature
927  * @arg type: boolean
928  * @arg get: @b true if currently enabled
929  * @arg set: enable/disable
930  */
932 
933  /**
934  * Over-current protection (OCP) active
935  * @arg type: boolean
936  * @arg get: @b true if device has activated OCP, i.e. the current current
937  * exceeds the over-current protection threshold.
938  */
940 
941  /**
942  * Over-current protection (OCP) threshold
943  * @arg type: double (current)
944  * @arg get: get current threshold
945  * @arg set: set new threshold
946  */
948 
949  /** Choice of clock edge for external clock ("r" or "f"). */
951 
952  /** Amplitude of a source without strictly-defined MQ. */
954 
955  /**
956  * Channel regulation
957  * get: "CV", "CC" or "UR", denoting constant voltage, constant current
958  * or unregulated.
959  * "CC-" denotes a power supply in current sink mode (e.g. HP 66xxB).
960  * "" is used when there is no regulation, e.g. the output is disabled.
961  */
963 
964  /** Over-temperature protection (OTP) */
966 
967  /** Output frequency in Hz. */
969 
970  /** Output frequency target in Hz. */
972 
973  /** Measured quantity. */
975 
976  /** Equivalent circuit model. */
978 
979  /** Over-temperature protection (OTP) active. */
981 
982  /** Under-voltage condition. */
984 
985  /** Under-voltage condition active. */
987 
988  /** Trigger level. */
990 
991  /** Under-voltage condition threshold. */
993 
994  /**
995  * Which external clock source to use if the device supports
996  * multiple external clock channels.
997  */
999 
1000  /** Offset of a source without strictly-defined MQ. */
1002 
1003  /** The device supports setting a pattern for the logic trigger. */
1005 
1006  /** High resolution mode. */
1008 
1009  /** Peak detection. */
1011 
1012  /** Logic threshold: predefined levels (TTL, ECL, CMOS, etc). */
1014 
1015  /** Logic threshold: custom numerical value. */
1017 
1018  /** The measurement range of a DMM or the output range of a power supply. */
1020 
1021  /** The number of digits (e.g. for a DMM). */
1023 
1024  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1025 
1026  /*--- Special stuff -------------------------------------------------*/
1027 
1028  /** Session filename. */
1030 
1031  /** The device supports specifying a capturefile to inject. */
1033 
1034  /** The device supports specifying the capturefile unit size. */
1036 
1037  /** Power off the device. */
1039 
1040  /**
1041  * Data source for acquisition. If not present, acquisition from
1042  * the device is always "live", i.e. acquisition starts when the
1043  * frontend asks and the results are sent out as soon as possible.
1044  *
1045  * If present, it indicates that either the device has no live
1046  * acquisition capability (for example a pure data logger), or
1047  * there is a choice. sr_config_list() returns those choices.
1048  *
1049  * In any case if a device has live acquisition capabilities, it
1050  * is always the default.
1051  */
1053 
1054  /** The device supports setting a probe factor. */
1056 
1057  /** Number of powerline cycles for ADC integration time. */
1059 
1060  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1061 
1062  /*--- Acquisition modes, sample limiting ----------------------------*/
1063 
1064  /**
1065  * The device supports setting a sample time limit (how long
1066  * the sample acquisition should run, in ms).
1067  */
1069 
1070  /**
1071  * The device supports setting a sample number limit (how many
1072  * samples should be acquired).
1073  */
1075 
1076  /**
1077  * The device supports setting a frame limit (how many
1078  * frames should be acquired).
1079  */
1081 
1082  /**
1083  * The device supports continuous sampling. Neither a time limit
1084  * nor a sample number limit has to be supplied, it will just acquire
1085  * samples continuously, until explicitly stopped by a certain command.
1086  */
1088 
1089  /** The device has internal storage, into which data is logged. This
1090  * starts or stops the internal logging. */
1092 
1093  /** Device mode for multi-function devices. */
1095 
1096  /** Self test mode. */
1098 
1099  /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1100 };
1101 
1102 /**
1103  * Opaque structure representing a libsigrok device instance.
1104  *
1105  * None of the fields of this structure are meant to be accessed directly.
1106  */
1107 struct sr_dev_inst;
1108 
1109 /** Types of device instance, struct sr_dev_inst.type */
1111  /** Device instance type for USB devices. */
1112  SR_INST_USB = 10000,
1113  /** Device instance type for serial port devices. */
1115  /** Device instance type for SCPI devices. */
1117  /** Device-instance type for user-created "devices". */
1119  /** Device instance type for Modbus devices. */
1121 };
1122 
1123 /** Device instance status, struct sr_dev_inst.status */
1125  /** The device instance was not found. */
1127  /** The device instance was found, but is still booting. */
1129  /** The device instance is live, but not in use. */
1131  /** The device instance is actively in use in a session. */
1133  /** The device is winding down its session. */
1135 };
1136 
1137 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1139  /* Driver-specific */
1140  /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1141  const char *name;
1142  /** Long name. Verbose driver name shown to user. */
1143  const char *longname;
1144  /** API version (currently 1). */
1146  /** Called when driver is loaded, e.g. program startup. */
1147  int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1148  /** Called before driver is unloaded.
1149  * Driver must free all resources held by it. */
1150  int (*cleanup) (const struct sr_dev_driver *driver);
1151  /** Scan for devices. Driver should do all initialisation required.
1152  * Can be called several times, e.g. with different port options.
1153  * @retval NULL Error or no devices found.
1154  * @retval other GSList of a struct sr_dev_inst for each device.
1155  * Must be freed by caller!
1156  */
1157  GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1158  /** Get list of device instances the driver knows about.
1159  * @returns NULL or GSList of a struct sr_dev_inst for each device.
1160  * Must not be freed by caller!
1161  */
1162  GSList *(*dev_list) (const struct sr_dev_driver *driver);
1163  /** Clear list of devices the driver knows about. */
1164  int (*dev_clear) (const struct sr_dev_driver *driver);
1165  /** Query value of a configuration key in driver or given device instance.
1166  * @see sr_config_get().
1167  */
1168  int (*config_get) (uint32_t key, GVariant **data,
1169  const struct sr_dev_inst *sdi,
1170  const struct sr_channel_group *cg);
1171  /** Set value of a configuration key in driver or a given device instance.
1172  * @see sr_config_set(). */
1173  int (*config_set) (uint32_t key, GVariant *data,
1174  const struct sr_dev_inst *sdi,
1175  const struct sr_channel_group *cg);
1176  /** Channel status change.
1177  * @see sr_dev_channel_enable(). */
1178  int (*config_channel_set) (const struct sr_dev_inst *sdi,
1179  struct sr_channel *ch, unsigned int changes);
1180  /** Apply configuration settings to the device hardware.
1181  * @see sr_config_commit().*/
1182  int (*config_commit) (const struct sr_dev_inst *sdi);
1183  /** List all possible values for a configuration key in a device instance.
1184  * @see sr_config_list().
1185  */
1186  int (*config_list) (uint32_t key, GVariant **data,
1187  const struct sr_dev_inst *sdi,
1188  const struct sr_channel_group *cg);
1189 
1190  /* Device-specific */
1191  /** Open device */
1192  int (*dev_open) (struct sr_dev_inst *sdi);
1193  /** Close device */
1194  int (*dev_close) (struct sr_dev_inst *sdi);
1195  /** Begin data acquisition on the specified device. */
1196  int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
1197  /** End data acquisition on the specified device. */
1198  int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
1199 
1200  /* Dynamic */
1201  /** Device driver context, considered private. Initialized by init(). */
1202  void *context;
1203 };
1204 
1205 /** Serial port descriptor. */
1207  /** The OS dependent name of the serial port. */
1208  char *name;
1209  /** An end user friendly description for the serial port. */
1211 };
1212 
1213 #include <libsigrok/proto.h>
1214 #include <libsigrok/version.h>
1215 
1216 #ifdef __cplusplus
1217 }
1218 #endif
1219 
1220 #endif
void * handle
File handle or equivalent; set by resource open callback.
Definition: libsigrok.h:569
Generic/unspecified error.
Definition: libsigrok.h:68
Output frequency target in Hz.
Definition: libsigrok.h:971
Header file containing API function prototypes.
sr_dev_inst_type
Types of device instance, struct sr_dev_inst.type.
Definition: libsigrok.h:1110
Time is duration (as opposed to epoch, ...).
Definition: libsigrok.h:379
struct sr_channel * channel
The channel to trigger on.
Definition: libsigrok.h:426
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
A trigger stage.
Definition: libsigrok.h:416
sr_mqflag
Values for sr_analog_meaning.mqflags.
Definition: libsigrok.h:335
uint64_t size
Size of resource in bytes; set by resource open callback.
Definition: libsigrok.h:567
int(* config_commit)(const struct sr_dev_inst *sdi)
Apply configuration settings to the device hardware.
Definition: libsigrok.h:1182
End of frame.
Definition: libsigrok.h:168
sr_channeltype
Constants for channel type.
Definition: libsigrok.h:588
const char * name
Full capitalized name, e.g.
Definition: libsigrok.h:645
Sound pressure level is A-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:356
char * name
A name for this trigger.
Definition: libsigrok.h:410
The device can measure temperature.
Definition: libsigrok.h:680
The device supports setting the number of logic channels.
Definition: libsigrok.h:849
Logic datafeed payload for type SR_DF_LOGIC.
Definition: libsigrok.h:493
The number of digits (e.g.
Definition: libsigrok.h:1022
The device supports setting the number of analog channels.
Definition: libsigrok.h:852
The device supports setting a sample number limit (how many samples should be acquired).
Definition: libsigrok.h:1074
Apparent power.
Definition: libsigrok.h:231
The device supports run-length encoding (RLE).
Definition: libsigrok.h:768
Measurement is four wire (e.g.
Definition: libsigrok.h:387
const char * name
Definition: libsigrok.h:546
Harmonic ratio.
Definition: libsigrok.h:235
uint16_t unitsize
Definition: libsigrok.h:495
GSList * matches
List of pointers to struct sr_trigger_match.
Definition: libsigrok.h:420
The device can act as an oscilloscope.
Definition: libsigrok.h:668
void * priv
Private data for driver use.
Definition: libsigrok.h:619
int stage
Starts at 0.
Definition: libsigrok.h:418
int api_version
API version (currently 1).
Definition: libsigrok.h:1145
Degrees Fahrenheit (temperature).
Definition: libsigrok.h:255
This is a true RMS measurement.
Definition: libsigrok.h:341
The device can act as an LCR meter.
Definition: libsigrok.h:695
Payload is struct sr_datafeed_meta.
Definition: libsigrok.h:160
Under-voltage condition active.
Definition: libsigrok.h:986
Series capacitance (LCR meter model).
Definition: libsigrok.h:215
int(* config_channel_set)(const struct sr_dev_inst *sdi, struct sr_channel *ch, unsigned int changes)
Channel status change.
Definition: libsigrok.h:1178
Generic option struct used by various subsystems.
Definition: libsigrok.h:542
Normalized (0 to 1) concentration of a substance or compound with 0 representing a concentration of 0...
Definition: libsigrok.h:286
Equivalent circuit model.
Definition: libsigrok.h:977
Channel regulation get: "CV", "CC" or "UR", denoting constant voltage, constant current or unregulate...
Definition: libsigrok.h:962
Plane angle in 1/360th of a full circle.
Definition: libsigrok.h:302
Percent value.
Definition: libsigrok.h:259
Output no messages at all.
Definition: libsigrok.h:95
Sound pressure level measurement is S-weighted (1s) in the time domain.
Definition: libsigrok.h:368
Min hold mode.
Definition: libsigrok.h:828
The device supports continuous sampling.
Definition: libsigrok.h:1087
Number of vertical divisions, as related to SR_CONF_VDIV.
Definition: libsigrok.h:813
Ampere (current).
Definition: libsigrok.h:245
Payload is struct sr_datafeed_analog.
Definition: libsigrok.h:170
gboolean enabled
Is this channel enabled?
Definition: libsigrok.h:605
Payload is struct sr_datafeed_logic.
Definition: libsigrok.h:164
Duty cycle, e.g.
Definition: libsigrok.h:184
Unit of conductance, the inverse of resistance.
Definition: libsigrok.h:265
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:445
Carbon monoxide level.
Definition: libsigrok.h:197
Output very noisy debug messages.
Definition: libsigrok.h:100
const char * id
Definition: libsigrok.h:544
Sound pressure level measurement is F-weighted (125ms) in the time domain.
Definition: libsigrok.h:371
Over-current protection (OCP) feature.
Definition: libsigrok.h:931
Channel type is logic channel.
Definition: libsigrok.h:590
The device can measure power.
Definition: libsigrok.h:707
No error.
Definition: libsigrok.h:67
Degrees Celsius (temperature).
Definition: libsigrok.h:253
int match
The trigger match to use.
Definition: libsigrok.h:442
The device can act as a scale.
Definition: libsigrok.h:701
GSList * channels
Definition: libsigrok.h:528
Mass in pound [lb].
Definition: libsigrok.h:314
gboolean is_signed
Definition: libsigrok.h:510
The device supports setting a sample time limit (how long the sample acquisition should run...
Definition: libsigrok.h:1068
Data source for acquisition.
Definition: libsigrok.h:1052
int(* cleanup)(const struct sr_dev_driver *driver)
Called before driver is unloaded.
Definition: libsigrok.h:1150
Mass in momme.
Definition: libsigrok.h:322
Over-current protection (OCP) threshold.
Definition: libsigrok.h:947
Logic low-high threshold range.
Definition: libsigrok.h:831
An absolute measurement of power, in decibels, referenced to 1 milliwatt (dBm).
Definition: libsigrok.h:270
Sound pressure level is time-averaged (LAT), also known as Equivalent Continuous A-weighted Sound Lev...
Definition: libsigrok.h:374
Trigger level.
Definition: libsigrok.h:989
Device is in autoranging mode.
Definition: libsigrok.h:351
A channel to match and what to match it on.
Definition: libsigrok.h:424
uint64_t length
Definition: libsigrok.h:494
Volt.
Definition: libsigrok.h:243
Output informational messages.
Definition: libsigrok.h:98
Pieces (number of items).
Definition: libsigrok.h:326
GSList * channels
List of sr_channel structs of the channels belonging to this group.
Definition: libsigrok.h:617
Buffer size.
Definition: libsigrok.h:789
Sound pressure level is C-weighted in the frequency domain, according to IEC 61672:2003.
Definition: libsigrok.h:359
sr_output_flag
Output module flags.
Definition: libsigrok.h:575
const char * name
Driver name.
Definition: libsigrok.h:1141
char * name
The OS dependent name of the serial port.
Definition: libsigrok.h:1208
struct sr_rational scale
Definition: libsigrok.h:520
int type
Resource type (SR_RESOURCE_FIRMWARE, ...)
Definition: libsigrok.h:571
Output warnings.
Definition: libsigrok.h:97
Coupling.
Definition: libsigrok.h:801
int(* dev_open)(struct sr_dev_inst *sdi)
Open device.
Definition: libsigrok.h:1192
Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan)
Definition: libsigrok.h:320
The device is a demo device.
Definition: libsigrok.h:674
struct sr_analog_encoding * encoding
Definition: libsigrok.h:503
End of stream (no further data).
Definition: libsigrok.h:158
Device is in "min" mode, only updating upon a new min value.
Definition: libsigrok.h:349
sr_mq
Measured quantity, sr_analog_meaning.mq.
Definition: libsigrok.h:176
Electrical power, usually in W, or dBm.
Definition: libsigrok.h:190
Consumption [Wh].
Definition: libsigrok.h:294
GSList * values
Definition: libsigrok.h:552
Sound pressure level represented as a percentage of measurements that were over a preset alarm level...
Definition: libsigrok.h:377
Mass in tola.
Definition: libsigrok.h:324
Device instance type for SCPI devices.
Definition: libsigrok.h:1116
int datatype
Data type like SR_T_STRING, etc if applicable.
Definition: libsigrok.h:641
Serial port descriptor.
Definition: libsigrok.h:1206
The device supports specifying a capturefile to inject.
Definition: libsigrok.h:1032
Voltage measurement is alternating current (AC).
Definition: libsigrok.h:337
const char * longname
Long name.
Definition: libsigrok.h:1143
The device supports setting a pre/post-trigger capture ratio.
Definition: libsigrok.h:762
Power off the device.
Definition: libsigrok.h:1038
Horizontal trigger position.
Definition: libsigrok.h:786
Used for setting or getting value of a config item.
Definition: libsigrok.h:623
The device supports specifying the capturefile unit size.
Definition: libsigrok.h:1035
Output frequency in Hz.
Definition: libsigrok.h:968
Current voltage.
Definition: libsigrok.h:859
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:723
Trigger source.
Definition: libsigrok.h:783
Farad (capacity).
Definition: libsigrok.h:249
Output error messages.
Definition: libsigrok.h:96
The device can measure energy consumption.
Definition: libsigrok.h:686
Dissipation factor.
Definition: libsigrok.h:219
Count.
Definition: libsigrok.h:227
The device supports setting its sample interval, in ms.
Definition: libsigrok.h:807
enum sr_mq mq
Definition: libsigrok.h:525
Channel type is analog channel.
Definition: libsigrok.h:592
Data is invalid.
Definition: libsigrok.h:77
Device is in "hold" mode (repeating the last measurement).
Definition: libsigrok.h:345
sr_keytype
Definition: libsigrok.h:630
The device has internal storage, into which data is logged.
Definition: libsigrok.h:1091
const void * payload
Definition: libsigrok.h:478
Peak detection.
Definition: libsigrok.h:1010
int8_t spec_digits
Number of significant digits after the decimal point if positive, or number of non-significant digits...
Definition: libsigrok.h:538
enum sr_unit unit
Definition: libsigrok.h:526
Offset of a source without strictly-defined MQ.
Definition: libsigrok.h:1001
Header of a sigrok data feed.
Definition: libsigrok.h:482
Enabling/disabling channel.
Definition: libsigrok.h:890
sr_error_code
Status/error codes returned by libsigrok functions.
Definition: libsigrok.h:66
Over-voltage protection (OVP) threshold.
Definition: libsigrok.h:923
A channel group must be specified.
Definition: libsigrok.h:76
Ohm (resistance).
Definition: libsigrok.h:247
Parallel inductance (LCR meter model).
Definition: libsigrok.h:207
Possible values can be enumerated.
Definition: libsigrok.h:657
int(* dev_acquisition_start)(const struct sr_dev_inst *sdi)
Begin data acquisition on the specified device.
Definition: libsigrok.h:1196
Logic threshold: custom numerical value.
Definition: libsigrok.h:1016
void * priv
Private data for driver use.
Definition: libsigrok.h:609
Device-instance type for user-created "devices".
Definition: libsigrok.h:1118
The device instance is actively in use in a session.
Definition: libsigrok.h:1132
Wind speed.
Definition: libsigrok.h:203
Information about a key.
Definition: libsigrok.h:637
sr_unit
Unit of measured quantity, sr_analog_meaning.unit.
Definition: libsigrok.h:241
Number of powerline cycles for ADC integration time.
Definition: libsigrok.h:1058
The device can act as a function generator.
Definition: libsigrok.h:704
Device instance type for Modbus devices.
Definition: libsigrok.h:1120
Packet in a sigrok data feed.
Definition: libsigrok.h:476
If set, this output module writes the output itself.
Definition: libsigrok.h:577
Parallel resistance (LCR meter model).
Definition: libsigrok.h:211
Series resistance (LCR meter model).
Definition: libsigrok.h:217
GVariant * data
Key-specific data.
Definition: libsigrok.h:627
GSList * stages
List of pointers to struct sr_trigger_stage.
Definition: libsigrok.h:412
The device can measure humidity.
Definition: libsigrok.h:683
struct sr_analog_meaning * meaning
Definition: libsigrok.h:504
Which external clock source to use if the device supports multiple external clock channels...
Definition: libsigrok.h:998
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:1186
The device can act as a multimeter.
Definition: libsigrok.h:671
const char * description
Verbose description (unused currently).
Definition: libsigrok.h:647
Not applicable.
Definition: libsigrok.h:73
The device supports using an external clock.
Definition: libsigrok.h:834
Resource descriptor.
Definition: libsigrok.h:565
Hertz (frequency, 1/s, [Hz]).
Definition: libsigrok.h:257
Channel configuration.
Definition: libsigrok.h:899
Mass.
Definition: libsigrok.h:233
The device supports setting its samplerate, in Hz.
Definition: libsigrok.h:759
int(* dev_clear)(const struct sr_dev_driver *driver)
Clear list of devices the driver knows about.
Definition: libsigrok.h:1164
Structure for groups of channels that have common properties.
Definition: libsigrok.h:613
The device instance was found, but is still booting.
Definition: libsigrok.h:1128
The device can act as logic analyzer.
Definition: libsigrok.h:665
The device can act as a signal demodulator.
Definition: libsigrok.h:689
Current current.
Definition: libsigrok.h:874
Device instance type for serial port devices.
Definition: libsigrok.h:1114
int(* sr_receive_data_callback)(int fd, int revents, void *cb_data)
Type definition for callback function for data reception.
Definition: libsigrok.h:134
Boolean value.
Definition: libsigrok.h:261
Amplitude of a source without strictly-defined MQ.
Definition: libsigrok.h:953
Kelvin (temperature).
Definition: libsigrok.h:251
Malloc/calloc/realloc error.
Definition: libsigrok.h:69
Continuity test.
Definition: libsigrok.h:186
int type
Channel type (SR_CHANNEL_LOGIC, ...)
Definition: libsigrok.h:603
Phase angle.
Definition: libsigrok.h:223
char * description
An end user friendly description for the serial port.
Definition: libsigrok.h:1210
The representation of a trigger, consisting of one or more stages containing one or more matches on a...
Definition: libsigrok.h:408
Over-voltage protection (OVP) active.
Definition: libsigrok.h:915
The device supports averaging.
Definition: libsigrok.h:774
Modbus slave address specification.
Definition: libsigrok.h:752
Device is closed, but must be open.
Definition: libsigrok.h:74
sr_configcap
Configuration capabilities.
Definition: libsigrok.h:651
Mass in carat [ct].
Definition: libsigrok.h:308
The device supports swapping channels.
Definition: libsigrok.h:840
int(* dev_acquisition_stop)(struct sr_dev_inst *sdi)
End data acquisition on the specified device.
Definition: libsigrok.h:1198
Maximum target voltage.
Definition: libsigrok.h:867
char * name
Name of the channel group.
Definition: libsigrok.h:615
Pressure.
Definition: libsigrok.h:205
char * name
Name of channel.
Definition: libsigrok.h:607
gboolean is_digits_decimal
Definition: libsigrok.h:519
Device is in "avg" mode, averaging upon each new value.
Definition: libsigrok.h:381
Quality factor.
Definition: libsigrok.h:221
The device is winding down its session.
Definition: libsigrok.h:1134
Sound pressure level time weighting.
Definition: libsigrok.h:819
Device mode for multi-function devices.
Definition: libsigrok.h:1094
Version number definitions and macros.
Voltage measurement is direct current (DC).
Definition: libsigrok.h:339
The device can act as a sound level meter.
Definition: libsigrok.h:677
Pressure in hectopascal.
Definition: libsigrok.h:298
Filter.
Definition: libsigrok.h:795
The device supports setting trigger slope.
Definition: libsigrok.h:771
Serial communication specification, in the form:
Definition: libsigrok.h:744
Device driver data.
Definition: libsigrok.h:1138
struct sr_analog_spec * spec
Definition: libsigrok.h:505
void * context
Device driver context, considered private.
Definition: libsigrok.h:1202
int(* dev_close)(struct sr_dev_inst *sdi)
Close device.
Definition: libsigrok.h:1194
uint64_t q
Denominator of the rational number.
Definition: libsigrok.h:472
struct sr_dev_inst * sdi
The device this channel is attached to.
Definition: libsigrok.h:598
sr_datatype
Data types used by sr_config_info().
Definition: libsigrok.h:137
Datafeed payload for type SR_DF_META.
Definition: libsigrok.h:488
Measured quantity.
Definition: libsigrok.h:974
uint32_t key
Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc.
Definition: libsigrok.h:639
Series inductance (LCR meter model).
Definition: libsigrok.h:213
Revolutions per minute.
Definition: libsigrok.h:288
Max hold mode.
Definition: libsigrok.h:825
sr_packettype
Value for sr_datafeed_packet.type.
Definition: libsigrok.h:154
Mass in troy ounce [oz t].
Definition: libsigrok.h:312
Apparent power [VA].
Definition: libsigrok.h:290
Payload is sr_datafeed_header.
Definition: libsigrok.h:156
Mass in grain [gr].
Definition: libsigrok.h:318
High resolution mode.
Definition: libsigrok.h:1007
Henry (inductance).
Definition: libsigrok.h:304
Incorrect samplerate.
Definition: libsigrok.h:72
The device supports setting a pattern (pattern generator mode).
Definition: libsigrok.h:765
The measurement range of a DMM or the output range of a power supply.
Definition: libsigrok.h:1019
Current limit.
Definition: libsigrok.h:882
A timeout occurred.
Definition: libsigrok.h:75
Output debug messages.
Definition: libsigrok.h:99
Gain (a transistor's gain, or hFE, for example).
Definition: libsigrok.h:192
The device supports setting number of samples to be averaged over.
Definition: libsigrok.h:780
int64_t p
Numerator of the rational number.
Definition: libsigrok.h:470
The device instance was not found.
Definition: libsigrok.h:1126
Voltage in decibel, referenced to 1 volt (dBV).
Definition: libsigrok.h:272
Analog datafeed payload for type SR_DF_ANALOG.
Definition: libsigrok.h:500
Power factor.
Definition: libsigrok.h:229
Function argument error.
Definition: libsigrok.h:70
Volts/div.
Definition: libsigrok.h:798
The device supports setting a probe factor.
Definition: libsigrok.h:1055
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:1173
GSList * config
Definition: libsigrok.h:489
struct sr_rational offset
Definition: libsigrok.h:521
sr_dev_inst_status
Device instance status, struct sr_dev_inst.status.
Definition: libsigrok.h:1124
The device can act as a programmable power supply.
Definition: libsigrok.h:692
int index
The index of this channel, starting at 0.
Definition: libsigrok.h:601
Sound pressure level is Z-weighted (i.e.
Definition: libsigrok.h:362
Time base.
Definition: libsigrok.h:792
Device instance type for USB devices.
Definition: libsigrok.h:1112
sr_loglevel
libsigrok loglevels.
Definition: libsigrok.h:94
Center frequency.
Definition: libsigrok.h:846
Value can be read.
Definition: libsigrok.h:653
Real power [W].
Definition: libsigrok.h:292
enum sr_mqflag mqflags
Definition: libsigrok.h:527
The device supports setting a pattern for the logic trigger.
Definition: libsigrok.h:1004
int(* init)(struct sr_dev_driver *driver, struct sr_context *sr_ctx)
Called when driver is loaded, e.g.
Definition: libsigrok.h:1147
Relative humidity assuming air temperature of 293 Kelvin (rF).
Definition: libsigrok.h:300
struct timeval starttime
Definition: libsigrok.h:484
uint32_t key
Config key like SR_CONF_CONN, etc.
Definition: libsigrok.h:625
Over-temperature protection (OTP)
Definition: libsigrok.h:965
sr_trigger_matches
Definition: libsigrok.h:395
Under-voltage condition.
Definition: libsigrok.h:983
sr_resource_type
Resource type.
Definition: libsigrok.h:558
Logic threshold: predefined levels (TTL, ECL, CMOS, etc).
Definition: libsigrok.h:1013
Over-voltage protection (OVP) feature.
Definition: libsigrok.h:907
Difference from reference value.
Definition: libsigrok.h:225
Time.
Definition: libsigrok.h:201
Over-temperature protection (OTP) active.
Definition: libsigrok.h:980
Input/output error.
Definition: libsigrok.h:78
Value is voltage drop across a diode, or NAN.
Definition: libsigrok.h:343
Sound pressure level, in decibels, relative to 20 micropascals.
Definition: libsigrok.h:280
Parallel capacitance (LCR meter model).
Definition: libsigrok.h:209
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:1168
Mass in pennyweight [dwt].
Definition: libsigrok.h:316
Sound pressure level measurement range.
Definition: libsigrok.h:822
const char * id
Short, lowercase ID string, e.g.
Definition: libsigrok.h:643
Device is in "max" mode, only updating upon a new max value.
Definition: libsigrok.h:347
const char * desc
Definition: libsigrok.h:548
The device instance is live, but not in use.
Definition: libsigrok.h:1130
Information on single channel.
Definition: libsigrok.h:596
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:1080
uint32_t num_samples
Definition: libsigrok.h:502
Time in seconds.
Definition: libsigrok.h:263
Beginning of frame.
Definition: libsigrok.h:166
Logarithmic representation of sound pressure relative to a reference value.
Definition: libsigrok.h:195
The device can act as an electronic load.
Definition: libsigrok.h:698
Self test mode.
Definition: libsigrok.h:1097
Value can be written.
Definition: libsigrok.h:655
Under-voltage condition threshold.
Definition: libsigrok.h:992
gboolean is_float
Definition: libsigrok.h:511
Sound pressure level frequency weighting.
Definition: libsigrok.h:816
Errors hinting at internal bugs.
Definition: libsigrok.h:71
Wind speed in meters per second.
Definition: libsigrok.h:296
GVariant * def
Definition: libsigrok.h:550
gboolean is_bigendian
Definition: libsigrok.h:512
sr_configkey
Configuration keys.
Definition: libsigrok.h:661
Trigger matches.
Definition: libsigrok.h:804
Opaque structure representing a libsigrok session.
Definition: libsigrok.h:456
int8_t digits
Number of significant digits after the decimal point if positive, or number of non-significant digits...
Definition: libsigrok.h:518
Number of horizontal divisions, as related to SR_CONF_TIMEBASE.
Definition: libsigrok.h:810
Session filename.
Definition: libsigrok.h:1029
Mass in ounce [oz].
Definition: libsigrok.h:310
Measurements that intrinsically do not have units attached, such as ratios, gains, etc.
Definition: libsigrok.h:278
Opaque structure representing a libsigrok context.
Over-current protection (OCP) active.
Definition: libsigrok.h:939
Choice of clock edge for external clock ("r" or "f").
Definition: libsigrok.h:950
Unstable value (hasn't settled yet).
Definition: libsigrok.h:385
Mass in gram [g].
Definition: libsigrok.h:306