libsigrok

README

Das sigrok-Projekt hat zum Ziel, eine portable, plattformunabhängige, freie/Libre/Open-Source-Signalanalyse-Softwaresuite zu schaffen, die verschiedene Gerätetypen unterstützt (wie Logikanalysatoren, Oszilloskope, Multimeter und mehr).

libsigrok ist eine in C geschriebene Shared Library, die die grundlegende API für die Kommunikation mit Hardware sowie das Lesen/Schreiben der erfassten Daten in verschiedene Eingabe-/Ausgabedateiformate bereitstellt.

Status

libsigrok befindet sich in einem nutzbaren Zustand und hat bereits offizielle Tarball-Releases.

Auch wenn sich die API von Release zu Release ändern kann, wird dies immer ordnungsgemäß dokumentiert und in der Paketversionsnummer sowie in den Versionsnummern der Shared Library / von libtool / der .so-Dateien berücksichtigt.

Allerdings gibt es KEINERLEI Garantien für stabile APIs in Git-Snapshots! Distro-Paketbauer sollten ausschließlich veröffentlichte Tarballs verwenden (keine Git-Snapshots).

Anforderungen

Anforderungen für die C-Bibliothek:

• git (nur beim Bauen aus Git benötigt)
• gcc (>= 4.0) oder clang
• make
• autoconf >= 2.63 (nur beim Bauen aus Git benötigt)
• automake >= 1.11 (nur beim Bauen aus Git benötigt)
• libtool (nur beim Bauen aus Git benötigt)
• pkg-config >= 0.22
• libglib >= 2.32.0
• zlib (optional, wird für die CRC32-Berechnung im STF-Eingabeformat verwendet)
• libzip >= 0.11
• libtirpc (optional, von VXI verwendet, Fallback wenn glibc >= 2.26)
• libserialport >= 0.1.1 (optional, von einigen Treibern verwendet)
• librevisa >= 0.0.20130412 (optional, von einigen Treibern verwendet)
• libusb-1.0 >= 1.0.16 (optional, von einigen Treibern verwendet)
• hidapi >= 0.8.0 (optional, für einige HID-basierte „serielle Kabel“ verwendet)
• bluez/libbluetooth >= 4.0 (optional, für Bluetooth-/BLE-Kommunikation verwendet)
• libftdi1 >= 1.0 (optional, von einigen Treibern verwendet)
• libgpib (optional, von einigen Treibern verwendet)
• libieee1284 (optional, von einigen Treibern verwendet)
• libgio >= 2.32.0 (optional, von einigen Treibern verwendet)
• nettle (optional, von einigen Treibern verwendet)
• check >= 0.9.4 (optional, nur zum Ausführen von Unit-Tests benötigt)
• doxygen (optional, nur für die C-API-Dokumentation benötigt)
• graphviz (optional, nur für die C-API-Dokumentation benötigt)

Anforderungen für die C++-Bindings:

• libsigrok >= 0.4.0 (die libsigrok-C-Bibliothek, siehe oben)
• Ein C++-Compiler mit C++11-Unterstützung (-std=c++11-Option), z. B.
  • g++ (>= 4.8.1)
  • clang++ (>= 3.3)
• autoconf-archive (nur beim Bauen aus Git benötigt)
• doxygen (zum Bauen der Bindings erforderlich, nicht nur für die C++-API-Dokumentation!)
• graphviz (optional, nur für die C++-API-Dokumentation benötigt)
• Python-3-Programm (Entwicklungsdateien werden nicht benötigt)
• glibmm-2.4 (>= 2.32.0) oder glibmm-2.68 (>= 2.68.0)

Anforderungen für die Python-Bindings:

• libsigrokcxx >= 0.4.0 (die libsigrok-C++-Bindings, siehe oben)
• SWIG >= 2.0.0
• Python >= 3 (einschließlich Entwicklungsdateien!)
• Python setuptools
• pygobject >= 3.0.0, auch bekannt als python-gi
• numpy
• doxygen (optional, nur für die Python-API-Dokumentation benötigt)
• graphviz (optional, nur für die Python-API-Dokumentation benötigt)
• doxypy (optional, nur für die Python-API-Dokumentation benötigt)

Anforderungen für die Ruby-Bindings:

• libsigrokcxx >= 0.4.0 (die libsigrok-C++-Bindings, siehe oben)
• Ruby >= 2.5.0 (einschließlich Entwicklungsdateien!)
• SWIG >= 3.0.8
• YARD (optional, nur für die Ruby-API-Dokumentation benötigt)

Anforderungen für die Java-Bindings:

• libsigrokcxx >= 0.4.0 (die libsigrok-C++-Bindings, siehe oben)
• SWIG >= 2.0.0
• Java JDK (für die JNI-Includes und die javac/jar-Binärdateien)
• doxygen (optional, nur für die Java-API-Dokumentation benötigt)
• graphviz (optional, nur für die Java-API-Dokumentation benötigt)

Bauen und Installieren

Um den libsigrok-Quellcode zu erhalten und zu bauen, führen Sie Folgendes aus:

$ git clone git://sigrok.org/libsigrok $ cd libsigrok $ ./autogen.sh $ ./configure $ make

Zum Installieren von libsigrok:

$ make install

Weitere (betriebssystemspezifische) Anweisungen finden Sie in INSTALL oder auf der folgenden Wiki-Seite:

http://sigrok.org/wiki/Building

Bitte lesen Sie bei Problemen auch die folgende Wiki-Seite:

http://sigrok.org/wiki/Building#FAQ

Gerätespezifische Probleme

Bitte lesen Sie README.devices für Hinweise und Tipps zu geräte- oder treiberspezifischen Problemen, die zu beachten sind.

Firmware

Einige von libsigrok unterstützte Geräte benötigen eine Firmware, die hochgeladen werden muss, bevor das Gerät verwendet werden kann. Details finden Sie in README.devices.

Urheberrecht und Lizenz

libsigrok ist unter den Bedingungen der GNU General Public License (GPL), Version 3 oder später, lizenziert.

Obwohl einige einzelne Quellcodedateien unter GPLv2+ lizenziert sind und einige Dateien unter GPLv3+, ändert dies nichts an der Tatsache, dass die Bibliothek als Ganzes unter den Bedingungen der GPLv3+ lizenziert ist.

Die vollständige Liste der Urheberrechtsinhaber finden Sie in den einzelnen Quelldateien.

Mailingliste

https://lists.sourceforge.net/lists/listinfo/sigrok-devel

IRC

Sie finden die sigrok-Entwickler im IRC-Kanal #sigrok auf Libera.Chat.

Website

http://sigrok.org/wiki/Libsigrok