]>
Commit | Line | Data |
---|---|---|
1 | ------------------------------------------------------------------------------- | |
2 | README | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | The sigrok project aims at creating a portable, cross-platform, | |
6 | Free/Libre/Open-Source signal analysis software suite that supports various | |
7 | device types (such as logic analyzers, oscilloscopes, multimeters, and more). | |
8 | ||
9 | libsigrok is a shared library written in C which provides the basic API | |
10 | for talking to hardware and reading/writing the acquired data into various | |
11 | input/output file formats. | |
12 | ||
13 | ||
14 | Status | |
15 | ------ | |
16 | ||
17 | libsigrok is in a usable state and has had official tarball releases. | |
18 | ||
19 | While the API can change from release to release, this will always be | |
20 | properly documented and reflected in the package version number and | |
21 | in the shared library / libtool / .so-file version numbers. | |
22 | ||
23 | However, there are _NO_ guarantees at all for stable APIs in git snapshots! | |
24 | Distro packagers should only use released tarballs (no git snapshots). | |
25 | ||
26 | ||
27 | Requirements | |
28 | ------------ | |
29 | ||
30 | Requirements for the C library: | |
31 | ||
32 | - git (only needed when building from git) | |
33 | - gcc (>= 4.0) or clang | |
34 | - make | |
35 | - autoconf >= 2.63 (only needed when building from git) | |
36 | - automake >= 1.11 (only needed when building from git) | |
37 | - libtool (only needed when building from git) | |
38 | - pkg-config >= 0.22 | |
39 | - libglib >= 2.32.0 | |
40 | - zlib (optional, used for CRC32 calculation in STF input) | |
41 | - libzip >= 0.10 | |
42 | - libtirpc (optional, used by VXI, fallback when glibc >= 2.26) | |
43 | - libserialport >= 0.1.1 (optional, used by some drivers) | |
44 | - librevisa >= 0.0.20130412 (optional, used by some drivers) | |
45 | - libusb-1.0 >= 1.0.16 (optional, used by some drivers) | |
46 | - hidapi >= 0.8.0 (optional, used for some HID based "serial cables") | |
47 | - bluez/libbluetooth >= 4.0 (optional, used for Bluetooth/BLE communication) | |
48 | - libftdi1 >= 1.0 (optional, used by some drivers) | |
49 | - libgpib (optional, used by some drivers) | |
50 | - libieee1284 (optional, used by some drivers) | |
51 | - libgio >= 2.32.0 (optional, used by some drivers) | |
52 | - nettle (optional, used by some drivers) | |
53 | - check >= 0.9.4 (optional, only needed to run unit tests) | |
54 | - doxygen (optional, only needed for the C API docs) | |
55 | - graphviz (optional, only needed for the C API docs) | |
56 | ||
57 | Requirements for the C++ bindings: | |
58 | ||
59 | - libsigrok >= 0.4.0 (the libsigrok C library, see above) | |
60 | - A C++ compiler with C++11 support (-std=c++11 option), e.g. | |
61 | - g++ (>= 4.8.1) | |
62 | - clang++ (>= 3.3) | |
63 | - autoconf-archive (only needed when building from git) | |
64 | - doxygen (required for building the bindings, not only for C++ API docs!) | |
65 | - graphviz (optional, only needed for the C++ API docs) | |
66 | - Python (2 or 3) executable (development files are not needed) | |
67 | - glibmm-2.4 (>= 2.32.0) or glibmm-2.68 (>= 2.68.0) | |
68 | ||
69 | Requirements for the Python bindings: | |
70 | ||
71 | - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above) | |
72 | - Python >= 2.7 or Python >= 3 (including development files!) | |
73 | - Python setuptools (for Python 2 or 3) | |
74 | - pygobject >= 3.0.0 (for Python 2 or 3), a.k.a python-gi | |
75 | - numpy (for Python 2 or 3) | |
76 | - SWIG >= 2.0.0 | |
77 | - doxygen (optional, only needed for the Python API docs) | |
78 | - graphviz (optional, only needed for the Python API docs) | |
79 | - doxypy (optional, only needed for the Python API docs) | |
80 | ||
81 | Requirements for the Ruby bindings: | |
82 | ||
83 | - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above) | |
84 | - Ruby >= 2.5.0 (including development files!) | |
85 | - SWIG >= 3.0.8 | |
86 | - YARD (optional, only needed for the Ruby API docs) | |
87 | ||
88 | Requirements for the Java bindings: | |
89 | ||
90 | - libsigrokcxx >= 0.4.0 (the libsigrok C++ bindings, see above) | |
91 | - SWIG >= 2.0.0 | |
92 | - Java JDK (for JNI includes and the javac/jar binaries) | |
93 | - doxygen (optional, only needed for the Java API docs) | |
94 | - graphviz (optional, only needed for the Java API docs) | |
95 | ||
96 | ||
97 | Building and installing | |
98 | ----------------------- | |
99 | ||
100 | In order to get the libsigrok source code and build it, run: | |
101 | ||
102 | $ git clone git://sigrok.org/libsigrok | |
103 | $ cd libsigrok | |
104 | $ ./autogen.sh | |
105 | $ ./configure | |
106 | $ make | |
107 | ||
108 | For installing libsigrok: | |
109 | ||
110 | $ make install | |
111 | ||
112 | See INSTALL or the following wiki page for more (OS-specific) instructions: | |
113 | ||
114 | http://sigrok.org/wiki/Building | |
115 | ||
116 | Please also check the following wiki page in case you encounter any issues: | |
117 | ||
118 | http://sigrok.org/wiki/Building#FAQ | |
119 | ||
120 | ||
121 | Device-specific issues | |
122 | ---------------------- | |
123 | ||
124 | Please check README.devices for some notes and hints about device- or | |
125 | driver-specific issues to be aware of. | |
126 | ||
127 | ||
128 | Firmware | |
129 | -------- | |
130 | ||
131 | Some devices supported by libsigrok need a firmware to be uploaded before the | |
132 | device can be used. See README.devices for details. | |
133 | ||
134 | ||
135 | Copyright and license | |
136 | --------------------- | |
137 | ||
138 | libsigrok is licensed under the terms of the GNU General Public License | |
139 | (GPL), version 3 or later. | |
140 | ||
141 | While some individual source code files are licensed under the GPLv2+, and | |
142 | some files are licensed under the GPLv3+, this doesn't change the fact that | |
143 | the library as a whole is licensed under the terms of the GPLv3+. | |
144 | ||
145 | Please see the individual source files for the full list of copyright holders. | |
146 | ||
147 | ||
148 | Mailing list | |
149 | ------------ | |
150 | ||
151 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
152 | ||
153 | ||
154 | IRC | |
155 | --- | |
156 | ||
157 | You can find the sigrok developers in the #sigrok IRC channel on Libera.Chat. | |
158 | ||
159 | ||
160 | Website | |
161 | ------- | |
162 | ||
163 | http://sigrok.org/wiki/Libsigrok | |
164 |