@@ -872,7 +872,6 @@ Used by:
872872
873873NetworkUSBSDMuxDevice
874874~~~~~~~~~~~~~~~~~~~~~
875-
876875A :any: `NetworkUSBSDMuxDevice ` resource describes a `USBSDMuxDevice `_ available
877876on a remote computer.
878877
@@ -894,7 +893,6 @@ Used by:
894893
895894NetworkLXAUSBMux
896895~~~~~~~~~~~~~~~~
897-
898896A :any: `NetworkLXAUSBMux ` resource describes a `LXAUSBMux `_ available on a
899897remote computer.
900898
@@ -918,13 +916,11 @@ Used by:
918916
919917NetworkUSBSDWireDevice
920918~~~~~~~~~~~~~~~~~~~~~~
921-
922919A :any: `NetworkUSBSDWireDevice ` resource describes a `USBSDWireDevice `_ available
923920on a remote computer.
924921
925922USBVideo
926923~~~~~~~~
927-
928924A :any: `USBVideo ` resource describes a USB video camera which is supported by a
929925Video4Linux2 kernel driver.
930926
@@ -942,7 +938,6 @@ Used by:
942938
943939SysfsGPIO
944940~~~~~~~~~
945-
946941A :any: `SysfsGPIO ` resource describes a GPIO line.
947942
948943.. code-block :: yaml
@@ -958,13 +953,11 @@ Used by:
958953
959954NetworkUSBVideo
960955~~~~~~~~~~~~~~~
961-
962956A :any: `NetworkUSBVideo ` resource describes a :any: `USBVideo ` resource available
963957on a remote computer.
964958
965959USBAudioInput
966960~~~~~~~~~~~~~
967-
968961A :any: `USBAudioInput ` resource describes a USB audio input which is supported
969962by an ALSA kernel driver.
970963
@@ -984,13 +977,11 @@ Used by:
984977
985978NetworkUSBAudioInput
986979~~~~~~~~~~~~~~~~~~~~
987-
988980A :any: `NetworkUSBAudioInput ` resource describes a :any: `USBAudioInput ` resource
989981available on a remote computer.
990982
991983USBTMC
992984~~~~~~
993-
994985A :any: `USBTMC ` resource describes an oscilloscope connected via the USB TMC
995986protocol.
996987The low-level communication is handled by the ``usbtmc `` kernel driver.
@@ -1016,7 +1007,6 @@ Used by:
10161007
10171008NetworkUSBTMC
10181009~~~~~~~~~~~~~
1019-
10201010A :any: `NetworkUSBTMC ` resource describes a :any: `USBTMC ` resource available
10211011on a remote computer.
10221012
@@ -1103,7 +1093,6 @@ For instance, to flash using 3.5V vcc:
11031093 DediprogFlasher :
11041094 vcc : ' 3.5V'
11051095
1106-
11071096 Used by:
11081097 - `DediprogFlashDriver `_
11091098
@@ -1149,7 +1138,6 @@ Used by:
11491138
11501139HTTPVideoStream
11511140~~~~~~~~~~~~~~~
1152-
11531141A :any: `HTTPVideoStream ` resource describes a IP video stream over HTTP or HTTPS.
11541142
11551143.. code-block :: yaml
@@ -1187,7 +1175,6 @@ labgrid.
11871175
11881176TFTPProvider / HTTPProvider
11891177+++++++++++++++++++++++++++
1190-
11911178.. code-block :: yaml
11921179
11931180 TFTPProvider :
@@ -1208,7 +1195,6 @@ Used by:
12081195
12091196NFSProvider
12101197+++++++++++
1211-
12121198.. code-block :: yaml
12131199
12141200 NFSProvider : {}
@@ -1318,7 +1304,6 @@ Used by:
13181304
13191305udev Matching
13201306~~~~~~~~~~~~~
1321-
13221307labgrid allows the exporter (or the client-side environment) to match resources
13231308via udev rules.
13241309Any udev property key and value can be used, path matching USB devices is
@@ -1374,7 +1359,6 @@ use-cases.
13741359
13751360Matching a USB Serial Converter on a Hub Port
13761361+++++++++++++++++++++++++++++++++++++++++++++
1377-
13781362This will match any USB serial converter connected below the hub port 1.2.5.5
13791363on bus 1.
13801364The `ID_PATH ` value corresponds to the hierarchy of buses and ports as shown
@@ -1393,7 +1377,6 @@ This is necessary for the `USBSerialPort` because we actually want to find the
13931377
13941378Matching an Android USB Fastboot Device
13951379+++++++++++++++++++++++++++++++++++++++
1396-
13971380In this case, we want to match the USB device on that port directly, so we
13981381don't use a parent match.
13991382
@@ -1405,7 +1388,6 @@ don't use a parent match.
14051388
14061389 Matching a Specific UART in a Dual-Port Adapter
14071390+++++++++++++++++++++++++++++++++++++++++++++++
1408-
14091391On this board, the serial console is connected to the second port of an
14101392on-board dual-port USB-UART.
14111393The board itself is connected to the bus 3 and port path 10.2.2.2.
@@ -1457,7 +1439,6 @@ We use the ``ID_USB_INTERFACE_NUM`` to distinguish between the two ports:
14571439
14581440 Matching a USB UART by Serial Number
14591441++++++++++++++++++++++++++++++++++++
1460-
14611442Most of the USB serial converters in our lab have been programmed with unique
14621443serial numbers.
14631444This makes it easy to always match the same one even if the USB topology
@@ -1715,7 +1696,6 @@ Arguments:
17151696
17161697BareboxDriver
17171698~~~~~~~~~~~~~
1718-
17191699A BareboxDriver interfaces with a barebox bootloader via a `ConsoleProtocol `.
17201700
17211701Binds to:
@@ -2804,7 +2784,6 @@ Although the driver can be used from Python code by calling the `stream()`
28042784method, it is currently mainly useful for the ``video `` subcommand of
28052785``labgrid-client ``.
28062786
2807-
28082787========== =========================================================
28092788Key Description
28102789========== =========================================================
@@ -2908,7 +2887,6 @@ Implements:
29082887Arguments:
29092888 - None
29102889
2911-
29122890HttpDigitalOutputDriver
29132891~~~~~~~~~~~~~~~~~~~~~~~
29142892A HttpDigitalOutputDriver binds to a `HttpDigitalOutput ` to set and get a
@@ -2928,7 +2906,6 @@ Implements:
29282906Arguments:
29292907 - None
29302908
2931-
29322909PyVISADriver
29332910~~~~~~~~~~~~
29342911The PyVISADriver uses a PyVISADevice resource to control test equipment manageable by PyVISA.
@@ -3023,7 +3000,6 @@ Arguments:
30233000
30243001Strategies
30253002----------
3026-
30273003Strategies are used to ensure that the device is in a certain state during a test.
30283004Such a state could be the bootloader or a booted Linux kernel with shell.
30293005
@@ -3241,7 +3217,6 @@ The Reporter can be stopped with a call to the stop function:
32413217Stopping the StepReporter if it has not been started will raise an
32423218AssertionError, as will starting an already started StepReporter.
32433219
3244-
32453220ConsoleLoggingReporter
32463221~~~~~~~~~~~~~~~~~~~~~~
32473222The ConsoleLoggingReporter outputs read calls from the console transports into
@@ -3259,12 +3234,9 @@ The Reporter can be stopped with a call to the stop function:
32593234 >>> from labgrid import ConsoleLoggingReporter
32603235 >>> ConsoleLoggingReporter.stop()
32613236
3262-
32633237Stopping the ConsoleLoggingReporter if it has not been started will raise an
32643238AssertionError, as will starting an already started StepReporter.
32653239
3266-
3267-
32683240Environment Configuration
32693241-------------------------
32703242The environment configuration for a test environment consists of a YAML file
0 commit comments