Configuration

This chapter describes the individual drivers and resources used in a device configuration. Drivers can depend on resources or other drivers, whereas resources have no dependencies.

_images/config_graph.svg

Here the resource RawSerialPort provides the information for the SerialDriver, which in turn is needed by the ShellDriver. Driver dependency resolution is done by searching for the driver which implements the dependent protocol, all drivers implement one or more protocols.

Resources

Serial Ports

RawSerialPort

A RawSerialPort is a serial port which is identified via the device path on the local computer. Take note that re-plugging USB serial converters can result in a different enumeration order.

RawSerialPort:
  port: /dev/ttyUSB0
  speed: 115200

The example would access the serial port /dev/ttyUSB0 on the local computer with a baud rate of 115200.

Arguments:

  • port (str): path to the serial device

  • speed (int, default=115200): desired baud rate

Used by:

NetworkSerialPort

A NetworkSerialPort describes a serial port which is exported over the network, usually using RFC2217 or raw tcp.

NetworkSerialPort:
  host: remote.example.computer
  port: 53867
  speed: 115200

The example would access the serial port on computer remote.example.computer via port 53867 and use a baud rate of 115200 with the RFC2217 protocol.

Arguments:

  • host (str): hostname of the remote host

  • port (str): TCP port on the remote host to connect to

  • speed (int, default=115200): baud rate of the serial port

  • protocol (str, default=”rfc2217”): protocol used for connection: raw or rfc2217

Used by:

ModbusRTU

Describes the resource required to use the ModbusRTU driver. Modbus RTU is a communication protocol used to control many different kinds of electronic systems, such as thermostats, power plants, etc. Modbus is normally implemented on top of RS-485, though this is not strictly necessary, as long as the Modbus network only has one master (and up to 256 slaves).

The labgrid driver is implemented using the minimalmodbus Python library. The implementation only supports that labgrid will be the master on the Modbus network. For more information, see minimalmodbus.

This resource and driver only supports local usage and will not work with an exporter.

ModbusRTU:
  port: "/dev/ttyUSB0"
  address: 16
  speed: 115200
  timeout: 0.25
Arguments:

  • port (str): tty the instrument is connected to, e.g. ‘/dev/ttyUSB0’

  • address (int): slave address on the modbus, e.g. 16

  • speed (int, default=115200): baud rate of the serial port

  • timeout (float, default=0.25): optional, timeout in seconds

Used by:

USBSerialPort

A USBSerialPort describes a serial port which is connected via USB and is identified by matching udev properties. This allows identification through hot-plugging or rebooting.

USBSerialPort:
  match:
    ID_SERIAL_SHORT: P-00-00682
  speed: 115200

The example would search for a USB serial converter with the key ID_SERIAL_SHORT and the value P-00-00682 and use it with a baud rate of 115200. The ID_SERIAL_SHORT property is set by the usb_id builtin helper program.

Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

  • speed (int, default=115200): baud rate of the serial port

Used by:

Power Ports

NetworkPowerPort

A NetworkPowerPort describes a remotely switchable power port.

NetworkPowerPort:
  model: gude
  host: powerswitch.example.computer
  index: 0

The example describes port 0 on the remote power switch powerswitch.example.computer, which is a gude model.

Arguments:

  • model (str): model of the power switch

  • host (str): hostname of the power switch

  • index (int): number of the port to switch

The model property selects one of several backend implementations. Currently available are:

apc

Controls an APU PDU via SNMP.

digipower

Controls a DigiPower PDU via a simple HTTP API.

digitalloggers_http

Control a Digital Loggers PDU that use the legacy HTTP API. Note that host argument must include the protocol, such as http://192.168.0.3 or http://admin:pass@192.168.0.4.

eaton

Controls Eaton ePDUs via SNMP.

eg_pms2_network

Controls the EG_PMS2_LAN & EG_PMS2_WLAN devices, through simple HTTP POST and GET requests. The device requires a password for logging into the control interface, this module deliberately uses the standard password ‘1’ and is not compatible with a different password.

gude

Controls a Gude PDU via a simple HTTP API.

gude24

Controls a Gude Expert Power Control 8008 PDU via a simple HTTP API.

gude8031

Controls a Gude Expert Power Control 8031 PDU via a simple HTTP API.

gude8225

Controls a Gude Expert Power Control 8225 PDU via a simple HTTP API.

gude8316

Controls a Gude Expert Power Control 8316 PDU via a simple HTTP API.

netio

Controls a NETIO 4-Port PDU via a simple HTTP API.

netio_kshell

Controls a NETIO 4C PDU via a Telnet interface.

raritan

Controls Raritan PDUs via SNMP.

rest

This is a generic backend for PDU implementations which can be controlled via HTTP PUT and GET requests. See the docstring in the module for details.

sentry

Controls a Sentry PDU via SNMP using Sentry3-MIB. It was tested on CW-24VDD and 4805-XLS-16.

shelly_gen1

Controls relays of Shelly devices using the Gen 1 Device API. See the docstring in the module for details.

siglent

Controls Siglent SPD3000X series modules via the vxi11 Python module.

simplerest

This is a generic backend for PDU implementations which can be controlled via HTTP GET requests (both set and get). See the docstring in the module for details.

tplink

Controls TP-Link power strips via python-kasa.

Used by:

PDUDaemonPort

A PDUDaemonPort describes a PDU port accessible via PDUDaemon. As one PDUDaemon instance can control many PDUs, the instance name from the PDUDaemon configuration file needs to be specified.

PDUDaemonPort:
  host: pduserver
  pdu: apc-snmpv3-noauth
  index: 1

The example describes port 1 on the PDU configured as apc-snmpv3-noauth, with PDUDaemon running on the host pduserver.

Arguments:

  • host (str): name of the host running the PDUDaemon

  • pdu (str): name of the PDU in the configuration file

  • index (int): index of the power port on the PDU

Used by:

YKUSHPowerPort

A YKUSHPowerPort describes a YEPKIT YKUSH USB (HID) switchable USB hub.

YKUSHPowerPort:
  serial: YK12345
  index: 1

The example describes port 1 on the YKUSH USB hub with the serial “YK12345”. (use “pykush -l” to get your serial…)

Arguments:

  • serial (str): serial number of the YKUSH hub

  • index (int): number of the port to switch

Used by:

USBPowerPort

A USBPowerPort describes a generic switchable USB hub as supported by uhubctl.

USBPowerPort:
  match:
    ID_PATH: pci-0000:00:14.0-usb-0:2:1.0
  index: 1

The example describes port 1 on the hub with the ID_PATH “pci-0000:00:14.0-usb-0:2:1.0”. (use udevadm info /sys/bus/usb/devices/... to find the ID_PATH value)

Arguments:

  • index (int): number of the port to switch

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

Note

Labgrid requires that the interface is contained in the ID_PATH. This usually means that the ID_PATH should end with :1.0. Only this first interface is registered with the hub driver labgrid is looking for, paths without the interface will fail to match since they use the usb driver.

SiSPMPowerPort

A SiSPMPowerPort describes a GEMBIRD SiS-PM as supported by sispmctl.

SiSPMPowerPort:
  match:
    ID_PATH: platform-1c1a400.usb-usb-0:2
  index: 1

The example describes port 1 on the hub with the ID_PATH “platform-1c1a400.usb-usb-0:2”.

Arguments:

  • index (int): number of the port to switch

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

TasmotaPowerPort

A TasmotaPowerPort resource describes a switchable Tasmota power outlet accessed over MQTT.

TasmotaPowerPort:
  host: this.is.an.example.host.com
  status_topic: stat/tasmota_575A2B/POWER
  power_topic: cmnd/tasmota_575A2B/POWER
  avail_topic: tele/tasmota_575A2B/LWT

The example uses a mosquitto server at “this.is.an.example.host.com” and has the topics setup for a tasmota power port that has the ID 575A2B.

Arguments:

  • host (str): hostname of the MQTT server

  • status_topic (str): topic that signals the current status as “ON” or “OFF”

  • power_topic (str): topic that allows switching the status between “ON” and “OFF”

  • avail_topic (str): topic that signals the availability of the Tasmota power outlet

Used by:

Digital Outputs

ModbusTCPCoil

A ModbusTCPCoil describes a coil accessible via ModbusTCP.

ModbusTCPCoil:
  host: "192.168.23.42"
  coil: 1

The example describes the coil with the address 1 on the ModbusTCP device 192.168.23.42.

Arguments:

  • host (str): hostname of the Modbus TCP server e.g. “192.168.23.42:502”

  • coil (int): index of the coil e.g. 3

  • invert (bool, default=False): whether the logic level is inverted (active-low)

  • write_multiple_coils (bool, default=False): whether to perform write using “write multiple coils” method instead of “write single coil”

