]> sigrok.org Git - libsigrok.git/blame - README.devices
README.devices: document conn=bt/ extensions for more optional parameters
[libsigrok.git] / README.devices
CommitLineData
c77ed446
UH
1-------------------------------------------------------------------------------
2README.devices
3-------------------------------------------------------------------------------
4
5This README contains various notes for users of libsigrok (or frontends
6that are based on libsigrok) about device- and/or driver-specific issues.
7
8
9Firmware
10--------
11
12Some devices supported by libsigrok need a firmware to be uploaded every time
fadd0707 13the device is connected to the PC (usually via USB), before it can be used.
c77ed446 14
796f0e98 15The 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
25For further information see the section below and also:
26
27 http://sigrok.org/wiki/Firmware
28
29
30Per-driver firmware requirements
31--------------------------------
32
33The following drivers/devices require a firmware upload upon connection:
34
734bab71
GS
35 - asix-omega-rtm-cli: There is no native sigrok support for ASIX OMEGA
36 devices. But the vendor's RTM CLI application can be used in streaming
37 mode, which transparently handles the device detection and firmware
38 download. The firmware ships with the vendor application. See below
39 for details how to make the vendor application available to the sigrok
40 driver.
41
c77ed446
UH
42 - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files,
43 depending on the settings used. These files are available from our
44 'sigrok-firmware' repository/project under a license which allows us
45 to redistribute them.
46
599f9e1d
UH
47 - dreamsourcelab-dslogic: The DreamSourceLab DSLogic/DSCope device series
48 requires various firmware files and FPGA bitstream files.
49 These can be extracted/downloaded from the vendor's GitHub repo using a
50 tool from our 'sigrok-util' repository/project.
51
c77ed446
UH
52 - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the
53 firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
e311f770 54 The firmware is written from scratch and licensed under the GNU GPLv2+.
c77ed446 55
1d82f9ad
UH
56 - hantek-6xxx: Certain oscilloscopes based on the Cypress FX2(LP) chip, such
57 as the Hantek 6022BE/6022BL, SainSmart DDS120, and Rocktech BM102, need the
796f0e98
UH
58 firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
59 The firmware is written from scratch and licensed under the GNU GPLv2+.
60
c77ed446
UH
61 - hantek-dso: The Hantek DSO-2090 (and other supported models of the same
62 series of Hantek PC oscilloscopes) need firmware files.
63 These can be extracted from the vendor's Windows drivers using a tool
64 from our 'sigrok-util' repository/project.
65
ffd150de
GS
66 - kingst-la2016: The Kingst LA series of logic analyzers needs MCU firmware
67 and FPGA netlists. The 'sigrok-util' repository contains a script to
68 extract these files from the vendor software.
69
796f0e98
UH
70 - lecroy-logicstudio: The LeCroy LogicStudio requires FPGA bitstream files.
71 These can be extracted from the vendor's Windows software using a tool
72 from our 'sigrok-util' repository/project.
73 Additionally, it requires a Cypress FX2 firmware. This can be extracted
74 from the vendor's Windows software using another tool. Details:
75
76 http://sigrok.org/wiki/LeCroy_LogicStudio#Firmware
77
1b142b78
UH
78 - saleae-logic16: The Saleae Logic16 needs a firmware file for the
79 Cypress FX2 chip in the device, as well as two FPGA bitstream files.
80 These can be extracted from the vendor's Linux application using a tool
81 from our 'sigrok-util' repository/project.
82
599f9e1d
UH
83 - saleae-logic-pro: The Saleae Logic Pro 16 needs a firmware file for the
84 Cypress FX3 chip in the device, as well as an FPGA bitstream file.
85 These can be extracted from the vendor's Linux application using a tool
86 from our 'sigrok-util' repository/project.
87
796f0e98
UH
88 - sysclk-lwla:
89
90 - The Sysclk LWLA1034 requires various bitstream files.
91 These files are available from our 'sigrok-firmware' repository/project
92 under a license which allows us to redistribute them.
93
94 - The Sysclk LWLA1016 requires various bitstream files.
95 These can be extracted from the vendor's Windows drivers using a tool
96 from our 'sigrok-util' repository/project.
e311f770 97
599f9e1d
UH
98 - sysclk-sla5032: The Sysclk SLA5032 needs an FPGA bitstream file.
99 This file can be copied (and renamed) from the Windows vendor software
100 installation directory. Details:
101
102 https://sigrok.org/wiki/Sysclk_SLA5032#Firmware
103
c77ed446
UH
104The following drivers/devices do not need any firmware upload:
105
106 - agilent-dmm
1267f128 107 - appa-55ii
796f0e98 108 - arachnid-labs-re-load-pro
e311f770 109 - atten-pps3xxx
796f0e98
UH
110 - baylibre-acme
111 - beaglelogic
45bb47a7 112 - cem-dt-885x
1267f128 113 - center-3xx (including all subdrivers)
7b356712 114 - chronovu-la
c77ed446 115 - colead-slm
e311f770 116 - conrad-digi-35-cpu
c77ed446 117 - demo
599f9e1d 118 - fluke-45
c77ed446 119 - fluke-dmm
796f0e98 120 - ftdi-la
e311f770 121 - gmc-mh-1x-2x (including all subdrivers)
796f0e98 122 - gwinstek-gds-800
599f9e1d 123 - gwinstek-gpd
1267f128 124 - hameg-hmo
599f9e1d 125 - hantek-4032l
796f0e98 126 - hp-3457a
599f9e1d 127 - hp-3478a
796f0e98 128 - hung-chang-dso-2100
45bb47a7 129 - ikalogic-scanalogic2
6cda4600 130 - ikalogic-scanaplus
599f9e1d 131 - ipdbg-la
6cda4600 132 - kecheng-kc-330b
796f0e98 133 - kern-scale
599f9e1d 134 - korad-kaxxxxp
c77ed446 135 - lascar-el-usb
599f9e1d 136 - lecroy-xstream
7ab89f48 137 - link-mso19
796f0e98
UH
138 - manson-hcs-3xxx
139 - maynuo-m97
1267f128 140 - mic-985xx (including all subdrivers)
599f9e1d 141 - microchip-pickit2
ebcd1aba 142 - mooshimeter-dmm
599f9e1d 143 - motech-lps-30x
5fa12e93 144 - norma-dmm
c77ed446 145 - openbench-logic-sniffer
796f0e98 146 - pce-322a
4bd80e12 147 - pipistrello-ols
599f9e1d 148 - rdtech-dps
02feeb30 149 - rigol-dg
3086efdd 150 - rigol-ds
599f9e1d
UH
151 - rohde-schwarz-sme-0x
152 - scpi-dmm
796f0e98 153 - scpi-pps
1267f128 154 - serial-dmm (including all subdrivers)
f05903eb 155 - serial-lcr (including all subdrivers)
563c2463 156 - siglent-sds
5fa12e93 157 - teleinfo
796f0e98 158 - testo
c77ed446 159 - tondaj-sl-814
1267f128 160 - uni-t-dmm (including all subdrivers)
1b142b78 161 - uni-t-ut32x
10763937 162 - yokogawa-dlm
c77ed446 163 - zeroplus-logic-cube
599f9e1d 164 - zketech-ebd-usb
c77ed446
UH
165
166
167Specifying serial ports
168-----------------------
169
170Many devices supported by libsigrok use serial port based cables (real RS232
f736691d
GS
171or USB-to-serial ones, CDC class) to connect to a PC. These serial cables are
172supported by the libserialport library. Some vendors prefer to use HID chips
173instead of CDC chips in their serial cables. These cables can get supported
174by means of the hidapi library. Note that each chip type requires specific
07e42cb2
GS
175support in the libsigrok library. Bluetooth connected devices may be supported
176as well when they communicate by means of RFCOMM channels, or one of the
177implemented BLE notification/indication approaches, and one of the Bluetooth
178supporting platforms is used.
c77ed446
UH
179
180For all these devices, you need to specify the serial port they are connected
181to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan
182for such devices without specifying a serial port.
183
184Example:
185
186 $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ...
f736691d 187 $ sigrok-cli --driver <somedriver>:conn=hid/cp2110 ...
07e42cb2 188 $ sigrok-cli --driver <somedriver>:conn=bt/rfcomm/01-23-45-67-89-ab ...
c77ed446 189
e2a391aa
GS
190Formal syntax for serial communication:
191
192 - COM ports (RS232, USB CDC):
193 conn=<com-port>
194 - USB HID cables:
195 conn=hid[/<chip>]
196 conn=hid[/<chip>]/usb=<bus>.<dev>[.<if>]
197 conn=hid[/<chip>]/raw=<path>
198 conn=hid[/<chip>]/sn=<serno>
d7df9dc7 199 conn=hid[/<chip>]/iokit=<path>
599f9e1d 200 chip can be: bu86x, ch9325, cp2110, victor
e2a391aa
GS
201 path may contain slashes
202 path and serno are "greedy" (span to the end of the spec)
203 - Bluetooth Classic and Bluetooth Low Energy (BLE):
0dea0243 204 conn=bt/<conn>/<addr>[/param=value]
e2a391aa
GS
205 conn can be: rfcomm, ble122, nrf51, cc254x
206 addr can be "dense" or separated, bt/cc254x/0123456789ab or
207 bt/rfcomm/11-22-33-44-55-66 or bt/ble122/88:6b:12:34:56:78
208 (note that colons may not be available when the conn= spec is taken
209 from a string that separates fields by colon, e.g. in the "--driver
210 <name>:conn=<spec>" example, that is why the dense form and the use
211 of dashes for separation are supported)
0dea0243
GS
212 additional parameter keywords can be: channel, handle_rx, handle_tx,
213 handle_cccd, value_cccd
e2a391aa 214
599f9e1d
UH
215Some of the drivers implement a default for the connection. Some of the
216drivers can auto-detect USB connected devices.
c77ed446 217
e2a391aa 218Beyond strict serial communication over COM ports (discussed above), the
ca25a3ee
GS
219conn= property can also address specific USB devices, as well as specify TCP
220or VXI communication parameters. See these examples:
221
222 $ sigrok-cli --driver <somedriver>:conn=<vid>.<pid> ...
223 $ sigrok-cli --driver <somedriver>:conn=tcp-raw/<ipaddr>/<port> ...
224 $ sigrok-cli --driver <somedriver>:conn=vxi/<ipaddr> ...
88c03eae 225 $ sigrok-cli --driver <somedriver>:conn=usbtmc/<bus>.<addr> ...
ca25a3ee 226
e24ecabf
GS
227Individual device drivers _may_ implement additional semantics for the
228conn= specification, which would not apply to other drivers, yet can be
229rather useful for a given type of device.
230
231 $ sigrok-cli --driver <somedriver>:conn=sn=<serno>
232
c77ed446 233
f3f19d11
UH
234Specifying serial port parameters
235---------------------------------
48d3238e
MH
236
237Every serial device's driver has default serial port parameters like baud
238rate, number of data bits, stop bits and handshake status. If a device requires
239different parameters, pass them as option "serialcomm" with the driver name.
e311f770 240See libsigrok docs for the function serial_set_paramstr() for complete specs.
48d3238e
MH
241
242Example:
243
244 $ sigrok-cli --driver <somedriver>:conn=<someconn>:serialcomm=9600/7n1/dtr=1
245
246
c77ed446
UH
247Permissions of serial port based devices
248----------------------------------------
249
250When using devices supported by libsigrok that use serial port based cables
251(real RS232 or USB-to-serial ones) to connect to a PC, you need to ensure
252that the user running the libsigrok frontend has (read/write) permissions to
253access the serial port device (e.g. /dev/ttyS0, /dev/ttyUSB0, and so on).
254
255You can use 'chmod' to apply permissions as you see fit, and/or 'chown' to
256change the owner of the serial port device to a certain user or group.
257
258For USB-to-serial based devices, we recommended using our udev rules file
259(see below for details).
260
261
75696630
SB
262Permissions for USB devices (udev rules files)
263----------------------------------------------
c77ed446
UH
264
265When using USB-based devices supported by libsigrok, the user running the
266libsigrok frontend (e.g. sigrok-cli) has to have (read/write) permissions
267for the respective USB device.
268
75696630
SB
269On Linux, this is accomplished using udev rules. libsigrok ships a rules
270file containing all supported devices which can be detected reliably
271(generic USB-to-serial converters are omitted, as these are used for a wide
272range of devices, e.g. GPS receivers, which are not handled by libsigrok).
c77ed446 273
75696630
SB
274The file is available in contrib/60-libsigrok.rules. This file just contains
275the list of devices and flags these devices with ID_SIGROK="1". Access is
276granted by the 61-libsigrok-plugdev.rules or 61-libsigrok-uaccess.rules files,
277allowing access to members of the plugdev group or to currently logged in
278users, respectively.
c77ed446
UH
279
280When using a libsigrok package from your favorite Linux distribution, the
75696630
SB
281files should already be installed in /usr/lib/udev/rules.d/, i.e.
28260-libsigrok.rules and one of the access granting rules files. Use of
28361-libsigrok-uaccess.rules is encouraged on systemd distributions.
284
285The access policy can be locally overridden by placing appropriate rules in
286/etc/udev/rules.d/, disabling or ammending the default policy. See the
287udev documentation, e.g. man 7 udev, for details.
c77ed446
UH
288
289If you're building from source, you need to copy the file to the place
75696630
SB
290where udev will read these rules. Local rules should go to /etc/udev/rules.d.
291Keep the file naming, otherwise interaction between the libsigrok rules and
292rules shipped by the system will be broken.
c77ed446 293
75696630 294Please consult the udev docs for details.
c77ed446
UH
295
296
54b217b2
GS
297Assigning drivers to devices (Windows, Zadig)
298---------------------------------------------
299
300On Windows systems it may be necessary to assign drivers to devices
301before libusb based applications can access them. It may be necessary
302to re-run this driver assignment after firmware upload in case the
303device changes its USB identification as a consequence of loading the
304firmware image.
305
306The https://sigrok.org/wiki/Windows wiki page discusses this subject,
307and other platform specific aspects.
308
309
24a95338
GS
310Non-default drivers for commodity chips
311---------------------------------------
312
313Some vendors include common USB chips in their products yet assign device
314specific VID:PID pairs. Which results in the necessity for extra steps
315before the serial port can be used:
316
317- GW Instek VCP, found in GDM-8000 and probably other meters: Install the
318 vendors Windows driver to get access to a COM port. Or force the driver
319 assignment on Linux:
320 # modprobe cp210x
321 # echo 2184 0030 > /sys/bus/usb-serial/drivers/cp210x/new_id
322
323
c77ed446
UH
324Cypress FX2 based devices
325-------------------------
326
327Devices using the Cypress FX2(LP) chip without any specific USB VID/PID will
328be enumerated with VID/PID 04b4:8613 (the default for "unconfigured FX2").
329These are usually "FX2 eval boards" (that can also be used as LAs, though).
330
331On Linux, the 'usbtest' driver will usually grab such devices, and they will
332thus not be usable by libsigrok (and frontends).
333
334You can fix this by running 'rmmod usbtest' as root before using the device.
335
336
337UNI-T DMM (and rebranded models) cables
338---------------------------------------
339
340UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can
341ship with different PC connectivity cables:
342
de805ae5 343 - UT-D02 (RS232 cable)
c77ed446
UH
344 - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490)
345 - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008)
07e42cb2 346 - UT-D07 (Bluetooth adapter, ISSC BL79 BLETR chip)
f736691d 347 - UT-D09 (USB/HID cable with SiL CP2110 chip, USB VID/PID 10c4:ea80)
c77ed446
UH
348
349The above cables are all physically compatible (same IR connector shape)
350with all/most currently known UNI-T multimeters. For example, you can
351use either of the UT-D04 USB/HID cables or the UT-D02 RS232 cable with
352the UNI-T UT61D multimeter.
353
354When using the UT-D02 RS232 cable with any of the supported UNI-T DMMs,
355you have to use the respective driver with a '-ser' drivername suffix
356(internally all of these models are handled by the 'serial-dmm' driver).
357
358You also need to specify the serial port via the 'conn' option, e.g.
359/dev/ttyUSB0 (attached via a USB-to-serial cable) or /dev/ttyS0 (actual
360RS232 port) on Linux (see above).
361
362Finally, the user running the frontend (e.g. sigrok-cli) also needs
363permissions to access the respective serial port (see above).
364
365Examples (sigrok-cli):
366
367 $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ...
368 $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ...
0097afa4
GS
369 $ sigrok-cli --driver uni-t-ut61e-ser:conn=hid/cp2110
370
371Using any of the UT-D04 et al USB/HID cables can be done in two different
372ways: Use transparent serial over HID support in libsigrok, by giving the
373-ser driver a conn=hid/... serial port spec. This re-uses the 'serial-dmm'
374driver, results in better coverage of these code paths, and reduces
375maintenance overhead. Or by running non-ser drivers and passing USB
376specific connection details. When the driver _without_ the '-ser' suffix
377is used, the models are handled by the 'uni-t-dmm' driver. These duplicate
378drivers only exist for historical reasons, the redundancy may result in
379differences of behaviour between the two implementations. When in doubt,
380check if the '-ser' driver works for you.
381
382In the USB specific driver case you need to specify the cable's vendor
383and product IDs. Autodetection is not possible here, since various other
384products use the USB VID/PID of those cables too, and there is no way to
385distinguish them. The sigrok software errs on the safe side, and won't
386communicate to serial ports unless explicitly instructed by the user.
387
388The user running the frontend does also need to have permissions to
389access the respective USB device (see above).
c77ed446
UH
390
391Examples (sigrok-cli):
392
9b2f03bb
UH
393 $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ...
394 $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ...
c77ed446
UH
395
396
397UNI-T UT-D04 cable issue on Linux
398---------------------------------
399
400The UNI-T UT-D04 cable with Hoitek HE2325U (or WCH CH9325) chip seems to have
8d3764aa 401a very specific problem on Linux. Apparently it requires to be put into
c77ed446
UH
402suspend (and woken up again) before it is usable. This seems to be a
403Linux-only issue, Windows is not affected by this since apparently the
404Windows kernel does this for every USB device, always.
405
406Thus, if you want to use any of the UNI-T DMMs with this specific cable,
407you'll have to run the following script (as root) once, every time you attach
408the cable via USB. The script was written by Ralf Burger.
409
410See also: http://erste.de/UT61/index.html
411
412 #!/bin/bash
413 for dat in /sys/bus/usb/devices/*; do
414 if test -e $dat/manufacturer; then
415 grep "WCH.CN" $dat/manufacturer > /dev/null && echo auto > ${dat}/power/level && echo 0 > ${dat}/power/autosuspend
416 fi
417 done
418
419
c1f32601
GS
420UNI-T UT-D04 cable issue on Windows
421-----------------------------------
422
423There have been reports that CH9325 based cables are not detected on
424Windows out of the box when they are assigned to libwdi drivers. Though
425they may be usable in that case when the USB address is manually specified.
426This can happen when some "USB to serial" driver is assigned which does not
427provide a genuine COM port that enumerates naturally. Manually assigning a
428"USB input device" driver can improve HIDAPI compatibility and make the
429cable show up in sigrok's serial port enumeration.
430
431
e6b2b4df
UH
432Enabling multimeter / data logger measurement output
433----------------------------------------------------
434
435Some multimeters or data loggers will not start outputting measurement data
436unless a certain action has been performed by the user beforehand. This is
437usually mentioned in the vendor manual of the respective device, but here's
438a short list for convenience:
439
1267f128
UH
440 - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the
441 interface panel on top.
de805ae5 442 - Brymen BM257s: Press HOLD during power-on.
e6b2b4df 443 - Digitek DT4000ZC: Briefly press the "RS232" button.
de805ae5 444 - EEVBlog 121GW: Hold "1ms PEAK" until the "BT" indicator is shown.
f9c3df65
GS
445 - ES51919 based LCR meters (DER EE DE-5000, PeakTech 2170, UNI-T UT612):
446 Press the button with the "RS232" or "USB" or "PC link" label (usually
447 the "up" cursor button).
c90beca7 448 - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232:
fadd0707
MH
449 - Power on the device with the "DATA" button pressed.
450 - Metrahit 2x devices must be configured for the respective interface type.
c90beca7 451 - Gossen Metrawatt Metrahit 2x devices, driver gmc-mh-2x-bd232:
fadd0707
MH
452 - 'BD232' interface:
453 The multimeter must be configured for the respective interface type.
454 - 'SI232-II' interface ("PC Mode"):
455 The multimeter must be configured for interface type 'BD232' (all),
456 'SI232 online' (28-29S) or 'SI232 store' (22-26x). The interface must
457 be configured to the same baud rate as the host (default 9600).
458 Multimeter and interface must be configured to the same address.
66665b09 459 - GW Instek GDM-397: Press the "REL/RS232C (USB)" button for roughly 1 second.
24a95338
GS
460 - GW Instek VCP: See the discussion on manual driver assignment to common
461 USB to UART chips with non-default USB identification.
aca2b460 462 - MASTECH MS6514: Press the "Setup/PC-Link" button for roughly 3 seconds.
ba1fb5e9 463 - Meterman 38XR: Press the "RS232" button.
309bb27e
GS
464 - Metrix MX56C: Press the PRINT button to have the meter send acquisition
465 data via IR. Hold the PRINT button to adjust the meter's transmission
466 interval.
1267f128
UH
467 - Norma DM950: If the interface doesn't work (e.g. USB-RS232 converter), power
468 on the device with "FUNC" pressed (to power the interface from the DMM).
e6b2b4df
UH
469 - PCE PCE-DM32: Briefly press the "RS232" button.
470 - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together.
471 - TekPower TP4000ZC: Briefly press the "RS232" button.
d9e79c51 472 - Tenma 72-7750: Briefly press the "RS232C" button.
4104ef81 473 - UNI-T UT60G: Briefly press the "RS232C" button.
7cb69b18 474 - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second.
8769478c
UH
475 - UNI-T UT71x: Press the "SEND/-/MAXMIN" button for roughly 1 second.
476 Briefly pressing the "EXIT" button leaves this mode again.
ebc51109 477 - UNI-T UT181A: In the "SETUP" menu set "Communication" to "ON".
1b142b78
UH
478 - UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it
479 appears that in practice you don't have to press the button (at least on
480 some versions of the device), simply connect the device via USB.
1267f128
UH
481 - V&A VA18B/VA40B: Keep the "Hz/DUTY" key pressed while powering on the DMM.
482 - Victor 70C/86C: Press the "REL/RS232" button for roughly 1 second.
45bb47a7 483 - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds.
c36f78f7 484 - Voltcraft VC-870: Press the "REL/PC" button for roughly 1 second.
e6b2b4df
UH
485
486
734bab71
GS
487ASIX OMEGA in RTM CLI mode
488--------------------------
489
490The asix-sigma driver can detect the Omega devices' presence, but does
491not support their protocol and emits a diagnostics message. The firmware
492image is not available for distribution, and information on the protocol
493is not available. That's why native support is in some distant future.
494Yet basic operation of Omega devices is available by using the vendor's
495command line application for real time mode (RTM CLI).
496
497The vendor application targets Windows (on x86), but also executes on
498Linux when 32bit libraries for FTDI communication are provided. The
499user manual discusses the installation. The sigrok asix-omega-rtm-cli
500driver uses the vendor provided omegartmcli.exe binary to configure the
501device for streaming, and to acquire sample data.
502
503Either make an "omegartmcli" executable available in PATH. This can be
504the vendor's executable or some wrapper around it or a symlink to it.
505Or specify the executable's location in the OMEGARTMCLI environment
506variable. The sigrok driver accepts an optional serial number (six or
507eight hex digits) to select one out of several connected devices.
508
509 (optional)
510 $ export "OMEGARTMCLI=$HOME/.wine/drive_c/progx86/ASIX/SIGMA/omegartmcli.exe"
511
512 (optional)
513 $ OMEGASN=":conn=sn=a6030123"
514
515 (example use)
516 $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} --show
517 $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --time 10s
518 $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --samples 100m
519 $ pulseview -d asix-omega-rtm-cli${OMEGASN}
520
521The RTM mode of operation samples 16 channels at a fixed rate of 200MHz.
522Hardware triggers are not available in this mode. Glib should handle
523platform specific details of external process execution, but the driver
524was only tested on Linux so far. Acquisition start in sigrok applications
525may take some time before sample data becomes available (roughly one
526second here on a slow machine). This is an implementation detail of the
527RTM CLI approach including execution under wine.
528
529The reliability of that setup in the presence of fast changing input
530signals is yet to get determined. It's assumed that slow input signals
531are operational. It's essential that the _average_ rate of changes in
532the input signal in combination with the hardware compression are such
533that the FTDI FIFO can communicate all involved data via USB2.0 to the
534application. Intermediate bursts of rapid changes shall not be an issue
535given the Omega devices' deep memory which RTM uses for buffering.
536
537Native support for the Asix Omega devices depends on the availability of
538a protocol description and use of the protocol depends on the firmware's
539availability at the user's site. Which then would allow to capture to
540DRAM at high rates without the communication bottleneck, before the data
541gets communicated to the PC after the acquisition has completed. Compare
c5dd6c4f 542the native sigrok support for Asix Sigma.
734bab71
GS
543
544
7b356712
UH
545ChronoVu LA8/LA16 USB VID/PIDs
546------------------------------
c77ed446 547
7b356712
UH
548The ChronoVu LA8/LA16 logic analyzer is available in two revisions. Previously,
549the device shipped with a USB VID/PID of 0403:6001, which is the standard ID
c77ed446
UH
550for FTDI FT232 USB chips.
551
7b356712 552Since this made it hard to distinguish the LA8/LA16 from any other device
c77ed446 553with this FTDI chip connected to the PC, the vendor later shipped the
7b356712 554device with a USB VID/PID of 0403:8867.
c77ed446 555
7b356712
UH
556The 'chronovu-la' driver in libsigrok supports both VID/PID pairs and
557automatically finds devices with either VID/PID pair.
c77ed446
UH
558
559
560OLS
561---
562
e311f770
UH
563The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer
564driver in libsigrok assumes a somewhat recent firmware has been flashed onto
565the OLS (it doesn't need a firmware upload every time it's attached via USB,
566since the firmware is stored in the device permanently).
c77ed446
UH
567
568The most recent firmware version that is tested is 3.07.
569
570If you use any older firmware and your OLS is not found or is not working
571properly, please upgrade to at least this firmware version. Check the
572Dangerous Prototypes wiki for firmware upgrade instructions:
573
574 http://dangerousprototypes.com/docs/Logic_Sniffer_upgrade_procedure
575
576Also, you need to specify a serial port for the OLS in the frontends, e.g.
577using the 'conn' option in sigrok-cli, and you also need to have the
578permissions to access the serial port (see above).
579
580Example:
581
582 $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
583
ebcd1aba 584
1f8ef363
GS
585JTAGulator
586----------
587
588The Grand Idea Studio JTAGulator also implements the SUMP protocol and
589thus is covered by the OLS driver. See the vendor's wiki on details how
590to enable the Logic Analyzer mode of operation.
591
592 https://github.com/grandideastudio/jtagulator/wiki/Logic-Analyzer
593
594
ebcd1aba
DH
595Mooshimeter
596-----------
597
598The Mooshim Engineering Mooshimeter is controlled via Bluetooth Low Energy
599(sometimes called Bluetooth 4.0), as such it requires a supported Bluetooth
600interface available. The 'conn' option is required and must contain the
601Bluetooth MAC address of the meter.
602
603Example:
604
605 $ sigrok-cli --driver mooshimeter-dmm:conn=12-34-56-78-9A-BC ...
606
607Since the Mooshimeter has no physical interface on the meter itself, the
608channel configuration is set with the 'channel_config' option. The format
609of this option is 'CH1,CH2' where each channel configuration has the form
610'MODE:RANGE:ANALYSIS', with later parts being optional. In addition for
611CLI compatibility, the ',' in the channels can also be a '/' and the ':' in
612the individual configuration can be a ';'.
613
614Available channel 1 modes:
615
616 - Current, A: Current in amps
617 - Temperature, T, K: Internal meter temperature in Kelvin
618 - Resistance, Ohm, W: Resistance in ohms
619 - Diode, D: Diode voltage
620 - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
621
622Available channel 2 modes:
623
624 - Voltage, V: Voltage
625 - Temperature, T, K: Internal meter temperature in Kelvin
626 - Resistance, Ohm, W: Resistance in ohms
627 - Diode, D: Diode voltage
628 - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
629
630Only one channel can use the shared inputs at a time (e.g. if CH1 is measuring
631resistance, CH2 cannot measure low voltage). Temperature is excepted from
632this, so the meter can measure internal temperature and low voltage at the
633same time.
634
635Additionally, the meter can calculate the real power of both channels. This
636generally only makes sense when CH1 is set to current and CH2 is set to a
637voltage and so it is disabled by default. It must be enabled by enabling the
638'P' channel (the third channel).
639
640The range of the channel specification sets the maximum input for that channel
641and is rounded up to the next value the meter itself supports. For example,
642specifying 50 for the voltage will result in the actual maximum of 60.
643Specifying 61 would result in 600. If omitted, sigrok will perform
644auto-ranging of the channel by selecting the next greater value than the
645latest maximum.
646
647The analysis option sets how the meter reports its internal sampling buffer
648to sigrok:
649
650 - Mean, DC: The default is a simple arithmetic mean of the sample buffer
651 - RMS, AC: The root mean square of the sample buffer
652 - Buf, Buffer, Samples: Report the entire sample buffer to sigrok. This
653 results in packets that contain all the samples in the buffer instead
654 of a single output value.
655
656The size of the sample buffer is set with the 'avg_samples' option, while
657the sampling rate is set with the 'samplerate' option. So the update rate
658is avg_samples/samplerate. Both are rounded up to the next supported value
659by the meter.
660
661Example:
662
663 $ sigrok-cli -c channel_config="Aux;0.1/T" --driver mooshimeter-dmm...
664 $ sigrok-cli -c channel_config="A;;AC/V;;AC" --driver mooshimeter-dmm...