'sigrok-firmware' repository/project under a license which allows us
to redistribute them.
+ - dreamsourcelab-dslogic: The DreamSourceLab DSLogic/DSCope device series
+ requires various firmware files and FPGA bitstream files.
+ These can be extracted/downloaded from the vendor's GitHub repo using a
+ tool from our 'sigrok-util' repository/project.
+
- fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the
firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
The firmware is written from scratch and licensed under the GNU GPLv2+.
These can be extracted from the vendor's Linux application using a tool
from our 'sigrok-util' repository/project.
+ - saleae-logic-pro: The Saleae Logic Pro 16 needs a firmware file for the
+ Cypress FX3 chip in the device, as well as an FPGA bitstream file.
+ These can be extracted from the vendor's Linux application using a tool
+ from our 'sigrok-util' repository/project.
+
- sysclk-lwla:
- The Sysclk LWLA1034 requires various bitstream files.
These can be extracted from the vendor's Windows drivers using a tool
from our 'sigrok-util' repository/project.
+ - sysclk-sla5032: The Sysclk SLA5032 needs an FPGA bitstream file.
+ This file can be copied (and renamed) from the Windows vendor software
+ installation directory. Details:
+
+ https://sigrok.org/wiki/Sysclk_SLA5032#Firmware
+
The following drivers/devices do not need any firmware upload:
- agilent-dmm
- atten-pps3xxx
- baylibre-acme
- beaglelogic
- - brymen-bm86x
- - brymen-dmm
- cem-dt-885x
- center-3xx (including all subdrivers)
- chronovu-la
- colead-slm
- conrad-digi-35-cpu
- demo
+ - fluke-45
- fluke-dmm
- ftdi-la
- gmc-mh-1x-2x (including all subdrivers)
- gwinstek-gds-800
+ - gwinstek-gpd
- hameg-hmo
+ - hantek-4032l
- hp-3457a
+ - hp-3478a
- hung-chang-dso-2100
- ikalogic-scanalogic2
- ikalogic-scanaplus
+ - ipdbg-la
- kecheng-kc-330b
- kern-scale
+ - korad-kaxxxxp
- lascar-el-usb
+ - lecroy-xstream
- link-mso19
- manson-hcs-3xxx
- maynuo-m97
- mic-985xx (including all subdrivers)
+ - microchip-pickit2
+ - mooshimeter-dmm
- motech-lps-30x
- norma-dmm
- openbench-logic-sniffer
- pce-322a
- pipistrello-ols
+ - rdtech-dps
+ - rigol-dg
- rigol-ds
+ - rohde-schwarz-sme-0x
+ - scpi-dmm
- scpi-pps
- serial-dmm (including all subdrivers)
- serial-lcr (including all subdrivers)
- tondaj-sl-814
- uni-t-dmm (including all subdrivers)
- uni-t-ut32x
- - victor-dmm
- yokogawa-dlm
- zeroplus-logic-cube
+ - zketech-ebd-usb
Specifying serial ports
conn=hid[/<chip>]/usb=<bus>.<dev>[.<if>]
conn=hid[/<chip>]/raw=<path>
conn=hid[/<chip>]/sn=<serno>
- chip can be: ch9325, cp2110
+ conn=hid[/<chip>]/iokit=<path>
+ chip can be: bu86x, ch9325, cp2110, victor
path may contain slashes
path and serno are "greedy" (span to the end of the spec)
- Bluetooth Classic and Bluetooth Low Energy (BLE):
<name>:conn=<spec>" example, that is why the dense form and the use
of dashes for separation are supported)
-The following drivers/devices require a serial port specification. Some of
-the drivers implement a default for the connection. Some of the drivers
-can auto-detect USB connected devices.
-
- - agilent-dmm
- - appa-55ii
- - atten-pps3xxx
- - brymen-dmm
- - cem-dt-885x
- - center-3xx (including all subdrivers)
- - colead-slm
- - conrad-digi-35-cpu
- - fluke-dmm
- - gmc-mh-1x-2x (including all subdrivers)
- - hameg-hmo
- - link-mso19
- - mic-985xx (including all subdrivers)
- - norma-dmm
- - openbench-logic-sniffer
- - rigol-ds (for RS232; not required for USBTMC or TCP)
- - serial-dmm (including all subdrivers)
- - serial-lcr (including all subdrivers)
- - teleinfo
- - tondaj-sl-814
- - uni-t-dmm (all -ser subdrivers)
- - uni-t-ut32x
-
-The following drivers/devices do not require a serial port specification:
-
- - asix-sigma
- - brymen-bm86x
- - chronovu-la
- - demo
- - fx2lafw
- - hantek-dso
- - ikalogic-scanalogic2
- - ikalogic-scanaplus
- - kecheng-kc-330b
- - lascar-el-usb
- - pipistrello-ols
- - rigol-ds (USBTMC or TCP)
- - saleae-logic16
- - sysclk-lwla
- - uni-t-dmm (all non -ser subdrivers)
- - yokogawa-dlm (USBTMC or TCP)
- - zeroplus-logic-cube
+Some of the drivers implement a default for the connection. Some of the
+drivers can auto-detect USB connected devices.
Beyond strict serial communication over COM ports (discussed above), the
conn= property can also address specific USB devices, as well as specify TCP
$ sigrok-cli --driver <somedriver>:conn=vxi/<ipaddr> ...
$ sigrok-cli --driver <somedriver>:conn=usbtmc/<bus>.<addr> ...
-The following drivers/devices accept network communication parameters:
+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.
- - hameg-hmo
- - rigol-ds
- - scpi-dmm
- - siglent-sds
- - yokogawa-dlm
+ $ sigrok-cli --driver <somedriver>:conn=sn=<serno>
Specifying serial port parameters
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
-------------------------
'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.
- UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second.
- UNI-T UT71x: Press the "SEND/-/MAXMIN" button for roughly 1 second.
Briefly pressing the "EXIT" button leaves this mode again.
+ - UNI-T UT181A: In the "SETUP" menu set "Communication" to "ON".
- UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it
appears that in practice you don't have to press the button (at least on
some versions of the device), simply connect the device via USB.
$ 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
+-----------
+
+The Mooshim Engineering Mooshimeter is controlled via Bluetooth Low Energy
+(sometimes called Bluetooth 4.0), as such it requires a supported Bluetooth
+interface available. The 'conn' option is required and must contain the
+Bluetooth MAC address of the meter.
+
+Example:
+
+ $ sigrok-cli --driver mooshimeter-dmm:conn=12-34-56-78-9A-BC ...
+
+Since the Mooshimeter has no physical interface on the meter itself, the
+channel configuration is set with the 'channel_config' option. The format
+of this option is 'CH1,CH2' where each channel configuration has the form
+'MODE:RANGE:ANALYSIS', with later parts being optional. In addition for
+CLI compatibility, the ',' in the channels can also be a '/' and the ':' in
+the individual configuration can be a ';'.
+
+Available channel 1 modes:
+
+ - Current, A: Current in amps
+ - Temperature, T, K: Internal meter temperature in Kelvin
+ - Resistance, Ohm, W: Resistance in ohms
+ - Diode, D: Diode voltage
+ - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
+
+Available channel 2 modes:
+
+ - Voltage, V: Voltage
+ - Temperature, T, K: Internal meter temperature in Kelvin
+ - Resistance, Ohm, W: Resistance in ohms
+ - Diode, D: Diode voltage
+ - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
+
+Only one channel can use the shared inputs at a time (e.g. if CH1 is measuring
+resistance, CH2 cannot measure low voltage). Temperature is excepted from
+this, so the meter can measure internal temperature and low voltage at the
+same time.
+
+Additionally, the meter can calculate the real power of both channels. This
+generally only makes sense when CH1 is set to current and CH2 is set to a
+voltage and so it is disabled by default. It must be enabled by enabling the
+'P' channel (the third channel).
+
+The range of the channel specification sets the maximum input for that channel
+and is rounded up to the next value the meter itself supports. For example,
+specifying 50 for the voltage will result in the actual maximum of 60.
+Specifying 61 would result in 600. If omitted, sigrok will perform
+auto-ranging of the channel by selecting the next greater value than the
+latest maximum.
+
+The analysis option sets how the meter reports its internal sampling buffer
+to sigrok:
+
+ - Mean, DC: The default is a simple arithmetic mean of the sample buffer
+ - RMS, AC: The root mean square of the sample buffer
+ - Buf, Buffer, Samples: Report the entire sample buffer to sigrok. This
+ results in packets that contain all the samples in the buffer instead
+ of a single output value.
+
+The size of the sample buffer is set with the 'avg_samples' option, while
+the sampling rate is set with the 'samplerate' option. So the update rate
+is avg_samples/samplerate. Both are rounded up to the next supported value
+by the meter.
+
+Example:
+
+ $ sigrok-cli -c channel_config="Aux;0.1/T" --driver mooshimeter-dmm...
+ $ sigrok-cli -c channel_config="A;;AC/V;;AC" --driver mooshimeter-dmm...
projects / libsigrok.git / blobdiff