X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README.devices;h=a7e50a395302d9b5a6e9d351a138ea54dc5b8e0b;hb=24931412eeee31e5c0bb5291a9c73e7b57309216;hp=f5c8e976d148233bcde49cffd0d5755579cbed90;hpb=ca25a3ee0b8d3c92166ce928ae51bcb683eea887;p=libsigrok.git diff --git a/README.devices b/README.devices index f5c8e976..a7e50a39 100644 --- a/README.devices +++ b/README.devices @@ -107,6 +107,7 @@ The following drivers/devices do not need any firmware upload: - maynuo-m97 - mic-985xx (including all subdrivers) - motech-lps-30x + - mooshimeter-dmm - norma-dmm - openbench-logic-sniffer - pce-322a @@ -115,6 +116,7 @@ The following drivers/devices do not need any firmware upload: - scpi-pps - serial-dmm (including all subdrivers) - serial-lcr (including all subdrivers) + - siglent-sds - teleinfo - testo - tondaj-sl-814 @@ -129,7 +131,14 @@ Specifying serial ports ----------------------- Many devices supported by libsigrok use serial port based cables (real RS232 -or USB-to-serial ones) to connect to a PC. +or USB-to-serial ones, CDC class) to connect to a PC. These serial cables are +supported by the libserialport library. Some vendors prefer to use HID chips +instead of CDC chips in their serial cables. These cables can get supported +by means of the hidapi library. Note that each chip type requires specific +support in the libsigrok library. Bluetooth connected devices may be supported +as well when they communicate by means of RFCOMM channels, or one of the +implemented BLE notification/indication approaches, and one of the Bluetooth +supporting platforms is used. For all these devices, you need to specify the serial port they are connected to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan @@ -138,9 +147,34 @@ for such devices without specifying a serial port. Example: $ sigrok-cli --driver :conn=/dev/ttyUSB0 ... + $ sigrok-cli --driver :conn=hid/cp2110 ... + $ sigrok-cli --driver :conn=bt/rfcomm/01-23-45-67-89-ab ... + +Formal syntax for serial communication: + + - COM ports (RS232, USB CDC): + conn= + - USB HID cables: + conn=hid[/] + conn=hid[/]/usb=.[.] + conn=hid[/]/raw= + conn=hid[/]/sn= + chip can be: ch9325, cp2110 + 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 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 + (note that colons may not be available when the conn= spec is taken + 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) The following drivers/devices require a serial port specification. Some of -the drivers implement a default for the connection. +the drivers implement a default for the connection. Some of the drivers +can auto-detect USB connected devices. - agilent-dmm - appa-55ii @@ -162,6 +196,8 @@ the drivers implement a default for the connection. - 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: @@ -179,24 +215,25 @@ The following drivers/devices do not require a serial port specification: - rigol-ds (USBTMC or TCP) - saleae-logic16 - sysclk-lwla - - uni-t-dmm (including all subdrivers) - - uni-t-ut32x - - victor-dmm + - uni-t-dmm (all non -ser subdrivers) - yokogawa-dlm (USBTMC or TCP) - zeroplus-logic-cube -Beyond strict serial communication over COM ports (e.g. /dev/ttyUSB0), the +Beyond strict serial communication over COM ports (discussed above), the conn= property can also address specific USB devices, as well as specify TCP or VXI communication parameters. See these examples: $ sigrok-cli --driver :conn=. ... $ sigrok-cli --driver :conn=tcp-raw// ... $ sigrok-cli --driver :conn=vxi/ ... + $ sigrok-cli --driver :conn=usbtmc/. ... The following drivers/devices accept network communication parameters: - hameg-hmo - rigol-ds + - scpi-dmm + - siglent-sds - yokogawa-dlm @@ -282,9 +319,11 @@ UNI-T DMM (and rebranded models) cables UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can ship with different PC connectivity cables: + - UT-D02 (RS232 cable) - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490) - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008) - - UT-D02 (RS232 cable) + - UT-D07 (Bluetooth adapter, ISSC BL79 BLETR chip) + - UT-D09 (USB/HID cable with SiL CP2110 chip, USB VID/PID 10c4:ea80) The above cables are all physically compatible (same IR connector shape) with all/most currently known UNI-T multimeters. For example, you can @@ -359,7 +398,12 @@ a short list for convenience: - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the interface panel on top. + - Brymen BM257s: Press HOLD during power-on. - Digitek DT4000ZC: Briefly press the "RS232" button. + - EEVBlog 121GW: Hold "1ms PEAK" until the "BT" indicator is shown. + - ES51919 based LCR meters (DER EE DE-5000, PeakTech 2170, UNI-T UT612): + Press the button with the "RS232" or "USB" or "PC link" label (usually + the "up" cursor button). - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232: - Power on the device with the "DATA" button pressed. - Metrahit 2x devices must be configured for the respective interface type. @@ -432,3 +476,74 @@ Example: $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ... + +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...