X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=README.devices;h=dac3f842794b2587dcda5dec97770184010296e3;hb=2fba14d05a9dd65fc873b59c438f62b87ab5e2d9;hp=dd84f242b2f8bf75ae0586f195ec2352ae174b47;hpb=07e42cb2cb865801ff294c3244ef906c58b2b11e;p=libsigrok.git

diff --git a/README.devices b/README.devices
index dd84f242..dac3f842 100644
--- a/README.devices
+++ b/README.devices
@@ -149,6 +149,28 @@ Example:
  $ 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. Some of the drivers
 can auto-detect USB connected devices.
@@ -173,6 +195,8 @@ can auto-detect USB connected devices.
  - 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:
 
@@ -190,13 +214,12 @@ 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
+ - uni-t-dmm (all non -ser subdrivers)
  - victor-dmm
  - 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:
 
@@ -378,6 +401,9 @@ a short list for convenience:
  - 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.