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