SYNOPSIS¶

*.yaml

DESCRIPTION¶

To integrate a device into a labgrid test, labgrid needs to have a description of the device and how to access it.

This manual page is divided into section, each describing one top-level yaml key.

TARGETS¶

The targets: top key configures a target, it's drivers and resources.

The top level key is the name of the target, it needs both a resources and drivers subkey. The order of instantiated resources and drivers is important, since they are parsed as an ordered dictionary and may depend on a previous driver.

For a list of available resources and drivers refer to https://labgrid.readthedocs.io/en/latest/configuration.html.

OPTIONS¶

The options: top key configures various options such as the coordinator_address.

OPTIONS KEYS¶

IMAGES¶

The images: top key provides paths to access preconfigured images to flash onto the board. The image paths can be either relative to the YAML file or absolute.

IMAGE KEYS¶

The subkeys consist of image names as keys and their paths as values. The corresponding name can than be used with the appropriate tool found under TOOLS.

IMAGE EXAMPLE¶

Two configured images, one for the root filesystem, one for the bootloader:

images:


  root: "platform-v7a/images/root.img"


  boot: "platform-v7a/images/barebox.img"

TOOLS¶

The tools: top key provides paths to binaries such as fastboot.

TOOLS KEYS¶

The QEMUDriver expects a custom key set via its qemu_bin argument. See https://www.qemu.org/

TOOLS EXAMPLE¶

Configure the tool path for imx-usb-loader:

tools:


  imx-usb-loader: "/opt/labgrid-helper/imx-usb-loader"

IMPORTS¶

The imports key is a list of files or python modules which are imported by the environment after loading the configuration. Paths relative to the configuration file are also supported. This is useful to load drivers and strategy which are contained in your testsuite, since the import is done before instantiating the targets.

IMPORTS EXAMPLE¶

Import a local myfunctions.py file:

imports:


  - myfunctions.py

EXAMPLES¶

A sample configuration with one main target, accessible via SerialPort /dev/ttyUSB0, allowing usage of the ShellDriver:

targets:


  main:


    resources:


      RawSerialPort:


        port: "/dev/ttyUSB0"


    drivers:


      SerialDriver: {}


      ShellDriver:


        prompt: 'root@[\w-]+:[^ ]+ '


        login_prompt: ' login: '


        username: 'root'

A sample configuration with RemotePlace, using the tools configuration and importing the local mystrategy.py file. The MyStrategy strategy is contained in the loaded local python file:

targets:


  main:


    resources:


      RemotePlace:


        name: test-place


    drivers:


      SerialDriver: {}


      ShellDriver:


        prompt: 'root@[\w-]+:[^ ]+ '


        login_prompt: ' login: '


        username: 'root'


      IMXUSBDriver: {}


      MyStrategy: {}
tools:


  imx-usb-loader: "/opt/lg-tools/imx-usb-loader"
imports:


  - mystrategy.py

SEE ALSO¶

labgrid-client(1), labgrid-exporter(1)