Used by:

DeditecRelais8

A DeditecRelais8 describes a Deditec USB GPO module with 8 relays.

DeditecRelais8:
  index: 1
  invert: false
  match:
    ID_PATH: pci-0000:00:14.0-usb-0:2:1.0
Arguments:

  • index (int): number of the relay to use

  • invert (bool, default=False): whether the logic level is inverted (active-low)

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

OneWirePIO

A OneWirePIO describes a onewire programmable I/O pin.

OneWirePIO:
  host: example.computer
  path: /29.7D6913000000/PIO.0
  invert: false

The example describes a PIO.0 at device address 29.7D6913000000 via the onewire server on example.computer.

Arguments:

  • host (str): hostname of the remote system running the onewire server

  • path (str): path on the server to the programmable I/O pin

  • invert (bool, default=False): whether the logic level is inverted (active-low)

Used by:

LXAIOBusPIO

An LXAIOBusPIO resource describes a single PIO pin on an LXAIOBusNode.

LXAIOBusPIO:
  host: localhost:8080
  node: IOMux-00000003
  pin: OUT0
  invert: False

The example uses an lxa-iobus-server running on localhost:8080, with node IOMux-00000003 and pin OUT0.

Arguments:

  • host (str): hostname with port of the lxa-io-bus server

  • node (str): name of the node to use

  • pin (str): name of the pin to use

  • invert (bool, default=False): whether to invert the pin

Used by:

NetworkLXAIOBusPIO

A NetworkLXAIOBusPIO describes an LXAIOBusPIO exported over the network.

HIDRelay

An HIDRelay resource describes a single output of a HID protocol based USB relays. It currently supports the widely used “dcttech USBRelay”.

HIDRelay:
  index: 2
  invert: False
  match:
    ID_PATH: pci-0000:00:14.0-usb-0:2:1.0
Arguments:

  • index (int, default=1): number of the relay to use

  • invert (bool, default=False): whether to invert the relay

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkHIDRelay

A NetworkHIDRelay describes an HIDRelay exported over the network.

NetworkService

A NetworkService describes a remote SSH connection.

NetworkService:
  address: example.computer
  username: root

The example describes a remote SSH connection to the computer example.computer with the username root. Set the optional password password property to make SSH login with a password instead of the key file.

When used with labgrid-exporter, the address can contain a device scope suffix (such as %eth1), which is especially useful with overlapping address ranges or link-local IPv6 addresses. In that case, the SSH connection will be proxied via the exporter, using socat and the labgrid-bound-connect sudo helper. These and the sudo configuration needs to be prepared by the administrator.

Arguments:

  • address (str): hostname of the remote system

  • username (str): username used by SSH

  • password (str, default=””): password used by SSH

  • port (int, default=22): port used by SSH

Used by:

USBMassStorage

A USBMassStorage resource describes a USB memory stick or similar device.

USBMassStorage:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0-scsi-0:0:0:3
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkUSBMassStorage

A NetworkUSBMassStorage resource describes a USB memory stick or similar device available on a remote computer.

Used by:

The NetworkUSBMassStorage can be used in test cases by calling the write_image(), and get_size() functions.

SigrokDevice

A SigrokDevice resource describes a sigrok device. To select a specific device from all connected supported devices use the SigrokUSBDevice.

SigrokDevice:
  driver: fx2lafw
  channels: "D0=CLK,D1=DATA"
Arguments:

  • driver (str): name of the sigrok driver to use

  • channels (str): optional, channel mapping as described in the sigrok-cli man page

Used by:

IMXUSBLoader

An IMXUSBLoader resource describes a USB device in the imx loader state.

IMXUSBLoader:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

MXSUSBLoader

An MXSUSBLoader resource describes a USB device in the mxs loader state.

MXSUSBLoader:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

RKUSBLoader

An RKUSBLoader resource describes a USB device in the rockchip loader state.

RKUSBLoader:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkMXSUSBLoader

A NetworkMXSUSBLoader describes an MXSUSBLoader available on a remote computer.

NetworkIMXUSBLoader

A NetworkIMXUSBLoader describes an IMXUSBLoader available on a remote computer.

NetworkRKUSBLoader

A NetworkRKUSBLoader describes an RKUSBLoader available on a remote computer.

AndroidUSBFastboot

An AndroidUSBFastboot resource describes a USB device in the fastboot state. Previously, this resource was named AndroidFastboot and this name still supported for backwards compatibility.

AndroidUSBFastboot:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • usb_vendor_id (str, default=”1d6b”): USB vendor ID to be compared with the ID_VENDOR_ID udev property

  • usb_product_id (str, default=”0104”): USB product ID, to be compared with the ID_MODEL_ID udev property

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

AndroidNetFastboot

An AndroidNetFastboot resource describes a network device in fastboot state.

AndroidNetFastboot:
  address: "192.168.23.42"
Arguments:

  • address (str): ip address of the fastboot device

  • port (int, default=5554): udp/tcp fastboot port that is used in the device. (e.g. Barebox uses port 5554)

  • protocol (str, default=”udp”): which protocol should be used when issuing fastboot commands. (Barebox supports currently only the udp protocol)

Used by:

DFUDevice

A DFUDevice resource describes a USB device in DFU (Device Firmware Upgrade) mode.

DFUDevice:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkInterface

A NetworkInterface resource describes a network adapter (such as Ethernet or WiFi)

NetworkInterface:
  ifname: eth0
Arguments:

  • ifname (str): name of the interface

USBNetworkInterface

A USBNetworkInterface resource describes a USB network adapter (such as Ethernet or WiFi)

USBNetworkInterface:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

RemoteNetworkInterface

A RemoteNetworkInterface resource describes a NetworkInterface or USBNetworkInterface resource available on a remote computer.

AlteraUSBBlaster

An AlteraUSBBlaster resource describes an Altera USB blaster.

AlteraUSBBlaster:
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

USBDebugger

An USBDebugger resource describes a JTAG USB adapter (for example an FTDI FT2232H).

USBDebugger:
  match:
    ID_PATH: pci-0000:00:10.0-usb-0:1.4
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

SNMPEthernetPort

A SNMPEthernetPort resource describes a port on an Ethernet switch, which is accessible via SNMP.

SNMPEthernetPort:
  switch: "switch-012"
  interface: "17"
Arguments:

  • switch (str): host name of the Ethernet switch

  • interface (str): interface name

SigrokUSBDevice

A SigrokUSBDevice resource describes a sigrok USB device.

SigrokUSBDevice:
  driver: fx2lafw
  channels: "D0=CLK,D1=DATA"
  match:
    ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
Arguments:

  • driver (str): name of the sigrok driver to use

  • channels (str): optional, channel mapping as described in the sigrok-cli man page

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkSigrokUSBDevice

A NetworkSigrokUSBDevice resource describes a sigrok USB device connected to a host which is exported over the network. The SigrokDriver will access it via SSH.

SigrokUSBSerialDevice

A SigrokUSBSerialDevice resource describes a sigrok device which communicates of a USB serial port instead of being a USB device itself (see SigrokUSBDevice for that case).

SigrokUSBSerialDevice:
  driver: manson-hcs-3xxx
  match:
    '@ID_SERIAL_SHORT': P-00-02389
Arguments:

  • driver (str): name of the sigrok driver to use

  • channels (str): optional, channel mapping as described in the sigrok-cli man page

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

USBSDMuxDevice

A USBSDMuxDevice resource describes a Pengutronix USB-SD-Mux device.

USBSDMuxDevice:
  match:
    '@ID_PATH': pci-0000:00:14.0-usb-0:1.2
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkUSBSDMuxDevice

A NetworkUSBSDMuxDevice resource describes a USBSDMuxDevice available on a remote computer.

LXAUSBMux

A LXAUSBMux resource describes a Linux Automation GmbH USB-Mux device.

LXAUSBMux:
  match:
    '@ID_PATH': pci-0000:00:14.0-usb-0:1.2
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkLXAUSBMux

A NetworkLXAUSBMux resource describes a LXAUSBMux available on a remote computer.

USBSDWireDevice

A USBSDWireDevice resource describes a Tizen SD Wire device device.

USBSDWireDevice:
  match:
    '@ID_PATH': pci-0000:00:14.0-usb-0:1.2
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkUSBSDWireDevice

A NetworkUSBSDWireDevice resource describes a USBSDWireDevice available on a remote computer.

USBVideo

A USBVideo resource describes a USB video camera which is supported by a Video4Linux2 kernel driver.

USBVideo:
  match:
    '@ID_PATH': pci-0000:00:14.0-usb-0:1.2
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

SysfsGPIO

A SysfsGPIO resource describes a GPIO line.

