https://sigrok.org/w/api.php?action=feedcontributions&feedformat=atom&user=Joelholdsworthsigrok - User contributions [en]2026-04-21T04:06:06ZUser contributionsMediaWiki 1.37.1https://sigrok.org/w/index.php?title=Linux&diff=10502Linux2015-01-23T23:45:52Z<p>Joelholdsworth: /* PulseView */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
'''Fedora (18, 19)'''<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf autoconf-archive automake libtool \'''<br />
'''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''<br />
'''python-setuptools swig jdk8-openjdk'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
'''Fedora (18, 19, 20)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu''''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
'''Fedora (18, 19)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''OpenSuse'''<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
'''Fedora (18, 19)'''<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make cmake libtool pkgconfig glib2 boost qt5 \'''<br />
'''qt5-base qt5-svg'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10501Linux2015-01-23T23:44:44Z<p>Joelholdsworth: /* Installing the requirements */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
'''Fedora (18, 19)'''<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf autoconf-archive automake libtool \'''<br />
'''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''<br />
'''python-setuptools swig jdk8-openjdk'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
'''Fedora (18, 19, 20)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu''''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
'''Fedora (18, 19)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''OpenSuse'''<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
'''Fedora (18, 19)'''<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make cmake libtool pkgconfig glib2 boost qt5 \'''<br />
'''qt5-svg'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10500Linux2015-01-23T23:39:26Z<p>Joelholdsworth: /* sigrok-cli */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
'''Fedora (18, 19)'''<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf autoconf-archive automake libtool \'''<br />
'''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''<br />
'''python-setuptools swig jdk8-openjdk'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
'''Fedora (18, 19, 20)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu''''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
'''Fedora (18, 19)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''OpenSuse'''<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10499Linux2015-01-23T23:34:58Z<p>Joelholdsworth: /* libsigrokdecode */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
'''Fedora (18, 19)'''<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf autoconf-archive automake libtool \'''<br />
'''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''<br />
'''python-setuptools swig jdk8-openjdk'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
'''Fedora (18, 19, 20)'''<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool pkgconfig glib2 python check'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10498Linux2015-01-23T23:30:50Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
'''Debian/Ubuntu'''<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
'''Fedora (18, 19)'''<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf autoconf-archive automake libtool \'''<br />
'''pkg-config glib2 glibmm libzip libusb libftdi check doxygen python-numpy \'''<br />
'''python-setuptools swig jdk8-openjdk'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10497Linux2015-01-22T21:04:02Z<p>Joelholdsworth: </p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# '''pacman -S git gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10496Linux2015-01-22T20:59:37Z<p>Joelholdsworth: </p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
'''Debian/Ubuntu/Mint'''<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Arch'''<br />
# pacman -S git gcc make autoconf automake libtool<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10495Linux2015-01-22T20:51:51Z<p>Joelholdsworth: </p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
==== Device access ====<br />
<br />
Please read [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|this FAQ entry]] for any extra steps you may need to take to get your specific device working.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
==== Installing the [[Building#Build_requirements|requirements]] ====<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
==== Building ====<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].<br />
<br />
=== Cannot access USB / serial / other device ===<br />
<br />
See [[Building#Cannot_access_USB_.2F_serial_.2F_other_device|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10450Linux2015-01-10T13:57:38Z<p>Joelholdsworth: /* PulseView */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel check python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
'''Device access:'''<br />
<br />
Please read the readme.devices file in the libsigrok/ folder for any extra steps you may need to take to get your specific device working. This includes USB devices, which will not work on standard user priviledges unless you follow the instructions given in that file. These steps are not necessary if you are installing from a package.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev libboost-thread-dev\'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=10449Linux2015-01-10T13:45:59Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
<div style="background-color:#ff6666"><br />
'''IMPORTANT''': The following sections on installing build requirements are distro-specific examples and may or may not be out of date, depending on which distro you use. Please check the [[Building#Build_requirements|official build requirements list]] in the wiki or the current [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=README libsigrok README] for the full list of requirements.<br />
</div><br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev check doxygen python-numpy\'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel check-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel check python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
'''Device access:'''<br />
<br />
Please read the readme.devices file in the libsigrok/ folder for any extra steps you may need to take to get your specific device working. This includes USB devices, which will not work on standard user priviledges unless you follow the instructions given in that file. These steps are not necessary if you are installing from a package.<br />
<br />
<div style="background-color:#ff6666"><br />
Please see [[Building#FAQ]] if you are sure that you installed all requirements properly but still encounter some issues.<br />
</div><br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-test-dev \'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
== FAQ ==<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro not found ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_not_found|here]].<br />
<br />
=== Warning: AX_CXX_COMPILE_STDCXX_11 macro is too old ===<br />
<br />
See [[Building#Warning:_AX_CXX_COMPILE_STDCXX_11_macro_is_too_old|here]].<br />
<br />
=== Cannot open shared object file: No such file or directory ===<br />
<br />
See [[Building#Cannot_open_shared_object_file:_No_such_file_or_directory|here]].<br />
<br />
=== TEST FAILED: .../lib/python2.7/site-packages/ does NOT support .pth files ===<br />
<br />
See [[Building#TEST_FAILED:_....2Flib.2Fpython2.7.2Fsite-packages.2F_does_NOT_support_.pth_files|here]].</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth&diff=10334User:Joelholdsworth2014-12-19T13:34:47Z<p>Joelholdsworth: Created page with "= Prototype Front Page = File:Front-page.png"</p>
<hr />
<div>= [[User:Joelholdsworth/new main|Prototype Front Page]] =<br />
[[File:Front-page.png]]</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=10333User:Joelholdsworth/new main2014-12-19T13:16:15Z<p>Joelholdsworth: </p>
<hr />
<div><table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
</div><br />
<br />
<div style="float: left; width: 33%; margin-bottom: 1em; margin-right: 1%"><br />
=== Supported Devices ===<br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">[[Supported_hardware#Logic_analyzers|Logic analyzers]] </span>|<br />
CONTENT =<br />
<small><br />
[[File:Zeroplus Logic Cube.png|60px]]<br />
[[File:Saleae_Logic16_bottom.png|60px]]<br />
[[File:Openbench_logic_sniffer_front.png|60px]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Oscilloscopes</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Multimeters</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Data Loggers</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="float: right; width: 32%; margin-bottom: 1em;"><br />
<br />
=== Applications ===<br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">PulseView</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">sigrok-cli</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="display: inline-block; width: 33%; margin-bottom: 1em;"><br />
=== Libraries ===<br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">libsigrok</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">libsigrokdecode</span>|<br />
CONTENT =<br />
<small><br />
<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<div style="clear: both;"><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=10332User:Joelholdsworth/new main2014-12-19T12:53:18Z<p>Joelholdsworth: </p>
<hr />
<div><table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
</div><br />
<br />
<div style="float: left; width: 33%; margin-bottom: 1em;"><br />
=== Supported Devices ===<br />
</div><br />
<br />
<div style="display: inline-block; width: 33%; margin-bottom: 1em;"><br />
=== Applications ===<br />
</div><br />
<br />
<div style="float: right; width: 33%; margin-bottom: 1em;"><br />
=== Libraries ===<br />
</div><br />
<br />
<center>[[File:Front-page.png]]</center><br />
<br />
<br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10217File format:Sigrok/v32014-11-26T09:44:39Z<p>Joelholdsworth: /* List of known compression schemes */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
* JH: Do we need info about interleaving here? We could insist that all channels be de-intereleaved, or add support for interleaved streams.<br />
* JH: Would could add support for device compression schemes. It may sometimes be desirable to be able to pass the device stream straight into the file.<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
*** JH: I wonder if we can do even better by XOR-ing the data with some kind of frequency tracking oscillator. This would convert a square wave into mostly continuous 0s or 1s, with occasional pulses where jitter occurs.<br />
*** JH: This kind of thing is best prototyped with a script e.g python + the bitset library.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10216File format:Sigrok/v32014-11-26T09:35:32Z<p>Joelholdsworth: /* Futher notes and ideas to consider */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
*** JH: I wonder if we can do even better by XOR-ing the data with some kind of frequency tracking oscillator. This would convert a square wave into mostly continuous 0s or 1s, with occasional pulses where jitter occurs.<br />
*** JH: This kind of thing is best prototyped with a script e.g python + the bitset library.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10215File format:Sigrok/v32014-11-26T09:34:26Z<p>Joelholdsworth: /* Futher notes and ideas to consider */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
*** JH: I wonder if we can do even better by XOR-ing the data with some kind of frequency tracking oscillator. This would convert a square wave into mostly continuous 0s or 1s, with occasional pulses where jitter occurs.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10214File format:Sigrok/v32014-11-26T09:29:52Z<p>Joelholdsworth: /* Goals */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10213File format:Sigrok/v32014-11-26T09:28:16Z<p>Joelholdsworth: /* Goals */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
** JH: Compression works best when it is tailored to the data type being compressed. For example for logic, I think the ideal compression scheme would be deinterleave -> RLE -> canical huffman. For analog data, a linear prediction scheme - FLAC, or something like it will probably suit best.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10212File format:Sigrok/v32014-11-26T09:27:53Z<p>Joelholdsworth: /* Goals */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
** JH: Compression works best when it is tailored to the data type being comppressed. For example for logic, I think the ideal compression scheme would be deinterleave -> RLE -> huffman. For analog data, a linear prediction scheme - FLAC, or something like it will probably suit best.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=10211File format:Sigrok/v32014-11-26T09:27:09Z<p>Joelholdsworth: /* Goals */</p>
<hr />
<div>{{DISPLAYTITLE:File format:sigrok/v3}}<br />
This page describes the proposed file/stream format (v3) for storing and transmitting sigrok related data.<br />
<br />
<div style="background-color:#ff6666"><br />
NOTE: This is work in progress and has not yet been implemented!<br />
</div><br />
<br />
== Motivation ==<br />
<br />
The previous [[File format:sigrok/v2|sigrok session]] file format (version 2) is a ZIP file containing multiple files (some metadata files and data files containing the actual samples). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* It doesn't support storing analog data (e.g. from oscilloscopes or MSOs).<br />
* It doesn't support storing additional information for frontends (channel colors, and so on).<br />
* ...<br />
<br />
== Goals ==<br />
<br />
The following list highlights some of the goals of the new file format (v3):<br />
<br />
* It must be able to store<br />
** arbitrary data (logic samples, and/or analog samples, and/or protocol decoder data, and more), as well as<br />
** arbitrary meta-/config-data and other extra information that may be useful to frontends (UI state data, user-configured probe colors, names, positions, and so on).<br />
* It must support and facilitate stream-oriented processing (save, load, transmission, compression/decompression, and so on).<br />
* It must support compression of the payload data.<br />
* It must be usable independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), operating system, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
* It must allow for sufficiently good performance for the common operations a frontend needs to perform on the data/file/stream (save, load, compress/uncompress, append, and so on) so that it doesn't become the bottleneck. This is especially important for stream-oriented devices which could otherwise lose samples if the processing on the host side is not sufficiently fast ([[Saleae Logic]], [[Saleae Logic16]], [[IKALOGIC ScanaPLUS]], others).<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* It should have better compression properties than ZIP (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, Android, and so on.<br />
** JH: Compression works best when it is tailored to the data type being comppressed. For example for logic, I think the ideal compression scheme would be deinterleave -> RLE -> huffman. For analog data, a linear prediction scheme - FLAC, or something like it will probably suit best.<br />
** JH: Compression algorithms should be selectable, and should allow direct pass-through from devices that support hardware compression.<br />
<br />
== Specification ==<br />
<br />
== UUIDs ==<br />
<br />
The format uses random [http://en.wikipedia.org/wiki/Universally_unique_identifier UUIDs] (version 4) as per [http://tools.ietf.org/html/rfc4122 RFC4122] in various places. These UUIDs are always 16 bytes long.<br />
<br />
A simple way to generate a random (version 4) UUID (ASCII and hex representation):<br />
<br />
<small><br />
$ '''python3 -c 'import uuid; u = uuid.uuid4(); print(u); print(u.hex)''''<br />
14c49f22-f08a-4ef2-b3d7-82ee16c3d531<br />
14c49f22f08a4ef2b3d782ee16c3d531<br />
</small><br />
<br />
== File/stream format ==<br />
<br />
The format consists entirely of a stream of packets of various types.<br />
<br />
These packets can be either written to or read from a file, buffer, pipe, socket, or any other source/destination.<br />
<br />
== Packet format ==<br />
<br />
Every packet consists of four fields:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Short-UUID'''<br />
| 2<br />
| An ID (2 bytes, little-endian) that maps to a previously defined 16-byte packet type UUID. The Short-UUID values can range from 0x0002 to 0xffff, which allows for 65535 different packet types in a single file/stream. The Short-UUIDs 0x0000 and 0x0001 are special and cannot be used for "normal" packets, see below. The reason for using a (Short-)UUID here instead of some simple index number is to allow for clients to define and use their own special-purpose packet types as they see fit, without having to fear any conflicts with existing packet types (or packet types that someone else might add later).<br />
<br />
|-<br />
| '''Reference-ID'''<br />
| 4<br />
| An ID (4 bytes, little-endian) that is assigned to this packet, so that other packets can reference it. Valid values: 0x00000001 - 0xffffffff. A value of 0x00000000 means that this packet doesn't have a Reference-ID. Note that a (Short-)UUID specifies a certain ''type'' of packet, whereas the Reference-ID identifies a specific ''individual'' packet. For example, there can be multiple different packets (different Reference-ID) that are of the same type (same Short-UUID).<br />
<br />
|-<br />
| '''Length'''<br />
| 4<br />
| The length of the data in this packet (in number of bytes). The length does not include the length of the '''Short-UUID''', '''Reference-ID''' or '''Length''' field, only the length of the '''Data''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Data'''<br />
| 0..n<br />
| The actual payload data, max. 2^32 bytes (4GiB). For some packet types the '''Data''' field is optional (in that case it is completely omitted and the '''Length''' field is set to 0). The contents of the '''Data''' field are entirely dependent on (and vary with) the type of packet.<br />
<br />
|}<br />
<br />
Using the common [http://en.wikipedia.org/wiki/Type-length-value type-length-value] idom for each packet allows clients to easily skip over (ignore) any packets they do not know how to handle, and instead continue on to checking/handling the next packet.<br />
<br />
'''Example packet with a 7-byte data field (Short-UUID is 0x55aa, Reference-ID is 0x00008ab2):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 8a b2<br />
| 00 00 00 07<br />
| 11 22 33 44 55 66 77<br />
<br />
|}<br />
<br />
'''Example packet without a data field (Short-UUID is 0x55aa, Reference-ID is 0x00005f31):'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
<br />
|-<br />
| 55 aa<br />
| 00 00 5f 31<br />
| 00 00 00 00<br />
<br />
|}<br />
<br />
== PACKET_MAP_UUIDS packet ==<br />
<br />
This is a special packet that is used to map 16-byte UUIDs to 2-byte Short-UUIDs.<br />
<br />
Since every packet has a 2-byte Short-UUID, PACKET_MAP_UUIDS must be the first packet in a file/stream, otherwise the client will not be able to interpret any other packets.<br />
<br />
However, PACKET_MAP_UUIDS can occur multiple times in a stream. Every time PACKET_MAP_UUIDS is seen, mappings that were not yet defined are added to the list of mappings, and mappings that already existed will be overwritten with the respective new mapping.<br />
<br />
Since PACKET_MAP_UUIDS is a packet itself, it also consists of the four common fields Short-UUID/Reference-ID/Length/Data. The Short-UUID of PACKET_MAP_UUIDS is always '''0x0000'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Special Short-UUID for magic marker'''<br />
| 2<br />
| A reserved special Short-UUID (2 bytes, little-endian) for the magic marker. Value: '''0x0001'''.<br />
<br />
|-<br />
| '''Special UUID for magic marker'''<br />
| 16<br />
| This is a special marker that can be used by the '''file''' utility (and other tools) to detect the file format easily. Contents: '''$sIgRoK$$sIgRoK$'''.<br />
<br />
|-<br />
| '''Short-UUID 1'''<br />
| 2<br />
| The 2-byte Short-UUID with index 1 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 1'''<br />
| 16<br />
| The UUID with index 1 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| '''Short-UUID 2'''<br />
| 2<br />
| The 2-byte Short-UUID with index 2 (valid values: 0x0002 to 0xffff) that will, from now on, map to the UUID specified below.<br />
<br />
|-<br />
| '''UUID 2'''<br />
| 16<br />
| The UUID with index 2 (binary representation, 16 bytes, little-endian) which identifies the type of packet (globally unique).<br />
<br />
|-<br />
| ...<br />
| ...<br />
| ...<br />
<br />
|}<br />
<br />
Important notes:<br />
<br />
* The '''Data''' field contains a list of Short-UUID to UUID mappings. Since every such pair is 18 bytes in size, the '''Length''' field of PACKET_MAP_UUIDS can be used to deduce how many such mappings are contained in the '''Data''' field.<br />
* The special "magic marker" fields (2 + 16 bytes) are required to be in every PACKET_MAP_UUIDS and are required to always be the first entries of PACKET_MAP_UUIDS. The file format can thus easily be detected by looking at the unique bytes 10-27 in the file (additionally, the file also always starts with the two bytes 0x00 0x00).<br />
* The special Short-UUID 0x0000 must not be used in any mapping, it is reserved for PACKET_MAP_UUIDS itself.<br />
* The special Short-UUID 0x0001 must not be used in any mapping, it is reserved for the special "magic marker", see above.<br />
* There is no guarantee of any kind about which Short-UUIDs will be mapped (and to what). Specifically, a client can '''not''' assume that Short-UUIDs start at 0x0002, and it can '''not''' assume that Short-UUIDs are ordered in any way. The Short-UUIDs can have a completely random order and they can also have gaps.<br />
* Mappings are generally not static in nature. Every additional PACKET_MAP_UUIDS that occurs can dynamically add or overwrite/change mappings, for example.<br />
<br />
'''Example packet:'''<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| 00&nbsp;00<br />
| ''xx&nbsp;xx&nbsp;xx&nbsp;xx''<br />
| 00&nbsp;00&nbsp;00&nbsp;48<br />
| <tt><span style="background-color: lightblue">00 01</span> <span style="background-color: yellow">24 73 49 67 52 6f 4b 24 24 73 49 67 52 6f 4b 24</span><br /><span style="background-color: lightblue">77 a1</span> <span style="background-color: cyan">5a 17 72 eb 28 54 48 a8 a4 1c 73 97 d7 e9 22 3d</span><br /><span style="background-color: lightblue">00 06</span> <span style="background-color: cyan">59 de f3 30 53 6a 46 b1 8e dd 62 f2 19 5d 1c 95</span><br /><span style="background-color: lightblue">a3 9f</span> <span style="background-color: cyan">ec 6b d7 63 c8 79 4a a7 a9 7a 7e df 0e 68 af c7</span></tt><br />
<br />
|}<br />
<br />
The above PACKET_MAP_UUIDS maps three different UUIDs to the Short-UUIDs 0x77a1, 0x0006 and 0xa39f.<br />
<br />
== sigrok packets ==<br />
<br />
The following packets are currently defined for use in projects hosted on [http://sigrok.org sigrok.org].<br />
<br />
The "names" (e.g. "SIGROK_PACKET_LOGIC") are for documentation purposes only, the (Short-)UUIDs are what actually matters. The names are prefixed with SIGROK_ to make it clear that other 3rd-party software may define their own additional packet types with arbitrary contents and for arbitrary purposes.<br />
<br />
=== SIGROK_PACKET_DEVICE ===<br />
<br />
This is a packet type used to define a device.<br />
<br />
This packet uses the fixed UUID '''94aa863d-bb58-4d79-b944-ab9dd30eecdf'''.<br />
<br />
Details yet to be defined.<br />
<br />
=== SIGROK_PACKET_CHANNEL ===<br />
<br />
This is a packet type used to define a channel.<br />
<br />
This packet uses the fixed UUID '''1325b595-0d5e-40a4-ac4d-36e89224dcb9'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Backreference-ID'''<br />
| 4<br />
| A Reference-ID (4 bytes, little-endian) referencing a previously defined device (SIGROK_PACKET_DEVICE) that the channel belongs to.<br />
<br />
|-<br />
| '''Channel type'''<br />
| 1<br />
| The type of this channel. '''0x01''': Logic, '''0x02''': Analog.<br />
<br />
|-<br />
| '''Channel name length'''<br />
| 2<br />
| The length in number of bytes of the channel name (2 bytes, little-endian).<br />
<br />
|-<br />
| '''Channel name'''<br />
| n<br />
| The channel name (UTF-8 string).<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
The following packet defines a logic channel named "CH1" with the Reference-ID ''tt tt tt tt'' (which identifies this specific channel) and the Backreference-ID ''bb bb bb bb'' which references a previously defined device the channel belongs to.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 0a<br />
| <tt><span style="background-color: lightblue">''bb bb bb bb''</span> <span style="background-color: cyan">01</span> <span style="background-color: lightblue">00 03</span> <span style="background-color: cyan">CH1</span></tt><br />
<br />
|}<br />
<br />
Further details yet to be defined.<br />
<br />
=== SIGROK_PACKET_LOGIC ===<br />
<br />
This is a packet type used to store/transmit (only) digital samples, usually from a logic analyzer.<br />
<br />
This packet uses the fixed UUID '''2236202e-9ee7-4bc6-81f6-56b4e6e029ba'''.<br />
<br />
The '''Data''' field has the following contents:<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Field<br />
!Length<br />
!Description<br />
<br />
|-<br />
| '''Version'''<br />
| 2<br />
| The version of the SIGROK_PACKET_LOGIC format in binary format (little-endian). Current version: '''0x0001'''.<br />
<br />
|-<br />
| '''Payload format Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain payload format.<br />
<br />
|-<br />
| '''Compression scheme Short-UUID'''<br />
| 2<br />
| A Short-UUID (2 bytes, little-endian) which identifies a certain compression scheme that is applied to the payload data.<br />
<br />
|-<br />
| '''Payload length'''<br />
| 4<br />
| The length of the actual payload data in this SIGROK_PACKET_LOGIC packet (in number of bytes). The length only includes the '''Payload''' field. The length is given as an uint32_t number (little-endian).<br />
<br />
|-<br />
| '''Payload'''<br />
| 0..n<br />
| The actual payload data, i.e. logic analyzer samples in the specified payload format, using the specified compression scheme.<br />
<br />
|}<br />
<br />
'''Example packet:'''<br />
<br />
(Packet type SIGROK_PACKET_LOGIC Short-UUID ''0xuuuu'', Reference-ID ''0xtttttttt'', 0x12 bytes packet data, SIGROK_PACKET_LOGIC version 0x0001, SIGROK_PAYLOAD_FORMAT_LOGIC_V1 payload format Short-UUID ''0xvvvv'', SIGROK_COMPRESSION_NONE compression scheme Short-UUID ''0xwwww'', 8 bytes of logic analyzer payload (uncompressed))<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable"<br />
|-<br />
!Short-UUID<br />
!Reference-ID<br />
!Length<br />
!Data<br />
<br />
|-<br />
| ''uu uu''<br />
| ''tt tt tt tt''<br />
| 00 00 00 12<br />
| <span style="background-color: cyan">00 01</span> <span style="background-color: lightblue">''vv vv''</span> <span style="background-color: cyan">''ww ww''</span> <span style="background-color: lightblue">00 00 00 08</span> <span style="background-color: cyan">11 22 33 44 55 66 77 88</span><br />
<br />
|}<br />
<br />
=== SIGROK_PACKET_ANALOG ===<br />
<br />
This is a packet type used to store/transmit (only) analog samples, e.g. from a multimeter, oscilloscope, sound level meter, or any other source for analog data.<br />
<br />
This packet uses the fixed UUID '''59def330-536a-46b1-8edd-62f2195d1c95'''.<br />
<br />
Details yet to be defined.<br />
<br />
== List of known packet types ==<br />
<br />
This is a short overview of known packet types that are in use. This includes the packet types used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to packet types that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Packet type<br />
!Description<br />
<br />
|-<br />
| 94aa863d-bb58-4d79-b944-ab9dd30eecdf<br />
| SIGROK_PACKET_DEVICE<br />
| [[File format:sigrok#SIGROK_PACKET_DEVICE|See above]].<br />
<br />
|-<br />
| 1325b595-0d5e-40a4-ac4d-36e89224dcb9<br />
| SIGROK_PACKET_CHANNEL<br />
| [[File format:sigrok#SIGROK_PACKET_CHANNEL|See above]].<br />
<br />
|-<br />
| 5a1772eb-2854-48a8-a41c-7397d7e9223d<br />
| SIGROK_PACKET_LOGIC<br />
| [[File format:sigrok#SIGROK_PACKET_LOGIC|See above]].<br />
<br />
|-<br />
| 59def330-536a-46b1-8edd-62f2195d1c95<br />
| SIGROK_PACKET_ANALOG<br />
| [[File format:sigrok#SIGROK_PACKET_ANALOG|See above]].<br />
<br />
|}<br />
<br />
== List of known payload formats ==<br />
<br />
This is a short overview of known payload formats that are in use. This includes the payload formats used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to payload formats that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Payload format<br />
!Description<br />
<br />
|-<br />
| style="white-space: nowrap;" | d2964f38-8b13-4570-9add-add5678a0394<br />
| SIGROK_PAYLOAD_FORMAT_LOGIC_V1<br />
| This payload format can only store digital samples from a logic analyzer (0/1 values for a certain channel/probe/pin). It is basically identical to the format that was used in the previous ZIP-based file format versions. Details are yet to be defined.<br />
<br />
|-<br />
| 79e7cfd1-0f56-4d5e-968a-b66fdbdff624<br />
| SIGROK_PAYLOAD_FORMAT_ANALOG_V1<br />
| A certain type of payload format that can store (only) analog samples of a certain number of analog channels. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== List of known compression schemes ==<br />
<br />
This is a short overview of known compression schemes that are in use. This includes the schemes used in projects hosted at [http://sigrok.org sigrok.org], as well as pointers to schemes that other (3rd-party) software is known to use.<br />
<br />
{| border="0" style="font-size: smaller;" class="alternategrey sigroktable sortable"<br />
|-<br />
!UUID<br />
!Compression scheme<br />
!Description<br />
<br />
|-<br />
| ec6bd763-c879-4aa7-a97a-7edf0e68afc7<br />
| SIGROK_COMPRESSION_NONE<br />
| No compression whatsoever is used.<br />
<br />
|-<br />
| acd2e249-5c4d-426d-96ae-ded5b6020e6f<br />
| SIGROK_COMPRESSION_RLE_V1<br />
| A certain type of RLE-based compression is used. Details are yet to be defined.<br />
<br />
|}<br />
<br />
== Futher notes and ideas to consider ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9604Linux2014-08-31T16:04:49Z<p>Joelholdsworth: </p>
<hr />
<div>This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check doxygen \'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev \'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9603Linux2014-08-31T16:03:54Z<p>Joelholdsworth: /* PulseView */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check doxygen \'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev \'''<br />
'''libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9602Linux2014-08-31T15:51:01Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf autoconf-archive \'''<br />
'''automake libtool pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev \'''<br />
'''libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check doxygen \'''<br />
'''python-dev python-gi-dev python-setuptools swig default-jdk'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9601Linux2014-08-31T15:42:36Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool \'''<br />
'''pkg-config libglib2.0-dev libglibmm-2.4-dev libzip-dev libusb-1.0-0-dev \'''<br />
'''libftdi-dev libudev-dev libasound2-dev check doxygen'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9600Linux2014-08-31T15:42:14Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libglibmm-2.4-dev libzip-dev libusb-1.0-0-dev libftdi-dev \'''<br />
'''libudev-dev libasound2-dev check doxygen'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9599Linux2014-08-31T15:41:56Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libglibmm-2.4-dev libzip-dev libusb-1.0-0-dev libftdi-dev \'''<br />
'''libudev-dev libasound2-dev check doxygen'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9598Linux2014-08-31T15:40:54Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libglibmm-2.4-dev libzip-dev libusb-1.0-0-dev libftdi-dev \'''<br />
'''libudev-dev libasound2-dev check'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9597Linux2014-08-31T15:37:21Z<p>Joelholdsworth: /* libserialport */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libzip-dev libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9596Linux2014-08-31T15:37:06Z<p>Joelholdsworth: /* libserialport */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libzip-dev libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check-devel'''<br />
<br />
Fedora 20:<br />
As above, but replace '''libudev-devel''' with '''systemd-devel'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19, 20):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel check-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=PulseView&diff=9453PulseView2014-08-18T08:37:57Z<p>Joelholdsworth: </p>
<hr />
<div>[[File:PulseView I2C DS1307 Decode.png|thumb|320px|right|PulseView (10-Aug-2014)]]<br />
[[File:Pulseview rigol 2 analog channels.png|thumb|320px|PulseView + scope]]<br />
<br />
'''PulseView''' is a Qt based logic analyzer GUI for sigrok.<br />
<br />
== Features ==<br />
<br />
* Fast O(log N) signal rendering at all zoom levels.<br />
* [[Protocol decoders|Protocol decoder]] support<br />
<br />
== Download ==<br />
<br />
[[http://sigrok.org/gitweb/?p=pulseview.git;a=summary Browse Source]]<br />
<br />
$ '''git clone git://sigrok.org/pulseview.git'''<br />
<br />
== Requirements ==<br />
<br />
See [[Building#PulseView]].<br />
<br />
== Building ==<br />
<br />
See [[Linux#PulseView]] (or any other of the [[Building#Building_from_source|OS-specific instruction pages]]).<br />
<br />
'''Additional notes:'''<br />
<br />
* Use <code>PKG_CONFIG_PATH=/''<prefix-of-libsigrok-installation>''/lib/pkgconfig/</code> if [[libsigrok]] and [[libsigrokdecode]] are installed to a non-standard prefix.<br />
* To change the install prefix: <code>cmake -DCMAKE_INSTALL_PREFIX=''<prefix-dir>''/ ..</code><br />
* To show compiler arguments during the build: <code>make VERBOSE=1</code><br />
* To make a non-stripped debug build <code>cmake -DCMAKE_BUILD_TYPE=Debug ..</code><br />
* To enable unit tests: <code>cmake -DENABLE_TESTS=y ..</code><br />
* To enable decoders: <code>cmake -DENABLE_DECODE=y ..</code><br />
* To disable -Werror: <code>cmake -DDISABLE_WERROR=y ..</code><br />
* To build with clang: <code>CXX=clang++ cmake ..</code><br />
* If cmake complains that it can only find Qt5, even though you have Qt4 installed: <code>cmake&nbsp;-DQT_QMAKE_EXECUTABLE:string=qmake-qt4&nbsp;..</code><br />
<br />
== Resources ==<br />
<br />
* [[PulseView/Architecture|PulseView Architecture Overview]]<br />
* [[TODO#pulseview|TODO List]]<br />
* [https://www.ohloh.net/p/pulseview PulseView on ohloh]<br />
* [http://airwebreathe.org.uk/w/doku.php?id=pulseview Joel Holdsworth's personal PulseView project page]</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=PulseView&diff=9452PulseView2014-08-18T08:37:31Z<p>Joelholdsworth: </p>
<hr />
<div>[[File:PulseView I2C DS1307 Decode.png|320px|right|PulseView (10-Aug-2014)]]<br />
[[File:Pulseview rigol 2 analog channels.png|thumb|320px|PulseView + scope]]<br />
<br />
'''PulseView''' is a Qt based logic analyzer GUI for sigrok.<br />
<br />
== Features ==<br />
<br />
* Fast O(log N) signal rendering at all zoom levels.<br />
* [[Protocol decoders|Protocol decoder]] support<br />
<br />
== Download ==<br />
<br />
[[http://sigrok.org/gitweb/?p=pulseview.git;a=summary Browse Source]]<br />
<br />
$ '''git clone git://sigrok.org/pulseview.git'''<br />
<br />
== Requirements ==<br />
<br />
See [[Building#PulseView]].<br />
<br />
== Building ==<br />
<br />
See [[Linux#PulseView]] (or any other of the [[Building#Building_from_source|OS-specific instruction pages]]).<br />
<br />
'''Additional notes:'''<br />
<br />
* Use <code>PKG_CONFIG_PATH=/''<prefix-of-libsigrok-installation>''/lib/pkgconfig/</code> if [[libsigrok]] and [[libsigrokdecode]] are installed to a non-standard prefix.<br />
* To change the install prefix: <code>cmake -DCMAKE_INSTALL_PREFIX=''<prefix-dir>''/ ..</code><br />
* To show compiler arguments during the build: <code>make VERBOSE=1</code><br />
* To make a non-stripped debug build <code>cmake -DCMAKE_BUILD_TYPE=Debug ..</code><br />
* To enable unit tests: <code>cmake -DENABLE_TESTS=y ..</code><br />
* To enable decoders: <code>cmake -DENABLE_DECODE=y ..</code><br />
* To disable -Werror: <code>cmake -DDISABLE_WERROR=y ..</code><br />
* To build with clang: <code>CXX=clang++ cmake ..</code><br />
* If cmake complains that it can only find Qt5, even though you have Qt4 installed: <code>cmake&nbsp;-DQT_QMAKE_EXECUTABLE:string=qmake-qt4&nbsp;..</code><br />
<br />
== Resources ==<br />
<br />
* [[PulseView/Architecture|PulseView Architecture Overview]]<br />
* [[TODO#pulseview|TODO List]]<br />
* [https://www.ohloh.net/p/pulseview PulseView on ohloh]<br />
* [http://airwebreathe.org.uk/w/doku.php?id=pulseview Joel Holdsworth's personal PulseView project page]</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:PulseView_I2C_DS1307_Decode.png&diff=9451File:PulseView I2C DS1307 Decode.png2014-08-18T08:36:58Z<p>Joelholdsworth: PulseView showing decoded I²C data from a DS1307</p>
<hr />
<div>== Summary ==<br />
PulseView showing decoded I²C data from a DS1307<br />
== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9043Linux2014-05-20T20:15:42Z<p>Joelholdsworth: /* sigrok-cli */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libzip-dev libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
OpenSuse (13.1):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Linux&diff=9042Linux2014-05-20T20:11:57Z<p>Joelholdsworth: /* libsigrok */</p>
<hr />
<div>[[File:Sigrok-gtk-0.1.png|thumb|320px|right|sigrok-gtk 0.1.0 on Linux]]<br />
<br />
This page describes how to build/install the sigrok subprojects on Linux.<br />
<br />
== Distribution packages ==<br />
<br />
See [[Downloads#Binaries_and_distribution_packages|Downloads]].<br />
<br />
== Building ==<br />
<br />
=== libserialport ===<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libserialport'''<br />
$ '''cd libserialport'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrok ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config \'''<br />
'''libglib2.0-dev libzip-dev libusb-1.0-0-dev libftdi-dev libudev-dev libasound2-dev check'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel \'''<br />
'''libzip-devel libusb1-devel libftdi-devel libudev-devel alsa-lib-devel check'''<br />
<br />
OpenSuSE (12.2):<br />
<br />
$ '''zypper install git gcc make autoconf automake libtool pkg-config glib2-devel \'''<br />
'''libzip-devel libusb-1_0-devel libftdi1-devel libudev-devel alsa-devel check \'''<br />
'''python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrok'''<br />
$ '''cd libsigrok'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== libsigrokdecode ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev python3-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel python3-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/libsigrokdecode'''<br />
$ '''cd libsigrokdecode'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-cli ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core gcc make autoconf automake libtool pkg-config libglib2.0-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc make autoconf automake libtool pkgconfig glib2-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-cli'''<br />
$ '''cd sigrok-cli'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== PulseView ===<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
Example on Debian/Ubuntu (please check your respective distro's package manager tool if you use other distros):<br />
<br />
$ '''sudo apt-get install git-core g++ make cmake libtool pkg-config \'''<br />
'''libglib2.0-dev libqt4-dev libboost-dev libboost-test-dev libboost-thread-dev libboost-filesystem-dev libboost-system-dev'''<br />
<br />
Fedora (18, 19):<br />
<br />
$ '''sudo yum install git gcc cmake libtool pkgconfig glib2-devel \'''<br />
'''boost-devel qt-devel boost-devel'''<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/pulseview'''<br />
$ '''cd pulseview'''<br />
$ '''cmake .'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<!--<br />
=== sigrok-gtk ===<br />
<br />
'''Note:''' [[sigrok-gtk]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-gtk'''<br />
$ '''cd sigrok-gtk'''<br />
$ '''./autogen.sh'''<br />
$ '''./configure'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
=== sigrok-qt ===<br />
<br />
'''Note:''' [[sigrok-qt]] is not yet usable!<br />
<br />
'''Installing the [[Building#Build_requirements|requirements]]:'''<br />
<br />
TODO.<br />
<br />
'''Building:'''<br />
<br />
$ '''git clone git://sigrok.org/sigrok-qt'''<br />
$ '''cd sigrok-qt'''<br />
$ '''qmake-qt4'''<br />
$ '''make'''<br />
$ '''sudo make install'''<br />
<br />
If you get warnings claiming potential symbol conflicts when running qmake, you are likely not invoking '''qmake-qt4'''. Try running '''qmake-qt4''' to force the correct version.<br />
--><br />
<br />
== Common problems ==<br />
<br />
If you get this error:<br />
<br />
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory<br />
<br />
Then you have to rebuild the links to your shared libraries:<br />
<br />
$ '''sudo ldconfig /usr/local/lib'''</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Logo&diff=8950Logo2014-05-02T15:11:19Z<p>Joelholdsworth: </p>
<hr />
<div>The '''sigrok logo''' is available for download in various formats here:<br />
<br />
<gallery><br />
File:Sigrok_logo_no_text_transparent_512.png|<small>Logo without text (PNG), transparent background<small><br />
File:Sigrok_logo.svg|<small>Logo with text (SVG), transparent background<small><br />
File:Sigrok_logo.png|<small>Logo with text (PNG), white background<small><br />
</gallery><br />
<br />
The logo was created by [http://benbois.posterous.com/ Benjamin "wooz" Bois] (thanks!) and is licensed under the [http://creativecommons.org/licenses/by-sa/3.0/ CC-BY-SA 3.0] license.<br />
<br />
The font used is [http://www.dafont.com/days.font Days]</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Logo&diff=8949Logo2014-05-02T15:10:55Z<p>Joelholdsworth: </p>
<hr />
<div>The '''sigrok logo''' is available for download in various formats here:<br />
<br />
<gallery><br />
File:Sigrok_logo_no_text_transparent_512.png|<small>Logo without text (PNG), transparent background<small><br />
File:Sigrok_logo.svg|<small>Logo with text (SVG), transparent background<small><br />
File:Sigrok_logo.png|<small>Logo with text (PNG), white background<small><br />
</gallery><br />
<br />
The logo was created by [http://benbois.posterous.com/ Benjamin "wooz" Bois] (thanks!) and is licensed under the [http://creativecommons.org/licenses/by-sa/3.0/ CC-BY-SA 3.0] license.<br />
<br />
The font used is "[http://www.dafont.com/days.font Days]"</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=8566User:Joelholdsworth/new main2014-01-26T12:54:20Z<p>Joelholdsworth: </p>
<hr />
<div><table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
</div><br />
<br />
<center>[[File:Front-page.png]]</center><br />
<br />
<br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=8565User:Joelholdsworth/new main2014-01-26T12:52:46Z<p>Joelholdsworth: </p>
<hr />
<div><center>[[File:Front-page.png]]</center><br />
<br />
<table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#eee; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
<br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=8564User:Joelholdsworth/new main2014-01-26T12:52:06Z<p>Joelholdsworth: </p>
<hr />
<div><center>[[File:Front-page.png]]</center><br />
<br />
<table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
<br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:Front-page.png&diff=8563File:Front-page.png2014-01-26T12:51:28Z<p>Joelholdsworth: Joelholdsworth uploaded a new version of &quot;File:Front-page.png&quot;</p>
<hr />
<div>== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=8562User:Joelholdsworth/new main2014-01-26T12:47:08Z<p>Joelholdsworth: </p>
<hr />
<div><table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
<br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<center>[[File:Front-page.png]]</center><br />
<br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:Front-page.png&diff=8561File:Front-page.png2014-01-26T12:44:33Z<p>Joelholdsworth: </p>
<hr />
<div>== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:Floor-right.png&diff=8560File:Floor-right.png2014-01-26T12:36:14Z<p>Joelholdsworth: </p>
<hr />
<div>== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:Floor-mid.png&diff=8559File:Floor-mid.png2014-01-26T12:35:58Z<p>Joelholdsworth: </p>
<hr />
<div>== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File:Floor-left.png&diff=8558File:Floor-left.png2014-01-26T12:35:10Z<p>Joelholdsworth: </p>
<hr />
<div>== Licensing ==<br />
{{CC-BY-SA-3.0}}</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=User:Joelholdsworth/new_main&diff=8557User:Joelholdsworth/new main2014-01-26T12:15:26Z<p>Joelholdsworth: Created page with "<table width="100%" valign="top"><tr valign="top"><td width="80%"> <div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; bor..."</p>
<hr />
<div><table width="100%" valign="top"><tr valign="top"><td width="80%"><br />
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;"><br />
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types, such as [[Supported_hardware#Logic_analyzers|logic analyzers]], [[Supported_hardware#Mixed-signal_devices|MSOs]], [[Supported_hardware#Oscilloscopes|oscilloscopes]], [[Supported_hardware#Multimeters|multimeters]], [[Supported_hardware#LCR meters|LCR meters]], [[Supported_hardware#Sound_level_meters|sound level meters]], [[Supported_hardware#Thermometers|thermometers]], [[Supported_hardware#Hygrometers|hygrometers]], [[Supported_hardware#Anemometers|anemometers]], [[Supported_hardware#Light meters|light meters]], [[Supported_hardware#Energy meters|Energy meters]], [[Supported_hardware#DAQs|DAQs]], [[Supported_hardware#Dataloggers|dataloggers]], [[Supported_hardware#Function_generators|function generators]], [[Supported_hardware#RF receivers|RF receivers]], [[Supported_hardware#Spectrum_analyzers|spectrum analyzers]], [[Supported_hardware#Power_supplies|power supplies]], [[Supported_hardware#GPIB_interfaces|GPIB interfaces]], and more.<br />
<br />
It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:<br />
<br />
<small><br />
* '''Broad hardware support'''. Supports many different logic analyzers, oscilloscopes, multimeters, data loggers etc. from various vendors.<br />
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]] (and on x86, ARM, Sparc, PowerPC, ...).<br />
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.<br />
* '''File format support'''. Supports various [[Input output formats|input/output file formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).<br />
* '''Reusable code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.<br />
</small><br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #d1adf6|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[http://www.sigrok.org/blog News] / [http://www.sigrok.org/blog Blog]</span>|<br />
CONTENT =<br />
<small><br />
<rss max=13 date="Y-m-d">http://sigrok.org/blog/rss.xml</rss><br />
See also: [[Current events]].<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lime|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Supported hardware</span> (<small><span style="font-variant:normal;">[[:Category:Device|Browse by category...]]</span></small>)|<br />
CONTENT =<br />
<small><br />
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison]])<br />
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] ([[Mixed-signal device comparison|comparison]])<br />
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]] ([[Oscilloscope comparison|comparison]])<br />
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison]], [[Device_cables#Multimeters|cables]], [[Multimeter ICs|ICs]])<br />
* [[Supported_hardware#LCR meters|LCR meters]] ([[LCR meter comparison|comparison]])<br />
* [[Supported_hardware#Sound_level_meters|Sound level meters]] ([[Sound level meter comparison|comparison]], [[Device_cables#Sound_level_meters|cables]])<br />
* [[Supported_hardware#Thermometers|Thermometers]] ([[Thermometer comparison|comparison]])<br />
* [[Supported_hardware#Hygrometers|Hygrometers]]<br />
* [[Supported_hardware#Anemometers|Anemometers]] ([[Anemometer comparison|comparison]])<br />
* [[Supported_hardware#Light meters|Light meters]] ([[Light meter comparison|comparison]])<br />
* [[Supported_hardware#Energy meters|Energy meters]]<br />
* [[Supported_hardware#DAQs|DAQs]] ([[DAQ comparison|comparison]])<br />
* [[Supported_hardware#Dataloggers|Dataloggers]] ([[Datalogger comparison|comparison]])<br />
* [[Supported_hardware#Function_generators|Function generators]] ([[Function generator comparison|comparison]])<br />
* [[Supported_hardware#RF receivers|RF receivers]]<br />
* [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] ([[Spectrum analyzer comparison|comparison]])<br />
* [[Supported_hardware#Power_supplies|Power supplies]] ([[Power supply comparison|comparison]])<br />
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison]])<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = cyan|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Documentation</span>|<br />
CONTENT =<br />
<small><br />
[[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #ff3333|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|<br />
CONTENT =<br />
<small><br />
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="clear: both;"><br />
<br />
<div style="width: 50%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = yellow|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|<br />
CONTENT = <br />
<small><br />
Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits] ([http://sourceforge.net/mailarchive/forum.php?forum_name=sigrok-commits archive]) &middot; IRC: [irc://chat.freenode.net/sigrok #sigrok]<br />
</small><br />
}}<br />
</div><br />
<br />
<div style="width: 49%; float: right; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = lightblue|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|<br />
CONTENT =<br />
<small><br />
[[Developers]] &middot; [http://sigrok.org/api/libsigrok/unstable/index.html libsigrok API] &middot; [http://sigrok.org/api/libsigrokdecode/unstable/index.html libsigrokdecode API] &middot; [http://sigrok.org/gitweb/ Browse source code] &middot; [http://sigrok.org/bugzilla/ Bug tracker] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]<br />
</small><br />
}}<br />
</div><br />
<br />
</div><br />
<br />
<div style="clear: both;margin-top: 2em;"><br />
----<br />
<small><br />
'''IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the <span style="color:red">CC-BY-SA 3.0</span> license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!'''<br />
</small><br />
</div><br />
__NOTOC__<br />
__NOEDITSECTION__</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=Fpgalafw&diff=7791Fpgalafw2013-12-06T09:09:24Z<p>Joelholdsworth: </p>
<hr />
<div>{{DISPLAYTITLE:fpgalafw}}<br />
'''This is a preliminary design'''<br />
<br />
'''fpgalafw''' is a proposal for a project to implement a universal logic analyser firmware for use as a firmware for commercial logic analysers that we wish to support, on FPGA development boards and for use as an in-circuit, or even in-FPGA debugging tool.<br />
<br />
== Benefits ==<br />
<br />
* Would simplify the implementation of libsigrok.<br />
** Reduced repetition.<br />
** Advanced triggering becomes hard when every manufacturer has a different trigger model. We can implement one to cover a variety of devices.<br />
* Unlock previously unsupported device features. If a feature is added to one LA, it is added to all.<br />
* Would enable support for more analysers such as the [[RockyLogic Ant8]], the [[RockyLogic Ant18e]], the [[ChronoVu LA8]] etc.<br />
<br />
== Goals ==<br />
<br />
* 100% open-source Verilog implementation (written from scratch or based off of other open-source projects).<br />
* Portable Verilog implementation that works (as much as possible) in a generic way.<br />
** Should work across all common FPGA/CPLD families from various vendors, including Xilinx, Altera, Microsemi/Actel, Lattice, etc.<br />
** Should work for any suitable FPGA/CPLD based logic analyzer board (existing devices or future ones than can be built specifically for use with this project), and any suitable CPLD/FPGA eval boards.<br />
** This means that the use of vendor-/family-specific constructs are discouraged in the "core" of the code. There might be optional per-device or per-vendor constructs that are not portable, but those should be moved outside the "core" so that as much functionality as possible works for any device.<br />
<br />
== Previous Projects ==<br />
<br />
There are various pre-existing open source firmware projects that can be drawn upon:<br />
<br />
* 2004 - [http://www.freepcb.com/eebit/ eebit]<br />
* 2006 - [http://www.sump.org/projects/analyzer/ SUMP] (written in VHDL)<br />
* 2008 - [http://opencores.org/project,openverifla openVeriFLA]<br />
* 2009 - [http://minila.sourceforge.net/index.php miniLA]<br />
* 2009 - [http://lekernel.net/blog/2009/01/usb-logic-analyzer/ LeKernel's Logic Analyser]<br />
* 2010 - [http://www.bastli.ethz.ch/index.php?page=BitHoundEn BitHound] (Derived from SUMP but with Ethernet interface)<br />
* 2011 - [http://dangerousprototypes.com/docs/Open_Bench_Logic_Sniffer OpenBench Logic Sniffer] (Derived from SUMP, ported to Verilog)<br />
** [http://gadgetforge.gadgetfactory.net/gf/project/butterflylogic/scmsvn/?action=browse&path=%2Ftrunk%2FVerilog_Core%2F Demon Core Verilog Source Code SVN]<br />
<br />
== Status ==<br />
Some intitial work has been done, but the project is not really started yet. The current best branches are<br />
* Joel Holdsworth's work on the demon core: https://github.com/jhol/butterflylogic<br />
* Iztok Jeras's work on the demone core: https://github.com/jeras/butterflylogic<br />
<br />
== Components ==<br />
<br />
fpgalafw will not work as a monolithic single firmware. Rather it is a library/framework of components that can be assembled together depending on the capabilities of the device, and the mode of operation.<br />
<br />
<div style="clear: both;"><br />
<div style="width: 31%; float: left; margin-right: 2%; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #cc0000|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Host Interface</span>|<br />
CONTENT =<br />
* [http://www.cypress.com/?id=193 Cypress FX2]<br />
* [http://www.ftdichip.com/Products/ICs/FT245BM.htm FTDI FT245] USB Fifo<br />
* RS232 (SUMP)<br />
* Ethernet<br />
* USB-MCU<br />
* JTAG - for ChipScope-like in-circuit use cases.<br />
* PCIe?<br />
* Parallel Port?<br />
* Cypress FX3?<br />
}}<br />
</div><br />
<div style="width: 31%; float: left; margin-right: 2%; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #f57900|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Storage</span>|<br />
CONTENT =<br />
* Internal Block-RAM (BRAM)<br />
* External DRAM<br />
* External SDRAM (DDR2, DDR3)<br />
* Burst RAM<br />
* Internal Soft-RAM? (Shift Registers)<br />
* Streaming Pass-through<br />
}}<br />
</div><br />
<div style="width: 31%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #edd400|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Data Packer</span>|<br />
CONTENT =<br />
* N-probes to M-data Lines Muxer<br />
* RLE Encoder<br />
* RLE + Golomb/Huffman/... Encoder?<br />
}}<br />
</div><br />
</div><br />
<br />
<div style="clear: both;"><br />
<div style="width: 31%; float: left; margin-right: 2%; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #73d216|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Indicator LEDs</span>|<br />
CONTENT =<br />
* None<br />
* Tri-colour<br />
* Multiple LEDs<br />
}}<br />
</div><br />
<div style="width: 31%; float: left; margin-right: 2%; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #3465a4|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Operating Modes</span>|<br />
CONTENT =<br />
* Storage Sampling<br />
** Asynchronous Mode<br />
** Externally Clocked Synchronous (State Analysis) Mode<br />
* Continuous Sampling<br />
* Pulse Counter<br />
* Time-to-digital Conversion<br />
* Signal Generation<br />
}}<br />
</div><br />
<div style="width: 31%; float: left; margin-bottom: 1em;"><br />
{{Box|<br />
BORDER = #8898bf|<br />
BACKGROUND = #75507b|<br />
WIDTH = 100%|<br />
ICON = |<br />
HEADING = <span style="font-variant:small-caps;">Triggering</span>|<br />
CONTENT =<br />
* External<br />
* Simple (Edge/Level)<br />
* Time Delayed<br />
* Advanced Triggers (the Demon Core replicates the behaviour of the HP16550)<br />
}}<br />
</div><br />
</div><br />
<br />
<div style="clear: both;"></div><br />
<br />
== Project Folder Structure ==<br />
<br />
Proposed project folder structure...<br />
<br />
* /<br />
** README<br />
** NEWS<br />
** Makefile<br />
** /boards<br />
*** /openbench-logic-sniffer<br />
*** /nexys2<br />
*** /papilio ...<br />
** /rtl<br />
*** /verilog<br />
**** /host-interface<br />
***** /cypress-fx2<br />
****** /software<br />
****** /firmware<br />
***** /sump<br />
****** /firmware<br />
****** ....<br />
**** /storage<br />
***** /ddr2<br />
****** /firmware<br />
***** /bram<br />
****** /firmware<br />
** /tools<br />
*** # Scripts etc in here<br />
** /sw<br />
*** # Embedded sofware here<br />
<br />
== Firmware Packaging ==<br />
<br />
Each device class will be given a firmware package that the driver can load. This package will be ZIP-file containing multiple firmware .bit files for the different permutations of modes and options that can be selected on this device. It is undesirable to have a single universal hardware file for each device, because multiple features will compete for use the limited number of logic units and internal storage.<br />
<br />
The firmware package will contain a text index file that indicates the capabilities of the device, its Bus ID, and a list of the firmware files available.<br />
<br />
== Firmware Build Environment ==<br />
<br />
The firmware will be built using a GNU Make driven build environment, which will be compatible with Altera, Xilinx, Microsemi/Actel, Lattice tools, and FreeHDL etc.<br />
<br />
== Protocol ==<br />
<br />
We will implement a common command protocol, common among all the host interfaces. (With the possible exception of SUMP if we plan to support that).</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=7783File format:Sigrok/v32013-12-04T14:45:37Z<p>Joelholdsworth: /* jhol's Musings */</p>
<hr />
<div>== Problem ==<br />
<br />
The current .sr file format is a ZIP file containing multiple files (some metadata files and actual sampling data files). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* ...<br />
<br />
== Wish list ==<br />
<br />
* It should be able to store metadata and arbitrary data (logic samples, and/or analog samples, and so on).<br />
* It must support compression.<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* Better compression properties (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, and so on.<br />
* Independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), OS, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
<div style="color: green"><br />
* Must be (optionally) possible to store extra UI state data. E.g User configured probe colours, names, positions.<br />
</div><br />
<br />
We were planning [[Input output formats/sigrok session|a new file format]] and a full spec for it for other reasons already, but this will probably be obsolete anyway and solved differently (see above).<br />
<br />
== jhol's Musings ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
** Similarly RTP is a rather natural protocol for sigrok network streaming.<br />
* PulseView needs some means to save state: Probe names/colours/positions etc. Probably best to store this in an INI file (- JSON?). In ZIP this is easy - just add an extra file to the archive.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=7782File format:Sigrok/v32013-12-04T14:42:33Z<p>Joelholdsworth: /* jhol's Musings */</p>
<hr />
<div>== Problem ==<br />
<br />
The current .sr file format is a ZIP file containing multiple files (some metadata files and actual sampling data files). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* ...<br />
<br />
== Wish list ==<br />
<br />
* It should be able to store metadata and arbitrary data (logic samples, and/or analog samples, and so on).<br />
* It must support compression.<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* Better compression properties (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, and so on.<br />
* Independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), OS, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
<div style="color: green"><br />
* Must be (optionally) possible to store extra UI state data. E.g User configured probe colours, names, positions.<br />
</div><br />
<br />
We were planning [[Input output formats/sigrok session|a new file format]] and a full spec for it for other reasons already, but this will probably be obsolete anyway and solved differently (see above).<br />
<br />
== jhol's Musings ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for lossless analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
* PulseView needs some means to save state: Probe names/colours/positions etc. Probably best to store this in an INI file (- JSON?). In ZIP this is easy - just add an extra file to the archive.</div>Joelholdsworthhttps://sigrok.org/w/index.php?title=File_format:Sigrok/v3&diff=7781File format:Sigrok/v32013-12-04T14:42:17Z<p>Joelholdsworth: </p>
<hr />
<div>== Problem ==<br />
<br />
The current .sr file format is a ZIP file containing multiple files (some metadata files and actual sampling data files). This works fine, but it also has some issues:<br />
<br />
* In order to get to the data you want, you need to decompress the whole file.<br />
* Appending to a file is not possible easily (and it's not efficient).<br />
* ...<br />
<br />
== Wish list ==<br />
<br />
* It should be able to store metadata and arbitrary data (logic samples, and/or analog samples, and so on).<br />
* It must support compression.<br />
* It should be able to handle run-time changes in the data streams (via meta packets on the session bus), e.g. changing samplerates, changing probes, etc. etc.<br />
* Better compression properties (e.g. using LZO or other algorithms, this is to be evaluated). What we ideally want out of the compression algorithm is:<br />
** Good and relatively fast compression results at only moderate CPU usage.<br />
** Very fast decompression (LZO is probably the best one here, as it's specifically designed for this).<br />
** Ideally, support for appending further data to already compressed data chunks (though this could be also implemented outside of the compression algorithm per se).<br />
** Open-source license and OS portability. There should be an open-source library or code chunk for compression/uncompression and it should be widely available in Linux distros, and portable to Windows, Mac OS X, FreeBSD, and so on.<br />
* Independent of hardware architecture (x86, ARM, PowerPC, MIPS, and so on), OS, endianness, float representation, and so on. All data fields must be properly specified (endianness, signedness, size, format).<br />
<div style="color: green"><br />
* Must be (optionally) possible to store extra UI state data. E.g User configured probe colours, names, positions.<br />
</div><br />
<br />
We were planning [[Input output formats/sigrok session|a new file format]] and a full spec for it for other reasons already, but this will probably be obsolete anyway and solved differently (see above).<br />
<br />
== jhol's Musings ==<br />
<br />
* Data should be encoded in a data aware way. This would give greater compression:<br />
** Logic Data is most efficient stored in RLE+Huffman or Golomb coding. e.g. a clock signal may compress to one bit per edge.<br />
** FLAC (libflac) or a FLAC inspired codec (linear predicition) is probably as good as it gets for analog data encoding.<br />
* If data is stored in a format specific way, it would be best to store it as a series of stream-blocks, similar to how video containers work. Would it be possible to simply leverage a video container such as OGG? IIRC this contains headers to declare metadata about each stream, then a series of timestamped stream blocks interleaved together. The time stamp is a format specific number... for audio: the sample number, for video: the frame number, so sigrok formats can easily leverage this.<br />
* PulseView needs some means to save state: Probe names/colours/positions etc. Probably best to store this in an INI file (- JSON?). In ZIP this is easy - just add an extra file to the archive.</div>Joelholdsworth