serial: Improved docs.

[libsigrok.git] / README.devices

diff --git a/README.devices b/README.devices
index f28462a02977a2dc2d5da968fd98d7ed0be67e8d..6dd42dde05c90dd17adf2e6facc751a3cda21786 100644 (file)
--- a/README.devices
+++ b/README.devices
@@ -51,6 +51,7 @@ The following drivers/devices do not need any firmware upload:
 
  - agilent-dmm
  - alsa
+ - bbcgm-m2110
  - brymen-dmm
  - cem-dt-885x
  - center-3xx
@@ -58,6 +59,7 @@ The following drivers/devices do not need any firmware upload:
  - colead-slm
  - demo
  - fluke-dmm
+ - gmc-mh-1x-2x-rs232
  - ikalogic-scanalogic2
  - ikalogic-scanaplus
  - kecheng-kc-330b
@@ -66,7 +68,7 @@ The following drivers/devices do not need any firmware upload:
  - mic-985xx
  - norma-dmm
  - openbench-logic-sniffer
- - rigol-ds1xx2
+ - rigol-ds
  - serial-dmm
  - teleinfo
  - tondaj-sl-814
@@ -93,11 +95,13 @@ Example:
 The following drivers/devices require a serial port specification:
 
  - agilent-dmm
+ - bbcgm-m2110
  - brymen-dmm
  - cem-dt-885x
  - center-3xx
  - colead-slm
  - fluke-dmm
+ - gmc-mh-1x-2x-rs232
  - link-mso19
  - mic-985xx
  - norma-dmm
@@ -118,7 +122,7 @@ The following drivers/devices do not require a serial port specification:
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb
- - rigol-ds1xx2
+ - rigol-ds
  - saleae-logic16
  - uni-t-dmm
  - uni-t-ut32x
@@ -126,6 +130,20 @@ The following drivers/devices do not require a serial port specification:
  - zeroplus-logic-cube
 
 
+Specifiying serial port parameters
+----------------------------------
+
+Every serial device's driver has default serial port parameters like baud
+rate, number of data bits, stop bits and handshake status. If a device requires
+different parameters, pass them as option "serialcomm" with the driver name.
+See libsigrok, docs for function serial_set_paramstr() for complete specs.
+
+Example:
+
+ $ sigrok-cli --driver <somedriver>:conn=<someconn>:serialcomm=9600/7n1/dtr=1
+
+
+
 Permissions of serial port based devices
 ----------------------------------------
 
@@ -264,11 +282,16 @@ unless a certain action has been performed by the user beforehand. This is
 usually mentioned in the vendor manual of the respective device, but here's
 a short list for convenience:
 
+ - bbcgm-m2110: Press button "Start/Reset" on interface panel on top.
  - Digitek DT4000ZC: Briefly press the "RS232" button.
+ - gmc-mh-1x-2x-rs232: Switch on device with buttons "DATA" pressed.
+   Additionally Metrahit 2x devices must be configured for interface "RS232".
+ - norma-dmm: If the interface does not work (e.g. USB-RS232 converter), switch
+   on device with "FUNC" button pressed to power interface from multimeter.
  - PCE PCE-DM32: Briefly press the "RS232" button.
  - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together.
  - TekPower TP4000ZC: Briefly press the "RS232" button.
- - UNI-T UT61D: Press the "REL/RS232/USB" button for roughly 1 second.
+ - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second.
  - 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.
@@ -344,12 +367,12 @@ Example:
  $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
 
 
-Rigol DS1xx2 oscilloscopes
---------------------------
+Rigol DS oscilloscopes
+----------------------
 
-The 'rigol-ds1xx2' driver (for the Rigol DS1052E and some other, similar DSOs)
-currently uses the Linux usbtmc kernel driver. This means it can currently
-only be built and used on Linux (i.e., it's non-portable).
+The 'rigol-ds' driver (for the Rigol DS series DSOs) currently uses the Linux
+usbtmc kernel driver. This means it can currently only be built and used on
+Linux (i.e., it's non-portable).
 
 The use of a kernel module also means it is dependent on the kernel version
 used, as well as on whether this specific module is available in the kernel.
@@ -360,4 +383,3 @@ module as opposed to a libusb-based driver that works in user-space.
 We plan to change the driver to use the 'librevisa' user-space shared
 library (which uses libusb) soon, which will fix all these issues and make
 the driver portable at the same time.
-