]>
Commit | Line | Data |
---|---|---|
c77ed446 UH |
1 | ------------------------------------------------------------------------------- |
2 | README.devices | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | This README contains various notes for users of libsigrok (or frontends | |
6 | that are based on libsigrok) about device- and/or driver-specific issues. | |
7 | ||
8 | ||
9 | Firmware | |
10 | -------- | |
11 | ||
12 | Some devices supported by libsigrok need a firmware to be uploaded every time | |
13 | the device is connected to the PC (usually via USB), before it can be used. | |
14 | ||
15 | The default location where libsigrok expects the firmware files is: | |
16 | ||
17 | $prefix/share/sigrok-firmware | |
18 | ||
19 | ($prefix is usually /usr/local or /usr, depending on your ./configure options) | |
20 | ||
21 | For further information see the section below and also: | |
22 | ||
23 | http://sigrok.org/wiki/Firmware | |
24 | ||
25 | ||
26 | Per-driver firmware requirements | |
27 | -------------------------------- | |
28 | ||
29 | The following drivers/devices require a firmware upload upon connection: | |
30 | ||
31 | - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files, | |
32 | depending on the settings used. These files are available from our | |
33 | 'sigrok-firmware' repository/project under a license which allows us | |
34 | to redistribute them. | |
35 | ||
36 | - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the | |
37 | firmware files from the 'sigrok-firmware-fx2lafw' repository/project. | |
38 | The firmware is written from scratch and licensed under the GPLv2+. | |
39 | ||
40 | - hantek-dso: The Hantek DSO-2090 (and other supported models of the same | |
41 | series of Hantek PC oscilloscopes) need firmware files. | |
42 | These can be extracted from the vendor's Windows drivers using a tool | |
43 | from our 'sigrok-util' repository/project. | |
44 | ||
1b142b78 UH |
45 | - saleae-logic16: The Saleae Logic16 needs a firmware file for the |
46 | Cypress FX2 chip in the device, as well as two FPGA bitstream files. | |
47 | These can be extracted from the vendor's Linux application using a tool | |
48 | from our 'sigrok-util' repository/project. | |
49 | ||
c77ed446 UH |
50 | The following drivers/devices do not need any firmware upload: |
51 | ||
52 | - agilent-dmm | |
53 | - alsa | |
54 | - brymen-dmm | |
45bb47a7 | 55 | - cem-dt-885x |
1b142b78 | 56 | - center-3xx |
c77ed446 UH |
57 | - chronovu-la8 |
58 | - colead-slm | |
59 | - demo | |
60 | - fluke-dmm | |
45bb47a7 | 61 | - ikalogic-scanalogic2 |
6cda4600 UH |
62 | - ikalogic-scanaplus |
63 | - kecheng-kc-330b | |
c77ed446 | 64 | - lascar-el-usb |
7ab89f48 | 65 | - link-mso19 |
c77ed446 | 66 | - mic-985xx |
5fa12e93 | 67 | - norma-dmm |
c77ed446 | 68 | - openbench-logic-sniffer |
3086efdd | 69 | - rigol-ds |
c77ed446 | 70 | - serial-dmm |
5fa12e93 | 71 | - teleinfo |
c77ed446 UH |
72 | - tondaj-sl-814 |
73 | - uni-t-dmm | |
1b142b78 | 74 | - uni-t-ut32x |
c77ed446 UH |
75 | - victor-dmm |
76 | - zeroplus-logic-cube | |
77 | ||
78 | ||
79 | Specifying serial ports | |
80 | ----------------------- | |
81 | ||
82 | Many devices supported by libsigrok use serial port based cables (real RS232 | |
83 | or USB-to-serial ones) to connect to a PC. | |
84 | ||
85 | For all these devices, you need to specify the serial port they are connected | |
86 | to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan | |
87 | for such devices without specifying a serial port. | |
88 | ||
89 | Example: | |
90 | ||
91 | $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ... | |
92 | ||
93 | The following drivers/devices require a serial port specification: | |
94 | ||
95 | - agilent-dmm | |
96 | - brymen-dmm | |
45bb47a7 | 97 | - cem-dt-885x |
1b142b78 | 98 | - center-3xx |
c77ed446 UH |
99 | - colead-slm |
100 | - fluke-dmm | |
7ab89f48 | 101 | - link-mso19 |
c77ed446 | 102 | - mic-985xx |
5fa12e93 | 103 | - norma-dmm |
c77ed446 UH |
104 | - openbench-logic-sniffer |
105 | - serial-dmm | |
5fa12e93 | 106 | - teleinfo |
c77ed446 UH |
107 | - tondaj-sl-814 |
108 | ||
109 | The following drivers/devices do not require a serial port specification: | |
110 | ||
111 | - alsa | |
112 | - asix-sigma | |
113 | - chronovu-la8 | |
114 | - demo | |
115 | - fx2lafw | |
116 | - hantek-dso | |
45bb47a7 | 117 | - ikalogic-scanalogic2 |
6cda4600 UH |
118 | - ikalogic-scanaplus |
119 | - kecheng-kc-330b | |
c77ed446 | 120 | - lascar-el-usb |
3086efdd | 121 | - rigol-ds |
1b142b78 | 122 | - saleae-logic16 |
c77ed446 | 123 | - uni-t-dmm |
1b142b78 | 124 | - uni-t-ut32x |
c77ed446 UH |
125 | - victor-dmm |
126 | - zeroplus-logic-cube | |
127 | ||
128 | ||
129 | Permissions of serial port based devices | |
130 | ---------------------------------------- | |
131 | ||
132 | When using devices supported by libsigrok that use serial port based cables | |
133 | (real RS232 or USB-to-serial ones) to connect to a PC, you need to ensure | |
134 | that the user running the libsigrok frontend has (read/write) permissions to | |
135 | access the serial port device (e.g. /dev/ttyS0, /dev/ttyUSB0, and so on). | |
136 | ||
137 | You can use 'chmod' to apply permissions as you see fit, and/or 'chown' to | |
138 | change the owner of the serial port device to a certain user or group. | |
139 | ||
140 | For USB-to-serial based devices, we recommended using our udev rules file | |
141 | (see below for details). | |
142 | ||
143 | ||
144 | Permissions for USB devices (udev rules file) | |
145 | --------------------------------------------- | |
146 | ||
147 | When using USB-based devices supported by libsigrok, the user running the | |
148 | libsigrok frontend (e.g. sigrok-cli) has to have (read/write) permissions | |
149 | for the respective USB device. | |
150 | ||
151 | On Linux, this is accomplished using either 'chmod' (not recommended) or | |
152 | using the udev rules file shipped with libsigrok (recommended). | |
153 | ||
154 | The file is available in contrib/z60_libsigrok.rules. It contains entries | |
155 | for all libsigrok-supported (USB-based) devices and changes their group | |
156 | to 'plugdev' and the permissions to '664'. | |
157 | ||
158 | When using a libsigrok package from your favorite Linux distribution, the | |
159 | packager will have already taken care of properly installing the udev file | |
160 | in the correct (distro-specific) place, and you don't have to do anything. | |
161 | The packager might also have adapted 'plugdev' and '664' as needed. | |
162 | ||
163 | If you're building from source, you need to copy the file to the place | |
164 | where your distro expects such files. This is beyond the scope of this README, | |
165 | but generally the location could be e.g. /etc/udev/rules.d, or maybe | |
166 | /lib/udev/rules.d, or something else. Afterwards you might have to restart | |
167 | udev, e.g. via '/etc/init.d/udev restart' or similar, and you'll have to | |
168 | re-attach your device via USB. | |
169 | ||
170 | Please consult the udev docs of your distro for details. | |
171 | ||
172 | ||
173 | Cypress FX2 based devices | |
174 | ------------------------- | |
175 | ||
176 | Devices using the Cypress FX2(LP) chip without any specific USB VID/PID will | |
177 | be enumerated with VID/PID 04b4:8613 (the default for "unconfigured FX2"). | |
178 | These are usually "FX2 eval boards" (that can also be used as LAs, though). | |
179 | ||
180 | On Linux, the 'usbtest' driver will usually grab such devices, and they will | |
181 | thus not be usable by libsigrok (and frontends). | |
182 | ||
183 | You can fix this by running 'rmmod usbtest' as root before using the device. | |
184 | ||
185 | ||
186 | UNI-T DMM (and rebranded models) cables | |
187 | --------------------------------------- | |
188 | ||
189 | UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can | |
190 | ship with different PC connectivity cables: | |
191 | ||
192 | - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490) | |
193 | - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008) | |
194 | - UT-D02 (RS232 cable) | |
195 | ||
196 | The above cables are all physically compatible (same IR connector shape) | |
197 | with all/most currently known UNI-T multimeters. For example, you can | |
198 | use either of the UT-D04 USB/HID cables or the UT-D02 RS232 cable with | |
199 | the UNI-T UT61D multimeter. | |
200 | ||
201 | When using the UT-D02 RS232 cable with any of the supported UNI-T DMMs, | |
202 | you have to use the respective driver with a '-ser' drivername suffix | |
203 | (internally all of these models are handled by the 'serial-dmm' driver). | |
204 | ||
205 | You also need to specify the serial port via the 'conn' option, e.g. | |
206 | /dev/ttyUSB0 (attached via a USB-to-serial cable) or /dev/ttyS0 (actual | |
207 | RS232 port) on Linux (see above). | |
208 | ||
209 | Finally, the user running the frontend (e.g. sigrok-cli) also needs | |
210 | permissions to access the respective serial port (see above). | |
211 | ||
212 | Examples (sigrok-cli): | |
213 | ||
214 | $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ... | |
215 | $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ... | |
216 | ||
217 | When using any of the UT-D04 USB/HID cables you have to use the respective | |
218 | driver _without_ the '-ser' drivername suffix (internally all of these models | |
219 | are handled by the 'uni-t-dmm' driver). | |
220 | ||
9b2f03bb UH |
221 | You also need to specify the USB vendor/device IDs of the cable. |
222 | Autodetection is not possible here, since various other products use the | |
223 | USB VID/PID of those cables too, and there is no way to distinguish them. | |
224 | ||
c77ed446 UH |
225 | Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip) |
226 | there is no need to specify a serial port via 'conn', of course. | |
227 | However, the user running the frontend does also need to have permissions | |
228 | to access the respective USB device (see above). | |
229 | ||
230 | Examples (sigrok-cli): | |
231 | ||
9b2f03bb UH |
232 | $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ... |
233 | $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ... | |
c77ed446 UH |
234 | |
235 | ||
236 | UNI-T UT-D04 cable issue on Linux | |
237 | --------------------------------- | |
238 | ||
239 | The UNI-T UT-D04 cable with Hoitek HE2325U (or WCH CH9325) chip seems to have | |
8d3764aa | 240 | a very specific problem on Linux. Apparently it requires to be put into |
c77ed446 UH |
241 | suspend (and woken up again) before it is usable. This seems to be a |
242 | Linux-only issue, Windows is not affected by this since apparently the | |
243 | Windows kernel does this for every USB device, always. | |
244 | ||
245 | Thus, if you want to use any of the UNI-T DMMs with this specific cable, | |
246 | you'll have to run the following script (as root) once, every time you attach | |
247 | the cable via USB. The script was written by Ralf Burger. | |
248 | ||
249 | See also: http://erste.de/UT61/index.html | |
250 | ||
251 | #!/bin/bash | |
252 | for dat in /sys/bus/usb/devices/*; do | |
253 | if test -e $dat/manufacturer; then | |
254 | grep "WCH.CN" $dat/manufacturer > /dev/null && echo auto > ${dat}/power/level && echo 0 > ${dat}/power/autosuspend | |
255 | fi | |
256 | done | |
257 | ||
258 | ||
e6b2b4df UH |
259 | Enabling multimeter / data logger measurement output |
260 | ---------------------------------------------------- | |
261 | ||
262 | Some multimeters or data loggers will not start outputting measurement data | |
263 | unless a certain action has been performed by the user beforehand. This is | |
264 | usually mentioned in the vendor manual of the respective device, but here's | |
265 | a short list for convenience: | |
266 | ||
267 | - Digitek DT4000ZC: Briefly press the "RS232" button. | |
268 | - PCE PCE-DM32: Briefly press the "RS232" button. | |
269 | - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together. | |
270 | - TekPower TP4000ZC: Briefly press the "RS232" button. | |
7cb69b18 | 271 | - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second. |
1b142b78 UH |
272 | - UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it |
273 | appears that in practice you don't have to press the button (at least on | |
274 | some versions of the device), simply connect the device via USB. | |
e6b2b4df UH |
275 | - V&A VA18B: Keep the "Hz/DUTY" key pressed while powering on the device. |
276 | - Victor 70C: Press the "REL/RS232" button for roughly 1 second. | |
277 | - Victor 86C: Press the "REL/RS232" button for roughly 1 second. | |
45bb47a7 | 278 | - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds. |
e6b2b4df UH |
279 | |
280 | ||
c77ed446 UH |
281 | ALSA driver |
282 | ----------- | |
283 | ||
284 | The 'alsa' driver can be used to sample analog data using a PC's soundcard. | |
285 | I.e. the sound card can act as a simple oscilloscope (with some limitations) | |
286 | using commercial or DIY "sound card scope probe" cables. | |
287 | ||
288 | Since ALSA is a Linux-specific sound system, this driver will inherently | |
289 | only compile and work on Linux. | |
290 | ||
291 | We might write additional drivers to make a similar functionality available | |
292 | on other OSes at some point. | |
293 | ||
294 | ||
7ab89f48 UH |
295 | Link Instruments MSO-19 |
296 | ----------------------- | |
297 | ||
298 | The driver for the Link Instruments MSO-19 mixed-signal oscilloscope (MSO) | |
299 | is currently using libudev (which is a library for the Linux-specific udev | |
300 | system). Thus, this driver can currently only compile and work on Linux. | |
301 | ||
302 | We plan to fix this though, so that it'll work on all other OSes, too. | |
303 | ||
304 | ||
c77ed446 UH |
305 | ChronoVu LA8 USB VID/PIDs |
306 | ------------------------- | |
307 | ||
308 | The ChronoVu LA8 logic analyzer is available in two revisions. Previously, | |
309 | the LA8 shipped with a USB VID/PID of 0403:6001, which is the standard ID | |
310 | for FTDI FT232 USB chips. | |
311 | ||
312 | Since this made it hard to distinguish the LA8 from any other device | |
313 | with this FTDI chip connected to the PC, the vendor later shipped the | |
314 | LA8 with a USB VID/PID of 0403:8867. | |
315 | ||
316 | The 'chronovu-la8' driver in libsigrok supports both VID/PID pairs and | |
317 | automatically finds devices with either VID/PID pair. However, currently | |
318 | the driver will assume any device with VID/PID 0403:6001 is a ChronoVu LA8. | |
319 | ||
320 | ||
321 | OLS | |
322 | --- | |
323 | ||
324 | The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer is | |
325 | supported by the 'ols' driver in libsigrok. This driver assumes a somewhat | |
326 | recent firmware has been flashed onto the OLS (it doesn't need a firmware | |
327 | upload every time it's attached via USB, since the firmware is stored in the | |
328 | device permanently). | |
329 | ||
330 | The most recent firmware version that is tested is 3.07. | |
331 | ||
332 | If you use any older firmware and your OLS is not found or is not working | |
333 | properly, please upgrade to at least this firmware version. Check the | |
334 | Dangerous Prototypes wiki for firmware upgrade instructions: | |
335 | ||
336 | http://dangerousprototypes.com/docs/Logic_Sniffer_upgrade_procedure | |
337 | ||
338 | Also, you need to specify a serial port for the OLS in the frontends, e.g. | |
339 | using the 'conn' option in sigrok-cli, and you also need to have the | |
340 | permissions to access the serial port (see above). | |
341 | ||
342 | Example: | |
343 | ||
344 | $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ... | |
345 | ||
346 | ||
3086efdd ML |
347 | Rigol DS oscilloscopes |
348 | ---------------------- | |
c77ed446 | 349 | |
3086efdd ML |
350 | The 'rigol-ds' driver (for the Rigol DS series DSOs) currently uses the Linux |
351 | usbtmc kernel driver. This means it can currently only be built and used on | |
352 | Linux (i.e., it's non-portable). | |
c77ed446 UH |
353 | |
354 | The use of a kernel module also means it is dependent on the kernel version | |
355 | used, as well as on whether this specific module is available in the kernel. | |
356 | Additionally, the usbtmc kernel module has been known to have various bugs | |
357 | in some versions. These are some (but not all) drawbacks of using a kernel | |
358 | module as opposed to a libusb-based driver that works in user-space. | |
359 | ||
360 | We plan to change the driver to use the 'librevisa' user-space shared | |
361 | library (which uses libusb) soon, which will fix all these issues and make | |
362 | the driver portable at the same time. |