SysfsGPIO:
  index: 12
Arguments:

  • index (int): index of the GPIO line

Used by:

NetworkUSBVideo

A NetworkUSBVideo resource describes a USBVideo resource available on a remote computer.

USBAudioInput

A USBAudioInput resource describes a USB audio input which is supported by an ALSA kernel driver.

USBAudioInput:
  match:
    ID_PATH: pci-0000:00:14.0-usb-0:3:1.0
Arguments:

  • index (int, default=0): ALSA PCM device number (as in hw:CARD=<card>,DEV=<index>)

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkUSBAudioInput

A NetworkUSBAudioInput resource describes a USBAudioInput resource available on a remote computer.

USBTMC

A USBTMC resource describes an oscilloscope connected via the USB TMC protocol. The low-level communication is handled by the usbtmc kernel driver.

USBTMC:
  match:
    '@ID_PATH': pci-0000:00:14.0-usb-0:1.2
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

A udev rules file may be needed to allow access for non-root users:

DRIVERS=="usbtmc", MODE="0660", GROUP="plugdev"
Used by:

NetworkUSBTMC

A NetworkUSBTMC resource describes a USBTMC resource available on a remote computer.

Flashrom

A Flashrom resource is used to configure the parameters to a local installed flashrom instance. It is assumed that flashrom is installed on the host and the executable is configured in:

tools:
  flashrom: '/usr/sbin/flashrom'
Arguments:

  • programmer (str): programmer device as described in -p, –programmer in man 8 flashrom

The resource must configure which programmer to use and the parameters to the programmer. The programmer parameter is passed directly to the flashrom bin hence man(8) flashrom can be used for reference. Below an example where the local spidev is used.

Flashrom:
  programmer: 'linux_spi:dev=/dev/spidev0.1,spispeed=30000'
Used by:

NetworkFlashRom

A NetworkFlashrom describes a Flashrom available on a remote computer.

USBFlashableDevice

Represents an “opaque” USB device used by custom flashing programs. There is usually not anything useful that can be done with the interface other than running a flashing program with FlashScriptDriver.

Note

This resource is only intended to be used as a last resort when it is impossible or impractical to use a different resource

USBFlashableDevice:
  match:
    SUBSYSTEM: usb
    ID_SERIAL: '1234'
Arguments:

  • match (dict): key and value pairs for a udev match, see udev Matching

Used by:

NetworkUSBFlashableDevice

A NetworkUSBFlashableDevice resource describes a USBFlashableDevice resource available on a remote computer

Used by:

DediprogFlasher

A DediprogFlasher resource is used to configure the parameters to a locally installed dpmcd instance. It is assumed that dpcmd is installed on the host and the executable can be configured via:

tools:
  dpcmd: '/usr/sbin/dpcmd'
Arguments:

  • vcc (str): ‘3.5V’, ‘2.5V’ or ‘1.8V’.

For instance, to flash using 3.5V vcc:

DediprogFlasher:
  vcc: '3.5V'
Used by:

NetworkDediprogFlasher

A NetworkDediprogFlasher describes a DediprogFlasher available on a remote computer.

XenaManager

A XenaManager resource describes a Xena Manager instance which is the instance the XenaDriver must connect to in order to configure a Xena chassis.

XenaManager:
  hostname: "example.computer"
Arguments:

  • hostname (str): hostname or IP of the management address of the Xena tester

Used by:

PyVISADevice

A PyVISADevice resource describes a test stimuli device controlled by PyVISA. Such device could be a signal generator.

PyVISADevice:
  type: "TCPIP"
  url: "192.168.110.11"
Arguments:

  • type (str): device resource type following the pyVISA resource syntax, e.g. ASRL, TCPIP…

  • url (str): device identifier on selected resource, e.g. <ip> for TCPIP resource

Used by:

HTTPVideoStream

A HTTPVideoStream resource describes a IP video stream over HTTP or HTTPS.

HTTPVideoStream:
  url: http://192.168.110.11/0.ts
Arguments:

  • url (str): URI of the IP video stream

Used by:

Providers

Providers describe directories that are accessible by the target over a specific protocol. This is useful for software installation in the bootloader (via TFTP) or downloading update artifacts under Linux (via HTTP).

They are used with the ManagedFile helper, which ensures that the file is available on the server and then creates a symlink from the internal directory to the uploaded file. The path for the target is generated by replacing the internal prefix with the external prefix.

For now, the TFTP/NFS/HTTP server needs to be configured before using it from labgrid.

TFTPProvider / NFSProvider / HTTPProvider

TFTPProvider:
  internal: "/srv/tftp/board-23/"
  external: "board-23/"

HTTPProvider:
  internal: "/srv/www/board-23/"
  external: "http://192.168.1.1/board-23/"
Arguments:

  • internal (str): path prefix to the local directory accessible by the target

  • external (str): corresponding path prefix for use by the target

Used by:

RemoteTFTPProvider / RemoteNFSProvider / RemoteHTTPProvider

These describe a TFTPProvider, NFSProvider or HTTPProvider resource available on a remote computer

Used by:

RemotePlace

A RemotePlace describes a set of resources attached to a labgrid remote place.

RemotePlace:
  name: example-place

The example describes the remote place example-place. It will connect to the labgrid remote coordinator, wait until the resources become available and expose them to the internal environment.

Arguments:

  • name (str): name or pattern of the remote place

Used by:

  • potentially all drivers

DockerDaemon

A DockerDaemon describes where to contact a docker daemon process. DockerDaemon also participates in managing NetworkService instances created through interaction with that daemon.

DockerDaemon:
  docker_daemon_url: unix://var/run/docker.sock

The example describes a docker daemon accessible via the ‘/var/run/docker.sock’ unix socket. When used by a DockerDriver, the DockerDriver will first create a docker container which the DockerDaemon resource will subsequently use to create one/more NetworkService instances - as specified by DockerDriver configuration. Each NetworkService instance corresponds to a network service running inside the container.

Moreover, DockerDaemon will remove any hanging containers if DockerDaemon is used several times in a row - as is the case when executing test suites. Normally DockerDriver - when deactivated - cleans up the created docker container; programming errors, keyboard interrupts or unix kill signals may lead to hanging containers, however; therefore auto-cleanup is important.

Arguments:

  • docker_daemon_url (str): The url of the daemon to use for this target

Used by:

udev Matching

labgrid allows the exporter (or the client-side environment) to match resources via udev rules. Any udev property key and value can be used, path matching USB devices is allowed as well. The udev resources become available as soon as they are plugged into the computer running the exporter.

The initial matching and monitoring for udev events is handled by the UdevManager class. This manager is automatically created when a resource derived from USBResource (such as USBSerialPort, IMXUSBLoader or AndroidUSBFastboot) is instantiated.

To identify the kernel device which corresponds to a configured USBResource, each existing (and subsequently added) kernel device is matched against the configured resources. This is based on a list of match entries which must all be tested successfully against the potential kernel device. Match entries starting with an @ are checked against the device’s parents instead of itself; here one matching parent causes the check to be successful.

A given USBResource class has builtin match entries that are checked first, for example that the SUBSYSTEM is tty as in the case of the USBSerialPort. Only if these succeed, match entries provided by the user for the resource instance are considered.

In addition to the properties reported by udevadm monitor --udev --property, elements of the ATTR(S){} dictionary (as shown by udevadm info <device> -a) are useable as match keys. Finally sys_name allows matching against the name of the directory in sysfs. All match entries must succeed for the device to be accepted.

labgrid provides a small utility called labgrid-suggest which will output the proper YAML formatted snippets for you. These snippets can be added under the resource key in an environment configuration or under their own entries in an exporter configuration file.

As the USB bus number can change depending on the kernel driver initialization order, it is better to use the ID_PATH instead of sys_name for USB devices.

In the default udev configuration, ID_PATH is not available for all USB devices, but that can be changed by creating a udev rules file:

SUBSYSTEMS=="usb", IMPORT{builtin}="path_id"

The following examples show how to use the udev matches for some common use-cases.

Matching a USB Serial Converter on a Hub Port

This will match any USB serial converter connected below the hub port 1.2.5.5 on bus 1. The ID_PATH value corresponds to the hierarchy of buses and ports as shown with udevadm info /dev/ttyUSB0.

USBSerialPort:
  match:
    '@ID_PATH': pci-0000:05:00.0-usb-0:1.2.5.5

Note the @ in the @ID_PATH match, which applies this match to the device’s parents instead of directly to itself. This is necessary for the USBSerialPort because we actually want to find the ttyUSB? device below the USB serial converter device.

Matching an Android USB Fastboot Device

In this case, we want to match the USB device on that port directly, so we don’t use a parent match.

