sigrok - User contributions [en]

Mac OS X

2015-10-31T22:24:30Z

Rene: /* Building manually */

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==

These instructions have been tested on Mac OS X 10.9.1.

=== Requirements ===

Install [http://brew.sh Homebrew].

Tap sigrok:


$ '''brew tap rene-dev/sigrok'''


If you want [[PulseView]], you must install unstable.

=== Unstable ===


$ '''brew install python3'''
$ '''brew install --HEAD libserialport'''
$ '''brew install --HEAD --with-libserialport libsigrok'''
$ '''brew install --HEAD libsigrokdecode'''
$ '''brew install --HEAD --with-libserialport sigrok-cli'''
$ '''brew install --HEAD pulseview'''


=== Stable ===

If you just want [[sigrok-cli]], you can install stable.


$ '''brew install sigrok-cli'''


== Building manually ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4, 10.9.1 and 10.11.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).

Install git (not needed at least with 10.8.4):


$ '''sudo port install git-core'''


This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:


$ '''sudo port install boost libusb libzip libftdi0'''


Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.


$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''


Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.


$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''


=== libserialport ===

[[libserialport]] is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.


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


=== libsigrok ===


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


=== libsigrokdecode ===


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


=== sigrok-cli ===


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


=== PulseView ===


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


== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]].
* [[Mac OS X/Universal|Building universal DyLibs and binaries]].
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler].

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Mac OS X

2015-10-31T22:23:22Z

Rene: /* Unstable */

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==

These instructions have been tested on Mac OS X 10.9.1.

=== Requirements ===

Install [http://brew.sh Homebrew].

Tap sigrok:


$ '''brew tap rene-dev/sigrok'''


If you want [[PulseView]], you must install unstable.

=== Unstable ===


$ '''brew install python3'''
$ '''brew install --HEAD libserialport'''
$ '''brew install --HEAD --with-libserialport libsigrok'''
$ '''brew install --HEAD libsigrokdecode'''
$ '''brew install --HEAD --with-libserialport sigrok-cli'''
$ '''brew install --HEAD pulseview'''


=== Stable ===

If you just want [[sigrok-cli]], you can install stable.


$ '''brew install sigrok-cli'''


== Building manually ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).

Install git (not needed at least with 10.8.4):


$ '''sudo port install git-core'''


This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:


$ '''sudo port install boost libusb libzip libftdi0'''


Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.


$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''


Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.


$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''


=== libserialport ===

[[libserialport]] is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.


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


=== libsigrok ===


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


=== libsigrokdecode ===


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


=== sigrok-cli ===


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


=== PulseView ===


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


== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]].
* [[Mac OS X/Universal|Building universal DyLibs and binaries]].
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler].

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Downloads

2014-10-21T23:16:06Z

Rene: /* Binaries and distribution packages */

== Releases ==

