]>
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 | 14 | |
796f0e98 | 15 | The default locations where libsigrok expects the firmware files are: |
c77ed446 | 16 | |
1503d457 | 17 | $SIGROK_FIRMWARE_DIR (environment variable) |
796f0e98 | 18 | $HOME/.local/share/sigrok-firmware |
c77ed446 | 19 | $prefix/share/sigrok-firmware |
796f0e98 UH |
20 | /usr/local/share/sigrok-firmware |
21 | /usr/share/sigrok-firmware | |
c77ed446 UH |
22 | |
23 | ($prefix is usually /usr/local or /usr, depending on your ./configure options) | |
24 | ||
25 | For further information see the section below and also: | |
26 | ||
27 | http://sigrok.org/wiki/Firmware | |
28 | ||
29 | ||
30 | Per-driver firmware requirements | |
31 | -------------------------------- | |
32 | ||
33 | The following drivers/devices require a firmware upload upon connection: | |
34 | ||
35 | - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files, | |
36 | depending on the settings used. These files are available from our | |
37 | 'sigrok-firmware' repository/project under a license which allows us | |
38 | to redistribute them. | |
39 | ||
40 | - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the | |
41 | firmware files from the 'sigrok-firmware-fx2lafw' repository/project. | |
e311f770 | 42 | The firmware is written from scratch and licensed under the GNU GPLv2+. |
c77ed446 | 43 | |
1d82f9ad UH |
44 | - hantek-6xxx: Certain oscilloscopes based on the Cypress FX2(LP) chip, such |
45 | as the Hantek 6022BE/6022BL, SainSmart DDS120, and Rocktech BM102, need the | |
796f0e98 UH |
46 | firmware files from the 'sigrok-firmware-fx2lafw' repository/project. |
47 | The firmware is written from scratch and licensed under the GNU GPLv2+. | |
48 | ||
c77ed446 UH |
49 | - hantek-dso: The Hantek DSO-2090 (and other supported models of the same |
50 | series of Hantek PC oscilloscopes) need firmware files. | |
51 | These can be extracted from the vendor's Windows drivers using a tool | |
52 | from our 'sigrok-util' repository/project. | |
53 | ||
796f0e98 UH |
54 | - lecroy-logicstudio: The LeCroy LogicStudio requires FPGA bitstream files. |
55 | These can be extracted from the vendor's Windows software using a tool | |
56 | from our 'sigrok-util' repository/project. | |
57 | Additionally, it requires a Cypress FX2 firmware. This can be extracted | |
58 | from the vendor's Windows software using another tool. Details: | |
59 | ||
60 | http://sigrok.org/wiki/LeCroy_LogicStudio#Firmware | |
61 | ||
1b142b78 UH |
62 | - saleae-logic16: The Saleae Logic16 needs a firmware file for the |
63 | Cypress FX2 chip in the device, as well as two FPGA bitstream files. | |
64 | These can be extracted from the vendor's Linux application using a tool | |
65 | from our 'sigrok-util' repository/project. | |
66 | ||
796f0e98 UH |
67 | - sysclk-lwla: |
68 | ||
69 | - The Sysclk LWLA1034 requires various bitstream files. | |
70 | These files are available from our 'sigrok-firmware' repository/project | |
71 | under a license which allows us to redistribute them. | |
72 | ||
73 | - The Sysclk LWLA1016 requires various bitstream files. | |
74 | These can be extracted from the vendor's Windows drivers using a tool | |
75 | from our 'sigrok-util' repository/project. | |
e311f770 | 76 | |
c77ed446 UH |
77 | The following drivers/devices do not need any firmware upload: |
78 | ||
79 | - agilent-dmm | |
1267f128 | 80 | - appa-55ii |
796f0e98 | 81 | - arachnid-labs-re-load-pro |
e311f770 | 82 | - atten-pps3xxx |
796f0e98 UH |
83 | - baylibre-acme |
84 | - beaglelogic | |
ecaa89af | 85 | - brymen-bm86x |
c77ed446 | 86 | - brymen-dmm |
45bb47a7 | 87 | - cem-dt-885x |
1267f128 | 88 | - center-3xx (including all subdrivers) |
7b356712 | 89 | - chronovu-la |
c77ed446 | 90 | - colead-slm |
e311f770 | 91 | - conrad-digi-35-cpu |
c77ed446 UH |
92 | - demo |
93 | - fluke-dmm | |
796f0e98 | 94 | - ftdi-la |
e311f770 | 95 | - gmc-mh-1x-2x (including all subdrivers) |
796f0e98 | 96 | - gwinstek-gds-800 |
1267f128 | 97 | - hameg-hmo |
796f0e98 UH |
98 | - hp-3457a |
99 | - hung-chang-dso-2100 | |
45bb47a7 | 100 | - ikalogic-scanalogic2 |
6cda4600 UH |
101 | - ikalogic-scanaplus |
102 | - kecheng-kc-330b | |
796f0e98 | 103 | - kern-scale |
c77ed446 | 104 | - lascar-el-usb |
7ab89f48 | 105 | - link-mso19 |
796f0e98 UH |
106 | - manson-hcs-3xxx |
107 | - maynuo-m97 | |
1267f128 | 108 | - mic-985xx (including all subdrivers) |
796f0e98 | 109 | - motech-lps-30x |
5fa12e93 | 110 | - norma-dmm |
c77ed446 | 111 | - openbench-logic-sniffer |
796f0e98 | 112 | - pce-322a |
4bd80e12 | 113 | - pipistrello-ols |
3086efdd | 114 | - rigol-ds |
796f0e98 | 115 | - scpi-pps |
1267f128 | 116 | - serial-dmm (including all subdrivers) |
f05903eb | 117 | - serial-lcr (including all subdrivers) |
5fa12e93 | 118 | - teleinfo |
796f0e98 | 119 | - testo |
c77ed446 | 120 | - tondaj-sl-814 |
1267f128 | 121 | - uni-t-dmm (including all subdrivers) |
1b142b78 | 122 | - uni-t-ut32x |
c77ed446 | 123 | - victor-dmm |
10763937 | 124 | - yokogawa-dlm |
c77ed446 UH |
125 | - zeroplus-logic-cube |
126 | ||
127 | ||
128 | Specifying serial ports | |
129 | ----------------------- | |
130 | ||
131 | Many devices supported by libsigrok use serial port based cables (real RS232 | |
132 | or USB-to-serial ones) to connect to a PC. | |
133 | ||
134 | For all these devices, you need to specify the serial port they are connected | |
135 | to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan | |
136 | for such devices without specifying a serial port. | |
137 | ||
138 | Example: | |
139 | ||
140 | $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ... | |
141 | ||
142 | The following drivers/devices require a serial port specification: | |
143 | ||
144 | - agilent-dmm | |
1267f128 | 145 | - appa-55ii |
e311f770 | 146 | - atten-pps3xxx |
c77ed446 | 147 | - brymen-dmm |
45bb47a7 | 148 | - cem-dt-885x |
1267f128 | 149 | - center-3xx (including all subdrivers) |
c77ed446 | 150 | - colead-slm |
e311f770 | 151 | - conrad-digi-35-cpu |
c77ed446 | 152 | - fluke-dmm |
e311f770 | 153 | - gmc-mh-1x-2x (including all subdrivers) |
1267f128 | 154 | - hameg-hmo |
7ab89f48 | 155 | - link-mso19 |
1267f128 | 156 | - mic-985xx (including all subdrivers) |
5fa12e93 | 157 | - norma-dmm |
c77ed446 | 158 | - openbench-logic-sniffer |
1267f128 UH |
159 | - rigol-ds (for RS232; not required for USBTMC or TCP) |
160 | - serial-dmm (including all subdrivers) | |
f05903eb | 161 | - serial-lcr (including all subdrivers) |
5fa12e93 | 162 | - teleinfo |
c77ed446 UH |
163 | - tondaj-sl-814 |
164 | ||
165 | The following drivers/devices do not require a serial port specification: | |
166 | ||
c77ed446 | 167 | - asix-sigma |
ecaa89af | 168 | - brymen-bm86x |
7b356712 | 169 | - chronovu-la |
c77ed446 UH |
170 | - demo |
171 | - fx2lafw | |
172 | - hantek-dso | |
45bb47a7 | 173 | - ikalogic-scanalogic2 |
6cda4600 UH |
174 | - ikalogic-scanaplus |
175 | - kecheng-kc-330b | |
c77ed446 | 176 | - lascar-el-usb |
4bd80e12 | 177 | - pipistrello-ols |
1267f128 | 178 | - rigol-ds (USBTMC or TCP) |
1b142b78 | 179 | - saleae-logic16 |
e311f770 | 180 | - sysclk-lwla |
1267f128 | 181 | - uni-t-dmm (including all subdrivers) |
1b142b78 | 182 | - uni-t-ut32x |
c77ed446 | 183 | - victor-dmm |
10763937 | 184 | - yokogawa-dlm (USBTMC or TCP) |
c77ed446 UH |
185 | - zeroplus-logic-cube |
186 | ||
187 | ||
f3f19d11 UH |
188 | Specifying serial port parameters |
189 | --------------------------------- | |
48d3238e MH |
190 | |
191 | Every serial device's driver has default serial port parameters like baud | |
192 | rate, number of data bits, stop bits and handshake status. If a device requires | |
193 | different parameters, pass them as option "serialcomm" with the driver name. | |
e311f770 | 194 | See libsigrok docs for the function serial_set_paramstr() for complete specs. |
48d3238e MH |
195 | |
196 | Example: | |
197 | ||
198 | $ sigrok-cli --driver <somedriver>:conn=<someconn>:serialcomm=9600/7n1/dtr=1 | |
199 | ||
200 | ||
c77ed446 UH |
201 | Permissions of serial port based devices |
202 | ---------------------------------------- | |
203 | ||
204 | When using devices supported by libsigrok that use serial port based cables | |
205 | (real RS232 or USB-to-serial ones) to connect to a PC, you need to ensure | |
206 | that the user running the libsigrok frontend has (read/write) permissions to | |
207 | access the serial port device (e.g. /dev/ttyS0, /dev/ttyUSB0, and so on). | |
208 | ||
209 | You can use 'chmod' to apply permissions as you see fit, and/or 'chown' to | |
210 | change the owner of the serial port device to a certain user or group. | |
211 | ||
212 | For USB-to-serial based devices, we recommended using our udev rules file | |
213 | (see below for details). | |
214 | ||
215 | ||
75696630 SB |
216 | Permissions for USB devices (udev rules files) |
217 | ---------------------------------------------- | |
c77ed446 UH |
218 | |
219 | When using USB-based devices supported by libsigrok, the user running the | |
220 | libsigrok frontend (e.g. sigrok-cli) has to have (read/write) permissions | |
221 | for the respective USB device. | |
222 | ||
75696630 SB |
223 | On Linux, this is accomplished using udev rules. libsigrok ships a rules |
224 | file containing all supported devices which can be detected reliably | |
225 | (generic USB-to-serial converters are omitted, as these are used for a wide | |
226 | range of devices, e.g. GPS receivers, which are not handled by libsigrok). | |
c77ed446 | 227 | |
75696630 SB |
228 | The file is available in contrib/60-libsigrok.rules. This file just contains |
229 | the list of devices and flags these devices with ID_SIGROK="1". Access is | |
230 | granted by the 61-libsigrok-plugdev.rules or 61-libsigrok-uaccess.rules files, | |
231 | allowing access to members of the plugdev group or to currently logged in | |
232 | users, respectively. | |
c77ed446 UH |
233 | |
234 | When using a libsigrok package from your favorite Linux distribution, the | |
75696630 SB |
235 | files should already be installed in /usr/lib/udev/rules.d/, i.e. |
236 | 60-libsigrok.rules and one of the access granting rules files. Use of | |
237 | 61-libsigrok-uaccess.rules is encouraged on systemd distributions. | |
238 | ||
239 | The access policy can be locally overridden by placing appropriate rules in | |
240 | /etc/udev/rules.d/, disabling or ammending the default policy. See the | |
241 | udev documentation, e.g. man 7 udev, for details. | |
c77ed446 UH |
242 | |
243 | If you're building from source, you need to copy the file to the place | |
75696630 SB |
244 | where udev will read these rules. Local rules should go to /etc/udev/rules.d. |
245 | Keep the file naming, otherwise interaction between the libsigrok rules and | |
246 | rules shipped by the system will be broken. | |
c77ed446 | 247 | |
75696630 | 248 | Please consult the udev docs for details. |
c77ed446 UH |
249 | |
250 | ||
251 | Cypress FX2 based devices | |
252 | ------------------------- | |
253 | ||
254 | Devices using the Cypress FX2(LP) chip without any specific USB VID/PID will | |
255 | be enumerated with VID/PID 04b4:8613 (the default for "unconfigured FX2"). | |
256 | These are usually "FX2 eval boards" (that can also be used as LAs, though). | |
257 | ||
258 | On Linux, the 'usbtest' driver will usually grab such devices, and they will | |
259 | thus not be usable by libsigrok (and frontends). | |
260 | ||
261 | You can fix this by running 'rmmod usbtest' as root before using the device. | |
262 | ||
263 | ||
264 | UNI-T DMM (and rebranded models) cables | |
265 | --------------------------------------- | |
266 | ||
267 | UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can | |
268 | ship with different PC connectivity cables: | |
269 | ||
270 | - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490) | |
271 | - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008) | |
272 | - UT-D02 (RS232 cable) | |
273 | ||
274 | The above cables are all physically compatible (same IR connector shape) | |
275 | with all/most currently known UNI-T multimeters. For example, you can | |
276 | use either of the UT-D04 USB/HID cables or the UT-D02 RS232 cable with | |
277 | the UNI-T UT61D multimeter. | |
278 | ||
279 | When using the UT-D02 RS232 cable with any of the supported UNI-T DMMs, | |
280 | you have to use the respective driver with a '-ser' drivername suffix | |
281 | (internally all of these models are handled by the 'serial-dmm' driver). | |
282 | ||
283 | You also need to specify the serial port via the 'conn' option, e.g. | |
284 | /dev/ttyUSB0 (attached via a USB-to-serial cable) or /dev/ttyS0 (actual | |
285 | RS232 port) on Linux (see above). | |
286 | ||
287 | Finally, the user running the frontend (e.g. sigrok-cli) also needs | |
288 | permissions to access the respective serial port (see above). | |
289 | ||
290 | Examples (sigrok-cli): | |
291 | ||
292 | $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ... | |
293 | $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ... | |
294 | ||
295 | When using any of the UT-D04 USB/HID cables you have to use the respective | |
296 | driver _without_ the '-ser' drivername suffix (internally all of these models | |
297 | are handled by the 'uni-t-dmm' driver). | |
298 | ||
9b2f03bb UH |
299 | You also need to specify the USB vendor/device IDs of the cable. |
300 | Autodetection is not possible here, since various other products use the | |
301 | USB VID/PID of those cables too, and there is no way to distinguish them. | |
302 | ||
c77ed446 UH |
303 | Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip) |
304 | there is no need to specify a serial port via 'conn', of course. | |
305 | However, the user running the frontend does also need to have permissions | |
306 | to access the respective USB device (see above). | |
307 | ||
308 | Examples (sigrok-cli): | |
309 | ||
9b2f03bb UH |
310 | $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ... |
311 | $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ... | |
c77ed446 UH |
312 | |
313 | ||
314 | UNI-T UT-D04 cable issue on Linux | |
315 | --------------------------------- | |
316 | ||
317 | The UNI-T UT-D04 cable with Hoitek HE2325U (or WCH CH9325) chip seems to have | |
8d3764aa | 318 | a very specific problem on Linux. Apparently it requires to be put into |
c77ed446 UH |
319 | suspend (and woken up again) before it is usable. This seems to be a |
320 | Linux-only issue, Windows is not affected by this since apparently the | |
321 | Windows kernel does this for every USB device, always. | |
322 | ||
323 | Thus, if you want to use any of the UNI-T DMMs with this specific cable, | |
324 | you'll have to run the following script (as root) once, every time you attach | |
325 | the cable via USB. The script was written by Ralf Burger. | |
326 | ||
327 | See also: http://erste.de/UT61/index.html | |
328 | ||
329 | #!/bin/bash | |
330 | for dat in /sys/bus/usb/devices/*; do | |
331 | if test -e $dat/manufacturer; then | |
332 | grep "WCH.CN" $dat/manufacturer > /dev/null && echo auto > ${dat}/power/level && echo 0 > ${dat}/power/autosuspend | |
333 | fi | |
334 | done | |
335 | ||
336 | ||
e6b2b4df UH |
337 | Enabling multimeter / data logger measurement output |
338 | ---------------------------------------------------- | |
339 | ||
340 | Some multimeters or data loggers will not start outputting measurement data | |
341 | unless a certain action has been performed by the user beforehand. This is | |
342 | usually mentioned in the vendor manual of the respective device, but here's | |
343 | a short list for convenience: | |
344 | ||
1267f128 UH |
345 | - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the |
346 | interface panel on top. | |
e6b2b4df | 347 | - Digitek DT4000ZC: Briefly press the "RS232" button. |
c90beca7 | 348 | - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232: |
fadd0707 MH |
349 | - Power on the device with the "DATA" button pressed. |
350 | - Metrahit 2x devices must be configured for the respective interface type. | |
c90beca7 | 351 | - Gossen Metrawatt Metrahit 2x devices, driver gmc-mh-2x-bd232: |
fadd0707 MH |
352 | - 'BD232' interface: |
353 | The multimeter must be configured for the respective interface type. | |
354 | - 'SI232-II' interface ("PC Mode"): | |
355 | The multimeter must be configured for interface type 'BD232' (all), | |
356 | 'SI232 online' (28-29S) or 'SI232 store' (22-26x). The interface must | |
357 | be configured to the same baud rate as the host (default 9600). | |
358 | Multimeter and interface must be configured to the same address. | |
1267f128 UH |
359 | - Norma DM950: If the interface doesn't work (e.g. USB-RS232 converter), power |
360 | on the device with "FUNC" pressed (to power the interface from the DMM). | |
e6b2b4df UH |
361 | - PCE PCE-DM32: Briefly press the "RS232" button. |
362 | - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together. | |
363 | - TekPower TP4000ZC: Briefly press the "RS232" button. | |
d9e79c51 | 364 | - Tenma 72-7750: Briefly press the "RS232C" button. |
4104ef81 | 365 | - UNI-T UT60G: Briefly press the "RS232C" button. |
7cb69b18 | 366 | - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second. |
8769478c UH |
367 | - UNI-T UT71x: Press the "SEND/-/MAXMIN" button for roughly 1 second. |
368 | Briefly pressing the "EXIT" button leaves this mode again. | |
1b142b78 UH |
369 | - UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it |
370 | appears that in practice you don't have to press the button (at least on | |
371 | some versions of the device), simply connect the device via USB. | |
1267f128 UH |
372 | - V&A VA18B/VA40B: Keep the "Hz/DUTY" key pressed while powering on the DMM. |
373 | - Victor 70C/86C: Press the "REL/RS232" button for roughly 1 second. | |
45bb47a7 | 374 | - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds. |
c36f78f7 | 375 | - Voltcraft VC-870: Press the "REL/PC" button for roughly 1 second. |
e6b2b4df UH |
376 | |
377 | ||
7b356712 UH |
378 | ChronoVu LA8/LA16 USB VID/PIDs |
379 | ------------------------------ | |
c77ed446 | 380 | |
7b356712 UH |
381 | The ChronoVu LA8/LA16 logic analyzer is available in two revisions. Previously, |
382 | the device shipped with a USB VID/PID of 0403:6001, which is the standard ID | |
c77ed446 UH |
383 | for FTDI FT232 USB chips. |
384 | ||
7b356712 | 385 | Since this made it hard to distinguish the LA8/LA16 from any other device |
c77ed446 | 386 | with this FTDI chip connected to the PC, the vendor later shipped the |
7b356712 | 387 | device with a USB VID/PID of 0403:8867. |
c77ed446 | 388 | |
7b356712 UH |
389 | The 'chronovu-la' driver in libsigrok supports both VID/PID pairs and |
390 | automatically finds devices with either VID/PID pair. | |
c77ed446 UH |
391 | |
392 | ||
393 | OLS | |
394 | --- | |
395 | ||
e311f770 UH |
396 | The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer |
397 | driver in libsigrok assumes a somewhat recent firmware has been flashed onto | |
398 | the OLS (it doesn't need a firmware upload every time it's attached via USB, | |
399 | since the firmware is stored in the device permanently). | |
c77ed446 UH |
400 | |
401 | The most recent firmware version that is tested is 3.07. | |
402 | ||
403 | If you use any older firmware and your OLS is not found or is not working | |
404 | properly, please upgrade to at least this firmware version. Check the | |
405 | Dangerous Prototypes wiki for firmware upgrade instructions: | |
406 | ||
407 | http://dangerousprototypes.com/docs/Logic_Sniffer_upgrade_procedure | |
408 | ||
409 | Also, you need to specify a serial port for the OLS in the frontends, e.g. | |
410 | using the 'conn' option in sigrok-cli, and you also need to have the | |
411 | permissions to access the serial port (see above). | |
412 | ||
413 | Example: | |
414 | ||
415 | $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ... | |
416 |