Difference between revisions of "Main Page"

From sigrok
Jump to navigation Jump to search
(Save some more screen estate.)
(Drop big download button.)
(197 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'''. Some of the design goals and features include:
 
* '''Broad hardware support'''. Supports a wide variety of logic analyzers from various vendors with different capabilities.
<small>
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], and [[FreeBSD]], and on many architectures including x86, ARM, Sparc and PowerPC.
* '''Broad hardware support'''. Supports [[Supported hardware|many different devices]] (logic analyzers, oscilloscopes, multimeters, data loggers etc.) from various vendors.
* '''Scriptable protocol decoding'''. Extendable with [[protocol decoders]] and analyzers written in Python.
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]], [[OpenBSD]], [[NetBSD]], [[Android]] (and on x86, ARM, Sparc, PowerPC, ...).
* '''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).
* '''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">Supported hardware</span> ==
<div style="clear: both;">


{| border="0" style="font-size: smaller"
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
|- bgcolor="#fafafa" style="padding:6px"
'''You can use sigrok to...'''
| style="width:190px; horizontal-align=center" | [[File:Saleae Logic.jpg|40x25px|link=Saleae Logic]]<small>[[File:Nuvola OK.png|16px]] [[Saleae Logic]]</small>
<small>
| style="width:190px" | [[File:Eeelec xla esla100.jpg|40x25px|link=EE Electronics XLA ESLA100]]<small>[[File:Nuvola OK.png|16px]] [[EE Electronics XLA ESLA100|EE&nbsp;Eleec.&nbsp;XLA/ESLA100]]</small>
<div style="width: 50%; float: left;">
| style="width:190px" | [[File:ASIX SIGMA.jpg|40x25px|link=ASIX SIGMA]]<small>[[File:Nuvola OK.png|16px]] [[ASIX SIGMA]]</small>
* ...log data from your multimeter
| style="width:190px" | [[File:Openbench logic sniffer front.jpg|40x25px|link=Openbench Logic Sniffer]]<small>[[File:Nuvola OK.png|16px]] [[Openbench Logic Sniffer]]</small>
* ...have a $10 logic analyzer for examining logic circuits
| style="width:190px" | [[File:Zeroplus Logic Cube.jpg|40x25px|link=ZEROPLUS Logic Cube LAP-C]]<small>[[File:Nuvola OK.png|16px]] [[ZEROPLUS Logic Cube LAP-C|Zeroplus Logic Cube LAP-C]]</small>
* ...have a remote GUI for your oscilloscope
|- bgcolor="#fafafa"
* ...perform measurements on signals
| style="width:190px" | [[File:Chronovu la8 device.jpg|40x25px|link=ChronoVu LA8]]<small>[[File:Nuvola OK.png|16px]] [[ChronoVu LA8]]</small>
* ...make sense of digital signals with protocol decoders
| style="width:190px" | [[File:Robomotic minilogic.jpg|40x25px|link=Robomotic MiniLogic]]<small>[[File:Nuvola OK.png|16px]] [[Robomotic MiniLogic]]</small>
</div>
| style="width:190px" | [[File:Cwav usbee sx.jpg|40x25px|link=CWAV USBee SX]]<small>[[File:Nuvola Orange.png|16px]] [[CWAV USBee SX]]</small>
<div style="width: 50%; float: right;">
| style="width:190px" | [[File:Braintechnology usb lps.jpg|40x25px|link=Braintechnology USB-LPS]]<small>[[File:Nuvola Orange.png|16px]] [[Braintechnology USB-LPS]]</small>
* ...write custom protocol decoders in python
| style="width:190px" | [[File:Intronix Logicport.jpg|40x25px|link=Intronix Logicport]]<small>[[File:Nuvola Orange.png|16px]] [[Intronix Logicport]]</small>
* ...remote-control your power supply
|- bgcolor="#fafafa"
* ...remote-control whatever lab device you'd like to support
| style="width:190px" | [[File:Ant18e closed.jpg|40x25px|link=RockyLogic Ant18e]]<small>[[File:Nuvola Orange.png|16px]] [[RockyLogic Ant18e]]</small>
* ...write a quick-n-dirty automation tool for your particular needs
| style="width:190px" | [[File:MSO-19.JPG|40x25px|link=Link Instruments MSO-19]]<small>[[File:Nuvola Orange.png|16px]] [[Link Instruments MSO-19]]</small>
* ...have a framework/frontend for your home-made devices
| style="width:190px" | [[File:Buspirate v3 front.jpg|40x25px|link=Buspirate]]<small>[[File:Nuvola Red.png|16px]] [[Buspirate]]</small>
</div>
| style="width:190px" | [[File:Picoscope 2203 front.jpg|40x25px|link=Pico Technology PicoScope 2203]]<small>[[File:Nuvola Red.png|16px]] [[Pico Technology PicoScope 2203|Pico Tech PicoScope 2203]]</small>
<div style="clear: both;"></div>
| style="width:190px" | [[File:Ikalogic scanalogic2 device with probes.jpg|40x25px|link=Ikalogic SCANALOGIC-2 PRO]]<small>[[File:Nuvola Red.png|16px]] [[Ikalogic SCANALOGIC-2 PRO]]</small>
</small>
|- bgcolor="#fafafa"
</div>
| style="width:190px" | [[File:Microchip pickit2 device front.jpg|40x25px|link=Microchip PICkit2]]<small>[[File:Nuvola Red.png|16px]] [[Microchip PICkit2]]</small>
| style="width:190px" | [[File:Minila mockup.jpg|40x25px|link=MiniLA Mockup]]<small>[[File:Nuvola Red.png|16px]] [[MiniLA Mockup]]</small>
| style="width:190px" | [[File:logic-shrimp-front.png|40x25px|link=Logic Shrimp]]<small>[[File:Nuvola Red.png|16px]] [[Logic Shrimp]]</small>
|}


<table width="100%">
<div style="clear: both;">
<tr style="vertical-align:top">
<td style="vertical-align:top" width="30%">


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Documentation</span> ==
<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>


* [[Downloads]]
<div style="width: 49%; float: right; margin-bottom: 1em;">
* Building: [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]]
{{Box|
* [[Status]]
BORDER = #8898bf|
* [[FAQ]]
BACKGROUND = lime|
* [[Supported hardware]]
WIDTH = 100%|
* [[Command-line]]
ICON = |
* [[GUI|Cross-platform GUI]]
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>)|
* [[Input output formats]]
CONTENT =
* [[Protocol decoders]]
<small>
* [[Logic Analyzer Comparison]]
[[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]]


</td><td style="vertical-align:top" width="25%">
See also: [[:Category:Device comparison|Device comparisons]], [[Device cables]], [[Multimeter ICs]], [[Connection parameters]]
</small>
}}
</div>


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Development</span> ==
</div>
* [http://sigrok.git.sourceforge.net/git/gitweb.cgi?p=sigrok/sigrok;a=tree Browse Source Code]
* [[TODO]]
* [[Design Ideas]]
* [[Protocol Decoder API]]
* [[Formats and structures]]
* [[Hardware plugin API]]
* [[Input API]]
* [[Output API]]


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


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Misc</span> ==
<div style="width: 50%; float: left; margin-bottom: 1em;">
{{Box|
BORDER = #8898bf|
BACKGROUND = cyan|
WIDTH = 100%|
ICON = |
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>


* [[News]]
<div style="width: 49%; float: right; margin-bottom: 1em;">
* [[Current events]]
{{Box|
* [[Press]]
BORDER = #8898bf|
* [[Logo]]
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>


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


== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps">Getting in touch</span> ==
<div style="width: 50%; float: left; margin-bottom: 1em;">
 
{{Box|
* 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])
BORDER = #8898bf|
* IRC: '''[irc://chat.freenode.net/sigrok #sigrok]''' on [http://www.freenode.net Freenode]
BACKGROUND = yellow|
* identi.ca: [http://www.identi.ca/group/sigrok sigrok group]
WIDTH = 100%|
* 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]
ICON = |
 
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|
</td>
CONTENT =  
</tr>
<small>
</table>
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]
 
