gmc-mh-1x-2x: Added new driver gmc-mh-2x-bd232.

[libsigrok.git] / README.devices

diff --git a/README.devices b/README.devices
index 6a15f887c64bed76de4ecefe0eb53f74f28562c1..3591fe9c9722dbeda9608e1c2b22ee21b9e6369c 100644 (file)
--- a/README.devices
+++ b/README.devices
@@ -42,27 +42,39 @@ 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.
 

+ - 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

+ - appa-55ii

  - brymen-dmm
  - cem-dt-885x
  - brymen-dmm
  - cem-dt-885x

+ - center-3xx (including all subdrivers)

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

+ - gmc-mh-1x-2x
+ - hameg-hmo

  - ikalogic-scanalogic2
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb
  - link-mso19
  - ikalogic-scanalogic2
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb
  - link-mso19

- - mic-985xx
+ - mic-985xx (including all subdrivers)
+ - norma-dmm

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

- - rigol-ds1xx2
- - serial-dmm
+ - rigol-ds
+ - serial-dmm (including all subdrivers)
+ - teleinfo

  - tondaj-sl-814
  - tondaj-sl-814

- - uni-t-dmm
+ - uni-t-dmm (including all subdrivers)
+ - uni-t-ut32x

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


@@ -84,14 +96,21 @@ Example:
 The following drivers/devices require a serial port specification:
 
  - agilent-dmm
 The following drivers/devices require a serial port specification:
 
  - agilent-dmm

+ - appa-55ii

  - brymen-dmm
  - cem-dt-885x
  - brymen-dmm
  - cem-dt-885x

+ - center-3xx (including all subdrivers)

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

+ - gmc-mh-1x-2x
+ - hameg-hmo

  - link-mso19
  - link-mso19

- - mic-985xx
+ - mic-985xx (including all subdrivers)
+ - norma-dmm

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

- - serial-dmm
+ - rigol-ds (for RS232; not required for USBTMC or TCP)
+ - serial-dmm (including all subdrivers)
+ - 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:


@@ -106,12 +125,27 @@ The following drivers/devices do not require a serial port specification:
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb

- - rigol-ds1xx2
- - uni-t-dmm
+ - rigol-ds (USBTMC or TCP)
+ - saleae-logic16
+ - uni-t-dmm (including all subdrivers)
+ - 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
 ----------------------------------------
 


@@ -204,6 +238,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


@@ -211,8 +249,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


@@ -246,14 +284,27 @@ 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:
 

+ - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the
+   interface panel on top.

  - Digitek DT4000ZC: Briefly press the "RS232" button.
  - Digitek DT4000ZC: Briefly press the "RS232" button.

+ - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232:
+   Power on the device with the "DATA" button pressed. Additionally Metrahit
+   2x devices must be configured for the respective interface type.
+ - Gossen Metrawatt Metrahit 2x devices, driver gmc-mh-2x-bd232:
+   The device must be configured for the respective interface type.
+ - Norma DM950: If the interface doesn't work (e.g. USB-RS232 converter), power
+   on the device with "FUNC" pressed (to power the interface from the DMM).

  - 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.
- - 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.
+ - Tenma 72-7750: Briefly press the "RS232C" button.
+ - UNI-T UT60G: Briefly press the "RS232C" button.
+ - 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/VA40B: Keep the "Hz/DUTY" key pressed while powering on the DMM.
+ - Victor 70C/86C: Press the "REL/RS232" button for roughly 1 second.

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


@@ -323,12 +374,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.


@@ -339,4 +390,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.

-