Developers

This page contains documentation and resources for aspiring sigrok developers.

Source code browser

• gitweb

Tutorials and API descriptions

• libsigrok API
• Protocol decoder HOWTO
• Protocol decoder API
• Formats and structures
• Hardware plugin API
• Input API
• Output API
• IO API (outdated)

Development guidelines

Please check the respective sub-project's HACKING file for coding guidelines and development tips.

• libsigrok
• libsigrokdecode
• sigrok-cli
• sigrok-qt
• sigrok-gtk
• PulseView
• sigrok-firmware-fx2lafw

Design pages

This is a list of pages we use while working through new features or designs. They are working documents, not official API or feature documentation.

• New trigger specification
• GUI design
• High precision analog

Debugging

If you would like to see the output of the sr_dbg() or sr_err() functions you can use one of the following sigrok-cli options:

$ export SIGROK_DEBUG=1
$ sigrok-cli -l 5 <options> 

Release process

See Release process.