You can download the latest released tarballs of the following subprojects from [http://sigrok.org/download/ the sigrok.org download directory]:

{| border="0" style="font-size: smaller; white-space: nowrap;" class="alternategrey sigroktable"
|-
!Project
!Release/download
!News

|-
| [[libserialport]]
| [http://sigrok.org/download/source/libserialport/libserialport-0.1.0.tar.gz libserialport-0.1.0.tar.gz]
| [http://sigrok.org/gitweb/?p=libserialport.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[libsigrok]]
| [http://sigrok.org/download/source/libsigrok/libsigrok-0.3.0.tar.gz libsigrok-0.3.0.tar.gz]
| [http://sigrok.org/gitweb/?p=libsigrok.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[libsigrokdecode]]
| [http://sigrok.org/download/source/libsigrokdecode/libsigrokdecode-0.3.0.tar.gz libsigrokdecode-0.3.0.tar.gz]
| [http://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[sigrok-cli]]
| [http://sigrok.org/download/source/sigrok-cli/sigrok-cli-0.5.0.tar.gz sigrok-cli-0.5.0.tar.gz]
| [http://sigrok.org/gitweb/?p=sigrok-cli.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[PulseView]]
| [http://sigrok.org/download/source/pulseview/pulseview-0.2.0.tar.gz pulseview-0.2.0.tar.gz]
| [http://sigrok.org/gitweb/?p=pulseview.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[Example dumps|sigrok-dumps]]
| [http://sigrok.org/download/source/sigrok-dumps/sigrok-dumps-0.1.0.tar.gz sigrok-dumps-0.1.0.tar.gz]
| [http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[fx2lafw|sigrok-firmware-fx2lafw]] (source code)
| [http://sigrok.org/download/source/sigrok-firmware-fx2lafw/sigrok-firmware-fx2lafw-0.1.2.tar.gz sigrok-firmware-fx2lafw-0.1.2.tar.gz]
| [http://sigrok.org/gitweb/?p=sigrok-firmware-fx2lafw.git;a=blob;f=NEWS;hb=HEAD release notes]

|-
| [[fx2lafw|sigrok-firmware-fx2lafw]] (prebuilt firmware)
| [http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/sigrok-firmware-fx2lafw-bin-0.1.2.tar.gz sigrok-firmware-fx2lafw-bin-0.1.2.tar.gz]
| [http://sigrok.org/gitweb/?p=sigrok-firmware-fx2lafw.git;a=blob;f=NEWS;hb=HEAD release notes]

|}

== Binaries and distribution packages ==

* '''Debian:''' [http://packages.qa.debian.org/s/sigrok.html sigrok] (pulls [http://packages.qa.debian.org/libs/libserialport.html libserialport], [http://packages.qa.debian.org/libs/libsigrok.html libsigrok], [http://packages.qa.debian.org/libs/libsigrokdecode.html libsigrokdecode], [http://packages.qa.debian.org/s/sigrok-cli.html sigrok-cli], [http://packages.qa.debian.org/p/pulseview.html pulseview], [http://packages.qa.debian.org/s/sigrok-firmware-fx2lafw.html sigrok-firmware-fx2lafw])
* '''Ubuntu:''' [http://launchpad.net/ubuntu/+source/sigrok sigrok] (pulls [http://launchpad.net/ubuntu/+source/libserialport libserialport], [http://launchpad.net/ubuntu/+source/libsigrok libsigrok], [http://launchpad.net/ubuntu/+source/libsigrokdecode libsigrokdecode], [http://launchpad.net/ubuntu/+source/sigrok-cli sigrok-cli], [http://launchpad.net/ubuntu/+source/pulseview pulseview], [http://launchpad.net/ubuntu/+source/sigrok-firmware-fx2lafw sigrok-firmware-fx2lafw])
* '''Arch Linux:''' [https://aur.archlinux.org/packages.php?O=0&K=sigrok&do_Search=Go AUR (Arch Linux User Repository)], [https://aur.archlinux.org/packages/libserialport/ libserialport], [https://aur.archlinux.org/packages/libsigrok/ libsigrok], [https://aur.archlinux.org/packages/libsigrokdecode/ libsigrokdecode], [https://aur.archlinux.org/packages/sigrok-cli/ sigrok-cli], [https://aur.archlinux.org/packages/pulseview/ pulseview], [https://aur.archlinux.org/packages/sigrok-firmware-fx2lafw/ sigrok-firmware-fx2lafw]
* '''Slackware:''' [http://slackware.opennix.com/?slackversion=13.37&name=sigrok Package page]
* '''Fedora:''' [http://pkgs.fedoraproject.org/cgit/libsigrok.git/ libsigrok], [http://pkgs.fedoraproject.org/cgit/libsigrokdecode.git libsigrokdecode], [http://pkgs.fedoraproject.org/cgit/sigrok-cli.git sigrok-cli], [http://pkgs.fedoraproject.org/cgit/pulseview.git pulseview], [http://pkgs.fedoraproject.org/cgit/sigrok-firmware-fx2lafw.git sigrok-firmware-fx2lafw], [http://pkgs.fedoraproject.org/cgit/sigrok-firmware.git sigrok-firmware] (see also: [[Linux/Fedora]])
* '''Windows:'''
** Nightly installer binaries: [http://sigrok.org/jenkins/job/sigrok-cross-mingw/default/lastSuccessfulBuild/artifact/pulseview-NIGHTLY-installer.exe pulseview-NIGHTLY-installer.exe], [http://sigrok.org/jenkins/job/sigrok-cross-mingw/default/lastSuccessfulBuild/artifact/sigrok-cli-NIGHTLY-installer.exe sigrok-cli-NIGHTLY-installer.exe]
** See also [[Windows#Windows_installers|Windows]] for more information, including driver and firmware handling.
* '''Mac OS X:''' [[Mac_OS_X#Building_using_Homebrew|Building using Homebrew]], There are no packages yet, contributors welcome! Some older instructions are at [http://home2.xor-gate.org/writings/sigrok-osx-scratchbuild xor-gate.org] (work in progress; "Wafelijzer" on IRC)
* '''FreeBSD:''' [http://www.freshports.org/devel/libserialport/ libserialport], [http://www.freshports.org/devel/libsigrok/ libsigrok], [http://www.freshports.org/devel/libsigrokdecode/ libsigrokdecode], [http://www.freshports.org/science/sigrok-cli/ sigrok-cli], [http://www.freshports.org/science/pulseview/ pulseview], [http://www.freshports.org/science/sigrok-firmware-fx2lafw/ sigrok-firmware-fx2lafw], [http://www.freshports.org/science/sigrok-firmware/ sigrok-firmware], [http://www.freshports.org/science/sigrok-firmware-utils/ sigrok-firmware-utils]
* '''OpenBSD:''' There are no ports/packages yet, contributors welcome!
* '''Android:''' See [[Android]] for the current status.
* '''Gentoo:''' [http://packages.gentoo.org/package/dev-libs/libserialport libserialport], [http://packages.gentoo.org/package/sci-libs/libsigrok libsigrok], [http://packages.gentoo.org/package/sci-libs/libsigrokdecode libsigrokdecode], [http://packages.gentoo.org/package/sci-electronics/sigrok-cli sigrok-cli], [http://packages.gentoo.org/package/sci-electronics/pulseview pulseview], [http://packages.gentoo.org/package/sys-firmware/sigrok-firmware-fx2lafw sigrok-firmware-fx2lafw]

Please contact us if you want to work on packages for other Linux distributions or OSes.

== Source code ==

The development is done in various [http://sigrok.org/gitweb/ git repositories].

See [[Building]] for build instructions.

== Example data ==

See the [[Example dumps]] wiki page.

== Firmware files ==

See the [[Firmware]] wiki page.

Velleman PCS500

2014-07-24T00:49:33Z

Rene: /* Resources */

== Hardware ==

* '''Main oscillator''': 50MHz
* '''RAM''': SB61L256, 768x8-Bits STATIC CMOS RAM
* '''ADC''': ADS830, 8-Bit, 60MHz
lots of 74xx glue logic

== Photos ==
<gallery>
File:Velleman PCS500 top.jpg|PCB, Top
File:Velleman PCS500 bottom.jpg|PCB, Bottom
File:Velleman PCS500 RAM.jpg|PCB, RAM
File:Velleman PCS500 opto.jpg|PCB, opto
</gallery>

== Resources ==
http://kdataserv.fis.fc.ul.pt/~jmal/TclVI_Wiki/index.php/Hackers_guide

http://kdataserv.fis.fc.ul.pt/software/TclVI/

http://forum.velleman.eu/viewtopic.php?f=10&t=4314

[[Category:Device]]
[[Category:Oscilloscope]]

Velleman PCS500

2014-07-24T00:26:38Z

Rene: /* Resources */

Velleman PCS500

2014-07-24T00:26:28Z

Rene: /* Resources */

== Hardware ==

* '''Main oscillator''': 50MHz
* '''RAM''': SB61L256, 768x8-Bits STATIC CMOS RAM
* '''ADC''': ADS830, 8-Bit, 60MHz
lots of 74xx glue logic

== Photos ==
<gallery>
File:Velleman PCS500 top.jpg|PCB, Top
File:Velleman PCS500 bottom.jpg|PCB, Bottom
File:Velleman PCS500 RAM.jpg|PCB, RAM
File:Velleman PCS500 opto.jpg|PCB, opto
</gallery>

== Resources ==
http://kdataserv.fis.fc.ul.pt/~jmal/TclVI_Wiki/index.php/Hackers_guide
http://kdataserv.fis.fc.ul.pt/software/TclVI/

[[Category:Device]]
[[Category:Oscilloscope]]

Velleman PCS500

2014-07-24T00:17:23Z

Rene:

File:Velleman PCS500 opto.jpg

2014-07-23T23:55:11Z

Rene:

File:Velleman PCS500 RAM.jpg

2014-07-23T23:54:10Z

Rene:

File:Velleman PCS500 top.jpg

2014-07-23T23:53:02Z

Rene:

File:Velleman PCS500 bottom.jpg

2014-07-23T23:51:42Z

Rene:

Velleman PCS500

2014-07-23T21:04:28Z

Rene: /* Resources */

== Resources ==
http://kdataserv.fis.fc.ul.pt/~jmal/TclVI_Wiki/index.php/Hackers_guide

[[Category:Device]]
[[Category:Oscilloscope]]

Velleman PCS500

2014-07-23T21:02:58Z

Rene: Created page with "== Resources == http://kdataserv.fis.fc.ul.pt/~jmal/TclVI_Wiki/index.php/Hackers_guide"

== Resources ==
http://kdataserv.fis.fc.ul.pt/~jmal/TclVI_Wiki/index.php/Hackers_guide

Hantek 6052BE

2014-07-23T20:57:51Z

Rene: /* Resources */

[[File:Hantek front.jpg|thumb|right|Hantek 6052BE]]

The [http://www.hantek.com/en/ProductDetail_2_31.html Hantek 6052BE] is a USB-based, 2-channel oscilloscope with an analog bandwidth of 150MS/s sampling rate.

== Hardware ==

* '''Main chip''': [http://www.xilinx.com/support/documentation/spartan-3an_data_sheets.htm Xilinx Spartan XC3S50A] ([http://www.xilinx.com/support/documentation/data_sheets/ds557.pdf datasheet])
* '''Main oscillator''': 50MHz 50.000 YX FH
* '''USB''': Cypress CY7C68013A-100AXC (FX2LP)
* '''U1, U2 32K x 8 high-speed CMOS static RAM''': 2x [http://www.issi.com/products-asynchronous-sram.htm ISSI IS61LV256AL-10TLI] ([http://www.issi.com/WW/pdf/61LV256AL.pdf datasheet])
* '''U807 I2C EEPROM''': Microchip 24LC02BI (for the USB VID/PID of the Cypress FX2LP)
* '''U6, U35, U50 Dual 4-channel analog multiplexer/demultiplexer''': NXP HEF4052BT
* '''U12 8-bit serial-in, serial or parallel-out shift register with output latches; 3-state''': NXP HC595 [http://www.nxp.com/documents/data_sheet/74HC_HCT595.pdf HXP HC595] ([http://www.nxp.com/documents/data_sheet/74HC_HCT595.pdf datasheet])
* '''U26 RAIL-TO-RAIL OUTPUT OPERATIONAL AMPLIFIERS''': TI TLV274C ([http://www.ti.com/lit/ds/symlink/tlv274-q1.pdf datasheet])
* '''UNKNOW IC U4''': chip EEPROM - similar to 25L4005
* '''UNKNOW IC U14''': may be an amplifier
* '''UNKNOW IC U22''':

== Photos ==

<gallery>
File:Hantek front.jpg|Hantek 6052BE Front
File:Hantek bak.jpg|Hantek 6052BE Back
File:Hantek 6052BE back.jpg|PCB Hantek 6052BE Back
File:Hantek 6052BE front.jpg|PCB Hantek 6052BE Front
File:Input circuits.jpg|Input Circuits Hantek 6052BE
</gallery>

== Protocol ==

== Extracting the firmware ==

== Resources ==
https://github.com/olerem/openhantek/commit/9a0d2747edc9306b1b56c04a4a9d491269023c76

http://www.openhantek.org/forum/topic/4/13/

[[Category:Device]]
[[Category:Oscilloscope]]

Hameg HMO2024

2014-01-11T14:07:13Z

Rene: /* Resources */

[[File:Hameg HMO2024.png|thumb|right|Hameg HMO2024]]

The [http://webstore.rohde-schwarz.com/us/hamegr-hmo2024.html Hameg HMO2024] is a USB-/RS232-based, 4-channel oscilloscope with an analog bandwidth of 200MHz and 2GS/s sampling rate.

See [[Hameg HMO2024/Info]] for more details (such as '''lsusb -v''' output) about the device.

== Hardware ==

TODO.

== Photos ==

<gallery>
File:Hameg HMO2024.png|Device, front
File:Hameg HMO2024 back.png|Device, back
File:Hameg_HMO_USB-serial_module.jpg|HO 720 serial communication option
File:Hameg HO3508 logic probe pod.jpg|HO3508 logic probe pod
File:Hameg HO3508 logic probe back.jpg|HO3508 logic probe pod, back
File:Hameg HO3508 logic probe.jpg|HO3508 logic probe
</gallery>

== Protocol ==

The Hameg HMO series of scopes use [[IEEE-488|SCPI]] as the communication protocol.

== Resources ==

* [http://www.hameg.com/manuals.0.html?no_cache=1 Hameg - resource page]
* [http://midas.herts.ac.uk/helpsheets/hameg_scpi_hmo72.pdf Hameg HMO - programming guide]
* [http://www.ftdichip.com/Support/Documents/TechnicalNotes/TN_105%20Adding%20Support%20for%20New%20FTDI%20Devices%20to%20Mac%20Driver.pdf FTDI OS X Driver]
* [https://rowley.zendesk.com/entries/109069-getting-jtag-and-serial-port-to-work-under-mac-os-x-using-a-luminary-ftdi-target-interface changing vid/pid in FTDIUSBSerialDriver.kext]

[[Category:Device]]
[[Category:Oscilloscope]]
[[Category:Logic analyzer]]
[[Category:Mixed-signal oscilloscope]]
[[Category:Supported]]

Mac OS X

2014-01-11T13:07:03Z

Rene: /* Building using Homebrew */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==
These instructions have been tested on Mac OS X 10.9.1.
=== Requirements ===

Install Homebrew. http://brew.sh/

Tap sigrok:

$ '''brew tap rene-dev/sigrok'''

You cannot mix stable and unstable.

=== Unstable ===
$ '''brew install --HEAD libserialport'''

$ '''brew install --HEAD --with-libserialport libsigrok'''

$ '''brew install --HEAD libsigrokdecode'''

$ '''brew install --HEAD --with-libserialport sigrok-cli'''

$ '''brew install --HEAD pulseview'''

if it complains about python:

$ '''brew install python3'''
=== Stable ===
the stable version of pulseview does not build on OS X.

$ '''brew install sigrok-cli'''

== Building ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).



Install git (not needed at least with 10.8.4):

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:

$ '''sudo port install boost libusb libzip libftdi0'''

Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.

$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''

Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.

$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''

=== [[libserialport]] ===
''libserialport'' is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.

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

=== libsigrok ===

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

=== libsigrokdecode ===

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

=== sigrok-cli ===

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

=== PulseView ===

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



== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

PulseView

2014-01-04T12:10:29Z

Rene: /* Building */

[[File:20121006-scroll-bars.png|thumb|320px|right|PulseView on KDE (06/10/2012)]]

'''PulseView''' is a Qt based logic analyzer GUI for sigrok.

== Features ==

* Fast O(log N) signal rendering at all zoom levels.
* [[Protocol decoders|Protocol decoder]] support

== Download ==

[[http://sigrok.org/gitweb/?p=pulseview.git;a=summary Browse Source]]

$ '''git clone git://sigrok.org/pulseview.git'''

== Requirements ==

See [[Building#PulseView]].

== Building ==

See [[Linux#PulseView]] (or any other of the [[Building#Building_from_source|OS-specific instruction pages]]).

'''Additional notes:'''

* Use <code>PKG_CONFIG_PATH=/''<prefix-of-libsigrok-installation>''/lib/pkgconfig/</code> if [[libsigrok]] and [[libsigrokdecode]] are installed to a non-standard prefix.
* To change the install prefix: <code>cmake -DCMAKE_INSTALL_PREFIX=''<prefix-dir>''/ ..</code>
* To show compiler arguments during the build: <code>make VERBOSE=1</code>
* To make a non-stripped debug build <code>cmake -DCMAKE_BUILD_TYPE=Debug ..</code>
* To enable unit tests: <code>cmake -DENABLE_TESTS=y ..</code>
* To enable decoders: <code>cmake -DENABLE_DECODE=y ..</code>
* To disable -Werror: <code>cmake -DDISABLE_WERROR=y ..</code>
* To build with clang: <code>CXX=clang++ cmake ..</code>
* If cmake complains that it can only find Qt5, even though you have Qt4 installed: <code>cmake -DQT_QMAKE_EXECUTABLE:string=qmake-qt4 ..</code>

== Resources ==

* [[PulseView/Architecture|PulseView Architecture Overview]]
* [[TODO#pulseview|TODO List]]
* [https://www.ohloh.net/p/pulseview PulseView on ohloh]
* [http://airwebreathe.org.uk/w/doku.php?id=pulseview Joel Holdsworth's personal PulseView project page]

Mac OS X

2014-01-04T03:18:55Z

Rene:

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==
These instructions have been tested on Mac OS X 10.9.1.
=== Requirements ===

Install Homebrew. http://brew.sh/

Tap sigrok:

$ '''brew tap rene-dev/sigrok'''

=== Unstable ===
$ '''brew install --HEAD libserialport libsigrok libsigrokdecode sigrok-cli pulseview'''

=== Stable ===

$ '''brew install sigrok-cli'''

== Building ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).



Install git (not needed at least with 10.8.4):

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:

$ '''sudo port install boost libusb libzip libftdi0'''

Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.

$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''

Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.

$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''

=== [[libserialport]] ===
''libserialport'' is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.

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

=== libsigrok ===

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

=== libsigrokdecode ===

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

=== sigrok-cli ===

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

=== PulseView ===

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



== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Mac OS X

2014-01-04T03:09:16Z

Rene: /* Building using Homebrew */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==
These instructions have been tested onMac OS X 10.9.1.

Install Homebrew. http://brew.sh/

Tap sigrok:

$ '''brew tap rene-dev/sigrok'''

== Building ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).



Install git (not needed at least with 10.8.4):

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:

$ '''sudo port install boost libusb libzip libftdi0'''

Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.

$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''

Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.

$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''

=== [[libserialport]] ===
''libserialport'' is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.

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

=== libsigrok ===

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

=== libsigrokdecode ===

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

=== sigrok-cli ===

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

=== PulseView ===

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



== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Mac OS X

2014-01-04T03:08:09Z

Rene: /* Building */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build the sigrok subprojects on Mac OS X.

== Building using Homebrew ==
These instructions have been tested onMac OS X 10.9.1.

Install Homebrew. http://brew.sh/

Tap sigrok: $ '''brew tap rene-dev/sigrok'''

== Building ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).



Install git (not needed at least with 10.8.4):

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:

$ '''sudo port install boost libusb libzip libftdi0'''

Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.

$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''

Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.

$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''

=== [[libserialport]] ===
''libserialport'' is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.

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

=== libsigrok ===

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

=== libsigrokdecode ===

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

=== sigrok-cli ===

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

=== PulseView ===

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



== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Mac OS X

2014-01-04T02:41:55Z

Rene: /* Building */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build the sigrok subprojects on Mac OS X.

== Building ==

These instructions have been tested on a clean install of Mac OS X 10.6.8, 10.8.4 and 10.9.1.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode and Command Line Tools for Xcode be installed on your machine, which are also a dependencies to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for [[PulseView]]).



Install git (not needed at least with 10.8.4):

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install boost, libusb, libzip and libftdi, the libsigrok build dependencies:

$ '''sudo port install boost libusb libzip libftdi0'''

Install autoconf, automake, cmake, glib2.0+, python 3.3, libtool and pkgconfig to satisfy version dependencies in the build process.

$ '''sudo port install autoconf automake cmake glib2 python33 libtool pkgconfig'''

Set the PKG_CONFIG_PATH environment variable to reflect the future locations of libsigrok and libsigrokdecode for the sigrok-cli build process.

$ '''export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/'''

=== [[libserialport]] ===
''libserialport'' is optional and required only for devices with serial connection, e.g. most multimeters. If not present during configuring libsigrok, the respective drivers in libsigrok will be disabled.

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

=== libsigrok ===

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

=== libsigrokdecode ===

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

=== sigrok-cli ===

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

=== PulseView ===

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



== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Mac OS X

2013-04-02T19:50:15Z

Rene: /* Requirements */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build sigrok on Mac OS X.

== Building ==

These instructions have been tested on a clean Mac OS X 10.6.8 install.

=== Requirements ===

Install MacPorts, follow the guide on [http://www.macports.org/install.php macports.org] (this step will require Xcode on your machine, which is also a dependency to build sigrok).

Install Qt, download qt-mac-opensource-4.7.4.dmg from [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x qt.nokia.com] (Only needed for sigrok-qt).

TODO: Install GTK+ libs and dependencies for sigrok-gtk.

Install git:

$ '''sudo port install git-core'''

This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Install libusb, libzip and libftdi, the sigrok build dependencies:

$ '''sudo port install libusb'''
$ '''sudo port install libzip'''
$ '''sudo port install libftdi'''

Building [[libsigrok]]:

$ '''git clone git://sigrok.org/libsigrok'''
$ '''cd libsigrok'''
$ '''./autogen.sh'''
$ '''./configure --disable-link-mso19 --disable-alsa'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''

Building [[libsigrokdecode]]:

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

Then you need to build the chosen user interfaces (cli, qt or gtk).

For building [[sigrok-cli]] (the command-line interface for sigrok):

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

For building [[PulseView]]:

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

For building [[sigrok-gtk]] ('''Note:''' The GTK+ GUI is not yet usable!):

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

For building [[sigrok-qt]] ('''Note:''' The Qt GUI is not yet usable!):

$ '''git clone git://sigrok.org/sigrok-qt'''
$ '''cd sigrok-qt'''
$ '''PKG_CONFIG_PATH=/usr/local/lib/pkgconfig qmake -spec macx-g++'''
$ '''make'''
$ '''sudo make install'''
$ '''cd ..'''

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.

Open the sigrok-gui application just built:

$ '''open -a sigrok-gui.app'''

== Notes ==

* To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.
* Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.
* See also [http://xor-gate.org/writings/sigrok-osx-scratchbuild Wafelijzer's efforts to build Mac OS X binaries].
** Python framework incorrect build for OS X [http://bugs.python.org/issue15353 issue 15353]

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]
* Bundle the dynamic libraries with [http://macdylibbundler.sourceforge.net MacDylibBundler]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/library/mac/#documentation/Porting/Conceptual/PortingUnix/compiling/compiling.html Porting UNIX/Linux Applications to Mac OS X]
* [http://cairographics.org/end_to_end_build_for_mac_os_x CairoGraphics - End to End build for Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]
* [http://stackoverflow.com/questions/1596945/building-osx-app-bundle Stackoverflow - Building OSX App Bundle]

Hardware driver API

2012-12-29T15:42:52Z

Rene:

Every driver must define a '''struct sr_dev_driver''' to register it with libsigrok. It is defined as follows:

struct sr_dev_driver {
/* Driver-specific */
char *name;
char *longname;
int api_version;
int (*init) (void);
int (*cleanup) (void);
GSList *(*scan) (GSList *options);
GSList *(*dev_list) (void);
int (*dev_clear) (void);

/* Device-specific */
int (*dev_open) (struct sr_dev_inst *sdi);
int (*dev_close) (struct sr_dev_inst *sdi);
int (*info_get) (int info_id, const void **data,
const struct sr_dev_inst *sdi);
int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
const void *value);
int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
void *cb_data);
int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
void *cb_data);

/* Dynamic */
void *priv;
};

This structure should be the only symbol imported into the libsigrok namespace. The driver's variables thus cannot conflict with the global libsigrok namespace.

* '''name'''
<blockquote>
A short string describing this driver. It should contain only lowercase a-z, 0-9 and dashes (-). It will be referenced in saved session files.
</blockquote>

* '''longname'''
<blockquote>
A longer freeform string describing this driver. It will be shown to the user.
</blockquote>

* '''api_version'''
<blockquote>
Currently defined as 1.
</blockquote>

Most of the other members of the structure are pointers to driver callbacks:

* '''init()'''
<blockquote>
Called when the driver is initially loading into libsigrok, typically at program start.
Returns SR_OK if successful, SR_ERR otherwise.
</blockquote>

* '''cleanup()'''
<blockquote>
Called before the driver is unloaded. Any resources the driver holds must be released here, such as memory or connectivity library handles.
Returns SR_OK if successful, SR_ERR otherwise.
</blockquote>

* '''scan(GSList *options)'''
<blockquote>
When a frontend wants a driver to scan for devices on the system that it knows about, this function is called. If a device was found, any initialization it needs must be performed here; for example, uploading firmware should be done here.

A driver for USB-connected devices typically doesn't need any help with this: it will find devices known to it by their VendorID and ProductID (VID:PID).

However other drivers — notably those which use a serial port — need to be pointed at the device. The GSList <code>options</code> contains instances of this struct:

<pre>
struct sr_hwopt {
int hwopt;
const void *value;
};
</pre>

There are currently two valid <code>hwopt</code> values: '''SR_HWOPT_CONN''', where the associated value contains a string pointing the driver at the resource it needs to connect to. Right now that means a serial port of the form <code>/dev/ttyUSB0</code> or <code>/dev/ttyACM0</code>. The second <code>hwopt</code> is '''SR_HWOPT_SERIALCOMM''', which defines the serial communication parameters for the given port in the form ''<baudrate>/<data bits><parity><stop bits>'', for example "9600/8n1" or "600/7o2".

For serial port-based drivers, '''SR_HWOPT_CONN''' is always required, and '''SR_HWOPT_SERIALCOMM''' always optional: the driver should know at which bitrate its device(s) can communicate, or probe for it.

Any devices found must have a <code>struct sr_dev_inst</code> created, which is added to the driver's known instances -- a GSList stored in the driver context's <code>instances</code> field.

A copy of the <code>struct sr_dev_inst</code> for every device found in the current invocation of <code>scan()</code> must also be returned in a GSList from the function itself; the frontend is responsible for freeing the list (but will not touch the instances it contains).

The instances thus returned to the frontend are central to the communication between the driver and the libsigrok frontend: every other callback function has an instance struct as a parameter.
</blockquote>

* '''dev_list()'''
<blockquote>
Called whenever the frontend needs a list of device instances the driver knows about. This should just return the <code>instances</code> field in the driver's context struct.
</blockquote>

* '''dev_clear()''' 
<blockquote>
Clear the list of device instances the driver knows about. A frontend may call the <code>scan()</code> function multiple times to add to the driver's list of known devices, for example with a different serial port each time. If the frontend then wants to start over, it needs this function to clear the list.
Returns SR_OK if successful, SR_ERR otherwise.
</blockquote>

* '''dev_open(struct sr_dev_inst *sdi)''' 
<blockquote>
Open the specified device.
Returns SR_OK if successful, SR_ERR otherwise.
</blockquote>

* '''dev_close(struct sr_dev_inst *sdi)''' 
<blockquote>
Close the specified device.
Returns SR_OK if successful, SR_ERR otherwise.
</blockquote>

* '''info_get(int info_id, const void **data, struct sr_dev_inst *sdi)'''
<blockquote>
Returns information about the driver, or, is '''sdi''' is provided, that device instance. The type of information is given as info_id, one of a set of defined constants. The return value is always a pointer which refers to information specific to the id. Check <code>libsigrok.h</code> for the definitions ('''SR_DI_*''').
</blockquote>

* '''dev_config_set(const struct sr_dev_inst *sdi, int hwcap, const void *value)'''
<blockquote>
This is used to configure the driver and/or connected device. The hwcap parameter is one of the constants returned from calling <code>info_get()</code> with either SR_DI_HWOPTS (driver options) or SR_DI_HWCAPS (device instance options) as the <code>info_id</code>. The value depends on the parameter to be configured.
</blockquote>

* '''dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)'''
<blockquote>
Start acquisition on the specified device. The cb_data parameter will be passed along with the data feed of this session, as the first parameter to session bus callbacks.
</blockquote>

* '''dev_acquisition_stop(const struct sr_dev_inst *sdi, void *cb_data)'''
<blockquote>
Stop acquisition on the specified device. This causes a DF_END packet to be sent to the session bus.
</blockquote>

* '''priv'''
<blockquote>
This should contain a pointer to a <code>struct drv_context</code>, which is initialized by the <code>init()</code> function.
</blockquote>

Saleae Logic

2012-12-06T20:02:42Z

Rene: /* Hardware */

[[File:Saleae Logic.png|thumb|right|Saleae Logic]]

The [http://www.saleae.com/logic/ Saleae Logic] is a 24MHz, 8-channel, USB-based logic analyzer.

The unit itself is very small, and has a USB 2.0 port connecting it to a PC (and powering the unit) and a connector for the 8 + 1 probe set. It is built around a Cypress EZ-USB FX2LP microcontroller — an 8051-compatible chip with built-in USB 2.0 controller. It can sample 8 channels up to 24MHz and sells for $150.

The Saleae Logic reports on the USB bus with vendor ID '''0x0925''', product ID '''0x3881''' (see also the [[Saleae Logic/Info|full lsusb]]). It has no firmware on board; this must be uploaded when the unit is powered on. sigrok uses the [[fx2lafw]] firmware for this.

The case has four '''Torx T2''' screws you need to remove in order to be able to open it.

See [[Saleae Logic/Info]] for more details (such as '''lsusb -vvv''' output) about the device.

See [[Saleae Logic16]] for the successor product of the Saleae Logic.

== Hardware ==

* Main chip: Cypress CY7C68013A-56PVXC (SSOP)
* ESD protection: ST DVIULC6-4SC6
* 3.3V voltage regulator: ST LD33C
* I2C EEPROM: Microchip 24LC00
* Crystal: 24MHz

== Photos ==

<gallery>
File:Saleae Logic.jpg|Device, top
File:Saleae logic.jpg|Device with two E-Z-Hooks
File:Saleae logic opened.jpg|Device, open
File:Saleae logic pcb front.jpg|PCB, front
File:Saleae logic pcb back.jpg|PCB, back
File:Saleae logic collection.jpg|Saleae Logic collection
</gallery>

== Protocol ==

The original Saleae firmware, no longer used in sigrok, announces itself on the USB bus with the same vendor and product IDs, but with two endpoints: '''endpoint 1 (out)''' is used for sending commands to the logic analyzer, '''endpoint 2 (in)''' is for transfers of sample sets. Both endpoints are of type '''bulk'''.

The Saleae Logic does no analysis in hardware at all. Processing triggers, protocol analysis and so on is all done on the software side; the hardware unit merely sends the requested number of samples at a given sample rate. The device has 8 probes, all of which are always probed and sent along. A full sample is thus always exactly one byte.

=== Setting the samplerate, starting an acquisition ===

There is only one command the software sends to the Saleae Logic on '''endpoint 1''': a '''two-byte command''' to set the samplerate. The '''first byte''' is always '''0x01''' ('''0xd5''' on more recent firmware versions). This is likely a command opcode meaning "set sample rate".

The '''second byte''' indicates the samplerate. The samplerate is given in the form of a divider based on the FX2LP's clock, which runs at 48MHz. The following formula is used:

samplerate = 48 / (1 + divider)

Thus, a samplerate of 2 MHz (for example) is selected by using 23 as the divider:

{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!1st byte
!2nd byte
|- bgcolor="#eeeeee"
| 0x01 (1)
| 0x17 (23)
|}

=== Supported samplerates ===

The following samplerates are supported in older firmware versions:

{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!Samplerate
!Divider (hex)
!Divider (int)
|- bgcolor="#eeeeee"
| 200 kHz
| 0xef
| 239
|- bgcolor="#dddddd"
| 250 kHz
| 0xbf
| 191
|- bgcolor="#eeeeee"
| 500 kHz
| 0x5f
| 95
|- bgcolor="#dddddd"
| 1 MHz
| 0x2f
| 47
|- bgcolor="#eeeeee"
| 2 MHz
| 0x17
| 23
|- bgcolor="#dddddd"
| 4 MHz
| 0x0b
| 11
|- bgcolor="#eeeeee"
| 8 MHz
| 0x05
| 5
|- bgcolor="#dddddd"
| 12 MHz
| 0x03
| 3
|- bgcolor="#eeeeee"
| 16 MHz
| 0x02
| 2
|- bgcolor="#dddddd"
| 24 MHz
| 0x01
| 1
|}

Recent versions of the vendor software have additional samplerate settings of '''100 kHz''', '''50 kHz''', and '''25 kHz'''. However, these result in the same divider value of '''239''' (and the software likely just uses every 2nd/4th/8th sample) as with the 200 kHz samplerate, so they're not really too useful.

The following samplerates are supported in newer firmware versions:

{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!Samplerate
!Divider (hex)
!Divider (int)
|- bgcolor="#eeeeee"
| 200 kHz
| 0x4e
| 78
|- bgcolor="#dddddd"
| 250 kHz
| 0x9e
| 158
|- bgcolor="#eeeeee"
| 500 kHz
| 0xfe
| 254
|- bgcolor="#dddddd"
| 1 MHz
| 0x8e
| 142
|- bgcolor="#eeeeee"
| 2 MHz
| 0xe6
| 230
|- bgcolor="#dddddd"
| 4 MHz
| 0xda
| 218
|- bgcolor="#eeeeee"
| 8 MHz
| 0xd4
| 212
|- bgcolor="#dddddd"
| 12 MHz
| 0xe2
| 226
|- bgcolor="#eeeeee"
| 16 MHz
| 0xd5
| 213
|- bgcolor="#dddddd"
| 24 MHz
| 0xe0
| 224
|}

=== Getting samples ===

Samples are read off '''endpoint 2'''. The Saleae Logic receives a read request from the host, and responds by sending the requested number of samples. The maximum number of samples transferred at a time is 4096, a constraint in the USB protocol. A sample is one byte, with each bit representing the state of one of the probes. Probe 1 (black wire) is in the MSB of the sample, probe 8 (purple wire) is the LSB.

== Resources ==

TODO.

[[Category:Device]]
[[Category:Logic analyzer]]
[[Category:Supported]]