</small>
</td><td width="20%">
}}
 
</div>
[[File:Logic analyzer collection.png|center|thumb|<small>Small logic analyzer collection</small>]]
 
<br clear=all />


'''<span style="font-variant:small-caps; font-size:120%">[[File:Sigrok_stone.png]] [[News]]</span>'''<hr />
<div style="width: 49%; float: right; margin-bottom: 1em;">
<!-- Please always make this list 7 items long (7 most recent news items). -->
{{Box|
BORDER = #8898bf|
BACKGROUND = lightblue|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|
CONTENT =
<small>
<small>
* '''2011/04/03:''' [[News#2011.2F04.2F03_ChronoVu_LA8_now_supported|ChronoVu LA8 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]]
* '''2011/04/03:''' [[News#2011.2F04.2F03_sigrok_0.2_released|sigrok 0.2 released]]
* '''2011/03/15:''' [[News#2011.2F03.2F15_sigrok_in_Debian|sigrok in Debian]]
* '''2011/01/20:''' [[News#2011.2F01.2F20_sigrok_0.1_released|sigrok 0.1 released]]
* '''2010/12/27:''' [[News##2010.2F12.2F27_sigrok_.40_27C3|sigrok @ 27C3]]
* '''2010/05/01:''' [[News#2010.2F05.2F01_ASIX_SIGMA_now_supported|ASIX SIGMA support]]
* '''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;">
----
----
<small>
<small>
'''IMPORTANT: Please note that (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 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>
</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!