AndroidUSBFastboot:
  match:
    ID_PATH: pci-0000:05:00.0-usb-0:1.2.3

Matching a Specific UART in a Dual-Port Adapter

On this board, the serial console is connected to the second port of an on-board dual-port USB-UART. The board itself is connected to the bus 3 and port path 10.2.2.2. The correct value can be shown by running udevadm info /dev/ttyUSB9 in our case:

$ udevadm info /dev/ttyUSB9
P: /devices/pci0000:00/0000:00:14.0/usb3/3-10/3-10.2/3-10.2.2/3-10.2.2.2/3-10.2.2.2:1.1/ttyUSB9/tty/ttyUSB9
N: ttyUSB9
S: serial/by-id/usb-FTDI_Dual_RS232-HS-if01-port0
S: serial/by-path/pci-0000:00:14.0-usb-0:10.2.2.2:1.1-port0
E: DEVLINKS=/dev/serial/by-id/usb-FTDI_Dual_RS232-HS-if01-port0 /dev/serial/by-path/pci-0000:00:14.0-usb-0:10.2.2.2:1.1-port0
E: DEVNAME=/dev/ttyUSB9
E: DEVPATH=/devices/pci0000:00/0000:00:14.0/usb3/3-10/3-10.2/3-10.2.2/3-10.2.2.2/3-10.2.2.2:1.1/ttyUSB9/tty/ttyUSB9
E: ID_BUS=usb
E: ID_MODEL=Dual_RS232-HS
E: ID_MODEL_ENC=Dual\x20RS232-HS
E: ID_MODEL_FROM_DATABASE=FT2232C Dual USB-UART/FIFO IC
E: ID_MODEL_ID=6010
E: ID_PATH=pci-0000:00:14.0-usb-0:10.2.2.2:1.1
E: ID_PATH_TAG=pci-0000_00_14_0-usb-0_10_2_2_2_1_1
E: ID_REVISION=0700
E: ID_SERIAL=FTDI_Dual_RS232-HS
E: ID_TYPE=generic
E: ID_USB_DRIVER=ftdi_sio
E: ID_USB_INTERFACES=:ffffff:
E: ID_USB_INTERFACE_NUM=01
E: ID_VENDOR=FTDI
E: ID_VENDOR_ENC=FTDI
E: ID_VENDOR_FROM_DATABASE=Future Technology Devices International, Ltd
E: ID_VENDOR_ID=0403
E: MAJOR=188
E: MINOR=9
E: SUBSYSTEM=tty
E: TAGS=:systemd:
E: USEC_INITIALIZED=9129609697

We use the ID_USB_INTERFACE_NUM to distinguish between the two ports:

USBSerialPort:
  match:
    '@ID_PATH': pci-0000:05:00.0-usb-2:10.2.2.2'
    ID_USB_INTERFACE_NUM: '01'

Matching a USB UART by Serial Number

Most of the USB serial converters in our lab have been programmed with unique serial numbers. This makes it easy to always match the same one even if the USB topology changes or a board has been moved between host systems.

USBSerialPort:
  match:
    ID_SERIAL_SHORT: P-00-03564

To check if your device has a serial number, you can use udevadm info:

$ udevadm info /dev/ttyUSB5 | grep SERIAL_SHORT
E: ID_SERIAL_SHORT=P-00-03564

In the background, the additional properties are provided by the builtin usb_id udev helper:

$ udevadm test-builtin usb_id /sys/class/tty/ttyUSB0
Load module index
Parsed configuration file /lib/systemd/network/99-default.link
Parsed configuration file /lib/systemd/network/73-usb-net-by-mac.link
Created link configuration context.
ID_VENDOR=Silicon_Labs
ID_VENDOR_ENC=Silicon\x20Labs
ID_VENDOR_ID=10c4
ID_MODEL=CP2102_USB_to_UART_Bridge_Controller
ID_MODEL_ENC=CP2102\x20USB\x20to\x20UART\x20Bridge\x20Controller
ID_MODEL_ID=ea60
ID_REVISION=0100
ID_SERIAL=Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_P-00-03564
ID_SERIAL_SHORT=P-00-03564
ID_TYPE=generic
ID_BUS=usb
ID_USB_INTERFACES=:ff0000:
ID_USB_INTERFACE_NUM=00
ID_USB_DRIVER=cp210x
Unload module index
Unloaded link configuration context.

Drivers

SerialDriver

A SerialDriver connects to a serial port. It requires one of the serial port resources.

Binds to:
port:
SerialDriver:
  txdelay: 0.05
Implements:
Arguments:

  • txdelay (float, default=0.0): time in seconds to wait before sending each byte

  • timeout (float, default=3.0): time in seconds to wait for a network serial port before an error occurs

ModbusRTUDriver

A ModbusRTUDriver connects to a ModbusRTU resource. This driver only supports local usage and will not work with an exporter.

ModbusRTUDriver: {}
Binds to:
port:

ShellDriver

A ShellDriver binds on top of a ConsoleProtocol and is designed to interact with a login prompt and a Linux shell.

Binds to:
console:
Implements:
ShellDriver:
  prompt: 'root@\w+:[^ ]+ '
  login_prompt: ' login: '
  username: root
Arguments:

  • prompt (regex): shell prompt to match after logging in

  • login_prompt (regex): match for the login prompt

  • username (str): username to use during login

  • password (str): optional, password to use during login

  • keyfile (str): optional, keyfile to upload after login, making the SSHDriver usable

  • login_timeout (int, default=60): timeout for login prompt detection in seconds

  • await_login_timeout (int, default=2): time in seconds of silence that needs to pass before sending a newline to device.

  • console_ready (regex): optional, pattern used by the kernel to inform the user that a console can be activated by pressing enter.

  • post_login_settle_time (int, default=0): seconds of silence after logging in before check for a prompt. Useful when the console is interleaved with boot output which may interrupt prompt detection.

Note

