Difference between revisions of "Main Page"

From sigrok
Jump to navigation Jump to search
(27C3 logic analyzer collection.)
(Drop big download button.)
(224 intermediate revisions by 10 users not shown)
Line 1: Line 1:
<table width="100%" valign="top"><tr valign="top"><td width="80%">
<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; border:1px solid #aabbcc;">
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 GUI), [[sigrok-meter]] (DMM GUI), [[sigrok-cli]] (command-line), and other frontends all build upon the above libraries.
</small>
</div>
</div>


== <span style="font-variant:small-caps">Design goals</span> ==
<div style="clear: both;">


* '''Broad hardware support'''. Supports a wide variety of logic analyzers 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]] and [[Windows]], and on many architectures including x86, ARM, Sparc and PowerPC.
'''You can use sigrok to...'''
* '''Scriptable protocol decoding'''. Extendable with [[protocol decoders]] and analyzers written in Python.
<small>
* '''Format support'''. Supports various [[Input output formats|input and output formats]] (raw, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump 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>


== <span style="font-variant:small-caps">Supported hardware</span> ==
<div style="clear: both;">


<gallery widths="120px" heights="70px" perrow="5">
<div style="width: 50%; float: left; margin-bottom: 1em;">
File:Saleae Logic.jpg|<small>'''[[Saleae Logic]]'''<br />(supported)</small>
{{Box|
File:Eeelec xla esla100.jpg|<small>'''[[EE Electronics XLA ESLA100|EE Electronics XLA/ESLA100]]''' (supported)</small>
BORDER = #8898bf|
File:ASIX SIGMA.jpg|<small>'''[[ASIX SIGMA]]''' (supported)</small>
BACKGROUND = #d1adf6|
File:Openbench logic sniffer front.jpg|<small>'''[[Openbench Logic Sniffer]]'''<br />(supported)</small>
WIDTH = 100%|
File:Zeroplus Logic Cube.jpg|<small>'''[[ZEROPLUS Logic Cube LAP-C]]''' (work in progress)</small>
ICON = |
File:Cwav usbee sx.jpg|<small>'''[[CWAV USBee SX]]'''<br />(coming up)</small>
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">[//sigrok.org/blog News]</span>|
File:Braintechnology usb lps.jpg|<small>'''[[Braintechnology USB-LPS]]'''<br />(planned)</small>
CONTENT =
File:Buspirate v3 front.jpg|<small>'''[[Buspirate]]'''<br />(planned)</small>
<small>
File:Intronix Logicport.jpg|<small>'''[[Intronix Logicport]]'''<br />(planned)</small>
<rss max=3 date="Y-m-d">https://sigrok.org/blog/rss.xml</rss>
File:MSO-19.JPG|<small>'''[[Link Instruments MSO-19]]'''<br />(planned)</small>
See also: [[Current events]].
</gallery>
</small>
}}
</div>


<table width="100%">
<div style="width: 49%; float: right; margin-bottom: 1em;">
<tr style="vertical-align:top">
{{Box|
<td style="vertical-align:top" width="30%">
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#GPIB_interfaces|GPIB interfaces]]


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Documentation</span> ==
See also: [[:Category:Device comparison|Device comparisons]], [[Device cables]], [[Multimeter ICs]], [[Connection parameters]]
</small>
}}
</div>


* [[Downloads]]
</div>
* Building: [[Linux]], [[Mac OS X]], [[Windows]]
* [[Status]]
* [[FAQ]]
* [[Supported hardware]]
* [[Command-line]]
* [[GUI|Cross-platform GUI]]
* [[Input output formats]]
* [[Protocol decoders]]
* [[Logic Analyzer Comparison]]


</td><td style="vertical-align:top" width="25%">
<div style="clear: both;">


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Development</span> ==
<div style="width: 50%; float: left; margin-bottom: 1em;">
* [http://sigrok.git.sourceforge.net/git/gitweb.cgi?p=sigrok/sigrok;a=tree Browse Source Code]
{{Box|
* [[TODO]]
BORDER = #8898bf|
* [[Design Ideas]]
BACKGROUND = cyan|
* [[Protocol decoder API]]
WIDTH = 100%|
* [[Formats and structures]]
ICON = |
* [[Hardware plugin API]]
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Downloads and documentation</span>|
* [[Input API]]
CONTENT =
* [[Output API]]
<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>


</td><td style="vertical-align:top" width="15%">
<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; [[fx2lafw]] &middot; [[gpibgrok]] &middot; [[fx2grok]] &middot; [[fpgalafw]] &middot; [[Firmware]] &middot; [[Example dumps]]
</small>
}}
</div>


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Misc</span> ==
<div style="clear: both;">


* [[News]]
<div style="width: 50%; float: left; margin-bottom: 1em;">
* [[Current events]]
{{Box|
* [[Press]]
BORDER = #8898bf|
* [[Logo]]
BACKGROUND = yellow|
 
WIDTH = 100%|
</td><td style="vertical-align:top" width="35%">
ICON = |
 
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|
== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Getting in touch</span> ==
CONTENT =  
 
<small>
* 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]
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; IRC: [http://webchat.freenode.net/?channels=%23sigrok&uio=MT1mYWxzZQ9a #sigrok@freenode] &middot; Twitter: [https://twitter.com/sigrokproject @sigrokproject] &middot; Google+: [https://plus.google.com/communities/109843678338531936878 sigrok community]
* IRC: '''[irc://chat.freenode.net/sigrok #sigrok]''' on [http://www.freenode.net Freenode]
</small>
* identi.ca: [http://www.identi.ca/group/sigrok sigrok group]
}}
* Sites: [http://sourceforge.net/projects/sigrok/ SF], [http://freshmeat.net/projects/sigrok Fm], [https://www.ohloh.net/p/sigrok ohloh], [http://delicious.com/url/d8996d567839064c799ac217b263b2c8 del.icio.us]
</div>
 
</td>
</tr>
</table>
 
</td><td width="20%">


[[File:Logic analyzer collection.png|center|thumb|Small logic analyzer collection]]
<div style="width: 49%; float: right; margin-bottom: 1em;">
 
{{Box|
<br clear=all />
BORDER = #8898bf|
 
BACKGROUND = lightblue|
'''<span style="font-variant:small-caps; font-size:120%">[[File:Sigrok_stone.png]] [[News]]</span>'''<hr />
WIDTH = 100%|
<!-- Please always make this list 7 items long (7 most recent news items). -->
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|
CONTENT =
<small>
<small>
* '''2010/05/01:''' [[News#2010.2F05.2F01_ASIX_SIGMA_now_supported|ASIX SIGMA support]]
[[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; [//sigrok.org/jenkins/ Jenkins] &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]]
* '''2010/04/06:''' VCD and Gnuplot output
* '''2010/04/01:''' [[ZEROPLUS Logic Cube LAP-C]] support
* '''2010/03/30:''' libsigrokdecode started
* '''2010/03/19:''' GUI: i18n support
* '''2010/03/17:''' Session save support
* '''2010/03/16:''' GUI started
* '''2010/03/14:''' Official project start
</small>
</small>
}}
</div>


</td></tr></table>
</div>
 


<div style="clear: both;margin-top: 2em;">
----
----
'''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!'''
<small>
'''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__

Revision as of 13:08, 1 October 2018

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!