Difference between revisions of "Libsigrokdecode"

From sigrok
Jump to navigation Jump to search
m (API docs)
(Python version is old, so no underscores in literals, f-strings, etc.)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:libsigrokdecode}}
{{DISPLAYTITLE:libsigrokdecode}}
'''libsigrokdecode''' is a shared library written in C, which provides (streaming) protocol decoding functionality.
'''libsigrokdecode''' (sometimes abbreviated as "srd") is a shared library written in C, which provides (streaming) protocol decoding functionality.


The [[protocol decoders]] are written in Python (>= 3.0).
It is licensed under the terms of the '''GNU GPL, version 3 or later'''.
 
The [[protocol decoders]] are written in Python 3 (>=3.2, <3.6).


== Getting the code ==
== Getting the code ==
Line 16: Line 18:
== Building from source ==
== Building from source ==


See the respective OS-specific page, e.g. [[Linux]], [[Windows]], [[Mac OS X]], or [[FreeBSD]].
See [[Building]].


== Supported protocol decoders ==
== Supported protocol decoders ==


The libsigrokdecode library ships with a collection of various protocol decoders out of the box (but you can write your own too, of course).
The libsigrokdecode library ships with a collection of various protocol decoders out of the box (but you can write your own too, of course; see [[Protocol decoder HOWTO]] and [[Protocol decoder API]] for details).


See [[Protocol decoders]] for the list of currently supported ones (and others we might support in the future).
See [[Protocol decoders]] for the list of currently supported ones (and others we might support in the future).

Latest revision as of 23:35, 18 January 2022

libsigrokdecode (sometimes abbreviated as "srd") is a shared library written in C, which provides (streaming) protocol decoding functionality.

It is licensed under the terms of the GNU GPL, version 3 or later.

The protocol decoders are written in Python 3 (>=3.2, <3.6).

Getting the code

$ git clone git://sigrok.org/libsigrokdecode

You can also browse the source code via gitweb.

Distribution packages

See Downloads.

Building from source

See Building.

Supported protocol decoders

The libsigrokdecode library ships with a collection of various protocol decoders out of the box (but you can write your own too, of course; see Protocol decoder HOWTO and Protocol decoder API for details).

See Protocol decoders for the list of currently supported ones (and others we might support in the future).

Resources