Difference between revisions of "Main Page"

From sigrok
Jump to navigation Jump to search
m
m (Remove jenkins link)
 
(289 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[File:Sigrok linux.png|right|thumb|Linux]]
<table width="100%" valign="top"><tr valign="top"><td width="80%">
[[File:Sigrok macosx.png|right|thumb|Mac OS X]]
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
[[File:Sigrok windows.png|right|thumb|Windows]]
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source signal analysis software suite''' that supports various device types (e.g. [[Supported hardware#Logic_analyzers|logic analyzers]], [[Supported hardware#Oscilloscopes|oscilloscopes]], and [[Supported hardware|many more]]).


<div style="margin-top:0.5em; margin-bottom:0.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
It is licensed under the terms of the '''GNU GPL, version 3 or later'''. Design goals and features include:
The '''sigrok''' project aims at creating a portable, cross-platform, Free/Libre/Open-Source logic analyzer software that supports various (usually USB-based) logic analyzer hardware products. The code is licensed under the terms of the '''GNU GPL'''.
 
<small>
* '''Broad hardware support'''. Supports [[Supported hardware|many different devices]] (logic analyzers, oscilloscopes, multimeters, data loggers etc.) from various vendors.
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]], [[Android]] (and on x86, ARM, Sparc, PowerPC, ...).
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.
* '''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], WAV, ...).
* '''Reusable libraries'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.
* '''Various frontends'''. [[PulseView]] (LA/DSO/MSO GUI), [[SmuView]] (DMM/PSU/load GUI) and [[sigrok-meter]] (DMM GUI), [[sigrok-cli]] (command-line), and other frontends all build upon the above libraries.
</small>
</div>
</div>


== Design goals ==
<div style="clear: both;">


* '''Hardware support'''. Supports a wide variety of logic analyzer hardware from various vendors with different capabilities.
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
* '''Cross-platform'''. Works on [[Linux]]/[[Mac OS X]]/[[Windows]]/etc. and on x86/ARM/Sparc/PowerPC/etc.
'''You can use sigrok to...'''
* '''Scriptable'''. Extendable with protocol decoders written in Lua or Python.
<small>
* '''Format support'''. Supports various input and output formats (raw, CSV, gnuplot, VCD, others).
<div style="width: 50%; float: left;">
* ...log data from your multimeter
* ...have a $10 logic analyzer for examining logic circuits
* ...have a remote GUI for your oscilloscope
* ...perform measurements on signals
* ...make sense of digital signals with protocol decoders
</div>
<div style="width: 50%; float: right;">
* ...write custom protocol decoders in python
* ...remote-control your power supply
* ...remote-control whatever lab device you'd like to support
* ...write a quick-n-dirty automation tool for your particular needs
* ...have a framework/frontend for your home-made devices
</div>
<div style="clear: both;"></div>
</small>
</div>


== Download ==
<div style="clear: both;">


No releases have been made yet. However, development is done in a git repository. To get a copy:
<div style="width: 50%; float: left; margin-bottom: 1em;">
{{Box|
BORDER = #8898bf|
BACKGROUND = #d1adf6|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[//sigrok.org/blog News]</span>|
CONTENT =
<small>
<rss max=3 date="Y-m-d">https://sigrok.org/blog/rss.xml</rss>
See also: [[Current events]].
</small>
}}
</div>


$ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''
<div style="width: 49%; float: right; margin-bottom: 1em;">
{{Box|
BORDER = #8898bf|
BACKGROUND = lime|
WIDTH = 100%|
ICON = |
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>)|
CONTENT =
<small>
[[Supported_hardware#Logic_analyzers|Logic analyzers]] &middot; [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]] &middot; [[Supported_hardware#Oscilloscopes|Oscilloscopes]] &middot; [[Supported_hardware#Multimeters|Multimeters]] &middot; [[Supported_hardware#LCR meters|LCR meters]] &middot; [[Supported_hardware#Sound_level_meters|Sound level meters]] &middot; [[Supported_hardware#Thermometers|Thermometers]] &middot; [[Supported_hardware#Hygrometers|Hygrometers]] &middot; [[Supported_hardware#Anemometers|Anemometers]] &middot; [[Supported_hardware#Light meters|Light meters]] &middot; [[Supported_hardware#Energy meters|Energy meters]] &middot; [[Supported_hardware#DAQs|DAQs]] &middot; [[Supported_hardware#Dataloggers|Dataloggers]] &middot; [[Supported_hardware#Tachometers|Tachometers]] &middot; [[Supported_hardware#Scales|Scales]] &middot; [[Supported_hardware#Digital_loads|Digital loads]] &middot; [[Supported_hardware#Function_generators|Function generators]] &middot; [[Supported_hardware#Frequency_counters|Frequency counters]] &middot; [[Supported_hardware#RF receivers|RF receivers]] &middot; [[Supported_hardware#Spectrum_analyzers|Spectrum analyzers]] &middot; [[Supported_hardware#Power_supplies|Power supplies]] &middot; [[Supported_hardware#Multiplexer_.2F_Relay_actuators|Multiplexer]] &middot; [[Supported_hardware#GPIB_interfaces|GPIB interfaces]]


The build requires [http://libusb.org/ libusb-1.0] version 1.0.5 or higher.
See also: [[:Category:Device comparison|Device comparisons]], [[Device cables]], [[Multimeter ICs]], [[Connection parameters]]
</small>
}}
</div>


Binary releases and additional project information can be found on the [http://www.sourceforge.net/projects/sigrok sourceforge project page].
</div>


== Supported hardware ==
<div style="clear: both;">


<gallery>
<div style="width: 50%; float: left; margin-bottom: 1em;">
File:Cwav usbee sx.jpg|<small>'''[[CWAV USBee SX]]'''<br /></small>
{{Box|
File:Braintechnology usb lps.jpg|<small>'''[[Braintechnology USB-LPS]]'''<br />(partially supported)</small>
BORDER = #8898bf|
File:Saleae logic.jpg|<small>'''[[Saleae Logic]]'''<br />(work in progress)</small>
BACKGROUND = cyan|
File:Open workbench logic sniffer.jpg|<small>'''[[Openbench Logic Sniffer]]'''</small>
WIDTH = 100%|
File:Zeroplus Logic Cube.jpg|<small>'''[[Zeroplus Logic Cube]]'''</small>
ICON = |
</gallery>
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Downloads and documentation</span>|
CONTENT =
<small>
[[Downloads]] &middot; [[Building]] &middot; [[Linux]] &middot; [[Mac OS X]] &middot; [[Windows]] &middot; [[FreeBSD]] &middot; [[OpenBSD]] &middot; [[NetBSD]] &middot; [[Android]] &middot; [[Embedded]] &middot; [[Getting started]] &middot; [[Input output formats]] &middot; [[Protocol decoders]] &middot; [[Probe comparison]] &middot; [[GPIB]] &middot; [[Logo]] &middot; [[Press]]
</small>
}}
</div>


<div style="width: 49%; float: right; margin-bottom: 1em;">
{{Box|
BORDER = #8898bf|
BACKGROUND = #ff3333|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|
CONTENT =
<small>
[[libserialport]] &middot; [[libsigrok]] &middot; [[libsigrokdecode]] &middot; [[sigrok-cli]] &middot; [[PulseView]] &middot; [[sigrok-meter]] <!-- &middot; [[sigrok-qt]] &middot; [[sigrok-gtk]] --> &middot; [[SmuView]] &middot; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]
</small>
}}
</div>


== Documentation ==
<div style="clear: both;">


* [[Design Ideas]]
<div style="width: 50%; float: left; margin-bottom: 1em;">
* [[Formats and structures]]
{{Box|
* [[Hardware plugin API]]
BORDER = #8898bf|
* [[Library]]
BACKGROUND = yellow|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|
CONTENT =
<small>
IRC: [https://web.libera.chat/#sigrok #sigrok@libera.chat] &middot; Mailing list: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] (archives: [https://www.mail-archive.com/sigrok-devel@lists.sourceforge.net/ MA], [https://sourceforge.net/p/sigrok/mailman/sigrok-devel/ SF], [http://news.gmane.org/gmane.comp.debugging.sigrok.devel Gmane]) &middot; Twitter: [https://twitter.com/sigrokproject @sigrokproject] &middot; Mastodon/[https://en.wikipedia.org/wiki/Fediverse Fediverse]: [https://fosstodon.org/@sigrok @sigrok@fosstodon.org]
</small>
}}
</div>


== Frontends ==
<div style="width: 49%; float: right; margin-bottom: 1em;">
 
{{Box|
* [[Command-line]]
BORDER = #8898bf|
* [[Cross-platform GUI]]
BACKGROUND = lightblue|
 
WIDTH = 100%|
== Getting in touch ==
ICON = |
 
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|
* Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel], [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits]
CONTENT =
* IRC: '''#sigrok''' on Freenode.
<small>
[[Developers]] &middot; [[Roadmap]] &middot; [//sigrok.org/api/index.html API docs] ([//sigrok.org/api/libserialport/unstable/index.html sp] &middot; [//sigrok.org/api/libsigrok/unstable/index.html sr]/[//sigrok.org/api/libsigrok/unstable/bindings/cxx/index.html cxx]/[//sigrok.org/api/libsigrok/unstable/bindings/python/index.html py]/[//sigrok.org/api/libsigrok/unstable/bindings/java/index.html java] &middot; [//sigrok.org/api/libsigrokdecode/unstable/index.html srd]) &middot; [//sigrok.org/gitweb/ Browse source code] ([https://github.com/sigrokproject GitHub mirror]) &middot; [//sigrok.org/bugzilla/ Bug tracker] &middot; [[GSoC|Summer of Code]] &middot; [[Protocol decoder HOWTO]] &middot; [[Protocol decoder API]] &middot; [[Formats and structures]] &middot; [[Hardware driver API]] &middot; [[Portability]] &middot; [[TODO]]
</small>
}}
</div>