bash >= 5.1 enables bracketed-paste mode by default, allowing the terminal emulator to tell a program whether input was typed or pasted. To achieve this, \e[?2004h is inserted when user input is expected, enabling paste detection.

Add \x1b\[\?2004h at the beginning of the prompt argument to allow the ShellDriver to still match the prompt in this case.

SSHDriver

A SSHDriver requires a NetworkService resource and allows the execution of commands and file upload via network. It uses SSH’s ServerAliveInterval option to detect failed connections.

If a shared SSH connection to the target is already open, it will reuse it when running commands. In that case, ServerAliveInterval should be set outside of labgrid, as it cannot be enabled for an existing connection.

Binds to:
networkservice:
Implements:
SSHDriver:
  keyfile: example.key
Arguments:

  • keyfile (str): optional, filename of private key to login into the remote system (has precedence over NetworkService’s password)

  • stderr_merge (bool, default=False): set to True to make run() return stderr merged with stdout, and an empty list as second element.

  • connection_timeout (float, default=30.0): timeout when trying to establish connection to target.

  • explicit_sftp_mode (bool, default=False): if set to True, put() and get() will explicitly use the SFTP protocol for file transfers instead of scp’s default protocol

UBootDriver

A UBootDriver interfaces with a U-Boot bootloader via a ConsoleProtocol.

Binds to:
console:
Implements:
UBootDriver:
  prompt: 'Uboot> '
  boot_commands:
    net: run netboot
    spi: run spiboot
Arguments:

  • prompt (regex, default=””): U-Boot prompt to match

  • autoboot (regex, default=”stop autoboot”): autoboot message to match

  • password (str): optional, U-Boot unlock password

  • interrupt (str, default=”\n”): string to interrupt autoboot (use “\x03” for CTRL-C)

  • init_commands (tuple): optional, tuple of commands to execute after matching the prompt

  • password_prompt (str, default=”enter Password: “): regex to match the U-Boot password prompt

  • bootstring (str): optional, regex to match on Linux Kernel boot

  • boot_command (str, default=”run bootcmd”): boot command for booting target

  • boot_commands (dict, default={}): boot commands by name for LinuxBootProtocol boot command

  • login_timeout (int, default=30): timeout for login prompt detection in seconds

  • boot_timeout (int, default=30): timeout for initial Linux Kernel version detection

SmallUBootDriver

A SmallUBootDriver interfaces with stripped-down U-Boot variants that are sometimes used in cheap consumer electronics.

SmallUBootDriver is meant as a driver for U-Boot with only little functionality compared to a standard U-Boot. Especially is copes with the following limitations:

  • The U-Boot does not have a real password-prompt but can be activated by entering a “secret” after a message was displayed.

  • The command line does not have a built-in echo command. Thus this driver uses ‘Unknown Command’ messages as marker before and after the output of a command.

  • Since there is no echo we cannot return the exit code of the command. Commands will always return 0 unless the command was not found.

This driver needs the following features activated in U-Boot to work:

  • The U-Boot must not have a real password prompt. Instead it must be keyword activated. For example it should be activated by a dialog like the following:

    • U-Boot: “Autobooting in 1s…”

    • labgrid: “secret”

    • U-Boot: <switching to console>

  • The U-Boot must be able to parse multiple commands in a single line separated by “;”.

  • The U-Boot must support the “bootm” command to boot from a memory location.

Binds to:
Implements:
SmallUBootDriver:
  prompt: 'ap143-2\.0> '
  boot_expression: 'Autobooting in 1 seconds'
  boot_secret: "tpl"
Arguments:

  • boot_expression (str, default=”U-Boot 20\d+”): regex to match the U-Boot start string

  • boot_secret (str, default=”a”): secret used to unlock prompt

  • login_timeout (int, default=60): timeout for password/login prompt detection

  • for other arguments, see UBootDriver

BareboxDriver

A BareboxDriver interfaces with a barebox bootloader via a ConsoleProtocol.

Binds to:
console:
Implements:
BareboxDriver:
  prompt: 'barebox@[^:]+:[^ ]+ '
Arguments:

  • prompt (regex, default=””): barebox prompt to match

  • autoboot (regex, default=”stop autoboot”): autoboot message to match

  • interrupt (str, default=”\n”): string to interrupt autoboot (use “\x03” for CTRL-C)

  • bootstring (regex, default=”Linux version \d”): regex that indicating that the Linux Kernel is booting

  • password (str): optional, password to use for access to the shell

  • login_timeout (int, default=60): timeout for access to the shell

ExternalConsoleDriver

An ExternalConsoleDriver implements the ConsoleProtocol on top of a command executed on the local computer.

Implements:
ExternalConsoleDriver:
  cmd: 'microcom /dev/ttyUSB2'
  txdelay: 0.05
Arguments:

  • cmd (str): command to execute and then bind to.

  • txdelay (float, default=0.0): time in seconds to wait before sending each byte

AndroidFastbootDriver

An AndroidFastbootDriver allows the upload of images to a device in the USB or network fastboot state.

Binds to:
fastboot:
Implements:

  • None (yet)

AndroidFastbootDriver:
  boot_image: mylocal.image
  sparse_size: 100M
Arguments:

  • boot_image (str): optional, image key referring to the image to boot

  • flash_images (dict): optional, partition to image key mapping referring to images to flash to the device

  • sparse_size (str): optional, sparse files greater than given size (see fastboot manpage -S option for allowed size suffixes). The default is the same as the fastboot default, which is computed after querying the target’s max-download-size variable.

DFUDriver

A DFUDriver allows the download of images to a device in DFU (Device Firmware Upgrade) mode.

Binds to:
dfu:
Implements:

  • None (yet)

DFUDriver: {}
Arguments:

  • None

OpenOCDDriver

An OpenOCDDriver controls OpenOCD to bootstrap a target with a bootloader.

Note that OpenOCD supports specifying USB paths since a1b308ab which was released with v0.11. The OpenOCDDriver passes the resource’s USB path. Depending on which OpenOCD version is installed it is either used correctly or a warning is displayed and the first resource seen is used, which might be the wrong USB device. Consider updating your OpenOCD version when using multiple USB Blasters.

Binds to:
interface:
Implements:
OpenOCDDriver:
  config: local-settings.cfg
  image: bitstream
  interface_config: ftdi/lambdaconcept_ecpix-5.cfg
  board_config: lambdaconcept_ecpix-5.cfg
  load_commands:
  - "init"
  - "svf -quiet {filename}"
  - "exit"
Arguments:

  • config (str/list): optional, OpenOCD configuration file(s)

  • search (str): optional, include search path for scripts

  • image (str): optional, name of the image to bootstrap onto the device

  • interface_config (str): optional, interface config in the openocd/scripts/interface/ directory

  • board_config (str): optional, board config in the openocd/scripts/board/ directory

  • load_commands (list of str): optional, load commands to use instead of init, bootstrap {filename}, shutdown

QuartusHPSDriver

A QuartusHPSDriver controls the “Quartus Prime Programmer and Tools” to flash a target’s QSPI.

Binds to:
Implements:

  • None

Arguments:

  • image (str): optional, filename of image to write into QSPI flash

The driver can be used in test cases by calling the flash function. An example strategy is included in labgrid.

ManualPowerDriver

A ManualPowerDriver requires the user to control the target power states. This is required if a strategy is used with the target, but no automatic power control is available.

The driver’s name will be displayed during interaction.

Implements:
ManualPowerDriver:
  name: 'example-board'
Arguments:

  • None

ExternalPowerDriver

An ExternalPowerDriver is used to control a target power state via an external command.

Implements:
ExternalPowerDriver:
  cmd_on: example_command on
  cmd_off: example_command off
  cmd_cycle: example_command cycle
Arguments:

  • cmd_on (str): command to turn power to the board on

  • cmd_off (str): command to turn power to the board off

  • cmd_cycle (str): optional command to switch the board off and on

  • delay (float, default=2.0): delay in seconds between off and on, if cmd_cycle is not set

NetworkPowerDriver

A NetworkPowerDriver controls a NetworkPowerPort, allowing control of the target power state without user interaction.

Binds to:
port:
Implements:
NetworkPowerDriver:
  delay: 5.0
Arguments:

  • delay (float, default=2.0): delay in seconds between off and on

PDUDaemonDriver

A PDUDaemonDriver controls a PDUDaemonPort, allowing control of the target power state without user interaction.

Note

PDUDaemon processes commands in the background, so the actual state change may happen several seconds after calls to PDUDaemonDriver return.

Binds to:
port:
Implements:
PDUDaemonDriver:
  delay: 5.0
Arguments:

  • delay (float, default=5.0): delay in seconds between off and on

YKUSHPowerDriver

A YKUSHPowerDriver controls a YKUSHPowerPort, allowing control of the target power state without user interaction.

Binds to:
port:
Implements:
YKUSHPowerDriver:
  delay: 5.0
Arguments:

  • delay (float, default=2.0): delay in seconds between off and on

DigitalOutputPowerDriver

A DigitalOutputPowerDriver can be used to control the power of a device using a DigitalOutputDriver.

Using this driver you probably want an external relay to switch the power of your DUT.

Binds to:
output:
DigitalOutputPowerDriver:
  delay: 2.0
Arguments:

  • delay (float, default=1.0): delay in seconds between off and on

USBPowerDriver

A USBPowerDriver controls a USBPowerPort, allowing control of the target power state without user interaction.

Binds to:
Implements:
USBPowerDriver:
  delay: 5.0
Arguments:

  • delay (float, default=2.0): delay in seconds between off and on

SiSPMPowerDriver

A SiSPMPowerDriver controls a SiSPMPowerPort, allowing control of the target power state without user interaction.

Binds to:
Implements:
SiSPMPowerDriver:
  delay: 5.0
Arguments:

  • delay (float, default=2.0): delay in seconds between off and on

TasmotaPowerDriver

A TasmotaPowerDriver controls a TasmotaPowerPort, allowing the outlet to be switched on and off.

Binds to:
Implements:
TasmotaPowerDriver:
  delay: 5.0
Arguments:

  • delay (float, default=2.0): delay in seconds between off and on

GpioDigitalOutputDriver

The GpioDigitalOutputDriver writes a digital signal to a GPIO line.

This driver configures GPIO lines via the sysfs kernel interface <https://www.kernel.org/doc/html/latest/gpio/sysfs.html>. While the driver automatically exports the GPIO, it does not configure it in any other way than as an output.

Binds to:
Implements:
GpioDigitalOutputDriver: {}
Arguments:

  • None

SerialPortDigitalOutputDriver

The SerialPortDigitalOutputDriver makes it possible to use a UART as a 1-Bit general-purpose digital output.

This driver acts on top of a SerialDriver and uses the its pyserial port to control the flow control lines.

Implements:
SerialPortDigitalOutputDriver:
  signal: "dtr"
  bindings: { serial : "nameOfSerial" }
Arguments:

  • signal (str): control signal to use: “dtr” or “rts”

  • invert (bool): whether to invert the signal

  • bindings (dict): optional, a named resource of the type SerialDriver to bind against. This is only needed if you have multiple SerialDriver in your environment (what is likely to be the case if you are using this driver).

FileDigitalOutputDriver

The FileDigitalOutputDriver uses a file to write arbitrary string representations of booleans to a file and read from it.

The file is checked to exist at configuration time.

If the file’s content does not match any of the representations reading defaults to False.

A prime example for using this driver is Linux’s sysfs.

Implements:
FileDigitalOutputDriver:
  filepath: "/sys/class/leds/myled/brightness"
Arguments:

  • filepath (str): file that is used for reads and writes.

  • false_repr (str, default=”0\n”): representation for False

  • true_repr (str, default=”1\n”): representation for True

DigitalOutputResetDriver

A DigitalOutputResetDriver uses a DigitalOutput to reset the target.

Binds to:
output:
Implements:
DigitalOutputResetDriver:
  delay: 2.0
Arguments:

  • delay (float, default=1.0): delay in seconds between setting the output 0 and 1.

ModbusCoilDriver

A ModbusCoilDriver controls a ModbusTCPCoil resource. It can set and get the current state of the resource.

Binds to:
coil:
Implements:
ModbusCoilDriver: {}
Arguments:

  • None

HIDRelayDriver

A HIDRelayDriver controls a HIDRelay or NetworkHIDRelay resource. It can set and get the current state of the resource.

Binds to:
relay:
Implements:
HIDRelayDriver: {}
Arguments:

  • None

ManualSwitchDriver

A ManualSwitchDriver requires the user to control a switch or jumper on the target. This can be used if a driver binds to a DigitalOutputProtocol, but no automatic control is available.

Implements:
ManualSwitchDriver:
  description: 'Jumper 5'
Arguments:

  • description (str): optional, description of the switch or jumper on the target

DeditecRelaisDriver

A DeditecRelaisDriver controls a Deditec relay resource. It can set and get the current state of the resource.

Binds to:
relais:
Implements:
DeditecRelaisDriver: {}
Arguments:

  • None

MXSUSBDriver

A MXUSBDriver is used to upload an image into a device in the mxs USB loader state. This is useful to bootstrap a bootloader onto a device.

Binds to:
loader:
Implements:
targets:
  main:
    drivers:
      MXSUSBDriver:
        image: mybootloaderkey

images:
  mybootloaderkey: path/to/mybootloader.img
Arguments:

  • image (str): optional, key in images containing the path of an image to bootstrap onto the target

IMXUSBDriver

A IMXUSBDriver is used to upload an image into a device in the imx USB loader state. This is useful to bootstrap a bootloader onto a device. This driver uses the imx-usb-loader tool from barebox.

Binds to:
loader:
Implements:
targets:
  main:
    drivers:
      IMXUSBDriver:
        image: mybootloaderkey

images:
  mybootloaderkey: path/to/mybootloader.img
Arguments:

  • image (str): optional, key in images containing the path of an image to bootstrap onto the target

BDIMXUSBDriver

The BDIMXUSBDriver is used to upload bootloader images into an i.MX device in the USB SDP mode. This driver uses the imx_usb tool by Boundary Devices. Compared to the IMXUSBLoader, it supports two-stage upload of U-Boot images. The images paths need to be specified from code instead of in the YAML environment, as the correct image depends on the system state.

Binds to:
loader:
Implements:
targets:
  main:
    drivers:
      BDIMXUSBDriver: {}
Arguments:

  • None

RKUSBDriver

A RKUSBDriver is used to upload an image into a device in the rockchip USB loader state. This is useful to bootstrap a bootloader onto a device.

Binds to:
loader:
Implements:
targets:
  main:
    drivers:
      RKUSBDriver:
        image: mybootloaderkey
        usb_loader: myloaderkey

images:
  mybootloaderkey: path/to/mybootloader.img
  myloaderkey: path/to/myloader.bin
Arguments:

  • image (str): optional, key in images containing the path of an image to bootstrap onto the target

  • usb_loader (str): optional, key in images containing the path of a first-stage bootloader image to write

UUUDriver

A UUUDriver is used to upload an image into a device in the NXP USB loader state. This is useful to bootstrap a bootloader onto a device.

Binds to:
loader:
Implements:
targets:
  main:
    drivers:
      UUUDriver:
        image: mybootloaderkey
        cmd: spl

images:
  mybootloaderkey: path/to/mybootloader.img
Arguments:

  • image (str): optional, key in images containing the path of an image to bootstrap onto the target

  • script (str): run built-in script with “uuu -b”, called with image as arg0

USBStorageDriver

A USBStorageDriver allows access to a USB stick or similar local or remote device.

Binds to:
Implements:

  • None (yet)

USBStorageDriver:
  image: flashimage

images:
  flashimage: ../images/myusb.image
Arguments:

  • image (str): optional, key in images containing the path of an image to write to the target

OneWirePIODriver

A OneWirePIODriver controls a OneWirePIO resource. It can set and get the current state of the resource.

Binds to:
port:
Implements:
OneWirePIODriver: {}
Arguments:

  • None

TFTPProviderDriver / NFSProviderDriver / HTTPProviderDriver

These drivers control their corresponding Provider resources, either locally or remotely.

Binds to:
provider:
TFTPProviderDriver: {}
Arguments:

  • None

The driver can be used in test cases by calling the stage() function, which returns the path to be used by the target.

QEMUDriver

The QEMUDriver allows the usage of a QEMU instance as a target. It requires several arguments, listed below. The kernel, flash, rootfs and dtb arguments refer to images and paths declared in the environment configuration.

Binds to:

  • None

QEMUDriver:
  qemu_bin: qemu_arm
  machine: vexpress-a9
  cpu: cortex-a9
  memory: 512M
  boot_args: "root=/dev/root console=ttyAMA0,115200"
  extra_args: ""
  kernel: kernel
  rootfs: rootfs
  dtb: dtb
  nic: user

tools:
  qemu_arm: /bin/qemu-system-arm
paths:
  rootfs: ../images/root
images:
  dtb: ../images/mydtb.dtb
  kernel: ../images/vmlinuz
Implements:
Arguments:

  • qemu_bin (str): reference to the tools key for the QEMU binary

  • machine (str): QEMU machine type

  • cpu (str): QEMU cpu type

  • memory (str): QEMU memory size (ends with M or G)

  • extra_args (str): extra QEMU arguments, they are passed directly to the QEMU binary

  • boot_args (str): optional, additional kernel boot argument

  • kernel (str): optional, reference to the images key for the kernel

  • disk (str): optional, reference to the images key for the disk image

  • flash (str): optional, reference to the images key for the flash image

  • rootfs (str): optional, reference to the paths key for use as the virtio-9p filesystem

  • dtb (str): optional, reference to the image key for the device tree

  • bios (str): optional, reference to the image key for the bios image

  • display (str, default=”none”): optional, display output to enable; must be one of: - none: Do not create a display device - fb-headless: Create a headless framebuffer device - egl-headless: Create a headless GPU-backed graphics card. Requires host support

  • nic (str): optional, configuration string to pass to QEMU to create a network interface

The QEMUDriver also requires the specification of:

  • a tool key, this contains the path to the QEMU binary

  • an image key, the path to the kernel image and optionally the dtb key to specify the build device tree

  • a path key, this is the path to the rootfs

SigrokDriver

The SigrokDriver uses a SigrokDevice resource to record samples and provides them during test runs.

Binds to:
sigrok:
Implements:

  • None yet

Arguments:

  • None

The driver can be used in test cases by calling the capture, stop and analyze functions.

SigrokPowerDriver

The SigrokPowerDriver uses a SigrokUSBSerialDevice resource to control a programmable power supply.

Binds to:
sigrok:
Implements:
SigrokPowerDriver:
  delay: 3.0
Arguments:

  • delay (float, default=3.0): delay in seconds between off and on

  • max_voltage (float): optional, maximum allowed voltage for protection against accidental damage (in volts)

  • max_current (float): optional, maximum allowed current for protection against accidental damage (in ampere)

USBSDMuxDriver

The USBSDMuxDriver uses a USBSDMuxDevice resource to control a USB-SD-Mux device via usbsdmux tool.

Implements:

  • None yet

Arguments:

  • None

The driver can be used in test cases by calling the set_mode() function with argument being dut, host, off, or client.

LXAUSBMuxDriver

The LXAUSBMuxDriver uses a LXAUSBMux resource to control a USB-Mux device via the usbmuxctl tool.

Implements:

  • None yet

Arguments:

  • None

The driver can be used in test cases by calling the set_links() function with a list containing one or more of “dut-device”, “host-dut” and “host-device”. Not all combinations can be configured at the same time.

USBSDWireDriver

The USBSDWireDriver uses a USBSDWireDevice resource to control a USB-SD-Wire device via sd-mux-ctrl tool.

Implements:

  • None yet

Arguments:

  • None

The driver can be used in test cases by calling the set_mode() function with argument being dut, host, off, or client.

USBVideoDriver

The USBVideoDriver is used to show a video stream from a remote USB video camera in a local window. It uses the GStreamer command line utility gst-launch on both sides to stream the video via an SSH connection to the exporter.

Binds to:
video:
Implements:
Arguments:

  • None

Although the driver can be used from Python code by calling the stream() method, it is currently mainly useful for the video subcommand of labgrid-client. It supports the Logitech HD Pro Webcam C920 with the USB ID 046d:082d and a few others. More cameras can be added to get_qualities() and get_pipeline() in labgrid/driver/usbvideodriver.py. Appropriate configuration parameters can be determined by using the GStreamer gst-device-monitor-1.0 command line utility.

USBAudioInputDriver

The USBAudioInputDriver is used to receive a audio stream from a local or remote USB audio input. It uses the GStreamer command line utility gst-launch on the sender side to stream the audio to the client. For remote resources, this is done via an SSH connection to the exporter. On the receiver, it either uses gst-launch for simple playback or gst-python for more complex cases (such as measuring the current volume level).

Binds to:
video:
Implements:

  • None yet

Arguments:

  • None

USBTMCDriver

The USBTMCDriver is used to control a oscilloscope via the USB TMC protocol.

Binds to:
tmc:
Implements:

  • None yet

Arguments:

  • None

Currently, it can be used by the labgrid-client tmc subcommands to show (and save) a screenshot, to show per channel measurements and to execute raw TMC commands. It only supports the Keysight DSO-X 2000 series (with the USB ID 0957:1798), but more devices can be added by extending on_activate() in labgrid/driver/usbtmcdriver.py and writing a corresponding backend in labgrid/driver/usbtmc/.

FlashromDriver

The FlashromDriver is used to flash a rom, using the flashrom utility.

FlashromDriver:
  image: 'foo'
images:
  foo: ../images/image_to_load.raw
Binds to:
flashrom_resource:
Implements:
Arguments:

  • image (str): optional, key in images containing the path of an image to bootstrap onto the target

The FlashromDriver allows using the linux util “flashrom” to write directly to a ROM e.g. a NOR SPI flash. The assumption is that the device flashing the DUT e.g. an exporter is wired to the Flash to be flashed. The driver implements the bootstrap protocol. The driver uses tool configuration section and the key: flashrom to determine the path of the installed flashrom utility.

FlashScriptDriver

The FlashScriptDriver is used to run a custom script or program to flash a device.

Note

This driver is only intended to be used as a last resort when it is impossible or impractical to use a different driver.

FlashScriptDriver:
  script: 'foo'
  args:
    - '{device.devnode}'

images:
  foo: ../images/flash_device.sh
Binds to:
flashabledevice_resource:
Implements:

  • None (yet)

Arguments:

  • script (str): optional, key in images containing the script to execute for writing of the flashable device

  • args (list of str): optional, list of arguments for flash script execution

The FlashScriptDriver allows running arbitrary programs to flash a device. Some SoC or devices may require custom, one-off, or proprietary programs to flash. A target image can be bundled with these programs using a tool like makeself, which can then be executed by labgrid to flash the device using this driver.

Additional arguments may be passed with the args parameter. These arguments will be expanded as Python format strings with the following keys:

HTTPVideoDriver

The HTTPVideoDriver is used to show a video stream over HTTP or HTTPS from a remote IP video source in a local window.

Binds to:
video:
Implements:

Although the driver can be used from Python code by calling the stream() method, it is currently mainly useful for the video subcommand of labgrid-client.

Key

Description

device

The Resource bound to the driver

file

The ManagedFile used to track the flashable script

Properties of these keys can be selected using the Python format string syntax, e.g. {device.devnode} to select the device node path of USBFlashableDevice

DediprogFlashDriver

The DediprogFlashDriver is used to flash an SPI device using DediprogFlasher dpcmd.

DediprogFlashDriver:
  image: 'foo'
images:
  foo: ../images/image_to_load.raw
Binds to:
DediprogFlasher_resource:
Arguments:

  • image (str): optional, key in images containing the path of an image to flash onto the target

The DediprogFlashDriver allows using DediprogFlasher dpcmd to flash or erase SPI devices. It is assumed that the device flashing is an exporter wired, via DediprogFlasher SF100 for instance, to the device being flashed.

XenaDriver

The XenaDriver allows to use Xena networking test equipment. Using the xenavalkyrie library a full API to control the tester is available.

Binds to:
xena_manager:

The driver is supposed to work with all Xena products from the “Valkyrie Layer 2-3 Test platform” Currently tested on a XenaCompact chassis equipped with a 1 GE test module.

DockerDriver

A DockerDriver binds to a DockerDaemon and is used to create and control one docker container.

The driver uses the docker python module to interact with the docker daemon.
For more information on the parameters see:
https://docker-py.readthedocs.io/en/stable/containers.html#container-objects
Binds to:
docker_daemon:
Implements:
DockerDriver:
  image_uri: "rastasheep/ubuntu-sshd:16.04"
  container_name: "ubuntu-lg-example"
  host_config: {"network_mode":"bridge"}
  network_services: [{"port":22,"username":"root","password":"root"}]
Arguments:

  • image_uri (str): identifier of the docker image to use (may have a tag suffix)

  • command (str): command to run in the container (optional, depends on image)

  • volumes (list): list to configure volumes mounted inside the container (optional)

  • container_name (str): name of the container

  • environment (list): list of environment variables (optional)

  • host_config (dict): dictionary of host configurations

  • network_services (list): dictionaries that describe individual NetworkService instances that come alive when the container is created. The “address” argument which NetworkService also requires will be derived automatically upon container creation.

LXAIOBusPIODriver

An LXAIOBusPIODriver binds to a single LXAIOBusPIO to toggle and read the PIO states.

Binds to:
pio:
LXAIOBusPIODriver: {}
Implements:
Arguments:

  • None

PyVISADriver

The PyVISADriver uses a PyVISADevice resource to control test equipment manageable by PyVISA.

Binds to:
pyvisa_resource:
Implements:

  • None yet

Arguments:

  • None

NetworkInterfaceDriver

This driver allows controlling a network interface (such as Ethernet or WiFi) on the exporter using NetworkManager.

The configuration is based on dictionaries with contents similar to NM’s connection files in INI-format. Currently basic wired and wireless configuration options have been tested.

To use it, PyGObject must be installed (on the same system as the network interface). For Debian, the necessary packages are python3-gi and gir1.2-nm-1.0.

It supports: - static and DHCP address configuration - WiFi client or AP - connection sharing (DHCP server with NAT) - listing DHCP leases (if the client has sufficient permissions)

Binds to:
iface:
Implements:

  • None yet

Arguments:

  • None

Strategies

Strategies are used to ensure that the device is in a certain state during a test. Such a state could be the bootloader or a booted Linux kernel with shell.

BareboxStrategy

A BareboxStrategy has four states:

  • unknown

  • off

  • barebox

  • shell

Here is an example environment config:

targets:
  main:
    resources:
      RawSerialPort:
        port: '/dev/ttyUSB0'
    drivers:
      ManualPowerDriver: {}
      SerialDriver: {}
      BareboxDriver: {}
      ShellDriver:
        prompt: 'root@\w+:[^ ]+ '
        login_prompt: ' login: '
        username: root
      BareboxStrategy: {}

In order to use the BareboxStrategy via labgrid as a library and transition to the shell state:

>>> from labgrid import Environment
>>> e = Environment("barebox-env.yaml")
>>> t = e.get_target("main")
>>> s = t.get_driver("BareboxStrategy")
>>> s.transition("shell")

This command would transition from the bootloader into a Linux shell and activate the ShellDriver.

ShellStrategy

A ShellStrategy has three states:

  • unknown

  • off

  • shell

Here is an example environment config:

targets:
  main:
    resources:
      RawSerialPort:
        port: '/dev/ttyUSB0'
    drivers:
      ManualPowerDriver: {}
      SerialDriver: {}
      ShellDriver:
        prompt: 'root@\w+:[^ ]+ '
        login_prompt: ' login: '
        username: root
      ShellStrategy: {}

In order to use the ShellStrategy via labgrid as a library and transition to the shell state:

>>> from labgrid import Environment
>>> e = Environment("shell-env.yaml")
>>> t = e.get_target("main")
>>> s = t.get_driver("ShellStrategy")

This command would transition directly into a Linux shell and activate the ShellDriver.

UBootStrategy

A UBootStrategy has four states:

  • unknown

  • off

  • uboot

  • shell

Here is an example environment config:

targets:
  main:
    resources:
      RawSerialPort:
        port: '/dev/ttyUSB0'
    drivers:
      ManualPowerDriver: {}
      SerialDriver: {}
      UBootDriver: {}
      ShellDriver:
        prompt: 'root@\w+:[^ ]+ '
        login_prompt: ' login: '
        username: root
      UBootStrategy: {}

In order to use the UBootStrategy via labgrid as a library and transition to the shell state:

>>> from labgrid import Environment
>>> e = Environment("uboot-env.yaml")
>>> t = e.get_target("main")
>>> s = t.get_driver("UBootStrategy")
>>> s.transition("shell")

This command would transition from the bootloader into a Linux shell and activate the ShellDriver.

DockerStrategy

A DockerStrategy has three states:

  • unknown

  • gone

  • accessible

Here is an example environment config:

targets:
  main:
    resources:
      DockerDaemon:
        docker_daemon_url: unix://var/run/docker.sock
    drivers:
      DockerDriver:
        image_uri: "rastasheep/ubuntu-sshd:16.04"
        container_name: "ubuntu-lg-example"
        host_config: {"network_mode":"bridge"}
        network_services: [{"port":22,"username":"root","password":"root"}]
      DockerStrategy: {}

In order to use the DockerStrategy via labgrid as a library and transition to the accessible state:

>>> from labgrid import Environment
>>> e = Environment("docker-env.yaml")
>>> t = e.get_target("main")
>>> s = t.get_driver("DockerStrategy")
>>> s.transition("accessible")

These commands would activate the docker driver which creates and starts a docker container. This will subsequently make NetworkService instance(s) available which can be used for e.g. SSH access.

Reporters

StepReporter

The StepReporter outputs individual labgrid steps to STDOUT.

>>> from labgrid import StepReporter
>>> StepReporter.start()

The Reporter can be stopped with a call to the stop function:

>>> from labgrid import StepReporter
>>> StepReporter.stop()

Stopping the StepReporter if it has not been started will raise an AssertionError, as will starting an already started StepReporter.

ConsoleLoggingReporter

The ConsoleLoggingReporter outputs read calls from the console transports into files. It takes the path as a parameter.

>>> from labgrid import ConsoleLoggingReporter
>>> ConsoleLoggingReporter.start(".")

The Reporter can be stopped with a call to the stop function:

>>> from labgrid import ConsoleLoggingReporter
>>> ConsoleLoggingReporter.stop()

Stopping the ConsoleLoggingReporter if it has not been started will raise an AssertionError, as will starting an already started StepReporter.

Environment Configuration

The environment configuration for a test environment consists of a YAML file which contains targets, drivers and resources.

Note

The order is important here: Objects are instantiated in the order they appear in the YAML file, so if drivers depend on other drivers or resources which are only instantiated later, loading the environment will fail.

The skeleton for an environment consists of:

targets:
  <target-1>:
    resources:
      <resource-1>:
        <resource-1 parameters>
      <resource-2>:
        <resource-2 parameters>
    drivers:
      <driver-1>:
        <driver-1 parameters>
      <driver-2>: {} # no parameters for driver-2
    features:
      - <target-feature-1>
  <target-2>:
    resources:
      <resources>
    drivers:
      <drivers>
    options:
      <target-option-1-name>: <value for target-option-1>
      <more target-options>
  <more targets>
options:
  <option-1 name>: <value for option-1>
  <more options>
features:
  - <global-feature-1>
paths:
  <path-1 name>: <absolute or relative path for path-1>
  <more paths>
images:
  <image-1 name>: <absolute or relative path for image-1>
  <more images>
tools:
  <tool-1 name>: <absolute or relative path for tool-1>
  <more tools>
imports:
  - <import.py>
  - <python module>

If you have a single target in your environment, name it “main”, as the get_target function defaults to “main”.

All the resources and drivers in this chapter have a YAML example snippet which can simply be added (at the correct indentation level, one level deeper) to the environment configuration.

If you want to use multiple drivers of the same type, the resources and drivers need to be lists, e.g:

resources:
  RawSerialPort:
    port: '/dev/ttyS1'
drivers:
  SerialDriver: {}

becomes:

resources:
- RawSerialPort:
    port: '/dev/ttyS1'
- RawSerialPort:
    port: '/dev/ttyS2'
drivers:
- SerialDriver: {}
- SerialDriver: {}

This configuration doesn’t specify which RawSerialPort to use for each SerialDriver, so it will cause an exception when instantiating the Target. To bind the correct driver to the correct resource, explicit name and bindings properties are used:

resources:
- RawSerialPort:
    name: 'foo'
    port: '/dev/ttyS1'
- RawSerialPort:
    name: 'bar'
    port: '/dev/ttyS2'
drivers:
- SerialDriver:
    name: 'foo_driver'
    bindings:
      port: 'foo'
- SerialDriver:
    name: 'bar_driver'
    bindings:
      port: 'bar'

The property name for the binding (e.g. port in the example above) is documented for each individual driver in this chapter.

The YAML configuration file also supports templating for some substitutions, these are:

  • LG_* variables, are replaced with their respective LG_* environment variable

  • BASE is substituted with the base directory of the YAML file.

As an example:

targets:
  main:
    resources:
      RemotePlace:
        name: !template $LG_PLACE
tools:
  qemu_bin: !template "$BASE/bin/qemu-bin"

would resolve the qemu_bin path relative to the BASE dir of the YAML file and try to use the RemotePlace with the name set in the LG_PLACE environment variable.

See the labgrid-device-config man page for documentation on the top-level options, images, tools, and examples keys in the environment configuration.

Exporter Configuration

The exporter is configured by using a YAML file (with a syntax similar to the environment configs used for pytest) or by instantiating the Environment object. To configure the exporter, you need to define one or more resource groups, each containing one or more resources. The syntax for exported resource names is <exporter>/<group>/<class>/<name>, which allows the exporter to group resources for various usage scenarios, e.g. all resources of a specific place or for a specific test setup. For information on how the exporter fits into the rest of labgrid, see Remote Resources and Places.

The <exporter> part can be specified on the labgrid-exporter command line, and defaults to the hostname of the exporter.

The basic structure of an exporter configuration file is:

<group-1>:
  <resource-name-1>:
    <params>
  <resource-name-2>:
    <params>
<group-2>:
  <resource-name-1>:
    <params>

By default, the class name is inferred from the resource name, and <params> will be passed to its constructor. For USB resources, you will most likely want to use udev Matching here.

As a simple example, here is one group called usb-hub-in-rack12 containing a single USBSerialPort resource (using udev matching), which will be exported as exportername/usb-hub-in-rack12/NetworkSerialPort/USBSerialPort:

usb-hub-in-rack12:
  USBSerialPort:
    match:
      '@ID_PATH': pci-0000:05:00.0-usb-3-1.3

To export multiple resources of the same class in the same group, you can choose a unique resource name, and then use the cls parameter to specify the class name instead (which will not be passed as a parameter to the class constructor). In this next example we will export one USBSerialPort as exportername/usb-hub-in-rack12/NetworkSerialPort/console-main, and another USBSerialPort as exportername/usb-hub-in-rack12/NetworkSerialPort/console-secondary:

usb-hub-in-rack12:
  console-main:
    cls: USBSerialPort
    match:
      '@ID_PATH': pci-0000:05:00.0-usb-3-1.3
  console-secondary:
    cls: USBSerialPort
    match:
      '@ID_PATH': pci-0000:05:00.0-usb-3-1.4

Note that you could also split the resources up into distinct groups instead to achieve the same effect:

usb-hub-in-rack12-port3:
  USBSerialPort:
    match:
      '@ID_PATH': pci-0000:05:00.0-usb-3-1.3
usb-hub-in-rack12-port4:
  USBSerialPort:
    match:
      '@ID_PATH': pci-0000:05:00.0-usb-3-1.4

Templating

To reduce the amount of repeated declarations when many similar resources need to be exported, the Jinja2 template engine is used as a preprocessor for the configuration file:

## Iterate from group 1001 to 1016
# for idx in range(1, 17)
{{ 1000 + idx }}:
  NetworkSerialPort:
    {host: rl1, port: {{ 4000 + idx }}}
  NetworkPowerPort:
    # if 1 <= idx <= 8
    {model: apc, host: apc1, index: {{ idx }}}
    # elif 9 <= idx <= 12
    {model: netio, host: netio4, index: {{ idx - 8 }}}
    # elif 13 <= idx <= 16
    {model: netio, host: netio5, index: {{ idx - 12 }}}
    # endif
# endfor

Use # for line statements (like the for loops in the example) and ## for line comments. Statements like {{ 4000 + idx }} are expanded based on variables in the Jinja2 template.

The template processing also supports use of OS environment variables, using something like {{ env['FOOBAR'] }} to insert the content of environment variable FOOBAR. In addition to env the template also has access to the following variables:

isolated

True or False, depending on the --isolated command line option.

hostname

The hostname of the exporter host. Can be used to e.g. construct URLs to the current host (http://{{ hostname }}/).

name

The name of the exporter.