Difference between revisions of "Connection parameters"
m (fix links) |
|||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
In case a device can not be autodetected or connection to a specific device is required, is is possible to specify the connection | In case a device can not be [[Device discovery|autodetected]] or connection to a specific device is required, is is possible to specify the connection | ||
explicitly as an driver option, using the "<driver-name>:conn=<connection>" syntax. | explicitly as an driver option, using the "<driver-name>:conn=<connection>" syntax. See the '''README.devices''' file for details. | ||
= Digital Multimeters = | = Digital Multimeters = | ||
| Line 20: | Line 20: | ||
== USB HID connections == | == USB HID connections == | ||
'''TODO''' This chapter needs an update. It has not yet caught up with the recent '''HIDAPI library''' approach, and '''conn=hid/''' syntax. When in doubt, check the '''README.devices''' file -- it's probably more up to date than this wiki page. | |||
When a device driver exclusively supports HID based cables, then it usually accepts USB vendor and product ID pairs, or bus and device addresses: | |||
<code>conn=<vendor-id>.<product-id></code> | <code>conn=<vendor-id>.<product-id></code> | ||
| Line 27: | Line 33: | ||
<code>conn=<bus-nr>.<device-address></code> | <code>conn=<bus-nr>.<device-address></code> | ||
<bus-nr> is an integer | <bus-nr> is an integer between 1 and 255, <device-address> is an integer between 1 and 127. The device address changes | ||
every time a device is reconnected. Bus number and device address can e.g. be found using <tt>lsusb</tt>. | every time a device is reconnected. Bus number and device address can e.g. be found using <tt>lsusb</tt>. | ||
| Line 34: | Line 40: | ||
$ sigrok-cli --driver=uni-t-ut61e:conn=2.12 -O analog | $ sigrok-cli --driver=uni-t-ut61e:conn=2.12 -O analog | ||
</source> | </source> | ||
When a device driver supports several different cable types, then a unified form of specifying serial connections can be used instead: | |||
<source lang="bash"> | |||
$ sigrok-cli -d uni-t-ut61c:conn=/dev/ttyUSB0 --continuous | |||
$ sigrok-cli -d uni-t-ut61c:conn=hid/ch9325 --continuous | |||
</source> | |||
Individual drivers may require that users specify the connection, or may come with builtin defaults and accept user overrides to ease their use. | |||
= Devices using SCPI = | = Devices using SCPI = | ||
| Line 46: | Line 61: | ||
<code>conn=<device-path></code> | <code>conn=<device-path></code> | ||
<source lang="bash"> | <source lang="bash"> | ||
$ sigrok-cli --driver=hameg-hmo:conn=/dev/ttyACM0 -O analog -frames 1 | $ sigrok-cli --driver=hameg-hmo:conn=/dev/ttyACM0 -O analog --frames 1 | ||
</source> | |||
Baudrate can be set with option '''serialcomm''': | |||
<source lang="bash"> | |||
$ sigrok-cli --driver=scpi-dmm:conn=/dev/ttyUSB0:serialcomm=115200/8n1 -O analog --frames 1 | |||
</source> | </source> | ||
| Line 58: | Line 79: | ||
<source lang="bash"> | <source lang="bash"> | ||
$ sigrok-cli --driver=hameg-hmo:conn=usbtmc/0aad.0119 -O analog -frames 1 | $ sigrok-cli --driver=hameg-hmo:conn=usbtmc/0aad.0119 -O analog --frames 1 | ||
</source> | </source> | ||
| Line 66: | Line 87: | ||
<source lang="bash"> | <source lang="bash"> | ||
$ sigrok-cli --driver=hameg-hmo:conn=tcp-raw/192.168.1.20/5025 -O analog -frames 1 | $ sigrok-cli --driver=hameg-hmo:conn=tcp-raw/192.168.1.20/5025 -O analog --frames 1 | ||
</source> | |||
== Linux-GPIB == | |||
For GPIB devices connected via [http://linux-gpib.sourceforge.net/ linux-gpib], use the <code>libgpib</code> prefix, followed by the device name as defined in your <code>gpib.conf</code> file. | |||
<source lang="bash"> | |||
$ sigrok-cli --driver=scpi-pps:conn=libgpib/pm2813 -O analog --samples 1 | |||
</source> | |||
== VXI == | |||
Devices using a VXI-based network connection can be specified with the <code>vxi</code> prefix, followed by the hostname (or IP address). Optionally, the instrument name can be added with another <code>/</code> and the name; this defaults to <code>inst0</code>. | |||
<source lang="bash"> | |||
$ sigrok-cli --driver=scpi-pps:conn=vxi/labps -O analog --samples 1 | |||
</source> | |||
= Forced detection = | |||
Sometimes unsupported device models might be covered by existing drivers, but would not match against a builtin list of known devices. Therefore the scan option <code>force_detect</code> provides a way for the users to force | |||
the use of a driver with an unsupported device. | |||
Right now only the Korad power supplies (driver <code>korad-kaxxxxp</code>) support the <code>force_detect</code> scan option: | |||
<source lang="bash"> | |||
$ sigrok-cli -d korad-kaxxxxp:conn=/dev/ttyUSB0:force_detect=KORADKA3005PV2.0 --show | |||
</source> | </source> | ||
Latest revision as of 12:29, 21 October 2024
In case a device can not be autodetected or connection to a specific device is required, is is possible to specify the connection explicitly as an driver option, using the "<driver-name>:conn=<connection>" syntax. See the README.devices file for details.
Digital Multimeters
Most multimeters use a serial connection. The corresponding device cables either povide an RS232 connection or an USB connection using an serial to USB-CDC or serial to USB-HID converter chip, see Serial port. Some devices are available with different data cables. RS232 and USB-CDC (Virtual Com Port, VCP) cables use a common driver, USB HID cables need a seperate one. If a device has two drivers, the one for RS232/VCP is typically suffixed with "-ser"
RS232 / Virtual Com Port
conn=<device-path>
<device-path> is an absolute path to the wanted device, e.g. /dev/ttyUSB1 or /dev/ttyACM0.
$ sigrok-cli --driver=uni-t-ut61e-ser:conn=/dev/ttyUSB0 -O analog
USB HID connections
TODO This chapter needs an update. It has not yet caught up with the recent HIDAPI library approach, and conn=hid/ syntax. When in doubt, check the README.devices file -- it's probably more up to date than this wiki page.
When a device driver exclusively supports HID based cables, then it usually accepts USB vendor and product ID pairs, or bus and device addresses:
conn=<vendor-id>.<product-id>
<vendor-id> and <product-id> have to be specifid as 4 hexadecimal digits.
conn=<bus-nr>.<device-address>
<bus-nr> is an integer between 1 and 255, <device-address> is an integer between 1 and 127. The device address changes every time a device is reconnected. Bus number and device address can e.g. be found using lsusb.
$ sigrok-cli --driver=uni-t-ut61e:conn=1a86.e008 -O analog
$ sigrok-cli --driver=uni-t-ut61e:conn=2.12 -O analog
When a device driver supports several different cable types, then a unified form of specifying serial connections can be used instead:
$ sigrok-cli -d uni-t-ut61c:conn=/dev/ttyUSB0 --continuous
$ sigrok-cli -d uni-t-ut61c:conn=hid/ch9325 --continuous
Individual drivers may require that users specify the connection, or may come with builtin defaults and accept user overrides to ease their use.
Devices using SCPI
SCPI has several backends. For all backends but serial the backend name is the first parameter, followed by one or more backend specific parameters.
Serial / Virtual Com Port
Same syntax as for DMMs with serial connection.
conn=<device-path>
$ sigrok-cli --driver=hameg-hmo:conn=/dev/ttyACM0 -O analog --frames 1
Baudrate can be set with option serialcomm:
$ sigrok-cli --driver=scpi-dmm:conn=/dev/ttyUSB0:serialcomm=115200/8n1 -O analog --frames 1
USBTMC
Similar syntax as for DMMs with USB HID datacables.
conn=usbtmc/<vendor-id>.<product-id>
conn=usbtmc/<bus-nr>.<device-address>
$ sigrok-cli --driver=hameg-hmo:conn=usbtmc/0aad.0119 -O analog --frames 1
TCP RAW
conn=tcp-raw/<ip-address>/<tcp-port>
$ sigrok-cli --driver=hameg-hmo:conn=tcp-raw/192.168.1.20/5025 -O analog --frames 1
Linux-GPIB
For GPIB devices connected via linux-gpib, use the libgpib prefix, followed by the device name as defined in your gpib.conf file.
$ sigrok-cli --driver=scpi-pps:conn=libgpib/pm2813 -O analog --samples 1
VXI
Devices using a VXI-based network connection can be specified with the vxi prefix, followed by the hostname (or IP address). Optionally, the instrument name can be added with another / and the name; this defaults to inst0.
$ sigrok-cli --driver=scpi-pps:conn=vxi/labps -O analog --samples 1
Forced detection
Sometimes unsupported device models might be covered by existing drivers, but would not match against a builtin list of known devices. Therefore the scan option force_detect provides a way for the users to force
the use of a driver with an unsupported device.
Right now only the Korad power supplies (driver korad-kaxxxxp) support the force_detect scan option:
$ sigrok-cli -d korad-kaxxxxp:conn=/dev/ttyUSB0:force_detect=KORADKA3005PV2.0 --show
Vendor specific protocols
Most (all?) devices using a vendor specific protocol use either RS232 or a USB-to-serial converter, thus the connection string is the same as for DMMs with serial connection.