Difference between revisions of "Main Page"

From sigrok
Jump to navigation Jump to search
m
m
(150 intermediate revisions by 8 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]]).
It is licensed under the terms of the '''GNU GPL, version 3 or later'''. Design goals and features include:


<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;">
The '''sigrok''' project aims at creating a '''portable, cross-platform, Free/Libre/Open-Source logic analyzer software''' that supports various logic analyzer hardware products. It is licensed under the terms of the '''GNU GPL'''. Design goals and features include:
<small>
<small>
* '''Broad hardware support'''. Supports many different logic analyzers from various vendors.
* '''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]], and [[FreeBSD]] (and on x86, ARM, Sparc, PowerPC, ...).
* '''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.
* '''Scriptable protocol decoding'''. Extendable with stackable [[protocol decoders]] written in Python 3.
* '''Format support'''. Supports various [[Input output formats|input/output formats]] (binary, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], ...).
* '''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>
</small>
</div>
</div>


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


{| border="0" style="font-size: smaller; width: 100%"
<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...'''
| [[File:Saleae Logic.jpg|40x25px|link=Saleae Logic]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Saleae Logic]]</small>
<small>
| [[File:Eeelec xla esla100.jpg|40x25px|link=EE Electronics XLA ESLA100]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[EE Electronics XLA ESLA100|EE Elec. XLA/ESLA100]]</small>
<div style="width: 50%; float: left;">
| [[File:ASIX SIGMA.jpg|40x25px|link=ASIX SIGMA]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[ASIX SIGMA]]</small>
* ...log data from your multimeter
| [[File:Openbench logic sniffer front.jpg|40x25px|link=Openbench Logic Sniffer]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Openbench Logic Sniffer]]</small>
* ...have a $10 logic analyzer for examining logic circuits
|- bgcolor="#eeeeee"
* ...have a remote GUI for your oscilloscope
| [[File:Zeroplus Logic Cube.jpg|40x25px|link=ZEROPLUS Logic Cube LAP-C]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[ZEROPLUS Logic Cube LAP-C|Zeroplus Logic Cube LAP-C]]</small>
* ...perform measurements on signals
| [[File:Chronovu la8 device.jpg|40x25px|link=ChronoVu LA8]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[ChronoVu LA8]]</small>
* ...make sense of digital signals with protocol decoders
| [[File:Robomotic buglogic3.jpg|40x27px|link=Robomotic BugLogic 3]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Robomotic BugLogic 3]]</small>
</div>
| [[File:Robomotic minilogic.jpg|40x25px|link=Robomotic MiniLogic]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Robomotic MiniLogic]]</small>
<div style="width: 50%; float: right;">
|- bgcolor="#fafafa"
* ...write custom protocol decoders in python
| [[File:logic-shrimp-front.png|40x25px|link=Logic Shrimp]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Logic Shrimp]]</small>
* ...remote-control your power supply
| [[File:Lcsoft-miniboard-front.png|40x25px|link=Lcsoft Mini Board]]&nbsp;<small>[[File:Nuvola OK.png|16px]]<br />[[Lcsoft Mini Board]]</small>
* ...remote-control whatever lab device you'd like to support
| [[File:Cwav usbee sx.jpg|40x25px|link=CWAV USBee SX]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[CWAV USBee SX]]</small>
* ...write a quick-n-dirty automation tool for your particular needs
| [[File:Braintechnology usb lps.jpg|40x25px|link=Braintechnology USB-LPS]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[Braintechnology USB-LPS]]</small>
* ...have a framework/frontend for your home-made devices
|- bgcolor="#eeeeee"
</div>
| [[File:Dso2090-case-top-small.jpg|40x25px|link=Hantek DSO-2090]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[Hantek DSO-2090]]</small>
<div style="clear: both;"></div>
| [[File:Intronix Logicport.jpg|40x25px|link=Intronix Logicport]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[Intronix Logicport]]</small>
</small>
| [[File:Ant18e closed.jpg|40x25px|link=RockyLogic Ant18e]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[RockyLogic Ant18e]]</small>
</div>
| [[File:Rockylogic ant8 device.jpg|40x25px|link=RockyLogic Ant8]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[RockyLogic Ant8]]</small>
|- bgcolor="#fafafa"
| [[File:MSO-19.JPG|40x25px|link=Link Instruments MSO-19]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[Link Instruments MSO-19]]</small>
| [[File:Esla201a.JPG|40x25px|link=EE Electronics ESLA201A]]&nbsp;<small>[[File:Nuvola Orange.png|16px]]<br />[[EE Electronics ESLA201A|EE Elec. ESLA201A]]</small>
| [[File:Buspirate v3 front.jpg|40x25px|link=Buspirate]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Buspirate]]</small>
| [[File:Picoscope 2203 front.jpg|40x25px|link=Pico Technology PicoScope 2203]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Pico Technology PicoScope 2203|Pico Tech PicoScope 2203]]</small>
|- bgcolor="#eeeeee"
| [[File:Ikalogic scanalogic2 device with probes.jpg|40x25px|link=Ikalogic SCANALOGIC-2 PRO]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Ikalogic SCANALOGIC-2 PRO]]</small>
| [[File:Microchip pickit2 device front.jpg|40x25px|link=Microchip PICkit2]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Microchip PICkit2]]</small>
| [[File:Minila mockup.jpg|40x25px|link=MiniLA Mockup]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[MiniLA Mockup]]</small>
| [[File:Acute_pkla1216_front.jpg|40x25px|link=Acute PKLA-1216]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Acute PKLA-1216]]</small>
|- bgcolor="#fafafa"
| [[File:Saleae_logic16_front.jpg|40x25px|link=Saleae Logic16]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Saleae Logic16]]</small>
| [[File:Polabs poscope basic2 device top.jpg|40x25px|link=PoLabs PoScope Basic2]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[PoLabs PoScope Basic2]]</small>
| [[File:QA100 Full.JPG|40x25px|link=QuantAsylum QA100]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[QuantAsylum QA100]]</small>
| [[File:Rigol_VS5202D_Full.jpg|40x25px|link=Rigol VS5202D]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br/>[[Rigol VS5202D]]</small>
|- bgcolor="#eeeeee"
| [[File:Velleman pcsu1000 pcb front.jpg|40x25px|link=Velleman PCSU1000]]&nbsp;<small>[[File:Nuvola Red.png|16px]]<br />[[Velleman PCSU1000]]</small>
|}


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


