Difference between revisions of "Driver options"

From sigrok
Jump to navigation Jump to search
Line 3: Line 3:
The following options are available, listen by configuration key:
The following options are available, listen by configuration key:


== SR_CONF_CONN ==
=== SR_CONF_CONN ===


This option should be available in every driver, and identifies a connection string. The syntax of the string depends on the transport that driver can use to get to reach the device. Some drivers can use more than one transport, for example on devices that have both a USB and serial port.
This option should be available in every driver, and identifies a connection string. The syntax of the string depends on the transport that driver can use to get to reach the device. Some drivers can use more than one transport, for example on devices that have both a USB and serial port.
Line 20: Line 20:
|}
|}


== SR_CONF_SERIALCOMM ==
=== SR_CONF_SERIALCOMM ===


Serial communication specification, in the form:
Serial communication specification, in the form:

Revision as of 04:11, 12 January 2014

Every libsigrok driver can take options. These relate to the driver finding and connecting to the device; once it's discovered these options are not used.

The following options are available, listen by configuration key:

SR_CONF_CONN

This option should be available in every driver, and identifies a connection string. The syntax of the string depends on the transport that driver can use to get to reach the device. Some drivers can use more than one transport, for example on devices that have both a USB and serial port.

Drivers must always support this option, because it allows the frontend to specify more than one device of the same type to connect to, for example two multimeters on two different serial ports.

The following syntaxes are available:

Serial port A string of the form /dev/ttyS0 (POSIX) or COM1 (Windows).
USB Either the device's VID and PID as hex digits separated by a period (1d6b.0001, or the bus and address separated by a period (2.43).

SR_CONF_SERIALCOMM

Serial communication specification, in the form:

<baudrate>/<databits><parity><stopbits>

Example: 9600/8n1

The string may also be followed by one or more special settings, in the form /key=value. Supported keys and their allowed values are:

rts 0, 1 set the port's RTS pin to low or high
dtr 0, 1 set the port's DTR pin to low or high
flow 0 no flow control
1 hardware-based (RTS/CTS) flow control
2 software-based (XON/XOFF) flow control