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