Protocol decoder:Nrf24l01

2015-02-06T16:36:21Z

Jst: add clones section

Linux

2015-01-02T13:15:03Z

Jst: AX_CXX_COMPILE_STDCXX_11 warnings

This page describes how to build/install the sigrok subprojects on Linux.

== Distribution packages ==

See [[Downloads#Binaries_and_distribution_packages|Downloads]].

== Building ==

=== libserialport ===

'''Installing the [[Building#Build_requirements|requirements]]:'''

Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):

$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''

'''Building:'''

$ '''git clone git://sigrok.org/libserialport'''
$ '''cd libserialport'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

=== libsigrok ===

'''Installing the [[Building#Build_requirements|requirements]]:'''

Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):

$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''
'''libusb-1.0-0-dev libftdi-dev check doxygen \'''
'''python-dev python-gi-dev python-setuptools swig default-jdk'''

Fedora (18, 19):

$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''
'''libzip-devel libusb1-devel libftdi-devel check-devel'''

OpenSuSE (12.2):

$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''
'''libzip-devel libusb-1_0-devel libftdi1-devel check python3-devel'''

'''Building:'''

$ '''git clone git://sigrok.org/libsigrok'''
$ '''cd libsigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

=== libsigrokdecode ===

'''Installing the [[Building#Build_requirements|requirements]]:'''

Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):

$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''

Fedora (18, 19, 20):

$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''

'''Building:'''

$ '''git clone git://sigrok.org/libsigrokdecode'''
$ '''cd libsigrokdecode'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

=== sigrok-cli ===

'''Installing the [[Building#Build_requirements|requirements]]:'''

Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):

$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''

Fedora (18, 19):

$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''

OpenSuse (13.1):

$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''

'''Building:'''

$ '''git clone git://sigrok.org/sigrok-cli'''
$ '''cd sigrok-cli'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

=== PulseView ===

'''Installing the [[Building#Build_requirements|requirements]]:'''

Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):

$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''
'''libglib2.0-dev libqt4-dev libboost-test-dev \'''
'''libboost-filesystem-dev libboost-system-dev'''

Fedora (18, 19):

$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''
'''boost-devel qt-devel boost-devel'''

'''Building:'''

$ '''git clone git://sigrok.org/pulseview'''
$ '''cd pulseview'''
$ '''cmake .'''
$ '''make'''
$ '''sudo make install'''

== Common problems ==

libsigrok's <tt>'''autogen.sh'''</tt> outputs the following warning:

--- Warning: AX_CXX_COMPILE_STDCXX_11 macro not found.
--- You won't be able to build the language bindings!

That means that the m4 macro used to detect C++11 support was not found. Use the package manager of your distribution to install the package that included the macro. Most distributions package this file in a package called <tt>'''autoconf-archive'''</tt> or similar.

----

libsigrok's <tt>'''autogen.sh'''</tt> outputs the following warning:

--- Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old.
--- (found version <version>, at least 4 is required)
--- You won't be able to build the language bindings!

That means that the version of the macro included with your distribution is too old. You can:
* Download the latest version of the macro from [https://www.gnu.org/software/autoconf-archive/ax_cxx_compile_stdcxx_11.html here], and use the <tt>'''ACLOCAL_PATH'''</tt> environment variable to point aclocal to the file:
$ '''ACLOCAL_PATH=/path/to/directory/containing/macro ./autogen.sh'''
* Download the latest version of the macro and overwrite the file included with your distribution, most often located in <tt> /usr/share/aclocal/</tt>.

----

If you get this error:

sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory

Then you have to rebuild the links to your shared libraries:

$ '''sudo ldconfig /usr/local/lib'''

Feeding hardware-decoded packets into libsigrok

2014-12-23T14:46:01Z

Jst:

Soeren Apel came up with an interesting use-case:

The yokogawa DLM2000 series can do I2C decoding on the device, and feed the I2C packets and associated metadata to an SCPI client:

:SERialbus<x>:I2C:DETail:LIST:ITEM?
Queries all items that will be displayed in the I2C
bus signal analysis result list.

Example :SERIALBUS1:I2C:DETAIL:LIST:ITEM?
-> "No.,Time(ms),1st,2nd,R/W,Data,Information"

:SERialbus<x>:I2C:DETail:LIST:VALue?
Queries all of the data for the specified analysis
number in the I2C bus signal analysis result list.

Example :SERIALBUS1:I2C:DETAIL:LIST:VALUE? 0
-> "0,-0.07000,AA*,,W,AE*88*,7-bit"

This hardware-level decoder has access to more raw data than device ever feeds to sigrok: it cannot stream continually via SCPI transports, for example. So it's entirely possible, even likely, that the hardware can decode more I2C data from the raw signal than libsigrok/libsigrokdecode ever could.

Thus, this is a use-case for getting I2C packets from the hardware, associating it with libsigrok timing reference (sample numbers) and feeding to libsigrokdecode '''as an I2C packet''' -- to PDs that normally take their input from the libsigrokdecode I2C PD.

This involves:
* libsigrok would need a facility to send decoded packets over the session bus. This is certainly a new packet type, for example SR_DF_I2C.
* libsigrokdecode would need a way to receive more than just raw logic. The inter-PD Python object format for (in this case) I2C would need to be nailed down and formalized, and a way for the library to receive I2C in packet format and convert to the Python object.

== Other scopes that can send decoded data over SCPI ==

Keysight InfiniiVision 3000 X-Series Oscilloscopes and
Agilent InfiniiVision 7000A Series Oscilloscopes:

:LISTer:DATA
Query Syntax :LISTer:DATA?
The :LISTer:DATA? query returns the lister data.
Return Format <binary block><NL>
<binary_block> ::= comma-separated data with newlines at the end of each row

== RS232 ==

* One or two serial ports could be used as a "poor man's capture device" to decode RS232. The communication parameters for RS232 would have to be known to capture, the higher level protocol could then be analyzed with lsrd.
* The output of a program like [http://www.suspectclass.com/sgifford/interceptty/ interceptty] could be converted into the sigrok format and then be analyzed. No need to hook up any probes.

Both use cases could be useful if no "real" logic analyzer is available or for debugging.

File format:Pwl

2014-12-11T14:54:57Z

Jst: /* PWL in different SPICE implementations */

{{Infobox file format
| image =
| id = pwl
| name = Piecewise linear function
| status = unsupported
| extensions = '''.txt'''
| source_code_in =
| source_code_out =
| mime_type =
| is_ascii = yes
| compression = none
| website =
| image = [[File:Pwl source.png|200px]]
| image caption = A voltage source using values from a PWL file.
}}

'''pwl''' is a file format that can be used to define the signal of voltage/current sources in a SPICE simulation.

== Format ==

The file consists of multiple time/value pairs. The individual values are separated by whitespace, therefore all values can be in one long line, or on multiple lines (much more convenient). The time values have to be in increasing order. SI prefixes are supported for both the time and the value.

The content in the file is then accessed with the <tt>PWL file=…</tt> statement from the simulation.

== PWL in different SPICE implementations ==

=== [http://www.linear.com/designtools/software/#LTspice LTspice] ===

* [http://www.linear.com/solutions/1814 Description of PWL on the Linear Technology website.]
* [http://ltwiki.org/?title=Undocumented_LTspice#Piecewise_Linear_Sources_.28PWL.29 Additional information on LTwiki.]

==== Observations ====
* A space (0x20) or different newline indicators (CR (0x0D), LF (0x0A) and CR+LF) can be used to separate the times/values.
* When editing the properties of a voltage/current source in the LTspice editor and choosing the PWL file, the "Open File" dialog uses "ASCII File (*.txt)" as the default filter (but the simulation can use every other file extension too).

==== Screenshots ====
<gallery>
File:Pwl ltspice example.png|<small>green: AM signal imported using the <tt>PWL file=…</tt> statement.<br>blue: Demodulated signal.</small>
File:Pwl ltspice example repeated.png|<small>green: AM signal imported using the <tt>PWL REPEAT FOREVER file=… ENDREPEAT</tt> statement.<br>blue: Demodulated signal.</small>
File:Pwl ltspice time error.png|Error during the simulation if the timestamps are not increasing.
</gallery>

=== [http://ngspice.sourceforge.net/ Ngspice] ===

* [http://ngspice.sourceforge.net/docs/ngspice-manual.pdf Ngspice user's manual]
* [http://hforsten.com/simulating-audio-effects-with-spice.html Blogpost by Henrik Forstén that involves reading audio data from a file using Ngspice] (by using a Python script to get the data into the correct format, link to source on github at the bottom of the page).

==== Observations ====
* Ngspice's PWL source can't read from a file, however there is a model called <tt>filesource</tt> instead (section 12.2.8 in the user's manual):
** The input file is read line by line. (The [http://sourceforge.net/p/ngspice/ngspice/ci/master/tree/src/xspice/icm/analog/file_source/cfunc.mod#l203 actual implementation] of the module uses <tt>fgets()</tt> to read the individual lines.)
** The characters '#' and ';' start a comment, the rest of the line after them is ignored.
** A line can contain two or more values, the first is the timestamp, the other values are the outputs of the model.
* Ngspice also has a digital source called <tt>d_source</tt> (section 12.4.21 in the user's manual):
** Again, the file is read [http://sourceforge.net/p/ngspice/ngspice/ci/master/tree/src/xspice/icm/digital/d_source/cfunc.mod#l723 line by line using <tt>fgets()</tt>].
** The character '*' starts a comment.
** A line contains a timestamp an one or more digital values.
** A digital value consists of two characters, the first defines the actual value (0/1/undefined) and the second the "strength" of the state (strong/resistive/hi-impedance/undetermined), as documented in section 12.5.1 "Digital Node Type" of the user's guide.

== Resources ==

* [https://bitbucket.org/jenste/pwl-test Files used to test the LTspice implementation.]

[[Category:File format]]

2014-11-06T00:54:55Z

Jst:

=== Modules ===

Various online marketplaces sell modules containing the ESP8266 (and a few assisting components) that comes preprogrammed with a TCP/IP stack that can be controlled via RS232 commands.

* ESP-01
<blockquote>
Connector: 2x4pin male 2.54mm header
{|style="border-width: 0px"
| style="width: 300px" |
{| border="0" style="margin-top: 0px; font-size: smaller; text-align: center" class="alternategrey sigroktable"
|+ Connector pinout
|-
! Function
! Pin
! style="border-left:2px solid gray" | Pin
! Function
|-
| <div>{{ESP8266EXpin|26}}</div>
| 1
| style="border-left:2px solid gray" | 2
| GND
|-
| <div>{{ESP8266EXpin|7}}</div>
| 3
| style="border-left:2px solid gray" | 4
| <div>{{ESP8266EXpin|14}}</div>
|-
| <div>{{ESP8266EXpin|32}}</div>
| 5
| style="border-left:2px solid gray" | 6
| <div>{{ESP8266EXpin|15}}</div>
|-
| VCC
| 7
| style="border-left:2px solid gray" | 8
| <div>{{ESP8266EXpin|25}}</div>
|}
<small>(Note: The PCB has two square pads at the pin header, so it's not clear which one should be pin number 1. The table above assumes that the module is oriented as shown in the picture from the top, with the antenna on the right side, pin 1 is then in the top left corner and pin 8 next to the SPI flash chip.)</small>
| style="vertical-align: top" |
<gallery>
File:ESP-01.jpg|<small>ESP-01, top</small>
File:ESP-01_flash.jpg|<small>[http://www.gigadevice.com/product/detail/5/119.html GigaDevice GD25Q40B] 4Mbit SPI flash</small>
</gallery>
|}

</blockquote>

* ESP-04
<blockquote>
Connectors: 7 pin castellated holes on both sides (2mm distance)
{|style="border-width: 0px"
|
{| border="0" style="margin-top: 0px; font-size: smaller; text-align: center" class="alternategrey sigroktable"
|+ Pinout of left connector
|-
! Pin
! Function
|-
| 1
| VCC
|-
| 2
| <div>{{ESP8266EXpin|9}}</div>
|-
| 3
| <div>{{ESP8266EXpin|10}}</div>
|-
| 4
| <div>{{ESP8266EXpin|12}}</div>
|-
| 5
| <div>{{ESP8266EXpin|13}}</div>
|-
| 6
| <div>{{ESP8266EXpin|14}}</div>
|-
| 7
| <div>{{ESP8266EXpin|15}}</div>
|}
|
{| border="0" style="margin-top: 0px; font-size: smaller; text-align: center" class="alternategrey sigroktable"
|+ Pinout of right connector
|-
! Pin
! Function
|-
| 1
| <div>{{ESP8266EXpin|2}}</div>
|-
| 2
| <div>{{ESP8266EXpin|7}}</div>
|-
| 3
| <div>{{ESP8266EXpin|8}}</div>
|-
| 4
| <div>{{ESP8266EXpin|25}}</div>
|-
| 5
| <div>{{ESP8266EXpin|26}}</div>
|-
| 6
| n.c.
|-
| 7
| GND
|}
|}
</blockquote>

* ESP-05
<blockquote>
Connectors: 1x5pin pads (2.54mm distance), U.FL antenna connector
{|style="border-width: 0px"
|
{| border="0" style="margin-top: 0px; font-size: smaller; text-align: center" class="alternategrey sigroktable"
|+ Connector pinout
|-
! Pin
! Function
|-
| 1
| <div>{{ESP8266EXpin|32}}</div>
|-
| 2
| GND
|-
| 3
| <div>{{ESP8266EXpin|25}}</div>
|-
| 4
| <div>{{ESP8266EXpin|26}}</div>
|-
| 5
| VCC
|}
|}
</blockquote>

Protocol decoder:Esp8266

2014-11-06T00:40:30Z

Jst: /* Modules */

Protocol decoder:Esp8266

2014-11-06T00:32:33Z

Jst: /* Modules */

Protocol decoder:Esp8266

2014-11-06T00:19:20Z

Jst: /* Hardware */

2014-11-05T23:52:02Z

Jst: /* Modules */

Template:ESP8266EXpin

2014-11-05T23:48:06Z

Jst:

Template:ESP8266EXpin

2014-11-05T23:42:59Z

Jst: Created page with "<noinclude> Template for the ESP8266EX pin names. </noinclude> <includeonly> {{#switch: {{{1}}} | 1 = VDDA | 2 = LNA | 3 = VDD3P3 | 4 = VDD3P3 | 5 = VDD_RTC | 6 =..."

<noinclude>
Template for the ESP8266EX pin names.
</noinclude>
<includeonly>
{{#switch: {{{1}}}
| 1 = VDDA
| 2 = LNA
| 3 = VDD3P3
| 4 = VDD3P3
| 5 = VDD_RTC
| 6 = TOUT
| 7 = CHIP_EN
| 8 = XPD_DCDC
| 9 = MTMS
| 10 = MTDI
| 11 = VDDPST
| 12 = MTCK
| 13 = MTDO
| 14 = GPIO2
| 15 = GPIO0
| 16 = GPIO4
| 17 = VDDPST
| 18 = SDIO_DATA_2
| 19 = SDIO_DATA_3
| 20 = SDIO_CMD
| 21 = SDIO_CLK
| 22 = SDIO_DATA_0
| 23 = SDIO_DATA_1
| 24 = GPIO5
| 25 = U0RXD
| 26 = U0TXD
| 27 = XTAL_OUT
| 28 = XTAL_IN
| 29 = VDDD
| 30 = VDDA
| 31 = RES12K
| 32 = EXT_RSTB
| error: unknown pin {{{1}}}
}}
<includeonly>

Protocol decoder:Esp8266

2014-11-03T14:05:14Z

Jst: /* Modules */