README.devices

   1 -------------------------------------------------------------------------------
   2 README.devices
   3 -------------------------------------------------------------------------------
   4
   5 This README contains various notes for users of libsigrok (or frontends
   6 that are based on libsigrok) about device- and/or driver-specific issues.
   7
   8
   9 Firmware
  10 --------
  11
  12 Some devices supported by libsigrok need a firmware to be uploaded every time
  13 the device is connected to the PC (usually via USB), before it can be used.
  14
  15 The default location where libsigrok expects the firmware files is:
  16
  17   $prefix/share/sigrok-firmware
  18
  19 ($prefix is usually /usr/local or /usr, depending on your ./configure options)
  20
  21 For further information see the section below and also:
  22
  23   http://sigrok.org/wiki/Firmware
  24
  25
  26 Per-driver firmware requirements
  27 --------------------------------
  28
  29 The following drivers/devices require a firmware upload upon connection:
  30
  31  - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files,
  32    depending on the settings used. These files are available from our
  33    'sigrok-firmware' repository/project under a license which allows us
  34    to redistribute them.
  35
  36  - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the
  37    firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
  38    The firmware is written from scratch and licensed under the GNU GPLv2+.
  39
  40  - hantek-dso: The Hantek DSO-2090 (and other supported models of the same
  41    series of Hantek PC oscilloscopes) need firmware files.
  42    These can be extracted from the vendor's Windows drivers using a tool
  43    from our 'sigrok-util' repository/project.
  44
  45  - saleae-logic16: The Saleae Logic16 needs a firmware file for the
  46    Cypress FX2 chip in the device, as well as two FPGA bitstream files.
  47    These can be extracted from the vendor's Linux application using a tool
  48    from our 'sigrok-util' repository/project.
  49
  50  - sysclk-lwla: The Sysclk LWLA1034 requires various bitstream files.
  51    These files are available from our 'sigrok-firmware' repository/project
  52    under a license which allows us to redistribute them.
  53
  54 The following drivers/devices do not need any firmware upload:
  55
  56  - agilent-dmm
  57  - appa-55ii
  58  - atten-pps3xxx
  59  - brymen-bm86x
  60  - brymen-dmm
  61  - cem-dt-885x
  62  - center-3xx (including all subdrivers)
  63  - chronovu-la
  64  - colead-slm
  65  - conrad-digi-35-cpu
  66  - demo
  67  - fluke-dmm
  68  - gmc-mh-1x-2x (including all subdrivers)
  69  - hameg-hmo
  70  - ikalogic-scanalogic2
  71  - ikalogic-scanaplus
  72  - kecheng-kc-330b
  73  - lascar-el-usb
  74  - link-mso19
  75  - mic-985xx (including all subdrivers)
  76  - norma-dmm
  77  - openbench-logic-sniffer
  78  - pipistrello-ols
  79  - rigol-ds
  80  - serial-dmm (including all subdrivers)
  81  - teleinfo
  82  - tondaj-sl-814
  83  - uni-t-dmm (including all subdrivers)
  84  - uni-t-ut32x
  85  - victor-dmm
  86  - yokogawa-dlm
  87  - zeroplus-logic-cube
  88
  89
  90 Specifying serial ports
  91 -----------------------
  92
  93 Many devices supported by libsigrok use serial port based cables (real RS232
  94 or USB-to-serial ones) to connect to a PC.
  95
  96 For all these devices, you need to specify the serial port they are connected
  97 to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan
  98 for such devices without specifying a serial port.
  99
 100 Example:
 101
 102  $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ...
 103
 104 The following drivers/devices require a serial port specification:
 105
 106  - agilent-dmm
 107  - appa-55ii
 108  - atten-pps3xxx
 109  - brymen-dmm
 110  - cem-dt-885x
 111  - center-3xx (including all subdrivers)
 112  - colead-slm
 113  - conrad-digi-35-cpu
 114  - fluke-dmm
 115  - gmc-mh-1x-2x (including all subdrivers)
 116  - hameg-hmo
 117  - link-mso19
 118  - mic-985xx (including all subdrivers)
 119  - norma-dmm
 120  - openbench-logic-sniffer
 121  - rigol-ds (for RS232; not required for USBTMC or TCP)
 122  - serial-dmm (including all subdrivers)
 123  - teleinfo
 124  - tondaj-sl-814
 125
 126 The following drivers/devices do not require a serial port specification:
 127
 128  - asix-sigma
 129  - brymen-bm86x
 130  - chronovu-la
 131  - demo
 132  - fx2lafw
 133  - hantek-dso
 134  - ikalogic-scanalogic2
 135  - ikalogic-scanaplus
 136  - kecheng-kc-330b
 137  - lascar-el-usb
 138  - pipistrello-ols
 139  - rigol-ds (USBTMC or TCP)
 140  - saleae-logic16
 141  - sysclk-lwla
 142  - uni-t-dmm (including all subdrivers)
 143  - uni-t-ut32x
 144  - victor-dmm
 145  - yokogawa-dlm (USBTMC or TCP)
 146  - zeroplus-logic-cube
 147
 148
 149 Specifying serial port parameters
 150 ---------------------------------
 151
 152 Every serial device's driver has default serial port parameters like baud
 153 rate, number of data bits, stop bits and handshake status. If a device requires
 154 different parameters, pass them as option "serialcomm" with the driver name.
 155 See libsigrok docs for the function serial_set_paramstr() for complete specs.
 156
 157 Example:
 158
 159  $ sigrok-cli --driver <somedriver>:conn=<someconn>:serialcomm=9600/7n1/dtr=1
 160
 161
 162 Permissions of serial port based devices
 163 ----------------------------------------
 164
 165 When using devices supported by libsigrok that use serial port based cables
 166 (real RS232 or USB-to-serial ones) to connect to a PC, you need to ensure
 167 that the user running the libsigrok frontend has (read/write) permissions to
 168 access the serial port device (e.g. /dev/ttyS0, /dev/ttyUSB0, and so on).
 169
 170 You can use 'chmod' to apply permissions as you see fit, and/or 'chown' to
 171 change the owner of the serial port device to a certain user or group.
 172
 173 For USB-to-serial based devices, we recommended using our udev rules file
 174 (see below for details).
 175
 176
 177 Permissions for USB devices (udev rules file)
 178 ---------------------------------------------
 179
 180 When using USB-based devices supported by libsigrok, the user running the
 181 libsigrok frontend (e.g. sigrok-cli) has to have (read/write) permissions
 182 for the respective USB device.
 183
 184 On Linux, this is accomplished using either 'chmod' (not recommended) or
 185 using the udev rules file shipped with libsigrok (recommended).
 186
 187 The file is available in contrib/z60_libsigrok.rules. It contains entries
 188 for all libsigrok-supported (USB-based) devices and changes their group
 189 to 'plugdev' and the permissions to '664'.
 190
 191 When using a libsigrok package from your favorite Linux distribution, the
 192 packager will have already taken care of properly installing the udev file
 193 in the correct (distro-specific) place, and you don't have to do anything.
 194 The packager might also have adapted 'plugdev' and '664' as needed.
 195
 196 If you're building from source, you need to copy the file to the place
 197 where your distro expects such files. This is beyond the scope of this README,
 198 but generally the location could be e.g. /etc/udev/rules.d, or maybe
 199 /lib/udev/rules.d, or something else. Afterwards you might have to restart
 200 udev, e.g. via '/etc/init.d/udev restart' or similar, and you'll have to
 201 re-attach your device via USB.
 202
 203 Please consult the udev docs of your distro for details.
 204
 205
 206 Cypress FX2 based devices
 207 -------------------------
 208
 209 Devices using the Cypress FX2(LP) chip without any specific USB VID/PID will
 210 be enumerated with VID/PID 04b4:8613 (the default for "unconfigured FX2").
 211 These are usually "FX2 eval boards" (that can also be used as LAs, though).
 212
 213 On Linux, the 'usbtest' driver will usually grab such devices, and they will
 214 thus not be usable by libsigrok (and frontends).
 215
 216 You can fix this by running 'rmmod usbtest' as root before using the device.
 217
 218
 219 UNI-T DMM (and rebranded models) cables
 220 ---------------------------------------
 221
 222 UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can
 223 ship with different PC connectivity cables:
 224
 225  - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490)
 226  - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008)
 227  - UT-D02 (RS232 cable)
 228
 229 The above cables are all physically compatible (same IR connector shape)
 230 with all/most currently known UNI-T multimeters. For example, you can
 231 use either of the UT-D04 USB/HID cables or the UT-D02 RS232 cable with
 232 the UNI-T UT61D multimeter.
 233
 234 When using the UT-D02 RS232 cable with any of the supported UNI-T DMMs,
 235 you have to use the respective driver with a '-ser' drivername suffix
 236 (internally all of these models are handled by the 'serial-dmm' driver).
 237
 238 You also need to specify the serial port via the 'conn' option, e.g.
 239 /dev/ttyUSB0 (attached via a USB-to-serial cable) or /dev/ttyS0 (actual
 240 RS232 port) on Linux (see above).
 241
 242 Finally, the user running the frontend (e.g. sigrok-cli) also needs
 243 permissions to access the respective serial port (see above).
 244
 245 Examples (sigrok-cli):
 246
 247  $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ...
 248  $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ...
 249
 250 When using any of the UT-D04 USB/HID cables you have to use the respective
 251 driver _without_ the '-ser' drivername suffix (internally all of these models
 252 are handled by the 'uni-t-dmm' driver).
 253
 254 You also need to specify the USB vendor/device IDs of the cable.
 255 Autodetection is not possible here, since various other products use the
 256 USB VID/PID of those cables too, and there is no way to distinguish them.
 257
 258 Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip)
 259 there is no need to specify a serial port via 'conn', of course.
 260 However, the user running the frontend does also need to have permissions
 261 to access the respective USB device (see above).
 262
 263 Examples (sigrok-cli):
 264
 265  $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ...
 266  $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ...
 267
 268
 269 UNI-T UT-D04 cable issue on Linux
 270 ---------------------------------
 271
 272 The UNI-T UT-D04 cable with Hoitek HE2325U (or WCH CH9325) chip seems to have
 273 a very specific problem on Linux. Apparently it requires to be put into
 274 suspend (and woken up again) before it is usable. This seems to be a
 275 Linux-only issue, Windows is not affected by this since apparently the
 276 Windows kernel does this for every USB device, always.
 277
 278 Thus, if you want to use any of the UNI-T DMMs with this specific cable,
 279 you'll have to run the following script (as root) once, every time you attach
 280 the cable via USB. The script was written by Ralf Burger.
 281
 282 See also: http://erste.de/UT61/index.html
 283
 284   #!/bin/bash
 285   for dat in /sys/bus/usb/devices/*; do
 286     if test -e $dat/manufacturer; then
 287       grep "WCH.CN" $dat/manufacturer > /dev/null && echo auto > ${dat}/power/level && echo 0 > ${dat}/power/autosuspend
 288     fi
 289   done
 290
 291
 292 Enabling multimeter / data logger measurement output
 293 ----------------------------------------------------
 294
 295 Some multimeters or data loggers will not start outputting measurement data
 296 unless a certain action has been performed by the user beforehand. This is
 297 usually mentioned in the vendor manual of the respective device, but here's
 298 a short list for convenience:
 299
 300  - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the
 301    interface panel on top.
 302  - Digitek DT4000ZC: Briefly press the "RS232" button.
 303  - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232:
 304    - Power on the device with the "DATA" button pressed.
 305    - Metrahit 2x devices must be configured for the respective interface type.
 306  - Gossen Metrawatt Metrahit 2x devices, driver gmc-mh-2x-bd232:
 307    - 'BD232' interface:
 308       The multimeter must be configured for the respective interface type.
 309    - 'SI232-II' interface ("PC Mode"):
 310       The multimeter must be configured for interface type 'BD232' (all),
 311       'SI232 online' (28-29S) or 'SI232 store' (22-26x). The interface must
 312       be configured to the same baud rate as the host (default 9600).
 313       Multimeter and interface must be configured to the same address.
 314  - Norma DM950: If the interface doesn't work (e.g. USB-RS232 converter), power
 315    on the device with "FUNC" pressed (to power the interface from the DMM).
 316  - PCE PCE-DM32: Briefly press the "RS232" button.
 317  - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together.
 318  - TekPower TP4000ZC: Briefly press the "RS232" button.
 319  - Tenma 72-7750: Briefly press the "RS232C" button.
 320  - UNI-T UT60G: Briefly press the "RS232C" button.
 321  - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second.
 322  - UNI-T UT71x: Press the "SEND/-/MAXMIN" button for roughly 1 second.
 323    Briefly pressing the "EXIT" button leaves this mode again.
 324  - UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it
 325    appears that in practice you don't have to press the button (at least on
 326    some versions of the device), simply connect the device via USB.
 327  - V&A VA18B/VA40B: Keep the "Hz/DUTY" key pressed while powering on the DMM.
 328  - Victor 70C/86C: Press the "REL/RS232" button for roughly 1 second.
 329  - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds.
 330  - Voltcraft VC-870: Press the "REL/PC" button for roughly 1 second.
 331
 332
 333 ChronoVu LA8/LA16 USB VID/PIDs
 334 ------------------------------
 335
 336 The ChronoVu LA8/LA16 logic analyzer is available in two revisions. Previously,
 337 the device shipped with a USB VID/PID of 0403:6001, which is the standard ID
 338 for FTDI FT232 USB chips.
 339
 340 Since this made it hard to distinguish the LA8/LA16 from any other device
 341 with this FTDI chip connected to the PC, the vendor later shipped the
 342 device with a USB VID/PID of 0403:8867.
 343
 344 The 'chronovu-la' driver in libsigrok supports both VID/PID pairs and
 345 automatically finds devices with either VID/PID pair.
 346
 347
 348 OLS
 349 ---
 350
 351 The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer
 352 driver in libsigrok assumes a somewhat recent firmware has been flashed onto
 353 the OLS (it doesn't need a firmware upload every time it's attached via USB,
 354 since the firmware is stored in the device permanently).
 355
 356 The most recent firmware version that is tested is 3.07.
 357
 358 If you use any older firmware and your OLS is not found or is not working
 359 properly, please upgrade to at least this firmware version. Check the
 360 Dangerous Prototypes wiki for firmware upgrade instructions:
 361
 362  http://dangerousprototypes.com/docs/Logic_Sniffer_upgrade_procedure
 363
 364 Also, you need to specify a serial port for the OLS in the frontends, e.g.
 365 using the 'conn' option in sigrok-cli, and you also need to have the
 366 permissions to access the serial port (see above).
 367
 368 Example:
 369
 370  $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
 371