Difference between revisions of "Input output formats"

From sigrok
Jump to navigation Jump to search
(gnuplot has been removed, the csv output module can be used for that as well.)
(14 intermediate revisions by 5 users not shown)
Line 5: Line 5:
{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
|-
!Name
! style="width: 8em;" | Name
!Input
!Input
!Output
!Output
Line 13: Line 13:
| bgcolor="yellow" | —
| bgcolor="yellow" | —
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| Analog data and types.
| Text output of analog data and types.
|-
|-
| [[File format:ascii|ASCII]]
| [[File format:ascii|ASCII]]
Line 30: Line 30:
| 0/1 digits.
| 0/1 digits.
|-
|-
| [[File format:chronovu_la8|ChronoVu LA8]]
| style="white-space: nowrap;" | [[File format:chronovu_la8|ChronoVu LA8]]
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| bgcolor="lime" | supported
Line 38: Line 38:
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| Comma-separated values.
| Comma-separated values (also usable for generating data and config files for gnuplot).
|-
| [[File format:gnuplot|gnuplot]]
| bgcolor="yellow" | —
| bgcolor="lime" | supported
| Gnuplot data file format (tab-separated columns of '1' and '0' characters). You need another gnuplot input file such as [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=contrib/gnuplot_usbeesx.gpi this one] in addition.
|-
|-
| [[File format:hex|hex]]
| [[File format:hex|hex]]
Line 69: Line 64:
| bgcolor="lime" | supported
| bgcolor="lime" | supported
| The [http://en.wikipedia.org/wiki/WAV waveform audio] (WAV) file format.
| The [http://en.wikipedia.org/wiki/WAV waveform audio] (WAV) file format.
|-
| [[File format:raw_analog|Raw analog]]
| bgcolor="lime" | supported
| bgcolor="yellow" | —
| Analog signals without header (configurable sample size, format, and endianness).
|-
| [[File format:trace32_ad|Lauterbach Trace32]]
| bgcolor="lime" | supported
| bgcolor="yellow" | —
| The Lauterbach Trace32 logic analyzer data file format.
|}


== Supported transform modules ==
{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
! style="width: 8em;" | Name
!Description
|-
| nop
| Do nothing.
|-
| scale
| Scale analog values by a specified factor.
|-
| invert
| Invert values.
|}
|}


Line 85: Line 108:
| Used by the [[Rigol DP800 series]] power supplies.
| Used by the [[Rigol DP800 series]] power supplies.
|-
|-
| Rigol RAF
| [[File format:rigol_raf|Rigol RAF]]
| Used by the Rigol DG1000Z, DG4000, and DG5000 series signal generators. See [http://www.batronix.com/pdf/Rigol/UserGuide/DG1000Z_UserGuide_EN.pdf DG1000Z User Guide] page 2-75, also [http://www.eevblog.com/forum/testgear/rigol-dg4000-series-raf-file-format/msg559443/ this post] at eevblog.
| Used by the Rigol DG1000Z, DG4000, and DG5000 series signal generators. See [http://www.batronix.com/pdf/Rigol/UserGuide/DG1000Z_UserGuide_EN.pdf DG1000Z User Guide] page 2-75, also [http://www.eevblog.com/forum/testgear/rigol-dg4000-series-raf-file-format/msg559443/ this post] at eevblog.
|-
| Vector MDF (v3.3) / ASAM MDF (v4.x)
| Automotive industry standard format. Docs can be found [http://vector.com/vi_mdf_de.html here] and [http://vector.com/downloads/mdf_specification.pdf here]. Validator is [http://vector.com/downloads/MDFValidator2.1.8.zip here]. Some code is [https://code.google.com/p/mdfreader/ here] and [http://sourceforge.net/p/mdfdatafile/code/HEAD/tree/ here].
|-
| [http://en.wikipedia.org/wiki/Comtrade COMTRADE]
| File format used by devices in power engineering (e.g. protective relays, fault recorders). Can contain digital and analog data with constant or variable sample rate.
|-
| [[File format:pwl|PWL]]
| Trivial file format that can be used to define the signal of voltage/current sources in a SPICE simulation.
|-
| [[File format:tektronix_wfm|Tektronix WFM]]
| Used by the Tektronix TDS series oscilloscopes. A parser for Matlab can be found [http://www.mathworks.com/matlabcentral/fileexchange/5873-tektronix-binary-file-readers/content/wfmread.m here].
|}
|}

Revision as of 00:05, 5 September 2016

libsigrok supports a number of different input modules (a.k.a. file formats) and output modules, and has a generic API which allows easily adding more input/output modules.

Supported input/output formats

Name Input Output Description
Analog — supported Text output of analog data and types.
ASCII — supported ASCII art.
Binary supported supported Raw binary data output without any metadata attached.
Bits — supported 0/1 digits.
ChronoVu LA8 supported supported ChronoVu LA8 software file format (usually with .kdt file extension).
CSV supported supported Comma-separated values (also usable for generating data and config files for gnuplot).
hex — supported Hexadecimal digits.
ols — supported The file format used by the "Alternative" Java client for the Openbench Logic Sniffer.
srzip supported supported The current (v2) sigrok session file format (*.sr).
VCD supported supported The Value Change Dump format (can also be visualized in gtkwave, for instance).
WAV supported supported The waveform audio (WAV) file format.
Raw analog supported — Analog signals without header (configurable sample size, format, and endianness).
Lauterbach Trace32 supported — The Lauterbach Trace32 logic analyzer data file format.

Supported transform modules

Name Description
nop Do nothing.
scale Scale analog values by a specified factor.
invert Invert values.

Possible candidates for future input/output formats

Name Description
Scanalogic Used by the IKALOGIC Scanalogic-2 and IKALOGIC ScanaPLUS logic analyzers.
Rigol ROF Used by the Rigol DP800 series power supplies.
Rigol RAF Used by the Rigol DG1000Z, DG4000, and DG5000 series signal generators. See DG1000Z User Guide page 2-75, also this post at eevblog.
Vector MDF (v3.3) / ASAM MDF (v4.x) Automotive industry standard format. Docs can be found here and here. Validator is here. Some code is here and here.
COMTRADE File format used by devices in power engineering (e.g. protective relays, fault recorders). Can contain digital and analog data with constant or variable sample rate.
PWL Trivial file format that can be used to define the signal of voltage/current sources in a SPICE simulation.
Tektronix WFM Used by the Tektronix TDS series oscilloscopes. A parser for Matlab can be found here.
Retrieved from "https://sigrok.org/w/index.php?title=Input_output_formats&oldid=11906"