serial: Improved docs.

[libsigrok.git] / README.devices

diff --git a/README.devices b/README.devices
index fefbfc470ae7c8e67a663cd53324ffa11f2a846f..6dd42dde05c90dd17adf2e6facc751a3cda21786 100644 (file)
--- a/README.devices
+++ b/README.devices
@@ -42,26 +42,38 @@ The following drivers/devices require a firmware upload upon connection:
    These can be extracted from the vendor's Windows drivers using a tool
    from our 'sigrok-util' repository/project.
 
    These can be extracted from the vendor's Windows drivers using a tool
    from our 'sigrok-util' repository/project.
 

- - nexus-osciprime: The Nexus Computing OsciPrime PC oscilloscope needs
-   firmware files. These are available from the vendor website.
+ - saleae-logic16: The Saleae Logic16 needs a firmware file for the
+   Cypress FX2 chip in the device, as well as two FPGA bitstream files.
+   These can be extracted from the vendor's Linux application using a tool
+   from our 'sigrok-util' repository/project.

 
 The following drivers/devices do not need any firmware upload:
 
  - agilent-dmm
  - alsa
 
 The following drivers/devices do not need any firmware upload:
 
  - agilent-dmm
  - alsa

+ - bbcgm-m2110

  - brymen-dmm
  - brymen-dmm

+ - cem-dt-885x
+ - center-3xx

  - chronovu-la8
  - colead-slm
  - demo
  - fluke-dmm
  - chronovu-la8
  - colead-slm
  - demo
  - fluke-dmm

+ - gmc-mh-1x-2x-rs232
+ - ikalogic-scanalogic2
+ - ikalogic-scanaplus
+ - kecheng-kc-330b

  - lascar-el-usb
  - link-mso19
  - mic-985xx
  - lascar-el-usb
  - link-mso19
  - mic-985xx

+ - norma-dmm

  - openbench-logic-sniffer
  - openbench-logic-sniffer

- - rigol-ds1xx2
+ - rigol-ds

  - serial-dmm
  - serial-dmm

+ - teleinfo

  - tondaj-sl-814
  - uni-t-dmm
  - tondaj-sl-814
  - uni-t-dmm

+ - uni-t-ut32x

  - victor-dmm
  - zeroplus-logic-cube
 
  - victor-dmm
  - zeroplus-logic-cube
 


@@ -83,14 +95,19 @@ Example:
 The following drivers/devices require a serial port specification:
 
  - agilent-dmm
 The following drivers/devices require a serial port specification:
 
  - agilent-dmm

+ - bbcgm-m2110

  - brymen-dmm
  - brymen-dmm

+ - cem-dt-885x
+ - center-3xx

  - colead-slm
  - fluke-dmm
  - colead-slm
  - fluke-dmm

+ - gmc-mh-1x-2x-rs232

  - link-mso19
  - mic-985xx
  - link-mso19
  - mic-985xx

- - nexus-osciprime
+ - norma-dmm

  - openbench-logic-sniffer
  - serial-dmm
  - openbench-logic-sniffer
  - serial-dmm

+ - teleinfo

  - tondaj-sl-814
 
 The following drivers/devices do not require a serial port specification:
  - tondaj-sl-814
 
 The following drivers/devices do not require a serial port specification:


@@ -101,13 +118,32 @@ The following drivers/devices do not require a serial port specification:
  - demo
  - fx2lafw
  - hantek-dso
  - demo
  - fx2lafw
  - hantek-dso

+ - ikalogic-scanalogic2
+ - ikalogic-scanaplus
+ - kecheng-kc-330b

  - lascar-el-usb
  - lascar-el-usb

- - rigol-ds1xx2
+ - rigol-ds
+ - saleae-logic16

  - uni-t-dmm
  - uni-t-dmm

+ - uni-t-ut32x

  - victor-dmm
  - zeroplus-logic-cube
 
 
  - victor-dmm
  - 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
 ----------------------------------------
 
 Permissions of serial port based devices
 ----------------------------------------
 


@@ -200,6 +236,10 @@ When using any of the UT-D04 USB/HID cables you have to use the respective
 driver _without_ the '-ser' drivername suffix (internally all of these models
 are handled by the 'uni-t-dmm' driver).
 
 driver _without_ the '-ser' drivername suffix (internally all of these models
 are handled by the 'uni-t-dmm' driver).
 

+You also need to specify the USB vendor/device IDs of the cable.
+Autodetection is not possible here, since various other products use the
+USB VID/PID of those cables too, and there is no way to distinguish them.
+

 Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip)
 there is no need to specify a serial port via 'conn', of course.
 However, the user running the frontend does also need to have permissions
 Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip)
 there is no need to specify a serial port via 'conn', of course.
 However, the user running the frontend does also need to have permissions


@@ -207,8 +247,8 @@ to access the respective USB device (see above).
 
 Examples (sigrok-cli):
 
 
 Examples (sigrok-cli):
 

- $ sigrok-cli --driver uni-t-ut61e ...
- $ sigrok-cli --driver voltcraft-vc820 ...
+ $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ...
+ $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ...

 
 
 UNI-T UT-D04 cable issue on Linux
 
 
 UNI-T UT-D04 cable issue on Linux


@@ -242,14 +282,23 @@ 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:
 
 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.
  - 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.
  - 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.

  - V&A VA18B: Keep the "Hz/DUTY" key pressed while powering on the device.
  - Victor 70C: Press the "REL/RS232" button for roughly 1 second.
  - Victor 86C: Press the "REL/RS232" button for roughly 1 second.
  - V&A VA18B: Keep the "Hz/DUTY" key pressed while powering on the device.
  - Victor 70C: Press the "REL/RS232" button for roughly 1 second.
  - Victor 86C: Press the "REL/RS232" button for roughly 1 second.

+ - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds.

 
 
 ALSA driver
 
 
 ALSA driver


@@ -318,12 +367,12 @@ Example:
  $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
 
 
  $ 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.
 
 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.


@@ -334,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.
 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.

-