Difference between revisions of "Example dumps"
Jump to navigation
Jump to search
Uwe Hermann (talk | contribs) m |
(→Contributing dumps: The Gitorious sigrok-dumps repository went away (see e.g. the IRC channel 2017-11-18) - Gitorious was shut down and it wasn't moved to GitLab.) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
We collect various captured logic analyzer signals / protocol dumps in the [http://sigrok. | We collect various captured logic analyzer signals / protocol dumps in the [http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=tree sigrok-dumps] Git repository: | ||
They can be useful for testing the sigrok [[sigrok-cli|command-line]] application, the sigrok [[GUI]]s, or the [[protocol decoders]]. | They can be useful for testing the sigrok [[sigrok-cli|command-line]] application, the sigrok [[GUI]]s, or the [[protocol decoders]]. | ||
| Line 7: | Line 7: | ||
'''Tarball:''' | '''Tarball:''' | ||
You can download | You can download [http://sigrok.org/download/source/sigrok-dumps/ released tarballs] of the sigrok-dumps file collection. | ||
'''Git:''' | '''Git:''' | ||
Alternatively, you can also get the latest files from | Alternatively, you can also get the latest files from the Git repository: | ||
$ '''git clone git://sigrok. | $ '''git clone git://sigrok.org/sigrok-dumps''' | ||
== License == | == License == | ||
| Line 21: | Line 21: | ||
== Contributing dumps == | == Contributing dumps == | ||
We're happy to include further example data in our repository | We're happy to include further example data in our repository. Please send us '''.sr''' files of any interesting data/protocol you may come across (even if sigrok doesn't yet have a protocol decoder for that protocol). | ||
The easiest method is to clone the '''sigrok-dumps''' repository (e.g. on | The easiest method is to clone the '''sigrok-dumps''' repository (e.g. [https://github.com/sigrokproject/sigrok-dumps on GitHub]) and ask us to pull from there (e.g. in IRC or on the mailing list). Alternatively, you can also send the files (and a README, see below) to the mailing list. | ||
Please include the following items: | Please include the following items: | ||
* Protocol dumps in '''.sr''' format (the sigrok session format). Please do not send files in binary, VCD, CSV, or other formats. | * Protocol dumps in '''.sr''' format (the sigrok session format). Please do not send files in binary, VCD, CSV, or other formats. | ||
* A README file ([http://sigrok. | * A README file ([http://sigrok.org/gitweb/?p=sigrok-dumps.git;a=blob_plain;f=jtag/olimex_stm32-h103/README;hb=HEAD example]) which contains info such as: | ||
** Which logic analyzer hardware was used. | ** Which logic analyzer hardware was used. | ||
** Which target device was being probed (include vendor, name, description, relevant URLs, and so on, if possible). | ** Which target device was being probed (include vendor, name, description, relevant URLs, and so on, if possible). | ||
** Which probes (number/name/color) were connected to which pins on the target device. | ** Which probes (number/name/color) were connected to which pins on the target device. | ||
** Which exact [[sigrok-cli]] command line was used to generate the dump (includes device, samplerate, triggers, probe | ** Which exact [[sigrok-cli]] command line was used to generate the dump (includes device, samplerate, triggers, probe assignment, and so on). | ||
** Any other relevant information about your setup, the device being probed, and so on. | ** Any other relevant information about your setup, the device being probed, and so on. | ||
* If you want to release the files under a (freeish) license other than "public domain", please let us know about that. | * If you want to release the files under a (freeish) license other than "public domain", please let us know about that. | ||
Latest revision as of 13:56, 18 December 2017
We collect various captured logic analyzer signals / protocol dumps in the sigrok-dumps Git repository:
They can be useful for testing the sigrok command-line application, the sigrok GUIs, or the protocol decoders.
Download
Tarball:
You can download released tarballs of the sigrok-dumps file collection.
Git:
Alternatively, you can also get the latest files from the Git repository:
$ git clone git://sigrok.org/sigrok-dumps
License
Unless otherwise noted, all dumps are released into the public domain by their respective authors.
Contributing dumps
We're happy to include further example data in our repository. Please send us .sr files of any interesting data/protocol you may come across (even if sigrok doesn't yet have a protocol decoder for that protocol).
The easiest method is to clone the sigrok-dumps repository (e.g. on GitHub) and ask us to pull from there (e.g. in IRC or on the mailing list). Alternatively, you can also send the files (and a README, see below) to the mailing list.
Please include the following items:
- Protocol dumps in .sr format (the sigrok session format). Please do not send files in binary, VCD, CSV, or other formats.
- A README file (example) which contains info such as:
- Which logic analyzer hardware was used.
- Which target device was being probed (include vendor, name, description, relevant URLs, and so on, if possible).
- Which probes (number/name/color) were connected to which pins on the target device.
- Which exact sigrok-cli command line was used to generate the dump (includes device, samplerate, triggers, probe assignment, and so on).
- Any other relevant information about your setup, the device being probed, and so on.
- If you want to release the files under a (freeish) license other than "public domain", please let us know about that.