Release 0.3.0 (unreleased)
New Features in 0.3.0
- The new FileDigitalOutputDriver respresents a digital signal with a file.
- The new GpioDigitalOutputDriver controls the state of a GPIO via the sysfs interface.
- Crossbar and autobahn have been updated to 19.3.3 and 19.3.5 respectively.
- The InfoDriver was removed. The functions have been integrated into the labgridhelper library, please use the library for the old functionality.
write-imagesubcommand: labgrid client now has a
write-imagecommand to write images onto block devices.
labgrid-client sshnow also uses port from NetworkService resource if available
- The SSHDriver's keyfile attribute is now specified relative to the config file just like the images are.
- The ShellDriver's keyfile attribute is now specified relative to the config file just like the images are.
labgrid-client -P <PROXY>and the
LG_PROXYenviroment variable can be used to access the coordinator and network resources via that SSH proxy host. Drivers which run commands via SSH to the exporter still connect directly, allowing custom configuration in the user's
.ssh/configas needed. Note that not all drivers have been updated to use the ProxyManager yet.
- Flashrom support added, by hard-wiring e.g. an exporter to the DUT, the ROM on the DUT can be written directly. The flashrom driver implements the bootstrap protocol.
- AndroidFastbootDriver now supports 'getvar' and 'oem getenv' subcommands.
- The coordinator now updates the resource acquired state at the exporter. Accordingly, the exporter now starts ser2net only when a resources is aquired. Furthermore, resource conflicts between places are now detected.
- The binding dictionary can now supports type name strings in addition to the types themselves, avoiding the need to import a specific protocol or driver in some cases.
labgrid-client write-imagegained new arguments:
- UBootDriver now allows overriding of default boot command (
run bootcmd) via new
Breaking changes in 0.3.0
- ManagedFile now saves the files in a different directory on the exporter.
/tmpwas used, labgrid now uses
/var/cache/labgrid. A tmpfiles example configuration for systemd is provided in the
/contribdirectory. It is also highly recommended to enable
fs.protected_fifos=1for kernels>=4.19. This requires user intervention after the upgrade to create the directory and setup the cleanup job.
@attr.s(cmp=False)is deprecated and all classes have been moved to
@attr.s(eq=False), this release requires attrs version 19.2.0
- Coordinator work dir is now set to the same dir as the crossbar configuration
dir. Hence coordinator specific files like
resources.yamlare now also stored in the crossbar configuration folder. Previously it would use
USBStickclasses have been removed
- The original USBStorageDriver was removed,
NetworkUSBStorageDriverwas renamed to USBStorageDriver. A deprecated NetworkUSBStorageDriver exists temporarily for compatibility reasons.
Release 0.2.0 (released Jan 4, 2019)
New Features in 0.2.0
- A colored StepReporter was added and can be used with
labgrid-clientcan now use the last changed information to sort listed resources and places.
labgrid-client sshnow uses ip/user/password from NetworkService resource if available
- The pytest plugin option
--lg-logenables logging of the serial traffic into a file (see below).
- The environement files can contain feature flags which can be used to control which tests are run in pytest.
LG_*variables from the OS environment can be used in the config file with the
- The new "managed file" support takes a local file and synchronizes it to a resource on a remote host. If the resource is not a NetworkResource, the local file is used instead.
- ProxyManager: a class to automatically create ssh forwardings to proxy connections over the exporter
- SSHManager: a global manager to multiplex connections to different exporters
- The target now saves it's attached drivers, resources and protocols in a lookup table, avoiding the need of importing many Drivers and Protocols (see Syntactic sugar for Targets)
- When multiple Drivers implement the same Protocol, the best one can be selected using a priority (see below).
- The new subcommand
labgrid-client monitorshows resource or places changes as they happen, which is useful during development or debugging.
- The environment yaml file can now list Python files (under the 'imports' key). They are imported before constructing the Targets, which simplifies using custom Resources, Drivers or Strategies.
- The pytest plugin now stores metadata about the environment yaml file in the junit XML output.
labgrid-clienttool now understands a
--stateoption to transition to the provided state using a :any:`Strategy`. This requires an environment yaml file with a :any:`RemotePlace` Resources and matching Drivers.
- Resource matches for places configured in the coordinator can now have a name, allowing multiple resources with the same class.
- The new Target.__getitem__ method makes writing using protocols less verbose.
- Experimental: The labgrid-autoinstall tool was added (see below).
New and Updated Drivers
- The new DigitalOutputResetDriver adapts a driver implementing the DigitalOutputProtocol to the ResetProtocol.
- The new ModbusCoilDriver support outputs on a ModbusTCP device.
- The new
NetworkUSBStorageDriverallows writing to remote USB storage devices (such as SD cards or memory sticks connected to a mux).
- The new QEMUDriver runs a system image in QEmu and implements the :any:`ConsoleProtocol` and :any:`PowerProtocol`. This allows using labgrid without any real hardware.
- The new QuartusHPSDriver controls the "Quartus Prime Programmer and Tools" to flash a target's QSPI.
- The new SerialPortDigitalOutputDriver controls the state of a GPIO using the control lines of a serial port.
- The new SigrokDriver uses a (local or remote) device supported by sigrok to record samples.
- The new SmallUBootDriver supports the extremely limited U-Boot found in cheap WiFi routers.
- The new USBSDMuxDriver controls a Pengutronix USB-SD-Mux device.
- The new USBTMCDriver can fetch measurements and screenshots from the "Keysight DSOX2000 series" and the "Tektronix TDS 2000 series".
- The new USBVideoDriver can stream video from a remote H.264 UVC (USB Video Class) camera using gstreamer over SSH. Currently, configuration for the "Logitech HD Pro Webcam C920" exists.
- The new XenaDriver allows interacting with Xena network testing equipment.
- The new YKUSHPowerDriver and USBPowerDriver support software-controlled USB hubs.
- The bootloader drivers now have a
- The BareboxDriver's boot string is now configurable, which allows it to work
quietLinux boot parameter.
- The IMXUSBLoader now recognizes more USB IDs.
- The OpenOCDDriver is now more flexible with loading configuration files.
- The NetworkPowerDriver now additionally supports:
- 24 port "Gude Expert Power Control 8080"
- 8 port "Gude Expert Power Control 8316"
- NETIO 4 models (via telnet)
- a simple REST interface
- The SerialDriver now supports using plain TCP instead of RFC 2217, which is needed from some console servers.
- The ShellDriver has been improved:
- It supports configuring the various timeouts used during the login process.
- It can use xmodem to transfer file from and to the target.
- When using the coordinator, it must be upgrade together with the clients because of the newly introduce match names.
- Resources and Drivers now need to be created with an explicit name
It can be
Noneto keep the old behaviour. See below for details.
- Classes derived from :any:`Resource` or :any:`Driver` now need to use
@attr.sbecause of a change in the attrs module version 17.1.0.
Syntactic sugar for Targets
Targets are now able to retrieve requested drivers, resources or protocols by name instead of by class. This allows removing many imports, e.g.
from labgrid.driver import ShellDriver shell = target.get_driver(ShellDriver)
shell = target.get_driver("ShellDriver")
Also take a look at the examples, they have been ported to the new syntax as well.
Multiple Driver Instances
For some Protocols, it is useful to allow multiple instances.
- A board may have two jumpers to control the boot mode in addition to a reset GPIO. Previously, it was not possible to use these on a single target.
- Some boards have multiple console interfaces or expose a login prompt via a USB serial gadget.
- In some cases, multiple power ports need to be controlled for one Target.
To support these use cases, Resources and Drivers must be created with a
When updating your code to this version, you can either simply set the name to
None to keep the previous behaviour.
Alternatively, pass a string as the name.
>>> t = Target("MyTarget") >>> SerialPort(t) SerialPort(target=Target(name='MyTarget', env=None), state=<BindingState.bound: 1>, avail=True, port=None, speed=115200) >>> SerialDriver(t) SerialDriver(target=Target(name='MyTarget', env=None), state=<BindingState.bound: 1>, txdelay=0.0)
New (with name=None):
>>> t = Target("MyTarget") >>> SerialPort(t, None) SerialPort(target=Target(name='MyTarget', env=None), name=None, state=<BindingState.bound: 1>, avail=True, port=None, speed=115200) >>> SerialDriver(t, None) SerialDriver(target=Target(name='MyTarget', env=None), name=None, state=<BindingState.bound: 1>, txdelay=0.0)
New (with real names):
>>> t = Target("MyTarget") >>> SerialPort(t, "MyPort") SerialPort(target=Target(name='MyTarget', env=None), name='MyPort', state=<BindingState.bound: 1>, avail=True, port=None, speed=115200) >>> SerialDriver(t, "MyDriver") SerialDriver(target=Target(name='MyTarget', env=None), name='MyDriver', state=<BindingState.bound: 1>, txdelay=0.0)
Each driver supports a priorities class variable. This allows drivers which implement the same protocol to add a priority option to each of their protocols. This way a NetworkPowerDriver can implement the ResetProtocol, but if another ResetProtocol driver with a higher protocol is available, it will be selected instead. See the documentation for details.
The ConsoleLoggingReporter can be used with the pytest plugin or the library. It records the Data send from a DUT to the computer running labgrid. The logfile contains a header with the name of the device from the environment configuration and a timestamp.
When using the library, the reporter can be started with:
from labgrid.consoleloggingreporter import ConsoleLoggingReporter ConsoleLoggingReporter.start(".")
where "." is the output directory.
The pytest plugin accepts the
--lg-log commandline option, either with or
without an output path.
To simplify using labgrid for provisioning several boards in parallel, the
labgrid-autoinstall tool was added.
It reads a YAML file defining several targets and a Python script to be run for
Interally, it spawns a child process for each target, which waits until a matching
resource becomes available and then executes the script.
For example, this makes it simple to load a bootloader via the :any:`BootstrapProtocol`, use the :any:`AndroidFastbootDriver` to upload a kernel with initramfs and then write the target's eMMC over a USB Mass Storage gadget.
labgrid-autoinstall is still experimental and no documentation has been written.
Contributions from: Ahmad Fatoum, Bastian Krause, Björn Lässig, Chris Fiege, Enrico Joerns, Esben Haabendal, Felix Lampe, Florian Scherf, Georg Hofmann, Jan Lübbe, Jan Remmet, Johannes Nau, Kasper Revsbech, Kjeld Flarup, Laurentiu Palcu, Oleksij Rempel, Roland Hieber, Rouven Czerwinski, Stanley Phoong Cheong Kwan, Steffen Trumtrar, Tobi Gschwendtner, Vincent Prince
Release 0.1.0 (released May 11, 2017)
This is the initial release of labgrid.