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