X-Git-Url: http://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=README.devices;h=584899e2b0648ed65aae7c39cbbdf083a46db24f;hp=6d139aa9af0b88b31f7e8f028ed6a12f054abe84;hb=HEAD;hpb=734bab7113b9632933018d03bed0c00faf607840 diff --git a/README.devices b/README.devices index 6d139aa9..7563a57c 100644 --- a/README.devices +++ b/README.devices @@ -63,6 +63,10 @@ The following drivers/devices require a firmware upload upon connection: These can be extracted from the vendor's Windows drivers using a tool from our 'sigrok-util' repository/project. + - kingst-la2016: The Kingst LA series of logic analyzers needs MCU firmware + and FPGA netlists. The 'sigrok-util' repository contains a script to + extract these files from the vendor software. + - lecroy-logicstudio: The LeCroy LogicStudio requires FPGA bitstream files. These can be extracted from the vendor's Windows software using a tool from our 'sigrok-util' repository/project. @@ -197,7 +201,7 @@ Formal syntax for serial communication: path may contain slashes path and serno are "greedy" (span to the end of the spec) - Bluetooth Classic and Bluetooth Low Energy (BLE): - conn=bt// + conn=bt//[/param=value] conn can be: rfcomm, ble122, nrf51, cc254x addr can be "dense" or separated, bt/cc254x/0123456789ab or bt/rfcomm/11-22-33-44-55-66 or bt/ble122/88:6b:12:34:56:78 @@ -205,6 +209,8 @@ Formal syntax for serial communication: from a string that separates fields by colon, e.g. in the "--driver :conn=" example, that is why the dense form and the use of dashes for separation are supported) + additional parameter keywords can be: channel, handle_rx, handle_tx, + handle_cccd, value_cccd, mtu Some of the drivers implement a default for the connection. Some of the drivers can auto-detect USB connected devices. @@ -288,6 +294,19 @@ rules shipped by the system will be broken. Please consult the udev docs for details. +Assigning drivers to devices (Windows, Zadig) +--------------------------------------------- + +On Windows systems it may be necessary to assign drivers to devices +before libusb based applications can access them. It may be necessary +to re-run this driver assignment after firmware upload in case the +device changes its USB identification as a consequence of loading the +firmware image. + +The https://sigrok.org/wiki/Windows wiki page discusses this subject, +and other platform specific aspects. + + Non-default drivers for commodity chips --------------------------------------- @@ -347,19 +366,27 @@ Examples (sigrok-cli): $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ... $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ... - -When using any of the UT-D04 USB/HID cables you have to use the respective -driver _without_ the '-ser' drivername suffix (internally all of these models -are handled by the 'uni-t-dmm' driver). - -You also need to specify the USB vendor/device IDs of the cable. -Autodetection is not possible here, since various other products use the -USB VID/PID of those cables too, and there is no way to distinguish them. - -Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip) -there is no need to specify a serial port via 'conn', of course. -However, the user running the frontend does also need to have permissions -to access the respective USB device (see above). + $ sigrok-cli --driver uni-t-ut61e-ser:conn=hid/cp2110 + +Using any of the UT-D04 et al USB/HID cables can be done in two different +ways: Use transparent serial over HID support in libsigrok, by giving the +-ser driver a conn=hid/... serial port spec. This re-uses the 'serial-dmm' +driver, results in better coverage of these code paths, and reduces +maintenance overhead. Or by running non-ser drivers and passing USB +specific connection details. When the driver _without_ the '-ser' suffix +is used, the models are handled by the 'uni-t-dmm' driver. These duplicate +drivers only exist for historical reasons, the redundancy may result in +differences of behaviour between the two implementations. When in doubt, +check if the '-ser' driver works for you. + +In the USB specific driver case you need to specify the cable's vendor +and product IDs. Autodetection is not possible here, since various other +products use the USB VID/PID of those cables too, and there is no way to +distinguish them. The sigrok software errs on the safe side, and won't +communicate to serial ports unless explicitly instructed by the user. + +The user running the frontend does also need to have permissions to +access the respective USB device (see above). Examples (sigrok-cli): @@ -390,6 +417,18 @@ See also: http://erste.de/UT61/index.html done +UNI-T UT-D04 cable issue on Windows +----------------------------------- + +There have been reports that CH9325 based cables are not detected on +Windows out of the box when they are assigned to libwdi drivers. Though +they may be usable in that case when the USB address is manually specified. +This can happen when some "USB to serial" driver is assigned which does not +provide a genuine COM port that enumerates naturally. Manually assigning a +"USB input device" driver can improve HIDAPI compatibility and make the +cable show up in sigrok's serial port enumeration. + + Enabling multimeter / data logger measurement output ---------------------------------------------------- @@ -500,7 +539,7 @@ a protocol description and use of the protocol depends on the firmware's availability at the user's site. Which then would allow to capture to DRAM at high rates without the communication bottleneck, before the data gets communicated to the PC after the acquisition has completed. Compare -the native sigrok supoprt for Asix Sigma. +the native sigrok support for Asix Sigma. ChronoVu LA8/LA16 USB VID/PIDs