X-Git-Url: https://sigrok.org/gitweb/?p=libsigrok.git;a=blobdiff_plain;f=README.devices;h=226ec06ba59691b2c37a3548987d963d79ae3080;hp=2b66cd0104b4661ba66f705bbeae2ca3e905f3a6;hb=deb7615262ac4f9cc0750a08351afa7cbf9c34d5;hpb=d7df9dc738b22dd4e5083fb818ad1dbaf186f13e diff --git a/README.devices b/README.devices index 2b66cd01..226ec06b 100644 --- a/README.devices +++ b/README.devices @@ -32,6 +32,13 @@ Per-driver firmware requirements The following drivers/devices require a firmware upload upon connection: + - asix-omega-rtm-cli: There is no native sigrok support for ASIX OMEGA + devices. But the vendor's RTM CLI application can be used in streaming + mode, which transparently handles the device detection and firmware + download. The firmware ships with the vendor application. See below + for details how to make the vendor application available to the sigrok + driver. + - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files, depending on the settings used. These files are available from our 'sigrok-firmware' repository/project under a license which allows us @@ -98,7 +105,6 @@ The following drivers/devices do not need any firmware upload: - atten-pps3xxx - baylibre-acme - beaglelogic - - brymen-dmm - cem-dt-885x - center-3xx (including all subdrivers) - chronovu-la @@ -136,6 +142,7 @@ The following drivers/devices do not need any firmware upload: - pce-322a - pipistrello-ols - rdtech-dps + - rigol-dg - rigol-ds - rohde-schwarz-sme-0x - scpi-dmm @@ -211,6 +218,12 @@ or VXI communication parameters. See these examples: $ sigrok-cli --driver :conn=vxi/ ... $ sigrok-cli --driver :conn=usbtmc/. ... +Individual device drivers _may_ implement additional semantics for the +conn= specification, which would not apply to other drivers, yet can be +rather useful for a given type of device. + + $ sigrok-cli --driver :conn=sn= + Specifying serial port parameters --------------------------------- @@ -275,6 +288,20 @@ rules shipped by the system will be broken. Please consult the udev docs for details. +Non-default drivers for commodity chips +--------------------------------------- + +Some vendors include common USB chips in their products yet assign device +specific VID:PID pairs. Which results in the necessity for extra steps +before the serial port can be used: + +- GW Instek VCP, found in GDM-8000 and probably other meters: Install the + vendors Windows driver to get access to a COM port. Or force the driver + assignment on Linux: + # modprobe cp210x + # echo 2184 0030 > /sys/bus/usb-serial/drivers/cp210x/new_id + + Cypress FX2 based devices ------------------------- @@ -390,7 +417,11 @@ a short list for convenience: 'SI232 online' (28-29S) or 'SI232 store' (22-26x). The interface must be configured to the same baud rate as the host (default 9600). Multimeter and interface must be configured to the same address. + - GW Instek GDM-397: Press the "REL/RS232C (USB)" button for roughly 1 second. + - GW Instek VCP: See the discussion on manual driver assignment to common + USB to UART chips with non-default USB identification. - MASTECH MS6514: Press the "Setup/PC-Link" button for roughly 3 seconds. + - Meterman 38XR: Press the "RS232" button. - Metrix MX56C: Press the PRINT button to have the meter send acquisition data via IR. Hold the PRINT button to adjust the meter's transmission interval. @@ -414,6 +445,64 @@ a short list for convenience: - Voltcraft VC-870: Press the "REL/PC" button for roughly 1 second. +ASIX OMEGA in RTM CLI mode +-------------------------- + +The asix-sigma driver can detect the Omega devices' presence, but does +not support their protocol and emits a diagnostics message. The firmware +image is not available for distribution, and information on the protocol +is not available. That's why native support is in some distant future. +Yet basic operation of Omega devices is available by using the vendor's +command line application for real time mode (RTM CLI). + +The vendor application targets Windows (on x86), but also executes on +Linux when 32bit libraries for FTDI communication are provided. The +user manual discusses the installation. The sigrok asix-omega-rtm-cli +driver uses the vendor provided omegartmcli.exe binary to configure the +device for streaming, and to acquire sample data. + +Either make an "omegartmcli" executable available in PATH. This can be +the vendor's executable or some wrapper around it or a symlink to it. +Or specify the executable's location in the OMEGARTMCLI environment +variable. The sigrok driver accepts an optional serial number (six or +eight hex digits) to select one out of several connected devices. + + (optional) + $ export "OMEGARTMCLI=$HOME/.wine/drive_c/progx86/ASIX/SIGMA/omegartmcli.exe" + + (optional) + $ OMEGASN=":conn=sn=a6030123" + + (example use) + $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} --show + $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --time 10s + $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --samples 100m + $ pulseview -d asix-omega-rtm-cli${OMEGASN} + +The RTM mode of operation samples 16 channels at a fixed rate of 200MHz. +Hardware triggers are not available in this mode. Glib should handle +platform specific details of external process execution, but the driver +was only tested on Linux so far. Acquisition start in sigrok applications +may take some time before sample data becomes available (roughly one +second here on a slow machine). This is an implementation detail of the +RTM CLI approach including execution under wine. + +The reliability of that setup in the presence of fast changing input +signals is yet to get determined. It's assumed that slow input signals +are operational. It's essential that the _average_ rate of changes in +the input signal in combination with the hardware compression are such +that the FTDI FIFO can communicate all involved data via USB2.0 to the +application. Intermediate bursts of rapid changes shall not be an issue +given the Omega devices' deep memory which RTM uses for buffering. + +Native support for the Asix Omega devices depends on the availability of +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 support for Asix Sigma. + + ChronoVu LA8/LA16 USB VID/PIDs ------------------------------ @@ -454,6 +543,16 @@ Example: $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ... +JTAGulator +---------- + +The Grand Idea Studio JTAGulator also implements the SUMP protocol and +thus is covered by the OLS driver. See the vendor's wiki on details how +to enable the Logic Analyzer mode of operation. + + https://github.com/grandideastudio/jtagulator/wiki/Logic-Analyzer + + Mooshimeter -----------