X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README.devices;h=e7fe04297a8ed083ded9fd1d10d8f02094881a4b;hb=3a247d03595b910deba841ec8e7c312c156ae07c;hp=795ebc135eea3b634bb31b7f57c30a88f7438360;hpb=88c03eae8598f4faf2bdee5cc5b06bef409766dd;p=libsigrok.git

diff --git a/README.devices b/README.devices
index 795ebc13..e7fe0429 100644
--- a/README.devices
+++ b/README.devices
@@ -130,7 +130,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
@@ -139,9 +146,34 @@ for such devices without specifying a serial port.
 Example:
 
  $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ...
+ $ sigrok-cli --driver <somedriver>:conn=hid/cp2110 ...
+ $ sigrok-cli --driver <somedriver>:conn=bt/rfcomm/01-23-45-67-89-ab ...
+
+Formal syntax for serial communication:
+
+ - COM ports (RS232, USB CDC):
+   conn=<com-port>
+ - USB HID cables:
+   conn=hid[/<chip>]
+   conn=hid[/<chip>]/usb=<bus>.<dev>[.<if>]
+   conn=hid[/<chip>]/raw=<path>
+   conn=hid[/<chip>]/sn=<serno>
+   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>/<addr>
+   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
+     <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.
+the drivers implement a default for the connection. Some of the drivers
+can auto-detect USB connected devices.
 
  - agilent-dmm
  - appa-55ii
@@ -163,6 +195,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:
 
@@ -180,13 +214,11 @@ 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:
 
@@ -199,6 +231,7 @@ The following drivers/devices accept network communication parameters:
 
  - hameg-hmo
  - rigol-ds
+ - scpi-dmm
  - siglent-sds
  - yokogawa-dlm
 
@@ -285,9 +318,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
@@ -362,7 +397,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.