Difference between revisions of "Main Page"

From sigrok
Jump to navigation Jump to search
m (add "downloads" to the start of the downloads section.)
(106 intermediate revisions by 6 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-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 '''logic analyzers, oscilloscopes, multimeters, data loggers''', and more. 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, oscilloscopes, multimeters, data loggers etc. 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 3.
* '''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], ...).
* '''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 code'''. Consists of the [[libsigrok]] and [[libsigrokdecode]] shared libraries which can be used by various frontends/GUIs.
* '''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>


<div style="clear: both;">
<div style="clear: both;">
<div style="margin-bottom:1.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
'''You can use sigrok to...'''
<small>
<div style="width: 50%; float: left;">
<div style="width: 50%; float: left;">
'''<span style="font-variant:small-caps; font-size:120%">[[File:Sigrok_stone.png]] News / Events</span>'''<hr/>
* ...log data from your multimeter
<!-- Please always make this list 7 items long (7 most recent news items). -->
* ...have a $10 logic analyzer for examining logic circuits
* '''2012-06-21:''' [http://www.sigrok.org/blog/analog Analog!]
* ...have a remote GUI for your oscilloscope
* '''2012-06-17:''' [http://sigrok.org/blog/about-fx2lafw About fx2lafw]
* ...perform measurements on signals
* '''2012-06-17:''' [[News#2012.2F06.2F17_sigrok_developer_blog|sigrok developer blog]]
* ...make sense of digital signals with protocol decoders
* '''2012-05-30:''' [[News#2012.2F05.2F30_sigrok-cli_0.3.1_released|sigrok-cli 0.3.1 released]]
</div>
* '''2012-05-30:''' [[News#2012.2F05.2F30_libsigrok_0.1.1_released|libsigrok 0.1.1 released]]
<div style="width: 50%; float: right;">
* '''2012-05-18:''' [[News#2012.2F05.2F18_sigrok-dumps_0.1.0_released|sigrok-dumps 0.1.0 released]]
* ...write custom protocol decoders in python
* '''2012-05-02:''' [[News#2012.2F05.2F02_Slashdotted.21|Slashdotted!]]
* ...remote-control your power supply
* '''2012-04-26:''' [[News#2012.2F04.2F26_New_protocol_decoder:_JTAG|New decoder: JTAG]]
* ...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>
</div>


<div style="width: 50%; float: left;">
<div style="clear: both;">
'''<span style="font-variant:small-caps; font-size:120%">[[File:Sigrok_stone.png]] Supported hardware</span>'''<hr/>
 
* [[Supported_hardware#Logic_analyzers|Logic analyzers]] ([[Logic analyzer comparison|comparison table]])
<div style="width: 50%; float: left; margin-bottom: 1em;">
* [[Supported_hardware#Mixed-signal_devices|Mixed-signal devices]]
{{Box|
* [[Supported_hardware#Oscilloscopes|Oscilloscopes]]
BORDER = #8898bf|
* [[Supported_hardware#Multimeters|Multimeters]] ([[Multimeter comparison|comparison table]])
BACKGROUND = #d1adf6|
* [[Supported_hardware#GPIB_interfaces|GPIB interfaces]] ([[GPIB interface comparison|comparison table]])
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>
 
<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#GPIB_interfaces|GPIB interfaces]]
 
See also: [[:Category:Device comparison|Device comparisons]], [[Device cables]], [[Multimeter ICs]], [[Connection parameters]]
</small>
}}
</div>
</div>


Line 38: Line 74:


<div style="clear: both;">
<div style="clear: both;">
<div style="width: 50%; float: left;">
== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps; font-size:120%">Documentation</span> ==
* Building: [[Linux]], [[Mac OS X]], [[Windows]], [[FreeBSD]]
* [[libsigrok]] (hardware access lib)
* [[libsigrokdecode]] (protocol decoder lib)
* [[sigrok-cli]] (command-line)
* [[Protocol decoder HOWTO]]
* [[Protocol decoder API]]
* [[Formats and structures]]
* [[Hardware plugin API]]
* [[Input API]]
* [[Output API]]
* [[Input output formats]]
* [[Probe comparison]]
</div>


<div style="width: 50%; float: left;">
<div style="width: 50%; float: left; margin-bottom: 1em;">
== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps"; font-size:120%>Subprojects</span> ==
{{Box|
* [[sigrok-qt]] (cross-platform Qt GUI)
BORDER = #8898bf|
* [[sigrok-gtk]] (cross-platform GTK+ GUI)
BACKGROUND = cyan|
* [[GPIB]]/[[IEEE-488]] support project
WIDTH = 100%|
* [[gpibgrok]] project
ICON = |
* [[Protocol decoders]]
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Downloads and documentation</span>|
* [[fx2lafw]]
CONTENT =
* [[Firmware|Vendor firmware]]
<small>
* [[Example dumps]]
[[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>


<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>
</div>


<div style="clear: both;">
<div style="clear: both;">
<div style="width: 50%; float: left;">
 
== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps"; font-size:120%>Getting in touch</span> ==
<div style="width: 50%; float: left; margin-bottom: 1em;">
* 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])
{{Box|
* IRC: '''[irc://chat.freenode.net/sigrok #sigrok]''' on [http://www.freenode.net Freenode]
BORDER = #8898bf|
* Developer blog: [http://sigrok.org/blog/ sigrok.org/blog]
BACKGROUND = yellow|
* 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]
WIDTH = 100%|
* Google+: [https://plus.google.com/s/sigrok search]
ICON = |
* 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]/[http://freecode.com/projects/sigrok-dumps dumps], [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]]
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Getting in touch</span>|
* Other: [[Logo|sigrok logo]]
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>
</div>


<div style="width: 50%; float: left;">
<div style="width: 49%; float: right; margin-bottom: 1em;">
== [[File:Sigrok_stone.png]] <span style="font-variant:small-caps"; font-size:120%>Development</span> ==
{{Box|
* [http://sigrok.git.sourceforge.net/git/gitweb.cgi?p=sigrok/sigrok;a=tree Browse Source Code]
BORDER = #8898bf|
* [[TODO]]
BACKGROUND = lightblue|
* [[GUI design]]
WIDTH = 100%|
ICON = |
HEADING = [[File:Sigrok_stone.png]] <span style="font-variant:small-caps;">Development</span>|
CONTENT =
<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; [//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]]
</small>
}}
</div>
</div>



Revision as of 21:13, 11 January 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!