]> sigrok.org Git - libsigrok.git/blob - README.devices
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / 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 locations where libsigrok expects the firmware files are:
16
17   $SIGROK_FIRMWARE_DIR (environment variable)
18   $HOME/.local/share/sigrok-firmware
19   $prefix/share/sigrok-firmware
20   /usr/local/share/sigrok-firmware
21   /usr/share/sigrok-firmware
22
23 ($prefix is usually /usr/local or /usr, depending on your ./configure options)
24
25 For further information see the section below and also:
26
27   http://sigrok.org/wiki/Firmware
28
29
30 Per-driver firmware requirements
31 --------------------------------
32
33 The following drivers/devices require a firmware upload upon connection:
34
35  - asix-omega-rtm-cli: There is no native sigrok support for ASIX OMEGA
36    devices. But the vendor's RTM CLI application can be used in streaming
37    mode, which transparently handles the device detection and firmware
38    download. The firmware ships with the vendor application. See below
39    for details how to make the vendor application available to the sigrok
40    driver.
41
42  - asix-sigma: The ASIX SIGMA and SIGMA2 require various firmware files,
43    depending on the settings used. These files are available from our
44    'sigrok-firmware' repository/project under a license which allows us
45    to redistribute them.
46
47  - dreamsourcelab-dslogic: The DreamSourceLab DSLogic/DSCope device series
48    requires various firmware files and FPGA bitstream files.
49    These can be extracted/downloaded from the vendor's GitHub repo using a
50    tool from our 'sigrok-util' repository/project.
51
52  - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the
53    firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
54    The firmware is written from scratch and licensed under the GNU GPLv2+.
55
56  - hantek-6xxx: Certain oscilloscopes based on the Cypress FX2(LP) chip, such
57    as the Hantek 6022BE/6022BL, SainSmart DDS120, and Rocktech BM102, need the
58    firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
59    The firmware is written from scratch and licensed under the GNU GPLv2+.
60
61  - hantek-dso: The Hantek DSO-2090 (and other supported models of the same
62    series of Hantek PC oscilloscopes) need firmware files.
63    These can be extracted from the vendor's Windows drivers using a tool
64    from our 'sigrok-util' repository/project.
65
66  - lecroy-logicstudio: The LeCroy LogicStudio requires FPGA bitstream files.
67    These can be extracted from the vendor's Windows software using a tool
68    from our 'sigrok-util' repository/project.
69    Additionally, it requires a Cypress FX2 firmware. This can be extracted
70    from the vendor's Windows software using another tool. Details:
71
72      http://sigrok.org/wiki/LeCroy_LogicStudio#Firmware
73
74  - saleae-logic16: The Saleae Logic16 needs a firmware file for the
75    Cypress FX2 chip in the device, as well as two FPGA bitstream files.
76    These can be extracted from the vendor's Linux application using a tool
77    from our 'sigrok-util' repository/project.
78
79  - saleae-logic-pro: The Saleae Logic Pro 16 needs a firmware file for the
80    Cypress FX3 chip in the device, as well as an FPGA bitstream file.
81    These can be extracted from the vendor's Linux application using a tool
82    from our 'sigrok-util' repository/project.
83
84  - sysclk-lwla:
85
86     - The Sysclk LWLA1034 requires various bitstream files.
87       These files are available from our 'sigrok-firmware' repository/project
88       under a license which allows us to redistribute them.
89
90     - The Sysclk LWLA1016 requires various bitstream files.
91       These can be extracted from the vendor's Windows drivers using a tool
92       from our 'sigrok-util' repository/project.
93
94  - sysclk-sla5032: The Sysclk SLA5032 needs an FPGA bitstream file.
95    This file can be copied (and renamed) from the Windows vendor software
96    installation directory. Details:
97
98      https://sigrok.org/wiki/Sysclk_SLA5032#Firmware
99
100 The following drivers/devices do not need any firmware upload:
101
102  - agilent-dmm
103  - appa-55ii
104  - arachnid-labs-re-load-pro
105  - atten-pps3xxx
106  - baylibre-acme
107  - beaglelogic
108  - cem-dt-885x
109  - center-3xx (including all subdrivers)
110  - chronovu-la
111  - colead-slm
112  - conrad-digi-35-cpu
113  - demo
114  - fluke-45
115  - fluke-dmm
116  - ftdi-la
117  - gmc-mh-1x-2x (including all subdrivers)
118  - gwinstek-gds-800
119  - gwinstek-gpd
120  - hameg-hmo
121  - hantek-4032l
122  - hp-3457a
123  - hp-3478a
124  - hung-chang-dso-2100
125  - ikalogic-scanalogic2
126  - ikalogic-scanaplus
127  - ipdbg-la
128  - kecheng-kc-330b
129  - kern-scale
130  - korad-kaxxxxp
131  - lascar-el-usb
132  - lecroy-xstream
133  - link-mso19
134  - manson-hcs-3xxx
135  - maynuo-m97
136  - mic-985xx (including all subdrivers)
137  - microchip-pickit2
138  - mooshimeter-dmm
139  - motech-lps-30x
140  - norma-dmm
141  - openbench-logic-sniffer
142  - pce-322a
143  - pipistrello-ols
144  - rdtech-dps
145  - rigol-dg
146  - rigol-ds
147  - rohde-schwarz-sme-0x
148  - scpi-dmm
149  - scpi-pps
150  - serial-dmm (including all subdrivers)
151  - serial-lcr (including all subdrivers)
152  - siglent-sds
153  - teleinfo
154  - testo
155  - tondaj-sl-814
156  - uni-t-dmm (including all subdrivers)
157  - uni-t-ut32x
158  - yokogawa-dlm
159  - zeroplus-logic-cube
160  - zketech-ebd-usb
161
162
163 Specifying serial ports
164 -----------------------
165
166 Many devices supported by libsigrok use serial port based cables (real RS232
167 or USB-to-serial ones, CDC class) to connect to a PC. These serial cables are
168 supported by the libserialport library. Some vendors prefer to use HID chips
169 instead of CDC chips in their serial cables. These cables can get supported
170 by means of the hidapi library. Note that each chip type requires specific
171 support in the libsigrok library. Bluetooth connected devices may be supported
172 as well when they communicate by means of RFCOMM channels, or one of the
173 implemented BLE notification/indication approaches, and one of the Bluetooth
174 supporting platforms is used.
175
176 For all these devices, you need to specify the serial port they are connected
177 to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan
178 for such devices without specifying a serial port.
179
180 Example:
181
182  $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ...
183  $ sigrok-cli --driver <somedriver>:conn=hid/cp2110 ...
184  $ sigrok-cli --driver <somedriver>:conn=bt/rfcomm/01-23-45-67-89-ab ...
185
186 Formal syntax for serial communication:
187
188  - COM ports (RS232, USB CDC):
189    conn=<com-port>
190  - USB HID cables:
191    conn=hid[/<chip>]
192    conn=hid[/<chip>]/usb=<bus>.<dev>[.<if>]
193    conn=hid[/<chip>]/raw=<path>
194    conn=hid[/<chip>]/sn=<serno>
195    conn=hid[/<chip>]/iokit=<path>
196    chip can be: bu86x, ch9325, cp2110, victor
197    path may contain slashes
198    path and serno are "greedy" (span to the end of the spec)
199  - Bluetooth Classic and Bluetooth Low Energy (BLE):
200    conn=bt/<conn>/<addr>
201    conn can be: rfcomm, ble122, nrf51, cc254x
202    addr can be "dense" or separated, bt/cc254x/0123456789ab or
203      bt/rfcomm/11-22-33-44-55-66 or bt/ble122/88:6b:12:34:56:78
204      (note that colons may not be available when the conn= spec is taken
205      from a string that separates fields by colon, e.g. in the "--driver
206      <name>:conn=<spec>" example, that is why the dense form and the use
207      of dashes for separation are supported)
208
209 Some of the drivers implement a default for the connection. Some of the
210 drivers can auto-detect USB connected devices.
211
212 Beyond strict serial communication over COM ports (discussed above), the
213 conn= property can also address specific USB devices, as well as specify TCP
214 or VXI communication parameters. See these examples:
215
216  $ sigrok-cli --driver <somedriver>:conn=<vid>.<pid> ...
217  $ sigrok-cli --driver <somedriver>:conn=tcp-raw/<ipaddr>/<port> ...
218  $ sigrok-cli --driver <somedriver>:conn=vxi/<ipaddr> ...
219  $ sigrok-cli --driver <somedriver>:conn=usbtmc/<bus>.<addr> ...
220
221 Individual device drivers _may_ implement additional semantics for the
222 conn= specification, which would not apply to other drivers, yet can be
223 rather useful for a given type of device.
224
225  $ sigrok-cli --driver <somedriver>:conn=sn=<serno>
226
227
228 Specifying serial port parameters
229 ---------------------------------
230
231 Every serial device's driver has default serial port parameters like baud
232 rate, number of data bits, stop bits and handshake status. If a device requires
233 different parameters, pass them as option "serialcomm" with the driver name.
234 See libsigrok docs for the function serial_set_paramstr() for complete specs.
235
236 Example:
237
238  $ sigrok-cli --driver <somedriver>:conn=<someconn>:serialcomm=9600/7n1/dtr=1
239
240
241 Permissions of serial port based devices
242 ----------------------------------------
243
244 When using devices supported by libsigrok that use serial port based cables
245 (real RS232 or USB-to-serial ones) to connect to a PC, you need to ensure
246 that the user running the libsigrok frontend has (read/write) permissions to
247 access the serial port device (e.g. /dev/ttyS0, /dev/ttyUSB0, and so on).
248
249 You can use 'chmod' to apply permissions as you see fit, and/or 'chown' to
250 change the owner of the serial port device to a certain user or group.
251
252 For USB-to-serial based devices, we recommended using our udev rules file
253 (see below for details).
254
255
256 Permissions for USB devices (udev rules files)
257 ----------------------------------------------
258
259 When using USB-based devices supported by libsigrok, the user running the
260 libsigrok frontend (e.g. sigrok-cli) has to have (read/write) permissions
261 for the respective USB device.
262
263 On Linux, this is accomplished using udev rules. libsigrok ships a rules
264 file containing all supported devices which can be detected reliably
265 (generic USB-to-serial converters are omitted, as these are used for a wide
266 range of devices, e.g. GPS receivers, which are not handled by libsigrok).
267
268 The file is available in contrib/60-libsigrok.rules. This file just contains
269 the list of devices and flags these devices with ID_SIGROK="1". Access is
270 granted by the 61-libsigrok-plugdev.rules or 61-libsigrok-uaccess.rules files,
271 allowing access to members of the plugdev group or to currently logged in
272 users, respectively.
273
274 When using a libsigrok package from your favorite Linux distribution, the
275 files should already be installed in /usr/lib/udev/rules.d/, i.e.
276 60-libsigrok.rules and one of the access granting rules files. Use of
277 61-libsigrok-uaccess.rules is encouraged on systemd distributions.
278
279 The access policy can be locally overridden by placing appropriate rules in
280 /etc/udev/rules.d/, disabling or ammending the default policy. See the
281 udev documentation, e.g. man 7 udev, for details.
282
283 If you're building from source, you need to copy the file to the place
284 where udev will read these rules. Local rules should go to /etc/udev/rules.d.
285 Keep the file naming, otherwise interaction between the libsigrok rules and
286 rules shipped by the system will be broken.
287
288 Please consult the udev docs for details.
289
290
291 Assigning drivers to devices (Windows, Zadig)
292 ---------------------------------------------
293
294 On Windows systems it may be necessary to assign drivers to devices
295 before libusb based applications can access them. It may be necessary
296 to re-run this driver assignment after firmware upload in case the
297 device changes its USB identification as a consequence of loading the
298 firmware image.
299
300 The https://sigrok.org/wiki/Windows wiki page discusses this subject,
301 and other platform specific aspects.
302
303
304 Non-default drivers for commodity chips
305 ---------------------------------------
306
307 Some vendors include common USB chips in their products yet assign device
308 specific VID:PID pairs. Which results in the necessity for extra steps
309 before the serial port can be used:
310
311 - GW Instek VCP, found in GDM-8000 and probably other meters: Install the
312   vendors Windows driver to get access to a COM port. Or force the driver
313   assignment on Linux:
314     # modprobe cp210x
315     # echo 2184 0030 > /sys/bus/usb-serial/drivers/cp210x/new_id
316
317
318 Cypress FX2 based devices
319 -------------------------
320
321 Devices using the Cypress FX2(LP) chip without any specific USB VID/PID will
322 be enumerated with VID/PID 04b4:8613 (the default for "unconfigured FX2").
323 These are usually "FX2 eval boards" (that can also be used as LAs, though).
324
325 On Linux, the 'usbtest' driver will usually grab such devices, and they will
326 thus not be usable by libsigrok (and frontends).
327
328 You can fix this by running 'rmmod usbtest' as root before using the device.
329
330
331 UNI-T DMM (and rebranded models) cables
332 ---------------------------------------
333
334 UNI-T multimeters (and rebranded devices, e.g. some Voltcraft models) can
335 ship with different PC connectivity cables:
336
337  - UT-D02 (RS232 cable)
338  - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490)
339  - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008)
340  - UT-D07 (Bluetooth adapter, ISSC BL79 BLETR chip)
341  - UT-D09 (USB/HID cable with SiL CP2110 chip, USB VID/PID 10c4:ea80)
342
343 The above cables are all physically compatible (same IR connector shape)
344 with all/most currently known UNI-T multimeters. For example, you can
345 use either of the UT-D04 USB/HID cables or the UT-D02 RS232 cable with
346 the UNI-T UT61D multimeter.
347
348 When using the UT-D02 RS232 cable with any of the supported UNI-T DMMs,
349 you have to use the respective driver with a '-ser' drivername suffix
350 (internally all of these models are handled by the 'serial-dmm' driver).
351
352 You also need to specify the serial port via the 'conn' option, e.g.
353 /dev/ttyUSB0 (attached via a USB-to-serial cable) or /dev/ttyS0 (actual
354 RS232 port) on Linux (see above).
355
356 Finally, the user running the frontend (e.g. sigrok-cli) also needs
357 permissions to access the respective serial port (see above).
358
359 Examples (sigrok-cli):
360
361  $ sigrok-cli --driver uni-t-ut61e-ser:conn=/dev/ttyUSB0 ...
362  $ sigrok-cli --driver voltcraft-vc820-ser:conn=/dev/ttyS0 ...
363
364 When using any of the UT-D04 USB/HID cables you have to use the respective
365 driver _without_ the '-ser' drivername suffix (internally all of these models
366 are handled by the 'uni-t-dmm' driver).
367
368 You also need to specify the USB vendor/device IDs of the cable.
369 Autodetection is not possible here, since various other products use the
370 USB VID/PID of those cables too, and there is no way to distinguish them.
371
372 Since the UT-D04 cables are USB based (but don't use a USB-to-serial chip)
373 there is no need to specify a serial port via 'conn', of course.
374 However, the user running the frontend does also need to have permissions
375 to access the respective USB device (see above).
376
377 Examples (sigrok-cli):
378
379  $ sigrok-cli --driver uni-t-ut61e:conn=1a86.e008 ...
380  $ sigrok-cli --driver voltcraft-vc820:conn=04fa.2490 ...
381
382
383 UNI-T UT-D04 cable issue on Linux
384 ---------------------------------
385
386 The UNI-T UT-D04 cable with Hoitek HE2325U (or WCH CH9325) chip seems to have
387 a very specific problem on Linux. Apparently it requires to be put into
388 suspend (and woken up again) before it is usable. This seems to be a
389 Linux-only issue, Windows is not affected by this since apparently the
390 Windows kernel does this for every USB device, always.
391
392 Thus, if you want to use any of the UNI-T DMMs with this specific cable,
393 you'll have to run the following script (as root) once, every time you attach
394 the cable via USB. The script was written by Ralf Burger.
395
396 See also: http://erste.de/UT61/index.html
397
398   #!/bin/bash
399   for dat in /sys/bus/usb/devices/*; do
400     if test -e $dat/manufacturer; then
401       grep "WCH.CN" $dat/manufacturer > /dev/null && echo auto > ${dat}/power/level && echo 0 > ${dat}/power/autosuspend
402     fi
403   done
404
405
406 UNI-T UT-D04 cable issue on Windows
407 -----------------------------------
408
409 There have been reports that CH9325 based cables are not detected on
410 Windows out of the box when they are assigned to libwdi drivers. Though
411 they may be usable in that case when the USB address is manually specified.
412 This can happen when some "USB to serial" driver is assigned which does not
413 provide a genuine COM port that enumerates naturally. Manually assigning a
414 "USB input device" driver can improve HIDAPI compatibility and make the
415 cable show up in sigrok's serial port enumeration.
416
417
418 Enabling multimeter / data logger measurement output
419 ----------------------------------------------------
420
421 Some multimeters or data loggers will not start outputting measurement data
422 unless a certain action has been performed by the user beforehand. This is
423 usually mentioned in the vendor manual of the respective device, but here's
424 a short list for convenience:
425
426  - BBC Goertz Metrawatt M2110: Briefly press the "Start/Reset" button on the
427    interface panel on top.
428  - Brymen BM257s: Press HOLD during power-on.
429  - Digitek DT4000ZC: Briefly press the "RS232" button.
430  - EEVBlog 121GW: Hold "1ms PEAK" until the "BT" indicator is shown.
431  - ES51919 based LCR meters (DER EE DE-5000, PeakTech 2170, UNI-T UT612):
432    Press the button with the "RS232" or "USB" or "PC link" label (usually
433    the "up" cursor button).
434  - Gossen Metrawatt Metrahit 1x/2x devices, driver gmc-mh-1x-2x-rs232:
435    - Power on the device with the "DATA" button pressed.
436    - Metrahit 2x devices must be configured for the respective interface type.
437  - Gossen Metrawatt Metrahit 2x devices, driver gmc-mh-2x-bd232:
438    - 'BD232' interface:
439       The multimeter must be configured for the respective interface type.
440    - 'SI232-II' interface ("PC Mode"):
441       The multimeter must be configured for interface type 'BD232' (all),
442       'SI232 online' (28-29S) or 'SI232 store' (22-26x). The interface must
443       be configured to the same baud rate as the host (default 9600).
444       Multimeter and interface must be configured to the same address.
445  - GW Instek GDM-397: Press the "REL/RS232C (USB)" button for roughly 1 second.
446  - GW Instek VCP: See the discussion on manual driver assignment to common
447    USB to UART chips with non-default USB identification.
448  - MASTECH MS6514: Press the "Setup/PC-Link" button for roughly 3 seconds.
449  - Meterman 38XR: Press the "RS232" button.
450  - Metrix MX56C: Press the PRINT button to have the meter send acquisition
451    data via IR. Hold the PRINT button to adjust the meter's transmission
452    interval.
453  - Norma DM950: If the interface doesn't work (e.g. USB-RS232 converter), power
454    on the device with "FUNC" pressed (to power the interface from the DMM).
455  - PCE PCE-DM32: Briefly press the "RS232" button.
456  - RadioShack 22-812: Press and hold "SELECT" and "RANGE" together.
457  - TekPower TP4000ZC: Briefly press the "RS232" button.
458  - Tenma 72-7750: Briefly press the "RS232C" button.
459  - UNI-T UT60G: Briefly press the "RS232C" button.
460  - UNI-T UT61B/C/D: Press the "REL/RS232/USB" button for roughly 1 second.
461  - UNI-T UT71x: Press the "SEND/-/MAXMIN" button for roughly 1 second.
462    Briefly pressing the "EXIT" button leaves this mode again.
463  - UNI-T UT181A: In the "SETUP" menu set "Communication" to "ON".
464  - UNI-T UT325: Briefly press the "SEND" button (as per manual). However, it
465    appears that in practice you don't have to press the button (at least on
466    some versions of the device), simply connect the device via USB.
467  - V&A VA18B/VA40B: Keep the "Hz/DUTY" key pressed while powering on the DMM.
468  - Victor 70C/86C: Press the "REL/RS232" button for roughly 1 second.
469  - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds.
470  - Voltcraft VC-870: Press the "REL/PC" button for roughly 1 second.
471
472
473 ASIX OMEGA in RTM CLI mode
474 --------------------------
475
476 The asix-sigma driver can detect the Omega devices' presence, but does
477 not support their protocol and emits a diagnostics message. The firmware
478 image is not available for distribution, and information on the protocol
479 is not available. That's why native support is in some distant future.
480 Yet basic operation of Omega devices is available by using the vendor's
481 command line application for real time mode (RTM CLI).
482
483 The vendor application targets Windows (on x86), but also executes on
484 Linux when 32bit libraries for FTDI communication are provided. The
485 user manual discusses the installation. The sigrok asix-omega-rtm-cli
486 driver uses the vendor provided omegartmcli.exe binary to configure the
487 device for streaming, and to acquire sample data.
488
489 Either make an "omegartmcli" executable available in PATH. This can be
490 the vendor's executable or some wrapper around it or a symlink to it.
491 Or specify the executable's location in the OMEGARTMCLI environment
492 variable. The sigrok driver accepts an optional serial number (six or
493 eight hex digits) to select one out of several connected devices.
494
495   (optional)
496   $ export "OMEGARTMCLI=$HOME/.wine/drive_c/progx86/ASIX/SIGMA/omegartmcli.exe"
497
498   (optional)
499   $ OMEGASN=":conn=sn=a6030123"
500
501   (example use)
502   $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} --show
503   $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --time 10s
504   $ sigrok-cli -d asix-omega-rtm-cli${OMEGASN} -o capture.sr --samples 100m
505   $ pulseview  -d asix-omega-rtm-cli${OMEGASN}
506
507 The RTM mode of operation samples 16 channels at a fixed rate of 200MHz.
508 Hardware triggers are not available in this mode. Glib should handle
509 platform specific details of external process execution, but the driver
510 was only tested on Linux so far. Acquisition start in sigrok applications
511 may take some time before sample data becomes available (roughly one
512 second here on a slow machine). This is an implementation detail of the
513 RTM CLI approach including execution under wine.
514
515 The reliability of that setup in the presence of fast changing input
516 signals is yet to get determined. It's assumed that slow input signals
517 are operational. It's essential that the _average_ rate of changes in
518 the input signal in combination with the hardware compression are such
519 that the FTDI FIFO can communicate all involved data via USB2.0 to the
520 application. Intermediate bursts of rapid changes shall not be an issue
521 given the Omega devices' deep memory which RTM uses for buffering.
522
523 Native support for the Asix Omega devices depends on the availability of
524 a protocol description and use of the protocol depends on the firmware's
525 availability at the user's site. Which then would allow to capture to
526 DRAM at high rates without the communication bottleneck, before the data
527 gets communicated to the PC after the acquisition has completed. Compare
528 the native sigrok support for Asix Sigma.
529
530
531 ChronoVu LA8/LA16 USB VID/PIDs
532 ------------------------------
533
534 The ChronoVu LA8/LA16 logic analyzer is available in two revisions. Previously,
535 the device shipped with a USB VID/PID of 0403:6001, which is the standard ID
536 for FTDI FT232 USB chips.
537
538 Since this made it hard to distinguish the LA8/LA16 from any other device
539 with this FTDI chip connected to the PC, the vendor later shipped the
540 device with a USB VID/PID of 0403:8867.
541
542 The 'chronovu-la' driver in libsigrok supports both VID/PID pairs and
543 automatically finds devices with either VID/PID pair.
544
545
546 OLS
547 ---
548
549 The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer
550 driver in libsigrok assumes a somewhat recent firmware has been flashed onto
551 the OLS (it doesn't need a firmware upload every time it's attached via USB,
552 since the firmware is stored in the device permanently).
553
554 The most recent firmware version that is tested is 3.07.
555
556 If you use any older firmware and your OLS is not found or is not working
557 properly, please upgrade to at least this firmware version. Check the
558 Dangerous Prototypes wiki for firmware upgrade instructions:
559
560  http://dangerousprototypes.com/docs/Logic_Sniffer_upgrade_procedure
561
562 Also, you need to specify a serial port for the OLS in the frontends, e.g.
563 using the 'conn' option in sigrok-cli, and you also need to have the
564 permissions to access the serial port (see above).
565
566 Example:
567
568  $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
569
570
571 JTAGulator
572 ----------
573
574 The Grand Idea Studio JTAGulator also implements the SUMP protocol and
575 thus is covered by the OLS driver. See the vendor's wiki on details how
576 to enable the Logic Analyzer mode of operation.
577
578   https://github.com/grandideastudio/jtagulator/wiki/Logic-Analyzer
579
580
581 Mooshimeter
582 -----------
583
584 The Mooshim Engineering Mooshimeter is controlled via Bluetooth Low Energy
585 (sometimes called Bluetooth 4.0), as such it requires a supported Bluetooth
586 interface available. The 'conn' option is required and must contain the
587 Bluetooth MAC address of the meter.
588
589 Example:
590
591   $ sigrok-cli --driver mooshimeter-dmm:conn=12-34-56-78-9A-BC ...
592
593 Since the Mooshimeter has no physical interface on the meter itself, the
594 channel configuration is set with the 'channel_config' option. The format
595 of this option is 'CH1,CH2' where each channel configuration has the form
596 'MODE:RANGE:ANALYSIS', with later parts being optional. In addition for
597 CLI compatibility, the ',' in the channels can also be a '/' and the ':' in
598 the individual configuration can be a ';'.
599
600 Available channel 1 modes:
601
602   - Current, A: Current in amps
603   - Temperature, T, K: Internal meter temperature in Kelvin
604   - Resistance, Ohm, W: Resistance in ohms
605   - Diode, D: Diode voltage
606   - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
607
608 Available channel 2 modes:
609
610   - Voltage, V: Voltage
611   - Temperature, T, K: Internal meter temperature in Kelvin
612   - Resistance, Ohm, W: Resistance in ohms
613   - Diode, D: Diode voltage
614   - Aux, LV: Auxiliary (W input) low voltage sensor (1.2V max)
615
616 Only one channel can use the shared inputs at a time (e.g. if CH1 is measuring
617 resistance, CH2 cannot measure low voltage). Temperature is excepted from
618 this, so the meter can measure internal temperature and low voltage at the
619 same time.
620
621 Additionally, the meter can calculate the real power of both channels. This
622 generally only makes sense when CH1 is set to current and CH2 is set to a
623 voltage and so it is disabled by default. It must be enabled by enabling the
624 'P' channel (the third channel).
625
626 The range of the channel specification sets the maximum input for that channel
627 and is rounded up to the next value the meter itself supports. For example,
628 specifying 50 for the voltage will result in the actual maximum of 60.
629 Specifying 61 would result in 600. If omitted, sigrok will perform
630 auto-ranging of the channel by selecting the next greater value than the
631 latest maximum.
632
633 The analysis option sets how the meter reports its internal sampling buffer
634 to sigrok:
635
636  - Mean, DC: The default is a simple arithmetic mean of the sample buffer
637  - RMS, AC: The root mean square of the sample buffer
638  - Buf, Buffer, Samples: Report the entire sample buffer to sigrok. This
639    results in packets that contain all the samples in the buffer instead
640    of a single output value.
641
642 The size of the sample buffer is set with the 'avg_samples' option, while
643 the sampling rate is set with the 'samplerate' option. So the update rate
644 is avg_samples/samplerate. Both are rounded up to the next supported value
645 by the meter.
646
647 Example:
648
649   $ sigrok-cli -c channel_config="Aux;0.1/T" --driver mooshimeter-dmm...
650   $ sigrok-cli -c channel_config="A;;AC/V;;AC" --driver mooshimeter-dmm...