embedded systems control library for development, testing and installation
Switch branches/tags
Nothing to show
Failed to load latest commit information.
.crossbar remote: replace autoping with explicit polling Nov 19, 2017
doc Merge pull request #126 from Emantor/topic/sigrok Feb 16, 2018
examples examples: use new syntax for Driver retrieval Jan 24, 2018
labgrid map LG_* variables from OS environment into YAML config file using !t… Feb 22, 2018
man man/labgrid-device-config: fix indentation Dec 4, 2017
tests tests: add test for remoteplace regression Feb 22, 2018
.coveragerc coveralls: exclude protocols via .coveragerc and use it for travis Feb 28, 2017
.flake8 flake8: add configuration Nov 19, 2017
.gitignore gitignore: add doc/modules Mar 29, 2017
.pylintrc global: add pylint configuration Jan 4, 2017
.travis.yml travis: workaround for setuptools upgrade issue Aug 8, 2017
CHANGES.rst CHANGES: Fix various issues Feb 9, 2018
COPYING COPYING,LICENSE: move from .txt May 11, 2017
LICENSE COPYING,LICENSE: move from .txt May 11, 2017
MANIFEST.in setup: use fastentrypoints to reduce the script startup time Feb 27, 2017
README.rst README: add link to IRC and Matrix channel Feb 17, 2018
crossbar-requirements.txt doc/getting_started: document requirements installation processes Feb 15, 2018
dev-requirements.txt requirements: split up requirements files Feb 15, 2018
doc-requirements.txt requirements: update and pin dependencies Feb 15, 2018
fastentrypoints.py setup: use fastentrypoints to reduce the script startup time Feb 27, 2017
modbus-requirements.txt requirements: split up requirements files Feb 15, 2018
onewire-requirements.txt requirements: split up requirements files Feb 15, 2018
requirements.txt requirements: split up requirements files Feb 15, 2018
setup.cfg setup.cfg: enable warning-as-error for sphinx Feb 9, 2018
setup.py requirements: split up requirements files Feb 15, 2018
snmp-requirements.txt requirements: split up requirements files Feb 15, 2018
tox.ini Fixup tox.ini Dec 13, 2016


Welcome to labgrid

LGPLv2.1 build status coverage status documentation status chat


Labgrid is an embedded board control python library with a focus on testing, development and general automation. It includes a remote control layer to control boards connected to other hosts.

The idea behind labgrid is to create an abstraction of the hardware control layer needed for testing of embedded systems, automatic software installation and automation during development. Labgrid itself is not a testing framework, but is intended to be combined with pytest (and additional pytest plugins). Please see Design Decisions for more background information.

It currently supports:

  • pytest plugin to write tests for embedded systems connecting serial console or SSH
  • remote client-exporter-coordinator infrastructure to make boards available from different computers on a network
  • power/reset management via drivers for power switches or onewire PIOs
  • upload of binaries via USB: imxusbloader/mxsusbloader (bootloader) or fastboot (kernel)
  • functions to control external services such as emulated USB-Sticks and the hawkBit deployment service

While labgrid is currently used for daily development on embedded boards and for automated testing, several planned features are not yet implemented and the APIs may be changed as more use-cases appear. We appreciate code contributions and feedback on using labgrid on other environments (see Contributing for details). Please consider contacting us (via a GitHub issue) before starting larger changes, so we can discuss design trade-offs early and avoid redundant work. You can also look at Ideas for enhancements which are not yet implemented.


Read the Docs


Development Docs

IRC channel #labgrid on freenode (bridged to the Matrix channel #labgrid:matrix.org)


Work on labgrid started at Pengutronix in late 2016 and is currently in active use and development.


See the Installation section for more details.

Clone the git repository:

$ git clone https://github.com/labgrid-project/labgrid

Create and activate a virtualenv for labgrid:

$ virtualenv -p python3 venv
$ source venv/bin/activate

Install labgrid into the virtualenv:

$ pip install -r requirements.txt
$ python setup.py install

Tests can now run via:

$ python -m pytest --lg-env <config>