Introduction to sigrok

sigrok is a powerful suite of open source, cross platform software designed to interface to various types of device such as logic analyzers, oscillioscopes, multimeters and various other data capture devices. It has been produced by Bert Vermuelen, Uwe Hermann, myself Joel Holdsworth, Martin Ling, and a large community of contributors.

In this short introduction, I want to demostrate some of the useful features that sigrok has for signal capture and analysis with low cost logic analyzers.

Logic Capture and Analysis

1. Capturing Signals

The lowest cost logic analyzer products are devices based on the Cypress FX2 microcontroller. With fx2lafw, sigrok's open source runtime firmware, any device containing an FX2 can become a powerful streaming logic analyzer.

A variety of compatible low cost chinese made logic analyzer products are available for as little as $10.

usbee_ax_clone_front.jpg

These can be found on the following sites, by searching for 24MHz Logic Analyzer:

lcsoft-miniboard-front.jpg

There are also base-board Cypress FX2 boards such as the Lcsoft Mini Board, which can usually be found by searching for Cypress FX2 Board or similar.

In addition, a good set of quality probe hooks is recommended. The E-Z-Hook XKM series hooks are highly recommended, and are available from resellers such as DigiKey.

2. Sigrok Signal Capture

For this example we are going to perform an analysis on a signal captured from a Dallas DS1307 I²C Real-Time Clock chip, which measures the time of day.

The sigrok-dumps repository contains a pre-made capture of DS1307 signalling.

We now start up the PulseView sigrok GUI, and open the file from sigrok-dumps/i2c/rts_dallas_ds1307/rtc_ds1307_200khz.sr. We can now see the captured signal, which features a conversation between a microcontroller and the DS1307, where the microcontroller repeatedly sets and queries the time of day:

3. Sigrok Signal Decoding

Now we have the captured signal we can make use of sigrok's support for signal decoding. sigrok allows signal decoding through the use of Python-language Protocol Decoder scripts. This makes it very quick and easy to build powerful decoders for all forms of digital signalling. We hope to be able to build a vibrant decoder library, that will contain a large selection of supported chips and protocols.

Because we know that this is I²C signalling, we can add an I²C decoder from the Decoders menu:

Normally we would need to associate the logic probes with the logic analyzer inputs, but in this case, because the probes are already labelled SCL and SDA, PulseView can do this automatically. We can now see that sigrok has decoded the I²C messages and displays them with a blob diagram.

This is already very useful, and a massive improvement over counting out pulses on an oscilloscope screen. However, sigrok allows us to go one step further with the use of so-called second level decoders.

To add a second level decoder we go to the Stack Decoder menu, and select the DS1307 decoder.

With the second level decoder added, we can now see that sigrok has decoded the meaning of the I²C commands, so that we don't need to bother searching the reference manual. In this view, we can see that the I²C packet was a command to read the date and time, which was 10.03.2013 23:35:30.

4. Advanced analysis with sigrok-cli

sigrok-cli is a command line front-end for sigrok. signal analysis via the command line is a powerful method of working, particularly when used with UNIX pipes. Downstream programs and scripts can be used to search, filter, condition or format the data in whatever way is desired.

For example this blog post demonstrates how to extract a .WAV file from I²S digital sound signalling.

In the case of our DS1307 example, we can load the file with sigrok-cli. The data is displayed as bits by default:

Or we can display the signal as ASCII art:

Now we can decode the I²C packet data:

And as before we can decode the DS1307 commands:

When combined with tools such as grep, egrep, sed, perl, python, and many others, all kinds of powerful analysis becomes possible.

introduction_to_sigrok.txt · Last modified: 2016/07/22 17:50 (external edit)