labgrid.driver package
Subpackages
- labgrid.driver.power package
- Submodules
- labgrid.driver.power.apc module
- labgrid.driver.power.digipower module
- labgrid.driver.power.digitalloggers_http module
- labgrid.driver.power.eaton module
- labgrid.driver.power.eg_pms2_network module
- labgrid.driver.power.gude module
- labgrid.driver.power.gude24 module
- labgrid.driver.power.gude8031 module
- labgrid.driver.power.gude8225 module
- labgrid.driver.power.gude8316 module
- labgrid.driver.power.netio module
- labgrid.driver.power.netio_kshell module
- labgrid.driver.power.raritan module
- labgrid.driver.power.rest module
- labgrid.driver.power.sentry module
- labgrid.driver.power.shelly_gen1 module
- labgrid.driver.power.siglent module
- labgrid.driver.power.simplerest module
- labgrid.driver.power.tplink module
- labgrid.driver.usbtmc package
Submodules
labgrid.driver.bareboxdriver module
- class labgrid.driver.bareboxdriver.BareboxDriver(target, name, prompt='', autoboot='stop autoboot', interrupt='\n', bootstring='Linux version \\d', password='', login_timeout=60)[source]
Bases:
CommandMixin
,Driver
,CommandProtocol
,LinuxBootProtocol
- BareboxDriver - Driver to control barebox via the console.
BareboxDriver binds on top of a ConsoleProtocol.
On activation, the BareboxDriver will look for the barebox prompt on the console, stopping any autoboot counters if necessary, and provide access to the barebox shell.
- Parameters:
prompt (str) – barebox prompt to match
autoboot (regex) – optional, autoboot message to match
interrupt (str) – optional, string to interrupt autoboot (use “” for CTRL-C)
bootstring (regex) – optional, regex indicating that the Linux Kernel is booting
password (str) – optional, password to use for access to the shell
login_timeout (int) – optional, timeout for access to the shell
- bindings: Dict[str, Any] = {'console': <class 'labgrid.protocol.consoleprotocol.ConsoleProtocol'>}
- on_activate()[source]
Activate the BareboxDriver
This function tries to login if not already active
- get_status()[source]
Retrieve status of the BareboxDriver 0 means inactive, 1 means active.
- Returns:
status of the driver
- Return type:
int
- await_boot()[source]
Wait for the initial Linux version string to verify we successfully jumped into the kernel.
- boot(name: str)[source]
Boot the default or a specific boot entry
- Parameters:
name (str) – name of the entry to boot
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='prompt', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='prompt'), Attribute(name='autoboot', default='stop autoboot', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='autoboot'), Attribute(name='interrupt', default='\n', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='interrupt'), Attribute(name='bootstring', default='Linux version \\d', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='bootstring'), Attribute(name='password', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='password'), Attribute(name='login_timeout', default=60, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='login_timeout'))
- __init__(target, name, prompt='', autoboot='stop autoboot', interrupt='\n', bootstring='Linux version \\d', password='', login_timeout=60) None
Method generated by attrs for class BareboxDriver.
- __match_args__ = ('target', 'name', 'prompt', 'autoboot', 'interrupt', 'bootstring', 'password', 'login_timeout')
- __module__ = 'labgrid.driver.bareboxdriver'
- __repr__()
Method generated by attrs for class BareboxDriver.
labgrid.driver.commandmixin module
- class labgrid.driver.commandmixin.CommandMixin[source]
Bases:
object
CommandMixin implementing common functions for drivers which support the CommandProtocol
- wait_for(cmd, pattern, timeout=30.0, sleepduration=1)[source]
Wait until the pattern is detected in the output of cmd. Raises ExecutionError when the timeout expires.
- Parameters:
cmd (str) – command to run on the shell
pattern (str) – pattern as a string to look for in the output
timeout (float) – timeout for the pattern detection
sleepduration (int) – sleep time between the runs of the cmd
- poll_until_success(cmd, *, expected=0, tries=None, timeout=30.0, sleepduration=1)[source]
Poll a command until a specific exit code is detected. Takes a timeout and the number of tries to run the cmd. The sleepduration argument sets the duration between runs of the cmd.
- Parameters:
cmd (str) – command to run on the shell
expected (int) – exitcode to detect
tries (int) – number of tries, can be None for infinite tries
timeout (float) – timeout for the exitcode detection
sleepduration (int) – sleep time between the runs of the cmd
- Returns:
whether the command finally executed sucessfully
- Return type:
bool
- run_check(cmd: str, *, timeout=30, codec='utf-8', decodeerrors='strict')[source]
External run_check function, only available if the driver is active. Runs the supplied command and returns the stdout, raises an ExecutionError otherwise.
- Parameters:
cmd (str) – command to run on the shell
- Returns:
stdout of the executed command
- Return type:
List[str]
- __annotations__ = {}
- __dict__ = mappingproxy({'__module__': 'labgrid.driver.commandmixin', '__doc__': '\n CommandMixin implementing common functions for drivers which support the CommandProtocol\n ', '__attrs_post_init__': <function CommandMixin.__attrs_post_init__>, 'wait_for': <function CommandMixin.wait_for>, 'poll_until_success': <function CommandMixin.poll_until_success>, '_run_check': <function CommandMixin._run_check>, 'run_check': <function CommandMixin.run_check>, '__dict__': <attribute '__dict__' of 'CommandMixin' objects>, '__weakref__': <attribute '__weakref__' of 'CommandMixin' objects>, '__annotations__': {}})
- __module__ = 'labgrid.driver.commandmixin'
- __weakref__
list of weak references to the object (if defined)
labgrid.driver.common module
- class labgrid.driver.common.Driver(target, name)[source]
Bases:
BindingMixin
Represents a driver which is used externally or by other drivers. It implements functionality based on directly accessing the Resource or by building on top of other Drivers.
Life cycle: - create - bind (n times) - activate - usage - deactivate
- get_priority(protocol)[source]
Retrieve the priority for a given protocol
Arguments: protocol - protocol to search for in the MRO
- Returns:
value of the priority if it is found, 0 otherwise.
- Return type:
Int
- get_export_name()[source]
Get the name to be used for exported variables.
Falls back to the class name if the driver has no name.
- property skip_deactivate_on_export
Drivers are deactivated on export by default.
If the driver can handle external accesses even while active, it can return True here.
- get_bound_resources()[source]
Return the bound resources for a driver
This recursively calls all suppliers and combines the sets of returned resources.
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class Driver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.common'
- __repr__()
Method generated by attrs for class Driver.
labgrid.driver.consoleexpectmixin module
- class labgrid.driver.consoleexpectmixin.ConsoleExpectMixin[source]
Bases:
object
Console driver mixin to implement the read, write, expect and sendline methods. It uses the internal _read and _write methods.
The class using the ConsoleExpectMixin must provide a logger and a txdelay attribute.
- __annotations__ = {}
- __dict__ = mappingproxy({'__module__': 'labgrid.driver.consoleexpectmixin', '__doc__': '\n Console driver mixin to implement the read, write, expect and sendline methods. It uses\n the internal _read and _write methods.\n\n The class using the ConsoleExpectMixin must provide a logger and a txdelay attribute.\n ', '__attrs_post_init__': <function ConsoleExpectMixin.__attrs_post_init__>, 'read': <function ConsoleExpectMixin.read>, 'write': <function ConsoleExpectMixin.write>, 'sendline': <function ConsoleExpectMixin.sendline>, 'sendcontrol': <function ConsoleExpectMixin.sendcontrol>, 'expect': <function ConsoleExpectMixin.expect>, 'settle': <function ConsoleExpectMixin.settle>, 'resolve_conflicts': <function ConsoleExpectMixin.resolve_conflicts>, '__dict__': <attribute '__dict__' of 'ConsoleExpectMixin' objects>, '__weakref__': <attribute '__weakref__' of 'ConsoleExpectMixin' objects>, '__annotations__': {}})
- __module__ = 'labgrid.driver.consoleexpectmixin'
- __weakref__
list of weak references to the object (if defined)
labgrid.driver.dediprogflashdriver module
- class labgrid.driver.dediprogflashdriver.DediprogFlashDriver(target, name, image=None)[source]
Bases:
Driver
The DediprogFlashDriver uses the dediprog utility to write an image to a raw rom. The driver is a pure wrapper of the dpcmd utility
- bindings: Dict[str, Any] = {'flasher': {'DediprogFlasher', <class 'labgrid.resource.dediprogflasher.NetworkDediprogFlasher'>}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class DediprogFlashDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.dediprogflashdriver'
- __repr__()
Method generated by attrs for class DediprogFlashDriver.
labgrid.driver.deditecrelaisdriver module
- class labgrid.driver.deditecrelaisdriver.DeditecRelaisDriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'relais': {'DeditecRelais8', <class 'labgrid.resource.remote.NetworkDeditecRelais8'>}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class DeditecRelaisDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.deditecrelaisdriver'
- __repr__()
Method generated by attrs for class DeditecRelaisDriver.
labgrid.driver.dfudriver module
- class labgrid.driver.dfudriver.DFUDriver(target, name)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'dfu': {'DFUDevice', 'NetworkDFUDevice'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class DFUDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.dfudriver'
- __repr__()
Method generated by attrs for class DFUDriver.
labgrid.driver.dockerdriver module
Class for connecting to a docker daemon running on the host machine.
- class labgrid.driver.dockerdriver.DockerDriver(target, name, image_uri=None, command=None, volumes=None, container_name=None, environment=None, host_config=None, network_services=None)[source]
Bases:
PowerProtocol
,Driver
The DockerDriver is used to create docker containers. This is done via communication with a docker daemon.
When a container is created the container is labeled with an cleanup strategy identifier. Currently only one strategy is implemented. This strategy simply deletes all labgrid created containers before each test run. This is to ensure cleanup of dangling containers from crashed tests or hanging containers.
Image pruning is not done by the driver.
For detailed information about the arguments see the “Docker SDK for Python” documentation https://docker-py.readthedocs.io/en/stable/containers.html#container-objects
- Parameters:
bindings (dict) – The labgrid bindings
- Args passed to docker.create_container:
image_uri (str): The uri of the image to fetch command (str): The command to execute once container has been created volumes (list): The volumes to declare environment (list): Docker environment variables to set host_config (dict): Docker host configuration parameters network_services (list): Sequence of dicts each specifying a network service that the docker container exposes.
- bindings: Dict[str, Any] = {'docker_daemon': {'DockerDaemon'}}
- on_activate()[source]
On activation: 1. Import docker module (_client and _container remain available) 2. Connect to the docker daemon 3. Pull requested image from docker registry if needed 4. Create the new container according to parameters from conf
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image_uri', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image_uri'), Attribute(name='command', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='command'), Attribute(name='volumes', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='volumes'), Attribute(name='container_name', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='container_name'), Attribute(name='environment', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='environment'), Attribute(name='host_config', default=None, validator=<optional validator for <instance_of validator for type <class 'dict'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='host_config'), Attribute(name='network_services', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='network_services'))
- __init__(target, name, image_uri=None, command=None, volumes=None, container_name=None, environment=None, host_config=None, network_services=None) None
Method generated by attrs for class DockerDriver.
- __match_args__ = ('target', 'name', 'image_uri', 'command', 'volumes', 'container_name', 'environment', 'host_config', 'network_services')
- __module__ = 'labgrid.driver.dockerdriver'
- __repr__()
Method generated by attrs for class DockerDriver.
labgrid.driver.exception module
- exception labgrid.driver.exception.ExecutionError(msg, stdout=None, stderr=None)[source]
Bases:
Exception
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='msg'), Attribute(name='stdout', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='stdout'), Attribute(name='stderr', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='stderr'))
- __init__(msg, stdout=None, stderr=None) None
Method generated by attrs for class ExecutionError.
- __match_args__ = ('msg', 'stdout', 'stderr')
- __module__ = 'labgrid.driver.exception'
- __repr__()
Method generated by attrs for class ExecutionError.
- __weakref__
list of weak references to the object (if defined)
- exception labgrid.driver.exception.CleanUpError(msg)[source]
Bases:
Exception
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='msg'),)
- __init__(msg) None
Method generated by attrs for class CleanUpError.
- __match_args__ = ('msg',)
- __module__ = 'labgrid.driver.exception'
- __repr__()
Method generated by attrs for class CleanUpError.
- __weakref__
list of weak references to the object (if defined)
labgrid.driver.externalconsoledriver module
- class labgrid.driver.externalconsoledriver.ExternalConsoleDriver(target, name, cmd, txdelay=0.0)[source]
Bases:
ConsoleExpectMixin
,Driver
,ConsoleProtocol
Driver implementing the ConsoleProtocol interface using a subprocess
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='cmd', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='cmd'), Attribute(name='txdelay', default=0.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='txdelay'))
- __init__(target, name, cmd, txdelay=0.0) None
Method generated by attrs for class ExternalConsoleDriver.
- __match_args__ = ('target', 'name', 'cmd', 'txdelay')
- __module__ = 'labgrid.driver.externalconsoledriver'
- __repr__()
Method generated by attrs for class ExternalConsoleDriver.
labgrid.driver.fake module
- class labgrid.driver.fake.FakeConsoleDriver(target, name, txdelay=0.0)[source]
Bases:
ConsoleExpectMixin
,Driver
,ConsoleProtocol
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='txdelay', default=0.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='txdelay'))
- __init__(target, name, txdelay=0.0) None
Method generated by attrs for class FakeConsoleDriver.
- __match_args__ = ('target', 'name', 'txdelay')
- __module__ = 'labgrid.driver.fake'
- __repr__()
Method generated by attrs for class FakeConsoleDriver.
- class labgrid.driver.fake.FakeCommandDriver(target, name)[source]
Bases:
CommandMixin
,Driver
,CommandProtocol
- run_check(*args)[source]
External run_check function, only available if the driver is active. Runs the supplied command and returns the stdout, raises an ExecutionError otherwise.
- Parameters:
cmd (str) – command to run on the shell
- Returns:
stdout of the executed command
- Return type:
List[str]
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class FakeCommandDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.fake'
- __repr__()
Method generated by attrs for class FakeCommandDriver.
- class labgrid.driver.fake.FakeFileTransferDriver(target, name)[source]
Bases:
Driver
,FileTransferProtocol
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class FakeFileTransferDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.fake'
- __repr__()
Method generated by attrs for class FakeFileTransferDriver.
- class labgrid.driver.fake.FakePowerDriver(target, name)[source]
Bases:
Driver
,PowerProtocol
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class FakePowerDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.fake'
- __repr__()
Method generated by attrs for class FakePowerDriver.
labgrid.driver.fastbootdriver module
- class labgrid.driver.fastbootdriver.AndroidFastbootDriver(target, name, boot_image=None, flash_images={}, sparse_size=None)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'fastboot': {<class 'labgrid.resource.fastboot.AndroidNetFastboot'>, <class 'labgrid.resource.remote.RemoteAndroidNetFastboot'>, <class 'labgrid.resource.remote.RemoteAndroidUSBFastboot'>, <class 'labgrid.resource.udev.AndroidUSBFastboot'>}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='boot_image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_image'), Attribute(name='flash_images', default={}, validator=<optional validator for <instance_of validator for type <class 'dict'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='flash_images'), Attribute(name='sparse_size', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='sparse_size'))
- __init__(target, name, boot_image=None, flash_images={}, sparse_size=None) None
Method generated by attrs for class AndroidFastbootDriver.
- __match_args__ = ('target', 'name', 'boot_image', 'flash_images', 'sparse_size')
- __module__ = 'labgrid.driver.fastbootdriver'
- __repr__()
Method generated by attrs for class AndroidFastbootDriver.
labgrid.driver.filedigitaloutput module
- class labgrid.driver.filedigitaloutput.FileDigitalOutputDriver(target, name, filepath, false_repr='0\n', true_repr='1\n')[source]
Bases:
Driver
,DigitalOutputProtocol
Two arbitrary string values false_repr and true_repr are defined as representations for False and True. These values are written to a file and read from it. If the file’s content does not match any of the representations it defaults to False. A prime example for using this driver is Linux’s sysfs.
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='filepath', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='filepath'), Attribute(name='false_repr', default='0\n', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='false_repr'), Attribute(name='true_repr', default='1\n', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='true_repr'))
- __init__(target, name, filepath, false_repr='0\n', true_repr='1\n') None
Method generated by attrs for class FileDigitalOutputDriver.
- __match_args__ = ('target', 'name', 'filepath', 'false_repr', 'true_repr')
- __module__ = 'labgrid.driver.filedigitaloutput'
- __repr__()
Method generated by attrs for class FileDigitalOutputDriver.
labgrid.driver.flashromdriver module
- class labgrid.driver.flashromdriver.FlashromDriver(target, name, image=None)[source]
Bases:
Driver
,BootstrapProtocol
The Flashrom driver used the flashrom utility to write an image to a raw rom. The driver is a pure wrapper of the flashrom utility
- bindings: Dict[str, Any] = {'flashrom_resource': {'Flashrom', <class 'labgrid.resource.flashrom.NetworkFlashrom'>}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class FlashromDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.flashromdriver'
- __repr__()
Method generated by attrs for class FlashromDriver.
labgrid.driver.flashscriptdriver module
- class labgrid.driver.flashscriptdriver.FlashScriptDriver(target, name, script=None, args=_Nothing.NOTHING)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'device': {'NetworkUSBFlashableDevice', 'USBFlashableDevice'}}
- flash(script=None, args=None)[source]
Transfers and remotely executes the script
- Parameters:
script (str) – optional, path to the script to write to bound Flashable Device
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='script', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='script'), Attribute(name='args', default=Factory(factory=<class 'list'>, takes_self=False), validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='args'))
- __init__(target, name, script=None, args=_Nothing.NOTHING) None
Method generated by attrs for class FlashScriptDriver.
- __match_args__ = ('target', 'name', 'script', 'args')
- __module__ = 'labgrid.driver.flashscriptdriver'
- __repr__()
Method generated by attrs for class FlashScriptDriver.
labgrid.driver.gpiodriver module
All GPIO-related drivers
- class labgrid.driver.gpiodriver.GpioDigitalOutputDriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'gpio': {'NetworkSysfsGPIO', 'SysfsGPIO'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class GpioDigitalOutputDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.gpiodriver'
- __repr__()
Method generated by attrs for class GpioDigitalOutputDriver.
labgrid.driver.httpdigitaloutput module
- class labgrid.driver.httpdigitaloutput.HttpDigitalOutputDriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'http': 'HttpDigitalOutput'}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class HttpDigitalOutputDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.httpdigitaloutput'
- __repr__()
Method generated by attrs for class HttpDigitalOutputDriver.
labgrid.driver.httpvideodriver module
- class labgrid.driver.httpvideodriver.HTTPVideoDriver(target, name)[source]
Bases:
Driver
,VideoProtocol
- bindings: Dict[str, Any] = {'video': 'HTTPVideoStream'}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class HTTPVideoDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.httpvideodriver'
- __repr__()
Method generated by attrs for class HTTPVideoDriver.
labgrid.driver.lxaiobusdriver module
- class labgrid.driver.lxaiobusdriver.LXAIOBusPIODriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'pio': {'LXAIOBusPIO', 'NetworkLXAIOBusPIO'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class LXAIOBusPIODriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.lxaiobusdriver'
- __repr__()
Method generated by attrs for class LXAIOBusPIODriver.
labgrid.driver.lxausbmuxdriver module
- class labgrid.driver.lxausbmuxdriver.LXAUSBMuxDriver(target, name)[source]
Bases:
Driver
The LXAUSBMuxDriver uses the usbmuxctl tool to control the USBMux hardware
- bindings: Dict[str, Any] = {'mux': {'LXAUSBMux', 'NetworkLXAUSBMux'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class LXAUSBMuxDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.lxausbmuxdriver'
- __repr__()
Method generated by attrs for class LXAUSBMuxDriver.
labgrid.driver.manualswitchdriver module
- class labgrid.driver.manualswitchdriver.ManualSwitchDriver(target, name, description=None)[source]
Bases:
Driver
,DigitalOutputProtocol
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='description', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='description'))
- __init__(target, name, description=None) None
Method generated by attrs for class ManualSwitchDriver.
- __match_args__ = ('target', 'name', 'description')
- __module__ = 'labgrid.driver.manualswitchdriver'
- __repr__()
Method generated by attrs for class ManualSwitchDriver.
labgrid.driver.modbusdriver module
- class labgrid.driver.modbusdriver.ModbusCoilDriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'coil': 'ModbusTCPCoil'}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class ModbusCoilDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.modbusdriver'
- __repr__()
Method generated by attrs for class ModbusCoilDriver.
labgrid.driver.modbusrtudriver module
- class labgrid.driver.modbusrtudriver.ModbusRTUDriver(target, name)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'resource': 'ModbusRTU'}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class ModbusRTUDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.modbusrtudriver'
- __repr__()
Method generated by attrs for class ModbusRTUDriver.
labgrid.driver.mqtt module
- exception labgrid.driver.mqtt.MQTTError[source]
Bases:
Exception
- __module__ = 'labgrid.driver.mqtt'
- __weakref__
list of weak references to the object (if defined)
- class labgrid.driver.mqtt.TasmotaPowerDriver(target, name, delay=2.0, client=None, status=None)[source]
Bases:
Driver
,PowerProtocol
- bindings: Dict[str, Any] = {'power': {'TasmotaPowerPort'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'), Attribute(name='_client', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='client'), Attribute(name='_status', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='status'))
- __init__(target, name, delay=2.0, client=None, status=None) None
Method generated by attrs for class TasmotaPowerDriver.
- __match_args__ = ('target', 'name', 'delay', '_client', '_status')
- __module__ = 'labgrid.driver.mqtt'
- __repr__()
Method generated by attrs for class TasmotaPowerDriver.
labgrid.driver.networkinterfacedriver module
- class labgrid.driver.networkinterfacedriver.NetworkInterfaceDriver(target, name)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'iface': {'NetworkInterface', 'RemoteNetworkInterface', 'USBNetworkInterface'}}
- property skip_deactivate_on_export
Drivers are deactivated on export by default.
If the driver can handle external accesses even while active, it can return True here.
- wait_state(expected, timeout=60)[source]
Wait until the expected state is reached or the timeout expires.
Possible states include disconnected and activated. See NM’s DeviceState for more details.
- get_state()[source]
Get the current state of this interface.
This includes information such as the addresses or WiFi connection.
- get_dhcpd_leases()[source]
Get the list of active DHCP leases in shared mode.
This requires read access to /var/lib/NetworkManager/dnsmasq-* on the exporter.
- get_access_points(scan=None)[source]
Get the list of currently visible access points.
When scan is None (the default), it will automatically trigger a scan if the last scan is more than 30 seconds old.
- forward_local(remote_host, remote_port, local_port=None)[source]
Forward a local port to an address and port via the exporter.
A context manager that keeps the local port forwarded as long as the context remains valid. A connection can be made to the returned port on localhost and it will be forwarded to the address and port.
If localport is not set, a random free port will be selected.
- usage:
- with netif.forward_local(‘127.0.0.1’, 8080, local_port=1234) as local_port:
# Use localhost:1234 here to connect to port 8080 on # the exporter
- with netif.forward_local(‘192.168.1.2’, 8080) as local_port:
# Use localhost:local_port here to connect to port 8080 on # 192.168.1.2
- Returns:
local_port
- forward_remote(remote_port, local_port, remote_bind=None)[source]
Forward a remote port on the exporter to a local port.
A context manager that keeps a remote port forwarded to a local port as long as the context remains valid. A connection can be made to the remote port on the target device will be forwarded to the returned local port on localhost.
Note that the remote socket is not bound to any specific IP by default, making it reachable by the target. Also, ‘GatewayPorts clientspecified’ needs to be configured in the remote host’s sshd_config.
- usage:
- with netif.forward_remote(8080, 8081) as local_port:
# Connections to port 8080 on the exporter will be redirected to # localhost:8081
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class NetworkInterfaceDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.networkinterfacedriver'
- __repr__()
Method generated by attrs for class NetworkInterfaceDriver.
labgrid.driver.onewiredriver module
- class labgrid.driver.onewiredriver.OneWirePIODriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'port': 'OneWirePIO'}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class OneWirePIODriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.onewiredriver'
- __repr__()
Method generated by attrs for class OneWirePIODriver.
labgrid.driver.openocddriver module
- class labgrid.driver.openocddriver.OpenOCDDriver(target, name, config=_Nothing.NOTHING, search=_Nothing.NOTHING, image=None, interface_config=None, board_config=None, load_commands=None)[source]
Bases:
Driver
,BootstrapProtocol
- bindings: Dict[str, Any] = {'interface': {'AlteraUSBBlaster', 'NetworkAlteraUSBBlaster', 'NetworkUSBDebugger', 'USBDebugger'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='config', default=Factory(factory=<class 'list'>, takes_self=False), validator=<optional validator for <instance_of validator for type (<class 'str'>, <class 'list'>)> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='config'), Attribute(name='search', default=Factory(factory=<class 'list'>, takes_self=False), validator=<optional validator for <instance_of validator for type (<class 'str'>, <class 'list'>)> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='search'), Attribute(name='image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'), Attribute(name='interface_config', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='interface_config'), Attribute(name='board_config', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='board_config'), Attribute(name='load_commands', default=None, validator=<optional validator for <instance_of validator for type <class 'list'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='load_commands'))
- __init__(target, name, config=_Nothing.NOTHING, search=_Nothing.NOTHING, image=None, interface_config=None, board_config=None, load_commands=None) None
Method generated by attrs for class OpenOCDDriver.
- __match_args__ = ('target', 'name', 'config', 'search', 'image', 'interface_config', 'board_config', 'load_commands')
- __module__ = 'labgrid.driver.openocddriver'
- __repr__()
Method generated by attrs for class OpenOCDDriver.
labgrid.driver.powerdriver module
- class labgrid.driver.powerdriver.PowerResetMixin[source]
Bases:
ResetProtocol
ResetMixin implements the ResetProtocol for drivers which support the PowerProtocol
- priorities = {<class 'labgrid.protocol.resetprotocol.ResetProtocol'>: -10}
- __abstractmethods__ = frozenset({})
- __annotations__ = {}
- __attrs_attrs__ = ()
- __init__() None
Method generated by attrs for class PowerResetMixin.
- __match_args__ = ()
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class PowerResetMixin.
- class labgrid.driver.powerdriver.ManualPowerDriver(target, name)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
ManualPowerDriver - Driver to tell the user to control a target’s power
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class ManualPowerDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class ManualPowerDriver.
- class labgrid.driver.powerdriver.SiSPMPowerDriver(target, name, delay=2.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
SiSPMPowerDriver - Driver using a SiS-PM (Silver Shield PM) to control a target’s power using the sispmctl tool - http://sispmctl.sourceforge.net/
- bindings: Dict[str, Any] = {'port': {'NetworkSiSPMPowerPort', 'SiSPMPowerPort'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=2.0) None
Method generated by attrs for class SiSPMPowerDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class SiSPMPowerDriver.
- class labgrid.driver.powerdriver.ExternalPowerDriver(target, name, cmd_on, cmd_off, cmd_cycle=None, delay=2.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
ExternalPowerDriver - Driver using an external command to control a target’s power
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='cmd_on', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='cmd_on'), Attribute(name='cmd_off', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='cmd_off'), Attribute(name='cmd_cycle', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='cmd_cycle'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, cmd_on, cmd_off, cmd_cycle=None, delay=2.0) None
Method generated by attrs for class ExternalPowerDriver.
- __match_args__ = ('target', 'name', 'cmd_on', 'cmd_off', 'cmd_cycle', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class ExternalPowerDriver.
- class labgrid.driver.powerdriver.NetworkPowerDriver(target, name, delay=2.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
NetworkPowerDriver - Driver using a networked power switch to control a target’s power
- bindings: Dict[str, Any] = {'port': <class 'labgrid.resource.power.NetworkPowerPort'>}
- set_proxy_from_url()[source]
Some power backends (e.g. rest, simplerest) expect a URL in the host parameter. Try to handle the host parameter as a URL, extract the power backend port from it and set new proxied host parameter.
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=2.0) None
Method generated by attrs for class NetworkPowerDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class NetworkPowerDriver.
- class labgrid.driver.powerdriver.DigitalOutputPowerDriver(target, name, delay=1.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
DigitalOutputPowerDriver uses a DigitalOutput to control the power of a DUT.
- bindings: Dict[str, Any] = {'output': <class 'labgrid.protocol.digitaloutputprotocol.DigitalOutputProtocol'>}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=1.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=1.0) None
Method generated by attrs for class DigitalOutputPowerDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class DigitalOutputPowerDriver.
- class labgrid.driver.powerdriver.YKUSHPowerDriver(target, name, delay=2.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
YKUSHPowerDriver - Driver using a YEPKIT YKUSH switchable USB hub to control a target’s power - https://www.yepkit.com/products/ykush. Uses ykushcmd tool to control the hub.
- bindings: Dict[str, Any] = {'port': {'NetworkYKUSHPowerPort', 'YKUSHPowerPort'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=2.0) None
Method generated by attrs for class YKUSHPowerDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class YKUSHPowerDriver.
- class labgrid.driver.powerdriver.USBPowerDriver(target, name, delay=2.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
USBPowerDriver - Driver using a power switchable USB hub and the uhubctl tool (https://github.com/mvp/uhubctl) to control a target’s power
- bindings: Dict[str, Any] = {'hub': {'NetworkUSBPowerPort', 'USBPowerPort'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=2.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=2.0) None
Method generated by attrs for class USBPowerDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class USBPowerDriver.
- class labgrid.driver.powerdriver.PDUDaemonDriver(target, name, delay=5.0)[source]
Bases:
Driver
,PowerResetMixin
,PowerProtocol
PDUDaemonDriver - Driver using a PDU port available via pdudaemon
- bindings: Dict[str, Any] = {'port': 'PDUDaemonPort'}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=5.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=5.0) None
Method generated by attrs for class PDUDaemonDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.powerdriver'
- __repr__()
Method generated by attrs for class PDUDaemonDriver.
labgrid.driver.provider module
- class labgrid.driver.provider.BaseProviderDriver(target, name)[source]
Bases:
Driver
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class BaseProviderDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.provider'
- __repr__()
Method generated by attrs for class BaseProviderDriver.
- class labgrid.driver.provider.TFTPProviderDriver(target, name)[source]
Bases:
BaseProviderDriver
- bindings: Dict[str, Any] = {'provider': {'RemoteTFTPProvider', 'TFTPProvider'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class TFTPProviderDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.provider'
- __repr__()
Method generated by attrs for class TFTPProviderDriver.
- class labgrid.driver.provider.NFSPProviderDriver(target, name)[source]
Bases:
BaseProviderDriver
- bindings: Dict[str, Any] = {'provider': {'NFSProvider', 'RemoteNFSProvider'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class NFSPProviderDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.provider'
- __repr__()
Method generated by attrs for class NFSPProviderDriver.
- class labgrid.driver.provider.HTTPProviderDriver(target, name)[source]
Bases:
BaseProviderDriver
- bindings: Dict[str, Any] = {'provider': {'HTTPProvider', 'RemoteHTTPProvider'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class HTTPProviderDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.provider'
- __repr__()
Method generated by attrs for class HTTPProviderDriver.
labgrid.driver.pyvisadriver module
- class labgrid.driver.pyvisadriver.PyVISADriver(target, name)[source]
Bases:
Driver
The PyVISADriver provides a transparent layer to the PyVISA module allowing to get a pyvisa resource
- Parameters:
bindings (dict) – driver to use with PyVISA
- bindings: Dict[str, Any] = {'pyvisa_resource': 'PyVISADevice'}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class PyVISADriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.pyvisadriver'
- __repr__()
Method generated by attrs for class PyVISADriver.
labgrid.driver.qemudriver module
The QEMUDriver implements a driver to use a QEMU target
- class labgrid.driver.qemudriver.QEMUDriver(target, name, qemu_bin, machine, cpu, memory, extra_args, boot_args=None, kernel=None, disk=None, rootfs=None, dtb=None, flash=None, bios=None, display='none', nic=None)[source]
Bases:
ConsoleExpectMixin
,Driver
,PowerProtocol
,ConsoleProtocol
The QEMUDriver implements an interface to start targets as qemu instances.
The kernel, flash, rootfs and dtb arguments refer to images and paths declared in the environment configuration.
- Parameters:
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
- get_qemu_base_args()[source]
Returns the base command line used for Qemu without the options related to QMP. These options can be used to start an interactive Qemu manually for debugging tests
- on()[source]
Start the QEMU subprocess, accept the unix socket connection and afterwards start the emulator using a QMP Command
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='qemu_bin', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='qemu_bin'), Attribute(name='machine', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='machine'), Attribute(name='cpu', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='cpu'), Attribute(name='memory', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='memory'), Attribute(name='extra_args', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='extra_args'), Attribute(name='boot_args', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_args'), Attribute(name='kernel', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='kernel'), Attribute(name='disk', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='disk'), Attribute(name='rootfs', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='rootfs'), Attribute(name='dtb', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='dtb'), Attribute(name='flash', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='flash'), Attribute(name='bios', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='bios'), Attribute(name='display', default='none', validator=<optional validator for _AndValidator(_validators=(<instance_of validator for type <class 'str'>>, <in_ validator with options ['none', 'fb-headless', 'egl-headless']>)) or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='display'), Attribute(name='nic', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='nic'))
- __init__(target, name, qemu_bin, machine, cpu, memory, extra_args, boot_args=None, kernel=None, disk=None, rootfs=None, dtb=None, flash=None, bios=None, display='none', nic=None) None
Method generated by attrs for class QEMUDriver.
- __match_args__ = ('target', 'name', 'qemu_bin', 'machine', 'cpu', 'memory', 'extra_args', 'boot_args', 'kernel', 'disk', 'rootfs', 'dtb', 'flash', 'bios', 'display', 'nic')
- __module__ = 'labgrid.driver.qemudriver'
- __repr__()
Method generated by attrs for class QEMUDriver.
labgrid.driver.quartushpsdriver module
- class labgrid.driver.quartushpsdriver.QuartusHPSDriver(target, name, image=None)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'interface': {'AlteraUSBBlaster', 'NetworkAlteraUSBBlaster'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class QuartusHPSDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.quartushpsdriver'
- __repr__()
Method generated by attrs for class QuartusHPSDriver.
labgrid.driver.resetdriver module
- class labgrid.driver.resetdriver.DigitalOutputResetDriver(target, name, delay=1.0)[source]
Bases:
Driver
,ResetProtocol
DigitalOutputResetDriver - Driver using a DigitalOutput to reset the target
- bindings: Dict[str, Any] = {'output': <class 'labgrid.protocol.digitaloutputprotocol.DigitalOutputProtocol'>}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=1.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'))
- __init__(target, name, delay=1.0) None
Method generated by attrs for class DigitalOutputResetDriver.
- __match_args__ = ('target', 'name', 'delay')
- __module__ = 'labgrid.driver.resetdriver'
- __repr__()
Method generated by attrs for class DigitalOutputResetDriver.
labgrid.driver.serialdigitaloutput module
- class labgrid.driver.serialdigitaloutput.SerialPortDigitalOutputDriver(target, name, signal, invert)[source]
Bases:
Driver
,DigitalOutputProtocol
Controls the state of a GPIO using the control lines of a serial port.
This driver uses the flow-control pins of a serial port (for example an USB-UART-dongle) to control some external power switch. You may connect some kind of relay board to the flow control pins.
The serial port should NOT be used for serial communication at the same time. This will probably reset the flow-control signals.
Usable signals are DTR and RTS.
- bindings: Dict[str, Any] = {'serial': <class 'labgrid.driver.serialdriver.SerialDriver'>}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='signal', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='signal'), Attribute(name='invert', default=NOTHING, validator=<instance_of validator for type <class 'bool'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='invert'))
- __init__(target, name, signal, invert) None
Method generated by attrs for class SerialPortDigitalOutputDriver.
- __match_args__ = ('target', 'name', 'signal', 'invert')
- __module__ = 'labgrid.driver.serialdigitaloutput'
- __repr__()
Method generated by attrs for class SerialPortDigitalOutputDriver.
labgrid.driver.serialdriver module
- class labgrid.driver.serialdriver.SerialDriver(target, name, txdelay=0.0, timeout=3.0)[source]
Bases:
ConsoleExpectMixin
,Driver
,ConsoleProtocol
Driver implementing the ConsoleProtocol interface over a SerialPort connection
- bindings: Dict[str, Any] = {'port': {'NetworkSerialPort', 'SerialPort'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='txdelay', default=0.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='txdelay'), Attribute(name='timeout', default=3.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='timeout'))
- __init__(target, name, txdelay=0.0, timeout=3.0) None
Method generated by attrs for class SerialDriver.
- __match_args__ = ('target', 'name', 'txdelay', 'timeout')
- __module__ = 'labgrid.driver.serialdriver'
- __repr__()
Method generated by attrs for class SerialDriver.
labgrid.driver.shelldriver module
The ShellDriver provides the CommandProtocol, ConsoleProtocol and InfoProtocol on top of a SerialPort.
- class labgrid.driver.shelldriver.ShellDriver(target, name, prompt, login_prompt, username, password='', keyfile='', login_timeout=60, console_ready='', await_login_timeout=2, post_login_settle_time=0)[source]
Bases:
CommandMixin
,Driver
,CommandProtocol
,FileTransferProtocol
ShellDriver - Driver to execute commands on the shell ShellDriver binds on top of a ConsoleProtocol.
On activation, the ShellDriver will look for the login prompt on the console, and login to provide shell access.
- Parameters:
prompt (regex) – the shell prompt to detect
login_prompt (regex) – the login prompt to detect
username (str) – username to login with
password (str) – password to login with
keyfile (str) – keyfile to bind mount over users authorized keys
login_timeout (int) – optional, timeout for login prompt detection
console_ready (regex) – optional, pattern used by the kernel to inform the user that a console can be activated by pressing enter.
await_login_timeout (int) – optional, time in seconds of silence that needs to pass before sending a newline to device.
post_login_settle_time (int) – optional, 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.
- bindings: Dict[str, Any] = {'console': <class 'labgrid.protocol.consoleprotocol.ConsoleProtocol'>}
- get_status()[source]
Returns the status of the shell-driver. 0 means not connected/found, 1 means shell
- put_bytes(buf: bytes, remotefile: str)[source]
Upload a file to the target. Will silently overwrite the remote file if it already exists.
- Parameters:
buf (bytes) – file contents
remotefile (str) – destination filename on the target
- Raises:
ExecutionError – if something went wrong
- put(localfile: str, remotefile: str)[source]
Upload a file to the target. Will silently overwrite the remote file if it already exists.
- Parameters:
localfile (str) – source filename on the local machine
remotefile (str) – destination filename on the target
- Raises:
IOError – if the provided localfile could not be found
ExecutionError – if something else went wrong
- get_bytes(remotefile: str)[source]
Download a file from the target.
- Parameters:
remotefile (str) – source filename on the target
- Returns:
(bytes) file contents
- Raises:
ExecutionError – if something went wrong
- get(remotefile: str, localfile: str)[source]
Download a file from the target. Will silently overwrite the local file if it already exists.
- Parameters:
remotefile (str) – source filename on the target
localfile (str) – destination filename on the local machine (can be relative)
- Raises:
IOError – if localfile could not be written
ExecutionError – if something went wrong
- run_script(data: bytes, timeout: int = 60)[source]
Upload a script to the target and run it.
- Parameters:
data (bytes) – script data
timeout (int) – timeout for the script to finish execution
- Returns:
str, stderr: str, return_value: int)
- Return type:
Tuple of (stdout
- Raises:
ExecutionError – if something went wrong
- run_script_file(scriptfile: str, *args, timeout: int = 60)[source]
Upload a script file to the target and run it.
- Parameters:
scriptfile (str) – source file on the local file system to upload to the target
*args – (list of str): any arguments for the script as positional arguments
timeout (int) – timeout for the script to finish execution
- Returns:
str, stderr: str, return_value: int)
- Return type:
Tuple of (stdout
- Raises:
ExecutionError – if something went wrong
IOError – if the provided localfile could not be found
- get_default_interface_device_name(version=4)[source]
Retrieve the default route’s interface device name.
- Parameters:
version (int) – IP version
- Returns:
Name of the device of the default route
- Raises:
ExecutionError – if no or multiple routes are set up
- get_ip_addresses(device=None)[source]
Retrieves IP addresses for given interface name.
Note that although the return type is named IPv4Interface/IPv6Interface, it contains an IP address with the corresponding network prefix.
- Parameters:
device (str) – Name of the interface to query, defaults to default route’s device name.
- Returns:
List of IPv4Interface or IPv6Interface objects
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='prompt', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='prompt'), Attribute(name='login_prompt', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='login_prompt'), Attribute(name='username', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='username'), Attribute(name='password', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='password'), Attribute(name='keyfile', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='keyfile'), Attribute(name='login_timeout', default=60, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='login_timeout'), Attribute(name='console_ready', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='console_ready'), Attribute(name='await_login_timeout', default=2, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='await_login_timeout'), Attribute(name='post_login_settle_time', default=0, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='post_login_settle_time'))
- __init__(target, name, prompt, login_prompt, username, password='', keyfile='', login_timeout=60, console_ready='', await_login_timeout=2, post_login_settle_time=0) None
Method generated by attrs for class ShellDriver.
- __match_args__ = ('target', 'name', 'prompt', 'login_prompt', 'username', 'password', 'keyfile', 'login_timeout', 'console_ready', 'await_login_timeout', 'post_login_settle_time')
- __module__ = 'labgrid.driver.shelldriver'
- __repr__()
Method generated by attrs for class ShellDriver.
labgrid.driver.sigrokdriver module
- class labgrid.driver.sigrokdriver.SigrokCommon(target, name)[source]
Bases:
Driver
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class SigrokCommon.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.sigrokdriver'
- __repr__()
Method generated by attrs for class SigrokCommon.
- class labgrid.driver.sigrokdriver.SigrokDriver(target, name)[source]
Bases:
SigrokCommon
The SigrokDriver uses sigrok-cli to record samples and expose them as python dictionaries.
- Parameters:
bindings (dict) – driver to use with sigrok
- bindings: Dict[str, Any] = {'sigrok': {<class 'labgrid.resource.remote.NetworkSigrokUSBDevice'>, <class 'labgrid.resource.sigrok.SigrokDevice'>, <class 'labgrid.resource.udev.SigrokUSBDevice'>}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class SigrokDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.sigrokdriver'
- __repr__()
Method generated by attrs for class SigrokDriver.
- class labgrid.driver.sigrokdriver.SigrokPowerDriver(target, name, delay=3.0, max_voltage=None, max_current=None)[source]
Bases:
SigrokCommon
,PowerResetMixin
,PowerProtocol
The SigrokPowerDriverDriver uses sigrok-cli to control a PSU and collect measurements.
- Parameters:
bindings (dict) – driver to use with sigrok
- bindings: Dict[str, Any] = {'sigrok': {<class 'labgrid.resource.remote.NetworkSigrokUSBSerialDevice'>, <class 'labgrid.resource.udev.SigrokUSBSerialDevice'>}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='delay', default=3.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='delay'), Attribute(name='max_voltage', default=None, validator=<optional validator for <instance_of validator for type <class 'float'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=<function optional.<locals>.optional_converter>, kw_only=False, inherited=False, on_setattr=None, alias='max_voltage'), Attribute(name='max_current', default=None, validator=<optional validator for <instance_of validator for type <class 'float'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=<function optional.<locals>.optional_converter>, kw_only=False, inherited=False, on_setattr=None, alias='max_current'))
- __init__(target, name, delay=3.0, max_voltage=None, max_current=None) None
Method generated by attrs for class SigrokPowerDriver.
- __match_args__ = ('target', 'name', 'delay', 'max_voltage', 'max_current')
- __module__ = 'labgrid.driver.sigrokdriver'
- __repr__()
Method generated by attrs for class SigrokPowerDriver.
- class labgrid.driver.sigrokdriver.SigrokDmmDriver(target, name)[source]
Bases:
SigrokCommon
This driver wraps around a single channel DMM controlled by sigrok. It has been tested with Unit-T UT61C and UT61B devices but probably also works with other single chnnel DMMs.
This driver binds to a SigrokUsbDevice. Make sure to select the correct driver for your DMM there.
Example usage: > resources: > - SigrokUSBDevice: > driver: uni-t-ut61c > match: > ‘ID_PATH’: pci-0000:07:00.4-usb-0:2:1.0 > drivers: > - SigrokDmmDriver: {}
- Parameters:
bindings (dict) – driver to use with sigrok
- bindings: Dict[str, Any] = {'sigrok': {<class 'labgrid.resource.remote.NetworkSigrokUSBDevice'>, <class 'labgrid.resource.remote.NetworkSigrokUSBSerialDevice'>, <class 'labgrid.resource.udev.SigrokUSBDevice'>, <class 'labgrid.resource.udev.SigrokUSBSerialDevice'>}}
- capture(samples, timeout=None)[source]
Starts to read samples from the DMM. This method returns once sampling has been started. Sampling continues in the background.
Note: We use subprocess.PIPE to buffer the samples. When this buffer is too small for the number of samples requested sampling may stall.
- Parameters:
samples – Number of samples to obtain
timeout – Timeout after which sampling should be stopped. If None: timeout[s] = samples * 1s + 5s If int: Timeout in [s]
- Raises:
RuntimeError() if a capture is already running. –
- stop()[source]
Waits for sigrok to complete and returns all samples obtained afterwards. This function blocks until either sigrok has terminated or the timeout has been reached.
- Returns:
(unit_spec, [sample, …])
- Raises:
RuntimeError() if capture has not been started –
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class SigrokDmmDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.sigrokdriver'
- __repr__()
Method generated by attrs for class SigrokDmmDriver.
labgrid.driver.smallubootdriver module
- class labgrid.driver.smallubootdriver.SmallUBootDriver(target, name, prompt='', autoboot='stop autoboot', password='', interrupt='\n', init_commands=_Nothing.NOTHING, password_prompt='enter Password:', bootstring='Linux version \\d', boot_command='run bootcmd', boot_commands=_Nothing.NOTHING, boot_timeout=30, boot_expression='U-Boot 20\\d+', boot_secret='a', boot_secret_nolf=False, login_timeout=60)[source]
Bases:
UBootDriver
SmallUBootDriver is meant as a driver for UBoot with only little functionality compared to standard a standard UBoot. Especially is copes with the following limitations:
The UBoot does not have a real password-prompt but can be activated by entering a “secret” after a message was displayed.
The command line is does not have a build-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 can not 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 UBoot to work:
The UBoot must not have real password prompt. Instead it must be keyword activated. For example it should be activated by a dialog like the following: UBoot: “Autobooting in 1s…” Labgrid: “secret” UBoot: <switching to console>
The UBoot must be able to parse multiple commands in a single line separated by “;”.
The UBoot must support the “bootm” command to boot from a memory location.
This driver was created especially for the following devices:
TP-Link WR841 v11
- Parameters:
boot_secret (str) – optional, secret used to unlock prompt
boot_secret_nolf (bool) – optional, send boot_secret without new line
login_timeout (int) – optional, timeout for login prompt detection,
- boot(name)[source]
Boot the device from the given memory location using ‘bootm’.
- Parameters:
name (str) – address to boot
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='prompt', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='prompt'), Attribute(name='autoboot', default='stop autoboot', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='autoboot'), Attribute(name='password', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='password'), Attribute(name='interrupt', default='\n', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='interrupt'), Attribute(name='init_commands', default=Factory(factory=<class 'tuple'>, takes_self=False), validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=<class 'tuple'>, kw_only=False, inherited=True, on_setattr=None, alias='init_commands'), Attribute(name='password_prompt', default='enter Password:', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='password_prompt'), Attribute(name='bootstring', default='Linux version \\d', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='bootstring'), Attribute(name='boot_command', default='run bootcmd', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='boot_command'), Attribute(name='boot_commands', default=Factory(factory=<class 'dict'>, takes_self=False), validator=<instance_of validator for type <class 'dict'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='boot_commands'), Attribute(name='boot_timeout', default=30, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='boot_timeout'), Attribute(name='boot_expression', default='U-Boot 20\\d+', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_expression'), Attribute(name='boot_secret', default='a', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_secret'), Attribute(name='boot_secret_nolf', default=False, validator=<instance_of validator for type <class 'bool'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_secret_nolf'), Attribute(name='login_timeout', default=60, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='login_timeout'))
- __init__(target, name, prompt='', autoboot='stop autoboot', password='', interrupt='\n', init_commands=_Nothing.NOTHING, password_prompt='enter Password:', bootstring='Linux version \\d', boot_command='run bootcmd', boot_commands=_Nothing.NOTHING, boot_timeout=30, boot_expression='U-Boot 20\\d+', boot_secret='a', boot_secret_nolf=False, login_timeout=60) None
Method generated by attrs for class SmallUBootDriver.
- __match_args__ = ('target', 'name', 'prompt', 'autoboot', 'password', 'interrupt', 'init_commands', 'password_prompt', 'bootstring', 'boot_command', 'boot_commands', 'boot_timeout', 'boot_expression', 'boot_secret', 'boot_secret_nolf', 'login_timeout')
- __module__ = 'labgrid.driver.smallubootdriver'
- __repr__()
Method generated by attrs for class SmallUBootDriver.
labgrid.driver.sshdriver module
The SSHDriver uses SSH as a transport to implement CommandProtocol and FileTransferProtocol
- class labgrid.driver.sshdriver.SSHDriver(target, name, keyfile='', stderr_merge=False, connection_timeout=30.0, explicit_sftp_mode=False)[source]
Bases:
CommandMixin
,Driver
,CommandProtocol
,FileTransferProtocol
SSHDriver - Driver to execute commands via SSH
- bindings: Dict[str, Any] = {'networkservice': 'NetworkService'}
- priorities = {<class 'labgrid.protocol.commandprotocol.CommandProtocol'>: 10, <class 'labgrid.protocol.filetransferprotocol.FileTransferProtocol'>: 10}
- property skip_deactivate_on_export
Drivers are deactivated on export by default.
If the driver can handle external accesses even while active, it can return True here.
- forward_local_port(remoteport, localport=None)[source]
Forward a local port to a remote port on the target
A context manager that keeps a local port forwarded to a remote port as long as the context remains valid. A connection can be made to the returned port on localhost and it will be forwarded to the remote port on the target device
- usage:
- with ssh.forward_local_port(8080) as localport:
# Use localhost:localport here to connect to port 8080 on the # target
returns: localport
- forward_remote_port(remoteport, localport)[source]
Forward a remote port on the target to a local port
A context manager that keeps a remote port forwarded to a local port as long as the context remains valid. A connection can be made to the remote on the target device will be forwarded to the returned local port on localhost
- usage:
- with ssh.forward_remote_port(8080, 8081) as localport:
# Connections to port 8080 on the target will be redirected to # localhost:8081
- forward_unix_socket(unixsocket, localport=None)[source]
Forward a unix socket on the target to a local port
A context manager that keeps a unix socket forwarded to a local port as long as the context remains valid. A connection can be made to the remote socket on the target device will be forwarded to the returned local port on localhost
- usage:
- with ssh.forward_unix_socket(“/run/docker.sock”) as localport:
# Use localhost:localport here to connect to the socket on the # target
returns: localport
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='keyfile', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='keyfile'), Attribute(name='stderr_merge', default=False, validator=<instance_of validator for type <class 'bool'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='stderr_merge'), Attribute(name='connection_timeout', default=30.0, validator=<instance_of validator for type <class 'float'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='connection_timeout'), Attribute(name='explicit_sftp_mode', default=False, validator=<instance_of validator for type <class 'bool'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='explicit_sftp_mode'))
- __init__(target, name, keyfile='', stderr_merge=False, connection_timeout=30.0, explicit_sftp_mode=False) None
Method generated by attrs for class SSHDriver.
- __match_args__ = ('target', 'name', 'keyfile', 'stderr_merge', 'connection_timeout', 'explicit_sftp_mode')
- __module__ = 'labgrid.driver.sshdriver'
- __repr__()
Method generated by attrs for class SSHDriver.
labgrid.driver.ubootdriver module
The U-Boot Module contains the UBootDriver
- class labgrid.driver.ubootdriver.UBootDriver(target, name, prompt='', autoboot='stop autoboot', password='', interrupt='\n', init_commands=_Nothing.NOTHING, password_prompt='enter Password:', boot_expression='', bootstring='Linux version \\d', boot_command='run bootcmd', boot_commands=_Nothing.NOTHING, login_timeout=30, boot_timeout=30)[source]
Bases:
CommandMixin
,Driver
,CommandProtocol
,LinuxBootProtocol
UBootDriver - Driver to control uboot via the console. UBootDriver binds on top of a ConsoleProtocol.
- Parameters:
prompt (str) – optional, U-Boot prompt
password (str) – optional, password to unlock U-Boot
init_commands (tuple) – optional, tuple of commands to run after unlock
autoboot (str) – optional, string to search for to interrupt autoboot
interrupt (str) – optional, character to interrupt autoboot and go to prompt
password_prompt (str) – optional, string to detect the password prompt
boot_expression (str) – optional, deprecated
bootstring (str) – optional, string that indicates that the Kernel is booting
boot_command (str) – optional boot command to boot target
login_timeout (int) – optional, timeout for login prompt detection
boot_timeout (int) – optional, timeout for initial Linux Kernel version detection
- bindings: Dict[str, Any] = {'console': <class 'labgrid.protocol.consoleprotocol.ConsoleProtocol'>}
- on_activate()[source]
Activate the UBootDriver
This function checks for a prompt and awaits it if not already active
- run(cmd, timeout=30)[source]
Runs the specified command on the shell and returns the output.
- Parameters:
cmd (str) – command to run on the shell
timeout (int) – optional, how long to wait for completion
- Returns:
if successful, None otherwise
- Return type:
Tuple[List[str],List[str], int]
- get_status()[source]
Retrieve status of the UBootDriver. 0 means inactive, 1 means active.
- Returns:
status of the driver
- Return type:
int
- await_boot()[source]
Wait for the initial Linux version string to verify we successfully jumped into the kernel.
- boot(name: str = '')[source]
Boot the default or a specific boot entry
- Parameters:
name (str) – name of the entry to boot
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='prompt', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='prompt'), Attribute(name='autoboot', default='stop autoboot', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='autoboot'), Attribute(name='password', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='password'), Attribute(name='interrupt', default='\n', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='interrupt'), Attribute(name='init_commands', default=Factory(factory=<class 'tuple'>, takes_self=False), validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=<class 'tuple'>, kw_only=False, inherited=False, on_setattr=None, alias='init_commands'), Attribute(name='password_prompt', default='enter Password:', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='password_prompt'), Attribute(name='boot_expression', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_expression'), Attribute(name='bootstring', default='Linux version \\d', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='bootstring'), Attribute(name='boot_command', default='run bootcmd', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_command'), Attribute(name='boot_commands', default=Factory(factory=<class 'dict'>, takes_self=False), validator=<instance_of validator for type <class 'dict'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_commands'), Attribute(name='login_timeout', default=30, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='login_timeout'), Attribute(name='boot_timeout', default=30, validator=<instance_of validator for type <class 'int'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='boot_timeout'))
- __init__(target, name, prompt='', autoboot='stop autoboot', password='', interrupt='\n', init_commands=_Nothing.NOTHING, password_prompt='enter Password:', boot_expression='', bootstring='Linux version \\d', boot_command='run bootcmd', boot_commands=_Nothing.NOTHING, login_timeout=30, boot_timeout=30) None
Method generated by attrs for class UBootDriver.
- __match_args__ = ('target', 'name', 'prompt', 'autoboot', 'password', 'interrupt', 'init_commands', 'password_prompt', 'boot_expression', 'bootstring', 'boot_command', 'boot_commands', 'login_timeout', 'boot_timeout')
- __module__ = 'labgrid.driver.ubootdriver'
- __repr__()
Method generated by attrs for class UBootDriver.
labgrid.driver.usbaudiodriver module
- class labgrid.driver.usbaudiodriver.USBAudioInputDriver(target, name)[source]
Bases:
Driver
This driver provides access to a USB audio input device using ALSA and gstreamer.
When using this driver in a Python venv, you may need to allow access to the gi (GObject Introspection) module from the system. This can be done by crating a symlink: ln -s /usr/lib/python3/dist-packages/gi $VENV/lib/python*/site-packages/
- bindings: Dict[str, Any] = {'res': {'NetworkUSBAudioInput', 'USBAudioInput'}}
- start_sender()[source]
Return a subprocess which provides audio data in a matroska container on stdout
- measure_level()[source]
Returns the current peak and rms value (measured with the gst level element)
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class USBAudioInputDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbaudiodriver'
- __repr__()
Method generated by attrs for class USBAudioInputDriver.
labgrid.driver.usbhidrelay module
- class labgrid.driver.usbhidrelay.HIDRelayDriver(target, name)[source]
Bases:
Driver
,DigitalOutputProtocol
- bindings: Dict[str, Any] = {'relay': {'HIDRelay', <class 'labgrid.resource.remote.NetworkHIDRelay'>}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class HIDRelayDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbhidrelay'
- __repr__()
Method generated by attrs for class HIDRelayDriver.
labgrid.driver.usbloader module
- class labgrid.driver.usbloader.MXSUSBDriver(target, name, image=None)[source]
Bases:
Driver
,BootstrapProtocol
- bindings: Dict[str, Any] = {'loader': {'MXSUSBLoader', 'NetworkMXSUSBLoader'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class MXSUSBDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.usbloader'
- __repr__()
Method generated by attrs for class MXSUSBDriver.
- class labgrid.driver.usbloader.IMXUSBDriver(target, name, image=None)[source]
Bases:
Driver
,BootstrapProtocol
- bindings: Dict[str, Any] = {'loader': {'IMXUSBLoader', 'MXSUSBLoader', 'NetworkIMXUSBLoader', 'NetworkMXSUSBLoader'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class IMXUSBDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.usbloader'
- __repr__()
Method generated by attrs for class IMXUSBDriver.
- class labgrid.driver.usbloader.RKUSBDriver(target, name, image=None, usb_loader=None)[source]
Bases:
Driver
,BootstrapProtocol
- bindings: Dict[str, Any] = {'loader': {'NetworkRKUSBLoader', 'RKUSBLoader'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'), Attribute(name='usb_loader', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='usb_loader'))
- __init__(target, name, image=None, usb_loader=None) None
Method generated by attrs for class RKUSBDriver.
- __match_args__ = ('target', 'name', 'image', 'usb_loader')
- __module__ = 'labgrid.driver.usbloader'
- __repr__()
Method generated by attrs for class RKUSBDriver.
- class labgrid.driver.usbloader.UUUDriver(target, name, image=None, script='')[source]
Bases:
Driver
,BootstrapProtocol
- bindings: Dict[str, Any] = {'loader': {'IMXUSBLoader', 'MXSUSBLoader', 'NetworkIMXUSBLoader', 'NetworkMXSUSBLoader'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'), Attribute(name='script', default='', validator=<instance_of validator for type <class 'str'>>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='script'))
- __init__(target, name, image=None, script='') None
Method generated by attrs for class UUUDriver.
- __match_args__ = ('target', 'name', 'image', 'script')
- __module__ = 'labgrid.driver.usbloader'
- __repr__()
Method generated by attrs for class UUUDriver.
- class labgrid.driver.usbloader.BDIMXUSBDriver(target, name)[source]
Bases:
Driver
,BootstrapProtocol
This is a Driver for the Boundary Devices imx_usb_loader available from https://github.com/boundarydevices/imx_usb_loader
It supports loading the second stage bootloader to a SDP gadget implemented by the first stage bootloader in SRAM. Accordingly, the image to upload must be specified explicitly.
- bindings: Dict[str, Any] = {'loader': {'IMXUSBLoader', 'NetworkIMXUSBLoader'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class BDIMXUSBDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbloader'
- __repr__()
Method generated by attrs for class BDIMXUSBDriver.
labgrid.driver.usbsdmuxdriver module
- class labgrid.driver.usbsdmuxdriver.USBSDMuxDriver(target, name)[source]
Bases:
Driver
The USBSDMuxDriver uses the usbsdmux tool (https://github.com/pengutronix/usbsdmux) to control the USB-SD-Mux hardware
- Parameters:
bindings (dict) – driver to use with usbsdmux
- bindings: Dict[str, Any] = {'mux': {'NetworkUSBSDMuxDevice', 'USBSDMuxDevice'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class USBSDMuxDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbsdmuxdriver'
- __repr__()
Method generated by attrs for class USBSDMuxDriver.
labgrid.driver.usbsdwiredriver module
- class labgrid.driver.usbsdwiredriver.USBSDWireDriver(target, name)[source]
Bases:
Driver
The USBSDWireDriver uses the sd-mux-ctrl tool to control SDWire hardware
- Parameters:
bindings (dict) – driver to use with usbsdmux
- bindings: Dict[str, Any] = {'mux': {'NetworkUSBSDWireDevice', 'USBSDWireDevice'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class USBSDWireDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbsdwiredriver'
- __repr__()
Method generated by attrs for class USBSDWireDriver.
labgrid.driver.usbstoragedriver module
- class labgrid.driver.usbstoragedriver.Mode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]
Bases:
Enum
- DD = 'dd'
- BMAPTOOL = 'bmaptool'
- __module__ = 'labgrid.driver.usbstoragedriver'
- class labgrid.driver.usbstoragedriver.USBStorageDriver(target, name, image=None)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'storage': {'NetworkUSBMassStorage', 'NetworkUSBSDMuxDevice', 'NetworkUSBSDWireDevice', 'USBMassStorage', 'USBSDMuxDevice', 'USBSDWireDevice'}}
- write_image(filename=None, mode=Mode.DD, partition=None, skip=0, seek=0)[source]
Writes the file specified by filename or if not specified by config image subkey to the bound USB storage root device or partition.
- Parameters:
filename (str) – optional, path to the image to write to bound USB storage
mode (Mode) – optional, Mode.DD or Mode.BMAPTOOL (defaults to Mode.DD)
partition (int or None) – optional, write to the specified partition or None for writing to root device (defaults to None)
skip (int) – optional, skip n 512-sized blocks at start of input file (defaults to 0)
seek (int) – optional, skip n 512-sized blocks at start of output (defaults to 0)
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=False, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class USBStorageDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.usbstoragedriver'
- __repr__()
Method generated by attrs for class USBStorageDriver.
- class labgrid.driver.usbstoragedriver.NetworkUSBStorageDriver(target, name, image=None)[source]
Bases:
USBStorageDriver
- __annotations__ = {}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'), Attribute(name='image', default=None, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='image'))
- __init__(target, name, image=None) None
Method generated by attrs for class NetworkUSBStorageDriver.
- __match_args__ = ('target', 'name', 'image')
- __module__ = 'labgrid.driver.usbstoragedriver'
- __repr__()
Method generated by attrs for class NetworkUSBStorageDriver.
labgrid.driver.usbtmcdriver module
- class labgrid.driver.usbtmcdriver.USBTMCDriver(target, name)[source]
Bases:
Driver
- bindings: Dict[str, Any] = {'tmc': {'NetworkUSBTMC', 'USBTMC'}}
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class USBTMCDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbtmcdriver'
- __repr__()
Method generated by attrs for class USBTMCDriver.
labgrid.driver.usbvideodriver module
- class labgrid.driver.usbvideodriver.USBVideoDriver(target, name)[source]
Bases:
Driver
,VideoProtocol
- bindings: Dict[str, Any] = {'video': {'NetworkUSBVideo', 'USBVideo'}}
- __abstractmethods__ = frozenset({})
- __annotations__ = {'bindings': 'Dict[str, Any]'}
- __attrs_attrs__ = (Attribute(name='target', default=NOTHING, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='target'), Attribute(name='name', default=NOTHING, validator=<optional validator for <instance_of validator for type <class 'str'>> or None>, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=True, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='name'), Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, eq=True, eq_key=None, order=True, order_key=None, hash=None, init=False, metadata=mappingproxy({}), type=None, converter=None, kw_only=False, inherited=True, on_setattr=None, alias='state'))
- __init__(target, name) None
Method generated by attrs for class USBVideoDriver.
- __match_args__ = ('target', 'name')
- __module__ = 'labgrid.driver.usbvideodriver'
- __repr__()
Method generated by attrs for class USBVideoDriver.