== [[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>


* Building: [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]]
<div style="width: 49%; float: right; margin-bottom: 1em;">
* [[libsigrok]] (hardware access lib)
{{Box|
* [[libsigrokdecode]] (protocol decoder lib)
BORDER = #8898bf|
* [[sigrok-cli]] (command-line)
BACKGROUND = lime|
* [[sigrok-qt]] (cross-platform Qt GUI)
WIDTH = 100%|
* [[sigrok-gtk]] (cross-platform GTK+ GUI)
ICON = |
* [[Input output formats]]
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>)|
* [[Protocol decoders]]
CONTENT =
* [[Firmware]], [[fx2lafw]]
<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]]
* [[Example dumps]]


</td><td style="vertical-align:top" width="32%">
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]]
* [[Protocol decoder HOWTO]]
* [[Protocol Decoder API]]
* [[Formats and structures]]
* [[Hardware plugin API]]
* [[Input API]]
* [[Output API]]


</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|
BORDER = #8898bf|
BACKGROUND = cyan|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Downloads and documentation</span>|
CONTENT =
<small>
[[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>


* 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])
<div style="width: 49%; float: right; margin-bottom: 1em;">
* IRC: '''[irc://chat.freenode.net/sigrok #sigrok]''' on [http://www.freenode.net Freenode]
{{Box|
* identi.ca: [http://www.identi.ca/group/sigrok sigrok group], [https://identi.ca/search/notice?q=sigrok search], Twitter: [https://twitter.com/#!/search/realtime/sigrok search]
BORDER = #8898bf|
* Sites: [http://sourceforge.net/projects/sigrok/ SF], Fm: [http://freecode.com/projects/libsigrokdecode sr]/[http://freecode.com/projects/libsigrokdecode srd]/[http://freecode.com/projects/sigrok cli], [https://www.ohloh.net/p/sigrok ohloh], [http://delicious.com/url/d8996d567839064c799ac217b263b2c8 del.icio.us], [http://www.reddit.com/search?q=sigrok Reddit], [http://digg.com/search?q=sigrok Digg], [[Press#Other|others]]
BACKGROUND = #ff3333|
* Other: [[Logo|sigrok logo]]
WIDTH = 100%|
</td>
ICON = |
</tr>
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Subprojects</span>|
</table>
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 width="20%">
<div style="clear: both;">


[[File:Sigrok la collection 2011.jpg|center|thumb|<small>Logic analyzer collection</small>]]
<div style="width: 50%; float: left; margin-bottom: 1em;">
 
{{Box|
<br clear=all />
BORDER = #8898bf|
BACKGROUND = yellow|
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|
CONTENT =
<small>
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>
}}
</div>


'''<span style="font-variant:small-caps; font-size:120%">[[File:Sigrok_stone.png]] [[News]] / [[Current events|Events]] / [[Press]]</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>
* '''2012/05/02:''' [[News#2012.2F05.2F02_Slashdotted.21|Slashdotted!]]
[[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]]
* '''2012/04/26:''' [[News#2012.2F04.2F26_New_protocol_decoder:_JTAG|New decoder: JTAG]]
* '''2012/04/17:''' [[News#2012.2F04.2F17_libsigrok_0.1.0_released|libsigrok 0.1.0 released]]
* '''2012/04/17:''' [[News#2012.2F04.2F17_libsigrokdecode_0.1.0_released|libsigrokdecode 0.1.0 released]]
* '''2012/04/17:''' [[News#2012.2F04.2F17_sigrok-cli_0.3.0_released|sigrok-cli 0.3.0 released]]
* '''2011/12/27:''' [[News##2011.2F12.2F27_sigrok_.40_28C3|sigrok @ 28C3]]
* '''2011/11/15:''' [[News#2011.2F11.2F15_GTK.2B_GUI_started|GTK+ GUI started]]
</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 18:13, 23 August 2017

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!