</div>


<div style="clear: both;margin-top: 2em;">
----
----
 
<small>
'''IMPORTANT: Please note that (unless explicitly specified otherwise) all contents in this wiki (including text and images) are released to the <span style="color:red">CC-BY-SA 3.0</span>. If you don't want that, please explicitly specify another free-ish license when adding pages or images to the wiki!'''
'''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!'''
 
</small>
</div>
__NOTOC__
__NOTOC__
__NOEDITSECTION__
__NOEDITSECTION__

Latest revision as of 21:41, 9 April 2023

The sigrok project aims at creating a portable, cross-platform, Free/Libre/Open-Source signal analysis software suite that supports various device types (e.g. logic analyzers, oscilloscopes, and many more).

It is licensed under the terms of the GNU GPL, version 3 or later. Design goals and features include:

You can use sigrok to...

  • ...log data from your multimeter
  • ...have a $10 logic analyzer for examining logic circuits
  • ...have a remote GUI for your oscilloscope
  • ...perform measurements on signals
  • ...make sense of digital signals with protocol decoders
  • ...write custom protocol decoders in python
  • ...remote-control your power supply
  • ...remote-control whatever lab device you'd like to support
  • ...write a quick-n-dirty automation tool for your particular needs
  • ...have a framework/frontend for your home-made devices

IMPORTANT: Unless explicitly specified otherwise, all contents in this wiki (including text and images) are released under the CC-BY-SA 3.0 license. If you don't want that, please explicitly specify another free-ish license when adding pages/images!


Retrieved from "https://sigrok.org/w/index.php?title=Main_Page&oldid=16494"