README.devices 15 KB

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