diff --git a/CHANGELOG.md b/CHANGELOG.md index f34c118c..eed06882 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ Things to be included in the next release go here. - Added a step during a device reboot that will reset all the cached properties in the event that one of them changed. - Added command API support for MSO5K, DPO5K, and DPO7K models. - Added a custom, read-only implementation of the [`cached_property`](https://docs.python.org/3/library/functools.html#functools.cached_property) decorator. +- Added default buffer API for SMU 26xx series models. ### Changed @@ -34,6 +35,7 @@ Things to be included in the next release go here. - Fixed the code that detects VISA resource expressions to be able to detect SOCKET resource expressions properly. - Fixed PI device close method to catch VisaIOErrors and throw a warning, rather than an exception, when closing a PI device connection. +- Fixed APIs with query attributes missing under MSO4, MSO5, MSO6 and MSO2 model drivers. ______________________________________________________________________ diff --git a/src/tm_devices/commands/_1ltpwt_mdomsodpo/ch.py b/src/tm_devices/commands/_1ltpwt_mdomsodpo/ch.py index 2c7a8b9e..ea574dc7 100644 --- a/src/tm_devices/commands/_1ltpwt_mdomsodpo/ch.py +++ b/src/tm_devices/commands/_1ltpwt_mdomsodpo/ch.py @@ -169,12 +169,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): """The ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is the - channel number. This setting controls the vertical size of the acquisition window as well - as the display scale. The range and resolution of scale values depends on the probe - attached and any other external factors you have specified. For a signal with constant - amplitude, increasing the scale causes the waveform to be displayed smaller. Decreasing - the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -190,8 +186,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ @@ -1840,12 +1836,8 @@ def scale(self) -> ChannelScale: """Return the ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is - the channel number. This setting controls the vertical size of the acquisition window - as well as the display scale. The range and resolution of scale values depends on the - probe attached and any other external factors you have specified. For a signal with - constant amplitude, increasing the scale causes the waveform to be displayed smaller. - Decreasing the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -1861,8 +1853,8 @@ def scale(self) -> ChannelScale: - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ return self._scale diff --git a/src/tm_devices/commands/_1lwj1r_msomdodpo/__init__.py b/src/tm_devices/commands/_1lwj1r_msomdodpo/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/src/tm_devices/commands/_1lwj1r_msomdodpo/rosc.py b/src/tm_devices/commands/_1lwj1r_msomdodpo/rosc.py new file mode 100644 index 00000000..aff271b9 --- /dev/null +++ b/src/tm_devices/commands/_1lwj1r_msomdodpo/rosc.py @@ -0,0 +1,141 @@ +"""The rosc commands module. + +These commands are used in the following models: +DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO2, MSO4K, MSO4KB + +THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. + +Please report an issue if one is found. + +Commands and Queries: + +:: + + - ROSc:SOUrce {INTERnal|EXTernal} + - ROSc:SOUrce? + - ROSc:STATE? +""" +from typing import Optional, TYPE_CHECKING + +from .._helpers import SCPICmdRead, SCPICmdWrite + +if TYPE_CHECKING: + from tm_devices.drivers.pi.pi_device import PIDevice + + +class RoscState(SCPICmdRead): + """The ``ROSc:STATE`` command. + + **Description:** + - This query-only command returns whether the time base reference oscillator is locked. This + command will return either LOCKED or UNLOCKED. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:STATE?`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - ROSc:STATE? + """ + + +class RoscSource(SCPICmdWrite, SCPICmdRead): + """The ``ROSc:SOUrce`` command. + + **Description:** + - This command sets or queries the selected source for the time base reference oscillator. + The reference oscillator locks to this source. Depending on the command argument that you + specify, you can use an external reference or use the internal crystal oscillator as the + time base reference. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:SOUrce?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``ROSc:SOUrce value`` command. + + **SCPI Syntax:** + + :: + + - ROSc:SOUrce {INTERnal|EXTernal} + - ROSc:SOUrce? + + **Info:** + - ``INTERnal`` specifies the internal 10 MHz crystal oscillator as the time base reference. + - ``EXTernal`` specifies the user-supplied external signal as the time base reference. + """ + + +class Rosc(SCPICmdRead): + """The ``ROSc`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.source``: The ``ROSc:SOUrce`` command. + - ``.state``: The ``ROSc:STATE`` command. + """ + + def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "ROSc") -> None: + super().__init__(device, cmd_syntax) + self._source = RoscSource(device, f"{self._cmd_syntax}:SOUrce") + self._state = RoscState(device, f"{self._cmd_syntax}:STATE") + + @property + def source(self) -> RoscSource: + """Return the ``ROSc:SOUrce`` command. + + **Description:** + - This command sets or queries the selected source for the time base reference + oscillator. The reference oscillator locks to this source. Depending on the command + argument that you specify, you can use an external reference or use the internal + crystal oscillator as the time base reference. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:SOUrce?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``ROSc:SOUrce value`` command. + + **SCPI Syntax:** + + :: + + - ROSc:SOUrce {INTERnal|EXTernal} + - ROSc:SOUrce? + + **Info:** + - ``INTERnal`` specifies the internal 10 MHz crystal oscillator as the time base + reference. + - ``EXTernal`` specifies the user-supplied external signal as the time base reference. + """ + return self._source + + @property + def state(self) -> RoscState: + """Return the ``ROSc:STATE`` command. + + **Description:** + - This query-only command returns whether the time base reference oscillator is locked. + This command will return either LOCKED or UNLOCKED. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:STATE?`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - ROSc:STATE? + """ + return self._state diff --git a/src/tm_devices/commands/_1zn03_mso/bus.py b/src/tm_devices/commands/_1zn03_mso/bus.py index de952b9f..0eaa8280 100644 --- a/src/tm_devices/commands/_1zn03_mso/bus.py +++ b/src/tm_devices/commands/_1zn03_mso/bus.py @@ -82,16 +82,19 @@ - BUS:B:LIN:STANDard? - BUS:B:PARallel:ALLTHResholds - BUS:B:PARallel:ALLTHResholds:APPly + - BUS:B:PARallel:ALLTHResholds? - BUS:B:PARallel:BITSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} - BUS:B:PARallel:BITSOUrce:THReshold - - BUS:B:PARallel:CLOCKSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} - - BUS:B:PARallel:CLOCKSOUrce:THReshold - - BUS:B:PARallel:CLOCKSOUrce:THReshold? - - BUS:B:PARallel:CLOCKSOUrce? + - BUS:B:PARallel:BITSOUrce:THReshold? + - BUS:B:PARallel:BITSOUrce? - BUS:B:PARallel:CLOCk:EDGE {FALLING|RISING|EITHER} - BUS:B:PARallel:CLOCk:EDGE? - BUS:B:PARallel:CLOCk:ISCLOCKED {OFF|ON|} - BUS:B:PARallel:CLOCk:ISCLOCKED? + - BUS:B:PARallel:CLOCkSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} + - BUS:B:PARallel:CLOCkSOUrce:THReshold + - BUS:B:PARallel:CLOCkSOUrce:THReshold? + - BUS:B:PARallel:CLOCkSOUrce? - BUS:B:RS232C:BITRate {CUSTOM|RATE300|RATE1K|RATE2K|RATE9K| RATE19K|RATE38K|RATE115K|RATE921K} - BUS:B:RS232C:BITRate:CUSTom - BUS:B:RS232C:BITRate:CUSTom? @@ -2985,6 +2988,107 @@ def source(self) -> BusBItemRs232cSource: return self._source +class BusBItemParallelClocksourceThreshold(SCPICmdWrite, SCPICmdRead): + """The ``BUS:B:PARallel:CLOCkSOUrce:THReshold`` command. + + **Description:** + - This command sets or queries the clock source threshold for the parallel bus. The bus is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCkSOUrce:THReshold?`` + query. + - Using the ``.verify(value)`` method will send the + ``BUS:B:PARallel:CLOCkSOUrce:THReshold?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``BUS:B:PARallel:CLOCkSOUrce:THReshold value`` command. + + **SCPI Syntax:** + + :: + + - BUS:B:PARallel:CLOCkSOUrce:THReshold + - BUS:B:PARallel:CLOCkSOUrce:THReshold? + + **Info:** + - ```` is the clock bit source threshold for the parallel bus. + """ + + +class BusBItemParallelClocksource(SCPICmdWrite, SCPICmdRead): + """The ``BUS:B:PARallel:CLOCkSOUrce`` command. + + **Description:** + - This command sets or queries the Parallel clock bit source for the specified bus. The bus + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCkSOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCkSOUrce?`` query + and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:CLOCkSOUrce value`` + command. + + **SCPI Syntax:** + + :: + + - BUS:B:PARallel:CLOCkSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} + - BUS:B:PARallel:CLOCkSOUrce? + + **Info:** + - ``B`` is the number of the bus. + - ``CH`` specifies an analog FlexChannel to use as the bus clock source. + - ``DCH_D`` specifies a digital channel on a specified digital channel to use as the + bus clock source. The supported digital channel value is 1. The supported digital bit + values are 0 to 15. + - ``MATH`` specifies the math channel to use as the bus clock source. + - ``REF`` specifies the reference channel to use as the bus clock source. + - ``REF_D`` specifies a digital reference waveform as the clock source waveform for + the specified parallel bus. + - ``NONE`` specifies the reference channel to use as the bus clock source. + + Properties: + - ``.threshold``: The ``BUS:B:PARallel:CLOCkSOUrce:THReshold`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._threshold = BusBItemParallelClocksourceThreshold( + device, f"{self._cmd_syntax}:THReshold" + ) + + @property + def threshold(self) -> BusBItemParallelClocksourceThreshold: + """Return the ``BUS:B:PARallel:CLOCkSOUrce:THReshold`` command. + + **Description:** + - This command sets or queries the clock source threshold for the parallel bus. The bus + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``BUS:B:PARallel:CLOCkSOUrce:THReshold?`` query. + - Using the ``.verify(value)`` method will send the + ``BUS:B:PARallel:CLOCkSOUrce:THReshold?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``BUS:B:PARallel:CLOCkSOUrce:THReshold value`` command. + + **SCPI Syntax:** + + :: + + - BUS:B:PARallel:CLOCkSOUrce:THReshold + - BUS:B:PARallel:CLOCkSOUrce:THReshold? + + **Info:** + - ```` is the clock bit source threshold for the parallel bus. + """ + return self._threshold + + class BusBItemParallelClockIsclocked(SCPICmdWrite, SCPICmdRead): """The ``BUS:B:PARallel:CLOCk:ISCLOCKED`` command. @@ -3127,117 +3231,20 @@ def isclocked(self) -> BusBItemParallelClockIsclocked: return self._isclocked -class BusBItemParallelClocksourceThreshold(SCPICmdWrite, SCPICmdRead): - """The ``BUS:B:PARallel:CLOCKSOUrce:THReshold`` command. +class BusBItemParallelBitsourceItemThreshold(SCPICmdWrite, SCPICmdRead): + """The ``BUS:B:PARallel:BITSOUrce:THReshold`` command. **Description:** - - This command sets or queries the clock source threshold for the parallel bus. The bus is - specified by x. + - This command sets or queries the specified bit source threshold for the specified parallel + bus. The bus is specified by x. The bit is specified by x and is an integer in the range + of 1 to 64. **Usage:** - - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCKSOUrce:THReshold?`` + - Using the ``.query()`` method will send the ``BUS:B:PARallel:BITSOUrce:THReshold?`` query. - Using the ``.verify(value)`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce:THReshold?`` query and raise an AssertionError if the + ``BUS:B:PARallel:BITSOUrce:THReshold?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce:THReshold value`` command. - - **SCPI Syntax:** - - :: - - - BUS:B:PARallel:CLOCKSOUrce:THReshold - - BUS:B:PARallel:CLOCKSOUrce:THReshold? - - **Info:** - - ``B`` is the Bus number. - - ```` is the clock bit source threshold for the parallel bus. - """ - - -class BusBItemParallelClocksource(SCPICmdWrite, SCPICmdRead): - """The ``BUS:B:PARallel:CLOCKSOUrce`` command. - - **Description:** - - This command sets or queries the Parallel clock bit source for the specified bus. The bus - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCKSOUrce?`` query. - - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCKSOUrce?`` query - and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:CLOCKSOUrce value`` - command. - - **SCPI Syntax:** - - :: - - - BUS:B:PARallel:CLOCKSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} - - BUS:B:PARallel:CLOCKSOUrce? - - **Info:** - - ``B`` is the number of the bus. - - ``CH`` specifies an analog FlexChannel to use as the bus clock source. - - ``DCH_D`` specifies a digital channel on a specified digital channel to use as the - bus clock source. The supported digital channel value is 1. The supported digital bit - values are 0 to 15. - - ``MATH`` specifies the math channel to use as the bus clock source. - - ``REF`` specifies the reference channel to use as the bus clock source. - - ``REF_D`` specifies a digital reference waveform as the clock source waveform for - the specified parallel bus. - - ``NONE`` specifies the reference channel to use as the bus clock source. - - Properties: - - ``.threshold``: The ``BUS:B:PARallel:CLOCKSOUrce:THReshold`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._threshold = BusBItemParallelClocksourceThreshold( - device, f"{self._cmd_syntax}:THReshold" - ) - - @property - def threshold(self) -> BusBItemParallelClocksourceThreshold: - """Return the ``BUS:B:PARallel:CLOCKSOUrce:THReshold`` command. - - **Description:** - - This command sets or queries the clock source threshold for the parallel bus. The bus - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce:THReshold?`` query. - - Using the ``.verify(value)`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce:THReshold?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce:THReshold value`` command. - - **SCPI Syntax:** - - :: - - - BUS:B:PARallel:CLOCKSOUrce:THReshold - - BUS:B:PARallel:CLOCKSOUrce:THReshold? - - **Info:** - - ``B`` is the Bus number. - - ```` is the clock bit source threshold for the parallel bus. - """ - return self._threshold - - -class BusBItemParallelBitsourceItemThreshold(SCPICmdWrite): - """The ``BUS:B:PARallel:BITSOUrce:THReshold`` command. - - **Description:** - - This command sets or queries the specified bit source threshold for the specified parallel - bus. - - **Usage:** - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:BITSOUrce:THReshold value`` command. @@ -3246,10 +3253,11 @@ class BusBItemParallelBitsourceItemThreshold(SCPICmdWrite): :: - BUS:B:PARallel:BITSOUrce:THReshold + - BUS:B:PARallel:BITSOUrce:THReshold? **Info:** - ``B`` is the number of the bus. - - ``BIT`` is the number of the bit and is an integer in the range of 1 to 64. + - ``BIT`` is the number of the bit source. - ```` is the specified bit source threshold for the specified parallel bus. """ @@ -3259,9 +3267,12 @@ class BusBItemParallelBitsourceItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCP **Description:** - This command sets or queries the specified bit source for specified parallel bus. The bus - is specified by x. The bit is specified by n and is an integer in the range of 1 to 64. + is specified by x. The bit is specified by x and is an integer in the range of 1 to 64. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:BITSOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:BITSOUrce?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:BITSOUrce value`` command. @@ -3270,9 +3281,11 @@ class BusBItemParallelBitsourceItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCP :: - BUS:B:PARallel:BITSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} + - BUS:B:PARallel:BITSOUrce? **Info:** - ``B`` is the number of the bus. + - ``BIT`` is the number of the bit source. - ``CH`` is the specified bit source. - ``DCH_D`` specifies a digital channel to use as the source. The supported digital channel value is 1. The supported digital bit values are 0 to 15. @@ -3298,9 +3311,15 @@ def threshold(self) -> BusBItemParallelBitsourceItemThreshold: **Description:** - This command sets or queries the specified bit source threshold for the specified - parallel bus. + parallel bus. The bus is specified by x. The bit is specified by x and is an integer + in the range of 1 to 64. **Usage:** + - Using the ``.query()`` method will send the + ``BUS:B:PARallel:BITSOUrce:THReshold?`` query. + - Using the ``.verify(value)`` method will send the + ``BUS:B:PARallel:BITSOUrce:THReshold?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:BITSOUrce:THReshold value`` command. @@ -3309,10 +3328,11 @@ def threshold(self) -> BusBItemParallelBitsourceItemThreshold: :: - BUS:B:PARallel:BITSOUrce:THReshold + - BUS:B:PARallel:BITSOUrce:THReshold? **Info:** - ``B`` is the number of the bus. - - ``BIT`` is the number of the bit and is an integer in the range of 1 to 64. + - ``BIT`` is the number of the bit source. - ```` is the specified bit source threshold for the specified parallel bus. """ return self._threshold @@ -3349,6 +3369,9 @@ class BusBItemParallelAllthresholds(SCPICmdWrite, SCPICmdRead): bus is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:ALLTHResholds?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:ALLTHResholds?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:ALLTHResholds value`` command. @@ -3357,6 +3380,7 @@ class BusBItemParallelAllthresholds(SCPICmdWrite, SCPICmdRead): :: - BUS:B:PARallel:ALLTHResholds + - BUS:B:PARallel:ALLTHResholds? **Info:** - ``B`` is the number of the bus. @@ -3408,8 +3432,8 @@ class BusBItemParallel(SCPICmdRead): Properties: - ``.allthresholds``: The ``BUS:B:PARallel:ALLTHResholds`` command. - ``.bitsource``: The ``BUS:B:PARallel:BITSOUrce`` command. - - ``.clocksource``: The ``BUS:B:PARallel:CLOCKSOUrce`` command. - ``.clock``: The ``BUS:B:PARallel:CLOCk`` command tree. + - ``.clocksource``: The ``BUS:B:PARallel:CLOCkSOUrce`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: @@ -3420,8 +3444,8 @@ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: self._bitsource: Dict[int, BusBItemParallelBitsourceItem] = DefaultDictPassKeyToFactory( lambda x: BusBItemParallelBitsourceItem(device, f"{self._cmd_syntax}:BIT{x}SOUrce") ) - self._clocksource = BusBItemParallelClocksource(device, f"{self._cmd_syntax}:CLOCKSOUrce") self._clock = BusBItemParallelClock(device, f"{self._cmd_syntax}:CLOCk") + self._clocksource = BusBItemParallelClocksource(device, f"{self._cmd_syntax}:CLOCkSOUrce") @property def allthresholds(self) -> BusBItemParallelAllthresholds: @@ -3433,6 +3457,10 @@ def allthresholds(self) -> BusBItemParallelAllthresholds: value. The bus is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:ALLTHResholds?`` + query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:ALLTHResholds?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:ALLTHResholds value`` command. @@ -3441,6 +3469,7 @@ def allthresholds(self) -> BusBItemParallelAllthresholds: :: - BUS:B:PARallel:ALLTHResholds + - BUS:B:PARallel:ALLTHResholds? **Info:** - ``B`` is the number of the bus. @@ -3457,10 +3486,13 @@ def bitsource(self) -> Dict[int, BusBItemParallelBitsourceItem]: **Description:** - This command sets or queries the specified bit source for specified parallel bus. The - bus is specified by x. The bit is specified by n and is an integer in the range of 1 + bus is specified by x. The bit is specified by x and is an integer in the range of 1 to 64. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:BITSOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:BITSOUrce?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:PARallel:BITSOUrce value`` command. @@ -3469,9 +3501,11 @@ def bitsource(self) -> Dict[int, BusBItemParallelBitsourceItem]: :: - BUS:B:PARallel:BITSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} + - BUS:B:PARallel:BITSOUrce? **Info:** - ``B`` is the number of the bus. + - ``BIT`` is the number of the bit source. - ``CH`` is the specified bit source. - ``DCH_D`` specifies a digital channel to use as the source. The supported digital channel value is 1. The supported digital bit values are 0 to 15. @@ -3486,27 +3520,45 @@ def bitsource(self) -> Dict[int, BusBItemParallelBitsourceItem]: """ # noqa: E501 return self._bitsource + @property + def clock(self) -> BusBItemParallelClock: + """Return the ``BUS:B:PARallel:CLOCk`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCk?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCk?`` query + and raise an AssertionError if the returned value does not match ``value``. + + **Info:** + - ``B`` is the number of the bus. + + Sub-properties: + - ``.edge``: The ``BUS:B:PARallel:CLOCk:EDGE`` command. + - ``.isclocked``: The ``BUS:B:PARallel:CLOCk:ISCLOCKED`` command. + """ + return self._clock + @property def clocksource(self) -> BusBItemParallelClocksource: - """Return the ``BUS:B:PARallel:CLOCKSOUrce`` command. + """Return the ``BUS:B:PARallel:CLOCkSOUrce`` command. **Description:** - This command sets or queries the Parallel clock bit source for the specified bus. The bus is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCKSOUrce?`` query. - - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCKSOUrce?`` + - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCkSOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCkSOUrce?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``BUS:B:PARallel:CLOCKSOUrce value`` command. + ``BUS:B:PARallel:CLOCkSOUrce value`` command. **SCPI Syntax:** :: - - BUS:B:PARallel:CLOCKSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} - - BUS:B:PARallel:CLOCKSOUrce? + - BUS:B:PARallel:CLOCkSOUrce {CH| DCH_D| MATH| REF| REF_D| NONE} + - BUS:B:PARallel:CLOCkSOUrce? **Info:** - ``B`` is the number of the bus. @@ -3521,28 +3573,10 @@ def clocksource(self) -> BusBItemParallelClocksource: - ``NONE`` specifies the reference channel to use as the bus clock source. Sub-properties: - - ``.threshold``: The ``BUS:B:PARallel:CLOCKSOUrce:THReshold`` command. + - ``.threshold``: The ``BUS:B:PARallel:CLOCkSOUrce:THReshold`` command. """ return self._clocksource - @property - def clock(self) -> BusBItemParallelClock: - """Return the ``BUS:B:PARallel:CLOCk`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``BUS:B:PARallel:CLOCk?`` query. - - Using the ``.verify(value)`` method will send the ``BUS:B:PARallel:CLOCk?`` query - and raise an AssertionError if the returned value does not match ``value``. - - **Info:** - - ``B`` is the number of the bus. - - Sub-properties: - - ``.edge``: The ``BUS:B:PARallel:CLOCk:EDGE`` command. - - ``.isclocked``: The ``BUS:B:PARallel:CLOCk:ISCLOCKED`` command. - """ - return self._clock - class BusBItemLinStandard(SCPICmdWrite, SCPICmdRead): """The ``BUS:B:LIN:STANDard`` command. @@ -5951,8 +5985,8 @@ def parallel(self) -> BusBItemParallel: Sub-properties: - ``.allthresholds``: The ``BUS:B:PARallel:ALLTHResholds`` command. - ``.bitsource``: The ``BUS:B:PARallel:BITSOUrce`` command. - - ``.clocksource``: The ``BUS:B:PARallel:CLOCKSOUrce`` command. - ``.clock``: The ``BUS:B:PARallel:CLOCk`` command tree. + - ``.clocksource``: The ``BUS:B:PARallel:CLOCkSOUrce`` command. """ return self._parallel diff --git a/src/tm_devices/commands/_1zn03_mso/callouts.py b/src/tm_devices/commands/_1zn03_mso/callouts.py index 6918f8e2..3914dba2 100644 --- a/src/tm_devices/commands/_1zn03_mso/callouts.py +++ b/src/tm_devices/commands/_1zn03_mso/callouts.py @@ -11,7 +11,7 @@ :: - - CALLOUTS:CALLOUT + - CALLOUTS:ADDNew - CALLOUTS:CALLOUT:BOOKMark:SOURCE {CH} - CALLOUTS:CALLOUT:BOOKMark:SOURCE? - CALLOUTS:CALLOUT:BOOKMark:XPOS @@ -36,6 +36,7 @@ - CALLOUTS:CALLOUT:TEXT? - CALLOUTS:CALLOUT:TYPE {NOTE|ARROW|RECTANGLE|BOOKMARK} - CALLOUTS:CALLOUT:TYPE? + - CALLOUTS:DELete """ from typing import Dict, Optional, TYPE_CHECKING @@ -43,7 +44,6 @@ DefaultDictPassKeyToFactory, SCPICmdRead, SCPICmdWrite, - SCPICmdWriteNoArguments, ValidatedDynamicNumberCmd, ) @@ -51,6 +51,29 @@ from tm_devices.drivers.pi.pi_device import PIDevice +class CalloutsDelete(SCPICmdWrite): + """The ``CALLOUTS:DELete`` command. + + **Description:** + - This command deletes the specified callout. A Note is the default callout type. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CALLOUTS:DELete value`` command. + + **SCPI Syntax:** + + :: + + - CALLOUTS:DELete + + **Info:** + - ```` specifies the callout. The argument is of the form 'CALLOUT', where + is a number value ≥ 1. + """ + + _WRAP_ARG_WITH_QUOTES = True + + class CalloutsCalloutItemType(SCPICmdWrite, SCPICmdRead): """The ``CALLOUTS:CALLOUT:TYPE`` command. @@ -691,21 +714,13 @@ def xpos(self) -> CalloutsCalloutItemBookmarkXpos: return self._xpos -class CalloutsCalloutItem(ValidatedDynamicNumberCmd, SCPICmdWriteNoArguments, SCPICmdRead): - """The ``CALLOUTS:CALLOUT`` command. - - **Description:** - - This command creates a new note. A Note is the default callout value. The callout number - is specified by x. +class CalloutsCalloutItem(ValidatedDynamicNumberCmd, SCPICmdRead): + """The ``CALLOUTS:CALLOUT`` command tree. **Usage:** - - Using the ``.write()`` method will send the ``CALLOUTS:CALLOUT`` command. - - **SCPI Syntax:** - - :: - - - CALLOUTS:CALLOUT + - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT?`` query. + - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT?`` query and raise + an AssertionError if the returned value does not match ``value``. Properties: - ``.bookmark``: The ``CALLOUTS:CALLOUT:BOOKMark`` command tree. @@ -859,6 +874,29 @@ def type(self) -> CalloutsCalloutItemType: return self._type +class CalloutsAddnew(SCPICmdWrite): + """The ``CALLOUTS:ADDNew`` command. + + **Description:** + - This command adds the specified callout. A Note is the default callout type. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CALLOUTS:ADDNew value`` command. + + **SCPI Syntax:** + + :: + + - CALLOUTS:ADDNew + + **Info:** + - ```` specifies the callout. The argument is of the form 'CALLOUT', where + is a number value ≥ 1. + """ + + _WRAP_ARG_WITH_QUOTES = True + + class Callouts(SCPICmdRead): """The ``CALLOUTS`` command tree. @@ -868,31 +906,49 @@ class Callouts(SCPICmdRead): AssertionError if the returned value does not match ``value``. Properties: - - ``.callout``: The ``CALLOUTS:CALLOUT`` command. + - ``.addnew``: The ``CALLOUTS:ADDNew`` command. + - ``.callout``: The ``CALLOUTS:CALLOUT`` command tree. + - ``.delete``: The ``CALLOUTS:DELete`` command. """ def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "CALLOUTS") -> None: super().__init__(device, cmd_syntax) + self._addnew = CalloutsAddnew(device, f"{self._cmd_syntax}:ADDNew") self._callout: Dict[int, CalloutsCalloutItem] = DefaultDictPassKeyToFactory( lambda x: CalloutsCalloutItem(device, f"{self._cmd_syntax}:CALLOUT{x}") ) + self._delete = CalloutsDelete(device, f"{self._cmd_syntax}:DELete") @property - def callout(self) -> Dict[int, CalloutsCalloutItem]: - """Return the ``CALLOUTS:CALLOUT`` command. + def addnew(self) -> CalloutsAddnew: + """Return the ``CALLOUTS:ADDNew`` command. **Description:** - - This command creates a new note. A Note is the default callout value. The callout - number is specified by x. + - This command adds the specified callout. A Note is the default callout type. **Usage:** - - Using the ``.write()`` method will send the ``CALLOUTS:CALLOUT`` command. + - Using the ``.write(value)`` method will send the ``CALLOUTS:ADDNew value`` command. **SCPI Syntax:** :: - - CALLOUTS:CALLOUT + - CALLOUTS:ADDNew + + **Info:** + - ```` specifies the callout. The argument is of the form 'CALLOUT', where + is a number value ≥ 1. + """ + return self._addnew + + @property + def callout(self) -> Dict[int, CalloutsCalloutItem]: + """Return the ``CALLOUTS:CALLOUT`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``CALLOUTS:CALLOUT?`` query. + - Using the ``.verify(value)`` method will send the ``CALLOUTS:CALLOUT?`` query and + raise an AssertionError if the returned value does not match ``value``. Sub-properties: - ``.bookmark``: The ``CALLOUTS:CALLOUT:BOOKMark`` command tree. @@ -903,3 +959,25 @@ def callout(self) -> Dict[int, CalloutsCalloutItem]: - ``.type``: The ``CALLOUTS:CALLOUT:TYPE`` command. """ return self._callout + + @property + def delete(self) -> CalloutsDelete: + """Return the ``CALLOUTS:DELete`` command. + + **Description:** + - This command deletes the specified callout. A Note is the default callout type. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CALLOUTS:DELete value`` command. + + **SCPI Syntax:** + + :: + + - CALLOUTS:DELete + + **Info:** + - ```` specifies the callout. The argument is of the form 'CALLOUT', where + is a number value ≥ 1. + """ + return self._delete diff --git a/src/tm_devices/commands/_1zn03_mso/ch.py b/src/tm_devices/commands/_1zn03_mso/ch.py index 9716ffa3..a6672663 100644 --- a/src/tm_devices/commands/_1zn03_mso/ch.py +++ b/src/tm_devices/commands/_1zn03_mso/ch.py @@ -20,14 +20,21 @@ - CH:DESKew - CH:DESKew? - CH:DITHERrange + - CH:DITHERrange? - CH:INVert {ON|OFF|} - CH:INVert? - CH:LABel:COLor + - CH:LABel:COLor? - CH:LABel:FONT:BOLD {ON|OFF|} + - CH:LABel:FONT:BOLD? - CH:LABel:FONT:ITALic {ON|OFF|} + - CH:LABel:FONT:ITALic? - CH:LABel:FONT:SIZE + - CH:LABel:FONT:SIZE? - CH:LABel:FONT:TYPE + - CH:LABel:FONT:TYPE? - CH:LABel:FONT:UNDERline {ON|OFF|} + - CH:LABel:FONT:UNDERline? - CH:LABel:NAMe - CH:LABel:NAMe? - CH:LABel:XPOS @@ -37,16 +44,19 @@ - CH:OFFSet - CH:OFFSet? - CH:POSition + - CH:POSition? - CH:PROBEFunc:EXTAtten - CH:PROBEFunc:EXTAtten? - CH:PROBEFunc:EXTDBatten - CH:PROBEFunc:EXTDBatten? - CH:PROBEFunc:EXTUnits - CH:PROBEFunc:EXTUnits:STATE {ON|OFF|} + - CH:PROBEFunc:EXTUnits:STATE? - CH:PROBEFunc:EXTUnits? - CH:SCALERATio - CH:SCALERATio? - CH:SCAle + - CH:SCAle? - CH:TERmination - CH:TERmination? - CH:VTERm:BIAS @@ -161,7 +171,7 @@ class ChannelTermination(SCPICmdWrite, SCPICmdRead): """ -class ChannelScale(SCPICmdWrite): +class ChannelScale(SCPICmdWrite, SCPICmdRead): """The ``CH:SCAle`` command. **Description:** @@ -169,6 +179,9 @@ class ChannelScale(SCPICmdWrite): channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:SCAle?`` query. + - Using the ``.verify(value)`` method will send the ``CH:SCAle?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:SCAle value`` command. **SCPI Syntax:** @@ -176,6 +189,7 @@ class ChannelScale(SCPICmdWrite): :: - CH:SCAle + - CH:SCAle? **Info:** - ``CH`` is the channel number. @@ -208,14 +222,19 @@ class ChannelScaleratio(SCPICmdWrite, SCPICmdRead): """ -class ChannelProbefuncExtunitsState(SCPICmdWrite): +class ChannelProbefuncExtunitsState(SCPICmdWrite, SCPICmdRead): """The ``CH:PROBEFunc:EXTUnits:STATE`` command. **Description:** - - This command sets or queries the custom units enable state for the specified channel. The - channel is specified by x. + - This command sets or queries measure current status as ON or OFF. The channel is specified + by x. If this command is set, the vertical scale is set to 'A', as it implies that the + unit is measuring current from a voltage probe. When it is unset, the vertical scale is + set to the value of ``CHX:PROBEFUNC:EXTUNITS`` ('V' or 'A'). **Usage:** + - Using the ``.query()`` method will send the ``CH:PROBEFunc:EXTUnits:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:PROBEFunc:EXTUnits:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:PROBEFunc:EXTUnits:STATE value`` command. @@ -224,12 +243,13 @@ class ChannelProbefuncExtunitsState(SCPICmdWrite): :: - CH:PROBEFunc:EXTUnits:STATE {ON|OFF|} + - CH:PROBEFunc:EXTUnits:STATE? **Info:** - ``CH`` is the channel number. - - ``OFF`` argument turns off external units. - - ``ON`` argument turns on external units. - - ```` = 0 turns off external units; any other value turns on external units. + - ``OFF`` argument turns current status off. + - ``ON`` argument turns current status on. + - ```` = 0 turns current status off; any other value turns current status on. """ @@ -274,10 +294,15 @@ def state(self) -> ChannelProbefuncExtunitsState: """Return the ``CH:PROBEFunc:EXTUnits:STATE`` command. **Description:** - - This command sets or queries the custom units enable state for the specified channel. - The channel is specified by x. + - This command sets or queries measure current status as ON or OFF. The channel is + specified by x. If this command is set, the vertical scale is set to 'A', as it + implies that the unit is measuring current from a voltage probe. When it is unset, the + vertical scale is set to the value of ``CHX:PROBEFUNC:EXTUNITS`` ('V' or 'A'). **Usage:** + - Using the ``.query()`` method will send the ``CH:PROBEFunc:EXTUnits:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:PROBEFunc:EXTUnits:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:PROBEFunc:EXTUnits:STATE value`` command. @@ -286,12 +311,13 @@ def state(self) -> ChannelProbefuncExtunitsState: :: - CH:PROBEFunc:EXTUnits:STATE {ON|OFF|} + - CH:PROBEFunc:EXTUnits:STATE? **Info:** - ``CH`` is the channel number. - - ``OFF`` argument turns off external units. - - ``ON`` argument turns on external units. - - ```` = 0 turns off external units; any other value turns on external units. + - ``OFF`` argument turns current status off. + - ``ON`` argument turns current status on. + - ```` = 0 turns current status off; any other value turns current status on. """ return self._state @@ -473,13 +499,16 @@ def extunits(self) -> ChannelProbefuncExtunits: return self._extunits -class ChannelPosition(SCPICmdWrite): +class ChannelPosition(SCPICmdWrite, SCPICmdRead): """The ``CH:POSition`` command. **Description:** - This command sets or queries the vertical position for the specified analog channel. **Usage:** + - Using the ``.query()`` method will send the ``CH:POSition?`` query. + - Using the ``.verify(value)`` method will send the ``CH:POSition?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:POSition value`` command. **SCPI Syntax:** @@ -487,6 +516,7 @@ class ChannelPosition(SCPICmdWrite): :: - CH:POSition + - CH:POSition? **Info:** - ``CH`` is the channel number. @@ -603,7 +633,7 @@ class ChannelLabelName(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class ChannelLabelFontUnderline(SCPICmdWrite): +class ChannelLabelFontUnderline(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:FONT:UNDERline`` command. **Description:** @@ -611,6 +641,9 @@ class ChannelLabelFontUnderline(SCPICmdWrite): channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:UNDERline?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:UNDERline?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:UNDERline value`` command. @@ -619,6 +652,7 @@ class ChannelLabelFontUnderline(SCPICmdWrite): :: - CH:LABel:FONT:UNDERline {ON|OFF|} + - CH:LABel:FONT:UNDERline? **Info:** - ``CH`` is the channel number. @@ -628,7 +662,7 @@ class ChannelLabelFontUnderline(SCPICmdWrite): """ -class ChannelLabelFontType(SCPICmdWrite): +class ChannelLabelFontType(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:FONT:TYPE`` command. **Description:** @@ -636,6 +670,9 @@ class ChannelLabelFontType(SCPICmdWrite): or Times New Roman. The channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:TYPE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:TYPE value`` command. **SCPI Syntax:** @@ -643,6 +680,7 @@ class ChannelLabelFontType(SCPICmdWrite): :: - CH:LABel:FONT:TYPE + - CH:LABel:FONT:TYPE? **Info:** - ``CH`` is the channel number. @@ -652,7 +690,7 @@ class ChannelLabelFontType(SCPICmdWrite): _WRAP_ARG_WITH_QUOTES = True -class ChannelLabelFontSize(SCPICmdWrite): +class ChannelLabelFontSize(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:FONT:SIZE`` command. **Description:** @@ -660,6 +698,9 @@ class ChannelLabelFontSize(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:SIZE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:SIZE value`` command. **SCPI Syntax:** @@ -667,6 +708,7 @@ class ChannelLabelFontSize(SCPICmdWrite): :: - CH:LABel:FONT:SIZE + - CH:LABel:FONT:SIZE? **Info:** - ``CH`` is the channel number. @@ -674,7 +716,7 @@ class ChannelLabelFontSize(SCPICmdWrite): """ -class ChannelLabelFontItalic(SCPICmdWrite): +class ChannelLabelFontItalic(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:FONT:ITALic`` command. **Description:** @@ -682,6 +724,9 @@ class ChannelLabelFontItalic(SCPICmdWrite): is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:ITALic?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:ITALic value`` command. @@ -690,6 +735,7 @@ class ChannelLabelFontItalic(SCPICmdWrite): :: - CH:LABel:FONT:ITALic {ON|OFF|} + - CH:LABel:FONT:ITALic? **Info:** - ``CH`` is the channel number. @@ -699,7 +745,7 @@ class ChannelLabelFontItalic(SCPICmdWrite): """ -class ChannelLabelFontBold(SCPICmdWrite): +class ChannelLabelFontBold(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:FONT:BOLD`` command. **Description:** @@ -707,6 +753,9 @@ class ChannelLabelFontBold(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:BOLD?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:BOLD value`` command. **SCPI Syntax:** @@ -714,6 +763,7 @@ class ChannelLabelFontBold(SCPICmdWrite): :: - CH:LABel:FONT:BOLD {ON|OFF|} + - CH:LABel:FONT:BOLD? **Info:** - ``CH`` is the channel number. @@ -759,6 +809,9 @@ def bold(self) -> ChannelLabelFontBold: channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:BOLD?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:BOLD value`` command. @@ -767,6 +820,7 @@ def bold(self) -> ChannelLabelFontBold: :: - CH:LABel:FONT:BOLD {ON|OFF|} + - CH:LABel:FONT:BOLD? **Info:** - ``CH`` is the channel number. @@ -785,6 +839,9 @@ def italic(self) -> ChannelLabelFontItalic: channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:ITALic?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:ITALic value`` command. @@ -793,6 +850,7 @@ def italic(self) -> ChannelLabelFontItalic: :: - CH:LABel:FONT:ITALic {ON|OFF|} + - CH:LABel:FONT:ITALic? **Info:** - ``CH`` is the channel number. @@ -811,6 +869,9 @@ def size(self) -> ChannelLabelFontSize: is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:SIZE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:SIZE value`` command. @@ -819,6 +880,7 @@ def size(self) -> ChannelLabelFontSize: :: - CH:LABel:FONT:SIZE + - CH:LABel:FONT:SIZE? **Info:** - ``CH`` is the channel number. @@ -835,6 +897,9 @@ def type(self) -> ChannelLabelFontType: Arial or Times New Roman. The channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:TYPE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:TYPE value`` command. @@ -843,6 +908,7 @@ def type(self) -> ChannelLabelFontType: :: - CH:LABel:FONT:TYPE + - CH:LABel:FONT:TYPE? **Info:** - ``CH`` is the channel number. @@ -859,6 +925,9 @@ def underline(self) -> ChannelLabelFontUnderline: channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:FONT:UNDERline?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:FONT:UNDERline?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:FONT:UNDERline value`` command. @@ -867,6 +936,7 @@ def underline(self) -> ChannelLabelFontUnderline: :: - CH:LABel:FONT:UNDERline {ON|OFF|} + - CH:LABel:FONT:UNDERline? **Info:** - ``CH`` is the channel number. @@ -877,7 +947,7 @@ def underline(self) -> ChannelLabelFontUnderline: return self._underline -class ChannelLabelColor(SCPICmdWrite): +class ChannelLabelColor(SCPICmdWrite, SCPICmdRead): """The ``CH:LABel:COLor`` command. **Description:** @@ -885,6 +955,9 @@ class ChannelLabelColor(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:COLor?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:COLor value`` command. **SCPI Syntax:** @@ -892,6 +965,7 @@ class ChannelLabelColor(SCPICmdWrite): :: - CH:LABel:COLor + - CH:LABel:COLor? **Info:** - ``CH`` is the channel number. @@ -938,6 +1012,9 @@ def color(self) -> ChannelLabelColor: specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``CH:LABel:COLor?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:LABel:COLor value`` command. **SCPI Syntax:** @@ -945,6 +1022,7 @@ def color(self) -> ChannelLabelColor: :: - CH:LABel:COLor + - CH:LABel:COLor? **Info:** - ``CH`` is the channel number. @@ -1087,7 +1165,7 @@ class ChannelInvert(SCPICmdWrite, SCPICmdRead): """ -class ChannelDitherrange(SCPICmdWrite): +class ChannelDitherrange(SCPICmdWrite, SCPICmdRead): """The ``CH:DITHERrange`` command. **Description:** @@ -1097,6 +1175,9 @@ class ChannelDitherrange(SCPICmdWrite): improve performance. **Usage:** + - Using the ``.query()`` method will send the ``CH:DITHERrange?`` query. + - Using the ``.verify(value)`` method will send the ``CH:DITHERrange?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:DITHERrange value`` command. **SCPI Syntax:** @@ -1104,6 +1185,7 @@ class ChannelDitherrange(SCPICmdWrite): :: - CH:DITHERrange + - CH:DITHERrange? **Info:** - ```` is the amount of dithering as a percentage of full scale. Must be between 0.0 @@ -1394,6 +1476,9 @@ def ditherrange(self) -> ChannelDitherrange: slightly improve performance. **Usage:** + - Using the ``.query()`` method will send the ``CH:DITHERrange?`` query. + - Using the ``.verify(value)`` method will send the ``CH:DITHERrange?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:DITHERrange value`` command. **SCPI Syntax:** @@ -1401,6 +1486,7 @@ def ditherrange(self) -> ChannelDitherrange: :: - CH:DITHERrange + - CH:DITHERrange? **Info:** - ```` is the amount of dithering as a percentage of full scale. Must be between @@ -1491,6 +1577,9 @@ def position(self) -> ChannelPosition: - This command sets or queries the vertical position for the specified analog channel. **Usage:** + - Using the ``.query()`` method will send the ``CH:POSition?`` query. + - Using the ``.verify(value)`` method will send the ``CH:POSition?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:POSition value`` command. **SCPI Syntax:** @@ -1498,6 +1587,7 @@ def position(self) -> ChannelPosition: :: - CH:POSition + - CH:POSition? **Info:** - ``CH`` is the channel number. @@ -1559,6 +1649,9 @@ def scale(self) -> ChannelScale: channel is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``CH:SCAle?`` query. + - Using the ``.verify(value)`` method will send the ``CH:SCAle?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``CH:SCAle value`` command. **SCPI Syntax:** @@ -1566,6 +1659,7 @@ def scale(self) -> ChannelScale: :: - CH:SCAle + - CH:SCAle? **Info:** - ``CH`` is the channel number. diff --git a/src/tm_devices/commands/_1zn03_mso/display.py b/src/tm_devices/commands/_1zn03_mso/display.py index 4b682c8a..27e6fe0f 100644 --- a/src/tm_devices/commands/_1zn03_mso/display.py +++ b/src/tm_devices/commands/_1zn03_mso/display.py @@ -20,10 +20,15 @@ - DISplay:COLors {NORMal|INVERTed} - DISplay:COLors? - DISplay:GLObal:B:STATE {|OFF|ON} + - DISplay:GLObal:B:STATE? - DISplay:GLObal:CH:STATE {|OFF|ON} + - DISplay:GLObal:CH:STATE? - DISplay:GLObal:DCH:STATE {|OFF|ON} + - DISplay:GLObal:DCH:STATE? - DISplay:GLObal:MATH:STATE {|OFF|ON} + - DISplay:GLObal:MATH:STATE? - DISplay:GLObal:REF:STATE {|OFF|ON} + - DISplay:GLObal:REF:STATE? - DISplay:INTENSITy:BACKLight {LOW|MEDium|HIGH} - DISplay:INTENSITy:BACKLight:AUTODim:ENAble {ON|OFF} - DISplay:INTENSITy:BACKLight:AUTODim:ENAble? @@ -73,6 +78,7 @@ - DISplay:MATHFFTView1:GRIDlines {HORizontal|VERTical|BOTH} - DISplay:MATHFFTView1:GRIDlines? - DISplay:MATHFFTView1:MATH:MATH:STATE {OFF|ON|} + - DISplay:MATHFFTView1:MATH:MATH:STATE? - DISplay:MATHFFTView1:XAXIS:SCALE {LINEAr|LOG} - DISplay:MATHFFTView1:XAXIS:SCALE? - DISplay:MATHFFTView1:YAXIS:SCALE {LINEAr|DBM} @@ -80,6 +86,7 @@ - DISplay:MATHFFTView1:ZOOM:XAXIS:FROM - DISplay:MATHFFTView1:ZOOM:XAXIS:FROM? - DISplay:MATHFFTView1:ZOOM:XAXIS:TO + - DISplay:MATHFFTView1:ZOOM:XAXIS:TO? - DISplay:MATHFFTView1:ZOOM:YAXIS:FROM - DISplay:MATHFFTView1:ZOOM:YAXIS:FROM? - DISplay:MATHFFTView1:ZOOM:YAXIS:TO @@ -91,8 +98,6 @@ - DISplay:PERSistence {OFF|AUTO|INFPersist|INFInite|VARpersist|CLEAR} - DISplay:PERSistence:RESET - DISplay:PERSistence? - - DISplay:PLOTVIEW:XAXIS:SCALE {LINEAR|LOG} - - DISplay:PLOTVIEW:YAXIS:SCALE {LINEAR|LOG} - DISplay:PLOTView1:AUTOScale {OFF|ON|} - DISplay:PLOTView1:AUTOScale? - DISplay:PLOTView1:CURSor:ASOUrce? @@ -136,6 +141,10 @@ - DISplay:PLOTView1:CURSor:WAVEform:BPOSition? - DISplay:PLOTView1:GRIDlines {HORizontal|VERTical|BOTH} - DISplay:PLOTView1:GRIDlines? + - DISplay:PLOTView1:XAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:XAXIS:SCALE? + - DISplay:PLOTView1:YAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:YAXIS:SCALE? - DISplay:PLOTView1:ZOOM:XAXIS:FROM - DISplay:PLOTView1:ZOOM:XAXIS:FROM? - DISplay:PLOTView1:ZOOM:XAXIS:TO @@ -212,9 +221,13 @@ - DISplay:SELect:MATH MATH - DISplay:SELect:MATH? - DISplay:SELect:REFerence {NONE|REF} + - DISplay:SELect:REFerence? - DISplay:SELect:SOUrce {NONE |CH |DCH |BUS |MATH |PLOT |REF} + - DISplay:SELect:SOUrce? - DISplay:SELect:VIEW {WAVEVIEW1|MATHFFT|PLOTVIEW|REFFFT} + - DISplay:SELect:VIEW? - DISplay:SELect:WAVEView1:SOUrce {CH|MATH|BUS|REF|PLOT} + - DISplay:SELect:WAVEView1:SOUrce? - DISplay:VARpersist - DISplay:VARpersist? - DISplay:WAVEView1:BUS:B:STATE {OFF|ON|0|1} @@ -2158,8 +2171,8 @@ class DisplayWaveview1DchItemDallDigorder(SCPICmdWrite, SCPICmdRead): """The ``DISplay:WAVEView1:DCH_DALL:DIGORDER`` command. **Description:** - - This command sets or queries the order of the digital channels. WAVEView is the - specified Waveform View and must be WAVEView1. + - This command sets or queries the order of the digital channels. 1 is the specified + Waveform View and must be WAVEView1. **Usage:** - Using the ``.query()`` method will send the ``DISplay:WAVEView1:DCH_DALL:DIGORDER?`` @@ -2211,8 +2224,8 @@ def digorder(self) -> DisplayWaveview1DchItemDallDigorder: """Return the ``DISplay:WAVEView1:DCH_DALL:DIGORDER`` command. **Description:** - - This command sets or queries the order of the digital channels. WAVEView is the - specified Waveform View and must be WAVEView1. + - This command sets or queries the order of the digital channels. 1 is the specified + Waveform View and must be WAVEView1. **Usage:** - Using the ``.query()`` method will send the @@ -2348,12 +2361,9 @@ class DisplayWaveview1DchItem(ValidatedDynamicNumberCmd, SCPICmdRead): - Using the ``.verify(value)`` method will send the ``DISplay:WAVEView1:DCH?`` query and raise an AssertionError if the returned value does not match ``value``. - **Info:** - - ``DCH`` specifies the digital channel. The supported digital channel value is 1. - Properties: - - ``.dall``: The ``DISplay:WAVEView1:DCH_DALL`` command tree. - ``.d``: The ``DISplay:WAVEView1:DCH_D`` command tree. + - ``.dall``: The ``DISplay:WAVEView1:DCH_DALL`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: @@ -4653,10 +4663,10 @@ class DisplayWaveview1(SCPICmdRead): an AssertionError if the returned value does not match ``value``. Properties: - - ``.dch``: The ``DISplay:WAVEView1:DCH`` command tree. - ``.bus``: The ``DISplay:WAVEView1:BUS`` command tree. - ``.ch``: The ``DISplay:WAVEView1:CH`` command tree. - ``.cursor``: The ``DISplay:WAVEView1:CURSor`` command. + - ``.dch``: The ``DISplay:WAVEView1:DCH`` command tree. - ``.filter``: The ``DISplay:WAVEView1:FILTer`` command. - ``.graticule``: The ``DISplay:WAVEView1:GRAticule`` command. - ``.intensity``: The ``DISplay:WAVEView1:INTENSITy`` command tree. @@ -4752,12 +4762,9 @@ def dch(self) -> Dict[int, DisplayWaveview1DchItem]: - Using the ``.verify(value)`` method will send the ``DISplay:WAVEView1:DCH?`` query and raise an AssertionError if the returned value does not match ``value``. - **Info:** - - ``DCH`` specifies the digital channel. The supported digital channel value is 1. - Sub-properties: - - ``.dall``: The ``DISplay:WAVEView1:DCH_DALL`` command tree. - ``.d``: The ``DISplay:WAVEView1:DCH_D`` command tree. + - ``.dall``: The ``DISplay:WAVEView1:DCH_DALL`` command tree. """ return self._dch @@ -5038,13 +5045,16 @@ class DisplayVarpersist(SCPICmdWrite, SCPICmdRead): """ -class DisplaySelectWaveview1Source(SCPICmdWrite): +class DisplaySelectWaveview1Source(SCPICmdWrite, SCPICmdRead): """The ``DISplay:SELect:WAVEView1:SOUrce`` command. **Description:** - This command sets or queries the selected source in the given waveview. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:WAVEView1:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:WAVEView1:SOUrce?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:WAVEView1:SOUrce value`` command. @@ -5053,13 +5063,14 @@ class DisplaySelectWaveview1Source(SCPICmdWrite): :: - DISplay:SELect:WAVEView1:SOUrce {CH|MATH|BUS|REF|PLOT} + - DISplay:SELect:WAVEView1:SOUrce? **Info:** - - ``CH`` specifies an analog channel as source. - - ``MATH`` specifies a math channel as source. - - ``BUS`` specifies a bus as source. - - ``REF`` specifies a reference waveform as the source. - - ``PLOT`` specifies a plot as the source. + - ``CH`` + - ``MATH`` + - ``BUS`` + - ``REF`` + - ``PLOT`` """ @@ -5087,6 +5098,10 @@ def source(self) -> DisplaySelectWaveview1Source: - This command sets or queries the selected source in the given waveview. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:WAVEView1:SOUrce?`` + query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:WAVEView1:SOUrce?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:WAVEView1:SOUrce value`` command. @@ -5095,24 +5110,28 @@ def source(self) -> DisplaySelectWaveview1Source: :: - DISplay:SELect:WAVEView1:SOUrce {CH|MATH|BUS|REF|PLOT} + - DISplay:SELect:WAVEView1:SOUrce? **Info:** - - ``CH`` specifies an analog channel as source. - - ``MATH`` specifies a math channel as source. - - ``BUS`` specifies a bus as source. - - ``REF`` specifies a reference waveform as the source. - - ``PLOT`` specifies a plot as the source. + - ``CH`` + - ``MATH`` + - ``BUS`` + - ``REF`` + - ``PLOT`` """ return self._source -class DisplaySelectView(SCPICmdWrite): +class DisplaySelectView(SCPICmdWrite, SCPICmdRead): """The ``DISplay:SELect:VIEW`` command. **Description:** - This command sets or queries the selected view. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:VIEW?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:VIEW?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:VIEW value`` command. **SCPI Syntax:** @@ -5120,16 +5139,17 @@ class DisplaySelectView(SCPICmdWrite): :: - DISplay:SELect:VIEW {WAVEVIEW1|MATHFFT|PLOTVIEW|REFFFT} + - DISplay:SELect:VIEW? **Info:** - - ``WAVEVIEW1`` sets WAVEVIEW as the selected view. - - ``MATHFFT`` sets MATHFFT as the selected view. - - ``PLOTVIEW`` sets PLOTVIEW as the selected view. - - ``REFFFT`` sets REFFFT as the selected view. + - ``WAVEVIEW1`` + - ``MATHFFT`` + - ``PLOTVIEW`` + - ``REFFFT`` """ -class DisplaySelectSource(SCPICmdWrite): +class DisplaySelectSource(SCPICmdWrite, SCPICmdRead): """The ``DISplay:SELect:SOUrce`` command. **Description:** @@ -5137,6 +5157,9 @@ class DisplaySelectSource(SCPICmdWrite): that contain the source and the selected view is changed. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:SOUrce?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:SOUrce value`` command. **SCPI Syntax:** @@ -5144,6 +5167,7 @@ class DisplaySelectSource(SCPICmdWrite): :: - DISplay:SELect:SOUrce {NONE |CH |DCH |BUS |MATH |PLOT |REF} + - DISplay:SELect:SOUrce? **Info:** - ``NONE`` disables the selected source. @@ -5157,7 +5181,7 @@ class DisplaySelectSource(SCPICmdWrite): """ -class DisplaySelectReference(SCPICmdWrite): +class DisplaySelectReference(SCPICmdWrite, SCPICmdRead): """The ``DISplay:SELect:REFerence`` command. **Description:** @@ -5165,6 +5189,9 @@ class DisplaySelectReference(SCPICmdWrite): all views that contain the source and the selected view is changed. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:REFerence?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:REFerence?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:REFerence value`` command. @@ -5173,10 +5200,11 @@ class DisplaySelectReference(SCPICmdWrite): :: - DISplay:SELect:REFerence {NONE|REF} + - DISplay:SELect:REFerence? **Info:** - - ``NONE`` specifies no reference waveforms. - - ``REF`` specifies the reference waveform. + - ``NONE`` + - ``REF`` where x is the specified reference waveform. """ @@ -5322,6 +5350,9 @@ def reference(self) -> DisplaySelectReference: to all views that contain the source and the selected view is changed. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:REFerence?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:REFerence?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:REFerence value`` command. @@ -5330,10 +5361,11 @@ def reference(self) -> DisplaySelectReference: :: - DISplay:SELect:REFerence {NONE|REF} + - DISplay:SELect:REFerence? **Info:** - - ``NONE`` specifies no reference waveforms. - - ``REF`` specifies the reference waveform. + - ``NONE`` + - ``REF`` where x is the specified reference waveform. """ return self._reference @@ -5346,6 +5378,9 @@ def source(self) -> DisplaySelectSource: views that contain the source and the selected view is changed. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:SOUrce?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:SOUrce value`` command. @@ -5354,6 +5389,7 @@ def source(self) -> DisplaySelectSource: :: - DISplay:SELect:SOUrce {NONE |CH |DCH |BUS |MATH |PLOT |REF} + - DISplay:SELect:SOUrce? **Info:** - ``NONE`` disables the selected source. @@ -5375,6 +5411,9 @@ def view(self) -> DisplaySelectView: - This command sets or queries the selected view. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:SELect:VIEW?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:SELect:VIEW?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:SELect:VIEW value`` command. @@ -5383,12 +5422,13 @@ def view(self) -> DisplaySelectView: :: - DISplay:SELect:VIEW {WAVEVIEW1|MATHFFT|PLOTVIEW|REFFFT} + - DISplay:SELect:VIEW? **Info:** - - ``WAVEVIEW1`` sets WAVEVIEW as the selected view. - - ``MATHFFT`` sets MATHFFT as the selected view. - - ``PLOTVIEW`` sets PLOTVIEW as the selected view. - - ``REFFFT`` sets REFFFT as the selected view. + - ``WAVEVIEW1`` + - ``MATHFFT`` + - ``PLOTVIEW`` + - ``REFFFT`` """ return self._view @@ -8446,6 +8486,154 @@ def yaxis(self) -> DisplayPlotview1ZoomYaxis: return self._yaxis +class DisplayPlotview1YaxisScale(SCPICmdWrite, SCPICmdRead): + """The ``DISplay:PLOTView1:YAXIS:SCALE`` command. + + **Description:** + - This command sets or queries the vertical scale setting for applicable plots (Linear or + Log) in the specified plot view. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:YAXIS:SCALE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:YAXIS:SCALE?`` query + and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``DISplay:PLOTView1:YAXIS:SCALE value`` + command. + + **SCPI Syntax:** + + :: + + - DISplay:PLOTView1:YAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:YAXIS:SCALE? + + **Info:** + - ``1`` is the Plot waveform number. + - ``LINEAR`` specifies a linear vertical scale. + - ``LOG`` specifies a logarithmic vertical scale. + """ + + +class DisplayPlotview1Yaxis(SCPICmdRead): + """The ``DISplay:PLOTView1:YAXIS`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:YAXIS?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:YAXIS?`` query and + raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.scale``: The ``DISplay:PLOTView1:YAXIS:SCALE`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._scale = DisplayPlotview1YaxisScale(device, f"{self._cmd_syntax}:SCALE") + + @property + def scale(self) -> DisplayPlotview1YaxisScale: + """Return the ``DISplay:PLOTView1:YAXIS:SCALE`` command. + + **Description:** + - This command sets or queries the vertical scale setting for applicable plots (Linear + or Log) in the specified plot view. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:YAXIS:SCALE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:YAXIS:SCALE?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``DISplay:PLOTView1:YAXIS:SCALE value`` command. + + **SCPI Syntax:** + + :: + + - DISplay:PLOTView1:YAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:YAXIS:SCALE? + + **Info:** + - ``1`` is the Plot waveform number. + - ``LINEAR`` specifies a linear vertical scale. + - ``LOG`` specifies a logarithmic vertical scale. + """ + return self._scale + + +class DisplayPlotview1XaxisScale(SCPICmdWrite, SCPICmdRead): + """The ``DISplay:PLOTView1:XAXIS:SCALE`` command. + + **Description:** + - This command sets or queries the horizontal scale setting for applicable plots (Linear or + Log) for the specified plot view. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:XAXIS:SCALE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:XAXIS:SCALE?`` query + and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``DISplay:PLOTView1:XAXIS:SCALE value`` + command. + + **SCPI Syntax:** + + :: + + - DISplay:PLOTView1:XAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:XAXIS:SCALE? + + **Info:** + - ``1`` is the Plot waveform number. + - ``LINEAR`` creates a plot with linear scales. + - ``LOG`` creates a plot with logarithmic scales. + """ + + +class DisplayPlotview1Xaxis(SCPICmdRead): + """The ``DISplay:PLOTView1:XAXIS`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:XAXIS?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:XAXIS?`` query and + raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.scale``: The ``DISplay:PLOTView1:XAXIS:SCALE`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._scale = DisplayPlotview1XaxisScale(device, f"{self._cmd_syntax}:SCALE") + + @property + def scale(self) -> DisplayPlotview1XaxisScale: + """Return the ``DISplay:PLOTView1:XAXIS:SCALE`` command. + + **Description:** + - This command sets or queries the horizontal scale setting for applicable plots (Linear + or Log) for the specified plot view. + + **Usage:** + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:XAXIS:SCALE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:XAXIS:SCALE?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``DISplay:PLOTView1:XAXIS:SCALE value`` command. + + **SCPI Syntax:** + + :: + + - DISplay:PLOTView1:XAXIS:SCALE {LINEAR|LOG} + - DISplay:PLOTView1:XAXIS:SCALE? + + **Info:** + - ``1`` is the Plot waveform number. + - ``LINEAR`` creates a plot with linear scales. + - ``LOG`` creates a plot with logarithmic scales. + """ + return self._scale + + class DisplayPlotview1Gridlines(SCPICmdWrite, SCPICmdRead): """The ``DISplay:PLOTView1:GRIDlines`` command. @@ -10074,6 +10262,8 @@ class DisplayPlotview1(SCPICmdRead): - ``.autoscale``: The ``DISplay:PLOTView1:AUTOScale`` command. - ``.cursor``: The ``DISplay:PLOTView1:CURSor`` command tree. - ``.gridlines``: The ``DISplay:PLOTView1:GRIDlines`` command. + - ``.xaxis``: The ``DISplay:PLOTView1:XAXIS`` command tree. + - ``.yaxis``: The ``DISplay:PLOTView1:YAXIS`` command tree. - ``.zoom``: The ``DISplay:PLOTView1:ZOOM`` command tree. """ @@ -10082,6 +10272,8 @@ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: self._autoscale = DisplayPlotview1Autoscale(device, f"{self._cmd_syntax}:AUTOScale") self._cursor = DisplayPlotview1Cursor(device, f"{self._cmd_syntax}:CURSor") self._gridlines = DisplayPlotview1Gridlines(device, f"{self._cmd_syntax}:GRIDlines") + self._xaxis = DisplayPlotview1Xaxis(device, f"{self._cmd_syntax}:XAXIS") + self._yaxis = DisplayPlotview1Yaxis(device, f"{self._cmd_syntax}:YAXIS") self._zoom = DisplayPlotview1Zoom(device, f"{self._cmd_syntax}:ZOOM") @property @@ -10172,198 +10364,47 @@ def gridlines(self) -> DisplayPlotview1Gridlines: return self._gridlines @property - def zoom(self) -> DisplayPlotview1Zoom: - """Return the ``DISplay:PLOTView1:ZOOM`` command tree. + def xaxis(self) -> DisplayPlotview1Xaxis: + """Return the ``DISplay:PLOTView1:XAXIS`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTView1:ZOOM?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:ZOOM?`` query + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:XAXIS?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:XAXIS?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.xaxis``: The ``DISplay:PLOTView1:ZOOM:XAXIS`` command tree. - - ``.yaxis``: The ``DISplay:PLOTView1:ZOOM:YAXIS`` command tree. + - ``.scale``: The ``DISplay:PLOTView1:XAXIS:SCALE`` command. """ - return self._zoom - - -class DisplayPlotviewItemYaxisScale(SCPICmdWrite): - """The ``DISplay:PLOTVIEW:YAXIS:SCALE`` command. - - **Description:** - - This command sets or queries the vertical scale setting for applicable plots (Linear or - Log) in the specified plot view. - - **Usage:** - - Using the ``.write(value)`` method will send the ``DISplay:PLOTVIEW:YAXIS:SCALE value`` - command. - - **SCPI Syntax:** - - :: - - - DISplay:PLOTVIEW:YAXIS:SCALE {LINEAR|LOG} - - **Info:** - - ``PLOTView`` is the Plot waveform number. - - ``LINEAR`` specifies a linear vertical scale. - - ``LOG`` specifies a logarithmic vertical scale. - """ - - -class DisplayPlotviewItemYaxis(SCPICmdRead): - """The ``DISplay:PLOTVIEW:YAXIS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW:YAXIS?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW:YAXIS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.scale``: The ``DISplay:PLOTVIEW:YAXIS:SCALE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._scale = DisplayPlotviewItemYaxisScale(device, f"{self._cmd_syntax}:SCALE") - - @property - def scale(self) -> DisplayPlotviewItemYaxisScale: - """Return the ``DISplay:PLOTVIEW:YAXIS:SCALE`` command. - - **Description:** - - This command sets or queries the vertical scale setting for applicable plots (Linear - or Log) in the specified plot view. - - **Usage:** - - Using the ``.write(value)`` method will send the - ``DISplay:PLOTVIEW:YAXIS:SCALE value`` command. - - **SCPI Syntax:** - - :: - - - DISplay:PLOTVIEW:YAXIS:SCALE {LINEAR|LOG} - - **Info:** - - ``PLOTView`` is the Plot waveform number. - - ``LINEAR`` specifies a linear vertical scale. - - ``LOG`` specifies a logarithmic vertical scale. - """ - return self._scale - - -class DisplayPlotviewItemXaxisScale(SCPICmdWrite): - """The ``DISplay:PLOTVIEW:XAXIS:SCALE`` command. - - **Description:** - - This command sets or queries the horizontal scale setting for applicable plots (Linear or - Log) for the specified plot view. - - **Usage:** - - Using the ``.write(value)`` method will send the ``DISplay:PLOTVIEW:XAXIS:SCALE value`` - command. - - **SCPI Syntax:** - - :: - - - DISplay:PLOTVIEW:XAXIS:SCALE {LINEAR|LOG} - - **Info:** - - ``PLOTView`` is the Plot waveform number. - - ``LINEAR`` creates a plot with linear scales. - - ``LOG`` creates a plot with logarithmic scales. - """ - - -class DisplayPlotviewItemXaxis(SCPICmdRead): - """The ``DISplay:PLOTVIEW:XAXIS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW:XAXIS?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW:XAXIS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.scale``: The ``DISplay:PLOTVIEW:XAXIS:SCALE`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._scale = DisplayPlotviewItemXaxisScale(device, f"{self._cmd_syntax}:SCALE") - - @property - def scale(self) -> DisplayPlotviewItemXaxisScale: - """Return the ``DISplay:PLOTVIEW:XAXIS:SCALE`` command. - - **Description:** - - This command sets or queries the horizontal scale setting for applicable plots (Linear - or Log) for the specified plot view. - - **Usage:** - - Using the ``.write(value)`` method will send the - ``DISplay:PLOTVIEW:XAXIS:SCALE value`` command. - - **SCPI Syntax:** - - :: - - - DISplay:PLOTVIEW:XAXIS:SCALE {LINEAR|LOG} - - **Info:** - - ``PLOTView`` is the Plot waveform number. - - ``LINEAR`` creates a plot with linear scales. - - ``LOG`` creates a plot with logarithmic scales. - """ - return self._scale - - -class DisplayPlotviewItem(ValidatedDynamicNumberCmd, SCPICmdRead): - """The ``DISplay:PLOTVIEW`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.xaxis``: The ``DISplay:PLOTVIEW:XAXIS`` command tree. - - ``.yaxis``: The ``DISplay:PLOTVIEW:YAXIS`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._xaxis = DisplayPlotviewItemXaxis(device, f"{self._cmd_syntax}:XAXIS") - self._yaxis = DisplayPlotviewItemYaxis(device, f"{self._cmd_syntax}:YAXIS") + return self._xaxis @property - def xaxis(self) -> DisplayPlotviewItemXaxis: - """Return the ``DISplay:PLOTVIEW:XAXIS`` command tree. + def yaxis(self) -> DisplayPlotview1Yaxis: + """Return the ``DISplay:PLOTView1:YAXIS`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW:XAXIS?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW:XAXIS?`` query + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:YAXIS?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:YAXIS?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.scale``: The ``DISplay:PLOTVIEW:XAXIS:SCALE`` command. + - ``.scale``: The ``DISplay:PLOTView1:YAXIS:SCALE`` command. """ - return self._xaxis + return self._yaxis @property - def yaxis(self) -> DisplayPlotviewItemYaxis: - """Return the ``DISplay:PLOTVIEW:YAXIS`` command tree. + def zoom(self) -> DisplayPlotview1Zoom: + """Return the ``DISplay:PLOTView1:ZOOM`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW:YAXIS?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW:YAXIS?`` query + - Using the ``.query()`` method will send the ``DISplay:PLOTView1:ZOOM?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:PLOTView1:ZOOM?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.scale``: The ``DISplay:PLOTVIEW:YAXIS:SCALE`` command. + - ``.xaxis``: The ``DISplay:PLOTView1:ZOOM:XAXIS`` command tree. + - ``.yaxis``: The ``DISplay:PLOTView1:ZOOM:YAXIS`` command tree. """ - return self._yaxis + return self._zoom class DisplayPersistenceReset(SCPICmdWriteNoArguments): @@ -10712,7 +10753,7 @@ def to(self) -> DisplayMathfftview1ZoomYaxisTo: return self._to -class DisplayMathfftview1ZoomXaxisTo(SCPICmdWrite): +class DisplayMathfftview1ZoomXaxisTo(SCPICmdWrite, SCPICmdRead): """The ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO`` command. **Description:** @@ -10720,6 +10761,9 @@ class DisplayMathfftview1ZoomXaxisTo(SCPICmdWrite): specified Math-FFT view. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO value`` command. @@ -10728,6 +10772,7 @@ class DisplayMathfftview1ZoomXaxisTo(SCPICmdWrite): :: - DISplay:MATHFFTView1:ZOOM:XAXIS:TO + - DISplay:MATHFFTView1:ZOOM:XAXIS:TO? **Info:** - ``1`` is the Math-FFT waveform number. @@ -10821,6 +10866,11 @@ def to(self) -> DisplayMathfftview1ZoomXaxisTo: the specified Math-FFT view. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO?`` + query. + - Using the ``.verify(value)`` method will send the + ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:MATHFFTView1:ZOOM:XAXIS:TO value`` command. @@ -10829,6 +10879,7 @@ def to(self) -> DisplayMathfftview1ZoomXaxisTo: :: - DISplay:MATHFFTView1:ZOOM:XAXIS:TO + - DISplay:MATHFFTView1:ZOOM:XAXIS:TO? **Info:** - ``1`` is the Math-FFT waveform number. @@ -11041,7 +11092,7 @@ def scale(self) -> DisplayMathfftview1XaxisScale: return self._scale -class DisplayMathfftview1MathMathItemState(SCPICmdWrite): +class DisplayMathfftview1MathMathItemState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:MATHFFTView1:MATH:MATH:STATE`` command. **Description:** @@ -11049,6 +11100,11 @@ class DisplayMathfftview1MathMathItemState(SCPICmdWrite): specified Math-FFT view. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:MATHFFTView1:MATH:MATH:STATE?`` + query. + - Using the ``.verify(value)`` method will send the + ``DISplay:MATHFFTView1:MATH:MATH:STATE?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:MATHFFTView1:MATH:MATH:STATE value`` command. @@ -11057,6 +11113,7 @@ class DisplayMathfftview1MathMathItemState(SCPICmdWrite): :: - DISplay:MATHFFTView1:MATH:MATH:STATE {OFF|ON|} + - DISplay:MATHFFTView1:MATH:MATH:STATE? **Info:** - ``1`` is the Math-FFT waveform number. @@ -11092,6 +11149,11 @@ def state(self) -> DisplayMathfftview1MathMathItemState: specified Math-FFT view. **Usage:** + - Using the ``.query()`` method will send the + ``DISplay:MATHFFTView1:MATH:MATH:STATE?`` query. + - Using the ``.verify(value)`` method will send the + ``DISplay:MATHFFTView1:MATH:MATH:STATE?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:MATHFFTView1:MATH:MATH:STATE value`` command. @@ -11100,6 +11162,7 @@ def state(self) -> DisplayMathfftview1MathMathItemState: :: - DISplay:MATHFFTView1:MATH:MATH:STATE {OFF|ON|} + - DISplay:MATHFFTView1:MATH:MATH:STATE? **Info:** - ``1`` is the Math-FFT waveform number. @@ -13202,7 +13265,7 @@ def backlight(self) -> DisplayIntensityBacklight: return self._backlight -class DisplayGlobalRefItemState(SCPICmdWrite): +class DisplayGlobalRefItemState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:GLObal:REF:STATE`` command. **Description:** @@ -13213,6 +13276,9 @@ class DisplayGlobalRefItemState(SCPICmdWrite): already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:REF:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:REF:STATE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:REF:STATE value`` command. @@ -13221,6 +13287,7 @@ class DisplayGlobalRefItemState(SCPICmdWrite): :: - DISplay:GLObal:REF:STATE {|OFF|ON} + - DISplay:GLObal:REF:STATE? **Info:** - ``REF`` is the Reference waveform number. @@ -13262,6 +13329,9 @@ def state(self) -> DisplayGlobalRefItemState: waveform is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:REF:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:REF:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:REF:STATE value`` command. @@ -13270,6 +13340,7 @@ def state(self) -> DisplayGlobalRefItemState: :: - DISplay:GLObal:REF:STATE {|OFF|ON} + - DISplay:GLObal:REF:STATE? **Info:** - ``REF`` is the Reference waveform number. @@ -13281,7 +13352,7 @@ def state(self) -> DisplayGlobalRefItemState: return self._state -class DisplayGlobalMathItemState(SCPICmdWrite): +class DisplayGlobalMathItemState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:GLObal:MATH:STATE`` command. **Description:** @@ -13291,6 +13362,9 @@ class DisplayGlobalMathItemState(SCPICmdWrite): command only works if the specified math waveform is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:MATH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:MATH:STATE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:MATH:STATE value`` command. @@ -13299,6 +13373,7 @@ class DisplayGlobalMathItemState(SCPICmdWrite): :: - DISplay:GLObal:MATH:STATE {|OFF|ON} + - DISplay:GLObal:MATH:STATE? **Info:** - ```` = 0 disables the display of the specified math; any other value enables display @@ -13336,6 +13411,9 @@ def state(self) -> DisplayGlobalMathItemState: already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:MATH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:MATH:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:MATH:STATE value`` command. @@ -13344,6 +13422,7 @@ def state(self) -> DisplayGlobalMathItemState: :: - DISplay:GLObal:MATH:STATE {|OFF|ON} + - DISplay:GLObal:MATH:STATE? **Info:** - ```` = 0 disables the display of the specified math; any other value enables @@ -13354,7 +13433,7 @@ def state(self) -> DisplayGlobalMathItemState: return self._state -class DisplayGlobalDchItemState(SCPICmdWrite): +class DisplayGlobalDchItemState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:GLObal:DCH:STATE`` command. **Description:** @@ -13364,6 +13443,9 @@ class DisplayGlobalDchItemState(SCPICmdWrite): waveform view. This command only works if the specified channel is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:DCH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:DCH:STATE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:DCH:STATE value`` command. @@ -13372,6 +13454,7 @@ class DisplayGlobalDchItemState(SCPICmdWrite): :: - DISplay:GLObal:DCH:STATE {|OFF|ON} + - DISplay:GLObal:DCH:STATE? **Info:** - ``DCH`` = specifies the digital channel. The supported value is 1. @@ -13413,6 +13496,9 @@ def state(self) -> DisplayGlobalDchItemState: already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:DCH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:DCH:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:DCH:STATE value`` command. @@ -13421,6 +13507,7 @@ def state(self) -> DisplayGlobalDchItemState: :: - DISplay:GLObal:DCH:STATE {|OFF|ON} + - DISplay:GLObal:DCH:STATE? **Info:** - ``DCH`` = specifies the digital channel. The supported value is 1. @@ -13432,7 +13519,7 @@ def state(self) -> DisplayGlobalDchItemState: return self._state -class DisplayGlobalChannelState(SCPICmdWrite): +class DisplayGlobalChannelState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:GLObal:CH:STATE`` command. **Description:** @@ -13443,6 +13530,9 @@ class DisplayGlobalChannelState(SCPICmdWrite): already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:CH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:CH:STATE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:CH:STATE value`` command. @@ -13451,6 +13541,7 @@ class DisplayGlobalChannelState(SCPICmdWrite): :: - DISplay:GLObal:CH:STATE {|OFF|ON} + - DISplay:GLObal:CH:STATE? **Info:** - ```` = 0 disables the display of the specified channel; any other value enables @@ -13488,6 +13579,9 @@ def state(self) -> DisplayGlobalChannelState: channel is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:CH:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:CH:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:CH:STATE value`` command. @@ -13496,6 +13590,7 @@ def state(self) -> DisplayGlobalChannelState: :: - DISplay:GLObal:CH:STATE {|OFF|ON} + - DISplay:GLObal:CH:STATE? **Info:** - ```` = 0 disables the display of the specified channel; any other value enables @@ -13506,7 +13601,7 @@ def state(self) -> DisplayGlobalChannelState: return self._state -class DisplayGlobalBItemState(SCPICmdWrite): +class DisplayGlobalBItemState(SCPICmdWrite, SCPICmdRead): """The ``DISplay:GLObal:B:STATE`` command. **Description:** @@ -13516,6 +13611,9 @@ class DisplayGlobalBItemState(SCPICmdWrite): command only works if the specified bus is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:B:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:B:STATE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:B:STATE value`` command. @@ -13524,6 +13622,7 @@ class DisplayGlobalBItemState(SCPICmdWrite): :: - DISplay:GLObal:B:STATE {|OFF|ON} + - DISplay:GLObal:B:STATE? **Info:** - ```` = 0 disables the display of the specified bus; any other value enables display @@ -13560,6 +13659,9 @@ def state(self) -> DisplayGlobalBItemState: waveform view. This command only works if the specified bus is added already. **Usage:** + - Using the ``.query()`` method will send the ``DISplay:GLObal:B:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``DISplay:GLObal:B:STATE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``DISplay:GLObal:B:STATE value`` command. @@ -13568,6 +13670,7 @@ def state(self) -> DisplayGlobalBItemState: :: - DISplay:GLObal:B:STATE {|OFF|ON} + - DISplay:GLObal:B:STATE? **Info:** - ```` = 0 disables the display of the specified bus; any other value enables @@ -13885,13 +13988,12 @@ class Display(SCPICmdRead): - ``.intensity``: The ``DISplay:INTENSITy`` command. - ``.mathfftview1``: The ``DISplay:MATHFFTView1`` command tree. - ``.persistence``: The ``DISplay:PERSistence`` command. - - ``.plotview``: The ``DISplay:PLOTVIEW`` command tree. - ``.plotview1``: The ``DISplay:PLOTView1`` command tree. - ``.reffftview``: The ``DISplay:REFFFTView`` command tree. - ``.select``: The ``DISplay:SELect`` command tree. - ``.varpersist``: The ``DISplay:VARpersist`` command. - - ``.waveview1``: The ``DISplay:WAVEView1`` command tree. - ``.waveview``: The ``DISplay:WAVEView`` command tree. + - ``.waveview1``: The ``DISplay:WAVEView1`` command tree. - ``.waveform``: The ``DISplay:WAVEform`` command. - ``.ch``: The ``DISplay:CH`` command tree. - ``.math``: The ``DISplay:Math`` command tree. @@ -13905,9 +14007,6 @@ def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "DISpl self._intensity = DisplayIntensity(device, f"{self._cmd_syntax}:INTENSITy") self._mathfftview1 = DisplayMathfftview1(device, f"{self._cmd_syntax}:MATHFFTView1") self._persistence = DisplayPersistence(device, f"{self._cmd_syntax}:PERSistence") - self._plotview: Dict[int, DisplayPlotviewItem] = DefaultDictPassKeyToFactory( - lambda x: DisplayPlotviewItem(device, f"{self._cmd_syntax}:PLOTVIEW{x}") - ) self._plotview1 = DisplayPlotview1(device, f"{self._cmd_syntax}:PLOTView1") self._reffftview: Dict[int, DisplayReffftviewItem] = DefaultDictPassKeyToFactory( lambda x: DisplayReffftviewItem(device, f"{self._cmd_syntax}:REFFFTView{x}") @@ -14053,21 +14152,6 @@ def persistence(self) -> DisplayPersistence: """ return self._persistence - @property - def plotview(self) -> Dict[int, DisplayPlotviewItem]: - """Return the ``DISplay:PLOTVIEW`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``DISplay:PLOTVIEW?`` query. - - Using the ``.verify(value)`` method will send the ``DISplay:PLOTVIEW?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.xaxis``: The ``DISplay:PLOTVIEW:XAXIS`` command tree. - - ``.yaxis``: The ``DISplay:PLOTVIEW:YAXIS`` command tree. - """ - return self._plotview - @property def plotview1(self) -> DisplayPlotview1: """Return the ``DISplay:PLOTView1`` command tree. @@ -14081,6 +14165,8 @@ def plotview1(self) -> DisplayPlotview1: - ``.autoscale``: The ``DISplay:PLOTView1:AUTOScale`` command. - ``.cursor``: The ``DISplay:PLOTView1:CURSor`` command tree. - ``.gridlines``: The ``DISplay:PLOTView1:GRIDlines`` command. + - ``.xaxis``: The ``DISplay:PLOTView1:XAXIS`` command tree. + - ``.yaxis``: The ``DISplay:PLOTView1:YAXIS`` command tree. - ``.zoom``: The ``DISplay:PLOTView1:ZOOM`` command tree. """ return self._plotview1 @@ -14177,10 +14263,10 @@ def waveview1(self) -> DisplayWaveview1: raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.dch``: The ``DISplay:WAVEView1:DCH`` command tree. - ``.bus``: The ``DISplay:WAVEView1:BUS`` command tree. - ``.ch``: The ``DISplay:WAVEView1:CH`` command tree. - ``.cursor``: The ``DISplay:WAVEView1:CURSor`` command. + - ``.dch``: The ``DISplay:WAVEView1:DCH`` command tree. - ``.filter``: The ``DISplay:WAVEView1:FILTer`` command. - ``.graticule``: The ``DISplay:WAVEView1:GRAticule`` command. - ``.intensity``: The ``DISplay:WAVEView1:INTENSITy`` command tree. diff --git a/src/tm_devices/commands/_1zn03_mso/math.py b/src/tm_devices/commands/_1zn03_mso/math.py index a6be055c..230c9cb2 100644 --- a/src/tm_devices/commands/_1zn03_mso/math.py +++ b/src/tm_devices/commands/_1zn03_mso/math.py @@ -17,23 +17,33 @@ - MATH:DELete - MATH:LIST? - MATH:MATH:AVG:MODE {|OFF|ON} + - MATH:MATH:AVG:MODE? - MATH:MATH:AVG:WEIGht + - MATH:MATH:AVG:WEIGht? - MATH:MATH:CAN:SUPPortedfields {DATa} - MATH:MATH:CAN:SUPPortedfields? - MATH:MATH:DEFine - MATH:MATH:DEFine? - MATH:MATH:FUNCtion {ADD|SUBtract|MULTiply|DIVide} + - MATH:MATH:FUNCtion? - MATH:MATH:GATing {NONE|SCREEN|CURSor} - MATH:MATH:GATing? - MATH:MATH:I2C:SUPPortedfields {DATa} - MATH:MATH:I2C:SUPPortedfields? - MATH:MATH:INTERpolation {ON|OFF} + - MATH:MATH:INTERpolation? - MATH:MATH:LABel:COLor + - MATH:MATH:LABel:COLor? - MATH:MATH:LABel:FONT:BOLD {|OFF|ON} + - MATH:MATH:LABel:FONT:BOLD? - MATH:MATH:LABel:FONT:ITALic {|OFF|ON} + - MATH:MATH:LABel:FONT:ITALic? - MATH:MATH:LABel:FONT:SIZE + - MATH:MATH:LABel:FONT:SIZE? - MATH:MATH:LABel:FONT:TYPE + - MATH:MATH:LABel:FONT:TYPE? - MATH:MATH:LABel:FONT:UNDERline {|OFF|ON} + - MATH:MATH:LABel:FONT:UNDERline? - MATH:MATH:LABel:NAMe - MATH:MATH:LABel:NAMe? - MATH:MATH:LABel:XPOS @@ -51,11 +61,13 @@ - MATH:MATH:SIGNeddata {ON|OFF} - MATH:MATH:SIGNeddata? - MATH:MATH:SOUrce1 {CH|MATH|REF} + - MATH:MATH:SOUrce1? - MATH:MATH:SPECTral:WINdow {RECTANGular|HAMMing| HANNing|BLACKMANHarris|KAISERBessel|GAUSSian| FLATTOP2|TEKEXPonential} - MATH:MATH:SPECTral:WINdow? - MATH:MATH:SPI:SUPPortedfields {DATa|MOSIdata|MISOdata} - MATH:MATH:SPI:SUPPortedfields? - MATH:MATH:TYPe {BASic|FFT|ADVanced} + - MATH:MATH:TYPe? - MATH:MATH:VUNIT """ # noqa: E501 from typing import Dict, Optional, TYPE_CHECKING @@ -94,13 +106,16 @@ class MathMathItemVunit(SCPICmdWrite): _WRAP_ARG_WITH_QUOTES = True -class MathMathItemType(SCPICmdWrite): +class MathMathItemType(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:TYPe`` command. **Description:** - This command sets or queries the math type. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:TYPe?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:TYPe?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:TYPe value`` command. **SCPI Syntax:** @@ -108,6 +123,7 @@ class MathMathItemType(SCPICmdWrite): :: - MATH:MATH:TYPe {BASic|FFT|ADVanced} + - MATH:MATH:TYPe? **Info:** - ``BASic`` set the type to basic math. @@ -301,17 +317,20 @@ def window(self) -> MathMathItemSpectralWindow: return self._window -class MathMathItemSource1(SCPICmdWrite): +class MathMathItemSource1(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:SOUrce1`` command. **Description:** - - This command sets or queries the specified math source. The source in the command can be - either 1 or 2. This command sets the Basic Math components in the user interface, with two - sources and a function. You would also need to set the math type to Basic to see the - change in the user interface but this will not effect the programmable interface. The math - waveform and source are specified by x. + - This command sets or queries the specified math source. This command sets the Basic Math + components in the user interface, with two sources and a function. You would also need to + set the math type to Basic to see the change in the user interface, but this will not + effect the programmable interface. The math waveform and source are specified by x. When + the ``MATH:MATH:TYPE`` is set to BASIC, SOURCE1 and SOURCE2 can be used. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:SOUrce1?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:SOUrce1?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:SOUrce1 value`` command. **SCPI Syntax:** @@ -319,13 +338,14 @@ class MathMathItemSource1(SCPICmdWrite): :: - MATH:MATH:SOUrce1 {CH|MATH|REF} + - MATH:MATH:SOUrce1? **Info:** - - ``CH`` specifies an analog channel as source. - - ``MATH`` specifies a math channel as source. - - ``REF`` specifies a reference waveform as the source. - - ``1`` specifies the source number. SOURCE1 and SOURCE2 are for use when the - ``MATH:MATH:TYPE`` is BASIC. + - ``MATH`` specifies the math number. + - ``1`` specifies the source number. + - ``CH`` specifies the source as channel. + - ``MATH`` specifies the source as math. + - ``REF`` specifies the source as reference. """ @@ -758,7 +778,7 @@ class MathMathItemLabelName(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class MathMathItemLabelFontUnderline(SCPICmdWrite): +class MathMathItemLabelFontUnderline(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:FONT:UNDERline`` command. **Description:** @@ -766,6 +786,9 @@ class MathMathItemLabelFontUnderline(SCPICmdWrite): waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:UNDERline?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:UNDERline?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:UNDERline value`` command. @@ -774,6 +797,7 @@ class MathMathItemLabelFontUnderline(SCPICmdWrite): :: - MATH:MATH:LABel:FONT:UNDERline {|OFF|ON} + - MATH:MATH:LABel:FONT:UNDERline? **Info:** - ```` = 0 turns off underline, and any other integer turns on underline. @@ -782,7 +806,7 @@ class MathMathItemLabelFontUnderline(SCPICmdWrite): """ -class MathMathItemLabelFontType(SCPICmdWrite): +class MathMathItemLabelFontType(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:FONT:TYPE`` command. **Description:** @@ -790,6 +814,9 @@ class MathMathItemLabelFontType(SCPICmdWrite): New Roman. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:TYPE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:TYPE value`` command. @@ -798,6 +825,7 @@ class MathMathItemLabelFontType(SCPICmdWrite): :: - MATH:MATH:LABel:FONT:TYPE + - MATH:MATH:LABel:FONT:TYPE? **Info:** - ```` is the name of the font type. @@ -806,7 +834,7 @@ class MathMathItemLabelFontType(SCPICmdWrite): _WRAP_ARG_WITH_QUOTES = True -class MathMathItemLabelFontSize(SCPICmdWrite): +class MathMathItemLabelFontSize(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:FONT:SIZE`` command. **Description:** @@ -814,6 +842,9 @@ class MathMathItemLabelFontSize(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:SIZE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:SIZE value`` command. @@ -822,13 +853,14 @@ class MathMathItemLabelFontSize(SCPICmdWrite): :: - MATH:MATH:LABel:FONT:SIZE + - MATH:MATH:LABel:FONT:SIZE? **Info:** - - ```` sets the label size in points. + - ```` is the font size of the specified math label. """ -class MathMathItemLabelFontItalic(SCPICmdWrite): +class MathMathItemLabelFontItalic(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:FONT:ITALic`` command. **Description:** @@ -836,6 +868,9 @@ class MathMathItemLabelFontItalic(SCPICmdWrite): is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:ITALic?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:ITALic value`` command. @@ -844,6 +879,7 @@ class MathMathItemLabelFontItalic(SCPICmdWrite): :: - MATH:MATH:LABel:FONT:ITALic {|OFF|ON} + - MATH:MATH:LABel:FONT:ITALic? **Info:** - ```` = 0 turns off italic, and any other integer turns on italic. @@ -852,7 +888,7 @@ class MathMathItemLabelFontItalic(SCPICmdWrite): """ -class MathMathItemLabelFontBold(SCPICmdWrite): +class MathMathItemLabelFontBold(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:FONT:BOLD`` command. **Description:** @@ -860,6 +896,9 @@ class MathMathItemLabelFontBold(SCPICmdWrite): is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:BOLD?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:BOLD value`` command. @@ -868,6 +907,7 @@ class MathMathItemLabelFontBold(SCPICmdWrite): :: - MATH:MATH:LABel:FONT:BOLD {|OFF|ON} + - MATH:MATH:LABel:FONT:BOLD? **Info:** - ```` = 0 turns off bold, and any other integer turns on bold. @@ -909,6 +949,9 @@ def bold(self) -> MathMathItemLabelFontBold: waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:BOLD?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:BOLD value`` command. @@ -917,6 +960,7 @@ def bold(self) -> MathMathItemLabelFontBold: :: - MATH:MATH:LABel:FONT:BOLD {|OFF|ON} + - MATH:MATH:LABel:FONT:BOLD? **Info:** - ```` = 0 turns off bold, and any other integer turns on bold. @@ -934,6 +978,9 @@ def italic(self) -> MathMathItemLabelFontItalic: waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:ITALic?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:ITALic value`` command. @@ -942,6 +989,7 @@ def italic(self) -> MathMathItemLabelFontItalic: :: - MATH:MATH:LABel:FONT:ITALic {|OFF|ON} + - MATH:MATH:LABel:FONT:ITALic? **Info:** - ```` = 0 turns off italic, and any other integer turns on italic. @@ -959,6 +1007,9 @@ def size(self) -> MathMathItemLabelFontSize: is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:SIZE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:SIZE value`` command. @@ -967,9 +1018,10 @@ def size(self) -> MathMathItemLabelFontSize: :: - MATH:MATH:LABel:FONT:SIZE + - MATH:MATH:LABel:FONT:SIZE? **Info:** - - ```` sets the label size in points. + - ```` is the font size of the specified math label. """ return self._size @@ -982,6 +1034,9 @@ def type(self) -> MathMathItemLabelFontType: Times New Roman. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:FONT:TYPE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:TYPE value`` command. @@ -990,6 +1045,7 @@ def type(self) -> MathMathItemLabelFontType: :: - MATH:MATH:LABel:FONT:TYPE + - MATH:MATH:LABel:FONT:TYPE? **Info:** - ```` is the name of the font type. @@ -1005,6 +1061,11 @@ def underline(self) -> MathMathItemLabelFontUnderline: waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:FONT:UNDERline?`` + query. + - Using the ``.verify(value)`` method will send the + ``MATH:MATH:LABel:FONT:UNDERline?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:FONT:UNDERline value`` command. @@ -1013,6 +1074,7 @@ def underline(self) -> MathMathItemLabelFontUnderline: :: - MATH:MATH:LABel:FONT:UNDERline {|OFF|ON} + - MATH:MATH:LABel:FONT:UNDERline? **Info:** - ```` = 0 turns off underline, and any other integer turns on underline. @@ -1022,7 +1084,7 @@ def underline(self) -> MathMathItemLabelFontUnderline: return self._underline -class MathMathItemLabelColor(SCPICmdWrite): +class MathMathItemLabelColor(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:LABel:COLor`` command. **Description:** @@ -1030,6 +1092,9 @@ class MathMathItemLabelColor(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:COLor?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:COLor value`` command. @@ -1038,6 +1103,7 @@ class MathMathItemLabelColor(SCPICmdWrite): :: - MATH:MATH:LABel:COLor + - MATH:MATH:LABel:COLor? **Info:** - `` is the color of the label. To return the color to the default color, send @@ -1080,6 +1146,9 @@ def color(self) -> MathMathItemLabelColor: specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:LABel:COLor?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:LABel:COLor value`` command. @@ -1088,6 +1157,7 @@ def color(self) -> MathMathItemLabelColor: :: - MATH:MATH:LABel:COLor + - MATH:MATH:LABel:COLor? **Info:** - `` is the color of the label. To return the color to the default color, @@ -1198,7 +1268,7 @@ def ypos(self) -> MathMathItemLabelYpos: return self._ypos -class MathMathItemInterpolation(SCPICmdWrite): +class MathMathItemInterpolation(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:INTERpolation`` command. **Description:** @@ -1206,6 +1276,9 @@ class MathMathItemInterpolation(SCPICmdWrite): The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:INTERpolation?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:INTERpolation?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:INTERpolation value`` command. @@ -1214,6 +1287,7 @@ class MathMathItemInterpolation(SCPICmdWrite): :: - MATH:MATH:INTERpolation {ON|OFF} + - MATH:MATH:INTERpolation? **Info:** - ``ON`` indicates that the sinc interpolation is used for math waveform. @@ -1324,7 +1398,7 @@ class MathMathItemGating(SCPICmdWrite, SCPICmdRead): """ -class MathMathItemFunction(SCPICmdWrite): +class MathMathItemFunction(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:FUNCtion`` command. **Description:** @@ -1332,6 +1406,9 @@ class MathMathItemFunction(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:FUNCtion?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:FUNCtion?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:FUNCtion value`` command. **SCPI Syntax:** @@ -1339,6 +1416,7 @@ class MathMathItemFunction(SCPICmdWrite): :: - MATH:MATH:FUNCtion {ADD|SUBtract|MULTiply|DIVide} + - MATH:MATH:FUNCtion? **Info:** - ``ADD`` sets the basic math function to add. @@ -1459,7 +1537,7 @@ def supportedfields(self) -> MathMathItemCanSupportedfields: return self._supportedfields -class MathMathItemAvgWeight(SCPICmdWrite): +class MathMathItemAvgWeight(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:AVG:WEIGht`` command. **Description:** @@ -1467,6 +1545,9 @@ class MathMathItemAvgWeight(SCPICmdWrite): will begin exponential averaging. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:AVG:WEIGht?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:AVG:WEIGht?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:AVG:WEIGht value`` command. @@ -1475,6 +1556,7 @@ class MathMathItemAvgWeight(SCPICmdWrite): :: - MATH:MATH:AVG:WEIGht + - MATH:MATH:AVG:WEIGht? **Info:** - ```` is the number of acquisitions at which the averaging algorithm will begin @@ -1482,7 +1564,7 @@ class MathMathItemAvgWeight(SCPICmdWrite): """ -class MathMathItemAvgMode(SCPICmdWrite): +class MathMathItemAvgMode(SCPICmdWrite, SCPICmdRead): """The ``MATH:MATH:AVG:MODE`` command. **Description:** @@ -1490,6 +1572,9 @@ class MathMathItemAvgMode(SCPICmdWrite): averaging is turned on. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:AVG:MODE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:AVG:MODE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:AVG:MODE value`` command. **SCPI Syntax:** @@ -1497,6 +1582,7 @@ class MathMathItemAvgMode(SCPICmdWrite): :: - MATH:MATH:AVG:MODE {|OFF|ON} + - MATH:MATH:AVG:MODE? **Info:** - ```` = 0 turns off average mode, and any other integer turns on average mode. @@ -1532,6 +1618,9 @@ def mode(self) -> MathMathItemAvgMode: averaging is turned on. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:AVG:MODE?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:AVG:MODE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:AVG:MODE value`` command. @@ -1540,6 +1629,7 @@ def mode(self) -> MathMathItemAvgMode: :: - MATH:MATH:AVG:MODE {|OFF|ON} + - MATH:MATH:AVG:MODE? **Info:** - ```` = 0 turns off average mode, and any other integer turns on average mode. @@ -1557,6 +1647,9 @@ def weight(self) -> MathMathItemAvgWeight: algorithm will begin exponential averaging. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:AVG:WEIGht?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:AVG:WEIGht?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:AVG:WEIGht value`` command. @@ -1565,6 +1658,7 @@ def weight(self) -> MathMathItemAvgWeight: :: - MATH:MATH:AVG:WEIGht + - MATH:MATH:AVG:WEIGht? **Info:** - ```` is the number of acquisitions at which the averaging algorithm will begin @@ -1700,6 +1794,9 @@ def function(self) -> MathMathItemFunction: specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:FUNCtion?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:FUNCtion?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:FUNCtion value`` command. @@ -1708,6 +1805,7 @@ def function(self) -> MathMathItemFunction: :: - MATH:MATH:FUNCtion {ADD|SUBtract|MULTiply|DIVide} + - MATH:MATH:FUNCtion? **Info:** - ``ADD`` sets the basic math function to add. @@ -1770,6 +1868,9 @@ def interpolation(self) -> MathMathItemInterpolation: source. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:INTERpolation?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:INTERpolation?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:INTERpolation value`` command. @@ -1778,6 +1879,7 @@ def interpolation(self) -> MathMathItemInterpolation: :: - MATH:MATH:INTERpolation {ON|OFF} + - MATH:MATH:INTERpolation? **Info:** - ``ON`` indicates that the sinc interpolation is used for math waveform. @@ -1895,13 +1997,16 @@ def source1(self) -> MathMathItemSource1: """Return the ``MATH:MATH:SOUrce1`` command. **Description:** - - This command sets or queries the specified math source. The source in the command can - be either 1 or 2. This command sets the Basic Math components in the user interface, - with two sources and a function. You would also need to set the math type to Basic to - see the change in the user interface but this will not effect the programmable - interface. The math waveform and source are specified by x. + - This command sets or queries the specified math source. This command sets the Basic + Math components in the user interface, with two sources and a function. You would also + need to set the math type to Basic to see the change in the user interface, but this + will not effect the programmable interface. The math waveform and source are specified + by x. When the ``MATH:MATH:TYPE`` is set to BASIC, SOURCE1 and SOURCE2 can be used. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:SOUrce1?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:SOUrce1?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:SOUrce1 value`` command. @@ -1910,13 +2015,14 @@ def source1(self) -> MathMathItemSource1: :: - MATH:MATH:SOUrce1 {CH|MATH|REF} + - MATH:MATH:SOUrce1? **Info:** - - ``CH`` specifies an analog channel as source. - - ``MATH`` specifies a math channel as source. - - ``REF`` specifies a reference waveform as the source. - - ``1`` specifies the source number. SOURCE1 and SOURCE2 are for use when the - ``MATH:MATH:TYPE`` is BASIC. + - ``MATH`` specifies the math number. + - ``1`` specifies the source number. + - ``CH`` specifies the source as channel. + - ``MATH`` specifies the source as math. + - ``REF`` specifies the source as reference. """ return self._source1 @@ -1956,6 +2062,9 @@ def type(self) -> MathMathItemType: - This command sets or queries the math type. The math waveform is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MATH:MATH:TYPe?`` query. + - Using the ``.verify(value)`` method will send the ``MATH:MATH:TYPe?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MATH:MATH:TYPe value`` command. **SCPI Syntax:** @@ -1963,6 +2072,7 @@ def type(self) -> MathMathItemType: :: - MATH:MATH:TYPe {BASic|FFT|ADVanced} + - MATH:MATH:TYPe? **Info:** - ``BASic`` set the type to basic math. diff --git a/src/tm_devices/commands/_1zn03_mso/measurement.py b/src/tm_devices/commands/_1zn03_mso/measurement.py index 800ba7a3..c9e37145 100644 --- a/src/tm_devices/commands/_1zn03_mso/measurement.py +++ b/src/tm_devices/commands/_1zn03_mso/measurement.py @@ -56,6 +56,7 @@ - MEASUrement:DELETEALL - MEASUrement:DELete - MEASUrement:EDGE {RISE|FALL|BOTH} + - MEASUrement:EDGE? - MEASUrement:GATing {NONE|SCREEN|CURSor|LOGic|SEARch|TIMe} - MEASUrement:GATing:ACTive {HIGH|LOW} - MEASUrement:GATing:ACTive? @@ -130,6 +131,7 @@ - MEASUrement:MEAS:DISPlaystat:ENABle {OFF|ON|} - MEASUrement:MEAS:DISPlaystat:ENABle? - MEASUrement:MEAS:EDGE {RISE|FALL|BOTH} + - MEASUrement:MEAS:EDGE? - MEASUrement:MEAS:EDGEIncre - MEASUrement:MEAS:EDGEIncre? - MEASUrement:MEAS:EDGES:FROMLevel {MID|LOW|HIGH} @@ -157,9 +159,11 @@ - MEASUrement:MEAS:GATing:HYSTeresis - MEASUrement:MEAS:GATing:HYSTeresis? - MEASUrement:MEAS:GATing:LOGICSource {CH|MATH|REF} + - MEASUrement:MEAS:GATing:LOGICSource? - MEASUrement:MEAS:GATing:MIDRef - MEASUrement:MEAS:GATing:MIDRef? - MEASUrement:MEAS:GATing:SEARCHSource SEARCH1 + - MEASUrement:MEAS:GATing:SEARCHSource? - MEASUrement:MEAS:GATing:STARTtime - MEASUrement:MEAS:GATing:STARTtime? - MEASUrement:MEAS:GATing? @@ -170,6 +174,7 @@ - MEASUrement:MEAS:IDLETime - MEASUrement:MEAS:IDLETime? - MEASUrement:MEAS:LABel + - MEASUrement:MEAS:LABel? - MEASUrement:MEAS:LOWREFVoltage - MEASUrement:MEAS:LOWREFVoltage? - MEASUrement:MEAS:PASSFAILENabled @@ -185,6 +190,7 @@ - MEASUrement:MEAS:PASSFAILWHEN {LESSthan| GREATERthan| Equals| NOTEQuals| INSIDErange| OUTSIDErange} - MEASUrement:MEAS:PASSFAILWHEN? - MEASUrement:MEAS:PERFREQ:EDGE {FIRST|RISE|FALL} + - MEASUrement:MEAS:PERFREQ:EDGE? - MEASUrement:MEAS:POLarity {NORMal|INVerted} - MEASUrement:MEAS:POLarity? - MEASUrement:MEAS:REFLevels1:ABSolute:FALLLow @@ -249,6 +255,7 @@ - MEASUrement:MEAS:TOEdge {SAMEas|OPPositeas|RISe|FALL|BOTH} - MEASUrement:MEAS:TOEdge? - MEASUrement:MEAS:TRANSition {|OFF|ON} + - MEASUrement:MEAS:TRANSition? - MEASUrement:MEAS:TYPe {ACRMS |AMPlITUDE |AREA |BASE |BURSTWIDTH |DATARATE |DELAY |FALLSLEWRATE |FALLTIME |FREQUENCY |HIGHTIME |HOLD |LOWTIME |MAXIMUM |MEAN |MINIMUM |NDUtY |NPERIOD |NOVERSHOOT |NWIDTH |PDUTY |PERIOD |PHASE |PK2Pk |POVERSHOOT |PWIDTH |RISESLEWRATE |RISETIME |RMS |SETUP |SKEW |TIMEOUTSIDELEVEL |TOP} - MEASUrement:MEAS:TYPe? - MEASUrement:MEAS:XUNIT? @@ -269,7 +276,8 @@ - MEASUrement:REF:REFLevels:ABSolute:RISEMid? - MEASUrement:REF:REFLevels:ABSolute:TYPE {SAME|UNIQue} - MEASUrement:REF:REFLevels:ABSolute:TYPE? - - MEASUrement:REF:REFLevels:BASETop + - MEASUrement:REF:REFLevels:BASETop {AUTO| MINMax| MEANhistogram| MODEhistogram| EYEhistogram} + - MEASUrement:REF:REFLevels:BASETop? - MEASUrement:REF:REFLevels:METHod {PERCent|ABSolute} - MEASUrement:REF:REFLevels:METHod? - MEASUrement:REF:REFLevels:PERCent:FALLHigh @@ -2302,7 +2310,7 @@ class MeasurementRefItemReflevelsMethod(SCPICmdWrite, SCPICmdRead): """ -class MeasurementRefItemReflevelsBasetop(SCPICmdWriteNoArguments): +class MeasurementRefItemReflevelsBasetop(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:REF:REFLevels:BASETop`` command. **Description:** @@ -2310,14 +2318,20 @@ class MeasurementRefItemReflevelsBasetop(SCPICmdWriteNoArguments): calculate reference levels for the measurement. **Usage:** - - Using the ``.write()`` method will send the ``MEASUrement:REF:REFLevels:BASETop`` - command. + - Using the ``.query()`` method will send the ``MEASUrement:REF:REFLevels:BASETop?`` + query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:REF:REFLevels:BASETop?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``MEASUrement:REF:REFLevels:BASETop value`` command. **SCPI Syntax:** :: - - MEASUrement:REF:REFLevels:BASETop + - MEASUrement:REF:REFLevels:BASETop {AUTO| MINMax| MEANhistogram| MODEhistogram| EYEhistogram} + - MEASUrement:REF:REFLevels:BASETop? **Info:** - ``AUTO`` automatically chooses a reference level method. @@ -2328,7 +2342,7 @@ class MeasurementRefItemReflevelsBasetop(SCPICmdWriteNoArguments): and TOP. - ``EYEhistogram`` specifies that reverence levels are relative to the eye histogram BASE and TOP. - """ + """ # noqa: E501 class MeasurementRefItemReflevelsAbsoluteType(SCPICmdWrite, SCPICmdRead): @@ -2903,14 +2917,20 @@ def basetop(self) -> MeasurementRefItemReflevelsBasetop: calculate reference levels for the measurement. **Usage:** - - Using the ``.write()`` method will send the ``MEASUrement:REF:REFLevels:BASETop`` - command. + - Using the ``.query()`` method will send the ``MEASUrement:REF:REFLevels:BASETop?`` + query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:REF:REFLevels:BASETop?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``MEASUrement:REF:REFLevels:BASETop value`` command. **SCPI Syntax:** :: - - MEASUrement:REF:REFLevels:BASETop + - MEASUrement:REF:REFLevels:BASETop {AUTO| MINMax| MEANhistogram| MODEhistogram| EYEhistogram} + - MEASUrement:REF:REFLevels:BASETop? **Info:** - ``AUTO`` automatically chooses a reference level method. @@ -2922,7 +2942,7 @@ def basetop(self) -> MeasurementRefItemReflevelsBasetop: BASE and TOP. - ``EYEhistogram`` specifies that reverence levels are relative to the eye histogram BASE and TOP. - """ + """ # noqa: E501 return self._basetop @property @@ -3166,7 +3186,7 @@ class MeasurementMeasItemType(SCPICmdWrite, SCPICmdRead): """ # noqa: E501 -class MeasurementMeasItemTransition(SCPICmdWrite): +class MeasurementMeasItemTransition(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:TRANSition`` command. **Description:** @@ -3174,6 +3194,9 @@ class MeasurementMeasItemTransition(SCPICmdWrite): measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:TRANSition?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:TRANSition?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:TRANSition value`` command. @@ -3182,6 +3205,7 @@ class MeasurementMeasItemTransition(SCPICmdWrite): :: - MEASUrement:MEAS:TRANSition {|OFF|ON} + - MEASUrement:MEAS:TRANSition? **Info:** - ```` = 1, the measurement is computed on rising (if measurement type is rise time) or @@ -5489,7 +5513,7 @@ class MeasurementMeasItemPolarity(SCPICmdWrite, SCPICmdRead): """ -class MeasurementMeasItemPerfreqEdge(SCPICmdWrite): +class MeasurementMeasItemPerfreqEdge(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:PERFREQ:EDGE`` command. **Description:** @@ -5497,6 +5521,9 @@ class MeasurementMeasItemPerfreqEdge(SCPICmdWrite): measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:PERFREQ:EDGE?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:PERFREQ:EDGE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:PERFREQ:EDGE value`` command. @@ -5505,6 +5532,7 @@ class MeasurementMeasItemPerfreqEdge(SCPICmdWrite): :: - MEASUrement:MEAS:PERFREQ:EDGE {FIRST|RISE|FALL} + - MEASUrement:MEAS:PERFREQ:EDGE? **Info:** - ``MEAS`` specifies the measurement number. @@ -5543,6 +5571,11 @@ def edge(self) -> MeasurementMeasItemPerfreqEdge: measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:PERFREQ:EDGE?`` + query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:MEAS:PERFREQ:EDGE?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:PERFREQ:EDGE value`` command. @@ -5551,6 +5584,7 @@ def edge(self) -> MeasurementMeasItemPerfreqEdge: :: - MEASUrement:MEAS:PERFREQ:EDGE {FIRST|RISE|FALL} + - MEASUrement:MEAS:PERFREQ:EDGE? **Info:** - ``MEAS`` specifies the measurement number. @@ -5768,7 +5802,7 @@ class MeasurementMeasItemLowrefvoltage(SCPICmdWrite, SCPICmdRead): """ -class MeasurementMeasItemLabel(SCPICmdWrite): +class MeasurementMeasItemLabel(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:LABel`` command. **Description:** @@ -5777,6 +5811,9 @@ class MeasurementMeasItemLabel(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:LABel?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:LABel?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:LABel value`` command. @@ -5785,6 +5822,7 @@ class MeasurementMeasItemLabel(SCPICmdWrite): :: - MEASUrement:MEAS:LABel + - MEASUrement:MEAS:LABel? **Info:** - ``MEAS`` specifies the measurement number. @@ -5907,7 +5945,7 @@ class MeasurementMeasItemGatingStarttime(SCPICmdWrite, SCPICmdRead): """ -class MeasurementMeasItemGatingSearchsource(SCPICmdWrite): +class MeasurementMeasItemGatingSearchsource(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:GATing:SEARCHSource`` command. **Description:** @@ -5915,6 +5953,11 @@ class MeasurementMeasItemGatingSearchsource(SCPICmdWrite): measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:GATing:SEARCHSource?`` + query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:MEAS:GATing:SEARCHSource?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:GATing:SEARCHSource value`` command. @@ -5923,6 +5966,7 @@ class MeasurementMeasItemGatingSearchsource(SCPICmdWrite): :: - MEASUrement:MEAS:GATing:SEARCHSource SEARCH1 + - MEASUrement:MEAS:GATing:SEARCHSource? **Info:** - ``MEAS`` specifies the measurement number. @@ -5957,7 +6001,7 @@ class MeasurementMeasItemGatingMidref(SCPICmdWrite, SCPICmdRead): """ -class MeasurementMeasItemGatingLogicsource(SCPICmdWrite): +class MeasurementMeasItemGatingLogicsource(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:GATing:LOGICSource`` command. **Description:** @@ -5965,6 +6009,11 @@ class MeasurementMeasItemGatingLogicsource(SCPICmdWrite): measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:GATing:LOGICSource?`` + query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:MEAS:GATing:LOGICSource?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:GATing:LOGICSource value`` command. @@ -5973,6 +6022,7 @@ class MeasurementMeasItemGatingLogicsource(SCPICmdWrite): :: - MEASUrement:MEAS:GATing:LOGICSource {CH|MATH|REF} + - MEASUrement:MEAS:GATing:LOGICSource? **Info:** - ``MEAS`` specifies the measurement number. @@ -6295,6 +6345,11 @@ def logicsource(self) -> MeasurementMeasItemGatingLogicsource: measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the + ``MEASUrement:MEAS:GATing:LOGICSource?`` query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:MEAS:GATing:LOGICSource?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:GATing:LOGICSource value`` command. @@ -6303,6 +6358,7 @@ def logicsource(self) -> MeasurementMeasItemGatingLogicsource: :: - MEASUrement:MEAS:GATing:LOGICSource {CH|MATH|REF} + - MEASUrement:MEAS:GATing:LOGICSource? **Info:** - ``MEAS`` specifies the measurement number. @@ -6348,6 +6404,11 @@ def searchsource(self) -> MeasurementMeasItemGatingSearchsource: The measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the + ``MEASUrement:MEAS:GATing:SEARCHSource?`` query. + - Using the ``.verify(value)`` method will send the + ``MEASUrement:MEAS:GATing:SEARCHSource?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:GATing:SEARCHSource value`` command. @@ -6356,6 +6417,7 @@ def searchsource(self) -> MeasurementMeasItemGatingSearchsource: :: - MEASUrement:MEAS:GATing:SEARCHSource SEARCH1 + - MEASUrement:MEAS:GATing:SEARCHSource? **Info:** - ``MEAS`` specifies the measurement number. @@ -6829,7 +6891,7 @@ class MeasurementMeasItemEdgeincre(SCPICmdWrite, SCPICmdRead): """ -class MeasurementMeasItemEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite): +class MeasurementMeasItemEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:EDGE`` command. **Description:** @@ -6837,6 +6899,9 @@ class MeasurementMeasItemEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite): measurement. The measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:EDGE?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:EDGE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:EDGE value`` command. @@ -6845,9 +6910,11 @@ class MeasurementMeasItemEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite): :: - MEASUrement:MEAS:EDGE {RISE|FALL|BOTH} + - MEASUrement:MEAS:EDGE? **Info:** - ``MEAS`` specifies the measurement number. + - ``EDGE`` specifies the edge number. - ``RISE`` specifies the rising edge. - ``FALL`` specifies the falling edge. - ``BOTH`` specifies either the rising or falling edge. @@ -7949,6 +8016,9 @@ def edge(self) -> Dict[int, MeasurementMeasItemEdgeItem]: measurement. The measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:EDGE?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:EDGE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:EDGE value`` command. @@ -7957,9 +8027,11 @@ def edge(self) -> Dict[int, MeasurementMeasItemEdgeItem]: :: - MEASUrement:MEAS:EDGE {RISE|FALL|BOTH} + - MEASUrement:MEAS:EDGE? **Info:** - ``MEAS`` specifies the measurement number. + - ``EDGE`` specifies the edge number. - ``RISE`` specifies the rising edge. - ``FALL`` specifies the falling edge. - ``BOTH`` specifies either the rising or falling edge. @@ -8243,6 +8315,9 @@ def label(self) -> MeasurementMeasItemLabel: is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:LABel?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:LABel?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:LABel value`` command. @@ -8251,6 +8326,7 @@ def label(self) -> MeasurementMeasItemLabel: :: - MEASUrement:MEAS:LABel + - MEASUrement:MEAS:LABel? **Info:** - ``MEAS`` specifies the measurement number. @@ -8797,6 +8873,9 @@ def transition(self) -> MeasurementMeasItemTransition: measurement number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:MEAS:TRANSition?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:MEAS:TRANSition?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:MEAS:TRANSition value`` command. @@ -8805,6 +8884,7 @@ def transition(self) -> MeasurementMeasItemTransition: :: - MEASUrement:MEAS:TRANSition {|OFF|ON} + - MEASUrement:MEAS:TRANSition? **Info:** - ```` = 1, the measurement is computed on rising (if measurement type is rise @@ -10812,13 +10892,16 @@ def starttime(self) -> MeasurementGatingStarttime: return self._starttime -class MeasurementEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite): +class MeasurementEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:EDGE`` command. **Description:** - This command sets or queries the type of the edge for the measurement. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:EDGE?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:EDGE?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:EDGE value`` command. **SCPI Syntax:** @@ -10826,6 +10909,7 @@ class MeasurementEdgeItem(ValidatedDynamicNumberCmd, SCPICmdWrite): :: - MEASUrement:EDGE {RISE|FALL|BOTH} + - MEASUrement:EDGE? **Info:** - ``FALL`` specifies the falling edge of the waveform. @@ -12603,6 +12687,9 @@ def edge(self) -> Dict[int, MeasurementEdgeItem]: - This command sets or queries the type of the edge for the measurement. **Usage:** + - Using the ``.query()`` method will send the ``MEASUrement:EDGE?`` query. + - Using the ``.verify(value)`` method will send the ``MEASUrement:EDGE?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``MEASUrement:EDGE value`` command. @@ -12611,6 +12698,7 @@ def edge(self) -> Dict[int, MeasurementEdgeItem]: :: - MEASUrement:EDGE {RISE|FALL|BOTH} + - MEASUrement:EDGE? **Info:** - ``FALL`` specifies the falling edge of the waveform. diff --git a/src/tm_devices/commands/_1zn03_mso/power.py b/src/tm_devices/commands/_1zn03_mso/power.py new file mode 100644 index 00000000..b809337b --- /dev/null +++ b/src/tm_devices/commands/_1zn03_mso/power.py @@ -0,0 +1,1524 @@ +# pylint: disable=too-many-lines +# pylint: disable=line-too-long +"""The power commands module. + +These commands are used in the following models: +MSO2 + +THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. + +Please report an issue if one is found. + +Commands and Queries: + +:: + + - POWer:ADDNew 'POWER' + - POWer:DELete 'POWER' + - POWer:POWer:CLRESPONSE:AMPVal + - POWer:POWer:CLRESPONSE:AMPVal? + - POWer:POWer:CLRESPONSE:AMPMode {CONSTant|PROFile} + - POWer:POWer:CLRESPONSE:AMPMode? + - POWer:POWer:CLRESPONSE:ANALYSISMethod? + - POWer:POWer:CLRESPONSE:CONNECTSTATus? + - POWer:POWer:CLRESPONSE:CONSTAMPlitude + - POWer:POWer:CLRESPONSE:CONSTAMPlitude? + - POWer:POWer:CLRESPONSE:FREQVal + - POWer:POWer:CLRESPONSE:FREQVal? + - POWer:POWer:CLRESPONSE:GENIPADDress + - POWer:POWer:CLRESPONSE:GENIPADDress? + - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator? + - POWer:POWer:CLRESPONSE:IMPEDance {FIFTy|HIGHZ} + - POWer:POWer:CLRESPONSE:IMPEDance? + - POWer:POWer:CLRESPONSE:INPUTSOurce CH + - POWer:POWer:CLRESPONSE:INPUTSOurce? + - POWer:POWer:CLRESPONSE:OUTPUTSOurce CH + - POWer:POWer:CLRESPONSE:OUTPUTSOurce? + - POWer:POWer:CLRESPONSE:PPD + - POWer:POWer:CLRESPONSE:PPD? + - POWer:POWer:CLRESPONSE:STARTFREQuency + - POWer:POWer:CLRESPONSE:STARTFREQuency? + - POWer:POWer:CLRESPONSE:STOPFREQuency + - POWer:POWer:CLRESPONSE:STOPFREQuency? + - POWer:POWer:CLRESPONSE:TESTCONNection EXECute + - POWer:POWer:PRESET {EXECute} + - POWer:POWer:RESUlts:CURRentacq:MAXimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + - POWer:POWer:RESUlts:CURRentacq:MEAN? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + - POWer:POWer:RESUlts:CURRentacq:MINimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} +""" +from typing import Dict, Optional, TYPE_CHECKING + +from .._helpers import ( + DefaultDictPassKeyToFactory, + SCPICmdRead, + SCPICmdReadWithArguments, + SCPICmdWrite, + ValidatedDynamicNumberCmd, +) + +if TYPE_CHECKING: + from tm_devices.drivers.pi.pi_device import PIDevice + + +class PowerPowerItemResultsCurrentacqMinimum(SCPICmdReadWithArguments): + """The ``POWer:POWer:RESUlts:CURRentacq:MINimum`` command. + + **Description:** + - This command queries the minimum value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MINimum? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MINimum? argument`` query and raise an AssertionError + if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MINimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified power + measurement number. Available results depend on the power measurement being taken in the + specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ + + +class PowerPowerItemResultsCurrentacqMean(SCPICmdReadWithArguments): + """The ``POWer:POWer:RESUlts:CURRentacq:MEAN`` command. + + **Description:** + - This command queries the mean value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MEAN? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MEAN? argument`` query and raise an AssertionError if + the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MEAN? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified power + measurement number. Available results depend on the power measurement being taken in the + specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ + + +class PowerPowerItemResultsCurrentacqMaximum(SCPICmdReadWithArguments): + """The ``POWer:POWer:RESUlts:CURRentacq:MAXimum`` command. + + **Description:** + - This command queries the maximum value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MAXimum? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MAXimum? argument`` query and raise an AssertionError + if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MAXimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified power + measurement number. Available results depend on the power measurement being taken in the + specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ + + +class PowerPowerItemResultsCurrentacq(SCPICmdRead): + """The ``POWer:POWer:RESUlts:CURRentacq`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:RESUlts:CURRentacq?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:RESUlts:CURRentacq?`` + query and raise an AssertionError if the returned value does not match ``value``. + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + + Properties: + - ``.maximum``: The ``POWer:POWer:RESUlts:CURRentacq:MAXimum`` command. + - ``.mean``: The ``POWer:POWer:RESUlts:CURRentacq:MEAN`` command. + - ``.minimum``: The ``POWer:POWer:RESUlts:CURRentacq:MINimum`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._maximum = PowerPowerItemResultsCurrentacqMaximum( + device, f"{self._cmd_syntax}:MAXimum" + ) + self._mean = PowerPowerItemResultsCurrentacqMean(device, f"{self._cmd_syntax}:MEAN") + self._minimum = PowerPowerItemResultsCurrentacqMinimum( + device, f"{self._cmd_syntax}:MINimum" + ) + + @property + def maximum(self) -> PowerPowerItemResultsCurrentacqMaximum: + """Return the ``POWer:POWer:RESUlts:CURRentacq:MAXimum`` command. + + **Description:** + - This command queries the maximum value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MAXimum? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MAXimum? argument`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MAXimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified + power measurement number. Available results depend on the power measurement being + taken in the specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ # noqa: E501 + return self._maximum + + @property + def mean(self) -> PowerPowerItemResultsCurrentacqMean: + """Return the ``POWer:POWer:RESUlts:CURRentacq:MEAN`` command. + + **Description:** + - This command queries the mean value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MEAN? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MEAN? argument`` query and raise an AssertionError + if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MEAN? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified + power measurement number. Available results depend on the power measurement being + taken in the specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ # noqa: E501 + return self._mean + + @property + def minimum(self) -> PowerPowerItemResultsCurrentacqMinimum: + """Return the ``POWer:POWer:RESUlts:CURRentacq:MINimum`` command. + + **Description:** + - This command queries the minimum value of the current acquisition for the measurement + parameter in the specified power measurement number. + + **Usage:** + - Using the ``.query(argument)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MINimum? argument`` query. + - Using the ``.verify(argument, value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq:MINimum? argument`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:RESUlts:CURRentacq:MINimum? {PM| GAINCROSSOVERFREQ| GM| PHASECROSSOVERFREQ} + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + - ```` is the measurement result that you want to return from the specified + power measurement number. Available results depend on the power measurement being + taken in the specified measurement number. The valid arguments are. + - ``'PM'`` returns the Phase margin value. + - ``'GAINCROSSOVERFREQ'`` returns the Gain crossover frequency value. + - ``'GM'`` returns the Gain margin value. + - ``'PHASECROSSOVERFREQ'`` returns the Phase cross over frequency value. + """ # noqa: E501 + return self._minimum + + +class PowerPowerItemResults(SCPICmdRead): + """The ``POWer:POWer:RESUlts`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:RESUlts?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:RESUlts?`` query and + raise an AssertionError if the returned value does not match ``value``. + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + + Properties: + - ``.currentacq``: The ``POWer:POWer:RESUlts:CURRentacq`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._currentacq = PowerPowerItemResultsCurrentacq(device, f"{self._cmd_syntax}:CURRentacq") + + @property + def currentacq(self) -> PowerPowerItemResultsCurrentacq: + """Return the ``POWer:POWer:RESUlts:CURRentacq`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:RESUlts:CURRentacq?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:RESUlts:CURRentacq?`` query and raise an AssertionError if the + returned value does not match ``value``. + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + + Sub-properties: + - ``.maximum``: The ``POWer:POWer:RESUlts:CURRentacq:MAXimum`` command. + - ``.mean``: The ``POWer:POWer:RESUlts:CURRentacq:MEAN`` command. + - ``.minimum``: The ``POWer:POWer:RESUlts:CURRentacq:MINimum`` command. + """ + return self._currentacq + + +class PowerPowerItemPreset(SCPICmdWrite): + """The ``POWer:POWer:PRESET`` command. + + **Description:** + - This command runs a power preset action for the specified power measurement number. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:POWer:PRESET value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:PRESET {EXECute} + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``EXECute`` runs the power preset action. + """ + + +class PowerPowerItemClresponseTestconnection(SCPICmdWrite): + """The ``POWer:POWer:CLRESPONSE:TESTCONNection`` command. + + **Description:** + - This command tests the connection to the external generator used with the specified + Control Loop Response power measurement. + + **Usage:** + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:TESTCONNection value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:TESTCONNection EXECute + + **Info:** + - ``POWer`` is the number of the PSRR power measurement. + - ``EXECute`` runs the test connection function. + """ + + +class PowerPowerItemClresponseStopfrequency(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:STOPFREQuency`` command. + + **Description:** + - This command sets or queries the stop frequency value for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:STOPFREQuency?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STOPFREQuency?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STOPFREQuency value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:STOPFREQuency + - POWer:POWer:CLRESPONSE:STOPFREQuency? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ```` is the stop frequency for the measurement, in the range of 10 Hz to 50 MHz. + """ + + +class PowerPowerItemClresponseStartfrequency(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:STARTFREQuency`` command. + + **Description:** + - This command sets or queries the start frequency value for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:STARTFREQuency?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STARTFREQuency?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STARTFREQuency value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:STARTFREQuency + - POWer:POWer:CLRESPONSE:STARTFREQuency? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ```` is the starting frequency for the measurement, in the range of 10 Hz to 50 MHz. + """ + + +class PowerPowerItemClresponsePpd(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:PPD`` command. + + **Description:** + - This command sets or queries the points per decade (PPD) value for the Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:PPD?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:PPD?`` query + and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``POWer:POWer:CLRESPONSE:PPD value`` + command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:PPD + - POWer:POWer:CLRESPONSE:PPD? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ```` is the PPD value for the measurement, in the range of 10 to 100 points. + """ + + +class PowerPowerItemClresponseOutputsource(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:OUTPUTSOurce`` command. + + **Description:** + - This command sets or queries the output source for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:OUTPUTSOurce?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:OUTPUTSOurce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:OUTPUTSOurce value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:OUTPUTSOurce CH + - POWer:POWer:CLRESPONSE:OUTPUTSOurce? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``CH`` sets the channel to use for the output signal source. + """ + + +class PowerPowerItemClresponseInputsource(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:INPUTSOurce`` command. + + **Description:** + - This command sets or queries the input source for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:INPUTSOurce?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:INPUTSOurce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:INPUTSOurce value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:INPUTSOurce CH + - POWer:POWer:CLRESPONSE:INPUTSOurce? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``CH`` sets the channel to use for the output signal source. + """ + + +class PowerPowerItemClresponseImpedance(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:IMPEDance`` command. + + **Description:** + - This command sets or queries the vertical termination impedance for the Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:IMPEDance?`` + query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:IMPEDance?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:IMPEDance value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:IMPEDance {FIFTy|HIGHZ} + - POWer:POWer:CLRESPONSE:IMPEDance? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``FIFTy`` sets the impedance to be 50 Ω. + - ``HIGHZ`` sets the impedance to be 1 MΩ. + """ + + +class PowerPowerItemClresponseGenerator(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:GENerator`` command. + + **Description:** + - Sets or queries the generator source for the specified Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:GENerator?`` + query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:GENerator?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENerator value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator? + + **Info:** + - ``POWer`` is the number of the power measurement.INTernal sets the internal generator + as the source for the Control Loop Response power measurement. + - ``EXTernal`` sets the external generator as the source for the Control Loop Response power + measurement. + """ + + +class PowerPowerItemClresponseGenipaddress(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:GENIPADDress`` command. + + **Description:** + - Sets or queries the IP address of the external generator to be used with the specified + Control Loop Response measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:GENIPADDress?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENIPADDress?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENIPADDress value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:GENIPADDress + - POWer:POWer:CLRESPONSE:GENIPADDress? + + **Info:** + - ``POWer`` is the number of the power measurement. is the IP address of the + generator. + """ + + +class PowerPowerItemClresponseFreqvalItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:FREQVal`` command. + + **Description:** + - This command sets or queries the generator frequency value of the specified configuration + step for the Control Loop Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:FREQVal?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:FREQVal?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:FREQVal value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:FREQVal + - POWer:POWer:CLRESPONSE:FREQVal? + + **Info:** + - ``Power`` sets the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``FREQ`` sets the configuration step number, in the range of 1 to 11. Values outside + this range will report an error. + - ```` sets the frequency of the specified configuration step number, in the range of + 10 Hz to 50 MHz. + """ + + +class PowerPowerItemClresponseConstamplitude(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:CONSTAMPlitude`` command. + + **Description:** + - This command sets or queries the constant amplitude voltage for the Control Loop Response + power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:CONSTAMPlitude?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONSTAMPlitude?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONSTAMPlitude value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:CONSTAMPlitude + - POWer:POWer:CLRESPONSE:CONSTAMPlitude? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ```` is the constant amplitude voltage value for the measurement, in the range of + -100 V to 100 V. + """ + + +class PowerPowerItemClresponseConnectstatus(SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:CONNECTSTATus`` command. + + **Description:** + - Queries connection status to the external generator used with the specified Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:CONNECTSTATus?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONNECTSTATus?`` query and raise an AssertionError if the + returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:CONNECTSTATus? + + **Info:** + - ``POWer`` is the number of the power measurement. + """ + + +class PowerPowerItemClresponseAnalysismethod(SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:ANALYSISMethod`` command. + + **Description:** + - This command sets or queries the Analysis Method for Control Loop Response measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:ANALYSISMethod?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:ANALYSISMethod?`` query and raise an AssertionError if the + returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:ANALYSISMethod? + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. This must be POWer1. + """ + + +class PowerPowerItemClresponseAmpmode(SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:AMPMode`` command. + + **Description:** + - This command sets or queries the amplitude mode for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:AMPMode?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:AMPMode?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPMode value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:AMPMode {CONSTant|PROFile} + - POWer:POWer:CLRESPONSE:AMPMode? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``CONSTant`` sets the amplitude mode to output a constant amplitude signal from the DUT + stimulus generator for all frequency bands. + - ``PROFile`` enables configuring the generator to set amplitude values for each frequency + band. + """ + + +class PowerPowerItemClresponseAmpvalItem(ValidatedDynamicNumberCmd, SCPICmdWrite, SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE:AMPVal`` command. + + **Description:** + - This command sets or queries the generator amplitude value of the specified configuration + step for the Control Loop Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:AMPVal?`` + query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:AMPVal?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPVal value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:AMPVal + - POWer:POWer:CLRESPONSE:AMPVal? + + **Info:** + - ``Power`` sets the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``AMP`` sets the configuration step number, in the range of 1 to 10. Values outside + this range will report an error. + - ```` sets the generator amplitude for the specified configuration step, in the range + of -100 V to 100 V. + """ + + +# pylint: disable=too-many-instance-attributes +class PowerPowerItemClresponse(SCPICmdRead): + """The ``POWer:POWer:CLRESPONSE`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE?`` query and + raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.ampval``: The ``POWer:POWer:CLRESPONSE:AMPVal`` command. + - ``.ampmode``: The ``POWer:POWer:CLRESPONSE:AMPMode`` command. + - ``.analysismethod``: The ``POWer:POWer:CLRESPONSE:ANALYSISMethod`` command. + - ``.connectstatus``: The ``POWer:POWer:CLRESPONSE:CONNECTSTATus`` command. + - ``.constamplitude``: The ``POWer:POWer:CLRESPONSE:CONSTAMPlitude`` command. + - ``.freqval``: The ``POWer:POWer:CLRESPONSE:FREQVal`` command. + - ``.genipaddress``: The ``POWer:POWer:CLRESPONSE:GENIPADDress`` command. + - ``.generator``: The ``POWer:POWer:CLRESPONSE:GENerator`` command. + - ``.impedance``: The ``POWer:POWer:CLRESPONSE:IMPEDance`` command. + - ``.inputsource``: The ``POWer:POWer:CLRESPONSE:INPUTSOurce`` command. + - ``.outputsource``: The ``POWer:POWer:CLRESPONSE:OUTPUTSOurce`` command. + - ``.ppd``: The ``POWer:POWer:CLRESPONSE:PPD`` command. + - ``.startfrequency``: The ``POWer:POWer:CLRESPONSE:STARTFREQuency`` command. + - ``.stopfrequency``: The ``POWer:POWer:CLRESPONSE:STOPFREQuency`` command. + - ``.testconnection``: The ``POWer:POWer:CLRESPONSE:TESTCONNection`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._ampval: Dict[int, PowerPowerItemClresponseAmpvalItem] = DefaultDictPassKeyToFactory( + lambda x: PowerPowerItemClresponseAmpvalItem(device, f"{self._cmd_syntax}:AMP{x}Val") + ) + self._ampmode = PowerPowerItemClresponseAmpmode(device, f"{self._cmd_syntax}:AMPMode") + self._analysismethod = PowerPowerItemClresponseAnalysismethod( + device, f"{self._cmd_syntax}:ANALYSISMethod" + ) + self._connectstatus = PowerPowerItemClresponseConnectstatus( + device, f"{self._cmd_syntax}:CONNECTSTATus" + ) + self._constamplitude = PowerPowerItemClresponseConstamplitude( + device, f"{self._cmd_syntax}:CONSTAMPlitude" + ) + self._freqval: Dict[int, PowerPowerItemClresponseFreqvalItem] = DefaultDictPassKeyToFactory( + lambda x: PowerPowerItemClresponseFreqvalItem(device, f"{self._cmd_syntax}:FREQ{x}Val") + ) + self._genipaddress = PowerPowerItemClresponseGenipaddress( + device, f"{self._cmd_syntax}:GENIPADDress" + ) + self._generator = PowerPowerItemClresponseGenerator(device, f"{self._cmd_syntax}:GENerator") + self._impedance = PowerPowerItemClresponseImpedance(device, f"{self._cmd_syntax}:IMPEDance") + self._inputsource = PowerPowerItemClresponseInputsource( + device, f"{self._cmd_syntax}:INPUTSOurce" + ) + self._outputsource = PowerPowerItemClresponseOutputsource( + device, f"{self._cmd_syntax}:OUTPUTSOurce" + ) + self._ppd = PowerPowerItemClresponsePpd(device, f"{self._cmd_syntax}:PPD") + self._startfrequency = PowerPowerItemClresponseStartfrequency( + device, f"{self._cmd_syntax}:STARTFREQuency" + ) + self._stopfrequency = PowerPowerItemClresponseStopfrequency( + device, f"{self._cmd_syntax}:STOPFREQuency" + ) + self._testconnection = PowerPowerItemClresponseTestconnection( + device, f"{self._cmd_syntax}:TESTCONNection" + ) + + @property + def ampval(self) -> Dict[int, PowerPowerItemClresponseAmpvalItem]: + """Return the ``POWer:POWer:CLRESPONSE:AMPVal`` command. + + **Description:** + - This command sets or queries the generator amplitude value of the specified + configuration step for the Control Loop Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:AMPVal?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPVal?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPVal value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:AMPVal + - POWer:POWer:CLRESPONSE:AMPVal? + + **Info:** + - ``Power`` sets the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``AMP`` sets the configuration step number, in the range of 1 to 10. Values outside + this range will report an error. + - ```` sets the generator amplitude for the specified configuration step, in the + range of -100 V to 100 V. + """ + return self._ampval + + @property + def ampmode(self) -> PowerPowerItemClresponseAmpmode: + """Return the ``POWer:POWer:CLRESPONSE:AMPMode`` command. + + **Description:** + - This command sets or queries the amplitude mode for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:AMPMode?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPMode?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:AMPMode value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:AMPMode {CONSTant|PROFile} + - POWer:POWer:CLRESPONSE:AMPMode? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``CONSTant`` sets the amplitude mode to output a constant amplitude signal from the + DUT stimulus generator for all frequency bands. + - ``PROFile`` enables configuring the generator to set amplitude values for each + frequency band. + """ + return self._ampmode + + @property + def analysismethod(self) -> PowerPowerItemClresponseAnalysismethod: + """Return the ``POWer:POWer:CLRESPONSE:ANALYSISMethod`` command. + + **Description:** + - This command sets or queries the Analysis Method for Control Loop Response + measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:ANALYSISMethod?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:ANALYSISMethod?`` query and raise an AssertionError if the + returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:ANALYSISMethod? + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + """ + return self._analysismethod + + @property + def connectstatus(self) -> PowerPowerItemClresponseConnectstatus: + """Return the ``POWer:POWer:CLRESPONSE:CONNECTSTATus`` command. + + **Description:** + - Queries connection status to the external generator used with the specified Control + Loop Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:CONNECTSTATus?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONNECTSTATus?`` query and raise an AssertionError if the + returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:CONNECTSTATus? + + **Info:** + - ``POWer`` is the number of the power measurement. + """ + return self._connectstatus + + @property + def constamplitude(self) -> PowerPowerItemClresponseConstamplitude: + """Return the ``POWer:POWer:CLRESPONSE:CONSTAMPlitude`` command. + + **Description:** + - This command sets or queries the constant amplitude voltage for the Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:CONSTAMPlitude?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONSTAMPlitude?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:CONSTAMPlitude value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:CONSTAMPlitude + - POWer:POWer:CLRESPONSE:CONSTAMPlitude? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ```` is the constant amplitude voltage value for the measurement, in the range of + -100 V to 100 V. + """ + return self._constamplitude + + @property + def freqval(self) -> Dict[int, PowerPowerItemClresponseFreqvalItem]: + """Return the ``POWer:POWer:CLRESPONSE:FREQVal`` command. + + **Description:** + - This command sets or queries the generator frequency value of the specified + configuration step for the Control Loop Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:FREQVal?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:FREQVal?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:FREQVal value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:FREQVal + - POWer:POWer:CLRESPONSE:FREQVal? + + **Info:** + - ``Power`` sets the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``FREQ`` sets the configuration step number, in the range of 1 to 11. Values + outside this range will report an error. + - ```` sets the frequency of the specified configuration step number, in the range + of 10 Hz to 50 MHz. + """ + return self._freqval + + @property + def genipaddress(self) -> PowerPowerItemClresponseGenipaddress: + """Return the ``POWer:POWer:CLRESPONSE:GENIPADDress`` command. + + **Description:** + - Sets or queries the IP address of the external generator to be used with the specified + Control Loop Response measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:GENIPADDress?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENIPADDress?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENIPADDress value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:GENIPADDress + - POWer:POWer:CLRESPONSE:GENIPADDress? + + **Info:** + - ``POWer`` is the number of the power measurement. is the IP address of the + generator. + """ + return self._genipaddress + + @property + def generator(self) -> PowerPowerItemClresponseGenerator: + """Return the ``POWer:POWer:CLRESPONSE:GENerator`` command. + + **Description:** + - Sets or queries the generator source for the specified Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:GENerator?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENerator?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:GENerator value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator? + + **Info:** + - ``POWer`` is the number of the power measurement.INTernal sets the internal + generator as the source for the Control Loop Response power measurement. + - ``EXTernal`` sets the external generator as the source for the Control Loop Response + power measurement. + """ + return self._generator + + @property + def impedance(self) -> PowerPowerItemClresponseImpedance: + """Return the ``POWer:POWer:CLRESPONSE:IMPEDance`` command. + + **Description:** + - This command sets or queries the vertical termination impedance for the Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:IMPEDance?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:IMPEDance?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:IMPEDance value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:IMPEDance {FIFTy|HIGHZ} + - POWer:POWer:CLRESPONSE:IMPEDance? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``FIFTy`` sets the impedance to be 50 Ω. + - ``HIGHZ`` sets the impedance to be 1 MΩ. + """ + return self._impedance + + @property + def inputsource(self) -> PowerPowerItemClresponseInputsource: + """Return the ``POWer:POWer:CLRESPONSE:INPUTSOurce`` command. + + **Description:** + - This command sets or queries the input source for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:INPUTSOurce?`` + query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:INPUTSOurce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:INPUTSOurce value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:INPUTSOurce CH + - POWer:POWer:CLRESPONSE:INPUTSOurce? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``CH`` sets the channel to use for the output signal source. + """ + return self._inputsource + + @property + def outputsource(self) -> PowerPowerItemClresponseOutputsource: + """Return the ``POWer:POWer:CLRESPONSE:OUTPUTSOurce`` command. + + **Description:** + - This command sets or queries the output source for the Control Loop Response power + measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:OUTPUTSOurce?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:OUTPUTSOurce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:OUTPUTSOurce value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:OUTPUTSOurce CH + - POWer:POWer:CLRESPONSE:OUTPUTSOurce? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``CH`` sets the channel to use for the output signal source. + """ + return self._outputsource + + @property + def ppd(self) -> PowerPowerItemClresponsePpd: + """Return the ``POWer:POWer:CLRESPONSE:PPD`` command. + + **Description:** + - This command sets or queries the points per decade (PPD) value for the Control Loop + Response power measurement. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:PPD?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE:PPD?`` + query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:PPD value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:PPD + - POWer:POWer:CLRESPONSE:PPD? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ```` is the PPD value for the measurement, in the range of 10 to 100 points. + """ + return self._ppd + + @property + def startfrequency(self) -> PowerPowerItemClresponseStartfrequency: + """Return the ``POWer:POWer:CLRESPONSE:STARTFREQuency`` command. + + **Description:** + - This command sets or queries the start frequency value for the Control Loop Response + power measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:STARTFREQuency?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STARTFREQuency?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STARTFREQuency value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:STARTFREQuency + - POWer:POWer:CLRESPONSE:STARTFREQuency? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ```` is the starting frequency for the measurement, in the range of 10 Hz to 50 + MHz. + """ + return self._startfrequency + + @property + def stopfrequency(self) -> PowerPowerItemClresponseStopfrequency: + """Return the ``POWer:POWer:CLRESPONSE:STOPFREQuency`` command. + + **Description:** + - This command sets or queries the stop frequency value for the Control Loop Response + power measurement. + + **Usage:** + - Using the ``.query()`` method will send the + ``POWer:POWer:CLRESPONSE:STOPFREQuency?`` query. + - Using the ``.verify(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STOPFREQuency?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:STOPFREQuency value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:STOPFREQuency + - POWer:POWer:CLRESPONSE:STOPFREQuency? + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ```` is the stop frequency for the measurement, in the range of 10 Hz to 50 MHz. + """ + return self._stopfrequency + + @property + def testconnection(self) -> PowerPowerItemClresponseTestconnection: + """Return the ``POWer:POWer:CLRESPONSE:TESTCONNection`` command. + + **Description:** + - This command tests the connection to the external generator used with the specified + Control Loop Response power measurement. + + **Usage:** + - Using the ``.write(value)`` method will send the + ``POWer:POWer:CLRESPONSE:TESTCONNection value`` command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:CLRESPONSE:TESTCONNection EXECute + + **Info:** + - ``POWer`` is the number of the PSRR power measurement. + - ``EXECute`` runs the test connection function. + """ + return self._testconnection + + +class PowerPowerItem(ValidatedDynamicNumberCmd, SCPICmdRead): + """The ``POWer:POWer`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.clresponse``: The ``POWer:POWer:CLRESPONSE`` command tree. + - ``.preset``: The ``POWer:POWer:PRESET`` command. + - ``.results``: The ``POWer:POWer:RESUlts`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._clresponse = PowerPowerItemClresponse(device, f"{self._cmd_syntax}:CLRESPONSE") + self._preset = PowerPowerItemPreset(device, f"{self._cmd_syntax}:PRESET") + self._results = PowerPowerItemResults(device, f"{self._cmd_syntax}:RESUlts") + + @property + def clresponse(self) -> PowerPowerItemClresponse: + """Return the ``POWer:POWer:CLRESPONSE`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:CLRESPONSE?`` query + and raise an AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.ampval``: The ``POWer:POWer:CLRESPONSE:AMPVal`` command. + - ``.ampmode``: The ``POWer:POWer:CLRESPONSE:AMPMode`` command. + - ``.analysismethod``: The ``POWer:POWer:CLRESPONSE:ANALYSISMethod`` command. + - ``.connectstatus``: The ``POWer:POWer:CLRESPONSE:CONNECTSTATus`` command. + - ``.constamplitude``: The ``POWer:POWer:CLRESPONSE:CONSTAMPlitude`` command. + - ``.freqval``: The ``POWer:POWer:CLRESPONSE:FREQVal`` command. + - ``.genipaddress``: The ``POWer:POWer:CLRESPONSE:GENIPADDress`` command. + - ``.generator``: The ``POWer:POWer:CLRESPONSE:GENerator`` command. + - ``.impedance``: The ``POWer:POWer:CLRESPONSE:IMPEDance`` command. + - ``.inputsource``: The ``POWer:POWer:CLRESPONSE:INPUTSOurce`` command. + - ``.outputsource``: The ``POWer:POWer:CLRESPONSE:OUTPUTSOurce`` command. + - ``.ppd``: The ``POWer:POWer:CLRESPONSE:PPD`` command. + - ``.startfrequency``: The ``POWer:POWer:CLRESPONSE:STARTFREQuency`` command. + - ``.stopfrequency``: The ``POWer:POWer:CLRESPONSE:STOPFREQuency`` command. + - ``.testconnection``: The ``POWer:POWer:CLRESPONSE:TESTCONNection`` command. + """ + return self._clresponse + + @property + def preset(self) -> PowerPowerItemPreset: + """Return the ``POWer:POWer:PRESET`` command. + + **Description:** + - This command runs a power preset action for the specified power measurement number. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:POWer:PRESET value`` + command. + + **SCPI Syntax:** + + :: + + - POWer:POWer:PRESET {EXECute} + + **Info:** + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``EXECute`` runs the power preset action. + """ + return self._preset + + @property + def results(self) -> PowerPowerItemResults: + """Return the ``POWer:POWer:RESUlts`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer:RESUlts?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer:RESUlts?`` query + and raise an AssertionError if the returned value does not match ``value``. + + **Info:** + - ``POWer`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. This must be POWer1. + + Sub-properties: + - ``.currentacq``: The ``POWer:POWer:RESUlts:CURRentacq`` command tree. + """ + return self._results + + +class PowerDelete(SCPICmdWrite): + """The ``POWer:DELete`` command. + + **Description:** + - This command deletes the specified power measurement number. The power measurement number + is specified by x. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:DELete value`` command. + + **SCPI Syntax:** + + :: + + - POWer:DELete 'POWER' + """ + + +class PowerAddnew(SCPICmdWrite): + """The ``POWer:ADDNew`` command. + + **Description:** + - This command adds the specified power measurement number. The power measurement number is + specified by x. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:ADDNew value`` command. + + **SCPI Syntax:** + + :: + + - POWer:ADDNew 'POWER' + """ + + +class Power(SCPICmdRead): + """The ``POWer`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer?`` query. + - Using the ``.verify(value)`` method will send the ``POWer?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.addnew``: The ``POWer:ADDNew`` command. + - ``.delete``: The ``POWer:DELete`` command. + - ``.power``: The ``POWer:POWer`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "POWer") -> None: + super().__init__(device, cmd_syntax) + self._addnew = PowerAddnew(device, f"{self._cmd_syntax}:ADDNew") + self._delete = PowerDelete(device, f"{self._cmd_syntax}:DELete") + self._power: Dict[int, PowerPowerItem] = DefaultDictPassKeyToFactory( + lambda x: PowerPowerItem(device, f"{self._cmd_syntax}:POWer{x}") + ) + + @property + def addnew(self) -> PowerAddnew: + """Return the ``POWer:ADDNew`` command. + + **Description:** + - This command adds the specified power measurement number. The power measurement number + is specified by x. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:ADDNew value`` command. + + **SCPI Syntax:** + + :: + + - POWer:ADDNew 'POWER' + """ + return self._addnew + + @property + def delete(self) -> PowerDelete: + """Return the ``POWer:DELete`` command. + + **Description:** + - This command deletes the specified power measurement number. The power measurement + number is specified by x. + + **Usage:** + - Using the ``.write(value)`` method will send the ``POWer:DELete value`` command. + + **SCPI Syntax:** + + :: + + - POWer:DELete 'POWER' + """ + return self._delete + + @property + def power(self) -> Dict[int, PowerPowerItem]: + """Return the ``POWer:POWer`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer:POWer?`` query. + - Using the ``.verify(value)`` method will send the ``POWer:POWer?`` query and raise + an AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.clresponse``: The ``POWer:POWer:CLRESPONSE`` command tree. + - ``.preset``: The ``POWer:POWer:PRESET`` command. + - ``.results``: The ``POWer:POWer:RESUlts`` command tree. + """ + return self._power diff --git a/src/tm_devices/commands/_1zn03_mso/ref.py b/src/tm_devices/commands/_1zn03_mso/ref.py index 21e33bdc..68389c68 100644 --- a/src/tm_devices/commands/_1zn03_mso/ref.py +++ b/src/tm_devices/commands/_1zn03_mso/ref.py @@ -15,12 +15,19 @@ - REF:DELete - REF:LIST? - REF:REF:DESKew + - REF:REF:DESKew? - REF:REF:LABel:COLor + - REF:REF:LABel:COLor? - REF:REF:LABel:FONT:BOLD {|OFF|ON} + - REF:REF:LABel:FONT:BOLD? - REF:REF:LABel:FONT:ITALic {|OFF|ON} + - REF:REF:LABel:FONT:ITALic? - REF:REF:LABel:FONT:SIZE + - REF:REF:LABel:FONT:SIZE? - REF:REF:LABel:FONT:TYPE + - REF:REF:LABel:FONT:TYPE? - REF:REF:LABel:FONT:UNDERline {|OFF|ON} + - REF:REF:LABel:FONT:UNDERline? - REF:REF:LABel:NAMe - REF:REF:LABel:NAMe? - REF:REF:LABel:XPOS @@ -28,6 +35,7 @@ - REF:REF:LABel:YPOS - REF:REF:LABel:YPOS? - REF:REF:SOUrce + - REF:REF:SOUrce? """ from typing import Dict, Optional, TYPE_CHECKING @@ -42,13 +50,16 @@ from tm_devices.drivers.pi.pi_device import PIDevice -class RefRefItemSource(SCPICmdWrite): +class RefRefItemSource(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:SOUrce`` command. **Description:** - This command sets or queries the filename used by the given reference. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:SOUrce?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:SOUrce value`` command. **SCPI Syntax:** @@ -56,6 +67,7 @@ class RefRefItemSource(SCPICmdWrite): :: - REF:REF:SOUrce + - REF:REF:SOUrce? **Info:** - ```` is the reference file name. @@ -146,13 +158,16 @@ class RefRefItemLabelName(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class RefRefItemLabelFontUnderline(SCPICmdWrite): +class RefRefItemLabelFontUnderline(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:FONT:UNDERline`` command. **Description:** - This command sets or queries the underline state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:UNDERline?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:UNDERline?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:UNDERline value`` command. @@ -161,6 +176,7 @@ class RefRefItemLabelFontUnderline(SCPICmdWrite): :: - REF:REF:LABel:FONT:UNDERline {|OFF|ON} + - REF:REF:LABel:FONT:UNDERline? **Info:** - ```` = 0 disables underline font; any other value turns this feature on. @@ -169,7 +185,7 @@ class RefRefItemLabelFontUnderline(SCPICmdWrite): """ -class RefRefItemLabelFontType(SCPICmdWrite): +class RefRefItemLabelFontType(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:FONT:TYPE`` command. **Description:** @@ -177,6 +193,9 @@ class RefRefItemLabelFontType(SCPICmdWrite): or Times New Roman. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:TYPE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:TYPE value`` command. @@ -185,6 +204,7 @@ class RefRefItemLabelFontType(SCPICmdWrite): :: - REF:REF:LABel:FONT:TYPE + - REF:REF:LABel:FONT:TYPE? **Info:** - ```` is the font type. @@ -193,13 +213,16 @@ class RefRefItemLabelFontType(SCPICmdWrite): _WRAP_ARG_WITH_QUOTES = True -class RefRefItemLabelFontSize(SCPICmdWrite): +class RefRefItemLabelFontSize(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:FONT:SIZE`` command. **Description:** - This command sets or queries the font size of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:SIZE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:SIZE value`` command. @@ -208,19 +231,23 @@ class RefRefItemLabelFontSize(SCPICmdWrite): :: - REF:REF:LABel:FONT:SIZE + - REF:REF:LABel:FONT:SIZE? **Info:** - ```` is the font size of the label. """ -class RefRefItemLabelFontItalic(SCPICmdWrite): +class RefRefItemLabelFontItalic(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:FONT:ITALic`` command. **Description:** - This command sets or queries the italic state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:ITALic?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:ITALic value`` command. @@ -229,6 +256,7 @@ class RefRefItemLabelFontItalic(SCPICmdWrite): :: - REF:REF:LABel:FONT:ITALic {|OFF|ON} + - REF:REF:LABel:FONT:ITALic? **Info:** - ```` = 0 disables italic font; any other value turns this feature on. @@ -237,13 +265,16 @@ class RefRefItemLabelFontItalic(SCPICmdWrite): """ -class RefRefItemLabelFontBold(SCPICmdWrite): +class RefRefItemLabelFontBold(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:FONT:BOLD`` command. **Description:** - This command sets or queries the bold state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:BOLD?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:BOLD value`` command. @@ -252,6 +283,7 @@ class RefRefItemLabelFontBold(SCPICmdWrite): :: - REF:REF:LABel:FONT:BOLD {|OFF|ON} + - REF:REF:LABel:FONT:BOLD? **Info:** - ```` = 0 disables bold font; any other value turns this feature on. @@ -292,6 +324,9 @@ def bold(self) -> RefRefItemLabelFontBold: - This command sets or queries the bold state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:BOLD?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:BOLD?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:BOLD value`` command. @@ -300,6 +335,7 @@ def bold(self) -> RefRefItemLabelFontBold: :: - REF:REF:LABel:FONT:BOLD {|OFF|ON} + - REF:REF:LABel:FONT:BOLD? **Info:** - ```` = 0 disables bold font; any other value turns this feature on. @@ -316,6 +352,9 @@ def italic(self) -> RefRefItemLabelFontItalic: - This command sets or queries the italic state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:ITALic?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:ITALic?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:ITALic value`` command. @@ -324,6 +363,7 @@ def italic(self) -> RefRefItemLabelFontItalic: :: - REF:REF:LABel:FONT:ITALic {|OFF|ON} + - REF:REF:LABel:FONT:ITALic? **Info:** - ```` = 0 disables italic font; any other value turns this feature on. @@ -340,6 +380,9 @@ def size(self) -> RefRefItemLabelFontSize: - This command sets or queries the font size of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:SIZE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:SIZE value`` command. @@ -348,6 +391,7 @@ def size(self) -> RefRefItemLabelFontSize: :: - REF:REF:LABel:FONT:SIZE + - REF:REF:LABel:FONT:SIZE? **Info:** - ```` is the font size of the label. @@ -363,6 +407,9 @@ def type(self) -> RefRefItemLabelFontType: Arial or Times New Roman. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:TYPE?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:TYPE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:TYPE value`` command. @@ -371,6 +418,7 @@ def type(self) -> RefRefItemLabelFontType: :: - REF:REF:LABel:FONT:TYPE + - REF:REF:LABel:FONT:TYPE? **Info:** - ```` is the font type. @@ -385,6 +433,10 @@ def underline(self) -> RefRefItemLabelFontUnderline: - This command sets or queries the underline state of the specified reference label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:FONT:UNDERline?`` + query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:FONT:UNDERline?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:FONT:UNDERline value`` command. @@ -393,6 +445,7 @@ def underline(self) -> RefRefItemLabelFontUnderline: :: - REF:REF:LABel:FONT:UNDERline {|OFF|ON} + - REF:REF:LABel:FONT:UNDERline? **Info:** - ```` = 0 disables underline font; any other value turns this feature on. @@ -402,13 +455,16 @@ def underline(self) -> RefRefItemLabelFontUnderline: return self._underline -class RefRefItemLabelColor(SCPICmdWrite): +class RefRefItemLabelColor(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:LABel:COLor`` command. **Description:** - This command sets or queries the color of the specified ref label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:COLor?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:COLor value`` command. **SCPI Syntax:** @@ -416,6 +472,7 @@ class RefRefItemLabelColor(SCPICmdWrite): :: - REF:REF:LABel:COLor + - REF:REF:LABel:COLor? **Info:** - ```` is the label. To return the color to the default color, send an empty string @@ -457,6 +514,9 @@ def color(self) -> RefRefItemLabelColor: - This command sets or queries the color of the specified ref label. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:LABel:COLor?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:LABel:COLor?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:LABel:COLor value`` command. @@ -465,6 +525,7 @@ def color(self) -> RefRefItemLabelColor: :: - REF:REF:LABel:COLor + - REF:REF:LABel:COLor? **Info:** - ```` is the label. To return the color to the default color, send an empty @@ -577,13 +638,16 @@ def ypos(self) -> RefRefItemLabelYpos: return self._ypos -class RefRefItemDeskew(SCPICmdWrite): +class RefRefItemDeskew(SCPICmdWrite, SCPICmdRead): """The ``REF:REF:DESKew`` command. **Description:** - This command sets or queries the deskew value used for the specified reference. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:DESKew?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:DESKew?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:DESKew value`` command. **SCPI Syntax:** @@ -591,6 +655,7 @@ class RefRefItemDeskew(SCPICmdWrite): :: - REF:REF:DESKew + - REF:REF:DESKew? **Info:** - ```` is the deskew value used for the specified reference. @@ -625,6 +690,9 @@ def deskew(self) -> RefRefItemDeskew: - This command sets or queries the deskew value used for the specified reference. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:DESKew?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:DESKew?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:DESKew value`` command. **SCPI Syntax:** @@ -632,6 +700,7 @@ def deskew(self) -> RefRefItemDeskew: :: - REF:REF:DESKew + - REF:REF:DESKew? **Info:** - ```` is the deskew value used for the specified reference. @@ -664,6 +733,9 @@ def source(self) -> RefRefItemSource: - This command sets or queries the filename used by the given reference. **Usage:** + - Using the ``.query()`` method will send the ``REF:REF:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``REF:REF:SOUrce?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``REF:REF:SOUrce value`` command. **SCPI Syntax:** @@ -671,6 +743,7 @@ def source(self) -> RefRefItemSource: :: - REF:REF:SOUrce + - REF:REF:SOUrce? **Info:** - ```` is the reference file name. diff --git a/src/tm_devices/commands/_1zn03_mso/saveonevent.py b/src/tm_devices/commands/_1zn03_mso/saveonevent.py index 40d53827..02510131 100644 --- a/src/tm_devices/commands/_1zn03_mso/saveonevent.py +++ b/src/tm_devices/commands/_1zn03_mso/saveonevent.py @@ -11,7 +11,8 @@ :: - - SAVEONEVent:FILEDest ? + - SAVEONEVent:FILEDest + - SAVEONEVent:FILEDest? - SAVEONEVent:FILEName - SAVEONEVent:FILEName? - SAVEONEVent:IMAGe:FILEFormat {PNG|BMP|JPG} @@ -280,7 +281,7 @@ class SaveoneventFilename(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class SaveoneventFiledest(SCPICmdWrite): +class SaveoneventFiledest(SCPICmdWrite, SCPICmdRead): """The ``SAVEONEVent:FILEDest`` command. **Description:** @@ -288,13 +289,17 @@ class SaveoneventFiledest(SCPICmdWrite): ``SAVEON:FILE:DEST`` (still valid command, but only an alias for this new command). **Usage:** + - Using the ``.query()`` method will send the ``SAVEONEVent:FILEDest?`` query. + - Using the ``.verify(value)`` method will send the ``SAVEONEVent:FILEDest?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SAVEONEVent:FILEDest value`` command. **SCPI Syntax:** :: - - SAVEONEVent:FILEDest ? + - SAVEONEVent:FILEDest + - SAVEONEVent:FILEDest? **Info:** - ```` specifies the location to store files. @@ -334,6 +339,9 @@ def filedest(self) -> SaveoneventFiledest: ``SAVEON:FILE:DEST`` (still valid command, but only an alias for this new command). **Usage:** + - Using the ``.query()`` method will send the ``SAVEONEVent:FILEDest?`` query. + - Using the ``.verify(value)`` method will send the ``SAVEONEVent:FILEDest?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SAVEONEVent:FILEDest value`` command. @@ -341,7 +349,8 @@ def filedest(self) -> SaveoneventFiledest: :: - - SAVEONEVent:FILEDest ? + - SAVEONEVent:FILEDest + - SAVEONEVent:FILEDest? **Info:** - ```` specifies the location to store files. diff --git a/src/tm_devices/commands/_1zn03_mso/search.py b/src/tm_devices/commands/_1zn03_mso/search.py index b581cbed..54b990b2 100644 --- a/src/tm_devices/commands/_1zn03_mso/search.py +++ b/src/tm_devices/commands/_1zn03_mso/search.py @@ -31,6 +31,7 @@ - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe? - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType {ACKMISS|BITSTUFFing|FORMERRor |ANYERRor} - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType? - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit {ONE|ZERo|NOCARE} @@ -107,7 +108,7 @@ - SEARCH:SEARCH:TRIGger:A:BUS:SENT:FAST:STATus:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:QUALifier {EQual|UNEQual|LESSthan|MOREthan| LESSEQual|MOREEQual|INrange|OUTrange} - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:QUALifier? - - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue? - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:VALue - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:VALue? @@ -206,6 +207,8 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:LEVel:REF? - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH {INCLude|DONTInclude} - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH? + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D {INCLude|DONTInclude} + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D? - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH {INCLude|DONTInclude} - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH? - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:REF {INCLude|DONTInclude} @@ -213,6 +216,7 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:SETTime - SEARCH:SEARCH:TRIGger:A:SETHold:SETTime? - SEARCH:SEARCH:TRIGger:A:STATE {|OFF|ON} + - SEARCH:SEARCH:TRIGger:A:STATE? - SEARCH:SEARCH:TRIGger:A:STOPAcq {|OFF|ON} - SEARCH:SEARCH:TRIGger:A:STOPAcq? - SEARCH:SEARCH:TRIGger:A:TIMEOut:LOGICQUALification {ON|OFF} @@ -228,6 +232,7 @@ - SEARCH:SEARCH:TRIGger:A:TYPe {EDGE| RUNT| TRANsition| PULSEWidth| TIMEOut| LOGIc| SETHold| Bus} - SEARCH:SEARCH:TRIGger:A:TYPe? - SEARCH:SELected SEARCH1 + - SEARCH:SELected? """ # noqa: E501 from typing import Dict, Optional, TYPE_CHECKING @@ -245,7 +250,7 @@ from tm_devices.drivers.pi.pi_device import PIDevice -class SearchSelected(SCPICmdWrite): +class SearchSelected(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SELected`` command. **Description:** @@ -253,6 +258,9 @@ class SearchSelected(SCPICmdWrite): is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SELected?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SELected?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SELected value`` command. **SCPI Syntax:** @@ -260,6 +268,7 @@ class SearchSelected(SCPICmdWrite): :: - SEARCH:SELected SEARCH1 + - SEARCH:SELected? **Info:** - ``SEARCH1`` is the specified search. @@ -677,7 +686,7 @@ class SearchSearchItemTriggerAStopacq(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerAState(SCPICmdWrite): +class SearchSearchItemTriggerAState(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:STATE`` command. **Description:** @@ -685,6 +694,9 @@ class SearchSearchItemTriggerAState(SCPICmdWrite): specified by x. **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:STATE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:STATE value`` command. @@ -693,6 +705,7 @@ class SearchSearchItemTriggerAState(SCPICmdWrite): :: - SEARCH:SEARCH:TRIGger:A:STATE {|OFF|ON} + - SEARCH:SEARCH:TRIGger:A:STATE? **Info:** - ```` = 1 enables the search. Any other character disables the search. @@ -796,6 +809,101 @@ class SearchSearchItemTriggerASetholdLogicpatternMathItem( """ +class SearchSearchItemTriggerASetholdLogicpatternDchItemDigitalBit( + ValidatedDigitalBit, SCPICmdWrite, SCPICmdRead +): + """The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D`` command. + + **Description:** + - This command sets or queries the conditions used for generating an A logic pattern, with + respect to the defined input pattern, and identifies the time that the selected pattern + may be true and still generate the trigger. The search number is specified by x. The + supported digital channel value is 1. The supported digital bit values are 0 to 15. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D {INCLude|DONTInclude} + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D? + + **Info:** + - ``INCLude`` specifies including the specified channel SETHOLD inputs in the specified + search. + - ``DONTInclude`` specifies not including the specified channel SETHOLD inputs in the + specified search. + """ + + +class SearchSearchItemTriggerASetholdLogicpatternDchItem(ValidatedDynamicNumberCmd, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.d``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._d: Dict[ + int, SearchSearchItemTriggerASetholdLogicpatternDchItemDigitalBit + ] = DefaultDictPassKeyToFactory( + lambda x: SearchSearchItemTriggerASetholdLogicpatternDchItemDigitalBit( + device, f"{self._cmd_syntax}_D{x}" + ) + ) + + @property + def d(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternDchItemDigitalBit]: + """Return the ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D`` command. + + **Description:** + - This command sets or queries the conditions used for generating an A logic pattern, + with respect to the defined input pattern, and identifies the time that the selected + pattern may be true and still generate the trigger. The search number is specified by + x. The supported digital channel value is 1. The supported digital bit values are 0 to + 15. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D {INCLude|DONTInclude} + - SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D? + + **Info:** + - ``INCLude`` specifies including the specified channel SETHOLD inputs in the specified + search. + - ``DONTInclude`` specifies not including the specified channel SETHOLD inputs in the + specified search. + """ + return self._d + + class SearchSearchItemTriggerASetholdLogicpatternChannel( ValidatedChannel, SCPICmdWrite, SCPICmdRead ): @@ -842,6 +950,7 @@ class SearchSearchItemTriggerASetholdLogicpattern(SCPICmdRead): Properties: - ``.ch``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH`` command. + - ``.dch``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH`` command tree. - ``.math``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH`` command. - ``.ref``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:REF`` command. """ @@ -855,6 +964,13 @@ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: device, f"{self._cmd_syntax}:CH{x}" ) ) + self._dch: Dict[ + int, SearchSearchItemTriggerASetholdLogicpatternDchItem + ] = DefaultDictPassKeyToFactory( + lambda x: SearchSearchItemTriggerASetholdLogicpatternDchItem( + device, f"{self._cmd_syntax}:DCH{x}" + ) + ) self._math: Dict[ int, SearchSearchItemTriggerASetholdLogicpatternMathItem ] = DefaultDictPassKeyToFactory( @@ -904,6 +1020,22 @@ def ch(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternChannel]: """ return self._ch + @property + def dch(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternDchItem]: + """Return the ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.d``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D`` command. + """ + return self._dch + @property def math(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternMathItem]: """Return the ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH`` command. @@ -1543,6 +1675,7 @@ def logicpattern(self) -> SearchSearchItemTriggerASetholdLogicpattern: Sub-properties: - ``.ch``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH`` command. + - ``.dch``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH`` command tree. - ``.math``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH`` command. - ``.ref``: The ``SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:REF`` command. """ @@ -4715,7 +4848,7 @@ class SearchSearchItemTriggerABusSentPauseTicksValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusSentPauseTicksHivalue(SCPICmdWriteNoArguments, SCPICmdRead): +class SearchSearchItemTriggerABusSentPauseTicksHivalue(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue`` command. **Description:** @@ -4728,14 +4861,14 @@ class SearchSearchItemTriggerABusSentPauseTicksHivalue(SCPICmdWriteNoArguments, - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue`` command. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue? **Info:** @@ -4782,14 +4915,14 @@ def hivalue(self) -> SearchSearchItemTriggerABusSentPauseTicksHivalue: - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue`` command. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue - SEARCH:SEARCH:TRIGger:A:BUS:SENT:PAUSE:TICKs:HIVALue? **Info:** @@ -7943,7 +8076,7 @@ class SearchSearchItemTriggerABusCanErrtype(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite): +class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. **Description:** @@ -7951,6 +8084,11 @@ class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite): signal. The search condition must be set to IDANDDATA OR DATA. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. @@ -7959,6 +8097,7 @@ class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite): :: - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue? **Info:** - ```` @@ -8267,6 +8406,11 @@ def value(self) -> SearchSearchItemTriggerABusCanDataValue: bus signal. The search condition must be set to IDANDDATA OR DATA. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. @@ -8275,6 +8419,7 @@ def value(self) -> SearchSearchItemTriggerABusCanDataValue: :: - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue? **Info:** - ```` @@ -8870,6 +9015,11 @@ def state(self) -> SearchSearchItemTriggerAState: specified by x. **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:STATE?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:STATE?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:STATE value`` command. @@ -8878,6 +9028,7 @@ def state(self) -> SearchSearchItemTriggerAState: :: - SEARCH:SEARCH:TRIGger:A:STATE {|OFF|ON} + - SEARCH:SEARCH:TRIGger:A:STATE? **Info:** - ```` = 1 enables the search. Any other character disables the search. @@ -9433,6 +9584,9 @@ def selected(self) -> SearchSelected: number is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SELected?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SELected?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SELected value`` command. **SCPI Syntax:** @@ -9440,6 +9594,7 @@ def selected(self) -> SearchSelected: :: - SEARCH:SELected SEARCH1 + - SEARCH:SELected? **Info:** - ``SEARCH1`` is the specified search. diff --git a/src/tm_devices/commands/_1zn03_mso/select.py b/src/tm_devices/commands/_1zn03_mso/select.py index 420eeedb..7c2e5829 100644 --- a/src/tm_devices/commands/_1zn03_mso/select.py +++ b/src/tm_devices/commands/_1zn03_mso/select.py @@ -11,6 +11,8 @@ :: + - SELect:CH {ON|OFF|1|0} + - SELect:CH? - SELect:DCH:DAll {ON|OFF|} - SELect:DCH:DAll? """ @@ -20,6 +22,7 @@ DefaultDictPassKeyToFactory, SCPICmdRead, SCPICmdWrite, + ValidatedChannel, ValidatedDynamicNumberCmd, ) @@ -104,6 +107,37 @@ def dall(self) -> SelectDchItemDall: return self._dall +class SelectChannel(ValidatedChannel, SCPICmdWrite, SCPICmdRead): + """The ``SELect:CH`` command. + + **Description:** + - Turns the display of the channel waveform on or off, where is the channel number. + This command also resets the acquisition. The query returns whether the channel is on or + off but does not indicate whether it is the specified waveform. + + **Usage:** + - Using the ``.query()`` method will send the ``SELect:CH?`` query. + - Using the ``.verify(value)`` method will send the ``SELect:CH?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``SELect:CH value`` command. + + **SCPI Syntax:** + + :: + + - SELect:CH {ON|OFF|1|0} + - SELect:CH? + + **Info:** + - ``ON`` turns on the display of the specified waveform. This waveform also becomes the + selected waveform. + - ``OFF`` turns off the display of the specified waveform. + - ``1`` turns on the display of the specified waveform. This waveform also becomes the + selected waveform. + - ``0`` turns off the display of the specified waveform. + """ + + class Select(SCPICmdRead): """The ``SELect`` command tree. @@ -113,15 +147,51 @@ class Select(SCPICmdRead): AssertionError if the returned value does not match ``value``. Properties: + - ``.ch``: The ``SELect:CH`` command. - ``.dch``: The ``SELect:DCH`` command tree. """ def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "SELect") -> None: super().__init__(device, cmd_syntax) + self._ch: Dict[int, SelectChannel] = DefaultDictPassKeyToFactory( + lambda x: SelectChannel(device, f"{self._cmd_syntax}:CH{x}") + ) self._dch: Dict[int, SelectDchItem] = DefaultDictPassKeyToFactory( lambda x: SelectDchItem(device, f"{self._cmd_syntax}:DCH{x}") ) + @property + def ch(self) -> Dict[int, SelectChannel]: + """Return the ``SELect:CH`` command. + + **Description:** + - Turns the display of the channel waveform on or off, where is the channel + number. This command also resets the acquisition. The query returns whether the + channel is on or off but does not indicate whether it is the specified waveform. + + **Usage:** + - Using the ``.query()`` method will send the ``SELect:CH?`` query. + - Using the ``.verify(value)`` method will send the ``SELect:CH?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``SELect:CH value`` command. + + **SCPI Syntax:** + + :: + + - SELect:CH {ON|OFF|1|0} + - SELect:CH? + + **Info:** + - ``ON`` turns on the display of the specified waveform. This waveform also becomes the + selected waveform. + - ``OFF`` turns off the display of the specified waveform. + - ``1`` turns on the display of the specified waveform. This waveform also becomes the + selected waveform. + - ``0`` turns off the display of the specified waveform. + """ + return self._ch + @property def dch(self) -> Dict[int, SelectDchItem]: """Return the ``SELect:DCH`` command tree. diff --git a/src/tm_devices/commands/_1zn03_mso/trigger.py b/src/tm_devices/commands/_1zn03_mso/trigger.py index 93bd65ba..b0b1f2c7 100644 --- a/src/tm_devices/commands/_1zn03_mso/trigger.py +++ b/src/tm_devices/commands/_1zn03_mso/trigger.py @@ -110,6 +110,7 @@ - TRIGger:A:BUS:B:SENT:SLOW:DATA:VALue - TRIGger:A:BUS:B:SENT:SLOW:DATA:VALue? - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue + - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue? - TRIGger:A:BUS:B:SPI:CONDition {SS|STARTofframe|DATa} - TRIGger:A:BUS:B:SPI:CONDition? - TRIGger:A:BUS:B:SPI:DATa:SIZe @@ -3068,7 +3069,7 @@ def data(self) -> TriggerABusBItemSpiData: return self._data -class TriggerABusBItemSentSlowIdentifierValue(SCPICmdWrite): +class TriggerABusBItemSentSlowIdentifierValue(SCPICmdWrite, SCPICmdRead): """The ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue`` command. **Description:** @@ -3076,6 +3077,11 @@ class TriggerABusBItemSentSlowIdentifierValue(SCPICmdWrite): data. B is the specified bus number. **Usage:** + - Using the ``.query()`` method will send the + ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue value`` command. @@ -3084,6 +3090,7 @@ class TriggerABusBItemSentSlowIdentifierValue(SCPICmdWrite): :: - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue + - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue? **Info:** - ```` is the binary identifier value. @@ -3117,6 +3124,11 @@ def value(self) -> TriggerABusBItemSentSlowIdentifierValue: bus data. B is the specified bus number. **Usage:** + - Using the ``.query()`` method will send the + ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue value`` command. @@ -3125,6 +3137,7 @@ def value(self) -> TriggerABusBItemSentSlowIdentifierValue: :: - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue + - TRIGger:A:BUS:B:SENT:SLOW:IDentifier:VALue? **Info:** - ```` is the binary identifier value. diff --git a/src/tm_devices/commands/_7s2p1p_smu/smux.py b/src/tm_devices/commands/_7s2p1p_smu/smux.py index b0059196..31075b2c 100644 --- a/src/tm_devices/commands/_7s2p1p_smu/smux.py +++ b/src/tm_devices/commands/_7s2p1p_smu/smux.py @@ -63,6 +63,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.pulser.enable - smuX.pulser.measure.aperture - smuX.pulser.measure.calibrateY() @@ -6896,6 +6898,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.pulser``: The ``smuX.pulser`` command tree. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. @@ -7218,6 +7222,64 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def pulser(self) -> SmuxItemPulser: """Return the ``smuX.pulser`` command tree. diff --git a/src/tm_devices/commands/_8ojdkz_smu/smux.py b/src/tm_devices/commands/_8ojdkz_smu/smux.py index 8de5ed26..ac506f14 100644 --- a/src/tm_devices/commands/_8ojdkz_smu/smux.py +++ b/src/tm_devices/commands/_8ojdkz_smu/smux.py @@ -62,6 +62,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6760,6 +6762,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -7094,6 +7098,72 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_8wm55i_smu/smux.py b/src/tm_devices/commands/_8wm55i_smu/smux.py index 33d7e308..e2174b25 100644 --- a/src/tm_devices/commands/_8wm55i_smu/smux.py +++ b/src/tm_devices/commands/_8wm55i_smu/smux.py @@ -63,6 +63,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6922,6 +6924,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -7257,6 +7261,72 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_9kezla_smu/smux.py b/src/tm_devices/commands/_9kezla_smu/smux.py index 2ebc0c16..4e0fc036 100644 --- a/src/tm_devices/commands/_9kezla_smu/smux.py +++ b/src/tm_devices/commands/_9kezla_smu/smux.py @@ -63,6 +63,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6920,6 +6922,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -7247,6 +7251,72 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_ak4990_smu/smux.py b/src/tm_devices/commands/_ak4990_smu/smux.py index 09de0b6b..83f27ea6 100644 --- a/src/tm_devices/commands/_ak4990_smu/smux.py +++ b/src/tm_devices/commands/_ak4990_smu/smux.py @@ -63,6 +63,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6921,6 +6923,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -7254,6 +7258,72 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + **Info:** + - ``X``, the source-measure unit (SMU) channel (for example, smua.nvbuffer1 applies to + SMU channel A). + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_am6pcr_smu/smux.py b/src/tm_devices/commands/_am6pcr_smu/smux.py index 4b86f0b7..05e0934e 100644 --- a/src/tm_devices/commands/_am6pcr_smu/smux.py +++ b/src/tm_devices/commands/_am6pcr_smu/smux.py @@ -64,6 +64,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6295,6 +6297,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -6615,6 +6619,64 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_as1ejq_smu/smux.py b/src/tm_devices/commands/_as1ejq_smu/smux.py index d7c9a338..40121bd2 100644 --- a/src/tm_devices/commands/_as1ejq_smu/smux.py +++ b/src/tm_devices/commands/_as1ejq_smu/smux.py @@ -64,6 +64,8 @@ - smuX.measure.rel.levelr - smuX.measure.rel.levelv - smuX.measureYandstep() + - smuX.nvbuffer1 + - smuX.nvbuffer2 - smuX.reset() - smuX.savebuffer() - smuX.sense @@ -6247,6 +6249,8 @@ class SmuxItem(ValidatedChannel, BaseTSPCmd): - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. @@ -6567,6 +6571,64 @@ def measure(self) -> SmuxItemMeasure: """ return self._measure + @property + def nvbuffer1(self) -> str: + """Access the ``smuX.nvbuffer1`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (1 = default buffer1) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer1)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer1) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer1" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer1)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer1`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + + @property + def nvbuffer2(self) -> str: + """Access the ``smuX.nvbuffer2`` attribute. + + **Description:** + - This attribute contains a dedicated reading buffer. (2 = default buffer2) + + **Usage:** + - Accessing this property will send the ``print(smuX.nvbuffer2)`` query. + + **TSP Syntax:** + + :: + + - print(smuX.nvbuffer2) + + Raises: + tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. + """ + try: + if self._device.command_syntax_enabled: # type: ignore[union-attr] + return self._cmd_syntax + ".nvbuffer2" + return self._device.query( # type: ignore[union-attr] + f"print({self._cmd_syntax}.nvbuffer2)" + ) + except AttributeError as error: + msg = f"No TSPDevice object was provided, unable to access the ``{self._cmd_syntax}.nvbuffer2`` attribute." # noqa: E501 + raise NoDeviceProvidedError(msg) from error + @property def sense(self) -> str: """Access the ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_dpo4k_commands.py b/src/tm_devices/commands/_dpo4k_commands.py index 0127edf6..b790a0b8 100644 --- a/src/tm_devices/commands/_dpo4k_commands.py +++ b/src/tm_devices/commands/_dpo4k_commands.py @@ -51,6 +51,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1lxxm9_msomdodpo.cursor import Cursor from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration @@ -70,7 +71,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_dpo4kb_commands.py b/src/tm_devices/commands/_dpo4kb_commands.py index 30703783..fdb916a5 100644 --- a/src/tm_devices/commands/_dpo4kb_commands.py +++ b/src/tm_devices/commands/_dpo4kb_commands.py @@ -51,6 +51,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1lxxm9_msomdodpo.cursor import Cursor from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration @@ -70,7 +71,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/bus.py b/src/tm_devices/commands/_e3e9uu_lpdmso/bus.py index 44c69383..8c24c872 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/bus.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/bus.py @@ -373,6 +373,7 @@ - BUS:B:MDIO:CLOCk:SOUrce {CH|MATH|REF} - BUS:B:MDIO:CLOCk:SOUrce? - BUS:B:MDIO:CLOCk:THReshold + - BUS:B:MDIO:CLOCk:THReshold? - BUS:B:MDIO:DATA:SOUrce {CH|MATH|REF} - BUS:B:MDIO:DATA:SOUrce? - BUS:B:MDIO:DATA:THReshold @@ -10270,7 +10271,7 @@ def threshold(self) -> BusBItemMdioDataThreshold: return self._threshold -class BusBItemMdioClockThreshold(SCPICmdWrite): +class BusBItemMdioClockThreshold(SCPICmdWrite, SCPICmdRead): """The ``BUS:B:MDIO:CLOCk:THReshold`` command. **Description:** @@ -10278,6 +10279,9 @@ class BusBItemMdioClockThreshold(SCPICmdWrite): bus is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:MDIO:CLOCk:THReshold?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:MDIO:CLOCk:THReshold?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:MDIO:CLOCk:THReshold value`` command. @@ -10286,6 +10290,7 @@ class BusBItemMdioClockThreshold(SCPICmdWrite): :: - BUS:B:MDIO:CLOCk:THReshold + - BUS:B:MDIO:CLOCk:THReshold? **Info:** - ``B`` is the number of the bus. @@ -10383,6 +10388,9 @@ def threshold(self) -> BusBItemMdioClockThreshold: The bus is specified by x. **Usage:** + - Using the ``.query()`` method will send the ``BUS:B:MDIO:CLOCk:THReshold?`` query. + - Using the ``.verify(value)`` method will send the ``BUS:B:MDIO:CLOCk:THReshold?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``BUS:B:MDIO:CLOCk:THReshold value`` command. @@ -10391,6 +10399,7 @@ def threshold(self) -> BusBItemMdioClockThreshold: :: - BUS:B:MDIO:CLOCk:THReshold + - BUS:B:MDIO:CLOCk:THReshold? **Info:** - ``B`` is the number of the bus. diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/data.py b/src/tm_devices/commands/_e3e9uu_lpdmso/data.py index b9f20864..09c4baae 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/data.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/data.py @@ -193,7 +193,7 @@ class DataSource(SCPICmdWrite, SCPICmdRead): - ``DIGITALALL`` selects digital waveforms as the source. The Digital data is transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data. - - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAXHold``, ``CH_SV_MINHold`` + - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAX_Hold``, ``CH_SV_MIN_Hold`` selects the specified Spectrum View waveform. - ``CH_MAG_VS_TIME`` , ``CH_FREQ_VS_TIME``, ``CH_PHASE_VS_TIME`` selects the specified RF vs. Time waveform. @@ -685,8 +685,8 @@ def source(self) -> DataSource: transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data. - - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAXHold``, ``CH_SV_MINHold`` - selects the specified Spectrum View waveform. + - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAX_Hold``, + ``CH_SV_MIN_Hold`` selects the specified Spectrum View waveform. - ``CH_MAG_VS_TIME`` , ``CH_FREQ_VS_TIME``, ``CH_PHASE_VS_TIME`` selects the specified RF vs. Time waveform. - ``CH_SV_BASEBAND_IQ`` selects the specified RF baseband IQ data. diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/horizontal.py b/src/tm_devices/commands/_e3e9uu_lpdmso/horizontal.py index 91acb7c2..c22e18ee 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/horizontal.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/horizontal.py @@ -34,7 +34,6 @@ - HORizontal:FASTframe:SUMFrame {NONe|AVErage|ENVelope} - HORizontal:FASTframe:SUMFrame:STATE {|OFF|ON} - HORizontal:FASTframe:SUMFrame:STATE? - - HORizontal:FASTframe:SUMFrame? - HORizontal:FASTframe:TIMEStamp:ALL? - HORizontal:FASTframe:TIMEStamp:DELTa? - HORizontal:FASTframe:TIMEStamp:REFerence? @@ -2035,9 +2034,6 @@ class HorizontalFastframeSumframe(SCPICmdWrite, SCPICmdRead): always the number of frames to acquire. **Usage:** - - Using the ``.query()`` method will send the ``HORizontal:FASTframe:SUMFrame?`` query. - - Using the ``.verify(value)`` method will send the ``HORizontal:FASTframe:SUMFrame?`` query - and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``HORizontal:FASTframe:SUMFrame value`` command. @@ -2046,7 +2042,6 @@ class HorizontalFastframeSumframe(SCPICmdWrite, SCPICmdRead): :: - HORizontal:FASTframe:SUMFrame {NONe|AVErage|ENVelope} - - HORizontal:FASTframe:SUMFrame? **Info:** - ``NONe`` sets the Summary frame to off. @@ -2595,9 +2590,6 @@ def sumframe(self) -> HorizontalFastframeSumframe: value is always the number of frames to acquire. **Usage:** - - Using the ``.query()`` method will send the ``HORizontal:FASTframe:SUMFrame?`` query. - - Using the ``.verify(value)`` method will send the ``HORizontal:FASTframe:SUMFrame?`` - query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``HORizontal:FASTframe:SUMFrame value`` command. @@ -2606,7 +2598,6 @@ def sumframe(self) -> HorizontalFastframeSumframe: :: - HORizontal:FASTframe:SUMFrame {NONe|AVErage|ENVelope} - - HORizontal:FASTframe:SUMFrame? **Info:** - ``NONe`` sets the Summary frame to off. diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/plot.py b/src/tm_devices/commands/_e3e9uu_lpdmso/plot.py index ab893480..9216ce93 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/plot.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/plot.py @@ -42,6 +42,7 @@ - PLOT:PLOT:LABel:FONT:ITALic {|OFF|ON} - PLOT:PLOT:LABel:FONT:ITALic? - PLOT:PLOT:LABel:FONT:SIZE + - PLOT:PLOT:LABel:FONT:SIZE? - PLOT:PLOT:LABel:FONT:TYPE - PLOT:PLOT:LABel:FONT:TYPE? - PLOT:PLOT:LABel:FONT:UNDERline {|OFF|ON} @@ -918,7 +919,7 @@ class PlotPlotItemLabelFontType(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class PlotPlotItemLabelFontSize(SCPICmdWrite): +class PlotPlotItemLabelFontSize(SCPICmdWrite, SCPICmdRead): """The ``PLOT:PLOT:LABel:FONT:SIZE`` command. **Description:** @@ -926,6 +927,9 @@ class PlotPlotItemLabelFontSize(SCPICmdWrite): command/query only applies to Time Trend plots. **Usage:** + - Using the ``.query()`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE?`` query + and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE value`` command. @@ -934,6 +938,7 @@ class PlotPlotItemLabelFontSize(SCPICmdWrite): :: - PLOT:PLOT:LABel:FONT:SIZE + - PLOT:PLOT:LABel:FONT:SIZE? **Info:** - ```` is the font size. @@ -1087,6 +1092,9 @@ def size(self) -> PlotPlotItemLabelFontSize: command/query only applies to Time Trend plots. **Usage:** + - Using the ``.query()`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE?`` query. + - Using the ``.verify(value)`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE?`` + query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``PLOT:PLOT:LABel:FONT:SIZE value`` command. @@ -1095,6 +1103,7 @@ def size(self) -> PlotPlotItemLabelFontSize: :: - PLOT:PLOT:LABel:FONT:SIZE + - PLOT:PLOT:LABel:FONT:SIZE? **Info:** - ```` is the font size. diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/power.py b/src/tm_devices/commands/_e3e9uu_lpdmso/power.py index 0d504457..efabb7be 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/power.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/power.py @@ -31,7 +31,7 @@ - POWer:POWer:CLRESPONSE:FREQVal? - POWer:POWer:CLRESPONSE:GENIPADDress - POWer:POWer:CLRESPONSE:GENIPADDress? - - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator {INTernal} - POWer:POWer:CLRESPONSE:GENerator? - POWer:POWer:CLRESPONSE:IMPEDance {FIFTy|HIGHZ} - POWer:POWer:CLRESPONSE:IMPEDance? @@ -17143,8 +17143,8 @@ class PowerPowerItemClresponseGenerator(SCPICmdWrite, SCPICmdRead): """The ``POWer:POWer:CLRESPONSE:GENerator`` command. **Description:** - - Sets or queries the generator source for the specified Control Loop Response power - measurement. + - This command sets or queries the generator source used to send stimulus signals to the + DUT, for the Control Loop Response power measurement. **Usage:** - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:GENerator?`` @@ -17158,14 +17158,13 @@ class PowerPowerItemClresponseGenerator(SCPICmdWrite, SCPICmdRead): :: - - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator {INTernal} - POWer:POWer:CLRESPONSE:GENerator? **Info:** - - ``POWer`` is the number of the power measurement.INTernal sets the internal generator - as the source for the Control Loop Response power measurement. - - ``EXTernal`` sets the external generator as the source for the Control Loop Response power - measurement. + - ``Power`` is the power measurement number. This is the equivalent of the number shown + in the UI for a power measurement badge. + - ``INTernal`` sets the generator to the instrument AFG. This is the only valid argument. """ @@ -17737,8 +17736,8 @@ def generator(self) -> PowerPowerItemClresponseGenerator: """Return the ``POWer:POWer:CLRESPONSE:GENerator`` command. **Description:** - - Sets or queries the generator source for the specified Control Loop Response power - measurement. + - This command sets or queries the generator source used to send stimulus signals to the + DUT, for the Control Loop Response power measurement. **Usage:** - Using the ``.query()`` method will send the ``POWer:POWer:CLRESPONSE:GENerator?`` @@ -17753,14 +17752,14 @@ def generator(self) -> PowerPowerItemClresponseGenerator: :: - - POWer:POWer:CLRESPONSE:GENerator {INTernal|EXTernal} + - POWer:POWer:CLRESPONSE:GENerator {INTernal} - POWer:POWer:CLRESPONSE:GENerator? **Info:** - - ``POWer`` is the number of the power measurement.INTernal sets the internal - generator as the source for the Control Loop Response power measurement. - - ``EXTernal`` sets the external generator as the source for the Control Loop Response - power measurement. + - ``Power`` is the power measurement number. This is the equivalent of the number + shown in the UI for a power measurement badge. + - ``INTernal`` sets the generator to the instrument AFG. This is the only valid + argument. """ return self._generator diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/rosc.py b/src/tm_devices/commands/_e3e9uu_lpdmso/rosc.py new file mode 100644 index 00000000..b0197ccf --- /dev/null +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/rosc.py @@ -0,0 +1,147 @@ +"""The rosc commands module. + +These commands are used in the following models: +LPD6, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B + +THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. + +Please report an issue if one is found. + +Commands and Queries: + +:: + + - ROSc:SOUrce {INTERnal|EXTernal|TRACking} + - ROSc:SOUrce? + - ROSc:STATE? +""" +from typing import Optional, TYPE_CHECKING + +from .._helpers import SCPICmdRead, SCPICmdWrite + +if TYPE_CHECKING: + from tm_devices.drivers.pi.pi_device import PIDevice + + +class RoscState(SCPICmdRead): + """The ``ROSc:STATE`` command. + + **Description:** + - This query-only command returns whether the time base reference oscillator is locked. This + command will return either LOCKED or UNLOCKED. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:STATE?`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - ROSc:STATE? + """ + + +class RoscSource(SCPICmdWrite, SCPICmdRead): + """The ``ROSc:SOUrce`` command. + + **Description:** + - This command sets or queries the selected source for the time base reference oscillator. + The reference oscillator locks to this source. Depending on the command argument that you + specify, you can use an external reference or use the internal crystal oscillator as the + time base reference. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:SOUrce?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``ROSc:SOUrce value`` command. + + **SCPI Syntax:** + + :: + + - ROSc:SOUrce {INTERnal|EXTernal|TRACking} + - ROSc:SOUrce? + + **Info:** + - ``INTERnal`` specifies the internal 10 MHz crystal oscillator as the time base reference. + - ``EXTernal`` specifies the user-supplied external signal at ±1 ppm as the time base + reference. + - ``TRACking`` specifies the user-supplied external signal at ±1000 ppm as the time base + reference. + """ + + +class Rosc(SCPICmdRead): + """The ``ROSc`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.source``: The ``ROSc:SOUrce`` command. + - ``.state``: The ``ROSc:STATE`` command. + """ + + def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "ROSc") -> None: + super().__init__(device, cmd_syntax) + self._source = RoscSource(device, f"{self._cmd_syntax}:SOUrce") + self._state = RoscState(device, f"{self._cmd_syntax}:STATE") + + @property + def source(self) -> RoscSource: + """Return the ``ROSc:SOUrce`` command. + + **Description:** + - This command sets or queries the selected source for the time base reference + oscillator. The reference oscillator locks to this source. Depending on the command + argument that you specify, you can use an external reference or use the internal + crystal oscillator as the time base reference. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:SOUrce?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the ``ROSc:SOUrce value`` command. + + **SCPI Syntax:** + + :: + + - ROSc:SOUrce {INTERnal|EXTernal|TRACking} + - ROSc:SOUrce? + + **Info:** + - ``INTERnal`` specifies the internal 10 MHz crystal oscillator as the time base + reference. + - ``EXTernal`` specifies the user-supplied external signal at ±1 ppm as the time base + reference. + - ``TRACking`` specifies the user-supplied external signal at ±1000 ppm as the time base + reference. + """ + return self._source + + @property + def state(self) -> RoscState: + """Return the ``ROSc:STATE`` command. + + **Description:** + - This query-only command returns whether the time base reference oscillator is locked. + This command will return either LOCKED or UNLOCKED. + + **Usage:** + - Using the ``.query()`` method will send the ``ROSc:STATE?`` query. + - Using the ``.verify(value)`` method will send the ``ROSc:STATE?`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - ROSc:STATE? + """ + return self._state diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/search.py b/src/tm_devices/commands/_e3e9uu_lpdmso/search.py index c62afb51..dcee5cd1 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/search.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/search.py @@ -35,6 +35,7 @@ - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:QUALifier {EQual|UNEQual|LESSthan|MOREthan |LESSEQual|MOREEQual|INrange|OUTrange} - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:QUALifier? - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:SDI:VALue - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:SDI:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:SSM:VALue @@ -91,36 +92,6 @@ - SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:SEQnum:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:SOUrceport:VALue - SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:SOUrceport:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition {DATa} - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition {SYMbols|ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition? - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition {SOF| FRAMEtype| IDentifier| DATa| IDANDDATA| EOF| ERRor| FDBITS} - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition? - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection {READ|WRITE|NOCARE} @@ -690,6 +661,8 @@ - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF? - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity {ONE|ZERo|NOCARE} - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition {DATa} + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition? - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe? - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue @@ -718,12 +691,40 @@ - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe? - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue? - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:CONDition {DATa|EOp|PARItyerror|STARt} - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:CONDition? - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:SIZe - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:SIZe? - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:VALue - SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition {SYMbols|ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition? - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:DISParity {POSITIVe|NEGAtive|EITHer} - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:DISParity? - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:ERRor {SYMBol|DISParity} @@ -883,6 +884,7 @@ - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:OFFSet - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:OFFSet? - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier {EQual|UNEQual| LESSthan|MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier? - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:SIZe - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:SIZe? - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:TYPe {ANY|DATA|MDATA} @@ -1200,6 +1202,7 @@ - SEARCH:SEARCH:TRIGger:A:TYPe {EDGE|RUNT|TRANsition|PULSEWidth|TIMEOut|LOGIc| SETHold|WINdow|Bus|DDRRead|DDRREADWrite|DDRWrite} - SEARCH:SEARCH:TRIGger:A:TYPe? - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng {UPPer|LOWer|EITher|NONe} + - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng? - SEARCH:SEARCH:TRIGger:A:WINdow:LOGICQUALification {ON|OFF} - SEARCH:SEARCH:TRIGger:A:WINdow:LOGICQUALification? - SEARCH:SEARCH:TRIGger:A:WINdow:POLarity {UPPer|LOWer|EITher|NONe} @@ -1549,7 +1552,7 @@ class SearchSearchItemTriggerAWindowLogicqualification(SCPICmdWrite, SCPICmdRead """ -class SearchSearchItemTriggerAWindowCrossing(SCPICmdWrite): +class SearchSearchItemTriggerAWindowCrossing(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng`` command. **Description:** @@ -1558,6 +1561,11 @@ class SearchSearchItemTriggerAWindowCrossing(SCPICmdWrite): is INSIDEGreater or OUTSIDEGreater. The search number is specified by x. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng value`` command. @@ -1566,6 +1574,7 @@ class SearchSearchItemTriggerAWindowCrossing(SCPICmdWrite): :: - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng {UPPer|LOWer|EITher|NONe} + - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng? **Info:** - ``UPPer`` if ``:TRIGger:A:WINdow:WHEn`` is INSIDEGreater, the instrument triggers when the @@ -1644,6 +1653,11 @@ def crossing(self) -> SearchSearchItemTriggerAWindowCrossing: specified by x. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng value`` command. @@ -1652,6 +1666,7 @@ def crossing(self) -> SearchSearchItemTriggerAWindowCrossing: :: - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng {UPPer|LOWer|EITher|NONe} + - SEARCH:SEARCH:TRIGger:A:WINdow:CROSSIng? **Info:** - ``UPPer`` if ``:TRIGger:A:WINdow:WHEn`` is INSIDEGreater, the instrument triggers when @@ -13801,7 +13816,7 @@ class SearchSearchItemTriggerABusUsbDataSize(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusUsbDataQualifier(SCPICmdWrite): +class SearchSearchItemTriggerABusUsbDataQualifier(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier`` command. **Description:** @@ -13810,6 +13825,11 @@ class SearchSearchItemTriggerABusUsbDataQualifier(SCPICmdWrite): x. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier value`` command. @@ -13818,6 +13838,7 @@ class SearchSearchItemTriggerABusUsbDataQualifier(SCPICmdWrite): :: - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier {EQual|UNEQual| LESSthan|MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier? **Info:** - ``EQUal`` specifies the qualifier as Equal. @@ -13997,6 +14018,11 @@ def qualifier(self) -> SearchSearchItemTriggerABusUsbDataQualifier: specified by x. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier value`` command. @@ -14005,6 +14031,7 @@ def qualifier(self) -> SearchSearchItemTriggerABusUsbDataQualifier: :: - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier {EQual|UNEQual| LESSthan|MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:USB:DATa:QUALifier? **Info:** - ``EQUal`` specifies the qualifier as Equal. @@ -20964,6 +20991,36 @@ class SearchSearchItemTriggerABusS8b10bDisparity(SCPICmdWrite, SCPICmdRead): """ +class SearchSearchItemTriggerABusS8b10bCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition`` command. + + **Description:** + - This command sets or queries the type of data search for an 8B10B bus. The search number + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition {SYMbols|ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition? + + **Info:** + - ``Search`` is the number of the search. + - ``SYMbols`` specifies the search condition as data or control. + - ``ERRors`` specifies the search condition as Symbol error or disparity error. + """ + + class SearchSearchItemTriggerABusS8b10b(SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B`` command tree. @@ -20975,6 +21032,7 @@ class SearchSearchItemTriggerABusS8b10b(SCPICmdRead): returned value does not match ``value``. Properties: + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition`` command. - ``.disparity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:DISParity`` command. - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:ERRor`` command. - ``.symbol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:SYMbol`` command tree. @@ -20982,12 +21040,46 @@ class SearchSearchItemTriggerABusS8b10b(SCPICmdRead): def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) + self._condition = SearchSearchItemTriggerABusS8b10bCondition( + device, f"{self._cmd_syntax}:CONDition" + ) self._disparity = SearchSearchItemTriggerABusS8b10bDisparity( device, f"{self._cmd_syntax}:DISParity" ) self._error = SearchSearchItemTriggerABusS8b10bError(device, f"{self._cmd_syntax}:ERRor") self._symbol = SearchSearchItemTriggerABusS8b10bSymbol(device, f"{self._cmd_syntax}:SYMbol") + @property + def condition(self) -> SearchSearchItemTriggerABusS8b10bCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition`` command. + + **Description:** + - This command sets or queries the type of data search for an 8B10B bus. The search + number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition {SYMbols|ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition? + + **Info:** + - ``Search`` is the number of the search. + - ``SYMbols`` specifies the search condition as data or control. + - ``ERRors`` specifies the search condition as Symbol error or disparity error. + """ + return self._condition + @property def disparity(self) -> SearchSearchItemTriggerABusS8b10bDisparity: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:DISParity`` command. @@ -21328,5927 +21420,6682 @@ def data(self) -> SearchSearchItemTriggerABusRs232cData: return self._data -class SearchSearchItemTriggerABusParallelDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. +class SearchSearchItemTriggerABusPsifiveStatusValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue`` command. **Description:** - - This command sets or queries the binary data string used for a parallel bus search to - determine where to place a mark. The search number is specified by x. + - This command sets or queries the binary status string used for PSI5 triggering if the + trigger condition is status. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue? **Info:** - - ```` specifies the data value in a valid format. Valid characters are 0-9. + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusParallelData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. +class SearchSearchItemTriggerABusPsifiveStatus(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusParallelDataValue( + self._value = SearchSearchItemTriggerABusPsifiveStatusValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusParallelDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveStatusValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue`` command. **Description:** - - This command sets or queries the binary data string used for a parallel bus search to - determine where to place a mark. The search number is specified by x. + - This command sets or queries the binary status string used for PSI5 triggering if the + trigger condition is status. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue? **Info:** - - ```` specifies the data value in a valid format. Valid characters are 0-9. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ return self._value -class SearchSearchItemTriggerABusParallel(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._data = SearchSearchItemTriggerABusParallelData(device, f"{self._cmd_syntax}:DATa") - - @property - def data(self) -> SearchSearchItemTriggerABusParallelData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. - """ - return self._data - - -class SearchSearchItemTriggerABusOnewireSearchromRomcode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. +class SearchSearchItemTriggerABusPsifiveSensorAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue`` command. **Description:** - - This command sets or queries the ROM code for Search ROM in ONEWIRE bus. MODe should be - set to Standard. + - This command sets or queries the binary sensor address string used for PSI5 triggering if + the trigger condition is Sensor Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the ROM code for Search ROM. The default size and value of ROM - code for Search ROM is 64 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusOnewireSearchrom(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. +class SearchSearchItemTriggerABusPsifiveSensorAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.romcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._romcode = SearchSearchItemTriggerABusOnewireSearchromRomcode( - device, f"{self._cmd_syntax}:ROMCODe" + self._value = SearchSearchItemTriggerABusPsifiveSensorAddressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def romcode(self) -> SearchSearchItemTriggerABusOnewireSearchromRomcode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveSensorAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue`` command. **Description:** - - This command sets or queries the ROM code for Search ROM in ONEWIRE bus. MODe should - be set to Standard. + - This command sets or queries the binary sensor address string used for PSI5 triggering + if the trigger condition is Sensor Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the ROM code for Search ROM. The default size and value of ROM - code for Search ROM is 64 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._romcode - + return self._value -class SearchSearchItemTriggerABusOnewireReadromSerialnumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` command. - **Description:** - - This command sets or queries the serial number for Read ROM in ONEWIRE bus. MODe should be - set to Standard. +class SearchSearchItemTriggerABusPsifiveSensor(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess`` command tree. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusPsifiveSensorAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer? + @property + def address(self) -> SearchSearchItemTriggerABusPsifiveSensorAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess`` command tree. - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The default - size and value of serial number for Read ROM is 48 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX'. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue`` + command. + """ + return self._address -class SearchSearchItemTriggerABusOnewireReadromFamilycode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` command. +class SearchSearchItemTriggerABusPsifiveSensorstatusType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe`` command. **Description:** - - This command sets or queries the family code for Read ROM in ONEWIRE bus. MODe should be - set to Standard. + - This command sets or queries the sensor status for PSI5 bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Read ROM is 8 bits and 'XXXXXXXX'. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``READy`` specifies the sensor status as ready. This is the default value. + - ``BUSY`` specifies the sensor status as busy. + - ``DEFect`` specifies the sensor status as defect. + - ``SERVICEMODe`` specifies the sensor status as service mode. + - ``UNLocked`` specifies the sensor status as unlocked. + """ # noqa: E501 -class SearchSearchItemTriggerABusOnewireReadrom(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. +class SearchSearchItemTriggerABusPsifiveSensorstatus(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` - command. - - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` - command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._familycode = SearchSearchItemTriggerABusOnewireReadromFamilycode( - device, f"{self._cmd_syntax}:FAMILYCODe" - ) - self._serialnumber = SearchSearchItemTriggerABusOnewireReadromSerialnumber( - device, f"{self._cmd_syntax}:SERIALNUMBer" + self._type = SearchSearchItemTriggerABusPsifiveSensorstatusType( + device, f"{self._cmd_syntax}:TYPe" ) @property - def familycode(self) -> SearchSearchItemTriggerABusOnewireReadromFamilycode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` command. - - **Description:** - - This command sets or queries the family code for Read ROM in ONEWIRE bus. MODe should - be set to Standard. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe? - - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Read ROM is 8 bits and 'XXXXXXXX'. - """ - return self._familycode - - @property - def serialnumber(self) -> SearchSearchItemTriggerABusOnewireReadromSerialnumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` command. + def type(self) -> SearchSearchItemTriggerABusPsifiveSensorstatusType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe`` command. **Description:** - - This command sets or queries the serial number for Read ROM in ONEWIRE bus. MODe - should be set to Standard. + - This command sets or queries the sensor status for PSI5 bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The - default size and value of serial number for Read ROM is 48 bits and 'XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. - """ - return self._serialnumber + - ``READy`` specifies the sensor status as ready. This is the default value. + - ``BUSY`` specifies the sensor status as busy. + - ``DEFect`` specifies the sensor status as defect. + - ``SERVICEMODe`` specifies the sensor status as service mode. + - ``UNLocked`` specifies the sensor status as unlocked. + """ # noqa: E501 + return self._type -class SearchSearchItemTriggerABusOnewireOverdriveSerialnumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. +class SearchSearchItemTriggerABusPsifiveRegisterAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue`` command. **Description:** - - This command sets or queries the serial number for Overdrive Match ROM in ONEWIRE bus. - MODe should be set to Overdrive. + - This command sets or queries the binary register address string used for PSI5 triggering + if the trigger condition is Register Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The default - size and value of serial number for Overdrive match ROM is 48 bits and 'XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusOnewireOverdriveFamilycode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` command. - - **Description:** - - This command sets or queries the Family Code for Overdrive Match ROM in ONEWIRE bus. MODe - should be set to Overdrive. +class SearchSearchItemTriggerABusPsifiveRegisterAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe? - - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Overdrive match ROM is 8 bits and 'XXXXXXXX'. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusOnewireOverdrive(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query and raise an AssertionError if - the returned value does not match ``value``. Properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` - command. - - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._familycode = SearchSearchItemTriggerABusOnewireOverdriveFamilycode( - device, f"{self._cmd_syntax}:FAMILYCODe" - ) - self._serialnumber = SearchSearchItemTriggerABusOnewireOverdriveSerialnumber( - device, f"{self._cmd_syntax}:SERIALNUMBer" + self._value = SearchSearchItemTriggerABusPsifiveRegisterAddressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def familycode(self) -> SearchSearchItemTriggerABusOnewireOverdriveFamilycode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveRegisterAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue`` command. **Description:** - - This command sets or queries the Family Code for Overdrive Match ROM in ONEWIRE bus. - MODe should be set to Overdrive. + - This command sets or queries the binary register address string used for PSI5 + triggering if the trigger condition is Register Address. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Overdrive match ROM is 8 bits and 'XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._familycode + return self._value - @property - def serialnumber(self) -> SearchSearchItemTriggerABusOnewireOverdriveSerialnumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. - **Description:** - - This command sets or queries the serial number for Overdrive Match ROM in ONEWIRE bus. - MODe should be set to Overdrive. +class SearchSearchItemTriggerABusPsifiveRegister(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess`` command + tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusPsifiveRegisterAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + + @property + def address(self) -> SearchSearchItemTriggerABusPsifiveRegisterAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer? - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The - default size and value of serial number for Overdrive match ROM is 48 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue`` + command. """ - return self._serialnumber + return self._address -class SearchSearchItemTriggerABusOnewireMatchromSerialnumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. +class SearchSearchItemTriggerABusPsifiveRegisteraddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess`` command. **Description:** - - This command sets or queries the serial number for Match ROM in ONEWIRE bus. MODe should - be set to Standard. + - This command sets or queries the register address for PSI5 bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The default - size and value of serial number for Match ROM is 48 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX'. + - ``TWOBIT`` specifies the register address value as 2 bit. This is the default value. + - ``SIXBIT`` specifies the register address value as 6 bit. + - ``EIGHTBIT`` specifies the register address value as 8 bit. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusOnewireMatchromFamilycode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` command. +class SearchSearchItemTriggerABusPsifiveFunctioncodetype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe`` command. **Description:** - - This command sets or queries the family code for Match ROM in ONEWIRE bus. MODe should be - set to Standard. + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is a Function Code. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Match ROM is 8 bits and 'XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusOnewireMatchrom(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. +class SearchSearchItemTriggerABusPsifiveErrortype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe`` command. + + **Description:** + - This command sets or queries the error type for an PSI5 bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe value`` command. - Properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` - command. - - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` - command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe? + + **Info:** + - ``ANY`` specifies the error type value as any. This is the default value. + - ``PARity`` specifies the error type value as parity. + - ``CRC`` specifies the error type value as CRC. + - ``RESPONSECODe`` specifies the error type value as response code. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._familycode = SearchSearchItemTriggerABusOnewireMatchromFamilycode( - device, f"{self._cmd_syntax}:FAMILYCODe" - ) - self._serialnumber = SearchSearchItemTriggerABusOnewireMatchromSerialnumber( - device, f"{self._cmd_syntax}:SERIALNUMBer" - ) - @property - def familycode(self) -> SearchSearchItemTriggerABusOnewireMatchromFamilycode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` command. +class SearchSearchItemTriggerABusPsifiveDataRegionBValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue`` command. - **Description:** - - This command sets or queries the family code for Match ROM in ONEWIRE bus. MODe should - be set to Standard. + **Description:** + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is data region B. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue? + + **Info:** + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusPsifiveDataRegionB(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusPsifiveDataRegionBValue( + device, f"{self._cmd_syntax}:VALue" + ) + + @property + def value(self) -> SearchSearchItemTriggerABusPsifiveDataRegionBValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue`` command. + + **Description:** + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is data region B. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Family Code triggering. The default - size and value of family code for Match ROM is 8 bits and 'XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._familycode + return self._value + + +class SearchSearchItemTriggerABusPsifiveDataRegionAValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue`` command. + + **Description:** + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is data region A. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue? + + **Info:** + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusPsifiveDataRegionA(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusPsifiveDataRegionAValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def serialnumber(self) -> SearchSearchItemTriggerABusOnewireMatchromSerialnumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveDataRegionAValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue`` command. **Description:** - - This command sets or queries the serial number for Match ROM in ONEWIRE bus. MODe - should be set to Standard. + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is data region A. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the binary string used for Serial Number triggering. The - default size and value of serial number for Match ROM is 48 bits and 'XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._serialnumber - + return self._value -class SearchSearchItemTriggerABusOnewireDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. - **Description:** - - This command specifies the binary data string used for ONEWIRe triggering if the trigger - condition is DATA. +class SearchSearchItemTriggerABusPsifiveDataRegion(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue value`` command. - **SCPI Syntax:** + Properties: + - ``.a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A`` command tree. + - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B`` command tree. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._a = SearchSearchItemTriggerABusPsifiveDataRegionA(device, f"{self._cmd_syntax}:A") + self._b = SearchSearchItemTriggerABusPsifiveDataRegionB(device, f"{self._cmd_syntax}:B") - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue? + @property + def a(self) -> SearchSearchItemTriggerABusPsifiveDataRegionA: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A`` command tree. - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. The default size and value for - DATA is 8 bits and 'XXXXXXXX'. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A?`` query and raise an + AssertionError if the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue`` + command. + """ + return self._a + @property + def b(self) -> SearchSearchItemTriggerABusPsifiveDataRegionB: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B`` command tree. -class SearchSearchItemTriggerABusOnewireDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue`` + command. + """ + return self._b + + +class SearchSearchItemTriggerABusPsifiveDataEcuSensorValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for ONEWIRe - triggering if the trigger condition is DATA. The search number is specified by x. + - This command sets or queries the binary Data string used for PSI5 triggering if the + trigger condition is Data in ECU to Sensor communication mode. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values are - 1. The maximum value is 5. + - ```` specifies the value of the data string. The valid characters are 0, 1, and X + for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusOnewireData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. +class SearchSearchItemTriggerABusPsifiveDataEcuSensor(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusOnewireDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusOnewireDataValue( + self._value = SearchSearchItemTriggerABusPsifiveDataEcuSensorValue( device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusOnewireDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveDataEcuSensorValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for ONEWIRe - triggering if the trigger condition is DATA. The search number is specified by x. + - This command sets or queries the binary Data string used for PSI5 triggering if the + trigger condition is Data in ECU to Sensor communication mode. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values - are 1. The maximum value is 5. + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._size + return self._value - @property - def value(self) -> SearchSearchItemTriggerABusOnewireDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. - **Description:** - - This command specifies the binary data string used for ONEWIRe triggering if the - trigger condition is DATA. +class SearchSearchItemTriggerABusPsifiveDataEcu(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._sensor = SearchSearchItemTriggerABusPsifiveDataEcuSensor( + device, f"{self._cmd_syntax}:SENSor" + ) + + @property + def sensor(self) -> SearchSearchItemTriggerABusPsifiveDataEcuSensor: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue value`` command. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue`` + command. + """ + return self._sensor - :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue? +class SearchSearchItemTriggerABusPsifiveData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa`` command tree. - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. The default size and value - for DATA is 8 bits and 'XXXXXXXX'. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.ecu``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU`` command tree. + - ``.region``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._ecu = SearchSearchItemTriggerABusPsifiveDataEcu(device, f"{self._cmd_syntax}:ECU") + self._region = SearchSearchItemTriggerABusPsifiveDataRegion( + device, f"{self._cmd_syntax}:REGion" + ) + + @property + def ecu(self) -> SearchSearchItemTriggerABusPsifiveDataEcu: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor`` command + tree. """ - return self._value + return self._ecu + @property + def region(self) -> SearchSearchItemTriggerABusPsifiveDataRegion: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A`` command tree. + - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B`` command tree. + """ + return self._region -class SearchSearchItemTriggerABusOnewireCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. + +class SearchSearchItemTriggerABusPsifiveDatabits(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs`` command. **Description:** - - This command sets or queries the trigger condition for a ONEWIRe bus. MODe should be set - to Overdrive for OVERDRIVEMATCh and OVERDRIVESKIP. MODe should be set to Standard for - READROM, MATCHROM, SKIPROM, SEARCHROM, ALARMSEARch. The search number is specified by x. + - This command sets or queries the binary register address string used for PSI5 triggering + if the trigger condition is Data in ECU to Sensor communication mode. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition {RESet| PREsence| COMMand| DATa| READROM| MATCHROM| OVERDRIVEMATCh| SKIPROM| OVERDRIVESKIP| SEARCHROM| ALARMSEARch| CRCERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs? **Info:** - - ``Search`` is the number of the search. - - ``RESet`` specifies the search condition as RESet. Reset is the default trigger on - condition. - - ``PREsence`` specifies the search condition as PREsence. - - ``COMMand`` specifies the search condition as COMMand. - - ``DATa`` specifies the search condition as DATa. - - ``READROM`` specifies the search condition as READROM. - - ``MATCHROM`` specifies the search condition as MATCHROM. - - ``SKIPROM`` specifies the search condition as SKIPROM. - - ``SEARCHROM`` specifies the search condition as SEARCHROM. - - ``ALARMSEARch`` specifies the search condition as ALARMSEARch. - - ``CRCERRor`` specifies the search condition as CRCERRor. + - ``FOURBIT`` specifies the data bit value as 4 bit. + - ``EIGHTBIT`` specifies the data bit value as 8 bit. + - ``TWENTYBIT`` specifies the data bit value as 20 bit. + """ + + +class SearchSearchItemTriggerABusPsifiveCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for an PSI5 bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition? + + **Info:** + - ``STARt`` specifies the search condition as Start. This is the default trigger. + - ``STATus`` specifies the search condition as Status. + - ``DATa`` specifies the search condition as Data. + - ``BLOCkid`` specifies the search condition as Block ID. + - ``ERRors`` specifies the search condition as Errors. + - ``STARTBIT`` specifies the search condition as Start Bit. + - ``FUNCTIONCODe`` specifies the search condition as Function Code. + - ``ECUDATa`` specifies the search condition as ECU Data. + - ``SENSORADDRess`` specifies the search condition as Sensor Address. + - ``REGISTERADDRess`` specifies the search condition as Register Address. + - ``SENSORSTATus`` specifies the search condition as Sensor Status. + - ``CRCERRor`` specifies the search condition as CRC Error. """ # noqa: E501 -class SearchSearchItemTriggerABusOnewireCommandValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. +class SearchSearchItemTriggerABusPsifiveBlockdataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue`` command. **Description:** - - This command specifies the binary data string used for ONEWIRe triggering if the trigger - condition is COMMAND. + - This command sets or queries the binary block data string used for PSI5 triggering if the + trigger condition is block id. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. The default size and value for - COMMAND is 8 bits and 'XXXXXXXX'. + - ```` specifies the binary block data string. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusOnewireCommand(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. +class SearchSearchItemTriggerABusPsifiveBlockdata(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusOnewireCommandValue( + self._value = SearchSearchItemTriggerABusPsifiveBlockdataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusOnewireCommandValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusPsifiveBlockdataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue`` command. **Description:** - - This command specifies the binary data string used for ONEWIRe triggering if the - trigger condition is COMMAND. + - This command sets or queries the binary block data string used for PSI5 triggering if + the trigger condition is block id. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. The default size and value - for COMMAND is 8 bits and 'XXXXXXXX'. + - ```` specifies the binary block data string. """ return self._value -class SearchSearchItemTriggerABusOnewire(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe`` command tree. +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusPsifive(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. - - ``.matchrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. - - ``.overdrive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. - - ``.readrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. - - ``.searchrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. + - ``.blockdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition`` command. + - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa`` command tree. + - ``.errortype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe`` command. + - ``.functioncodetype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe`` + command. + - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess`` + command. + - ``.register``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister`` command tree. + - ``.sensorstatus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus`` command + tree. + - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor`` command tree. + - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._command = SearchSearchItemTriggerABusOnewireCommand( - device, f"{self._cmd_syntax}:COMMand" + self._blockdata = SearchSearchItemTriggerABusPsifiveBlockdata( + device, f"{self._cmd_syntax}:BLOCKDATa" ) - self._condition = SearchSearchItemTriggerABusOnewireCondition( + self._condition = SearchSearchItemTriggerABusPsifiveCondition( device, f"{self._cmd_syntax}:CONDition" ) - self._data = SearchSearchItemTriggerABusOnewireData(device, f"{self._cmd_syntax}:DATa") - self._matchrom = SearchSearchItemTriggerABusOnewireMatchrom( - device, f"{self._cmd_syntax}:MATCHROM" + self._databits = SearchSearchItemTriggerABusPsifiveDatabits( + device, f"{self._cmd_syntax}:DATABITs" ) - self._overdrive = SearchSearchItemTriggerABusOnewireOverdrive( - device, f"{self._cmd_syntax}:OVERDRIVe" + self._data = SearchSearchItemTriggerABusPsifiveData(device, f"{self._cmd_syntax}:DATa") + self._errortype = SearchSearchItemTriggerABusPsifiveErrortype( + device, f"{self._cmd_syntax}:ERRORTYPe" ) - self._readrom = SearchSearchItemTriggerABusOnewireReadrom( - device, f"{self._cmd_syntax}:READROM" + self._functioncodetype = SearchSearchItemTriggerABusPsifiveFunctioncodetype( + device, f"{self._cmd_syntax}:FUNCTIONCODETYPe" ) - self._searchrom = SearchSearchItemTriggerABusOnewireSearchrom( - device, f"{self._cmd_syntax}:SEARCHROM" + self._registeraddress = SearchSearchItemTriggerABusPsifiveRegisteraddress( + device, f"{self._cmd_syntax}:REGISTERADDRess" + ) + self._register = SearchSearchItemTriggerABusPsifiveRegister( + device, f"{self._cmd_syntax}:REGister" + ) + self._sensorstatus = SearchSearchItemTriggerABusPsifiveSensorstatus( + device, f"{self._cmd_syntax}:SENSORSTATus" + ) + self._sensor = SearchSearchItemTriggerABusPsifiveSensor( + device, f"{self._cmd_syntax}:SENSor" + ) + self._status = SearchSearchItemTriggerABusPsifiveStatus( + device, f"{self._cmd_syntax}:STATus" ) @property - def command(self) -> SearchSearchItemTriggerABusOnewireCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. + def blockdata(self) -> SearchSearchItemTriggerABusPsifiveBlockdata: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue`` command. """ - return self._command + return self._blockdata @property - def condition(self) -> SearchSearchItemTriggerABusOnewireCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. + def condition(self) -> SearchSearchItemTriggerABusPsifiveCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition`` command. **Description:** - - This command sets or queries the trigger condition for a ONEWIRe bus. MODe should be - set to Overdrive for OVERDRIVEMATCh and OVERDRIVESKIP. MODe should be set to Standard - for READROM, MATCHROM, SKIPROM, SEARCHROM, ALARMSEARch. The search number is specified - by x. + - This command sets or queries the trigger condition for an PSI5 bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition {RESet| PREsence| COMMand| DATa| READROM| MATCHROM| OVERDRIVEMATCh| SKIPROM| OVERDRIVESKIP| SEARCHROM| ALARMSEARch| CRCERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition? **Info:** - - ``Search`` is the number of the search. - - ``RESet`` specifies the search condition as RESet. Reset is the default trigger on - condition. - - ``PREsence`` specifies the search condition as PREsence. - - ``COMMand`` specifies the search condition as COMMand. - - ``DATa`` specifies the search condition as DATa. - - ``READROM`` specifies the search condition as READROM. - - ``MATCHROM`` specifies the search condition as MATCHROM. - - ``SKIPROM`` specifies the search condition as SKIPROM. - - ``SEARCHROM`` specifies the search condition as SEARCHROM. - - ``ALARMSEARch`` specifies the search condition as ALARMSEARch. - - ``CRCERRor`` specifies the search condition as CRCERRor. + - ``STARt`` specifies the search condition as Start. This is the default trigger. + - ``STATus`` specifies the search condition as Status. + - ``DATa`` specifies the search condition as Data. + - ``BLOCkid`` specifies the search condition as Block ID. + - ``ERRors`` specifies the search condition as Errors. + - ``STARTBIT`` specifies the search condition as Start Bit. + - ``FUNCTIONCODe`` specifies the search condition as Function Code. + - ``ECUDATa`` specifies the search condition as ECU Data. + - ``SENSORADDRess`` specifies the search condition as Sensor Address. + - ``REGISTERADDRess`` specifies the search condition as Register Address. + - ``SENSORSTATus`` specifies the search condition as Sensor Status. + - ``CRCERRor`` specifies the search condition as CRC Error. """ # noqa: E501 return self._condition @property - def data(self) -> SearchSearchItemTriggerABusOnewireData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. + def databits(self) -> SearchSearchItemTriggerABusPsifiveDatabits: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs`` command. + + **Description:** + - This command sets or queries the binary register address string used for PSI5 + triggering if the trigger condition is Data in ECU to Sensor communication mode. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs value`` command. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs? + + **Info:** + - ``FOURBIT`` specifies the data bit value as 4 bit. + - ``EIGHTBIT`` specifies the data bit value as 8 bit. + - ``TWENTYBIT`` specifies the data bit value as 20 bit. """ - return self._data + return self._databits @property - def matchrom(self) -> SearchSearchItemTriggerABusOnewireMatchrom: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. + def data(self) -> SearchSearchItemTriggerABusPsifiveData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` - command. - - ``.serialnumber``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. + - ``.ecu``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU`` command tree. + - ``.region``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion`` command tree. """ - return self._matchrom + return self._data @property - def overdrive(self) -> SearchSearchItemTriggerABusOnewireOverdrive: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. + def errortype(self) -> SearchSearchItemTriggerABusPsifiveErrortype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe`` command. + + **Description:** + - This command sets or queries the error type for an PSI5 bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe value`` command. - Sub-properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` - command. - - ``.serialnumber``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe? + + **Info:** + - ``ANY`` specifies the error type value as any. This is the default value. + - ``PARity`` specifies the error type value as parity. + - ``CRC`` specifies the error type value as CRC. + - ``RESPONSECODe`` specifies the error type value as response code. """ - return self._overdrive + return self._errortype @property - def readrom(self) -> SearchSearchItemTriggerABusOnewireReadrom: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. + def functioncodetype(self) -> SearchSearchItemTriggerABusPsifiveFunctioncodetype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe`` command. + + **Description:** + - This command sets or queries the binary data string used for PSI5 triggering if the + trigger condition is a Function Code. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe value`` command. - Sub-properties: - - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` - command. - - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` - command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe? + + **Info:** + - ```` specifies the value of the data string. The valid characters are 0, 1, + and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal + format. """ - return self._readrom + return self._functioncodetype @property - def searchrom(self) -> SearchSearchItemTriggerABusOnewireSearchrom: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. + def registeraddress(self) -> SearchSearchItemTriggerABusPsifiveRegisteraddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess`` command. + + **Description:** + - This command sets or queries the register address for PSI5 bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} + - SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess? + + **Info:** + - ``TWOBIT`` specifies the register address value as 2 bit. This is the default value. + - ``SIXBIT`` specifies the register address value as 6 bit. + - ``EIGHTBIT`` specifies the register address value as 8 bit. + """ + return self._registeraddress + + @property + def register(self) -> SearchSearchItemTriggerABusPsifiveRegister: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister?`` query and raise an AssertionError + if the returned value does not match ``value``. Sub-properties: - - ``.romcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` - command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess`` command + tree. """ - return self._searchrom + return self._register + @property + def sensorstatus(self) -> SearchSearchItemTriggerABusPsifiveSensorstatus: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus`` command tree. -class SearchSearchItemTriggerABusNrzDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus?`` query and raise an + AssertionError if the returned value does not match ``value``. - **Description:** - - This command sets or queries the binary data value to be used when searching on a NRZ - signal. The search condition must be set to DATA. + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe`` command. + """ + return self._sensorstatus - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue value`` command. + @property + def sensor(self) -> SearchSearchItemTriggerABusPsifiveSensor: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor?`` query and raise an AssertionError + if the returned value does not match ``value``. - :: + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess`` command + tree. + """ + return self._sensor - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue? + @property + def status(self) -> SearchSearchItemTriggerABusPsifiveStatus: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus`` command tree. - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus?`` query and raise an AssertionError + if the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue`` command. + """ + return self._status -class SearchSearchItemTriggerABusNrzDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. +class SearchSearchItemTriggerABusParallelDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. **Description:** - - This command specifies the length of the data string, in bytes, to use when searching on - the NRZ signal. The search condition needs to be set to DATa. The search number is - specified by x. + - This command sets or queries the binary data string used for a parallel bus search to + determine where to place a mark. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values are - 1. The maximum value is 5. + - ```` specifies the data value in a valid format. Valid characters are 0-9. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusNrzData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. + +class SearchSearchItemTriggerABusParallelData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusNrzDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusNrzDataValue(device, f"{self._cmd_syntax}:VALue") - - @property - def size(self) -> SearchSearchItemTriggerABusNrzDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string, in bytes, to use when searching - on the NRZ signal. The search condition needs to be set to DATa. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe? - - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values - are 1. The maximum value is 5. - """ - return self._size + self._value = SearchSearchItemTriggerABusParallelDataValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusNrzDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusParallelDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. **Description:** - - This command sets or queries the binary data value to be used when searching on a NRZ - signal. The search condition must be set to DATA. + - This command sets or queries the binary data string used for a parallel bus search to + determine where to place a mark. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data value in a valid format. + - ```` specifies the data value in a valid format. Valid characters are 0-9. """ return self._value -class SearchSearchItemTriggerABusNrz(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ`` command tree. +class SearchSearchItemTriggerABusParallel(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ?`` query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._data = SearchSearchItemTriggerABusNrzData(device, f"{self._cmd_syntax}:DATa") + self._data = SearchSearchItemTriggerABusParallelData(device, f"{self._cmd_syntax}:DATa") @property - def data(self) -> SearchSearchItemTriggerABusNrzData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. + def data(self) -> SearchSearchItemTriggerABusParallelData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel:DATa:VALue`` command. """ return self._data -class SearchSearchItemTriggerABusMil1553bStatusParity(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. +class SearchSearchItemTriggerABusOnewireSearchromRomcode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. **Description:** - - This command sets or queries the value of the status word parity bit for a MIL-STD-1553 - bus to search on. The search number is specified by x. The search condition must be set to - STATus. + - This command sets or queries the ROM code for Search ROM in ONEWIRE bus. MODe should be + set to Standard. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe? **Info:** - - ``ONE`` filters status words to only match those where the parity bit has a value of 1. - - ``ZERo`` filters status words to only match those where the parity bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the parity bit. + - ``Search`` is the number of the search. + - ```` specifies the ROM code for Search ROM. The default size and value of ROM + code for Search ROM is 64 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX'. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bStatusBitTf(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. - **Description:** - - This command sets or queries the value of the terminal flag bit (TF bit, bit 19) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The - search condition must be set to STATus. +class SearchSearchItemTriggerABusOnewireSearchrom(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.romcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._romcode = SearchSearchItemTriggerABusOnewireSearchromRomcode( + device, f"{self._cmd_syntax}:ROMCODe" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF? + @property + def romcode(self) -> SearchSearchItemTriggerABusOnewireSearchromRomcode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` command. - **Info:** - - ``ONE`` filters status words to only match those where the TF bit has a value of 1. - - ``ZERo`` filters status words to only match those where the TF bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the TF bit. - """ + **Description:** + - This command sets or queries the ROM code for Search ROM in ONEWIRE bus. MODe should + be set to Standard. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe value`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe? + + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the ROM code for Search ROM. The default size and value of ROM + code for Search ROM is 64 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX'. + """ + return self._romcode -class SearchSearchItemTriggerABusMil1553bStatusBitSubsf(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. + +class SearchSearchItemTriggerABusOnewireReadromSerialnumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` command. **Description:** - - This command sets or queries the value of the subsystem flag bit (SUBSF bit, bit 17) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x>. The - search condition must be set to STATus. + - This command sets or queries the serial number for Read ROM in ONEWIRE bus. MODe should be + set to Standard. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer? **Info:** - - ``ONE`` filters status words to only match those where the SUBSF bit has a value of 1. - - ``ZERo`` filters status words to only match those where the SUBSF bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the SUBSF bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The default + size and value of serial number for Read ROM is 48 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX'. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bStatusBitSrq(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. + +class SearchSearchItemTriggerABusOnewireReadromFamilycode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` command. **Description:** - - This command sets or queries the value of the status word service request bit (SRQ bit, - bit 11) in a status word for a MIL-STD-1553 bus to search on. The search number is - specified by x. The search condition must be set to STATus. + - This command sets or queries the family code for Read ROM in ONEWIRE bus. MODe should be + set to Standard. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe? **Info:** - - ``ONE`` filters status words to only match those where the SRQ bit has a value of 1. - - ``ZERo`` filters status words to only match those where the SRQ bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the SRQ bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Read ROM is 8 bits and 'XXXXXXXX'. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bStatusBitMe(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. - **Description:** - - This command sets or queries the value of the message error bit (ME bit, bit 9) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The - search condition must be set to STATus. +class SearchSearchItemTriggerABusOnewireReadrom(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` + command. + - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` + command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._familycode = SearchSearchItemTriggerABusOnewireReadromFamilycode( + device, f"{self._cmd_syntax}:FAMILYCODe" + ) + self._serialnumber = SearchSearchItemTriggerABusOnewireReadromSerialnumber( + device, f"{self._cmd_syntax}:SERIALNUMBer" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME? + @property + def familycode(self) -> SearchSearchItemTriggerABusOnewireReadromFamilycode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` command. - **Info:** - - ``ONE`` filters status words to only match those where the ME bit has a value of 1. - - ``ZERo`` filters status words to only match those where the ME bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the ME bit. - """ + **Description:** + - This command sets or queries the family code for Read ROM in ONEWIRE bus. MODe should + be set to Standard. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe value`` command. -class SearchSearchItemTriggerABusMil1553bStatusBitInstr(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe? + + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Read ROM is 8 bits and 'XXXXXXXX'. + """ + return self._familycode + + @property + def serialnumber(self) -> SearchSearchItemTriggerABusOnewireReadromSerialnumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` command. + + **Description:** + - This command sets or queries the serial number for Read ROM in ONEWIRE bus. MODe + should be set to Standard. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer? + + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The + default size and value of serial number for Read ROM is 48 bits and 'XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + """ + return self._serialnumber + + +class SearchSearchItemTriggerABusOnewireOverdriveSerialnumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. **Description:** - - This command sets or queries the value of the instrumentation bit (INSTR bit, bit 10) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The - search condition must be set to STATus. + - This command sets or queries the serial number for Overdrive Match ROM in ONEWIRE bus. + MODe should be set to Overdrive. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer? **Info:** - - ``ONE`` filters status words to only match those where the INSTR bit has a value of 1. - - ``ZERo`` filters status words to only match those where the INSTR bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the INSTR bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The default + size and value of serial number for Overdrive match ROM is 48 bits and 'XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. """ - -class SearchSearchItemTriggerABusMil1553bStatusBitDbca(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. - - **Description:** - - This command sets or queries the value of the dynamic bus control acceptance bit (DBCA - bit, bit 18) in a status word for a MIL-STD-1553 bus to search on. The search number is - specified by x. The search condition must be set to STATus. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA? - - **Info:** - - ``ONE`` filters status words to only match those where the DBCA bit has a value of 1. - - ``ZERo`` filters status words to only match those where the DBCA bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the DBCA bit. - """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bStatusBitBusy(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. +class SearchSearchItemTriggerABusOnewireOverdriveFamilycode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` command. **Description:** - - This command sets or queries the value of the busy bit (BUSY bit, bit 16) in a status word - for a MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to STATus. + - This command sets or queries the Family Code for Overdrive Match ROM in ONEWIRE bus. MODe + should be set to Overdrive. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe? **Info:** - - ``ONE`` filters status words to only match those where the BUSY bit has a value of 1. - - ``ZERo`` filters status words to only match those where the BUSY bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the BUSY bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Overdrive match ROM is 8 bits and 'XXXXXXXX'. """ - -class SearchSearchItemTriggerABusMil1553bStatusBitBcr(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. - - **Description:** - - This command sets or queries the value of the broadcast command received bit (BCR bit, bit - 15) in a status word for a MIL-STD-1553 bus to search on. The search number is specified - by x. The search condition must be set to STATus. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR? - - **Info:** - - ``ONE`` filters status words to only match those where the BCR bit has a value of 1. - - ``ZERo`` filters status words to only match those where the BCR bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the BCR bit. - """ + _WRAP_ARG_WITH_QUOTES = True -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusMil1553bStatusBit(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. +class SearchSearchItemTriggerABusOnewireOverdrive(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.bcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. - - ``.busy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. - - ``.dbca``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. - - ``.instr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. - - ``.me``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. - - ``.srq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. - - ``.subsf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. - - ``.tf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` + command. + - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._bcr = SearchSearchItemTriggerABusMil1553bStatusBitBcr( - device, f"{self._cmd_syntax}:BCR" - ) - self._busy = SearchSearchItemTriggerABusMil1553bStatusBitBusy( - device, f"{self._cmd_syntax}:BUSY" - ) - self._dbca = SearchSearchItemTriggerABusMil1553bStatusBitDbca( - device, f"{self._cmd_syntax}:DBCA" - ) - self._instr = SearchSearchItemTriggerABusMil1553bStatusBitInstr( - device, f"{self._cmd_syntax}:INSTR" - ) - self._me = SearchSearchItemTriggerABusMil1553bStatusBitMe(device, f"{self._cmd_syntax}:ME") - self._srq = SearchSearchItemTriggerABusMil1553bStatusBitSrq( - device, f"{self._cmd_syntax}:SRQ" + self._familycode = SearchSearchItemTriggerABusOnewireOverdriveFamilycode( + device, f"{self._cmd_syntax}:FAMILYCODe" ) - self._subsf = SearchSearchItemTriggerABusMil1553bStatusBitSubsf( - device, f"{self._cmd_syntax}:SUBSF" + self._serialnumber = SearchSearchItemTriggerABusOnewireOverdriveSerialnumber( + device, f"{self._cmd_syntax}:SERIALNUMBer" ) - self._tf = SearchSearchItemTriggerABusMil1553bStatusBitTf(device, f"{self._cmd_syntax}:TF") @property - def bcr(self) -> SearchSearchItemTriggerABusMil1553bStatusBitBcr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. + def familycode(self) -> SearchSearchItemTriggerABusOnewireOverdriveFamilycode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` command. **Description:** - - This command sets or queries the value of the broadcast command received bit (BCR bit, - bit 15) in a status word for a MIL-STD-1553 bus to search on. The search number is - specified by x. The search condition must be set to STATus. + - This command sets or queries the Family Code for Overdrive Match ROM in ONEWIRE bus. + MODe should be set to Overdrive. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe? **Info:** - - ``ONE`` filters status words to only match those where the BCR bit has a value of 1. - - ``ZERo`` filters status words to only match those where the BCR bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the BCR bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Overdrive match ROM is 8 bits and 'XXXXXXXX'. """ - return self._bcr + return self._familycode @property - def busy(self) -> SearchSearchItemTriggerABusMil1553bStatusBitBusy: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. + def serialnumber(self) -> SearchSearchItemTriggerABusOnewireOverdriveSerialnumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. **Description:** - - This command sets or queries the value of the busy bit (BUSY bit, bit 16) in a status - word for a MIL-STD-1553 bus to search on. The search number is specified by x. The - search condition must be set to STATus. + - This command sets or queries the serial number for Overdrive Match ROM in ONEWIRE bus. + MODe should be set to Overdrive. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer? **Info:** - - ``ONE`` filters status words to only match those where the BUSY bit has a value of 1. - - ``ZERo`` filters status words to only match those where the BUSY bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the BUSY bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The + default size and value of serial number for Overdrive match ROM is 48 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. """ - return self._busy - - @property - def dbca(self) -> SearchSearchItemTriggerABusMil1553bStatusBitDbca: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. - - **Description:** - - This command sets or queries the value of the dynamic bus control acceptance bit (DBCA - bit, bit 18) in a status word for a MIL-STD-1553 bus to search on. The search number - is specified by x. The search condition must be set to STATus. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA value`` command. - - **SCPI Syntax:** - - :: + return self._serialnumber - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA? - **Info:** - - ``ONE`` filters status words to only match those where the DBCA bit has a value of 1. - - ``ZERo`` filters status words to only match those where the DBCA bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the DBCA bit. - """ - return self._dbca +class SearchSearchItemTriggerABusOnewireMatchromSerialnumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. - @property - def instr(self) -> SearchSearchItemTriggerABusMil1553bStatusBitInstr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. + **Description:** + - This command sets or queries the serial number for Match ROM in ONEWIRE bus. MODe should + be set to Standard. - **Description:** - - This command sets or queries the value of the instrumentation bit (INSTR bit, bit 10) - in a status word for a MIL-STD-1553 bus to search on. The search number is specified - by x. The search condition must be set to STATus. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer? - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR? + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The default + size and value of serial number for Match ROM is 48 bits and 'XXXXXXXX XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX'. + """ - **Info:** - - ``ONE`` filters status words to only match those where the INSTR bit has a value of 1. - - ``ZERo`` filters status words to only match those where the INSTR bit has a value of - 0. - - ``NOCARE`` disables filtering of status words on the INSTR bit. - """ - return self._instr + _WRAP_ARG_WITH_QUOTES = True - @property - def me(self) -> SearchSearchItemTriggerABusMil1553bStatusBitMe: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. - **Description:** - - This command sets or queries the value of the message error bit (ME bit, bit 9) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x. - The search condition must be set to STATus. +class SearchSearchItemTriggerABusOnewireMatchromFamilycode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME value`` command. + **Description:** + - This command sets or queries the family code for Match ROM in ONEWIRE bus. MODe should be + set to Standard. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME? + :: - **Info:** - - ``ONE`` filters status words to only match those where the ME bit has a value of 1. - - ``ZERo`` filters status words to only match those where the ME bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the ME bit. - """ - return self._me + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe? - @property - def srq(self) -> SearchSearchItemTriggerABusMil1553bStatusBitSrq: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Match ROM is 8 bits and 'XXXXXXXX'. + """ - **Description:** - - This command sets or queries the value of the status word service request bit (SRQ - bit, bit 11) in a status word for a MIL-STD-1553 bus to search on. The search number - is specified by x. The search condition must be set to STATus. + _WRAP_ARG_WITH_QUOTES = True - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ value`` command. - **SCPI Syntax:** +class SearchSearchItemTriggerABusOnewireMatchrom(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query and raise an AssertionError if + the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ? + Properties: + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` + command. + - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` + command. + """ - **Info:** - - ``ONE`` filters status words to only match those where the SRQ bit has a value of 1. - - ``ZERo`` filters status words to only match those where the SRQ bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the SRQ bit. - """ - return self._srq + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._familycode = SearchSearchItemTriggerABusOnewireMatchromFamilycode( + device, f"{self._cmd_syntax}:FAMILYCODe" + ) + self._serialnumber = SearchSearchItemTriggerABusOnewireMatchromSerialnumber( + device, f"{self._cmd_syntax}:SERIALNUMBer" + ) @property - def subsf(self) -> SearchSearchItemTriggerABusMil1553bStatusBitSubsf: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. + def familycode(self) -> SearchSearchItemTriggerABusOnewireMatchromFamilycode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` command. **Description:** - - This command sets or queries the value of the subsystem flag bit (SUBSF bit, bit 17) - in a status word for a MIL-STD-1553 bus to search on. The search number is specified - by x>. The search condition must be set to STATus. + - This command sets or queries the family code for Match ROM in ONEWIRE bus. MODe should + be set to Standard. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe? **Info:** - - ``ONE`` filters status words to only match those where the SUBSF bit has a value of 1. - - ``ZERo`` filters status words to only match those where the SUBSF bit has a value of - 0. - - ``NOCARE`` disables filtering of status words on the SUBSF bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Family Code triggering. The default + size and value of family code for Match ROM is 8 bits and 'XXXXXXXX'. """ - return self._subsf + return self._familycode @property - def tf(self) -> SearchSearchItemTriggerABusMil1553bStatusBitTf: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. + def serialnumber(self) -> SearchSearchItemTriggerABusOnewireMatchromSerialnumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. **Description:** - - This command sets or queries the value of the terminal flag bit (TF bit, bit 19) in a - status word for a MIL-STD-1553 bus to search on. The search number is specified by x. - The search condition must be set to STATus. + - This command sets or queries the serial number for Match ROM in ONEWIRE bus. MODe + should be set to Standard. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer? **Info:** - - ``ONE`` filters status words to only match those where the TF bit has a value of 1. - - ``ZERo`` filters status words to only match those where the TF bit has a value of 0. - - ``NOCARE`` disables filtering of status words on the TF bit. + - ``Search`` is the number of the search. + - ```` specifies the binary string used for Serial Number triggering. The + default size and value of serial number for Match ROM is 48 bits and 'XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. """ - return self._tf + return self._serialnumber -class SearchSearchItemTriggerABusMil1553bStatusAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusOnewireDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. **Description:** - - This command sets or queries the low value when searching on status word addresses for a - MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to - STATus. + - This command specifies the binary data string used for ONEWIRe triggering if the trigger + condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue? **Info:** - - ```` is the address value. + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. The default size and value for + DATA is 8 bits and 'XXXXXXXX'. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bStatusAddressQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. +class SearchSearchItemTriggerABusOnewireDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. **Description:** - - This command sets or queries the qualifier used when searching on status word addresses - for a MIL-STD-1553 bus. The search number is specified by x. The search condition must be - set to STATus. + - This command specifies the length of the data string in bytes to be used for ONEWIRe + triggering if the trigger condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe? **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 - + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values are + 1. The maximum value is 5. + """ -class SearchSearchItemTriggerABusMil1553bStatusAddressHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` command. - **Description:** - - This command sets or queries the high value when searching on status word addresses for a - MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to - STATus and the address qualifier must be INrange or OUTrange. +class SearchSearchItemTriggerABusOnewireData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue value`` command. - - **SCPI Syntax:** - - :: + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue? - - **Info:** - - ```` is the address value. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusMil1553bStatusAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` - command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. - """ + Properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. + """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusMil1553bStatusAddressHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._qualifier = SearchSearchItemTriggerABusMil1553bStatusAddressQualifier( - device, f"{self._cmd_syntax}:QUALifier" - ) - self._value = SearchSearchItemTriggerABusMil1553bStatusAddressValue( + self._size = SearchSearchItemTriggerABusOnewireDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusOnewireDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def hivalue(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` command. + def size(self) -> SearchSearchItemTriggerABusOnewireDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. **Description:** - - This command sets or queries the high value when searching on status word addresses - for a MIL-STD-1553 bus. The search number is specified by x. The search condition must - be set to STATus and the address qualifier must be INrange or OUTrange. + - This command specifies the length of the data string in bytes to be used for ONEWIRe + triggering if the trigger condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe? **Info:** - - ```` is the address value. + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values + are 1. The maximum value is 5. """ - return self._hivalue + return self._size @property - def qualifier(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. + def value(self) -> SearchSearchItemTriggerABusOnewireDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. **Description:** - - This command sets or queries the qualifier used when searching on status word - addresses for a MIL-STD-1553 bus. The search number is specified by x. The search - condition must be set to STATus. + - This command specifies the binary data string used for ONEWIRe triggering if the + trigger condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue? **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 - return self._qualifier + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. The default size and value + for DATA is 8 bits and 'XXXXXXXX'. + """ + return self._value + + +class SearchSearchItemTriggerABusOnewireCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for a ONEWIRe bus. MODe should be set + to Overdrive for OVERDRIVEMATCh and OVERDRIVESKIP. MODe should be set to Standard for + READROM, MATCHROM, SKIPROM, SEARCHROM, ALARMSEARch. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition {RESet| PREsence| COMMand| DATa| READROM| MATCHROM| OVERDRIVEMATCh| SKIPROM| OVERDRIVESKIP| SEARCHROM| ALARMSEARch| CRCERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition? + + **Info:** + - ``Search`` is the number of the search. + - ``RESet`` specifies the search condition as RESet. Reset is the default trigger on + condition. + - ``PREsence`` specifies the search condition as PREsence. + - ``COMMand`` specifies the search condition as COMMand. + - ``DATa`` specifies the search condition as DATa. + - ``READROM`` specifies the search condition as READROM. + - ``MATCHROM`` specifies the search condition as MATCHROM. + - ``SKIPROM`` specifies the search condition as SKIPROM. + - ``SEARCHROM`` specifies the search condition as SEARCHROM. + - ``ALARMSEARch`` specifies the search condition as ALARMSEARch. + - ``CRCERRor`` specifies the search condition as CRCERRor. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusOnewireCommandValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. + + **Description:** + - This command specifies the binary data string used for ONEWIRe triggering if the trigger + condition is COMMAND. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue? + + **Info:** + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. The default size and value for + COMMAND is 8 bits and 'XXXXXXXX'. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusOnewireCommand(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusOnewireCommandValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusOnewireCommandValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. **Description:** - - This command sets or queries the low value when searching on status word addresses for - a MIL-STD-1553 bus. The search number is specified by x. The search condition must be - set to STATus. + - This command specifies the binary data string used for ONEWIRe triggering if the + trigger condition is COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue? **Info:** - - ```` is the address value. + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. The default size and value + for COMMAND is 8 bits and 'XXXXXXXX'. """ return self._value -class SearchSearchItemTriggerABusMil1553bStatus(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. +class SearchSearchItemTriggerABusOnewire(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. - - ``.bit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. + - ``.matchrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. + - ``.overdrive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. + - ``.readrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. + - ``.searchrom``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusMil1553bStatusAddress( - device, f"{self._cmd_syntax}:ADDRess" + self._command = SearchSearchItemTriggerABusOnewireCommand( + device, f"{self._cmd_syntax}:COMMand" ) - self._bit = SearchSearchItemTriggerABusMil1553bStatusBit(device, f"{self._cmd_syntax}:BIT") - self._parity = SearchSearchItemTriggerABusMil1553bStatusParity( - device, f"{self._cmd_syntax}:PARity" + self._condition = SearchSearchItemTriggerABusOnewireCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusOnewireData(device, f"{self._cmd_syntax}:DATa") + self._matchrom = SearchSearchItemTriggerABusOnewireMatchrom( + device, f"{self._cmd_syntax}:MATCHROM" + ) + self._overdrive = SearchSearchItemTriggerABusOnewireOverdrive( + device, f"{self._cmd_syntax}:OVERDRIVe" + ) + self._readrom = SearchSearchItemTriggerABusOnewireReadrom( + device, f"{self._cmd_syntax}:READROM" + ) + self._searchrom = SearchSearchItemTriggerABusOnewireSearchrom( + device, f"{self._cmd_syntax}:SEARCHROM" ) @property - def address(self) -> SearchSearchItemTriggerABusMil1553bStatusAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. + def command(self) -> SearchSearchItemTriggerABusOnewireCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand?`` query and raise an AssertionError + if the returned value does not match ``value``. Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` - command. - - ``.qualifier``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue`` command. """ - return self._address + return self._command @property - def bit(self) -> SearchSearchItemTriggerABusMil1553bStatusBit: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. + def condition(self) -> SearchSearchItemTriggerABusOnewireCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for a ONEWIRe bus. MODe should be + set to Overdrive for OVERDRIVEMATCh and OVERDRIVESKIP. MODe should be set to Standard + for READROM, MATCHROM, SKIPROM, SEARCHROM, ALARMSEARch. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition value`` command. - Sub-properties: - - ``.bcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. - - ``.busy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. - - ``.dbca``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. - - ``.instr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. - - ``.me``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. - - ``.srq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. - - ``.subsf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. - - ``.tf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. - """ - return self._bit + **SCPI Syntax:** - @property - def parity(self) -> SearchSearchItemTriggerABusMil1553bStatusParity: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. + :: - **Description:** - - This command sets or queries the value of the status word parity bit for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to STATus. + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition {RESet| PREsence| COMMand| DATa| READROM| MATCHROM| OVERDRIVEMATCh| SKIPROM| OVERDRIVESKIP| SEARCHROM| ALARMSEARch| CRCERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:CONDition? + + **Info:** + - ``Search`` is the number of the search. + - ``RESet`` specifies the search condition as RESet. Reset is the default trigger on + condition. + - ``PREsence`` specifies the search condition as PREsence. + - ``COMMand`` specifies the search condition as COMMand. + - ``DATa`` specifies the search condition as DATa. + - ``READROM`` specifies the search condition as READROM. + - ``MATCHROM`` specifies the search condition as MATCHROM. + - ``SKIPROM`` specifies the search condition as SKIPROM. + - ``SEARCHROM`` specifies the search condition as SEARCHROM. + - ``ALARMSEARch`` specifies the search condition as ALARMSEARch. + - ``CRCERRor`` specifies the search condition as CRCERRor. + """ # noqa: E501 + return self._condition + + @property + def data(self) -> SearchSearchItemTriggerABusOnewireData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:DATa:VALue`` command. + """ + return self._data - :: + @property + def matchrom(self) -> SearchSearchItemTriggerABusOnewireMatchrom: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Info:** - - ``ONE`` filters status words to only match those where the parity bit has a value of - 1. - - ``ZERo`` filters status words to only match those where the parity bit has a value of - 0. - - ``NOCARE`` disables filtering of status words on the parity bit. + Sub-properties: + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:FAMILYCODe`` + command. + - ``.serialnumber``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:MATCHROM:SERIALNUMBer`` command. """ - return self._parity + return self._matchrom + @property + def overdrive(self) -> SearchSearchItemTriggerABusOnewireOverdrive: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe`` command tree. -class SearchSearchItemTriggerABusMil1553bErrtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe?`` query and raise an + AssertionError if the returned value does not match ``value``. - **Description:** - - This command sets or queries the type of error condition for a MIL-STD-1553 bus to search - on. The search number is specified by x. The search condition must be set to ERRor. + Sub-properties: + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:FAMILYCODe`` + command. + - ``.serialnumber``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:OVERDRIVe:SERIALNUMBer`` command. + """ + return self._overdrive - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe value`` command. + @property + def readrom(self) -> SearchSearchItemTriggerABusOnewireReadrom: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM?`` query and raise an AssertionError + if the returned value does not match ``value``. - :: + Sub-properties: + - ``.familycode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:FAMILYCODe`` + command. + - ``.serialnumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:READROM:SERIALNUMBer`` + command. + """ + return self._readrom - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe {PARity|SYNC|DATA} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe? + @property + def searchrom(self) -> SearchSearchItemTriggerABusOnewireSearchrom: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM`` command tree. - **Info:** - - ``PARity`` specifies searching for an incorrectly calculated parity bit in any word. - - ``SYNC`` specifies searching for any sync pulse that does not transition in the middle of - the pulse as required. - - ``DATA`` specifies searching for any non-contiguous data words. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM?`` query and raise an + AssertionError if the returned value does not match ``value``. + Sub-properties: + - ``.romcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:SEARCHROM:ROMCODe`` + command. + """ + return self._searchrom -class SearchSearchItemTriggerABusMil1553bDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + +class SearchSearchItemTriggerABusNrzDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. **Description:** - - This command sets or queries the value when searching on data words for a MIL-STD-1553 - bus. The search number is specified by x. The search condition must be set to DATA. + - This command sets or queries the binary data value to be used when searching on a NRZ + signal. The search condition must be set to DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue? **Info:** - - ```` is the data value. + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMil1553bDataParity(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. +class SearchSearchItemTriggerABusNrzDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. **Description:** - - This command sets or queries the value of the command word parity bit for a MIL-STD-1553 - bus to search on. The search number is specified by x. The search condition must be set to - DATA. + - This command specifies the length of the data string, in bytes, to use when searching on + the NRZ signal. The search condition needs to be set to DATa. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe? **Info:** - - ``ONE`` filters data words to only match those where the parity bit has a value of 1. - - ``ZERo`` filters data words to only match those where the parity bit has a value of 0. - - ``NOCARE`` disables filtering of data words on the parity bit. + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values are + 1. The maximum value is 5. """ -class SearchSearchItemTriggerABusMil1553bData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. +class SearchSearchItemTriggerABusNrzData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._parity = SearchSearchItemTriggerABusMil1553bDataParity( - device, f"{self._cmd_syntax}:PARity" - ) - self._value = SearchSearchItemTriggerABusMil1553bDataValue( - device, f"{self._cmd_syntax}:VALue" - ) - + self._size = SearchSearchItemTriggerABusNrzDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusNrzDataValue(device, f"{self._cmd_syntax}:VALue") + @property - def parity(self) -> SearchSearchItemTriggerABusMil1553bDataParity: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. + def size(self) -> SearchSearchItemTriggerABusNrzDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. **Description:** - - This command sets or queries the value of the command word parity bit for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to DATA. + - This command specifies the length of the data string, in bytes, to use when searching + on the NRZ signal. The search condition needs to be set to DATa. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe? **Info:** - - ``ONE`` filters data words to only match those where the parity bit has a value of 1. - - ``ZERo`` filters data words to only match those where the parity bit has a value of 0. - - ``NOCARE`` disables filtering of data words on the parity bit. + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values + are 1. The maximum value is 5. """ - return self._parity + return self._size @property - def value(self) -> SearchSearchItemTriggerABusMil1553bDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusNrzDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. **Description:** - - This command sets or queries the value when searching on data words for a MIL-STD-1553 - bus. The search number is specified by x. The search condition must be set to DATA. + - This command sets or queries the binary data value to be used when searching on a NRZ + signal. The search condition must be set to DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue? **Info:** - - ```` is the data value. + - ``Search`` is the number of the search. + - ```` specifies the data value in a valid format. """ return self._value -class SearchSearchItemTriggerABusMil1553bCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. +class SearchSearchItemTriggerABusNrzCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition`` command. **Description:** - - This command sets or queries the field or condition for a MIL-STD-1553 bus to search on. - The search number is specified by x. + - This command specifies a field or condition for an NRZ bus to search on. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition {SYNC|COMMAND|STATus|DATA|ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition {DATa} + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition? **Info:** - - ``SYNC`` specifies a search for the sync pulse of any word. - - ``COMMAND`` specifies a search for a matching command word. - - ``STATus`` specifies a search for a matching status word. - - ``DATA`` specifies a search for a matching data word. - - ``ERRor`` specifies a search for a specified error condition. + - ``Search`` is the number of the search. + - ``DATa`` specifies the search condition as Data Characters. """ -class SearchSearchItemTriggerABusMil1553bCommandTrbit(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. +class SearchSearchItemTriggerABusNrz(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ?`` + query and raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._condition = SearchSearchItemTriggerABusNrzCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusNrzData(device, f"{self._cmd_syntax}:DATa") + + @property + def condition(self) -> SearchSearchItemTriggerABusNrzCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition`` command. + + **Description:** + - This command specifies a field or condition for an NRZ bus to search on. The search + number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition {DATa} + - SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition? + + **Info:** + - ``Search`` is the number of the search. + - ``DATa`` specifies the search condition as Data Characters. + """ + return self._condition + + @property + def data(self) -> SearchSearchItemTriggerABusNrzData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue`` command. + """ + return self._data + + +class SearchSearchItemTriggerABusMil1553bStatusParity(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. **Description:** - - This command sets or queries the value of the command word Transmit / Receive bit for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search condition - must be set to COMMAND. + - This command sets or queries the value of the status word parity bit for a MIL-STD-1553 + bus to search on. The search number is specified by x. The search condition must be set to + STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit {RX|TX|X} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity? **Info:** - - ``RX`` filters command words to only match those that are receive packets. - - ``TX`` filters command words to only match those that are transmit packets. - - ``X`` disables filtering of command words on the R/T bit. + - ``ONE`` filters status words to only match those where the parity bit has a value of 1. + - ``ZERo`` filters status words to only match those where the parity bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the parity bit. """ -class SearchSearchItemTriggerABusMil1553bCommandSubaddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` command. +class SearchSearchItemTriggerABusMil1553bStatusBitTf(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. **Description:** - - This command sets or queries the value of the command word subaddress field for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search condition - must be set to COMMAND. + - This command sets or queries the value of the terminal flag bit (TF bit, bit 19) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The + search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF? **Info:** - - ```` is the word count value. + - ``ONE`` filters status words to only match those where the TF bit has a value of 1. + - ``ZERo`` filters status words to only match those where the TF bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the TF bit. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusMil1553bCommandParity(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. +class SearchSearchItemTriggerABusMil1553bStatusBitSubsf(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. **Description:** - - This command sets or queries the value of the command word parity bit for a MIL-STD-1553 - bus to search on. The search number is specified by x. The search condition must be set to - COMMAND. + - This command sets or queries the value of the subsystem flag bit (SUBSF bit, bit 17) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x>. The + search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF? **Info:** - - ``ONE`` filters command words to only match those where the parity bit has a value of 1. - - ``ZERo`` filters command words to only match those where the parity bit has a value of 0. - - ``NOCARE`` disables filtering of command words on the parity bit. + - ``ONE`` filters status words to only match those where the SUBSF bit has a value of 1. + - ``ZERo`` filters status words to only match those where the SUBSF bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the SUBSF bit. """ -class SearchSearchItemTriggerABusMil1553bCommandCount(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. +class SearchSearchItemTriggerABusMil1553bStatusBitSrq(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. **Description:** - - This command sets or queries the value of the command word 'word count' field for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search condition - must be set to COMMAND. + - This command sets or queries the value of the status word service request bit (SRQ bit, + bit 11) in a status word for a MIL-STD-1553 bus to search on. The search number is + specified by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ? **Info:** - - ```` is the word count value. + - ``ONE`` filters status words to only match those where the SRQ bit has a value of 1. + - ``ZERo`` filters status words to only match those where the SRQ bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the SRQ bit. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusMil1553bCommandAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusMil1553bStatusBitMe(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. **Description:** - - This command sets or queries the low value when searching on command word addresses for a - MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to - COMMAND. + - This command sets or queries the value of the message error bit (ME bit, bit 9) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The + search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME? **Info:** - - ```` is the address value. + - ``ONE`` filters status words to only match those where the ME bit has a value of 1. + - ``ZERo`` filters status words to only match those where the ME bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the ME bit. """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusMil1553bStatusBitInstr(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. -class SearchSearchItemTriggerABusMil1553bCommandAddressQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. + **Description:** + - This command sets or queries the value of the instrumentation bit (INSTR bit, bit 10) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x. The + search condition must be set to STATus. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR? + + **Info:** + - ``ONE`` filters status words to only match those where the INSTR bit has a value of 1. + - ``ZERo`` filters status words to only match those where the INSTR bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the INSTR bit. + """ + + +class SearchSearchItemTriggerABusMil1553bStatusBitDbca(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. **Description:** - - This command sets or queries the qualifier to be used when searching on command word - addresses for a MIL-STD-1553 bus. The search number is specified by x. The search - condition must be set to COMMAND. + - This command sets or queries the value of the dynamic bus control acceptance bit (DBCA + bit, bit 18) in a status word for a MIL-STD-1553 bus to search on. The search number is + specified by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier {EQual|UNEQual|LESSthan |MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA? **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 + - ``ONE`` filters status words to only match those where the DBCA bit has a value of 1. + - ``ZERo`` filters status words to only match those where the DBCA bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the DBCA bit. + """ -class SearchSearchItemTriggerABusMil1553bCommandAddressHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` command. +class SearchSearchItemTriggerABusMil1553bStatusBitBusy(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. **Description:** - - This command sets or queries the high value when searching on command word addresses for a - MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to - COMMAND, and the address qualifier must be INrange or OUTrange. + - This command sets or queries the value of the busy bit (BUSY bit, bit 16) in a status word + for a MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY? **Info:** - - ```` is the address value. + - ``ONE`` filters status words to only match those where the BUSY bit has a value of 1. + - ``ZERo`` filters status words to only match those where the BUSY bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the BUSY bit. """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusMil1553bStatusBitBcr(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. -class SearchSearchItemTriggerABusMil1553bCommandAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command tree. + **Description:** + - This command sets or queries the value of the broadcast command received bit (BCR bit, bit + 15) in a status word for a MIL-STD-1553 bus to search on. The search number is specified + by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR? + + **Info:** + - ``ONE`` filters status words to only match those where the BCR bit has a value of 1. + - ``ZERo`` filters status words to only match those where the BCR bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the BCR bit. + """ + + +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusMil1553bStatusBit(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` - command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. + - ``.bcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. + - ``.busy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. + - ``.dbca``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. + - ``.instr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. + - ``.me``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. + - ``.srq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. + - ``.subsf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. + - ``.tf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusMil1553bCommandAddressHivalue( - device, f"{self._cmd_syntax}:HIVALue" + self._bcr = SearchSearchItemTriggerABusMil1553bStatusBitBcr( + device, f"{self._cmd_syntax}:BCR" ) - self._qualifier = SearchSearchItemTriggerABusMil1553bCommandAddressQualifier( - device, f"{self._cmd_syntax}:QUALifier" + self._busy = SearchSearchItemTriggerABusMil1553bStatusBitBusy( + device, f"{self._cmd_syntax}:BUSY" ) - self._value = SearchSearchItemTriggerABusMil1553bCommandAddressValue( - device, f"{self._cmd_syntax}:VALue" + self._dbca = SearchSearchItemTriggerABusMil1553bStatusBitDbca( + device, f"{self._cmd_syntax}:DBCA" ) + self._instr = SearchSearchItemTriggerABusMil1553bStatusBitInstr( + device, f"{self._cmd_syntax}:INSTR" + ) + self._me = SearchSearchItemTriggerABusMil1553bStatusBitMe(device, f"{self._cmd_syntax}:ME") + self._srq = SearchSearchItemTriggerABusMil1553bStatusBitSrq( + device, f"{self._cmd_syntax}:SRQ" + ) + self._subsf = SearchSearchItemTriggerABusMil1553bStatusBitSubsf( + device, f"{self._cmd_syntax}:SUBSF" + ) + self._tf = SearchSearchItemTriggerABusMil1553bStatusBitTf(device, f"{self._cmd_syntax}:TF") @property - def hivalue(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` command. + def bcr(self) -> SearchSearchItemTriggerABusMil1553bStatusBitBcr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. **Description:** - - This command sets or queries the high value when searching on command word addresses - for a MIL-STD-1553 bus. The search number is specified by x. The search condition must - be set to COMMAND, and the address qualifier must be INrange or OUTrange. + - This command sets or queries the value of the broadcast command received bit (BCR bit, + bit 15) in a status word for a MIL-STD-1553 bus to search on. The search number is + specified by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR? **Info:** - - ```` is the address value. + - ``ONE`` filters status words to only match those where the BCR bit has a value of 1. + - ``ZERo`` filters status words to only match those where the BCR bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the BCR bit. """ - return self._hivalue + return self._bcr @property - def qualifier(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. + def busy(self) -> SearchSearchItemTriggerABusMil1553bStatusBitBusy: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. **Description:** - - This command sets or queries the qualifier to be used when searching on command word - addresses for a MIL-STD-1553 bus. The search number is specified by x. The search - condition must be set to COMMAND. + - This command sets or queries the value of the busy bit (BUSY bit, bit 16) in a status + word for a MIL-STD-1553 bus to search on. The search number is specified by x. The + search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier {EQual|UNEQual|LESSthan |MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY? **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 - return self._qualifier + - ``ONE`` filters status words to only match those where the BUSY bit has a value of 1. + - ``ZERo`` filters status words to only match those where the BUSY bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the BUSY bit. + """ + return self._busy @property - def value(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. + def dbca(self) -> SearchSearchItemTriggerABusMil1553bStatusBitDbca: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. **Description:** - - This command sets or queries the low value when searching on command word addresses - for a MIL-STD-1553 bus. The search number is specified by x. The search condition must - be set to COMMAND. + - This command sets or queries the value of the dynamic bus control acceptance bit (DBCA + bit, bit 18) in a status word for a MIL-STD-1553 bus to search on. The search number + is specified by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA? **Info:** - - ```` is the address value. - """ - return self._value - - -class SearchSearchItemTriggerABusMil1553bCommand(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command - tree. - - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. - - ``.subaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` - command. - - ``.trbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusMil1553bCommandAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) - self._count = SearchSearchItemTriggerABusMil1553bCommandCount( - device, f"{self._cmd_syntax}:COUNt" - ) - self._parity = SearchSearchItemTriggerABusMil1553bCommandParity( - device, f"{self._cmd_syntax}:PARity" - ) - self._subaddress = SearchSearchItemTriggerABusMil1553bCommandSubaddress( - device, f"{self._cmd_syntax}:SUBADdress" - ) - self._trbit = SearchSearchItemTriggerABusMil1553bCommandTrbit( - device, f"{self._cmd_syntax}:TRBit" - ) - - @property - def address(self) -> SearchSearchItemTriggerABusMil1553bCommandAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` - command. - - ``.qualifier``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` - command. - """ - return self._address - - @property - def count(self) -> SearchSearchItemTriggerABusMil1553bCommandCount: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. - - **Description:** - - This command sets or queries the value of the command word 'word count' field for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to COMMAND. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt? - - **Info:** - - ```` is the word count value. + - ``ONE`` filters status words to only match those where the DBCA bit has a value of 1. + - ``ZERo`` filters status words to only match those where the DBCA bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the DBCA bit. """ - return self._count + return self._dbca @property - def parity(self) -> SearchSearchItemTriggerABusMil1553bCommandParity: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. + def instr(self) -> SearchSearchItemTriggerABusMil1553bStatusBitInstr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. **Description:** - - This command sets or queries the value of the command word parity bit for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to COMMAND. + - This command sets or queries the value of the instrumentation bit (INSTR bit, bit 10) + in a status word for a MIL-STD-1553 bus to search on. The search number is specified + by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR? **Info:** - - ``ONE`` filters command words to only match those where the parity bit has a value of - 1. - - ``ZERo`` filters command words to only match those where the parity bit has a value of + - ``ONE`` filters status words to only match those where the INSTR bit has a value of 1. + - ``ZERo`` filters status words to only match those where the INSTR bit has a value of 0. - - ``NOCARE`` disables filtering of command words on the parity bit. + - ``NOCARE`` disables filtering of status words on the INSTR bit. """ - return self._parity + return self._instr @property - def subaddress(self) -> SearchSearchItemTriggerABusMil1553bCommandSubaddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` command. + def me(self) -> SearchSearchItemTriggerABusMil1553bStatusBitMe: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. **Description:** - - This command sets or queries the value of the command word subaddress field for a - MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to COMMAND. + - This command sets or queries the value of the message error bit (ME bit, bit 9) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x. + The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME? **Info:** - - ```` is the word count value. + - ``ONE`` filters status words to only match those where the ME bit has a value of 1. + - ``ZERo`` filters status words to only match those where the ME bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the ME bit. """ - return self._subaddress + return self._me @property - def trbit(self) -> SearchSearchItemTriggerABusMil1553bCommandTrbit: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. + def srq(self) -> SearchSearchItemTriggerABusMil1553bStatusBitSrq: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. **Description:** - - This command sets or queries the value of the command word Transmit / Receive bit for - a MIL-STD-1553 bus to search on. The search number is specified by x. The search - condition must be set to COMMAND. + - This command sets or queries the value of the status word service request bit (SRQ + bit, bit 11) in a status word for a MIL-STD-1553 bus to search on. The search number + is specified by x. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit {RX|TX|X} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ? **Info:** - - ``RX`` filters command words to only match those that are receive packets. - - ``TX`` filters command words to only match those that are transmit packets. - - ``X`` disables filtering of command words on the R/T bit. - """ - return self._trbit - - -class SearchSearchItemTriggerABusMil1553b(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. - - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._command = SearchSearchItemTriggerABusMil1553bCommand( - device, f"{self._cmd_syntax}:COMMAND" - ) - self._condition = SearchSearchItemTriggerABusMil1553bCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusMil1553bData(device, f"{self._cmd_syntax}:DATa") - self._errtype = SearchSearchItemTriggerABusMil1553bErrtype( - device, f"{self._cmd_syntax}:ERRTYPe" - ) - self._status = SearchSearchItemTriggerABusMil1553bStatus( - device, f"{self._cmd_syntax}:STATus" - ) - - @property - def command(self) -> SearchSearchItemTriggerABusMil1553bCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command - tree. - - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. - - ``.subaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` - command. - - ``.trbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. + - ``ONE`` filters status words to only match those where the SRQ bit has a value of 1. + - ``ZERo`` filters status words to only match those where the SRQ bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the SRQ bit. """ - return self._command + return self._srq @property - def condition(self) -> SearchSearchItemTriggerABusMil1553bCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. + def subsf(self) -> SearchSearchItemTriggerABusMil1553bStatusBitSubsf: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. **Description:** - - This command sets or queries the field or condition for a MIL-STD-1553 bus to search - on. The search number is specified by x. + - This command sets or queries the value of the subsystem flag bit (SUBSF bit, bit 17) + in a status word for a MIL-STD-1553 bus to search on. The search number is specified + by x>. The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition {SYNC|COMMAND|STATus|DATA|ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF? **Info:** - - ``SYNC`` specifies a search for the sync pulse of any word. - - ``COMMAND`` specifies a search for a matching command word. - - ``STATus`` specifies a search for a matching status word. - - ``DATA`` specifies a search for a matching data word. - - ``ERRor`` specifies a search for a specified error condition. - """ - return self._condition - - @property - def data(self) -> SearchSearchItemTriggerABusMil1553bData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + - ``ONE`` filters status words to only match those where the SUBSF bit has a value of 1. + - ``ZERo`` filters status words to only match those where the SUBSF bit has a value of + 0. + - ``NOCARE`` disables filtering of status words on the SUBSF bit. """ - return self._data + return self._subsf @property - def errtype(self) -> SearchSearchItemTriggerABusMil1553bErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. + def tf(self) -> SearchSearchItemTriggerABusMil1553bStatusBitTf: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. **Description:** - - This command sets or queries the type of error condition for a MIL-STD-1553 bus to - search on. The search number is specified by x. The search condition must be set to - ERRor. + - This command sets or queries the value of the terminal flag bit (TF bit, bit 19) in a + status word for a MIL-STD-1553 bus to search on. The search number is specified by x. + The search condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe {PARity|SYNC|DATA} - - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF? **Info:** - - ``PARity`` specifies searching for an incorrectly calculated parity bit in any word. - - ``SYNC`` specifies searching for any sync pulse that does not transition in the middle - of the pulse as required. - - ``DATA`` specifies searching for any non-contiguous data words. - """ - return self._errtype - - @property - def status(self) -> SearchSearchItemTriggerABusMil1553bStatus: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command - tree. - - ``.bit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. - - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. + - ``ONE`` filters status words to only match those where the TF bit has a value of 1. + - ``ZERo`` filters status words to only match those where the TF bit has a value of 0. + - ``NOCARE`` disables filtering of status words on the TF bit. """ - return self._status + return self._tf -class SearchSearchItemTriggerABusMdioRegisteraddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. +class SearchSearchItemTriggerABusMil1553bStatusAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. **Description:** - - This command specifies the binary register address string used for MDIO triggering if the - trigger condition is register address. The search number is specified by x. + - This command sets or queries the low value when searching on status word addresses for a + MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to + STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue? **Info:** - - ```` is the register address value. Default register address value is XXXXX. + - ```` is the address value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMdioRegisteraddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command tree. +class SearchSearchItemTriggerABusMil1553bStatusAddressQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. + + **Description:** + - This command sets or queries the qualifier used when searching on status word addresses + for a MIL-STD-1553 bus. The search number is specified by x. The search condition must be + set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioRegisteraddressValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusMdioRegisteraddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. - - **Description:** - - This command specifies the binary register address string used for MDIO triggering if - the trigger condition is register address. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier? - **Info:** - - ```` is the register address value. Default register address value is XXXXX. - """ - return self._value + **Info:** + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. + """ # noqa: E501 -class SearchSearchItemTriggerABusMdioPhysicaladdressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. +class SearchSearchItemTriggerABusMil1553bStatusAddressHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` command. **Description:** - - This command specifies the binary physical address string used for MDIO triggering if the - trigger condition is physical address. The search number is specified by x. + - This command sets or queries the high value when searching on status word addresses for a + MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to + STATus and the address qualifier must be INrange or OUTrange. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue? **Info:** - - ```` is the physical address value. Default physical address value is XXXXX. + - ```` is the address value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMdioPhysicaladdress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command tree. +class SearchSearchItemTriggerABusMil1553bStatusAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` + command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioPhysicaladdressValue( + self._hivalue = SearchSearchItemTriggerABusMil1553bStatusAddressHivalue( + device, f"{self._cmd_syntax}:HIVALue" + ) + self._qualifier = SearchSearchItemTriggerABusMil1553bStatusAddressQualifier( + device, f"{self._cmd_syntax}:QUALifier" + ) + self._value = SearchSearchItemTriggerABusMil1553bStatusAddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusMdioPhysicaladdressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. + def hivalue(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` command. **Description:** - - This command specifies the binary physical address string used for MDIO triggering if - the trigger condition is physical address. The search number is specified by x. + - This command sets or queries the high value when searching on status word addresses + for a MIL-STD-1553 bus. The search number is specified by x. The search condition must + be set to STATus and the address qualifier must be INrange or OUTrange. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue? **Info:** - - ```` is the physical address value. Default physical address value is XXXXX. + - ```` is the address value. """ - return self._value + return self._hivalue + @property + def qualifier(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. -class SearchSearchItemTriggerABusMdioOpcodeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. + **Description:** + - This command sets or queries the qualifier used when searching on status word + addresses for a MIL-STD-1553 bus. The search number is specified by x. The search + condition must be set to STATus. - **Description:** - - This command specifies the binary op-code string used for MDIO triggering if the trigger - condition is op-code. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier?`` query and raise + an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier? - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue? + **Info:** + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. + """ # noqa: E501 + return self._qualifier - **Info:** - - ```` is the op-code value. Default op-code value is XX. - """ + @property + def value(self) -> SearchSearchItemTriggerABusMil1553bStatusAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` command. - _WRAP_ARG_WITH_QUOTES = True + **Description:** + - This command sets or queries the low value when searching on status word addresses for + a MIL-STD-1553 bus. The search number is specified by x. The search condition must be + set to STATus. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue value`` command. + + **SCPI Syntax:** + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue? + + **Info:** + - ```` is the address value. + """ + return self._value -class SearchSearchItemTriggerABusMdioOpcode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. + +class SearchSearchItemTriggerABusMil1553bStatus(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. + - ``.bit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioOpcodeValue( - device, f"{self._cmd_syntax}:VALue" + self._address = SearchSearchItemTriggerABusMil1553bStatusAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + self._bit = SearchSearchItemTriggerABusMil1553bStatusBit(device, f"{self._cmd_syntax}:BIT") + self._parity = SearchSearchItemTriggerABusMil1553bStatusParity( + device, f"{self._cmd_syntax}:PARity" ) @property - def value(self) -> SearchSearchItemTriggerABusMdioOpcodeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. + def address(self) -> SearchSearchItemTriggerABusMil1553bStatusAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:HIVALue`` + command. + - ``.qualifier``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:QUALifier`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess:VALue`` + command. + """ + return self._address + + @property + def bit(self) -> SearchSearchItemTriggerABusMil1553bStatusBit: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.bcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BCR`` command. + - ``.busy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:BUSY`` command. + - ``.dbca``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:DBCA`` command. + - ``.instr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:INSTR`` command. + - ``.me``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:ME`` command. + - ``.srq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SRQ`` command. + - ``.subsf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:SUBSF`` command. + - ``.tf``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT:TF`` command. + """ + return self._bit + + @property + def parity(self) -> SearchSearchItemTriggerABusMil1553bStatusParity: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. **Description:** - - This command specifies the binary op-code string used for MDIO triggering if the - trigger condition is op-code. The search number is specified by x. + - This command sets or queries the value of the status word parity bit for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to STATus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity? **Info:** - - ```` is the op-code value. Default op-code value is XX. + - ``ONE`` filters status words to only match those where the parity bit has a value of + 1. + - ``ZERo`` filters status words to only match those where the parity bit has a value of + 0. + - ``NOCARE`` disables filtering of status words on the parity bit. """ - return self._value + return self._parity -class SearchSearchItemTriggerABusMdioErrtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. +class SearchSearchItemTriggerABusMil1553bErrtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. **Description:** - - This command sets or queries the error type to be used when triggering on MDIO data. This - applies when the MDIO bus trigger condition is set to ERRor. The search number is - specified by x. + - This command sets or queries the type of error condition for a MIL-STD-1553 bus to search + on. The search number is specified by x. The search condition must be set to ERRor. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType {OPCODEERRor| DEVERRor| ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe {PARity|SYNC|DATA} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe? **Info:** - - ``OPCODEERRor`` specifies OPCODEERRor as the field within a MDIO frame to search on. This - is the default trigger on condition. - - ``DEVERRor`` specifies DEVERRor as the field within a MDIO frame to search on. - - ``ANY`` specifies ANY as the field within a MDIO frame to search on. + - ``PARity`` specifies searching for an incorrectly calculated parity bit in any word. + - ``SYNC`` specifies searching for any sync pulse that does not transition in the middle of + the pulse as required. + - ``DATA`` specifies searching for any non-contiguous data words. """ -class SearchSearchItemTriggerABusMdioDevicetypeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. +class SearchSearchItemTriggerABusMil1553bDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. **Description:** - - This command specifies the binary device type string used for MDIO triggering if the - trigger condition is Device type. The search number is specified by x. + - This command sets or queries the value when searching on data words for a MIL-STD-1553 + bus. The search number is specified by x. The search condition must be set to DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue? **Info:** - - ```` is the device type. Default value is XXXXX. + - ```` is the data value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMdioDevicetype(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. +class SearchSearchItemTriggerABusMil1553bDataParity(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. + + **Description:** + - This command sets or queries the value of the command word parity bit for a MIL-STD-1553 + bus to search on. The search number is specified by x. The search condition must be set to + DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity? + + **Info:** + - ``ONE`` filters data words to only match those where the parity bit has a value of 1. + - ``ZERo`` filters data words to only match those where the parity bit has a value of 0. + - ``NOCARE`` disables filtering of data words on the parity bit. + """ + + +class SearchSearchItemTriggerABusMil1553bData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioDevicetypeValue( + self._parity = SearchSearchItemTriggerABusMil1553bDataParity( + device, f"{self._cmd_syntax}:PARity" + ) + self._value = SearchSearchItemTriggerABusMil1553bDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusMdioDevicetypeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. + def parity(self) -> SearchSearchItemTriggerABusMil1553bDataParity: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. **Description:** - - This command specifies the binary device type string used for MDIO triggering if the - trigger condition is Device type. The search number is specified by x. + - This command sets or queries the value of the command word parity bit for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity? **Info:** - - ```` is the device type. Default value is XXXXX. + - ``ONE`` filters data words to only match those where the parity bit has a value of 1. + - ``ZERo`` filters data words to only match those where the parity bit has a value of 0. + - ``NOCARE`` disables filtering of data words on the parity bit. + """ + return self._parity + + @property + def value(self) -> SearchSearchItemTriggerABusMil1553bDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + + **Description:** + - This command sets or queries the value when searching on data words for a MIL-STD-1553 + bus. The search number is specified by x. The search condition must be set to DATA. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue? + + **Info:** + - ```` is the data value. """ return self._value -class SearchSearchItemTriggerABusMdioDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. +class SearchSearchItemTriggerABusMil1553bCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. **Description:** - - This command specifies the binary data string used for MDIO triggering if the trigger - condition is DATA. The search number is specified by x. + - This command sets or queries the field or condition for a MIL-STD-1553 bus to search on. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition {SYNC|COMMAND|STATus|DATA|ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition? **Info:** - - ```` is the data value. Default value is XXXXXXXXXXXXXXXX. + - ``SYNC`` specifies a search for the sync pulse of any word. + - ``COMMAND`` specifies a search for a matching command word. + - ``STATus`` specifies a search for a matching status word. + - ``DATA`` specifies a search for a matching data word. + - ``ERRor`` specifies a search for a specified error condition. """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusMil1553bCommandTrbit(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. -class SearchSearchItemTriggerABusMdioData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. + **Description:** + - This command sets or queries the value of the command word Transmit / Receive bit for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search condition + must be set to COMMAND. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit {RX|TX|X} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit? + + **Info:** + - ``RX`` filters command words to only match those that are receive packets. + - ``TX`` filters command words to only match those that are transmit packets. + - ``X`` disables filtering of command words on the R/T bit. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioDataValue(device, f"{self._cmd_syntax}:VALue") - @property - def value(self) -> SearchSearchItemTriggerABusMdioDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. +class SearchSearchItemTriggerABusMil1553bCommandSubaddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` command. - **Description:** - - This command specifies the binary data string used for MDIO triggering if the trigger - condition is DATA. The search number is specified by x. + **Description:** + - This command sets or queries the value of the command word subaddress field for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search condition + must be set to COMMAND. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress? - **Info:** - - ```` is the data value. Default value is XXXXXXXXXXXXXXXX. - """ - return self._value + **Info:** + - ```` is the word count value. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMdioCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. + +class SearchSearchItemTriggerABusMil1553bCommandParity(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. **Description:** - - This command sets or queries the trigger condition for MDIO bus. The search number is - specified by x. + - This command sets or queries the value of the command word parity bit for a MIL-STD-1553 + bus to search on. The search number is specified by x. The search condition must be set to + COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition {STARTPACKet| PHYSICALADDRess| REGISTERADDRess| DEVICETYPe| DATA| ADDRess| ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity? **Info:** - - ``STARTPACKet`` specifies STARTPACKet as the field within a MDIO frame to search on. This - is the default trigger on condition. - - ``PHYSICALADDRess`` specifies PHYSICALADDRess as the field within a MDIO frame to search - on. - - ``REGISTERADDRess`` specifies REGISTERADDRess as the field within a MDIO frame to search - on. - - ``DEVICETYPe`` specifies DEVICETYPe as the field within a MDIO frame to search on. - - ``DATA`` specifies DATA as the field within a MDIO frame to search on. - - ``ADDRess`` specifies ADDRess as the field within a MDIO frame to search on. - - ``ERRor`` specifies ERRor as the field within a MDIO frame to search on. - """ # noqa: E501 + - ``ONE`` filters command words to only match those where the parity bit has a value of 1. + - ``ZERo`` filters command words to only match those where the parity bit has a value of 0. + - ``NOCARE`` disables filtering of command words on the parity bit. + """ -class SearchSearchItemTriggerABusMdioAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. +class SearchSearchItemTriggerABusMil1553bCommandCount(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. **Description:** - - This command specifies the binary address string used for MDIO triggering if the trigger - condition is address. The search number is specified by x. + - This command sets or queries the value of the command word 'word count' field for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search condition + must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt? **Info:** - - ```` is the address value. Default address value is XXXXXXXXXXXXXXXX. + - ```` is the word count value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusMdioAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. +class SearchSearchItemTriggerABusMil1553bCommandAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. + + **Description:** + - This command sets or queries the low value when searching on command word addresses for a + MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to + COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. - """ + **SCPI Syntax:** - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusMdioAddressValue( - device, f"{self._cmd_syntax}:VALue" - ) + :: - @property - def value(self) -> SearchSearchItemTriggerABusMdioAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue? - **Description:** - - This command specifies the binary address string used for MDIO triggering if the - trigger condition is address. The search number is specified by x. + **Info:** + - ```` is the address value. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue value`` command. + _WRAP_ARG_WITH_QUOTES = True - **SCPI Syntax:** - :: +class SearchSearchItemTriggerABusMil1553bCommandAddressQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue? + **Description:** + - This command sets or queries the qualifier to be used when searching on command word + addresses for a MIL-STD-1553 bus. The search number is specified by x. The search + condition must be set to COMMAND. - **Info:** - - ```` is the address value. Default address value is XXXXXXXXXXXXXXXX. - """ - return self._value + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier value`` command. + **SCPI Syntax:** -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusMdio(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO`` command tree. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier {EQual|UNEQual|LESSthan |MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier? + + **Info:** + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusMil1553bCommandAddressHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` command. + + **Description:** + - This command sets or queries the high value when searching on command word addresses for a + MIL-STD-1553 bus. The search number is specified by x. The search condition must be set to + COMMAND, and the address qualifier must be INrange or OUTrange. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO?`` - query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue? + + **Info:** + - ```` is the address value. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusMil1553bCommandAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. - - ``.devicetype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. - - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. - - ``.physicaladdress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command - tree. - - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command - tree. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` + command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusMdioAddress( - device, f"{self._cmd_syntax}:ADDress" - ) - self._condition = SearchSearchItemTriggerABusMdioCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusMdioData(device, f"{self._cmd_syntax}:DATa") - self._devicetype = SearchSearchItemTriggerABusMdioDevicetype( - device, f"{self._cmd_syntax}:DEVicetype" - ) - self._errtype = SearchSearchItemTriggerABusMdioErrtype( - device, f"{self._cmd_syntax}:ERRType" + self._hivalue = SearchSearchItemTriggerABusMil1553bCommandAddressHivalue( + device, f"{self._cmd_syntax}:HIVALue" ) - self._opcode = SearchSearchItemTriggerABusMdioOpcode(device, f"{self._cmd_syntax}:OPCode") - self._physicaladdress = SearchSearchItemTriggerABusMdioPhysicaladdress( - device, f"{self._cmd_syntax}:PHYSicaladdress" + self._qualifier = SearchSearchItemTriggerABusMil1553bCommandAddressQualifier( + device, f"{self._cmd_syntax}:QUALifier" ) - self._registeraddress = SearchSearchItemTriggerABusMdioRegisteraddress( - device, f"{self._cmd_syntax}:REGisteraddress" + self._value = SearchSearchItemTriggerABusMil1553bCommandAddressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def address(self) -> SearchSearchItemTriggerABusMdioAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. + def hivalue(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` command. + + **Description:** + - This command sets or queries the high value when searching on command word addresses + for a MIL-STD-1553 bus. The search number is specified by x. The search condition must + be set to COMMAND, and the address qualifier must be INrange or OUTrange. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue?`` query and raise + an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue? + + **Info:** + - ```` is the address value. """ - return self._address + return self._hivalue @property - def condition(self) -> SearchSearchItemTriggerABusMdioCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. + def qualifier(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. **Description:** - - This command sets or queries the trigger condition for MDIO bus. The search number is - specified by x. + - This command sets or queries the qualifier to be used when searching on command word + addresses for a MIL-STD-1553 bus. The search number is specified by x. The search + condition must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition {STARTPACKet| PHYSICALADDRess| REGISTERADDRess| DEVICETYPe| DATA| ADDRess| ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier {EQual|UNEQual|LESSthan |MOREthan|LESSEQual|MOREEQual|INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier? **Info:** - - ``STARTPACKet`` specifies STARTPACKet as the field within a MDIO frame to search on. - This is the default trigger on condition. - - ``PHYSICALADDRess`` specifies PHYSICALADDRess as the field within a MDIO frame to - search on. - - ``REGISTERADDRess`` specifies REGISTERADDRess as the field within a MDIO frame to - search on. - - ``DEVICETYPe`` specifies DEVICETYPe as the field within a MDIO frame to search on. - - ``DATA`` specifies DATA as the field within a MDIO frame to search on. - - ``ADDRess`` specifies ADDRess as the field within a MDIO frame to search on. - - ``ERRor`` specifies ERRor as the field within a MDIO frame to search on. + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. """ # noqa: E501 - return self._condition + return self._qualifier @property - def data(self) -> SearchSearchItemTriggerABusMdioData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. + def value(self) -> SearchSearchItemTriggerABusMil1553bCommandAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` command. + + **Description:** + - This command sets or queries the low value when searching on command word addresses + for a MIL-STD-1553 bus. The search number is specified by x. The search condition must + be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue? + + **Info:** + - ```` is the address value. """ - return self._data + return self._value + + +class SearchSearchItemTriggerABusMil1553bCommand(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command + tree. + - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. + - ``.subaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` + command. + - ``.trbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusMil1553bCommandAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + self._count = SearchSearchItemTriggerABusMil1553bCommandCount( + device, f"{self._cmd_syntax}:COUNt" + ) + self._parity = SearchSearchItemTriggerABusMil1553bCommandParity( + device, f"{self._cmd_syntax}:PARity" + ) + self._subaddress = SearchSearchItemTriggerABusMil1553bCommandSubaddress( + device, f"{self._cmd_syntax}:SUBADdress" + ) + self._trbit = SearchSearchItemTriggerABusMil1553bCommandTrbit( + device, f"{self._cmd_syntax}:TRBit" + ) @property - def devicetype(self) -> SearchSearchItemTriggerABusMdioDevicetype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. + def address(self) -> SearchSearchItemTriggerABusMil1553bCommandAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:HIVALue`` + command. + - ``.qualifier``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:QUALifier`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess:VALue`` + command. """ - return self._devicetype + return self._address @property - def errtype(self) -> SearchSearchItemTriggerABusMdioErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. + def count(self) -> SearchSearchItemTriggerABusMil1553bCommandCount: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. **Description:** - - This command sets or queries the error type to be used when triggering on MDIO data. - This applies when the MDIO bus trigger condition is set to ERRor. The search number is - specified by x. + - This command sets or queries the value of the command word 'word count' field for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType {OPCODEERRor| DEVERRor| ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt? **Info:** - - ``OPCODEERRor`` specifies OPCODEERRor as the field within a MDIO frame to search on. - This is the default trigger on condition. - - ``DEVERRor`` specifies DEVERRor as the field within a MDIO frame to search on. - - ``ANY`` specifies ANY as the field within a MDIO frame to search on. + - ```` is the word count value. """ - return self._errtype + return self._count @property - def opcode(self) -> SearchSearchItemTriggerABusMdioOpcode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. + def parity(self) -> SearchSearchItemTriggerABusMil1553bCommandParity: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. + + **Description:** + - This command sets or queries the value of the command word parity bit for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity? + + **Info:** + - ``ONE`` filters command words to only match those where the parity bit has a value of + 1. + - ``ZERo`` filters command words to only match those where the parity bit has a value of + 0. + - ``NOCARE`` disables filtering of command words on the parity bit. """ - return self._opcode + return self._parity @property - def physicaladdress(self) -> SearchSearchItemTriggerABusMdioPhysicaladdress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command tree. + def subaddress(self) -> SearchSearchItemTriggerABusMil1553bCommandSubaddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` command. + + **Description:** + - This command sets or queries the value of the command word subaddress field for a + MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress? + + **Info:** + - ```` is the word count value. """ - return self._physicaladdress + return self._subaddress @property - def registeraddress(self) -> SearchSearchItemTriggerABusMdioRegisteraddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command tree. + def trbit(self) -> SearchSearchItemTriggerABusMil1553bCommandTrbit: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. + + **Description:** + - This command sets or queries the value of the command word Transmit / Receive bit for + a MIL-STD-1553 bus to search on. The search number is specified by x. The search + condition must be set to COMMAND. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. - """ - return self._registeraddress - - -class SearchSearchItemTriggerABusManchesterPacketoffdataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. - - **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is DATA. The search number is specified by . - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue value`` command. - - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit {RX|TX|X} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit? - **Info:** - - ```` specifies the data string in a valid format. - """ + **Info:** + - ``RX`` filters command words to only match those that are receive packets. + - ``TX`` filters command words to only match those that are transmit packets. + - ``X`` disables filtering of command words on the R/T bit. + """ + return self._trbit -class SearchSearchItemTriggerABusManchesterPacketoffdata(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` command tree. +class SearchSearchItemTriggerABusMil1553b(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. + - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusManchesterPacketoffdataValue( - device, f"{self._cmd_syntax}:VALue" + self._command = SearchSearchItemTriggerABusMil1553bCommand( + device, f"{self._cmd_syntax}:COMMAND" + ) + self._condition = SearchSearchItemTriggerABusMil1553bCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusMil1553bData(device, f"{self._cmd_syntax}:DATa") + self._errtype = SearchSearchItemTriggerABusMil1553bErrtype( + device, f"{self._cmd_syntax}:ERRTYPe" + ) + self._status = SearchSearchItemTriggerABusMil1553bStatus( + device, f"{self._cmd_syntax}:STATus" ) @property - def value(self) -> SearchSearchItemTriggerABusManchesterPacketoffdataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. + def command(self) -> SearchSearchItemTriggerABusMil1553bCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:ADDRess`` command + tree. + - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:COUNt`` command. + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:PARity`` command. + - ``.subaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:SUBADdress`` + command. + - ``.trbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:COMMAND:TRBit`` command. + """ + return self._command + + @property + def condition(self) -> SearchSearchItemTriggerABusMil1553bCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is DATA. The search number is specified by . + - This command sets or queries the field or condition for a MIL-STD-1553 bus to search + on. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition {SYNC|COMMAND|STATus|DATA|ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:CONDition? **Info:** - - ```` specifies the data string in a valid format. + - ``SYNC`` specifies a search for the sync pulse of any word. + - ``COMMAND`` specifies a search for a matching command word. + - ``STATus`` specifies a search for a matching status word. + - ``DATA`` specifies a search for a matching data word. + - ``ERRor`` specifies a search for a specified error condition. """ - return self._value + return self._condition + @property + def data(self) -> SearchSearchItemTriggerABusMil1553bData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa`` command tree. -class SearchSearchItemTriggerABusManchesterTrailerValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. - - **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is Trailer when searching on an Manchester signal. The search condition needs to - be set to Trailer. The search number is specified by . - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue? - - **Info:** - - ```` specifies the data string in a valid format. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusManchesterTrailer(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusManchesterTrailerValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:PARity`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:DATa:VALue`` command. + """ + return self._data @property - def value(self) -> SearchSearchItemTriggerABusManchesterTrailerValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. + def errtype(self) -> SearchSearchItemTriggerABusMil1553bErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is Trailer when searching on an Manchester signal. The search condition - needs to be set to Trailer. The search number is specified by . + - This command sets or queries the type of error condition for a MIL-STD-1553 bus to + search on. The search number is specified by x. The search condition must be set to + ERRor. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe {PARity|SYNC|DATA} + - SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:ERRTYPe? **Info:** - - ```` specifies the data string in a valid format. + - ``PARity`` specifies searching for an incorrectly calculated parity bit in any word. + - ``SYNC`` specifies searching for any sync pulse that does not transition in the middle + of the pulse as required. + - ``DATA`` specifies searching for any non-contiguous data words. """ - return self._value + return self._errtype + @property + def status(self) -> SearchSearchItemTriggerABusMil1553bStatus: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus`` command tree. -class SearchSearchItemTriggerABusManchesterSyncValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:ADDRess`` command + tree. + - ``.bit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:BIT`` command tree. + - ``.parity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MIL1553B:STATus:PARity`` command. + """ + return self._status + + +class SearchSearchItemTriggerABusMdioRegisteraddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is Sync when searching on an Manchester signal. The search condition needs to be - set to Sync. The search number is specified by . + - This command specifies the binary register address string used for MDIO triggering if the + trigger condition is register address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue? **Info:** - - ```` specifies the data string in a valid format. + - ```` is the register address value. Default register address value is XXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusManchesterSync(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. +class SearchSearchItemTriggerABusMdioRegisteraddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusManchesterSyncValue( + self._value = SearchSearchItemTriggerABusMdioRegisteraddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusManchesterSyncValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusMdioRegisteraddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is Sync when searching on an Manchester signal. The search condition needs - to be set to Sync. The search number is specified by . + - This command specifies the binary register address string used for MDIO triggering if + the trigger condition is register address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue? **Info:** - - ```` specifies the data string in a valid format. + - ```` is the register address value. Default register address value is XXXXX. """ return self._value -class SearchSearchItemTriggerABusManchesterHeaderValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. +class SearchSearchItemTriggerABusMdioPhysicaladdressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is header when searching on an Manchester signal. The search condition needs to - be set to header. The search number is specified by . + - This command specifies the binary physical address string used for MDIO triggering if the + trigger condition is physical address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue? **Info:** - - ```` is the header value. + - ```` is the physical address value. Default physical address value is XXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusManchesterHeader(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. +class SearchSearchItemTriggerABusMdioPhysicaladdress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusManchesterHeaderValue( + self._value = SearchSearchItemTriggerABusMdioPhysicaladdressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusManchesterHeaderValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusMdioPhysicaladdressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is header when searching on an Manchester signal. The search condition needs - to be set to header. The search number is specified by . + - This command specifies the binary physical address string used for MDIO triggering if + the trigger condition is physical address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue? **Info:** - - ```` is the header value. + - ```` is the physical address value. Default physical address value is XXXXX. """ return self._value -class SearchSearchItemTriggerABusManchesterErrorType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. +class SearchSearchItemTriggerABusMdioOpcodeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. **Description:** - - This command sets or queries the error to be used when searching on a Manchester signal. - The search condition must be set to error. Parity error identifies odd and even parity. - The search number is specified by . + - This command specifies the binary op-code string used for MDIO triggering if the trigger + condition is op-code. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe {MANChester|PARity} - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue? **Info:** - - ``MANChester`` sets the error type to Manchester. - - ``PARity`` sets the error type to parity. + - ```` is the op-code value. Default op-code value is XX. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusManchesterError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. + +class SearchSearchItemTriggerABusMdioOpcode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusManchesterErrorType( - device, f"{self._cmd_syntax}:TYPe" + self._value = SearchSearchItemTriggerABusMdioOpcodeValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def type(self) -> SearchSearchItemTriggerABusManchesterErrorType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. + def value(self) -> SearchSearchItemTriggerABusMdioOpcodeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. **Description:** - - This command sets or queries the error to be used when searching on a Manchester - signal. The search condition must be set to error. Parity error identifies odd and - even parity. The search number is specified by . + - This command specifies the binary op-code string used for MDIO triggering if the + trigger condition is op-code. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe {MANChester|PARity} - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue? **Info:** - - ``MANChester`` sets the error type to Manchester. - - ``PARity`` sets the error type to parity. + - ```` is the op-code value. Default op-code value is XX. """ - return self._type + return self._value -class SearchSearchItemTriggerABusManchesterDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. +class SearchSearchItemTriggerABusMdioErrtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is data when searching on an Manchester signal. The search condition needs to be - set to data. The search number is specified by . + - This command sets or queries the error type to be used when triggering on MDIO data. This + applies when the MDIO bus trigger condition is set to ERRor. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType {OPCODEERRor| DEVERRor| ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType? **Info:** - - ```` is the data value. + - ``OPCODEERRor`` specifies OPCODEERRor as the field within a MDIO frame to search on. This + is the default trigger on condition. + - ``DEVERRor`` specifies DEVERRor as the field within a MDIO frame to search on. + - ``ANY`` specifies ANY as the field within a MDIO frame to search on. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusManchesterDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. +class SearchSearchItemTriggerABusMdioDevicetypeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. **Description:** - - This command specifies the number of bits per word for the specified Manchester bus. The - search number is specified by x. + - This command specifies the binary device type string used for MDIO triggering if the + trigger condition is Device type. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue? **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values are - 1. The maximum value is 5. + - ```` is the device type. Default value is XXXXX. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusManchesterData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. + +class SearchSearchItemTriggerABusMdioDevicetype(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusManchesterDataSize( - device, f"{self._cmd_syntax}:SIZe" - ) - self._value = SearchSearchItemTriggerABusManchesterDataValue( + self._value = SearchSearchItemTriggerABusMdioDevicetypeValue( device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusManchesterDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. - - **Description:** - - This command specifies the number of bits per word for the specified Manchester bus. - The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe? - - **Info:** - - ``Search`` is the number of the search. - - ```` specifies the data string in a valid format. The minimum and default values - are 1. The maximum value is 5. - """ - return self._size - - @property - def value(self) -> SearchSearchItemTriggerABusManchesterDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusMdioDevicetypeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. **Description:** - - This command specifies the binary string used for Manchester triggering if the trigger - condition is data when searching on an Manchester signal. The search condition needs - to be set to data. The search number is specified by . + - This command specifies the binary device type string used for MDIO triggering if the + trigger condition is Device type. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue? **Info:** - - ```` is the data value. + - ```` is the device type. Default value is XXXXX. """ return self._value -class SearchSearchItemTriggerABusManchesterCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. +class SearchSearchItemTriggerABusMdioDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. **Description:** - - This command specifies a field or condition for an Manchester bus to search on. The search - number is specified by x. + - This command specifies the binary data string used for MDIO triggering if the trigger + condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition {SYNCBITS| HEADer| DATa| packetOffData| TRAiler| ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue? **Info:** - - ``SYNCBITS`` specifies Sync Bits symbols as the field within an Manchester frame to search - on. - - ``HEADer`` specifies header symbols as the field within an Manchester frame to search on. - - ``DATa`` specifies data symbols as the field within an Manchester frame to search on. - - ``packetOffData`` specifies the binary string used for Manchester triggering if the - trigger condition is DATA. - - ``TRAiler`` specifies trailer symbols as the field within an Manchester frame to search - on. - - ``ERRors`` specifies error symbols as the field within an Manchester frame to search on. - """ # noqa: E501 + - ```` is the data value. Default value is XXXXXXXXXXXXXXXX. + """ + + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusManchester(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester`` command tree. +class SearchSearchItemTriggerABusMdioData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. - - ``.sync``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. - - ``.trailer``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. - - ``.packetoffdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` - command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusManchesterCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusManchesterData(device, f"{self._cmd_syntax}:DATa") - self._error = SearchSearchItemTriggerABusManchesterError( - device, f"{self._cmd_syntax}:ERRor" - ) - self._header = SearchSearchItemTriggerABusManchesterHeader( - device, f"{self._cmd_syntax}:HEADER" - ) - self._sync = SearchSearchItemTriggerABusManchesterSync(device, f"{self._cmd_syntax}:SYNC") - self._trailer = SearchSearchItemTriggerABusManchesterTrailer( - device, f"{self._cmd_syntax}:TRAILER" - ) - self._packetoffdata = SearchSearchItemTriggerABusManchesterPacketoffdata( - device, f"{self._cmd_syntax}:packetOffData" - ) + self._value = SearchSearchItemTriggerABusMdioDataValue(device, f"{self._cmd_syntax}:VALue") @property - def condition(self) -> SearchSearchItemTriggerABusManchesterCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. + def value(self) -> SearchSearchItemTriggerABusMdioDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. **Description:** - - This command specifies a field or condition for an Manchester bus to search on. The - search number is specified by x. + - This command specifies the binary data string used for MDIO triggering if the trigger + condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition {SYNCBITS| HEADer| DATa| packetOffData| TRAiler| ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue? **Info:** - - ``SYNCBITS`` specifies Sync Bits symbols as the field within an Manchester frame to - search on. - - ``HEADer`` specifies header symbols as the field within an Manchester frame to search - on. - - ``DATa`` specifies data symbols as the field within an Manchester frame to search on. - - ``packetOffData`` specifies the binary string used for Manchester triggering if the - trigger condition is DATA. - - ``TRAiler`` specifies trailer symbols as the field within an Manchester frame to - search on. - - ``ERRors`` specifies error symbols as the field within an Manchester frame to search - on. - """ # noqa: E501 - return self._condition + - ```` is the data value. Default value is XXXXXXXXXXXXXXXX. + """ + return self._value + + +class SearchSearchItemTriggerABusMdioCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for MDIO bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition {STARTPACKet| PHYSICALADDRess| REGISTERADDRess| DEVICETYPe| DATA| ADDRess| ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition? + + **Info:** + - ``STARTPACKet`` specifies STARTPACKet as the field within a MDIO frame to search on. This + is the default trigger on condition. + - ``PHYSICALADDRess`` specifies PHYSICALADDRess as the field within a MDIO frame to search + on. + - ``REGISTERADDRess`` specifies REGISTERADDRess as the field within a MDIO frame to search + on. + - ``DEVICETYPe`` specifies DEVICETYPe as the field within a MDIO frame to search on. + - ``DATA`` specifies DATA as the field within a MDIO frame to search on. + - ``ADDRess`` specifies ADDRess as the field within a MDIO frame to search on. + - ``ERRor`` specifies ERRor as the field within a MDIO frame to search on. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusMdioAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + + **Description:** + - This command specifies the binary address string used for MDIO triggering if the trigger + condition is address. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue? + + **Info:** + - ```` is the address value. Default address value is XXXXXXXXXXXXXXXX. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusMdioAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusMdioAddressValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def data(self) -> SearchSearchItemTriggerABusManchesterData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. + def value(self) -> SearchSearchItemTriggerABusMdioAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + + **Description:** + - This command specifies the binary address string used for MDIO triggering if the + trigger condition is address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue? + + **Info:** + - ```` is the address value. Default address value is XXXXXXXXXXXXXXXX. + """ + return self._value + + +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusMdio(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO?`` + query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO?`` + query and raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. + - ``.devicetype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. + - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. + - ``.physicaladdress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command + tree. + - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command + tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusMdioAddress( + device, f"{self._cmd_syntax}:ADDress" + ) + self._condition = SearchSearchItemTriggerABusMdioCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusMdioData(device, f"{self._cmd_syntax}:DATa") + self._devicetype = SearchSearchItemTriggerABusMdioDevicetype( + device, f"{self._cmd_syntax}:DEVicetype" + ) + self._errtype = SearchSearchItemTriggerABusMdioErrtype( + device, f"{self._cmd_syntax}:ERRType" + ) + self._opcode = SearchSearchItemTriggerABusMdioOpcode(device, f"{self._cmd_syntax}:OPCode") + self._physicaladdress = SearchSearchItemTriggerABusMdioPhysicaladdress( + device, f"{self._cmd_syntax}:PHYSicaladdress" + ) + self._registeraddress = SearchSearchItemTriggerABusMdioRegisteraddress( + device, f"{self._cmd_syntax}:REGisteraddress" + ) + + @property + def address(self) -> SearchSearchItemTriggerABusMdioAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ADDress:VALue`` command. + """ + return self._address + + @property + def condition(self) -> SearchSearchItemTriggerABusMdioCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for MDIO bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition {STARTPACKet| PHYSICALADDRess| REGISTERADDRess| DEVICETYPe| DATA| ADDRess| ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:CONDition? + + **Info:** + - ``STARTPACKet`` specifies STARTPACKet as the field within a MDIO frame to search on. + This is the default trigger on condition. + - ``PHYSICALADDRess`` specifies PHYSICALADDRess as the field within a MDIO frame to + search on. + - ``REGISTERADDRess`` specifies REGISTERADDRess as the field within a MDIO frame to + search on. + - ``DEVICETYPe`` specifies DEVICETYPe as the field within a MDIO frame to search on. + - ``DATA`` specifies DATA as the field within a MDIO frame to search on. + - ``ADDRess`` specifies ADDRess as the field within a MDIO frame to search on. + - ``ERRor`` specifies ERRor as the field within a MDIO frame to search on. + """ # noqa: E501 + return self._condition + + @property + def data(self) -> SearchSearchItemTriggerABusMdioData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DATa:VALue`` command. """ return self._data @property - def error(self) -> SearchSearchItemTriggerABusManchesterError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. + def devicetype(self) -> SearchSearchItemTriggerABusMdioDevicetype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:DEVicetype:VALue`` command. """ - return self._error + return self._devicetype @property - def header(self) -> SearchSearchItemTriggerABusManchesterHeader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. + def errtype(self) -> SearchSearchItemTriggerABusMdioErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType`` command. + + **Description:** + - This command sets or queries the error type to be used when triggering on MDIO data. + This applies when the MDIO bus trigger condition is set to ERRor. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType {OPCODEERRor| DEVERRor| ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:MDIO:ERRType? + + **Info:** + - ``OPCODEERRor`` specifies OPCODEERRor as the field within a MDIO frame to search on. + This is the default trigger on condition. + - ``DEVERRor`` specifies DEVERRor as the field within a MDIO frame to search on. + - ``ANY`` specifies ANY as the field within a MDIO frame to search on. """ - return self._header + return self._errtype @property - def sync(self) -> SearchSearchItemTriggerABusManchesterSync: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. + def opcode(self) -> SearchSearchItemTriggerABusMdioOpcode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:OPCode:VALue`` command. """ - return self._sync + return self._opcode @property - def trailer(self) -> SearchSearchItemTriggerABusManchesterTrailer: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. + def physicaladdress(self) -> SearchSearchItemTriggerABusMdioPhysicaladdress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:PHYSicaladdress:VALue`` command. """ - return self._trailer + return self._physicaladdress @property - def packetoffdata(self) -> SearchSearchItemTriggerABusManchesterPacketoffdata: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` command tree. + def registeraddress(self) -> SearchSearchItemTriggerABusMdioRegisteraddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MDIO:REGisteraddress:VALue`` command. """ - return self._packetoffdata + return self._registeraddress -class SearchSearchItemTriggerABusLinIdentifierValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. +class SearchSearchItemTriggerABusManchesterPacketoffdataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. **Description:** - - This command sets or queries the string used for a LIN bus identifier value. The search - number is specified by x. The search condition must be IDENTIFIER or IDANDDATA. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is DATA. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue? **Info:** - - ```` specifies the identifier value. + - ```` specifies the data string in a valid format. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusLinIdentifier(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. +class SearchSearchItemTriggerABusManchesterPacketoffdata(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusLinIdentifierValue( + self._value = SearchSearchItemTriggerABusManchesterPacketoffdataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusLinIdentifierValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusManchesterPacketoffdataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` command. **Description:** - - This command sets or queries the string used for a LIN bus identifier value. The - search number is specified by x. The search condition must be IDENTIFIER or IDANDDATA. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is DATA. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue? **Info:** - - ```` specifies the identifier value. + - ```` specifies the data string in a valid format. """ return self._value -class SearchSearchItemTriggerABusLinErrtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. +class SearchSearchItemTriggerABusManchesterTrailerValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. **Description:** - - This command sets or queries the error type for a LIN bus search. The search number is - specified by x. The search condition must be set to ERROR. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is Trailer when searching on an Manchester signal. The search condition needs to + be set to Trailer. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE {CHecksum|PARity|SYNC} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue? **Info:** - - ``CHecksum`` specifies the error type is checksum. - - ``PARity`` specifies the error type is parity. - - ``SYNC`` specifies the error type is sync. + - ```` specifies the data string in a valid format. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusLinDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. - **Description:** - - This command sets or queries the data string used for a LIN bus search. The search number - is specified by x. The search condition must be DATA or IDANDDATA. +class SearchSearchItemTriggerABusManchesterTrailer(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query and raise an AssertionError + if the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusManchesterTrailerValue( + device, f"{self._cmd_syntax}:VALue" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue? + @property + def value(self) -> SearchSearchItemTriggerABusManchesterTrailerValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. - **Info:** - - ```` specifies the data value. - """ + **Description:** + - This command specifies the binary string used for Manchester triggering if the trigger + condition is Trailer when searching on an Manchester signal. The search condition + needs to be set to Trailer. The search number is specified by . - _WRAP_ARG_WITH_QUOTES = True + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue value`` command. + + **SCPI Syntax:** + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue? + + **Info:** + - ```` specifies the data string in a valid format. + """ + return self._value -class SearchSearchItemTriggerABusLinDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + +class SearchSearchItemTriggerABusManchesterSyncValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. **Description:** - - This command sets or queries the length of the stat string in bytes used for a LIN bus - search. The search number is specified by x. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is Sync when searching on an Manchester signal. The search condition needs to be + set to Sync. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue? **Info:** - - ```` specifies the data size. + - ```` specifies the data string in a valid format. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusLinDataQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. - **Description:** - - This command sets or queries the data qualifier used in a LIN bus search. The search - number is specified by x. +class SearchSearchItemTriggerABusManchesterSync(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusManchesterSyncValue( + device, f"{self._cmd_syntax}:VALue" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier {EQual| LESSEQual| MOREEQual| UNEQual| LESSthan| MOREthan| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier? + @property + def value(self) -> SearchSearchItemTriggerABusManchesterSyncValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. - **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 + **Description:** + - This command specifies the binary string used for Manchester triggering if the trigger + condition is Sync when searching on an Manchester signal. The search condition needs + to be set to Sync. The search number is specified by . + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue value`` command. + **SCPI Syntax:** -class SearchSearchItemTriggerABusLinDataHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue? + + **Info:** + - ```` specifies the data string in a valid format. + """ + return self._value + + +class SearchSearchItemTriggerABusManchesterHeaderValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. **Description:** - - This command sets or queries the high data value string used in a LIN bus search. The - search number is specified by x. The search condition must be DATA or IDANDDATA and the - data qualifier must be INRANGE or OUTRANGE. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is header when searching on an Manchester signal. The search condition needs to + be set to header. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue? **Info:** - - ```` is a quoted string of 1s, 0s, or Xs representing the binary data string to - be used in a LIN search if the search condition is IDentifier or IDANDDATA (identifier and - data). + - ```` is the header value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusLinData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. +class SearchSearchItemTriggerABusManchesterHeader(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusLinDataHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._qualifier = SearchSearchItemTriggerABusLinDataQualifier( - device, f"{self._cmd_syntax}:QUALifier" + self._value = SearchSearchItemTriggerABusManchesterHeaderValue( + device, f"{self._cmd_syntax}:VALue" ) - self._size = SearchSearchItemTriggerABusLinDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusLinDataValue(device, f"{self._cmd_syntax}:VALue") @property - def hivalue(self) -> SearchSearchItemTriggerABusLinDataHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. + def value(self) -> SearchSearchItemTriggerABusManchesterHeaderValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. **Description:** - - This command sets or queries the high data value string used in a LIN bus search. The - search number is specified by x. The search condition must be DATA or IDANDDATA and - the data qualifier must be INRANGE or OUTRANGE. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is header when searching on an Manchester signal. The search condition needs + to be set to header. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue? **Info:** - - ```` is a quoted string of 1s, 0s, or Xs representing the binary data string - to be used in a LIN search if the search condition is IDentifier or IDANDDATA - (identifier and data). + - ```` is the header value. """ - return self._hivalue + return self._value - @property - def qualifier(self) -> SearchSearchItemTriggerABusLinDataQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. - **Description:** - - This command sets or queries the data qualifier used in a LIN bus search. The search - number is specified by x. +class SearchSearchItemTriggerABusManchesterErrorType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier value`` command. + **Description:** + - This command sets or queries the error to be used when searching on a Manchester signal. + The search condition must be set to error. Parity error identifies odd and even parity. + The search number is specified by . - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier {EQual| LESSEQual| MOREEQual| UNEQual| LESSthan| MOREthan| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier? + :: - **Info:** - - ``EQual`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQual`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - - ``INrange`` sets the data qualifier to in range. - - ``OUTrange`` sets the data qualifier out of range. - """ # noqa: E501 - return self._qualifier + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe {MANChester|PARity} + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe? + + **Info:** + - ``MANChester`` sets the error type to Manchester. + - ``PARity`` sets the error type to parity. + """ + + +class SearchSearchItemTriggerABusManchesterError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._type = SearchSearchItemTriggerABusManchesterErrorType( + device, f"{self._cmd_syntax}:TYPe" + ) @property - def size(self) -> SearchSearchItemTriggerABusLinDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + def type(self) -> SearchSearchItemTriggerABusManchesterErrorType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. **Description:** - - This command sets or queries the length of the stat string in bytes used for a LIN bus - search. The search number is specified by x. + - This command sets or queries the error to be used when searching on a Manchester + signal. The search condition must be set to error. Parity error identifies odd and + even parity. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe {MANChester|PARity} + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe? **Info:** - - ```` specifies the data size. + - ``MANChester`` sets the error type to Manchester. + - ``PARity`` sets the error type to parity. """ - return self._size + return self._type - @property - def value(self) -> SearchSearchItemTriggerABusLinDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. - **Description:** - - This command sets or queries the data string used for a LIN bus search. The search - number is specified by x. The search condition must be DATA or IDANDDATA. +class SearchSearchItemTriggerABusManchesterDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue value`` command. + **Description:** + - This command specifies the binary string used for Manchester triggering if the trigger + condition is data when searching on an Manchester signal. The search condition needs to be + set to data. The search number is specified by . - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue? + :: - **Info:** - - ```` specifies the data value. - """ - return self._value + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue? + **Info:** + - ```` is the data value. + """ -class SearchSearchItemTriggerABusLinCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusManchesterDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. **Description:** - - This command sets or queries the condition for a LIN bus search. The search number is - specified by x. + - This command specifies the number of bits per word for the specified Manchester bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition {DATA|IDANDDATA|ERRor|IDentifier|SLEEP|SYNCfield|WAKEup} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe? **Info:** - - ``DATA`` sets the trigger condition to data. - - ``IDANDDATA`` sets the trigger condition to ID and data. - - ``ERRor`` sets the trigger condition to error. - - ``IDentifier`` sets the trigger condition to identifier. - - ``SLEEP`` sets the trigger condition to sleep. - - ``SYNCfield`` sets the trigger condition to sync field. - - ``WAKEup`` sets the trigger condition to wakeup. - """ # noqa: E501 + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values are + 1. The maximum value is 5. + """ -class SearchSearchItemTriggerABusLin(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN`` command tree. +class SearchSearchItemTriggerABusManchesterData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN?`` query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. - - ``.identifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusLinCondition( - device, f"{self._cmd_syntax}:CONDition" + self._size = SearchSearchItemTriggerABusManchesterDataSize( + device, f"{self._cmd_syntax}:SIZe" ) - self._data = SearchSearchItemTriggerABusLinData(device, f"{self._cmd_syntax}:DATa") - self._errtype = SearchSearchItemTriggerABusLinErrtype(device, f"{self._cmd_syntax}:ERRTYPE") - self._identifier = SearchSearchItemTriggerABusLinIdentifier( - device, f"{self._cmd_syntax}:IDentifier" + self._value = SearchSearchItemTriggerABusManchesterDataValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def condition(self) -> SearchSearchItemTriggerABusLinCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. + def size(self) -> SearchSearchItemTriggerABusManchesterDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. **Description:** - - This command sets or queries the condition for a LIN bus search. The search number is - specified by x. + - This command specifies the number of bits per word for the specified Manchester bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition {DATA|IDANDDATA|ERRor|IDentifier|SLEEP|SYNCfield|WAKEup} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe? **Info:** - - ``DATA`` sets the trigger condition to data. - - ``IDANDDATA`` sets the trigger condition to ID and data. - - ``ERRor`` sets the trigger condition to error. - - ``IDentifier`` sets the trigger condition to identifier. - - ``SLEEP`` sets the trigger condition to sleep. - - ``SYNCfield`` sets the trigger condition to sync field. - - ``WAKEup`` sets the trigger condition to wakeup. - """ # noqa: E501 - return self._condition - - @property - def data(self) -> SearchSearchItemTriggerABusLinData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. + - ``Search`` is the number of the search. + - ```` specifies the data string in a valid format. The minimum and default values + are 1. The maximum value is 5. """ - return self._data + return self._size @property - def errtype(self) -> SearchSearchItemTriggerABusLinErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. + def value(self) -> SearchSearchItemTriggerABusManchesterDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. **Description:** - - This command sets or queries the error type for a LIN bus search. The search number is - specified by x. The search condition must be set to ERROR. + - This command specifies the binary string used for Manchester triggering if the trigger + condition is data when searching on an Manchester signal. The search condition needs + to be set to data. The search number is specified by . **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE {CHecksum|PARity|SYNC} - - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue? **Info:** - - ``CHecksum`` specifies the error type is checksum. - - ``PARity`` specifies the error type is parity. - - ``SYNC`` specifies the error type is sync. - """ - return self._errtype - - @property - def identifier(self) -> SearchSearchItemTriggerABusLinIdentifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. + - ```` is the data value. """ - return self._identifier + return self._value -class SearchSearchItemTriggerABusI3cTestmodeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. +class SearchSearchItemTriggerABusManchesterCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is TESTMODE. Requires purchase and installation of option SRI3C. + - This command specifies a field or condition for an Manchester bus to search on. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition {SYNCBITS| HEADer| DATa| packetOffData| TRAiler| ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ + - ``SYNCBITS`` specifies Sync Bits symbols as the field within an Manchester frame to search + on. + - ``HEADer`` specifies header symbols as the field within an Manchester frame to search on. + - ``DATa`` specifies data symbols as the field within an Manchester frame to search on. + - ``packetOffData`` specifies the binary string used for Manchester triggering if the + trigger condition is DATA. + - ``TRAiler`` specifies trailer symbols as the field within an Manchester frame to search + on. + - ``ERRors`` specifies error symbols as the field within an Manchester frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusI3cTestmode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe`` command tree. +class SearchSearchItemTriggerABusManchester(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. + - ``.sync``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. + - ``.trailer``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. + - ``.packetoffdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` + command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cTestmodeValue( - device, f"{self._cmd_syntax}:VALue" + self._condition = SearchSearchItemTriggerABusManchesterCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusManchesterData(device, f"{self._cmd_syntax}:DATa") + self._error = SearchSearchItemTriggerABusManchesterError( + device, f"{self._cmd_syntax}:ERRor" + ) + self._header = SearchSearchItemTriggerABusManchesterHeader( + device, f"{self._cmd_syntax}:HEADER" + ) + self._sync = SearchSearchItemTriggerABusManchesterSync(device, f"{self._cmd_syntax}:SYNC") + self._trailer = SearchSearchItemTriggerABusManchesterTrailer( + device, f"{self._cmd_syntax}:TRAILER" + ) + self._packetoffdata = SearchSearchItemTriggerABusManchesterPacketoffdata( + device, f"{self._cmd_syntax}:packetOffData" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cTestmodeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. + def condition(self) -> SearchSearchItemTriggerABusManchesterCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is TESTMODE. Requires purchase and installation of option SRI3C. + - This command specifies a field or condition for an Manchester bus to search on. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition {SYNCBITS| HEADer| DATa| packetOffData| TRAiler| ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:MANChester:CONDition? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ - return self._value - - -class SearchSearchItemTriggerABusI3cSupportbyteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. - - **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SUPPORTEDBYTE. Requires purchase and installation of option SRI3C. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue value`` command. + - ``SYNCBITS`` specifies Sync Bits symbols as the field within an Manchester frame to + search on. + - ``HEADer`` specifies header symbols as the field within an Manchester frame to search + on. + - ``DATa`` specifies data symbols as the field within an Manchester frame to search on. + - ``packetOffData`` specifies the binary string used for Manchester triggering if the + trigger condition is DATA. + - ``TRAiler`` specifies trailer symbols as the field within an Manchester frame to + search on. + - ``ERRors`` specifies error symbols as the field within an Manchester frame to search + on. + """ # noqa: E501 + return self._condition - **SCPI Syntax:** + @property + def data(self) -> SearchSearchItemTriggerABusManchesterData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa?`` query and raise an AssertionError + if the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue? + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:DATa:VALue`` command. + """ + return self._data - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ + @property + def error(self) -> SearchSearchItemTriggerABusManchesterError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor?`` query and raise an AssertionError + if the returned value does not match ``value``. -class SearchSearchItemTriggerABusI3cSupportbyte(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe`` command tree. + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:ERRor:TYPe`` command. + """ + return self._error - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def header(self) -> SearchSearchItemTriggerABusManchesterHeader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER?`` query and raise an + AssertionError if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cSupportbyteValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:HEADER:VALue`` command. + """ + return self._header @property - def value(self) -> SearchSearchItemTriggerABusI3cSupportbyteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. + def sync(self) -> SearchSearchItemTriggerABusManchesterSync: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC`` command tree. - **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SUPPORTEDBYTE. Requires purchase and installation of option - SRI3C. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:SYNC:VALue`` command. + """ + return self._sync + + @property + def trailer(self) -> SearchSearchItemTriggerABusManchesterTrailer: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue value`` command. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:TRAILER:VALue`` command. + """ + return self._trailer - :: + @property + def packetoffdata(self) -> SearchSearchItemTriggerABusManchesterPacketoffdata: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData?`` query and raise an + AssertionError if the returned value does not match ``value``. - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:MANChester:packetOffData:VALue`` + command. """ - return self._value + return self._packetoffdata -class SearchSearchItemTriggerABusI3cStaticAddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. +class SearchSearchItemTriggerABusLinIdentifierValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is STATICADDRESS. Requires purchase and installation of option SRI3C. + - This command sets or queries the string used for a LIN bus identifier value. The search + number is specified by x. The search condition must be IDENTIFIER or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the address value for which to search. The valid characters are 0, - 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the identifier value. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusI3cStatic(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic`` command tree. +class SearchSearchItemTriggerABusLinIdentifier(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusI3cStaticAddress( - device, f"{self._cmd_syntax}:ADDRess" + self._value = SearchSearchItemTriggerABusLinIdentifierValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def address(self) -> SearchSearchItemTriggerABusI3cStaticAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. + def value(self) -> SearchSearchItemTriggerABusLinIdentifierValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is STATICADDRESS. Requires purchase and installation of option - SRI3C. + - This command sets or queries the string used for a LIN bus identifier value. The + search number is specified by x. The search condition must be IDENTIFIER or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the address value for which to search. The valid characters - are 0, 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the identifier value. """ - return self._address + return self._value -class SearchSearchItemTriggerABusI3cStatebyteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. +class SearchSearchItemTriggerABusLinErrtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is STATEBYTE. Requires purchase and installation of option SRI3C. + - This command sets or queries the error type for a LIN bus search. The search number is + specified by x. The search condition must be set to ERROR. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE {CHecksum|PARity|SYNC} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ - - -class SearchSearchItemTriggerABusI3cStatebyte(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. + - ``CHecksum`` specifies the error type is checksum. + - ``PARity`` specifies the error type is parity. + - ``SYNC`` specifies the error type is sync. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cStatebyteValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusI3cStatebyteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. - - **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is STATEBYTE. Requires purchase and installation of option SRI3C. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue? - - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ - return self._value - -class SearchSearchItemTriggerABusI3cSaddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. +class SearchSearchItemTriggerABusLinDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C bus searchif the - trigger condition is SLAVEADDRESS. Requires purchase and installation of option SRI3C. + - This command sets or queries the data string used for a LIN bus search. The search number + is specified by x. The search condition must be DATA or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the address value for which to search. The valid characters are 0, - 1, or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. + - ```` specifies the data value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusI3cSaddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress`` command tree. +class SearchSearchItemTriggerABusLinDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + + **Description:** + - This command sets or queries the length of the stat string in bytes used for a LIN bus + search. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cSaddressValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusI3cSaddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. - - **Description:** - - This command sets or queries the binary field string used for the I3C bus searchif the - trigger condition is SLAVEADDRESS. Requires purchase and installation of option SRI3C. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue value`` command. - - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe? - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the address value for which to search. The valid characters - are 0, 1, or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. - """ - return self._value + **Info:** + - ```` specifies the data size. + """ -class SearchSearchItemTriggerABusI3cPackets(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets`` command. +class SearchSearchItemTriggerABusLinDataQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. **Description:** - - This command sets or queries the I3C Direct Packets to Direct or Response. Requires - purchase and installation of option SRI3C. + - This command sets or queries the data qualifier used in a LIN bus search. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets {RESPonse|DIRect} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier {EQual| LESSEQual| MOREEQual| UNEQual| LESSthan| MOREthan| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier? **Info:** - - ``Search`` specifies the search number. - - ``RESPonse`` specifies the packet address mode as Response. - - ``DIRect`` specifies the packet address mode as Direct. - """ + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. + """ # noqa: E501 -class SearchSearchItemTriggerABusI3cMaxwriteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. +class SearchSearchItemTriggerABusLinDataHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXWRITE. Requires purchase and installation of option SRI3C. + - This command sets or queries the high data value string used in a LIN bus search. The + search number is specified by x. The search condition must be DATA or IDANDDATA and the + data qualifier must be INRANGE or OUTRANGE. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` is a quoted string of 1s, 0s, or Xs representing the binary data string to + be used in a LIN search if the search condition is IDentifier or IDANDDATA (identifier and + data). """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusI3cMaxwrite(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe`` command tree. + +class SearchSearchItemTriggerABusLinData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cMaxwriteValue( - device, f"{self._cmd_syntax}:VALue" + self._hivalue = SearchSearchItemTriggerABusLinDataHivalue( + device, f"{self._cmd_syntax}:HIVALue" + ) + self._qualifier = SearchSearchItemTriggerABusLinDataQualifier( + device, f"{self._cmd_syntax}:QUALifier" ) + self._size = SearchSearchItemTriggerABusLinDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusLinDataValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusI3cMaxwriteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. + def hivalue(self) -> SearchSearchItemTriggerABusLinDataHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXWRITE. Requires purchase and installation of option SRI3C. + - This command sets or queries the high data value string used in a LIN bus search. The + search number is specified by x. The search condition must be DATA or IDANDDATA and + the data qualifier must be INRANGE or OUTRANGE. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` is a quoted string of 1s, 0s, or Xs representing the binary data string + to be used in a LIN search if the search condition is IDentifier or IDANDDATA + (identifier and data). """ - return self._value + return self._hivalue + @property + def qualifier(self) -> SearchSearchItemTriggerABusLinDataQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. -class SearchSearchItemTriggerABusI3cMaxrturnValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. + **Description:** + - This command sets or queries the data qualifier used in a LIN bus search. The search + number is specified by x. - **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXREADTURN. Requires purchase and installation of option SRI3C. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier {EQual| LESSEQual| MOREEQual| UNEQual| LESSthan| MOREthan| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier? - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue? + **Info:** + - ``EQual`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQual`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + - ``INrange`` sets the data qualifier to in range. + - ``OUTrange`` sets the data qualifier out of range. + """ # noqa: E501 + return self._qualifier - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ + @property + def size(self) -> SearchSearchItemTriggerABusLinDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + **Description:** + - This command sets or queries the length of the stat string in bytes used for a LIN bus + search. The search number is specified by x. -class SearchSearchItemTriggerABusI3cMaxrturn(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN?`` query and raise an AssertionError if the - returned value does not match ``value``. + **SCPI Syntax:** - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. - """ + :: - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cMaxrturnValue( - device, f"{self._cmd_syntax}:VALue" - ) + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe? + + **Info:** + - ```` specifies the data size. + """ + return self._size @property - def value(self) -> SearchSearchItemTriggerABusI3cMaxrturnValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusLinDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXREADTURN. Requires purchase and installation of option SRI3C. + - This command sets or queries the data string used for a LIN bus search. The search + number is specified by x. The search condition must be DATA or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the data value. """ return self._value -class SearchSearchItemTriggerABusI3cMaxreadValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. +class SearchSearchItemTriggerABusLinCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXREAD. Requires purchase and installation of option SRI3C. + - This command sets or queries the condition for a LIN bus search. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition {DATA|IDANDDATA|ERRor|IDentifier|SLEEP|SYNCfield|WAKEup} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. - """ + - ``DATA`` sets the trigger condition to data. + - ``IDANDDATA`` sets the trigger condition to ID and data. + - ``ERRor`` sets the trigger condition to error. + - ``IDentifier`` sets the trigger condition to identifier. + - ``SLEEP`` sets the trigger condition to sleep. + - ``SYNCfield`` sets the trigger condition to sync field. + - ``WAKEup`` sets the trigger condition to wakeup. + """ # noqa: E501 -class SearchSearchItemTriggerABusI3cMaxread(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD`` command tree. +class SearchSearchItemTriggerABusLin(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD?`` query and raise an AssertionError if the - returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN?`` + query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. + - ``.identifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cMaxreadValue( - device, f"{self._cmd_syntax}:VALue" + self._condition = SearchSearchItemTriggerABusLinCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusLinData(device, f"{self._cmd_syntax}:DATa") + self._errtype = SearchSearchItemTriggerABusLinErrtype(device, f"{self._cmd_syntax}:ERRTYPE") + self._identifier = SearchSearchItemTriggerABusLinIdentifier( + device, f"{self._cmd_syntax}:IDentifier" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cMaxreadValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. + def condition(self) -> SearchSearchItemTriggerABusLinCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is MAXREAD. Requires purchase and installation of option SRI3C. + - This command sets or queries the condition for a LIN bus search. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition {DATA|IDANDDATA|ERRor|IDentifier|SLEEP|SYNCfield|WAKEup} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:CONDition? **Info:** - - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ``DATA`` sets the trigger condition to data. + - ``IDANDDATA`` sets the trigger condition to ID and data. + - ``ERRor`` sets the trigger condition to error. + - ``IDentifier`` sets the trigger condition to identifier. + - ``SLEEP`` sets the trigger condition to sleep. + - ``SYNCfield`` sets the trigger condition to sync field. + - ``WAKEup`` sets the trigger condition to wakeup. + """ # noqa: E501 + return self._condition + + @property + def data(self) -> SearchSearchItemTriggerABusLinData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:HIVALue`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:DATa:VALue`` command. """ - return self._value + return self._data + @property + def errtype(self) -> SearchSearchItemTriggerABusLinErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE`` command. -class SearchSearchItemTriggerABusI3cInaccbyteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. + **Description:** + - This command sets or queries the error type for a LIN bus search. The search number is + specified by x. The search condition must be set to ERROR. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE {CHecksum|PARity|SYNC} + - SEARCH:SEARCH:TRIGger:A:BUS:LIN:ERRTYPE? + + **Info:** + - ``CHecksum`` specifies the error type is checksum. + - ``PARity`` specifies the error type is parity. + - ``SYNC`` specifies the error type is sync. + """ + return self._errtype + + @property + def identifier(self) -> SearchSearchItemTriggerABusLinIdentifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:LIN:IDentifier:VALue`` command. + """ + return self._identifier + + +class SearchSearchItemTriggerABusI3cTestmodeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is INACCURACYBYTE. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is TESTMODE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27257,50 +28104,49 @@ class SearchSearchItemTriggerABusI3cInaccbyteValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cInaccbyte(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe`` command tree. +class SearchSearchItemTriggerABusI3cTestmode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cInaccbyteValue( + self._value = SearchSearchItemTriggerABusI3cTestmodeValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cInaccbyteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cTestmodeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is INACCURACYBYTE. Requires purchase and installation of option - SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is TESTMODE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:TESTMODe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27310,28 +28156,28 @@ def value(self) -> SearchSearchItemTriggerABusI3cInaccbyteValue: return self._value -class SearchSearchItemTriggerABusI3cIdValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. +class SearchSearchItemTriggerABusI3cSupportbyteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is ENTDAA packet ID. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SUPPORTEDBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27340,48 +28186,50 @@ class SearchSearchItemTriggerABusI3cIdValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cId(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID`` command tree. +class SearchSearchItemTriggerABusI3cSupportbyte(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cIdValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cSupportbyteValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cIdValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cSupportbyteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is ENTDAA packet ID. Requires purchase and installation of option + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SUPPORTEDBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SUPPORTBYTe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27391,108 +28239,111 @@ def value(self) -> SearchSearchItemTriggerABusI3cIdValue: return self._value -class SearchSearchItemTriggerABusI3cGsmsbValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. +class SearchSearchItemTriggerABusI3cStaticAddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is GETSTATUSMSB. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is STATICADDRESS. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess? **Info:** - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the address value for which to search. The valid characters are 0, + 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cGsmsb(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb`` command tree. +class SearchSearchItemTriggerABusI3cStatic(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cGsmsbValue(device, f"{self._cmd_syntax}:VALue") + self._address = SearchSearchItemTriggerABusI3cStaticAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cGsmsbValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. + def address(self) -> SearchSearchItemTriggerABusI3cStaticAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is GETSTATUSMSB. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is STATICADDRESS. Requires purchase and installation of option + SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATic:ADDRess? **Info:** - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the address value for which to search. The valid characters + are 0, 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ - return self._value + return self._address -class SearchSearchItemTriggerABusI3cGslsbValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. +class SearchSearchItemTriggerABusI3cStatebyteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is GETSTATUSLSB. Requires purchase and installation of option SRI3C. + trigger condition is STATEBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27501,47 +28352,49 @@ class SearchSearchItemTriggerABusI3cGslsbValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cGslsb(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb`` command tree. +class SearchSearchItemTriggerABusI3cStatebyte(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cGslsbValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cStatebyteValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cGslsbValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cStatebyteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is GETSTATUSLSB. Requires purchase and installation of option SRI3C. + trigger condition is STATEBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:STATEBYTe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27551,111 +28404,142 @@ def value(self) -> SearchSearchItemTriggerABusI3cGslsbValue: return self._value -class SearchSearchItemTriggerABusI3cFreqbyteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. +class SearchSearchItemTriggerABusI3cSaddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is FREQUENCYBYTE. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C bus searchif the + trigger condition is SLAVEADDRESS. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the address value for which to search. The valid characters are 0, + 1, or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusI3cFreqbyte(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe`` command tree. +class SearchSearchItemTriggerABusI3cSaddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cFreqbyteValue( + self._value = SearchSearchItemTriggerABusI3cSaddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cFreqbyteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cSaddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is FREQUENCYBYTE. Requires purchase and installation of option - SRI3C. + - This command sets or queries the binary field string used for the I3C bus searchif the + trigger condition is SLAVEADDRESS. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:SADDress:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the address value for which to search. The valid characters + are 0, 1, or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. """ return self._value -class SearchSearchItemTriggerABusI3cEventbyteValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. +class SearchSearchItemTriggerABusI3cPackets(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets`` command. + + **Description:** + - This command sets or queries the I3C Direct Packets to Direct or Response. Requires + purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets {RESPonse|DIRect} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:PACKets? + + **Info:** + - ``Search`` specifies the search number. + - ``RESPonse`` specifies the packet address mode as Response. + - ``DIRect`` specifies the packet address mode as Direct. + """ + + +class SearchSearchItemTriggerABusI3cMaxwriteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is EVENTBYTE. Requires purchase and installation of option SRI3C. + trigger condition is MAXWRITE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27664,49 +28548,49 @@ class SearchSearchItemTriggerABusI3cEventbyteValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cEventbyte(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe`` command tree. +class SearchSearchItemTriggerABusI3cMaxwrite(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cEventbyteValue( + self._value = SearchSearchItemTriggerABusI3cMaxwriteValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cEventbyteValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cMaxwriteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is EVENTBYTE. Requires purchase and installation of option SRI3C. + trigger condition is MAXWRITE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXWRITe:VALue? **Info:** - ``Search`` specifies the search number. @@ -27716,63 +28600,110 @@ def value(self) -> SearchSearchItemTriggerABusI3cEventbyteValue: return self._value -class SearchSearchItemTriggerABusI3cErrortype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe`` command. +class SearchSearchItemTriggerABusI3cMaxrturnValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. **Description:** - - This command sets or queries the error type condition for the specified I3C bus search to - determine where to place a mark. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is MAXREADTURN. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe {NACK|TBIT|PARity| BADDr|DADDr|PREamble|CRC} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue? **Info:** - ``Search`` specifies the search number. - - ``NACK`` specifies the error type on which to search as Missing Ack. - - ``TBIT`` specifies the error type on which to search as T-Bit. - - ``PARity`` specifies the error type on which to search as Parity. - - ``BADDr`` specifies the error type on which to search as Broadcast Address. - - ``DADDr`` specifies the error type on which to search as Dynamic Address. - - ``PREamble`` specifies the error type on which to search as Preamble. - - ``CRC`` specifies the error type on which to search as CRC. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cDwordValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. +class SearchSearchItemTriggerABusI3cMaxrturn(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cMaxrturnValue( + device, f"{self._cmd_syntax}:VALue" + ) + + @property + def value(self) -> SearchSearchItemTriggerABusI3cMaxrturnValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is MAXREADTURN. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXRTURN:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cMaxreadValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is DATAWORDS. Requires purchase and installation of option SRI3C. + trigger condition is MAXREAD. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue? **Info:** - ``Search`` specifies the search number. @@ -27781,47 +28712,49 @@ class SearchSearchItemTriggerABusI3cDwordValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cDword(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd`` command tree. +class SearchSearchItemTriggerABusI3cMaxread(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cDwordValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cMaxreadValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cDwordValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cMaxreadValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is DATAWORDS. Requires purchase and installation of option SRI3C. + trigger condition is MAXREAD. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:MAXREAD:VALue? **Info:** - ``Search`` specifies the search number. @@ -27831,110 +28764,111 @@ def value(self) -> SearchSearchItemTriggerABusI3cDwordValue: return self._value -class SearchSearchItemTriggerABusI3cDcrtypeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. +class SearchSearchItemTriggerABusI3cInaccbyteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C bus search if the - trigger condition is DCRTYPE. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is INACCURACYBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the data value for which to search. The valid characters are 0, 1, - or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cDcrtype(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType`` command tree. +class SearchSearchItemTriggerABusI3cInaccbyte(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cDcrtypeValue( + self._value = SearchSearchItemTriggerABusI3cInaccbyteValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cDcrtypeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cInaccbyteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C bus search if - the trigger condition is DCRTYPE. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is INACCURACYBYTE. Requires purchase and installation of option + SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:INACCBYTe:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the data value for which to search. The valid characters are - 0, 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ return self._value -class SearchSearchItemTriggerABusI3cDcrValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. +class SearchSearchItemTriggerABusI3cIdValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C bus search if the - trigger condition is DCR. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is ENTDAA packet ID. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue? **Info:** - ``Search`` specifies the search number. @@ -27943,47 +28877,48 @@ class SearchSearchItemTriggerABusI3cDcrValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cDcr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR`` command tree. +class SearchSearchItemTriggerABusI3cId(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cDcrValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cIdValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusI3cDcrValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cIdValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C bus search if - the trigger condition is DCR. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is ENTDAA packet ID. Requires purchase and installation of option + SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ID:VALue? **Info:** - ``Search`` specifies the search number. @@ -27993,366 +28928,388 @@ def value(self) -> SearchSearchItemTriggerABusI3cDcrValue: return self._value -class SearchSearchItemTriggerABusI3cDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. +class SearchSearchItemTriggerABusI3cGsmsbValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. **Description:** - - This command sets or queries the data value of the data token for the specified I3C bus - trigger search to determine where to place a mark. Requires purchase and installation of - option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is GETSTATUSMSB. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the data value. The valid characters are 0, 1, or X for Binary - format; and A-F, 0-9, and X for Hexadecimal format. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. - - **Description:** - - This command sets or queries the length of the data string in bytes used for the specified - I3C bus trigger search to determine where to place a mark. Requires purchase and - installation of option SRI3C. +class SearchSearchItemTriggerABusI3cGsmsb(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe value`` command. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cGsmsbValue(device, f"{self._cmd_syntax}:VALue") - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe? + @property + def value(self) -> SearchSearchItemTriggerABusI3cGsmsbValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue`` command. - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the data size in bytes. - """ + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is GETSTATUSMSB. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue value`` command. + **SCPI Syntax:** -class SearchSearchItemTriggerABusI3cDataDirection(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSMSb:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cGslsbValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. **Description:** - - This command sets or queries the direction of the data for the I3C bus trigger search to - determine where to place a mark. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is GETSTATUSLSB. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection {NOCARE|READ|WRITE} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue? **Info:** - ``Search`` specifies the search number. - - ``NOCARE`` specifies the data direction for which to search is Don't Care. - - ``READ`` specifies the data direction for which to search is Read. - - ``WRITE`` specifies the data direction for which to search is Write. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa`` command tree. +class SearchSearchItemTriggerABusI3cGslsb(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._direction = SearchSearchItemTriggerABusI3cDataDirection( - device, f"{self._cmd_syntax}:DIRection" - ) - self._size = SearchSearchItemTriggerABusI3cDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusI3cDataValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cGslsbValue(device, f"{self._cmd_syntax}:VALue") @property - def direction(self) -> SearchSearchItemTriggerABusI3cDataDirection: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. + def value(self) -> SearchSearchItemTriggerABusI3cGslsbValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue`` command. **Description:** - - This command sets or queries the direction of the data for the I3C bus trigger search - to determine where to place a mark. Requires purchase and installation of option - SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is GETSTATUSLSB. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection {NOCARE|READ|WRITE} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:GSLSb:VALue? **Info:** - ``Search`` specifies the search number. - - ``NOCARE`` specifies the data direction for which to search is Don't Care. - - ``READ`` specifies the data direction for which to search is Read. - - ``WRITE`` specifies the data direction for which to search is Write. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ - return self._direction + return self._value - @property - def size(self) -> SearchSearchItemTriggerABusI3cDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. - **Description:** - - This command sets or queries the length of the data string in bytes used for the - specified I3C bus trigger search to determine where to place a mark. Requires purchase - and installation of option SRI3C. +class SearchSearchItemTriggerABusI3cFreqbyteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe value`` command. + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is FREQUENCYBYTE. Requires purchase and installation of option SRI3C. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe? + :: - **Info:** - - ``Search`` specifies the search number. - - ```` specifies the data size in bytes. - """ - return self._size + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + + +class SearchSearchItemTriggerABusI3cFreqbyte(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cFreqbyteValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cFreqbyteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue`` command. **Description:** - - This command sets or queries the data value of the data token for the specified I3C - bus trigger search to determine where to place a mark. Requires purchase and - installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is FREQUENCYBYTE. Requires purchase and installation of option + SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:FREQBYTe:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the data value. The valid characters are 0, 1, or X for Binary - format; and A-F, 0-9, and X for Hexadecimal format. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ return self._value -class SearchSearchItemTriggerABusI3cCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition`` command. - - **Description:** - - This command sets or queries the trigger condition for the specified I3C bus trigger - search to determine where to place a mark. Requires purchase and installation of option - SRI3C. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition {STARt|REPEATStart|ADDRess|DATa| SDRDirect|SDRBroadcast|DDR|ERRors|HOTJoin| DMSGEnd|BMSGEnd|HDRRestart|HDRExit} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition? - - **Info:** - - ``Search`` specifies the search number. - - ``STARt`` specifies trigger condition as Start. - - ``REPEATStart`` specifies trigger condition as Repeated Start. - - ``ADDRess`` specifies trigger condition as Address. - - ``DATa`` specifies trigger condition as Data. - - ``SDRDirect`` specifies trigger condition as I3C SDR Direct. - - ``SDRBroadcast`` specifies trigger condition as I3C SDR Broadcast. - - ``DDR`` specifies trigger condition as DDR. - - ``ERRors`` specifies trigger condition as Errors. - - ``HOTJoin`` specifies trigger condition as Hot-Join. - - ``DMSGEnd`` specifies trigger condition as Direct Message End. - - ``BMSGEnd`` specifies trigger condition as Stop. - - ``HDRRestart`` specifies trigger condition as HDR Restart. - - ``HDRExit`` specifies trigger condition as HDR Exit. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusI3cCcodeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. +class SearchSearchItemTriggerABusI3cEventbyteValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option - SRI3C. + trigger condition is EVENTBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue? **Info:** - ``Search`` specifies the search number. - ```` specifies the value for which to search. The valid characters are 0, 1, or X - for Binary format; and A-F, 0-9, and X for Hexadecimal format. + for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cCcode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe`` command tree. +class SearchSearchItemTriggerABusI3cEventbyte(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cCcodeValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cEventbyteValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusI3cCcodeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cEventbyteValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option - SRI3C. + trigger condition is EVENTBYTE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:EVENTBYTe:VALue? **Info:** - ``Search`` specifies the search number. - ```` specifies the value for which to search. The valid characters are 0, 1, - or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. """ return self._value -class SearchSearchItemTriggerABusI3cBrgtidValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. +class SearchSearchItemTriggerABusI3cErrortype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe`` command. + + **Description:** + - This command sets or queries the error type condition for the specified I3C bus search to + determine where to place a mark. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe {NACK|TBIT|PARity| BADDr|DADDr|PREamble|CRC} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ERRORTYPe? + + **Info:** + - ``Search`` specifies the search number. + - ``NACK`` specifies the error type on which to search as Missing Ack. + - ``TBIT`` specifies the error type on which to search as T-Bit. + - ``PARity`` specifies the error type on which to search as Parity. + - ``BADDr`` specifies the error type on which to search as Broadcast Address. + - ``DADDr`` specifies the error type on which to search as Dynamic Address. + - ``PREamble`` specifies the error type on which to search as Preamble. + - ``CRC`` specifies the error type on which to search as CRC. + """ + + +class SearchSearchItemTriggerABusI3cDwordValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option - SRI3C. + trigger condition is DATAWORDS. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue? **Info:** - ``Search`` specifies the search number. @@ -28361,48 +29318,47 @@ class SearchSearchItemTriggerABusI3cBrgtidValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cBrgtid(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID`` command tree. +class SearchSearchItemTriggerABusI3cDword(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cBrgtidValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cDwordValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusI3cBrgtidValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cDwordValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C trigger if the - trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option - SRI3C. + trigger condition is DATAWORDS. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DWORd:VALue? **Info:** - ``Search`` specifies the search number. @@ -28412,58 +29368,28 @@ def value(self) -> SearchSearchItemTriggerABusI3cBrgtidValue: return self._value -class SearchSearchItemTriggerABusI3cBpackets(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets`` command. - - **Description:** - - This command sets or queries the I3C Broadcast Packets search to Broadcast or Response. - Requires purchase and installation of option SRI3C. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets {RESPonse|BROadcast} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets? - - **Info:** - - ``Search`` specifies the search number. - - ``RESPonse`` specifies the broadcast address mode as Response. - - ``BROadcast`` specifies the broadcast address mode as Broadcast. - """ - - -class SearchSearchItemTriggerABusI3cBcrtypeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. +class SearchSearchItemTriggerABusI3cDcrtypeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C bus search if the - trigger condition is BCRTYPE. Requires purchase and installation of option SRI3C. + trigger condition is DCRTYPE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue? **Info:** - ``Search`` specifies the search number. @@ -28472,49 +29398,49 @@ class SearchSearchItemTriggerABusI3cBcrtypeValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cBcrtype(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType`` command tree. +class SearchSearchItemTriggerABusI3cDcrtype(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cBcrtypeValue( + self._value = SearchSearchItemTriggerABusI3cDcrtypeValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusI3cBcrtypeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cDcrtypeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue`` command. **Description:** - This command sets or queries the binary field string used for the I3C bus search if - the trigger condition is BCRTYPE. Requires purchase and installation of option SRI3C. + the trigger condition is DCRTYPE. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCRType:VALue? **Info:** - ``Search`` specifies the search number. @@ -28524,28 +29450,28 @@ def value(self) -> SearchSearchItemTriggerABusI3cBcrtypeValue: return self._value -class SearchSearchItemTriggerABusI3cBcrValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. +class SearchSearchItemTriggerABusI3cDcrValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is BCR. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C bus search if the + trigger condition is DCR. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue? **Info:** - ``Search`` specifies the search number. @@ -28554,47 +29480,47 @@ class SearchSearchItemTriggerABusI3cBcrValue(SCPICmdWrite, SCPICmdRead): """ -class SearchSearchItemTriggerABusI3cBcr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR`` command tree. +class SearchSearchItemTriggerABusI3cDcr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusI3cBcrValue(device, f"{self._cmd_syntax}:VALue") + self._value = SearchSearchItemTriggerABusI3cDcrValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusI3cBcrValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusI3cDcrValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue`` command. **Description:** - - This command sets or queries the binary field string used for the I3C search if the - trigger condition is BCR. Requires purchase and installation of option SRI3C. + - This command sets or queries the binary field string used for the I3C bus search if + the trigger condition is DCR. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DCR:VALue? **Info:** - ``Search`` specifies the search number. @@ -28604,145 +29530,756 @@ def value(self) -> SearchSearchItemTriggerABusI3cBcrValue: return self._value -class SearchSearchItemTriggerABusI3cAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusI3cDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. **Description:** - - This command sets or queries the I3C address value for which to search, to determine where - to place a search mark. Requires purchase and installation of option SRI3C. + - This command sets or queries the data value of the data token for the specified I3C bus + trigger search to determine where to place a mark. Requires purchase and installation of + option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue? **Info:** - ``Search`` specifies the search number. - - ```` specifies the address value for the specified Search . This is either a - 7-bit or 10-bit value depending on the address mode. The valid characters are 0-9, A-F, - and X for Hexadecimal address format; and 0, 1, and X (don't care) for Binary address - format. + - ```` specifies the data value. The valid characters are 0, 1, or X for Binary + format; and A-F, 0-9, and X for Hexadecimal format. """ -class SearchSearchItemTriggerABusI3cAddressMode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. +class SearchSearchItemTriggerABusI3cDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. **Description:** - - This command sets or queries the address mode for the specified I3C bus trigger search to - determine where to place a search mark. Requires purchase and installation of option - SRI3C. + - This command sets or queries the length of the data string in bytes used for the specified + I3C bus trigger search to determine where to place a mark. Requires purchase and + installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe {ADDR10|ADDR7} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe? **Info:** - ``Search`` specifies the search number. - - ``ADDR10`` specifies the address mode as ADDR10. - - ``ADDR7`` specifies the address mode as ADDR7. + - ```` specifies the data size in bytes. """ -class SearchSearchItemTriggerABusI3cAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess`` command tree. +class SearchSearchItemTriggerABusI3cDataDirection(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. + + **Description:** + - This command sets or queries the direction of the data for the I3C bus trigger search to + determine where to place a mark. Requires purchase and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection {NOCARE|READ|WRITE} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection? + + **Info:** + - ``Search`` specifies the search number. + - ``NOCARE`` specifies the data direction for which to search is Don't Care. + - ``READ`` specifies the data direction for which to search is Read. + - ``WRITE`` specifies the data direction for which to search is Write. + """ + + +class SearchSearchItemTriggerABusI3cData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. + - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._mode = SearchSearchItemTriggerABusI3cAddressMode(device, f"{self._cmd_syntax}:MODe") - self._value = SearchSearchItemTriggerABusI3cAddressValue( - device, f"{self._cmd_syntax}:VALue" + self._direction = SearchSearchItemTriggerABusI3cDataDirection( + device, f"{self._cmd_syntax}:DIRection" ) + self._size = SearchSearchItemTriggerABusI3cDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusI3cDataValue(device, f"{self._cmd_syntax}:VALue") @property - def mode(self) -> SearchSearchItemTriggerABusI3cAddressMode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. + def direction(self) -> SearchSearchItemTriggerABusI3cDataDirection: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection`` command. **Description:** - - This command sets or queries the address mode for the specified I3C bus trigger search - to determine where to place a search mark. Requires purchase and installation of - option SRI3C. + - This command sets or queries the direction of the data for the I3C bus trigger search + to determine where to place a mark. Requires purchase and installation of option + SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe {ADDR10|ADDR7} - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe? + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection {NOCARE|READ|WRITE} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:DIRection? **Info:** - ``Search`` specifies the search number. - - ``ADDR10`` specifies the address mode as ADDR10. - - ``ADDR7`` specifies the address mode as ADDR7. + - ``NOCARE`` specifies the data direction for which to search is Don't Care. + - ``READ`` specifies the data direction for which to search is Read. + - ``WRITE`` specifies the data direction for which to search is Write. """ - return self._mode + return self._direction @property - def value(self) -> SearchSearchItemTriggerABusI3cAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusI3cDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe`` command. **Description:** - - This command sets or queries the I3C address value for which to search, to determine - where to place a search mark. Requires purchase and installation of option SRI3C. + - This command sets or queries the length of the data string in bytes used for the + specified I3C bus trigger search to determine where to place a mark. Requires purchase + and installation of option SRI3C. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:SIZe? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the data size in bytes. + """ + return self._size + + @property + def value(self) -> SearchSearchItemTriggerABusI3cDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue`` command. + + **Description:** + - This command sets or queries the data value of the data token for the specified I3C + bus trigger search to determine where to place a mark. Requires purchase and + installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:DATa:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the data value. The valid characters are 0, 1, or X for Binary + format; and A-F, 0-9, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for the specified I3C bus trigger + search to determine where to place a mark. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition {STARt|REPEATStart|ADDRess|DATa| SDRDirect|SDRBroadcast|DDR|ERRors|HOTJoin| DMSGEnd|BMSGEnd|HDRRestart|HDRExit} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CONDition? + + **Info:** + - ``Search`` specifies the search number. + - ``STARt`` specifies trigger condition as Start. + - ``REPEATStart`` specifies trigger condition as Repeated Start. + - ``ADDRess`` specifies trigger condition as Address. + - ``DATa`` specifies trigger condition as Data. + - ``SDRDirect`` specifies trigger condition as I3C SDR Direct. + - ``SDRBroadcast`` specifies trigger condition as I3C SDR Broadcast. + - ``DDR`` specifies trigger condition as DDR. + - ``ERRors`` specifies trigger condition as Errors. + - ``HOTJoin`` specifies trigger condition as Hot-Join. + - ``DMSGEnd`` specifies trigger condition as Direct Message End. + - ``BMSGEnd`` specifies trigger condition as Stop. + - ``HDRRestart`` specifies trigger condition as HDR Restart. + - ``HDRExit`` specifies trigger condition as HDR Exit. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusI3cCcodeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and A-F, 0-9, and X for Hexadecimal format. + """ + + +class SearchSearchItemTriggerABusI3cCcode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cCcodeValue(device, f"{self._cmd_syntax}:VALue") + + @property + def value(self) -> SearchSearchItemTriggerABusI3cCcodeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:CCODe:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and A-F, 0-9, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cBrgtidValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + + +class SearchSearchItemTriggerABusI3cBrgtid(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cBrgtidValue(device, f"{self._cmd_syntax}:VALue") + + @property + def value(self) -> SearchSearchItemTriggerABusI3cBrgtidValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C trigger if the + trigger condition is SETBRGTGT packet ID. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BRGTID:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cBpackets(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets`` command. + + **Description:** + - This command sets or queries the I3C Broadcast Packets search to Broadcast or Response. + Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets {RESPonse|BROadcast} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BPACKets? + + **Info:** + - ``Search`` specifies the search number. + - ``RESPonse`` specifies the broadcast address mode as Response. + - ``BROadcast`` specifies the broadcast address mode as Broadcast. + """ + + +class SearchSearchItemTriggerABusI3cBcrtypeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C bus search if the + trigger condition is BCRTYPE. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the data value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + + +class SearchSearchItemTriggerABusI3cBcrtype(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cBcrtypeValue( + device, f"{self._cmd_syntax}:VALue" + ) + + @property + def value(self) -> SearchSearchItemTriggerABusI3cBcrtypeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C bus search if + the trigger condition is BCRTYPE. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCRType:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the data value for which to search. The valid characters are + 0, 1, or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cBcrValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is BCR. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, or X + for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + + +class SearchSearchItemTriggerABusI3cBcr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusI3cBcrValue(device, f"{self._cmd_syntax}:VALue") + + @property + def value(self) -> SearchSearchItemTriggerABusI3cBcrValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue`` command. + + **Description:** + - This command sets or queries the binary field string used for the I3C search if the + trigger condition is BCR. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:BCR:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the value for which to search. The valid characters are 0, 1, + or X for Binary format; and 0-9, A-F, and X for Hexadecimal format. + """ + return self._value + + +class SearchSearchItemTriggerABusI3cAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. + + **Description:** + - This command sets or queries the I3C address value for which to search, to determine where + to place a search mark. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue? + + **Info:** + - ``Search`` specifies the search number. + - ```` specifies the address value for the specified Search . This is either a + 7-bit or 10-bit value depending on the address mode. The valid characters are 0-9, A-F, + and X for Hexadecimal address format; and 0, 1, and X (don't care) for Binary address + format. + """ + + +class SearchSearchItemTriggerABusI3cAddressMode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. + + **Description:** + - This command sets or queries the address mode for the specified I3C bus trigger search to + determine where to place a search mark. Requires purchase and installation of option + SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe {ADDR10|ADDR7} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe? + + **Info:** + - ``Search`` specifies the search number. + - ``ADDR10`` specifies the address mode as ADDR10. + - ``ADDR7`` specifies the address mode as ADDR7. + """ + + +class SearchSearchItemTriggerABusI3cAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._mode = SearchSearchItemTriggerABusI3cAddressMode(device, f"{self._cmd_syntax}:MODe") + self._value = SearchSearchItemTriggerABusI3cAddressValue( + device, f"{self._cmd_syntax}:VALue" + ) + + @property + def mode(self) -> SearchSearchItemTriggerABusI3cAddressMode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe`` command. + + **Description:** + - This command sets or queries the address mode for the specified I3C bus trigger search + to determine where to place a search mark. Requires purchase and installation of + option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe {ADDR10|ADDR7} + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:MODe? + + **Info:** + - ``Search`` specifies the search number. + - ``ADDR10`` specifies the address mode as ADDR10. + - ``ADDR7`` specifies the address mode as ADDR7. + """ + return self._mode + + @property + def value(self) -> SearchSearchItemTriggerABusI3cAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue`` command. + + **Description:** + - This command sets or queries the I3C address value for which to search, to determine + where to place a search mark. Requires purchase and installation of option SRI3C. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue - SEARCH:SEARCH:TRIGger:A:BUS:I3C:ADDRess:VALue? **Info:** @@ -30561,4745 +32098,3963 @@ class SearchSearchItemTriggerABusFlexrayDataSize(SCPICmdWrite, SCPICmdRead): class SearchSearchItemTriggerABusFlexrayDataQualifier(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. - **Description:** - - This command sets or queries the qualifier to be used when searching on a FlexRay bus - signal. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier? - - **Info:** - - ``EQUal`` specifies the qualifier as equal. - - ``LESSEQual`` specifies the qualifier as less equal. - - ``MOREEQual`` specifies the qualifier as more equal. - - ``UNEQual`` specifies the qualifier as unequal. - - ``LESSthan`` specifies the qualifier as less than. - - ``MOREthan`` specifies the qualifier as more than. - - ``INrange`` specifies the qualifier as in range. - - ``OUTrange`` specifies the qualifier as out of range. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusFlexrayDataOffset(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. - - **Description:** - - This command sets or queries the offset of the data string, in bytes, when searching on a - FlexRay bus data field. The search number is specified by x. The search condition must be - set to IDANDDATA OR DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet? - - **Info:** - - ```` specifies the data offset in bytes. A setting of X/Don't care is accomplished by - setting the offset to -1. - """ - - -class SearchSearchItemTriggerABusFlexrayDataHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. - - **Description:** - - This command sets or queries the high value when searching on a FlexRay bus data field. - The search number is specified by x. The search condition must be set to IDANDDATA OR - DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue? - - **Info:** - - ```` specifies the data value. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusFlexrayData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusFlexrayDataHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._offset = SearchSearchItemTriggerABusFlexrayDataOffset( - device, f"{self._cmd_syntax}:OFFSet" - ) - self._qualifier = SearchSearchItemTriggerABusFlexrayDataQualifier( - device, f"{self._cmd_syntax}:QUALifier" - ) - self._size = SearchSearchItemTriggerABusFlexrayDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusFlexrayDataValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def hivalue(self) -> SearchSearchItemTriggerABusFlexrayDataHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. - - **Description:** - - This command sets or queries the high value when searching on a FlexRay bus data - field. The search number is specified by x. The search condition must be set to - IDANDDATA OR DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue? - - **Info:** - - ```` specifies the data value. - """ - return self._hivalue - - @property - def offset(self) -> SearchSearchItemTriggerABusFlexrayDataOffset: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. - - **Description:** - - This command sets or queries the offset of the data string, in bytes, when searching - on a FlexRay bus data field. The search number is specified by x. The search condition - must be set to IDANDDATA OR DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet? - - **Info:** - - ```` specifies the data offset in bytes. A setting of X/Don't care is - accomplished by setting the offset to -1. - """ - return self._offset - - @property - def qualifier(self) -> SearchSearchItemTriggerABusFlexrayDataQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. - - **Description:** - - This command sets or queries the qualifier to be used when searching on a FlexRay bus - signal. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier? - - **Info:** - - ``EQUal`` specifies the qualifier as equal. - - ``LESSEQual`` specifies the qualifier as less equal. - - ``MOREEQual`` specifies the qualifier as more equal. - - ``UNEQual`` specifies the qualifier as unequal. - - ``LESSthan`` specifies the qualifier as less than. - - ``MOREthan`` specifies the qualifier as more than. - - ``INrange`` specifies the qualifier as in range. - - ``OUTrange`` specifies the qualifier as out of range. - """ # noqa: E501 - return self._qualifier - - @property - def size(self) -> SearchSearchItemTriggerABusFlexrayDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. - - **Description:** - - This command sets or queries the length of the data string, in bytes, to be used when - searching on a FlexRay bus data field. The search number is specified by x. The search - condition must be set to IDANDDATA OR DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe? - - **Info:** - - ```` specifies the data size in bytes. A data size of -1 is don't care. - """ - return self._size - - @property - def value(self) -> SearchSearchItemTriggerABusFlexrayDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. - - **Description:** - - This command sets or queries the low value to be used when searching on a FlexRay bus - data field. The search number is specified by x. The search condition must be set to - IDANDDATA or DATA. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue? - - **Info:** - - ```` specifies the data value. - """ - return self._value - - -class SearchSearchItemTriggerABusFlexrayCyclecountValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. - - **Description:** - - This command sets or queries the low value when searching on a FlexRay bus cycle count - field. The search number is specified by x. The search condition must be set to - CYCLEcount. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue? - - **Info:** - - ```` specifies the cycle count value. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusFlexrayCyclecountQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` command. - - **Description:** - - This command sets or queries the qualifier to be used when searching on a FlexRay bus - search cycle count field. The search number is specified by x. The search condition must - be set to CYCLEcount. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier? - - **Info:** - - ``EQUal`` specifies the qualifier as equal. - - ``LESSEQual`` specifies the qualifier as less equal. - - ``MOREEQual`` specifies the qualifier as more equal. - - ``UNEQual`` specifies the qualifier as unequal. - - ``LESSthan`` specifies the qualifier as less than. - - ``MOREthan`` specifies the qualifier as more than. - - ``INrange`` specifies the qualifier as in range. - - ``OUTrange`` specifies the qualifier as out of range. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusFlexrayCyclecountHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. - - **Description:** - - This command sets or queries the heigh value when searching on a FlexRay bus cycle count - field. The search number is specified by x. The search condition must be set to - CYCLEcount. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue? - - **Info:** - - ```` specifies the cycle count value. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusFlexrayCyclecount(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusFlexrayCyclecountHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._qualifier = SearchSearchItemTriggerABusFlexrayCyclecountQualifier( - device, f"{self._cmd_syntax}:QUALifier" - ) - self._value = SearchSearchItemTriggerABusFlexrayCyclecountValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def hivalue(self) -> SearchSearchItemTriggerABusFlexrayCyclecountHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. - - **Description:** - - This command sets or queries the heigh value when searching on a FlexRay bus cycle - count field. The search number is specified by x. The search condition must be set to - CYCLEcount. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue? - - **Info:** - - ```` specifies the cycle count value. - """ - return self._hivalue - - @property - def qualifier(self) -> SearchSearchItemTriggerABusFlexrayCyclecountQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` command. + **Description:** + - This command sets or queries the qualifier to be used when searching on a FlexRay bus + signal. The search number is specified by x. - **Description:** - - This command sets or queries the qualifier to be used when searching on a FlexRay bus - search cycle count field. The search number is specified by x. The search condition - must be set to CYCLEcount. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier? - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier? + **Info:** + - ``EQUal`` specifies the qualifier as equal. + - ``LESSEQual`` specifies the qualifier as less equal. + - ``MOREEQual`` specifies the qualifier as more equal. + - ``UNEQual`` specifies the qualifier as unequal. + - ``LESSthan`` specifies the qualifier as less than. + - ``MOREthan`` specifies the qualifier as more than. + - ``INrange`` specifies the qualifier as in range. + - ``OUTrange`` specifies the qualifier as out of range. + """ # noqa: E501 - **Info:** - - ``EQUal`` specifies the qualifier as equal. - - ``LESSEQual`` specifies the qualifier as less equal. - - ``MOREEQual`` specifies the qualifier as more equal. - - ``UNEQual`` specifies the qualifier as unequal. - - ``LESSthan`` specifies the qualifier as less than. - - ``MOREthan`` specifies the qualifier as more than. - - ``INrange`` specifies the qualifier as in range. - - ``OUTrange`` specifies the qualifier as out of range. - """ # noqa: E501 - return self._qualifier - @property - def value(self) -> SearchSearchItemTriggerABusFlexrayCyclecountValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. +class SearchSearchItemTriggerABusFlexrayDataOffset(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. - **Description:** - - This command sets or queries the low value when searching on a FlexRay bus cycle count - field. The search number is specified by x. The search condition must be set to - CYCLEcount. + **Description:** + - This command sets or queries the offset of the data string, in bytes, when searching on a + FlexRay bus data field. The search number is specified by x. The search condition must be + set to IDANDDATA OR DATA. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet? - **Info:** - - ```` specifies the cycle count value. - """ - return self._value + **Info:** + - ```` specifies the data offset in bytes. A setting of X/Don't care is accomplished by + setting the offset to -1. + """ -class SearchSearchItemTriggerABusFlexrayCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. +class SearchSearchItemTriggerABusFlexrayDataHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. **Description:** - - This command sets or queries the FlexRay bus search condition. The search number is - specified by x. + - This command sets or queries the high value when searching on a FlexRay bus data field. + The search number is specified by x. The search condition must be set to IDANDDATA OR + DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition {SOF| FRAMEType| IDentifier| CYCLEcount| HEADer| DATA| IDANDDATA| EOF| ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue? **Info:** - - ``SOF`` sets the trigger condition to start of frame. - - ``FRAMEType`` sets the trigger condition to frame type. - - ``IDentifier`` sets the trigger condition to identifier. - - ``CYCLEcount`` sets the trigger condition to cycle count. - - ``HEADer`` sets the trigger condition to header. - - ``DATA`` sets the trigger condition to data. - - ``IDANDDATA`` sets the trigger condition to ID and data. - - ``EOF`` sets the trigger condition to end of frame. - - ``ERRor`` sets the trigger condition to error. - """ # noqa: E501 + - ```` specifies the data value. + """ + _WRAP_ARG_WITH_QUOTES = True -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusFlexray(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY`` command tree. + +class SearchSearchItemTriggerABusFlexrayData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. - - ``.cyclecount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. - - ``.eoftype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE`` command. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE`` command. - - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID`` command tree. - - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType`` command. - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER`` command tree. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusFlexrayCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._cyclecount = SearchSearchItemTriggerABusFlexrayCyclecount( - device, f"{self._cmd_syntax}:CYCLEcount" - ) - self._data = SearchSearchItemTriggerABusFlexrayData(device, f"{self._cmd_syntax}:DATa") - self._eoftype = SearchSearchItemTriggerABusFlexrayEoftype( - device, f"{self._cmd_syntax}:EOFTYPE" - ) - self._errtype = SearchSearchItemTriggerABusFlexrayErrtype( - device, f"{self._cmd_syntax}:ERRTYPE" + self._hivalue = SearchSearchItemTriggerABusFlexrayDataHivalue( + device, f"{self._cmd_syntax}:HIVALue" ) - self._frameid = SearchSearchItemTriggerABusFlexrayFrameid( - device, f"{self._cmd_syntax}:FRAMEID" + self._offset = SearchSearchItemTriggerABusFlexrayDataOffset( + device, f"{self._cmd_syntax}:OFFSet" ) - self._frametype = SearchSearchItemTriggerABusFlexrayFrametype( - device, f"{self._cmd_syntax}:FRAMEType" + self._qualifier = SearchSearchItemTriggerABusFlexrayDataQualifier( + device, f"{self._cmd_syntax}:QUALifier" ) - self._header = SearchSearchItemTriggerABusFlexrayHeader( - device, f"{self._cmd_syntax}:HEADER" + self._size = SearchSearchItemTriggerABusFlexrayDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusFlexrayDataValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def condition(self) -> SearchSearchItemTriggerABusFlexrayCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. + def hivalue(self) -> SearchSearchItemTriggerABusFlexrayDataHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. **Description:** - - This command sets or queries the FlexRay bus search condition. The search number is - specified by x. + - This command sets or queries the high value when searching on a FlexRay bus data + field. The search number is specified by x. The search condition must be set to + IDANDDATA OR DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition {SOF| FRAMEType| IDentifier| CYCLEcount| HEADer| DATA| IDANDDATA| EOF| ERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue? **Info:** - - ``SOF`` sets the trigger condition to start of frame. - - ``FRAMEType`` sets the trigger condition to frame type. - - ``IDentifier`` sets the trigger condition to identifier. - - ``CYCLEcount`` sets the trigger condition to cycle count. - - ``HEADer`` sets the trigger condition to header. - - ``DATA`` sets the trigger condition to data. - - ``IDANDDATA`` sets the trigger condition to ID and data. - - ``EOF`` sets the trigger condition to end of frame. - - ``ERRor`` sets the trigger condition to error. - """ # noqa: E501 - return self._condition - - @property - def cyclecount(self) -> SearchSearchItemTriggerABusFlexrayCyclecount: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` - command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. - """ - return self._cyclecount - - @property - def data(self) -> SearchSearchItemTriggerABusFlexrayData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. + - ```` specifies the data value. """ - return self._data + return self._hivalue @property - def eoftype(self) -> SearchSearchItemTriggerABusFlexrayEoftype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE`` command. + def offset(self) -> SearchSearchItemTriggerABusFlexrayDataOffset: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. **Description:** - - This command sets or queries the end of frame type when searching on a FlexRay bus - signal. The search number is specified by x. The search condition must be set to EOF. + - This command sets or queries the offset of the data string, in bytes, when searching + on a FlexRay bus data field. The search number is specified by x. The search condition + must be set to IDANDDATA OR DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE {ANY|STATIC|DYNAMIC} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet? **Info:** - - ``ANY`` specifies either end of file type. - - ``STATIC`` specifies the static end of file type. - - ``DYNAMIC`` specifies the static end of file type. + - ```` specifies the data offset in bytes. A setting of X/Don't care is + accomplished by setting the offset to -1. """ - return self._eoftype + return self._offset @property - def errtype(self) -> SearchSearchItemTriggerABusFlexrayErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE`` command. + def qualifier(self) -> SearchSearchItemTriggerABusFlexrayDataQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. **Description:** - - This command sets or queries the error type when searching on a FlexRay bus signal. - The search number is specified by x. The search condition must be set to ERROR. + - This command sets or queries the qualifier to be used when searching on a FlexRay bus + signal. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE {CRCHeader|CRCTrailer|NULLFRStatic|NULLFRDynamic| SYNCFrame|STARTupnosync} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier? **Info:** - - ``CRCHeader`` sets the error type to CRCHeader. - - ``CRCTrailer`` sets the error type to CRCTrailer. - - ``NULLFRStatic`` sets the error type to NULLFRStatic. - - ``NULLFRDynamic`` sets the error type to NULLFRDynamic. - - ``SYNCFrame`` sets the error type to SYNCFrame. - - ``STARTupnosync`` sets the error type to STARTupnosync. + - ``EQUal`` specifies the qualifier as equal. + - ``LESSEQual`` specifies the qualifier as less equal. + - ``MOREEQual`` specifies the qualifier as more equal. + - ``UNEQual`` specifies the qualifier as unequal. + - ``LESSthan`` specifies the qualifier as less than. + - ``MOREthan`` specifies the qualifier as more than. + - ``INrange`` specifies the qualifier as in range. + - ``OUTrange`` specifies the qualifier as out of range. """ # noqa: E501 - return self._errtype - - @property - def frameid(self) -> SearchSearchItemTriggerABusFlexrayFrameid: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:HIVALue`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:QUALifier`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:VALue`` command. - """ - return self._frameid + return self._qualifier @property - def frametype(self) -> SearchSearchItemTriggerABusFlexrayFrametype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType`` command. + def size(self) -> SearchSearchItemTriggerABusFlexrayDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. **Description:** - - This command sets or queries the FlexRay bus search frame type. The search number is - specified by x. + - This command sets or queries the length of the data string, in bytes, to be used when + searching on a FlexRay bus data field. The search number is specified by x. The search + condition must be set to IDANDDATA OR DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType {NORMal|PAYload|NULL|SYNC|STARTup} - - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe? **Info:** - - ``NORMal`` sets the frame type to normal. - - ``PAYload`` sets the frame type to payload. - - ``NULL`` sets the frame type to null. - - ``SYNC`` sets the frame type to sync. - - ``STARTup`` sets the frame type to startup. + - ```` specifies the data size in bytes. A data size of -1 is don't care. """ - return self._frametype + return self._size @property - def header(self) -> SearchSearchItemTriggerABusFlexrayHeader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER`` command tree. + def value(self) -> SearchSearchItemTriggerABusFlexrayDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. + + **Description:** + - This command sets or queries the low value to be used when searching on a FlexRay bus + data field. The search number is specified by x. The search condition must be set to + IDANDDATA or DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.crc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:CRC`` command. - - ``.cyclecount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:CYCLECount`` - command. - - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:FRAMEID`` command. - - ``.indbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:INDBits`` command. - - ``.paylength``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:PAYLENgth`` - command. - """ - return self._header - - -class SearchSearchItemTriggerABusEusbTokentype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. - - **Description:** - - This command specifies the eUSB trigger type to be valid on any, sof, out, in, or setup - condition. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType {ANY|SOF|OUT|IN|SETUP} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType? - - **Info:** - - ``ANY`` specifies the token type as Any (XX01). - - ``SOF`` specifies the token type as Start Of Frame (0101). - - ``OUT`` specifies the token type as OUT (0001). - - ``IN`` specifies the token type as IN (1001). - - ``SETUP`` specifies the token type as SETUP (1101). - """ - - -class SearchSearchItemTriggerABusEusbSyncsearch(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. - - **Description:** - - This command specifies eUSB Search Sync Bits to be On and Off. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch {OFF|ON} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue? - **Info:** - - ``OFF`` specifies the Sync bits as OFF (for Low Speed and Full Speed). - - ``ON`` specifies the Sync bits as ON (for High Speed). - """ + **Info:** + - ```` specifies the data value. + """ + return self._value -class SearchSearchItemTriggerABusEusbSyncbitsMinSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. +class SearchSearchItemTriggerABusFlexrayCyclecountValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. **Description:** - - This command sets the number of sync bits, in bits, to be used when triggering on a eUSB - bus signal. The trigger condition must be set to SYNC. The search number is specified by - x. + - This command sets or queries the low value when searching on a FlexRay bus cycle count + field. The search number is specified by x. The search condition must be set to + CYCLEcount. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue? **Info:** - - ```` specifies the number of sync bits. The default minimum Sync bits is 12. The - argument range is 12 to 31 bits. + - ```` specifies the cycle count value. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbSyncbitsMin(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbSyncbitsMinSize( - device, f"{self._cmd_syntax}:SIZe" - ) - @property - def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMinSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. +class SearchSearchItemTriggerABusFlexrayCyclecountQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` command. - **Description:** - - This command sets the number of sync bits, in bits, to be used when triggering on a - eUSB bus signal. The trigger condition must be set to SYNC. The search number is - specified by x. + **Description:** + - This command sets or queries the qualifier to be used when searching on a FlexRay bus + search cycle count field. The search number is specified by x. The search condition must + be set to CYCLEcount. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier? - **Info:** - - ```` specifies the number of sync bits. The default minimum Sync bits is 12. The - argument range is 12 to 31 bits. - """ - return self._size + **Info:** + - ``EQUal`` specifies the qualifier as equal. + - ``LESSEQual`` specifies the qualifier as less equal. + - ``MOREEQual`` specifies the qualifier as more equal. + - ``UNEQual`` specifies the qualifier as unequal. + - ``LESSthan`` specifies the qualifier as less than. + - ``MOREthan`` specifies the qualifier as more than. + - ``INrange`` specifies the qualifier as in range. + - ``OUTrange`` specifies the qualifier as out of range. + """ # noqa: E501 -class SearchSearchItemTriggerABusEusbSyncbitsMaxSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. +class SearchSearchItemTriggerABusFlexrayCyclecountHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. **Description:** - - This command sets the number of sync bits, to be used when triggering on a eUSB bus - signal. The trigger condition must be set to SYNC. The search number is specified by x. + - This command sets or queries the heigh value when searching on a FlexRay bus cycle count + field. The search number is specified by x. The search condition must be set to + CYCLEcount. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue? **Info:** - - ```` specifies the number of sync bits. The default maximum Sync bits is 32. The - argument range is 13 to 32 bits. + - ```` specifies the cycle count value. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbSyncbitsMax(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. + +class SearchSearchItemTriggerABusFlexrayCyclecount(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbSyncbitsMaxSize( - device, f"{self._cmd_syntax}:SIZe" + self._hivalue = SearchSearchItemTriggerABusFlexrayCyclecountHivalue( + device, f"{self._cmd_syntax}:HIVALue" + ) + self._qualifier = SearchSearchItemTriggerABusFlexrayCyclecountQualifier( + device, f"{self._cmd_syntax}:QUALifier" + ) + self._value = SearchSearchItemTriggerABusFlexrayCyclecountValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMaxSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. + def hivalue(self) -> SearchSearchItemTriggerABusFlexrayCyclecountHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` command. **Description:** - - This command sets the number of sync bits, to be used when triggering on a eUSB bus - signal. The trigger condition must be set to SYNC. The search number is specified by - x. + - This command sets or queries the heigh value when searching on a FlexRay bus cycle + count field. The search number is specified by x. The search condition must be set to + CYCLEcount. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue? **Info:** - - ```` specifies the number of sync bits. The default maximum Sync bits is 32. The - argument range is 13 to 32 bits. + - ```` specifies the cycle count value. """ - return self._size - - -class SearchSearchItemTriggerABusEusbSyncbits(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. - - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._max = SearchSearchItemTriggerABusEusbSyncbitsMax(device, f"{self._cmd_syntax}:MAX") - self._min = SearchSearchItemTriggerABusEusbSyncbitsMin(device, f"{self._cmd_syntax}:MIN") + return self._hivalue @property - def max(self) -> SearchSearchItemTriggerABusEusbSyncbitsMax: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. + def qualifier(self) -> SearchSearchItemTriggerABusFlexrayCyclecountQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` command. + + **Description:** + - This command sets or queries the qualifier to be used when searching on a FlexRay bus + search cycle count field. The search number is specified by x. The search condition + must be set to CYCLEcount. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier value`` command. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. - """ - return self._max + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier {EQUal|LESSEQual|MOREEQual|UNEQual|LESSthan|MOREthan| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier? + + **Info:** + - ``EQUal`` specifies the qualifier as equal. + - ``LESSEQual`` specifies the qualifier as less equal. + - ``MOREEQual`` specifies the qualifier as more equal. + - ``UNEQual`` specifies the qualifier as unequal. + - ``LESSthan`` specifies the qualifier as less than. + - ``MOREthan`` specifies the qualifier as more than. + - ``INrange`` specifies the qualifier as in range. + - ``OUTrange`` specifies the qualifier as out of range. + """ # noqa: E501 + return self._qualifier @property - def min(self) -> SearchSearchItemTriggerABusEusbSyncbitsMin: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. + def value(self) -> SearchSearchItemTriggerABusFlexrayCyclecountValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. + + **Description:** + - This command sets or queries the low value when searching on a FlexRay bus cycle count + field. The search number is specified by x. The search condition must be set to + CYCLEcount. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue value`` command. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue? + + **Info:** + - ```` specifies the cycle count value. """ - return self._min + return self._value -class SearchSearchItemTriggerABusEusbSyncQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. +class SearchSearchItemTriggerABusFlexrayCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to Sync Bits. The search number is specified by x. + - This command sets or queries the FlexRay bus search condition. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition {SOF| FRAMEType| IDentifier| CYCLEcount| HEADer| DATA| IDANDDATA| EOF| ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition? **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``INrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. + - ``SOF`` sets the trigger condition to start of frame. + - ``FRAMEType`` sets the trigger condition to frame type. + - ``IDentifier`` sets the trigger condition to identifier. + - ``CYCLEcount`` sets the trigger condition to cycle count. + - ``HEADer`` sets the trigger condition to header. + - ``DATA`` sets the trigger condition to data. + - ``IDANDDATA`` sets the trigger condition to ID and data. + - ``EOF`` sets the trigger condition to end of frame. + - ``ERRor`` sets the trigger condition to error. """ # noqa: E501 -class SearchSearchItemTriggerABusEusbSync(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusFlexray(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. + - ``.cyclecount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. + - ``.eoftype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE`` command. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE`` command. + - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID`` command tree. + - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType`` command. + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._qualifier = SearchSearchItemTriggerABusEusbSyncQualifier( - device, f"{self._cmd_syntax}:QUAlifier" + self._condition = SearchSearchItemTriggerABusFlexrayCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._cyclecount = SearchSearchItemTriggerABusFlexrayCyclecount( + device, f"{self._cmd_syntax}:CYCLEcount" + ) + self._data = SearchSearchItemTriggerABusFlexrayData(device, f"{self._cmd_syntax}:DATa") + self._eoftype = SearchSearchItemTriggerABusFlexrayEoftype( + device, f"{self._cmd_syntax}:EOFTYPE" + ) + self._errtype = SearchSearchItemTriggerABusFlexrayErrtype( + device, f"{self._cmd_syntax}:ERRTYPE" + ) + self._frameid = SearchSearchItemTriggerABusFlexrayFrameid( + device, f"{self._cmd_syntax}:FRAMEID" + ) + self._frametype = SearchSearchItemTriggerABusFlexrayFrametype( + device, f"{self._cmd_syntax}:FRAMEType" + ) + self._header = SearchSearchItemTriggerABusFlexrayHeader( + device, f"{self._cmd_syntax}:HEADER" ) @property - def qualifier(self) -> SearchSearchItemTriggerABusEusbSyncQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. + def condition(self) -> SearchSearchItemTriggerABusFlexrayCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition`` command. **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to Sync Bits. The search number is specified by x. + - This command sets or queries the FlexRay bus search condition. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition {SOF| FRAMEType| IDentifier| CYCLEcount| HEADer| DATA| IDANDDATA| EOF| ERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CONDition? **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``INrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. + - ``SOF`` sets the trigger condition to start of frame. + - ``FRAMEType`` sets the trigger condition to frame type. + - ``IDentifier`` sets the trigger condition to identifier. + - ``CYCLEcount`` sets the trigger condition to cycle count. + - ``HEADer`` sets the trigger condition to header. + - ``DATA`` sets the trigger condition to data. + - ``IDANDDATA`` sets the trigger condition to ID and data. + - ``EOF`` sets the trigger condition to end of frame. + - ``ERRor`` sets the trigger condition to error. """ # noqa: E501 - return self._qualifier + return self._condition + @property + def cyclecount(self) -> SearchSearchItemTriggerABusFlexrayCyclecount: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount`` command tree. -class SearchSearchItemTriggerABusEusbSplitSeValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount?`` query and raise an + AssertionError if the returned value does not match ``value``. - **Description:** - - This command specifies the eUSB trigger type start/complete condition. The search number - is specified by x. + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:HIVALue`` + command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:QUALifier`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:CYCLEcount:VALue`` command. + """ + return self._cyclecount - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue value`` command. + @property + def data(self) -> SearchSearchItemTriggerABusFlexrayData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. - :: + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:DATa:VALue`` command. + """ + return self._data - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue {NOCARE| FULLSPEED| LOWSPEED| ISOSTART| ISOMID| ISOEND| ISOALL} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue? + @property + def eoftype(self) -> SearchSearchItemTriggerABusFlexrayEoftype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE`` command. - **Info:** - - ``NOCARE`` sets the trigger on any combination of S and E bits. - - ``FULLSPEED`` sets the trigger on S bit = 0 and E bit = 0. - - ``LOWSPEED`` sets the trigger on S bit = 1 and E bit = 0. - - ``ISOSTART`` sets the trigger on S bit = 1, E bit = 0. - - ``ISOMID`` specifies Isochronous Data is Middle (00) Start/End bit value. - - ``ISOEND`` specifies Isochronous Data is End (01) Start/End bit value. - - ``ISOALL`` specifies Isochronous Data is All (11) Start/End bit value. - """ # noqa: E501 + **Description:** + - This command sets or queries the end of frame type when searching on a FlexRay bus + signal. The search number is specified by x. The search condition must be set to EOF. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE value`` command. -class SearchSearchItemTriggerABusEusbSplitSe(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query and raise an AssertionError if the - returned value does not match ``value``. + :: - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE {ANY|STATIC|DYNAMIC} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:EOFTYPE? - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbSplitSeValue( - device, f"{self._cmd_syntax}:VALue" - ) + **Info:** + - ``ANY`` specifies either end of file type. + - ``STATIC`` specifies the static end of file type. + - ``DYNAMIC`` specifies the static end of file type. + """ + return self._eoftype @property - def value(self) -> SearchSearchItemTriggerABusEusbSplitSeValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. + def errtype(self) -> SearchSearchItemTriggerABusFlexrayErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE`` command. **Description:** - - This command specifies the eUSB trigger type start/complete condition. The search - number is specified by x. + - This command sets or queries the error type when searching on a FlexRay bus signal. + The search number is specified by x. The search condition must be set to ERROR. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue {NOCARE| FULLSPEED| LOWSPEED| ISOSTART| ISOMID| ISOEND| ISOALL} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE {CRCHeader|CRCTrailer|NULLFRStatic|NULLFRDynamic| SYNCFrame|STARTupnosync} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:ERRTYPE? **Info:** - - ``NOCARE`` sets the trigger on any combination of S and E bits. - - ``FULLSPEED`` sets the trigger on S bit = 0 and E bit = 0. - - ``LOWSPEED`` sets the trigger on S bit = 1 and E bit = 0. - - ``ISOSTART`` sets the trigger on S bit = 1, E bit = 0. - - ``ISOMID`` specifies Isochronous Data is Middle (00) Start/End bit value. - - ``ISOEND`` specifies Isochronous Data is End (01) Start/End bit value. - - ``ISOALL`` specifies Isochronous Data is All (11) Start/End bit value. + - ``CRCHeader`` sets the error type to CRCHeader. + - ``CRCTrailer`` sets the error type to CRCTrailer. + - ``NULLFRStatic`` sets the error type to NULLFRStatic. + - ``NULLFRDynamic`` sets the error type to NULLFRDynamic. + - ``SYNCFrame`` sets the error type to SYNCFrame. + - ``STARTupnosync`` sets the error type to STARTupnosync. """ # noqa: E501 - return self._value - - -class SearchSearchItemTriggerABusEusbSplitScValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. - - **Description:** - - This command specifies the eUSB trigger type start/complete condition. The search number - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue {NOCARE| SSPLIT| CSPLIT} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue? - - **Info:** - - ``NOCARE`` sets the trigger on either the start or complete phase of the split - transaction. - - ``SSPLIT`` sets the trigger on the start phase of the split transaction. - - ``CSPLIT`` sets the trigger on the complete phase of the split transaction. - """ - - -class SearchSearchItemTriggerABusEusbSplitSc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. + return self._errtype - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query and raise an AssertionError if the - returned value does not match ``value``. + @property + def frameid(self) -> SearchSearchItemTriggerABusFlexrayFrameid: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID?`` query and raise an AssertionError + if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbSplitScValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:HIVALue`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:QUALifier`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEID:VALue`` command. + """ + return self._frameid @property - def value(self) -> SearchSearchItemTriggerABusEusbSplitScValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. + def frametype(self) -> SearchSearchItemTriggerABusFlexrayFrametype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType`` command. **Description:** - - This command specifies the eUSB trigger type start/complete condition. The search - number is specified by x. + - This command sets or queries the FlexRay bus search frame type. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue {NOCARE| SSPLIT| CSPLIT} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType {NORMal|PAYload|NULL|SYNC|STARTup} + - SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:FRAMEType? **Info:** - - ``NOCARE`` sets the trigger on either the start or complete phase of the split - transaction. - - ``SSPLIT`` sets the trigger on the start phase of the split transaction. - - ``CSPLIT`` sets the trigger on the complete phase of the split transaction. + - ``NORMal`` sets the frame type to normal. + - ``PAYload`` sets the frame type to payload. + - ``NULL`` sets the frame type to null. + - ``SYNC`` sets the frame type to sync. + - ``STARTup`` sets the frame type to startup. """ - return self._value + return self._frametype + @property + def header(self) -> SearchSearchItemTriggerABusFlexrayHeader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER`` command tree. -class SearchSearchItemTriggerABusEusbSplitPortValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.crc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:CRC`` command. + - ``.cyclecount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:CYCLECount`` + command. + - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:FRAMEID`` command. + - ``.indbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:INDBits`` command. + - ``.paylength``: The ``SEARCH:SEARCH:TRIGger:A:BUS:FLEXRAY:HEADER:PAYLENgth`` + command. + """ + return self._header + + +class SearchSearchItemTriggerABusEusbTokentype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. **Description:** - - This command sets the binary port address value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to Special with a packet type SPLIT. The search - number is specified by x. + - This command specifies the eUSB trigger type to be valid on any, sof, out, in, or setup + condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType {ANY|SOF|OUT|IN|SETUP} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ``ANY`` specifies the token type as Any (XX01). + - ``SOF`` specifies the token type as Start Of Frame (0101). + - ``OUT`` specifies the token type as OUT (0001). + - ``IN`` specifies the token type as IN (1001). + - ``SETUP`` specifies the token type as SETUP (1101). """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusEusbSyncsearch(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. -class SearchSearchItemTriggerABusEusbSplitPort(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. + **Description:** + - This command specifies eUSB Search Sync Bits to be On and Off. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbSplitPortValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusEusbSplitPortValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. - - **Description:** - - This command sets the binary port address value to be used when triggering on a eUSB - bus signal. The trigger condition must be set to Special with a packet type SPLIT. The - search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue value`` command. - - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch {OFF|ON} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch? - **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). - """ - return self._value + **Info:** + - ``OFF`` specifies the Sync bits as OFF (for Low Speed and Full Speed). + - ``ON`` specifies the Sync bits as ON (for High Speed). + """ -class SearchSearchItemTriggerABusEusbSplitHubValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. +class SearchSearchItemTriggerABusEusbSyncbitsMinSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. **Description:** - - This command sets the binary hub address value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to Special with packet type SPLIT. The search - number is specified by x. + - This command sets the number of sync bits, in bits, to be used when triggering on a eUSB + bus signal. The trigger condition must be set to SYNC. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the number of sync bits. The default minimum Sync bits is 12. The + argument range is 12 to 31 bits. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEusbSplitHub(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. +class SearchSearchItemTriggerABusEusbSyncbitsMin(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbSplitHubValue( - device, f"{self._cmd_syntax}:VALue" + self._size = SearchSearchItemTriggerABusEusbSyncbitsMinSize( + device, f"{self._cmd_syntax}:SIZe" ) @property - def value(self) -> SearchSearchItemTriggerABusEusbSplitHubValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMinSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. **Description:** - - This command sets the binary hub address value to be used when triggering on a eUSB - bus signal. The trigger condition must be set to Special with packet type SPLIT. The - search number is specified by x. + - This command sets the number of sync bits, in bits, to be used when triggering on a + eUSB bus signal. The trigger condition must be set to SYNC. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe? **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the number of sync bits. The default minimum Sync bits is 12. The + argument range is 12 to 31 bits. """ - return self._value + return self._size -class SearchSearchItemTriggerABusEusbSplitEtValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. +class SearchSearchItemTriggerABusEusbSyncbitsMaxSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. **Description:** - - This command specifies the eUSB trigger type endpoint condition. The search number is - specified by x. + - This command sets the number of sync bits, to be used when triggering on a eUSB bus + signal. The trigger condition must be set to SYNC. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue {NOCARE| CONTRol| ISOchronous| BULK| INTERRUPT} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe? **Info:** - - ``NOCARE`` specifies the Endpoint Type value as Don't Care. - - ``CONTRol`` specifies the Endpoint Type value as Control (00). - - ``ISOchronous`` specifies the Endpoint Type value as Isochronous (01). - - ``BULK`` specifies the Endpoint Type value as Bulk (10). - - ``INTERRUPT`` specifies the Endpoint Type value as Interrupt (11). - """ # noqa: E501 + - ```` specifies the number of sync bits. The default maximum Sync bits is 32. The + argument range is 13 to 32 bits. + """ -class SearchSearchItemTriggerABusEusbSplitEt(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. +class SearchSearchItemTriggerABusEusbSyncbitsMax(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbSplitEtValue( - device, f"{self._cmd_syntax}:VALue" + self._size = SearchSearchItemTriggerABusEusbSyncbitsMaxSize( + device, f"{self._cmd_syntax}:SIZe" ) @property - def value(self) -> SearchSearchItemTriggerABusEusbSplitEtValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMaxSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. **Description:** - - This command specifies the eUSB trigger type endpoint condition. The search number is - specified by x. + - This command sets the number of sync bits, to be used when triggering on a eUSB bus + signal. The trigger condition must be set to SYNC. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue {NOCARE| CONTRol| ISOchronous| BULK| INTERRUPT} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe? **Info:** - - ``NOCARE`` specifies the Endpoint Type value as Don't Care. - - ``CONTRol`` specifies the Endpoint Type value as Control (00). - - ``ISOchronous`` specifies the Endpoint Type value as Isochronous (01). - - ``BULK`` specifies the Endpoint Type value as Bulk (10). - - ``INTERRUPT`` specifies the Endpoint Type value as Interrupt (11). - """ # noqa: E501 - return self._value + - ```` specifies the number of sync bits. The default maximum Sync bits is 32. The + argument range is 13 to 32 bits. + """ + return self._size -class SearchSearchItemTriggerABusEusbSplit(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. +class SearchSearchItemTriggerABusEusbSyncbits(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.et``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. - - ``.hub``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. - - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. - - ``.sc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. - - ``.se``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. + - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. + - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._et = SearchSearchItemTriggerABusEusbSplitEt(device, f"{self._cmd_syntax}:ET") - self._hub = SearchSearchItemTriggerABusEusbSplitHub(device, f"{self._cmd_syntax}:HUB") - self._port = SearchSearchItemTriggerABusEusbSplitPort(device, f"{self._cmd_syntax}:PORT") - self._sc = SearchSearchItemTriggerABusEusbSplitSc(device, f"{self._cmd_syntax}:SC") - self._se = SearchSearchItemTriggerABusEusbSplitSe(device, f"{self._cmd_syntax}:SE") - - @property - def et(self) -> SearchSearchItemTriggerABusEusbSplitEt: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. - """ - return self._et - - @property - def hub(self) -> SearchSearchItemTriggerABusEusbSplitHub: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. - """ - return self._hub - - @property - def port(self) -> SearchSearchItemTriggerABusEusbSplitPort: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. - """ - return self._port + self._max = SearchSearchItemTriggerABusEusbSyncbitsMax(device, f"{self._cmd_syntax}:MAX") + self._min = SearchSearchItemTriggerABusEusbSyncbitsMin(device, f"{self._cmd_syntax}:MIN") @property - def sc(self) -> SearchSearchItemTriggerABusEusbSplitSc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. + def max(self) -> SearchSearchItemTriggerABusEusbSyncbitsMax: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. """ - return self._sc + return self._max @property - def se(self) -> SearchSearchItemTriggerABusEusbSplitSe: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. + def min(self) -> SearchSearchItemTriggerABusEusbSyncbitsMin: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. """ - return self._se + return self._min -class SearchSearchItemTriggerABusEusbSpecialtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. +class SearchSearchItemTriggerABusEusbSyncQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on any, err, split, ping, or - reserved condition. The search number is specified by x. + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to Sync Bits. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType {ANY| PREamble| ERROr| SPLit| PING| RESERVed} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier? **Info:** - - ``ANY`` specifies the PID value as Any (XX00). - - ``PREamble`` specifies the PID value as PRE (1100). - - ``ERROr`` specifies the PID value as ERR (1100). - - ``SPLit`` specifies the PID value as Split (1000). - - ``PING`` specifies the PID value as PING (0100). - - ``RESERVed`` specifies the PID value as Reserved (0000). + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``INrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. """ # noqa: E501 -class SearchSearchItemTriggerABusEusbSofframenumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. - - **Description:** - - This command sets the binary frame number to be used when triggering on a eUSB bus signal. - The trigger condition must be set to TOKEN. The search number is specified by x. +class SearchSearchItemTriggerABusEusbSync(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber? + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Info:** - - ```` specifies the binary frame number within the range 000 0000 0000 to 111 1111 - 1111 (000 hex to 7FF hex). + Properties: + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. """ - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEusbRapOption(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._qualifier = SearchSearchItemTriggerABusEusbSyncQualifier( + device, f"{self._cmd_syntax}:QUAlifier" + ) - **Description:** - - This command specifies the eUSB Register Access Protocol search option. The search number - is specified by x. + @property + def qualifier(self) -> SearchSearchItemTriggerABusEusbSyncQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion value`` command. + **Description:** + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to Sync Bits. The search number is specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion {COMMand|ADDRess|RAPDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion? + :: - **Info:** - - ``COMMand`` specifies the RAP option as Command. - - ``ADDRess`` specifies the RAP option as Address. - - ``RAPDATa`` specifies the RAP option as RapData. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier? + **Info:** + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``INrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. + """ # noqa: E501 + return self._qualifier -class SearchSearchItemTriggerABusEusbRapDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. + +class SearchSearchItemTriggerABusEusbSplitSeValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. **Description:** - - This command sets the binary Register Access Protocol data value to be used when - triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The search - number is specified by x. + - This command specifies the eUSB trigger type start/complete condition. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue {NOCARE| FULLSPEED| LOWSPEED| ISOSTART| ISOMID| ISOEND| ISOALL} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X for binary; for hexadecimal; and symbolic. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``NOCARE`` sets the trigger on any combination of S and E bits. + - ``FULLSPEED`` sets the trigger on S bit = 0 and E bit = 0. + - ``LOWSPEED`` sets the trigger on S bit = 1 and E bit = 0. + - ``ISOSTART`` sets the trigger on S bit = 1, E bit = 0. + - ``ISOMID`` specifies Isochronous Data is Middle (00) Start/End bit value. + - ``ISOEND`` specifies Isochronous Data is End (01) Start/End bit value. + - ``ISOALL`` specifies Isochronous Data is All (11) Start/End bit value. + """ # noqa: E501 -class SearchSearchItemTriggerABusEusbRapData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. +class SearchSearchItemTriggerABusEusbSplitSe(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbRapDataValue( + self._value = SearchSearchItemTriggerABusEusbSplitSeValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEusbRapDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEusbSplitSeValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. **Description:** - - This command sets the binary Register Access Protocol data value to be used when - triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The - search number is specified by x. + - This command specifies the eUSB trigger type start/complete condition. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue {NOCARE| FULLSPEED| LOWSPEED| ISOSTART| ISOMID| ISOEND| ISOALL} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X for binary; for hexadecimal; and symbolic. - """ + - ``NOCARE`` sets the trigger on any combination of S and E bits. + - ``FULLSPEED`` sets the trigger on S bit = 0 and E bit = 0. + - ``LOWSPEED`` sets the trigger on S bit = 1 and E bit = 0. + - ``ISOSTART`` sets the trigger on S bit = 1, E bit = 0. + - ``ISOMID`` specifies Isochronous Data is Middle (00) Start/End bit value. + - ``ISOEND`` specifies Isochronous Data is End (01) Start/End bit value. + - ``ISOALL`` specifies Isochronous Data is All (11) Start/End bit value. + """ # noqa: E501 return self._value -class SearchSearchItemTriggerABusEusbRapCommand(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. +class SearchSearchItemTriggerABusEusbSplitScValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. **Description:** - - This command specifies the eUSB Register Access Protocol search option. The search number + - This command specifies the eUSB trigger type start/complete condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand {ALL|WRITe|READ|CLEar|SET} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand? - - **Info:** - - ``ALL`` specifies the RAP command as All. - - ``WRITe`` specifies the RAP command as Write. - - ``READ`` specifies the RAP command as Read. - - ``CLEar`` specifies the RAP command as Clear. - - ``SET`` specifies the RAP command as Set. - """ - - -class SearchSearchItemTriggerABusEusbRapAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. - - **Description:** - - This command sets the binary Register Access Protocol address value to be used when - triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The search - number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue {NOCARE| SSPLIT| CSPLIT} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X for binary; for hexadecimal; and symbolic. + - ``NOCARE`` sets the trigger on either the start or complete phase of the split + transaction. + - ``SSPLIT`` sets the trigger on the start phase of the split transaction. + - ``CSPLIT`` sets the trigger on the complete phase of the split transaction. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEusbRapAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. +class SearchSearchItemTriggerABusEusbSplitSc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbRapAddressValue( + self._value = SearchSearchItemTriggerABusEusbSplitScValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEusbRapAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEusbSplitScValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. **Description:** - - This command sets the binary Register Access Protocol address value to be used when - triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The - search number is specified by x. + - This command specifies the eUSB trigger type start/complete condition. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue {NOCARE| SSPLIT| CSPLIT} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X for binary; for hexadecimal; and symbolic. + - ``NOCARE`` sets the trigger on either the start or complete phase of the split + transaction. + - ``SSPLIT`` sets the trigger on the start phase of the split transaction. + - ``CSPLIT`` sets the trigger on the complete phase of the split transaction. """ return self._value -class SearchSearchItemTriggerABusEusbRap(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. +class SearchSearchItemTriggerABusEusbSplitPortValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. + + **Description:** + - This command sets the binary port address value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to Special with a packet type SPLIT. The search + number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. - - ``.option``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEusbRapAddress( - device, f"{self._cmd_syntax}:ADDress" - ) - self._command = SearchSearchItemTriggerABusEusbRapCommand( - device, f"{self._cmd_syntax}:COMMand" - ) - self._data = SearchSearchItemTriggerABusEusbRapData(device, f"{self._cmd_syntax}:DATa") - self._option = SearchSearchItemTriggerABusEusbRapOption( - device, f"{self._cmd_syntax}:OPTion" - ) - - @property - def address(self) -> SearchSearchItemTriggerABusEusbRapAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. - """ - return self._address + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue value`` command. - @property - def command(self) -> SearchSearchItemTriggerABusEusbRapCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. + **SCPI Syntax:** - **Description:** - - This command specifies the eUSB Register Access Protocol search option. The search - number is specified by x. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand value`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue? - **SCPI Syntax:** + **Info:** + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). + """ - :: + _WRAP_ARG_WITH_QUOTES = True - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand {ALL|WRITe|READ|CLEar|SET} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand? - **Info:** - - ``ALL`` specifies the RAP command as All. - - ``WRITe`` specifies the RAP command as Write. - - ``READ`` specifies the RAP command as Read. - - ``CLEar`` specifies the RAP command as Clear. - - ``SET`` specifies the RAP command as Set. - """ - return self._command +class SearchSearchItemTriggerABusEusbSplitPort(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. - @property - def data(self) -> SearchSearchItemTriggerABusEusbRapData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. + """ - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. - """ - return self._data + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEusbSplitPortValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def option(self) -> SearchSearchItemTriggerABusEusbRapOption: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + def value(self) -> SearchSearchItemTriggerABusEusbSplitPortValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. **Description:** - - This command specifies the eUSB Register Access Protocol search option. The search - number is specified by x. + - This command sets the binary port address value to be used when triggering on a eUSB + bus signal. The trigger condition must be set to Special with a packet type SPLIT. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion {COMMand|ADDRess|RAPDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue? **Info:** - - ``COMMand`` specifies the RAP option as Command. - - ``ADDRess`` specifies the RAP option as Address. - - ``RAPDATa`` specifies the RAP option as RapData. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - return self._option + return self._value -class SearchSearchItemTriggerABusEusbHandshaketype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. +class SearchSearchItemTriggerABusEusbSplitHubValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on any, ack, nak, stall, or nyet - condition. The search number is specified by x. + - This command sets the binary hub address value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to Special with packet type SPLIT. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType {ANY|ACK|NAK|STALL|NYET} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType? - - **Info:** - - ``ANY`` specifies the handshake type as Any (0010). - - ``ACK`` specifies the handshake type as Acknowledgement (positive) (XX10). - - ``NAK`` specifies the handshake type as Negative Acknowledgment (1010). - - ``STALL`` specifies the error type as PID Check Bits. - - ``NYET`` specifies the handshake type as Stall (endpoint is halted or control pipe request - not supported) (1110). - """ - - -class SearchSearchItemTriggerABusEusbErrtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. - - **Description:** - - This command specifies the eUSB trigger type to be valid on a PID, Token CRC5, Data CRC16, - or Bit stuffing condition. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType {BITSTUFFing|CRC5|CRC16|PID} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue? **Info:** - - ``BITSTUFFing`` specifies the error type as Bit Stuffing. - - ``CRC5`` specifies the error type as Token CRC5 (Cyclic Redundancy Check 5). - - ``CRC16`` specifies the error type as Data CRC16 (Cyclic Redundancy Check 16). - - ``PID`` specifies the error type as PID Check Bits. + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - -class SearchSearchItemTriggerABusEusbEopbitsMinSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. - - **Description:** - - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. - The trigger condition must be set to EOP. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe? - - **Info:** - - ```` specifies the number of EOP bits. The default minimum EOP bits is 8. The - argument range is 8 to 99 bits. - """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbEopbitsMin(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. +class SearchSearchItemTriggerABusEusbSplitHub(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbEopbitsMinSize( - device, f"{self._cmd_syntax}:SIZe" + self._value = SearchSearchItemTriggerABusEusbSplitHubValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMinSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusEusbSplitHubValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. **Description:** - - This command sets the number of EOP bits to be used when triggering on a eUSB bus - signal. The trigger condition must be set to EOP. The search number is specified by x. + - This command sets the binary hub address value to be used when triggering on a eUSB + bus signal. The trigger condition must be set to Special with packet type SPLIT. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue? **Info:** - - ```` specifies the number of EOP bits. The default minimum EOP bits is 8. The - argument range is 8 to 99 bits. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - return self._size + return self._value -class SearchSearchItemTriggerABusEusbEopbitsMaxSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. +class SearchSearchItemTriggerABusEusbSplitEtValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. **Description:** - - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. - The trigger condition must be set to EOP. The search number is specified by x. + - This command specifies the eUSB trigger type endpoint condition. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue {NOCARE| CONTRol| ISOchronous| BULK| INTERRUPT} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue? **Info:** - - ```` specifies the number of EOP bits. The default maximum EOP bits is 100. The - argument range is 9 to 100 bits. - """ + - ``NOCARE`` specifies the Endpoint Type value as Don't Care. + - ``CONTRol`` specifies the Endpoint Type value as Control (00). + - ``ISOchronous`` specifies the Endpoint Type value as Isochronous (01). + - ``BULK`` specifies the Endpoint Type value as Bulk (10). + - ``INTERRUPT`` specifies the Endpoint Type value as Interrupt (11). + """ # noqa: E501 -class SearchSearchItemTriggerABusEusbEopbitsMax(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. +class SearchSearchItemTriggerABusEusbSplitEt(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbEopbitsMaxSize( - device, f"{self._cmd_syntax}:SIZe" + self._value = SearchSearchItemTriggerABusEusbSplitEtValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMaxSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusEusbSplitEtValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. **Description:** - - This command sets the number of EOP bits to be used when triggering on a eUSB bus - signal. The trigger condition must be set to EOP. The search number is specified by x. + - This command specifies the eUSB trigger type endpoint condition. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe? - - **Info:** - - ```` specifies the number of EOP bits. The default maximum EOP bits is 100. The - argument range is 9 to 100 bits. - """ - return self._size + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue {NOCARE| CONTRol| ISOchronous| BULK| INTERRUPT} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue? + + **Info:** + - ``NOCARE`` specifies the Endpoint Type value as Don't Care. + - ``CONTRol`` specifies the Endpoint Type value as Control (00). + - ``ISOchronous`` specifies the Endpoint Type value as Isochronous (01). + - ``BULK`` specifies the Endpoint Type value as Bulk (10). + - ``INTERRUPT`` specifies the Endpoint Type value as Interrupt (11). + """ # noqa: E501 + return self._value -class SearchSearchItemTriggerABusEusbEopbits(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. +class SearchSearchItemTriggerABusEusbSplit(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. - - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. + - ``.et``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. + - ``.hub``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. + - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. + - ``.sc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. + - ``.se``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._max = SearchSearchItemTriggerABusEusbEopbitsMax(device, f"{self._cmd_syntax}:MAX") - self._min = SearchSearchItemTriggerABusEusbEopbitsMin(device, f"{self._cmd_syntax}:MIN") + self._et = SearchSearchItemTriggerABusEusbSplitEt(device, f"{self._cmd_syntax}:ET") + self._hub = SearchSearchItemTriggerABusEusbSplitHub(device, f"{self._cmd_syntax}:HUB") + self._port = SearchSearchItemTriggerABusEusbSplitPort(device, f"{self._cmd_syntax}:PORT") + self._sc = SearchSearchItemTriggerABusEusbSplitSc(device, f"{self._cmd_syntax}:SC") + self._se = SearchSearchItemTriggerABusEusbSplitSe(device, f"{self._cmd_syntax}:SE") @property - def max(self) -> SearchSearchItemTriggerABusEusbEopbitsMax: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. + def et(self) -> SearchSearchItemTriggerABusEusbSplitEt: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET:VALue`` command. + """ + return self._et + + @property + def hub(self) -> SearchSearchItemTriggerABusEusbSplitHub: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB:VALue`` command. """ - return self._max + return self._hub @property - def min(self) -> SearchSearchItemTriggerABusEusbEopbitsMin: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. + def port(self) -> SearchSearchItemTriggerABusEusbSplitPort: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT:VALue`` command. """ - return self._min + return self._port + @property + def sc(self) -> SearchSearchItemTriggerABusEusbSplitSc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. -class SearchSearchItemTriggerABusEusbEopQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC:VALue`` command. + """ + return self._sc + + @property + def se(self) -> SearchSearchItemTriggerABusEusbSplitSe: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE:VALue`` command. + """ + return self._se + + +class SearchSearchItemTriggerABusEusbSpecialtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to EOP Bits. The search number is specified by x. + - This command specifies the eUSB trigger type to be valid on any, err, split, ping, or + reserved condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType {ANY| PREamble| ERROr| SPLit| PING| RESERVed} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType? **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``INrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. + - ``ANY`` specifies the PID value as Any (XX00). + - ``PREamble`` specifies the PID value as PRE (1100). + - ``ERROr`` specifies the PID value as ERR (1100). + - ``SPLit`` specifies the PID value as Split (1000). + - ``PING`` specifies the PID value as PING (0100). + - ``RESERVed`` specifies the PID value as Reserved (0000). """ # noqa: E501 -class SearchSearchItemTriggerABusEusbEopDatabitsSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. +class SearchSearchItemTriggerABusEusbSofframenumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. **Description:** - - This command sets the number of EOP bits, in bytes, to be used when triggering on a eUSB - bus signal. The trigger condition must be set to EOP. The search number is specified by x. + - This command sets the binary frame number to be used when triggering on a eUSB bus signal. + The trigger condition must be set to TOKEN. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber? **Info:** - - ```` specifies the number of EOP bits. The default EOP bits is 8. The argument range - is 8 to 100 bits. + - ```` specifies the binary frame number within the range 000 0000 0000 to 111 1111 + 1111 (000 hex to 7FF hex). """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbEopDatabits(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. + +class SearchSearchItemTriggerABusEusbRapOption(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + + **Description:** + - This command specifies the eUSB Register Access Protocol search option. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion value`` command. - Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion {COMMand|ADDRess|RAPDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion? + + **Info:** + - ``COMMand`` specifies the RAP option as Command. + - ``ADDRess`` specifies the RAP option as Address. + - ``RAPDATa`` specifies the RAP option as RapData. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbEopDatabitsSize( - device, f"{self._cmd_syntax}:SIZe" - ) - @property - def size(self) -> SearchSearchItemTriggerABusEusbEopDatabitsSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. +class SearchSearchItemTriggerABusEusbRapDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. - **Description:** - - This command sets the number of EOP bits, in bytes, to be used when triggering on a - eUSB bus signal. The trigger condition must be set to EOP. The search number is - specified by x. + **Description:** + - This command sets the binary Register Access Protocol data value to be used when + triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The search + number is specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue? - **Info:** - - ```` specifies the number of EOP bits. The default EOP bits is 8. The argument - range is 8 to 100 bits. - """ - return self._size + **Info:** + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X for binary; for hexadecimal; and symbolic. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbEop(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. + +class SearchSearchItemTriggerABusEusbRapData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._databits = SearchSearchItemTriggerABusEusbEopDatabits( - device, f"{self._cmd_syntax}:DATABITS" - ) - self._qualifier = SearchSearchItemTriggerABusEusbEopQualifier( - device, f"{self._cmd_syntax}:QUAlifier" + self._value = SearchSearchItemTriggerABusEusbRapDataValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def databits(self) -> SearchSearchItemTriggerABusEusbEopDatabits: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. - """ - return self._databits - - @property - def qualifier(self) -> SearchSearchItemTriggerABusEusbEopQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. + def value(self) -> SearchSearchItemTriggerABusEusbRapDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to EOP Bits. The search number is specified by x. + - This command sets the binary Register Access Protocol data value to be used when + triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue? **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``INrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. - """ # noqa: E501 - return self._qualifier + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X for binary; for hexadecimal; and symbolic. + """ + return self._value -class SearchSearchItemTriggerABusEusbEndsearch(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. +class SearchSearchItemTriggerABusEusbRapCommand(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. **Description:** - - This command specifies eUSB Search EOP Bits to be On and Off. The search number is - specified by x. + - This command specifies the eUSB Register Access Protocol search option. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch {OFF|ON} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand {ALL|WRITe|READ|CLEar|SET} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand? **Info:** - - ``OFF`` specifies the EOP bits as OFF (for Low Speed and Full Speed). - - ``ON`` specifies the EOP bits as ON (for High Speed). + - ``ALL`` specifies the RAP command as All. + - ``WRITe`` specifies the RAP command as Write. + - ``READ`` specifies the RAP command as Read. + - ``CLEar`` specifies the RAP command as Clear. + - ``SET`` specifies the RAP command as Set. """ -class SearchSearchItemTriggerABusEusbEndpointValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. +class SearchSearchItemTriggerABusEusbRapAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. **Description:** - - This command sets the endpoint binary value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. The search number is specified by x. + - This command sets the binary Register Access Protocol address value to be used when + triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue? **Info:** - - ```` specifies the data value in the specified valid format. The valid characters - are 0, 1, and X for binary format; A-F, 0-9 and X for hexadecimal format. + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X for binary; for hexadecimal; and symbolic. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbEndpoint(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. +class SearchSearchItemTriggerABusEusbRapAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEusbEndpointValue( + self._value = SearchSearchItemTriggerABusEusbRapAddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEusbEndpointValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEusbRapAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. **Description:** - - This command sets the endpoint binary value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. The search number is specified by - x. + - This command sets the binary Register Access Protocol address value to be used when + triggering on a eUSB bus signal. The trigger condition must be set to TOKEN. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue? **Info:** - - ```` specifies the data value in the specified valid format. The valid - characters are 0, 1, and X for binary format; A-F, 0-9 and X for hexadecimal format. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X for binary; for hexadecimal; and symbolic. """ return self._value -class SearchSearchItemTriggerABusEusbDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. - - **Description:** - - This command sets the binary data value to be used when triggering on a eUSB bus signal. - The trigger condition must be set to DATA. The search number is specified by x. +class SearchSearchItemTriggerABusEusbRap(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query and raise an AssertionError if the + returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. + - ``.option``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEusbRapAddress( + device, f"{self._cmd_syntax}:ADDress" + ) + self._command = SearchSearchItemTriggerABusEusbRapCommand( + device, f"{self._cmd_syntax}:COMMand" + ) + self._data = SearchSearchItemTriggerABusEusbRapData(device, f"{self._cmd_syntax}:DATa") + self._option = SearchSearchItemTriggerABusEusbRapOption( + device, f"{self._cmd_syntax}:OPTion" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue? + @property + def address(self) -> SearchSearchItemTriggerABusEusbRapAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. - **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress?`` query and raise an AssertionError + if the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress:VALue`` command. + """ + return self._address + @property + def command(self) -> SearchSearchItemTriggerABusEusbRapCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. -class SearchSearchItemTriggerABusEusbDataType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. + **Description:** + - This command specifies the eUSB Register Access Protocol search option. The search + number is specified by x. - **Description:** - - This command specifies the eUSB trigger type to be valid on any, data0, data1, data2, or - mdata condition. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand {ALL|WRITe|READ|CLEar|SET} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand? - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe {ANY| DATA0| DATA1| DATA2| MDATA} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe? + **Info:** + - ``ALL`` specifies the RAP command as All. + - ``WRITe`` specifies the RAP command as Write. + - ``READ`` specifies the RAP command as Read. + - ``CLEar`` specifies the RAP command as Clear. + - ``SET`` specifies the RAP command as Set. + """ + return self._command - **Info:** - - ``ANY`` specifies either a DATA0 or DATA1 data packet type. - - ``DATA0`` specifies a DATA0 data packet type. - - ``DATA1`` specifies a DATA1 data packet type. - - ``DATA2`` specifies a DATA2 data packet type when on HIGH speed. - - ``MDATA`` specifies a MDATA data packet type when on HIGH speed. - """ + @property + def data(self) -> SearchSearchItemTriggerABusEusbRapData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusEusbDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa:VALue`` command. + """ + return self._data - **Description:** - - This command sets the length of the data string, in bytes, to be used when triggering on a - eUSB bus signal. The trigger condition must be set to DATA. The search number is specified - by x. + @property + def option(self) -> SearchSearchItemTriggerABusEusbRapOption: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe value`` command. + **Description:** + - This command specifies the eUSB Register Access Protocol search option. The search + number is specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe? + :: - **Info:** - - ```` specifies the length of the data string. Default data size value is 1. The - argument range is 1 to 16 bytes. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion {COMMand|ADDRess|RAPDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion? + + **Info:** + - ``COMMand`` specifies the RAP option as Command. + - ``ADDRess`` specifies the RAP option as Address. + - ``RAPDATa`` specifies the RAP option as RapData. + """ + return self._option -class SearchSearchItemTriggerABusEusbDataQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. +class SearchSearchItemTriggerABusEusbHandshaketype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to IDANDDATA OR DATA. The search number is specified by x. + - This command specifies the eUSB trigger type to be valid on any, ack, nak, stall, or nyet + condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| Inrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType {ANY|ACK|NAK|STALL|NYET} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType? **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``Inrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. - """ # noqa: E501 + - ``ANY`` specifies the handshake type as Any (0010). + - ``ACK`` specifies the handshake type as Acknowledgement (positive) (XX10). + - ``NAK`` specifies the handshake type as Negative Acknowledgment (1010). + - ``STALL`` specifies the error type as PID Check Bits. + - ``NYET`` specifies the handshake type as Stall (endpoint is halted or control pipe request + not supported) (1110). + """ -class SearchSearchItemTriggerABusEusbDataOffset(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. +class SearchSearchItemTriggerABusEusbErrtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. **Description:** - - This command sets the byte offset to look for a data pattern at, in bytes, to be used when - triggering on a eUSB bus signal. The trigger condition must be set to DATA. The search - number is specified by x. + - This command specifies the eUSB trigger type to be valid on a PID, Token CRC5, Data CRC16, + or Bit stuffing condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType {BITSTUFFing|CRC5|CRC16|PID} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType? **Info:** - - ```` specifies the byte offset. Default offset value is -1. The argument range is -1 - to 1024. + - ``BITSTUFFing`` specifies the error type as Bit Stuffing. + - ``CRC5`` specifies the error type as Token CRC5 (Cyclic Redundancy Check 5). + - ``CRC16`` specifies the error type as Data CRC16 (Cyclic Redundancy Check 16). + - ``PID`` specifies the error type as PID Check Bits. """ -class SearchSearchItemTriggerABusEusbDataHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. +class SearchSearchItemTriggerABusEusbEopbitsMinSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. **Description:** - - This command sets the high binary data value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to DATA. The search number is specified by x. + - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. + The trigger condition must be set to EOP. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the number of EOP bits. The default minimum EOP bits is 8. The + argument range is 8 to 99 bits. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEusbData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. +class SearchSearchItemTriggerABusEusbEopbitsMin(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusEusbDataHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._offset = SearchSearchItemTriggerABusEusbDataOffset( - device, f"{self._cmd_syntax}:OFFSet" - ) - self._qualifier = SearchSearchItemTriggerABusEusbDataQualifier( - device, f"{self._cmd_syntax}:QUAlifier" + self._size = SearchSearchItemTriggerABusEusbEopbitsMinSize( + device, f"{self._cmd_syntax}:SIZe" ) - self._size = SearchSearchItemTriggerABusEusbDataSize(device, f"{self._cmd_syntax}:SIZe") - self._type = SearchSearchItemTriggerABusEusbDataType(device, f"{self._cmd_syntax}:TYPe") - self._value = SearchSearchItemTriggerABusEusbDataValue(device, f"{self._cmd_syntax}:VALue") @property - def hivalue(self) -> SearchSearchItemTriggerABusEusbDataHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. + def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMinSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. **Description:** - - This command sets the high binary data value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to DATA. The search number is specified by - x. + - This command sets the number of EOP bits to be used when triggering on a eUSB bus + signal. The trigger condition must be set to EOP. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe? **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the number of EOP bits. The default minimum EOP bits is 8. The + argument range is 8 to 99 bits. """ - return self._hivalue - - @property - def offset(self) -> SearchSearchItemTriggerABusEusbDataOffset: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. + return self._size - **Description:** - - This command sets the byte offset to look for a data pattern at, in bytes, to be used - when triggering on a eUSB bus signal. The trigger condition must be set to DATA. The - search number is specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet value`` command. +class SearchSearchItemTriggerABusEusbEopbitsMaxSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. - **SCPI Syntax:** + **Description:** + - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. + The trigger condition must be set to EOP. The search number is specified by x. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe value`` command. - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet? + **SCPI Syntax:** - **Info:** - - ```` specifies the byte offset. Default offset value is -1. The argument range is - -1 to 1024. - """ - return self._offset + :: - @property - def qualifier(self) -> SearchSearchItemTriggerABusEusbDataQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe? - **Description:** - - This command sets the qualifier to be used when triggering on a eUSB bus signal. The - trigger condition must be set to IDANDDATA OR DATA. The search number is specified by - x. + **Info:** + - ```` specifies the number of EOP bits. The default maximum EOP bits is 100. The + argument range is 9 to 100 bits. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier value`` command. - **SCPI Syntax:** +class SearchSearchItemTriggerABusEusbEopbitsMax(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query and raise an AssertionError if + the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| Inrange| OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier? + Properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. + """ - **Info:** - - ``EQual`` specifies the qualifier as Equal. - - ``UNEQual`` specifies the qualifier as Not Equal to. - - ``LESSthan`` specifies the qualifier as Less Than. - - ``MOREthan`` specifies the qualifier as More Than. - - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. - - ``MOREEQual`` specifies the qualifier as More Than or Equal to. - - ``Inrange`` specifies the qualifier as Inside Range. - - ``OUTrange`` specifies the qualifier as Out of Range. - """ # noqa: E501 - return self._qualifier + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._size = SearchSearchItemTriggerABusEusbEopbitsMaxSize( + device, f"{self._cmd_syntax}:SIZe" + ) @property - def size(self) -> SearchSearchItemTriggerABusEusbDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. + def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMaxSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. **Description:** - - This command sets the length of the data string, in bytes, to be used when triggering - on a eUSB bus signal. The trigger condition must be set to DATA. The search number is - specified by x. + - This command sets the number of EOP bits to be used when triggering on a eUSB bus + signal. The trigger condition must be set to EOP. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe? **Info:** - - ```` specifies the length of the data string. Default data size value is 1. The - argument range is 1 to 16 bytes. + - ```` specifies the number of EOP bits. The default maximum EOP bits is 100. The + argument range is 9 to 100 bits. """ return self._size - @property - def type(self) -> SearchSearchItemTriggerABusEusbDataType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. - **Description:** - - This command specifies the eUSB trigger type to be valid on any, data0, data1, data2, - or mdata condition. The search number is specified by x. +class SearchSearchItemTriggerABusEusbEopbits(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. + - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._max = SearchSearchItemTriggerABusEusbEopbitsMax(device, f"{self._cmd_syntax}:MAX") + self._min = SearchSearchItemTriggerABusEusbEopbitsMin(device, f"{self._cmd_syntax}:MIN") + + @property + def max(self) -> SearchSearchItemTriggerABusEusbEopbitsMax: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe {ANY| DATA0| DATA1| DATA2| MDATA} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe? - **Info:** - - ``ANY`` specifies either a DATA0 or DATA1 data packet type. - - ``DATA0`` specifies a DATA0 data packet type. - - ``DATA1`` specifies a DATA1 data packet type. - - ``DATA2`` specifies a DATA2 data packet type when on HIGH speed. - - ``MDATA`` specifies a MDATA data packet type when on HIGH speed. + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. """ - return self._type + return self._max @property - def value(self) -> SearchSearchItemTriggerABusEusbDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. - - **Description:** - - This command sets the binary data value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to DATA. The search number is specified by - x. + def min(self) -> SearchSearchItemTriggerABusEusbEopbitsMin: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue value`` command. - **SCPI Syntax:** + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN:SIZe`` command. + """ + return self._min - :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue? +class SearchSearchItemTriggerABusEusbEopQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. - **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). - """ - return self._value + **Description:** + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to EOP Bits. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier value`` command. -class SearchSearchItemTriggerABusEusbDatabitsSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier? + + **Info:** + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``INrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusEusbEopDatabitsSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. **Description:** - - This command sets the number of Sync bits, in bytes, to be used when triggering on a eUSB - bus signal. The trigger condition must be set to SYNC. The search number is specified by - x. + - This command sets the number of EOP bits, in bytes, to be used when triggering on a eUSB + bus signal. The trigger condition must be set to EOP. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe? **Info:** - - ```` specifies the number of the Sync bits. The default Sync bits is 12. The argument - range is 12 to 32 bits. + - ```` specifies the number of EOP bits. The default EOP bits is 8. The argument range + is 8 to 100 bits. """ -class SearchSearchItemTriggerABusEusbDatabits(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. +class SearchSearchItemTriggerABusEusbEopDatabits(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._size = SearchSearchItemTriggerABusEusbEopDatabitsSize( + device, f"{self._cmd_syntax}:SIZe" + ) + + @property + def size(self) -> SearchSearchItemTriggerABusEusbEopDatabitsSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. + + **Description:** + - This command sets the number of EOP bits, in bytes, to be used when triggering on a + eUSB bus signal. The trigger condition must be set to EOP. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe? + + **Info:** + - ```` specifies the number of EOP bits. The default EOP bits is 8. The argument + range is 8 to 100 bits. + """ + return self._size + + +class SearchSearchItemTriggerABusEusbEop(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. + - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEusbDatabitsSize(device, f"{self._cmd_syntax}:SIZe") + self._databits = SearchSearchItemTriggerABusEusbEopDatabits( + device, f"{self._cmd_syntax}:DATABITS" + ) + self._qualifier = SearchSearchItemTriggerABusEusbEopQualifier( + device, f"{self._cmd_syntax}:QUAlifier" + ) @property - def size(self) -> SearchSearchItemTriggerABusEusbDatabitsSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. + def databits(self) -> SearchSearchItemTriggerABusEusbEopDatabits: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS:SIZe`` command. + """ + return self._databits + + @property + def qualifier(self) -> SearchSearchItemTriggerABusEusbEopQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. **Description:** - - This command sets the number of Sync bits, in bytes, to be used when triggering on a - eUSB bus signal. The trigger condition must be set to SYNC. The search number is - specified by x. + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to EOP Bits. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| INrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier? **Info:** - - ```` specifies the number of the Sync bits. The default Sync bits is 12. The - argument range is 12 to 32 bits. - """ - return self._size + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``INrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. + """ # noqa: E501 + return self._qualifier -class SearchSearchItemTriggerABusEusbCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. +class SearchSearchItemTriggerABusEusbEndsearch(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. **Description:** - - This command sets or queries the search type for the specified search. The search number - is specified by x. + - This command specifies eUSB Search EOP Bits to be On and Off. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition {SYNC| HANDSHAKEPacket| SPECIALPacket| ERRor| TOKENPacket| DATAPacket| RESET| CONNect| CONTROLMESSage| SUSPEND| DEVICEChirp| HOSTChirp| PORTReset| PORTConfiguration| RESUME| RAP| EOP} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition? - - **Info:** - - ``SYNC`` specifies the search condition as Sync. - - ``HANDSHAKEPacket`` specifies the search condition as Handshake Packet. - - ``SPECIALPacket`` specifies the search condition as Special Packet. - - ``ERRor`` specifies the search condition as Error. - - ``TOKENPacket`` specifies the search condition as Token (Address) Packet. - - ``DATAPacket`` specifies the search condition as Data Packet. - - ``RESET`` specifies the search condition as Reset. - - ``CONNect`` specifies the search condition as connect. - - ``CONTROLMESSage`` specifies the search condition as Control Message. - - ``SUSPEND`` specifies the search condition as Suspend. - - ``DEVICEChirp`` specifies the search condition as Device chirp. - - ``HOSTChirp`` specifies the search condition as Host Chirp. - - ``PORTReset`` specifies the search condition as Port Reset. - - ``PORTConfiguration`` specifies the search condition as Port Configuration. - - ``RESUME`` specifies the search condition as Resume. - - ``RAP`` specifies the search condition as Register Access Protocol. - - ``EOP`` specifies the search condition as End of Packet. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusEusbAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. - - **Description:** - - This command sets the binary address value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch {OFF|ON} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ``OFF`` specifies the EOP bits as OFF (for Low Speed and Full Speed). + - ``ON`` specifies the EOP bits as ON (for High Speed). """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEusbAddressHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. +class SearchSearchItemTriggerABusEusbEndpointValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. **Description:** - - This command sets the high binary address value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. + - This command sets the endpoint binary value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters are - 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the data value in the specified valid format. The valid characters + are 0, 1, and X for binary format; A-F, 0-9 and X for hexadecimal format. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEusbAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. +class SearchSearchItemTriggerABusEusbEndpoint(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusEusbAddressHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._value = SearchSearchItemTriggerABusEusbAddressValue( + self._value = SearchSearchItemTriggerABusEusbEndpointValue( device, f"{self._cmd_syntax}:VALue" ) @property - def hivalue(self) -> SearchSearchItemTriggerABusEusbAddressHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. + def value(self) -> SearchSearchItemTriggerABusEusbEndpointValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. **Description:** - - This command sets the high binary address value to be used when triggering on a eUSB - bus signal. The trigger condition must be set to TOKEN. + - This command sets the endpoint binary value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue? **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). + - ```` specifies the data value in the specified valid format. The valid + characters are 0, 1, and X for binary format; A-F, 0-9 and X for hexadecimal format. """ - return self._hivalue + return self._value - @property - def value(self) -> SearchSearchItemTriggerABusEusbAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. - **Description:** - - This command sets the binary address value to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. The search number is specified by - x. +class SearchSearchItemTriggerABusEusbDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue value`` command. + **Description:** + - This command sets the binary data value to be used when triggering on a eUSB bus signal. + The trigger condition must be set to DATA. The search number is specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue? + :: - **Info:** - - ```` specifies the value in the specified valid format. The valid characters - are 0, 1, and X (for binary, for hexadecimal, and symbolic). - """ - return self._value + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue? + + **Info:** + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). + """ + _WRAP_ARG_WITH_QUOTES = True -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusEusb(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB`` command tree. + +class SearchSearchItemTriggerABusEusbDataType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. + + **Description:** + - This command specifies the eUSB trigger type to be valid on any, data0, data1, data2, or + mdata condition. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB?`` - query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe value`` command. - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. - - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. - - ``.endpoint``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. - - ``.endsearch``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. - - ``.eop``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. - - ``.eopbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. - - ``.handshaketype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. - - ``.rap``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. - - ``.sofframenumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. - - ``.specialtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. - - ``.split``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. - - ``.sync``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. - - ``.syncbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. - - ``.syncsearch``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. - - ``.tokentype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe {ANY| DATA0| DATA1| DATA2| MDATA} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe? + + **Info:** + - ``ANY`` specifies either a DATA0 or DATA1 data packet type. + - ``DATA0`` specifies a DATA0 data packet type. + - ``DATA1`` specifies a DATA1 data packet type. + - ``DATA2`` specifies a DATA2 data packet type when on HIGH speed. + - ``MDATA`` specifies a MDATA data packet type when on HIGH speed. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEusbAddress( - device, f"{self._cmd_syntax}:ADDress" - ) - self._condition = SearchSearchItemTriggerABusEusbCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._databits = SearchSearchItemTriggerABusEusbDatabits( - device, f"{self._cmd_syntax}:DATABITS" - ) - self._data = SearchSearchItemTriggerABusEusbData(device, f"{self._cmd_syntax}:DATa") - self._endpoint = SearchSearchItemTriggerABusEusbEndpoint( - device, f"{self._cmd_syntax}:ENDPoint" - ) - self._endsearch = SearchSearchItemTriggerABusEusbEndsearch( - device, f"{self._cmd_syntax}:ENDSEARch" - ) - self._eop = SearchSearchItemTriggerABusEusbEop(device, f"{self._cmd_syntax}:EOP") - self._eopbits = SearchSearchItemTriggerABusEusbEopbits( - device, f"{self._cmd_syntax}:EOPBITS" - ) - self._errtype = SearchSearchItemTriggerABusEusbErrtype( - device, f"{self._cmd_syntax}:ERRType" - ) - self._handshaketype = SearchSearchItemTriggerABusEusbHandshaketype( - device, f"{self._cmd_syntax}:HANDSHAKEType" - ) - self._rap = SearchSearchItemTriggerABusEusbRap(device, f"{self._cmd_syntax}:RAP") - self._sofframenumber = SearchSearchItemTriggerABusEusbSofframenumber( - device, f"{self._cmd_syntax}:SOFFRAMENUMber" - ) - self._specialtype = SearchSearchItemTriggerABusEusbSpecialtype( - device, f"{self._cmd_syntax}:SPECIALType" - ) - self._split = SearchSearchItemTriggerABusEusbSplit(device, f"{self._cmd_syntax}:SPLit") - self._sync = SearchSearchItemTriggerABusEusbSync(device, f"{self._cmd_syntax}:SYNC") - self._syncbits = SearchSearchItemTriggerABusEusbSyncbits( - device, f"{self._cmd_syntax}:SYNCBITS" - ) - self._syncsearch = SearchSearchItemTriggerABusEusbSyncsearch( - device, f"{self._cmd_syntax}:SYNCSEARch" - ) - self._tokentype = SearchSearchItemTriggerABusEusbTokentype( - device, f"{self._cmd_syntax}:TOKENType" - ) - @property - def address(self) -> SearchSearchItemTriggerABusEusbAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. +class SearchSearchItemTriggerABusEusbDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Description:** + - This command sets the length of the data string, in bytes, to be used when triggering on a + eUSB bus signal. The trigger condition must be set to DATA. The search number is specified + by x. - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. - """ - return self._address + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe value`` command. - @property - def condition(self) -> SearchSearchItemTriggerABusEusbCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. + **SCPI Syntax:** - **Description:** - - This command sets or queries the search type for the specified search. The search - number is specified by x. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition value`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe? - **SCPI Syntax:** + **Info:** + - ```` specifies the length of the data string. Default data size value is 1. The + argument range is 1 to 16 bytes. + """ - :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition {SYNC| HANDSHAKEPacket| SPECIALPacket| ERRor| TOKENPacket| DATAPacket| RESET| CONNect| CONTROLMESSage| SUSPEND| DEVICEChirp| HOSTChirp| PORTReset| PORTConfiguration| RESUME| RAP| EOP} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition? +class SearchSearchItemTriggerABusEusbDataQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. - **Info:** - - ``SYNC`` specifies the search condition as Sync. - - ``HANDSHAKEPacket`` specifies the search condition as Handshake Packet. - - ``SPECIALPacket`` specifies the search condition as Special Packet. - - ``ERRor`` specifies the search condition as Error. - - ``TOKENPacket`` specifies the search condition as Token (Address) Packet. - - ``DATAPacket`` specifies the search condition as Data Packet. - - ``RESET`` specifies the search condition as Reset. - - ``CONNect`` specifies the search condition as connect. - - ``CONTROLMESSage`` specifies the search condition as Control Message. - - ``SUSPEND`` specifies the search condition as Suspend. - - ``DEVICEChirp`` specifies the search condition as Device chirp. - - ``HOSTChirp`` specifies the search condition as Host Chirp. - - ``PORTReset`` specifies the search condition as Port Reset. - - ``PORTConfiguration`` specifies the search condition as Port Configuration. - - ``RESUME`` specifies the search condition as Resume. - - ``RAP`` specifies the search condition as Register Access Protocol. - - ``EOP`` specifies the search condition as End of Packet. - """ # noqa: E501 - return self._condition + **Description:** + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to IDANDDATA OR DATA. The search number is specified by x. - @property - def databits(self) -> SearchSearchItemTriggerABusEusbDatabits: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query and raise an AssertionError if - the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. - """ - return self._databits + :: - @property - def data(self) -> SearchSearchItemTriggerABusEusbData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| Inrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + **Info:** + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``Inrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. + """ # noqa: E501 - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. - """ - return self._data - @property - def endpoint(self) -> SearchSearchItemTriggerABusEusbEndpoint: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. +class SearchSearchItemTriggerABusEusbDataOffset(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Description:** + - This command sets the byte offset to look for a data pattern at, in bytes, to be used when + triggering on a eUSB bus signal. The trigger condition must be set to DATA. The search + number is specified by x. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. - """ - return self._endpoint + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet? + + **Info:** + - ```` specifies the byte offset. Default offset value is -1. The argument range is -1 + to 1024. + """ - @property - def endsearch(self) -> SearchSearchItemTriggerABusEusbEndsearch: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. - **Description:** - - This command specifies eUSB Search EOP Bits to be On and Off. The search number is - specified by x. +class SearchSearchItemTriggerABusEusbDataHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch value`` command. + **Description:** + - This command sets the high binary data value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to DATA. The search number is specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch {OFF|ON} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch? + :: - **Info:** - - ``OFF`` specifies the EOP bits as OFF (for Low Speed and Full Speed). - - ``ON`` specifies the EOP bits as ON (for High Speed). - """ - return self._endsearch + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue? - @property - def eop(self) -> SearchSearchItemTriggerABusEusbEop: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. + **Info:** + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query and raise an AssertionError if the - returned value does not match ``value``. + _WRAP_ARG_WITH_QUOTES = True - Sub-properties: - - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. - """ - return self._eop - @property - def eopbits(self) -> SearchSearchItemTriggerABusEusbEopbits: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. +class SearchSearchItemTriggerABusEusbData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - Sub-properties: - - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. - - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. - """ - return self._eopbits + Properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._hivalue = SearchSearchItemTriggerABusEusbDataHivalue( + device, f"{self._cmd_syntax}:HIVALue" + ) + self._offset = SearchSearchItemTriggerABusEusbDataOffset( + device, f"{self._cmd_syntax}:OFFSet" + ) + self._qualifier = SearchSearchItemTriggerABusEusbDataQualifier( + device, f"{self._cmd_syntax}:QUAlifier" + ) + self._size = SearchSearchItemTriggerABusEusbDataSize(device, f"{self._cmd_syntax}:SIZe") + self._type = SearchSearchItemTriggerABusEusbDataType(device, f"{self._cmd_syntax}:TYPe") + self._value = SearchSearchItemTriggerABusEusbDataValue(device, f"{self._cmd_syntax}:VALue") @property - def errtype(self) -> SearchSearchItemTriggerABusEusbErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. + def hivalue(self) -> SearchSearchItemTriggerABusEusbDataHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on a PID, Token CRC5, Data - CRC16, or Bit stuffing condition. The search number is specified by x. + - This command sets the high binary data value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to DATA. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType {BITSTUFFing|CRC5|CRC16|PID} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue? **Info:** - - ``BITSTUFFing`` specifies the error type as Bit Stuffing. - - ``CRC5`` specifies the error type as Token CRC5 (Cyclic Redundancy Check 5). - - ``CRC16`` specifies the error type as Data CRC16 (Cyclic Redundancy Check 16). - - ``PID`` specifies the error type as PID Check Bits. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - return self._errtype + return self._hivalue @property - def handshaketype(self) -> SearchSearchItemTriggerABusEusbHandshaketype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. + def offset(self) -> SearchSearchItemTriggerABusEusbDataOffset: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on any, ack, nak, stall, or - nyet condition. The search number is specified by x. + - This command sets the byte offset to look for a data pattern at, in bytes, to be used + when triggering on a eUSB bus signal. The trigger condition must be set to DATA. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType {ANY|ACK|NAK|STALL|NYET} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet? **Info:** - - ``ANY`` specifies the handshake type as Any (0010). - - ``ACK`` specifies the handshake type as Acknowledgement (positive) (XX10). - - ``NAK`` specifies the handshake type as Negative Acknowledgment (1010). - - ``STALL`` specifies the error type as PID Check Bits. - - ``NYET`` specifies the handshake type as Stall (endpoint is halted or control pipe - request not supported) (1110). - """ - return self._handshaketype - - @property - def rap(self) -> SearchSearchItemTriggerABusEusbRap: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. - - ``.option``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + - ```` specifies the byte offset. Default offset value is -1. The argument range is + -1 to 1024. """ - return self._rap + return self._offset @property - def sofframenumber(self) -> SearchSearchItemTriggerABusEusbSofframenumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. + def qualifier(self) -> SearchSearchItemTriggerABusEusbDataQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. **Description:** - - This command sets the binary frame number to be used when triggering on a eUSB bus - signal. The trigger condition must be set to TOKEN. The search number is specified by + - This command sets the qualifier to be used when triggering on a eUSB bus signal. The + trigger condition must be set to IDANDDATA OR DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier {EQual| UNEQual| LESSthan| MOREthan| LESSEQual| MOREEQual| Inrange| OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier? **Info:** - - ```` specifies the binary frame number within the range 000 0000 0000 to 111 - 1111 1111 (000 hex to 7FF hex). - """ - return self._sofframenumber + - ``EQual`` specifies the qualifier as Equal. + - ``UNEQual`` specifies the qualifier as Not Equal to. + - ``LESSthan`` specifies the qualifier as Less Than. + - ``MOREthan`` specifies the qualifier as More Than. + - ``LESSEQual`` specifies the qualifier as Less Than or Equal to. + - ``MOREEQual`` specifies the qualifier as More Than or Equal to. + - ``Inrange`` specifies the qualifier as Inside Range. + - ``OUTrange`` specifies the qualifier as Out of Range. + """ # noqa: E501 + return self._qualifier @property - def specialtype(self) -> SearchSearchItemTriggerABusEusbSpecialtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. + def size(self) -> SearchSearchItemTriggerABusEusbDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on any, err, split, ping, or - reserved condition. The search number is specified by x. + - This command sets the length of the data string, in bytes, to be used when triggering + on a eUSB bus signal. The trigger condition must be set to DATA. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType {ANY| PREamble| ERROr| SPLit| PING| RESERVed} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe? **Info:** - - ``ANY`` specifies the PID value as Any (XX00). - - ``PREamble`` specifies the PID value as PRE (1100). - - ``ERROr`` specifies the PID value as ERR (1100). - - ``SPLit`` specifies the PID value as Split (1000). - - ``PING`` specifies the PID value as PING (0100). - - ``RESERVed`` specifies the PID value as Reserved (0000). - """ # noqa: E501 - return self._specialtype - - @property - def split(self) -> SearchSearchItemTriggerABusEusbSplit: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.et``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. - - ``.hub``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. - - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. - - ``.sc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. - - ``.se``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. - """ - return self._split - - @property - def sync(self) -> SearchSearchItemTriggerABusEusbSync: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. - """ - return self._sync - - @property - def syncbits(self) -> SearchSearchItemTriggerABusEusbSyncbits: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Sub-properties: - - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. - - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. + - ```` specifies the length of the data string. Default data size value is 1. The + argument range is 1 to 16 bytes. """ - return self._syncbits + return self._size @property - def syncsearch(self) -> SearchSearchItemTriggerABusEusbSyncsearch: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. + def type(self) -> SearchSearchItemTriggerABusEusbDataType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. **Description:** - - This command specifies eUSB Search Sync Bits to be On and Off. The search number is - specified by x. + - This command specifies the eUSB trigger type to be valid on any, data0, data1, data2, + or mdata condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch {OFF|ON} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe {ANY| DATA0| DATA1| DATA2| MDATA} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe? **Info:** - - ``OFF`` specifies the Sync bits as OFF (for Low Speed and Full Speed). - - ``ON`` specifies the Sync bits as ON (for High Speed). + - ``ANY`` specifies either a DATA0 or DATA1 data packet type. + - ``DATA0`` specifies a DATA0 data packet type. + - ``DATA1`` specifies a DATA1 data packet type. + - ``DATA2`` specifies a DATA2 data packet type when on HIGH speed. + - ``MDATA`` specifies a MDATA data packet type when on HIGH speed. """ - return self._syncsearch + return self._type @property - def tokentype(self) -> SearchSearchItemTriggerABusEusbTokentype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. + def value(self) -> SearchSearchItemTriggerABusEusbDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. **Description:** - - This command specifies the eUSB trigger type to be valid on any, sof, out, in, or - setup condition. The search number is specified by x. + - This command sets the binary data value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to DATA. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType {ANY|SOF|OUT|IN|SETUP} - - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue? **Info:** - - ``ANY`` specifies the token type as Any (XX01). - - ``SOF`` specifies the token type as Start Of Frame (0101). - - ``OUT`` specifies the token type as OUT (0001). - - ``IN`` specifies the token type as IN (1001). - - ``SETUP`` specifies the token type as SETUP (1101). + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - return self._tokentype + return self._value -class SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. +class SearchSearchItemTriggerABusEusbDatabitsSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. **Description:** - - This command specifies the binary source port value to use when searching on an Ethernet - bus signal. The search condition needs to be set to TCPHeader. The search number is - specified by x. + - This command sets the number of Sync bits, in bytes, to be used when triggering on a eUSB + bus signal. The trigger condition must be set to SYNC. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. + - ```` specifies the number of the Sync bits. The default Sync bits is 12. The argument + range is 12 to 32 bits. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEthernetTcpheaderSourceport(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` command tree. +class SearchSearchItemTriggerABusEusbDatabits(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` - command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._size = SearchSearchItemTriggerABusEusbDatabitsSize(device, f"{self._cmd_syntax}:SIZe") @property - def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusEusbDatabitsSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. **Description:** - - This command specifies the binary source port value to use when searching on an - Ethernet bus signal. The search condition needs to be set to TCPHeader. The search - number is specified by x. + - This command sets the number of Sync bits, in bytes, to be used when triggering on a + eUSB bus signal. The trigger condition must be set to SYNC. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ```` specifies the number of the Sync bits. The default Sync bits is 12. The + argument range is 12 to 32 bits. """ - return self._value + return self._size -class SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. +class SearchSearchItemTriggerABusEusbCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. **Description:** - - This command specifies the binary sequence number value to use when searching on an - Ethernet bus signal. The default is all X's (don't care). The search condition needs to be - set to TCPHeader. The search number is specified by x. + - This command sets or queries the search type for the specified search. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition {SYNC| HANDSHAKEPacket| SPECIALPacket| ERRor| TOKENPacket| DATAPacket| RESET| CONNect| CONTROLMESSage| SUSPEND| DEVICEChirp| HOSTChirp| PORTReset| PORTConfiguration| RESUME| RAP| EOP} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition? **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ + - ``SYNC`` specifies the search condition as Sync. + - ``HANDSHAKEPacket`` specifies the search condition as Handshake Packet. + - ``SPECIALPacket`` specifies the search condition as Special Packet. + - ``ERRor`` specifies the search condition as Error. + - ``TOKENPacket`` specifies the search condition as Token (Address) Packet. + - ``DATAPacket`` specifies the search condition as Data Packet. + - ``RESET`` specifies the search condition as Reset. + - ``CONNect`` specifies the search condition as connect. + - ``CONTROLMESSage`` specifies the search condition as Control Message. + - ``SUSPEND`` specifies the search condition as Suspend. + - ``DEVICEChirp`` specifies the search condition as Device chirp. + - ``HOSTChirp`` specifies the search condition as Host Chirp. + - ``PORTReset`` specifies the search condition as Port Reset. + - ``PORTConfiguration`` specifies the search condition as Port Configuration. + - ``RESUME`` specifies the search condition as Resume. + - ``RAP`` specifies the search condition as Register Access Protocol. + - ``EOP`` specifies the search condition as End of Packet. + """ # noqa: E501 - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusEusbAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. -class SearchSearchItemTriggerABusEthernetTcpheaderSeqnum(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command tree. + **Description:** + - This command sets the binary address value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` - command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. - - **Description:** - - This command specifies the binary sequence number value to use when searching on an - Ethernet bus signal. The default is all X's (don't care). The search condition needs - to be set to TCPHeader. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue? - **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. - """ - return self._value + **Info:** + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). + """ + + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. +class SearchSearchItemTriggerABusEusbAddressHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. **Description:** - - This command specifies the binary destination port value to use when searching on the - Ethernet TCP header destination port number. The search condition needs to be set to - TCPHeader. The search number is specified by x. + - This command sets the high binary address value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. + - ```` specifies the value in the specified valid format. The valid characters are + 0, 1, and X (for binary, for hexadecimal, and symbolic). """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetTcpheaderDestinationport(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. +class SearchSearchItemTriggerABusEusbAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue( + self._hivalue = SearchSearchItemTriggerABusEusbAddressHivalue( + device, f"{self._cmd_syntax}:HIVALue" + ) + self._value = SearchSearchItemTriggerABusEusbAddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. + def hivalue(self) -> SearchSearchItemTriggerABusEusbAddressHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. **Description:** - - This command specifies the binary destination port value to use when searching on the - Ethernet TCP header destination port number. The search condition needs to be set to - TCPHeader. The search number is specified by x. + - This command sets the high binary address value to be used when triggering on a eUSB + bus signal. The trigger condition must be set to TOKEN. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue value`` - command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ - return self._value - - -class SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` command. - - **Description:** - - This command specifies the binary ack number value to use when searching on an Ethernet - bus signal. The default is all X's (don't care). The search condition needs to be set to - TCPHeader. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue? - - **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEthernetTcpheaderAcknum(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` - command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue( - device, f"{self._cmd_syntax}:VALue" - ) + return self._hivalue @property - def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEusbAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. **Description:** - - This command specifies the binary ack number value to use when searching on an - Ethernet bus signal. The default is all X's (don't care). The search condition needs - to be set to TCPHeader. The search number is specified by x. + - This command sets the binary address value to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue? **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ```` specifies the value in the specified valid format. The valid characters + are 0, 1, and X (for binary, for hexadecimal, and symbolic). """ return self._value -class SearchSearchItemTriggerABusEthernetTcpheader(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusEusb(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query and raise an AssertionError - if the returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB?`` + query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB?`` + query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.acknum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command - tree. - - ``.destinationport``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. - - ``.seqnum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command - tree. - - ``.sourceport``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` - command tree. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. + - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. + - ``.endpoint``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. + - ``.endsearch``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. + - ``.eop``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. + - ``.eopbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. + - ``.handshaketype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. + - ``.rap``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. + - ``.sofframenumber``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. + - ``.specialtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. + - ``.split``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. + - ``.sync``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. + - ``.syncbits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. + - ``.syncsearch``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. + - ``.tokentype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._acknum = SearchSearchItemTriggerABusEthernetTcpheaderAcknum( - device, f"{self._cmd_syntax}:ACKnum" + self._address = SearchSearchItemTriggerABusEusbAddress( + device, f"{self._cmd_syntax}:ADDress" ) - self._destinationport = SearchSearchItemTriggerABusEthernetTcpheaderDestinationport( - device, f"{self._cmd_syntax}:DESTinationport" + self._condition = SearchSearchItemTriggerABusEusbCondition( + device, f"{self._cmd_syntax}:CONDition" ) - self._seqnum = SearchSearchItemTriggerABusEthernetTcpheaderSeqnum( - device, f"{self._cmd_syntax}:SEQnum" + self._databits = SearchSearchItemTriggerABusEusbDatabits( + device, f"{self._cmd_syntax}:DATABITS" ) - self._sourceport = SearchSearchItemTriggerABusEthernetTcpheaderSourceport( - device, f"{self._cmd_syntax}:SOUrceport" + self._data = SearchSearchItemTriggerABusEusbData(device, f"{self._cmd_syntax}:DATa") + self._endpoint = SearchSearchItemTriggerABusEusbEndpoint( + device, f"{self._cmd_syntax}:ENDPoint" + ) + self._endsearch = SearchSearchItemTriggerABusEusbEndsearch( + device, f"{self._cmd_syntax}:ENDSEARch" + ) + self._eop = SearchSearchItemTriggerABusEusbEop(device, f"{self._cmd_syntax}:EOP") + self._eopbits = SearchSearchItemTriggerABusEusbEopbits( + device, f"{self._cmd_syntax}:EOPBITS" + ) + self._errtype = SearchSearchItemTriggerABusEusbErrtype( + device, f"{self._cmd_syntax}:ERRType" + ) + self._handshaketype = SearchSearchItemTriggerABusEusbHandshaketype( + device, f"{self._cmd_syntax}:HANDSHAKEType" + ) + self._rap = SearchSearchItemTriggerABusEusbRap(device, f"{self._cmd_syntax}:RAP") + self._sofframenumber = SearchSearchItemTriggerABusEusbSofframenumber( + device, f"{self._cmd_syntax}:SOFFRAMENUMber" + ) + self._specialtype = SearchSearchItemTriggerABusEusbSpecialtype( + device, f"{self._cmd_syntax}:SPECIALType" + ) + self._split = SearchSearchItemTriggerABusEusbSplit(device, f"{self._cmd_syntax}:SPLit") + self._sync = SearchSearchItemTriggerABusEusbSync(device, f"{self._cmd_syntax}:SYNC") + self._syncbits = SearchSearchItemTriggerABusEusbSyncbits( + device, f"{self._cmd_syntax}:SYNCBITS" + ) + self._syncsearch = SearchSearchItemTriggerABusEusbSyncsearch( + device, f"{self._cmd_syntax}:SYNCSEARch" + ) + self._tokentype = SearchSearchItemTriggerABusEusbTokentype( + device, f"{self._cmd_syntax}:TOKENType" ) @property - def acknum(self) -> SearchSearchItemTriggerABusEthernetTcpheaderAcknum: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command tree. + def address(self) -> SearchSearchItemTriggerABusEusbAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` - command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:HIVALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ADDress:VALue`` command. """ - return self._acknum + return self._address @property - def destinationport(self) -> SearchSearchItemTriggerABusEthernetTcpheaderDestinationport: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. + def condition(self) -> SearchSearchItemTriggerABusEusbCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition`` command. + + **Description:** + - This command sets or queries the search type for the specified search. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition value`` command. - Sub-properties: - - ``.value``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. - """ - return self._destinationport + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition {SYNC| HANDSHAKEPacket| SPECIALPacket| ERRor| TOKENPacket| DATAPacket| RESET| CONNect| CONTROLMESSage| SUSPEND| DEVICEChirp| HOSTChirp| PORTReset| PORTConfiguration| RESUME| RAP| EOP} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:CONDition? + + **Info:** + - ``SYNC`` specifies the search condition as Sync. + - ``HANDSHAKEPacket`` specifies the search condition as Handshake Packet. + - ``SPECIALPacket`` specifies the search condition as Special Packet. + - ``ERRor`` specifies the search condition as Error. + - ``TOKENPacket`` specifies the search condition as Token (Address) Packet. + - ``DATAPacket`` specifies the search condition as Data Packet. + - ``RESET`` specifies the search condition as Reset. + - ``CONNect`` specifies the search condition as connect. + - ``CONTROLMESSage`` specifies the search condition as Control Message. + - ``SUSPEND`` specifies the search condition as Suspend. + - ``DEVICEChirp`` specifies the search condition as Device chirp. + - ``HOSTChirp`` specifies the search condition as Host Chirp. + - ``PORTReset`` specifies the search condition as Port Reset. + - ``PORTConfiguration`` specifies the search condition as Port Configuration. + - ``RESUME`` specifies the search condition as Resume. + - ``RAP`` specifies the search condition as Register Access Protocol. + - ``EOP`` specifies the search condition as End of Packet. + """ # noqa: E501 + return self._condition @property - def seqnum(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSeqnum: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command tree. + def databits(self) -> SearchSearchItemTriggerABusEusbDatabits: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` - command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. """ - return self._seqnum + return self._databits @property - def sourceport(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSourceport: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` command tree. + def data(self) -> SearchSearchItemTriggerABusEusbData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` - command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:QUAlifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:SIZe`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATa:VALue`` command. """ - return self._sourceport - - -class SearchSearchItemTriggerABusEthernetQtagValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. - - **Description:** - - This command specifies the binary Q-tag information to use when searching on an Ethernet - bus signal. The search condition needs to be set to QTAG. The search number is specified - by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue? - - **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEthernetQtag(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. + return self._data - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query and raise an AssertionError if the - returned value does not match ``value``. + @property + def endpoint(self) -> SearchSearchItemTriggerABusEusbEndpoint: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetQtagValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDPoint:VALue`` command. + """ + return self._endpoint @property - def value(self) -> SearchSearchItemTriggerABusEthernetQtagValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. + def endsearch(self) -> SearchSearchItemTriggerABusEusbEndsearch: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch`` command. **Description:** - - This command specifies the binary Q-tag information to use when searching on an - Ethernet bus signal. The search condition needs to be set to QTAG. The search number - is specified by x. + - This command specifies eUSB Search EOP Bits to be On and Off. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch {OFF|ON} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ENDSEARch? **Info:** - - ```` is a quoted string of up to 32 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ``OFF`` specifies the EOP bits as OFF (for Low Speed and Full Speed). + - ``ON`` specifies the EOP bits as ON (for High Speed). """ - return self._value - + return self._endsearch -class SearchSearchItemTriggerABusEthernetMacLengthValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. + @property + def eop(self) -> SearchSearchItemTriggerABusEusbEop: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP`` command tree. - **Description:** - - This command specifies the MAC length value to use when searching on an Ethernet bus - signal. The search condition needs to be set to MACADDRess. The search number is specified - by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue value`` command. + Sub-properties: + - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:DATABITS`` command tree. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOP:QUAlifier`` command. + """ + return self._eop - **SCPI Syntax:** + @property + def eopbits(self) -> SearchSearchItemTriggerABusEusbEopbits: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS?`` query and raise an AssertionError if + the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue? + Sub-properties: + - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX`` command tree. + - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MIN`` command tree. + """ + return self._eopbits - **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ + @property + def errtype(self) -> SearchSearchItemTriggerABusEusbErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType`` command. - _WRAP_ARG_WITH_QUOTES = True + **Description:** + - This command specifies the eUSB trigger type to be valid on a PID, Token CRC5, Data + CRC16, or Bit stuffing condition. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType value`` command. -class SearchSearchItemTriggerABusEthernetMacLengthHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. + **SCPI Syntax:** - **Description:** - - This command specifies the binary MAC length high value to use when searching on an - Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number - is specified by x. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue value`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType {BITSTUFFing|CRC5|CRC16|PID} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:ERRType? - **SCPI Syntax:** + **Info:** + - ``BITSTUFFing`` specifies the error type as Bit Stuffing. + - ``CRC5`` specifies the error type as Token CRC5 (Cyclic Redundancy Check 5). + - ``CRC16`` specifies the error type as Data CRC16 (Cyclic Redundancy Check 16). + - ``PID`` specifies the error type as PID Check Bits. + """ + return self._errtype - :: + @property + def handshaketype(self) -> SearchSearchItemTriggerABusEusbHandshaketype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType`` command. - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue? + **Description:** + - This command specifies the eUSB trigger type to be valid on any, ack, nak, stall, or + nyet condition. The search number is specified by x. - **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType value`` command. - _WRAP_ARG_WITH_QUOTES = True + **SCPI Syntax:** + + :: + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType {ANY|ACK|NAK|STALL|NYET} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:HANDSHAKEType? -class SearchSearchItemTriggerABusEthernetMacLength(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. + **Info:** + - ``ANY`` specifies the handshake type as Any (0010). + - ``ACK`` specifies the handshake type as Acknowledgement (positive) (XX10). + - ``NAK`` specifies the handshake type as Negative Acknowledgment (1010). + - ``STALL`` specifies the error type as PID Check Bits. + - ``NYET`` specifies the handshake type as Stall (endpoint is halted or control pipe + request not supported) (1110). + """ + return self._handshaketype - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query and raise an AssertionError - if the returned value does not match ``value``. + @property + def rap(self) -> SearchSearchItemTriggerABusEusbRap: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP`` command tree. - Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP?`` query and raise an AssertionError if the + returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusEthernetMacLengthHivalue( - device, f"{self._cmd_syntax}:HIVALue" - ) - self._value = SearchSearchItemTriggerABusEthernetMacLengthValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:ADDress`` command tree. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:COMMand`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:DATa`` command tree. + - ``.option``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:RAP:OPTion`` command. + """ + return self._rap @property - def hivalue(self) -> SearchSearchItemTriggerABusEthernetMacLengthHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. + def sofframenumber(self) -> SearchSearchItemTriggerABusEusbSofframenumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber`` command. **Description:** - - This command specifies the binary MAC length high value to use when searching on an - Ethernet bus signal. The search condition needs to be set to MACADDRess. The search - number is specified by x. + - This command sets the binary frame number to be used when triggering on a eUSB bus + signal. The trigger condition must be set to TOKEN. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SOFFRAMENUMber? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ```` specifies the binary frame number within the range 000 0000 0000 to 111 + 1111 1111 (000 hex to 7FF hex). """ - return self._hivalue + return self._sofframenumber @property - def value(self) -> SearchSearchItemTriggerABusEthernetMacLengthValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. + def specialtype(self) -> SearchSearchItemTriggerABusEusbSpecialtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType`` command. **Description:** - - This command specifies the MAC length value to use when searching on an Ethernet bus - signal. The search condition needs to be set to MACADDRess. The search number is - specified by x. + - This command specifies the eUSB trigger type to be valid on any, err, split, ping, or + reserved condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType {ANY| PREamble| ERROr| SPLit| PING| RESERVed} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPECIALType? **Info:** - - ```` is a quoted string of up to 16 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. - """ - return self._value + - ``ANY`` specifies the PID value as Any (XX00). + - ``PREamble`` specifies the PID value as PRE (1100). + - ``ERROr`` specifies the PID value as ERR (1100). + - ``SPLit`` specifies the PID value as Split (1000). + - ``PING`` specifies the PID value as PING (0100). + - ``RESERVed`` specifies the PID value as Reserved (0000). + """ # noqa: E501 + return self._specialtype + @property + def split(self) -> SearchSearchItemTriggerABusEusbSplit: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit`` command tree. -class SearchSearchItemTriggerABusEthernetMacAddressSourceValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Description:** - - This command specifies the binary MAC address source value to use when searching on an - Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number - is specified by x. + Sub-properties: + - ``.et``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:ET`` command tree. + - ``.hub``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:HUB`` command tree. + - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:PORT`` command tree. + - ``.sc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SC`` command tree. + - ``.se``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SPLit:SE`` command tree. + """ + return self._split - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue value`` command. + @property + def sync(self) -> SearchSearchItemTriggerABusEusbSync: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC?`` query and raise an AssertionError if the + returned value does not match ``value``. - :: + Sub-properties: + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNC:QUAlifier`` command. + """ + return self._sync - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue? + @property + def syncbits(self) -> SearchSearchItemTriggerABusEusbSyncbits: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS`` command tree. - **Info:** - - ```` is a quoted string of up to 48 characters where the allowable characters are - 0, 1, and X. The bits specified in the quoted string replace the least significant bits, - leaving any unspecified upper bits unchanged. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS?`` query and raise an AssertionError if + the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.max``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX`` command tree. + - ``.min``: The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN`` command tree. + """ + return self._syncbits + @property + def syncsearch(self) -> SearchSearchItemTriggerABusEusbSyncsearch: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch`` command. -class SearchSearchItemTriggerABusEthernetMacAddressSource(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command tree. + **Description:** + - This command specifies eUSB Search Sync Bits to be On and Off. The search number is + specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` - command. - """ + **SCPI Syntax:** - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetMacAddressSourceValue( - device, f"{self._cmd_syntax}:VALue" - ) + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch {OFF|ON} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCSEARch? + + **Info:** + - ``OFF`` specifies the Sync bits as OFF (for Low Speed and Full Speed). + - ``ON`` specifies the Sync bits as ON (for High Speed). + """ + return self._syncsearch @property - def value(self) -> SearchSearchItemTriggerABusEthernetMacAddressSourceValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` command. + def tokentype(self) -> SearchSearchItemTriggerABusEusbTokentype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType`` command. **Description:** - - This command specifies the binary MAC address source value to use when searching on an - Ethernet bus signal. The search condition needs to be set to MACADDRess. The search - number is specified by x. + - This command specifies the eUSB trigger type to be valid on any, sof, out, in, or + setup condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType {ANY|SOF|OUT|IN|SETUP} + - SEARCH:SEARCH:TRIGger:A:BUS:EUSB:TOKENType? **Info:** - - ```` is a quoted string of up to 48 characters where the allowable characters - are 0, 1, and X. The bits specified in the quoted string replace the least significant - bits, leaving any unspecified upper bits unchanged. + - ``ANY`` specifies the token type as Any (XX01). + - ``SOF`` specifies the token type as Start Of Frame (0101). + - ``OUT`` specifies the token type as OUT (0001). + - ``IN`` specifies the token type as IN (1001). + - ``SETUP`` specifies the token type as SETUP (1101). """ - return self._value + return self._tokentype -class SearchSearchItemTriggerABusEthernetMacAddressDestinationValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. +class SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. **Description:** - - This command specifies the binary MAC address destination value to use when searching on - an Ethernet bus signal. The search condition needs to be set to MACADDRess. The search - number is specified by x. + - This command specifies the binary source port value to use when searching on an Ethernet + bus signal. The search condition needs to be set to TCPHeader. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue? **Info:** - - ```` is a quoted string of up to 48 characters where the allowable characters are + - ```` is a quoted string of up to 16 characters where the allowable characters are 0, 1, and X. The bits specified in the quoted string replace the least significant bits, leaving any unspecified upper bits unchanged. """ @@ -35307,207 +36062,83 @@ class SearchSearchItemTriggerABusEthernetMacAddressDestinationValue(SCPICmdWrite _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetMacAddressDestination(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. +class SearchSearchItemTriggerABusEthernetTcpheaderSourceport(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetMacAddressDestinationValue( + self._value = SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetMacAddressDestinationValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSourceportValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. **Description:** - - This command specifies the binary MAC address destination value to use when searching - on an Ethernet bus signal. The search condition needs to be set to MACADDRess. The - search number is specified by x. + - This command specifies the binary source port value to use when searching on an + Ethernet bus signal. The search condition needs to be set to TCPHeader. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query and + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue value`` - command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue? **Info:** - - ```` is a quoted string of up to 48 characters where the allowable characters + - ```` is a quoted string of up to 16 characters where the allowable characters are 0, 1, and X. The bits specified in the quoted string replace the least significant bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthernetMacAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Properties: - - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` - command tree. - - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command - tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._destination = SearchSearchItemTriggerABusEthernetMacAddressDestination( - device, f"{self._cmd_syntax}:DESTination" - ) - self._source = SearchSearchItemTriggerABusEthernetMacAddressSource( - device, f"{self._cmd_syntax}:SOUrce" - ) - - @property - def destination(self) -> SearchSearchItemTriggerABusEthernetMacAddressDestination: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. - """ - return self._destination - - @property - def source(self) -> SearchSearchItemTriggerABusEthernetMacAddressSource: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` - command. - """ - return self._source - - -class SearchSearchItemTriggerABusEthernetMac(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEthernetMacAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) - self._length = SearchSearchItemTriggerABusEthernetMacLength( - device, f"{self._cmd_syntax}:LENgth" - ) - - @property - def address(self) -> SearchSearchItemTriggerABusEthernetMacAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.destination``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. - - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` - command tree. - """ - return self._address - - @property - def length(self) -> SearchSearchItemTriggerABusEthernetMacLength: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. - """ - return self._length - - -class SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` command. +class SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. **Description:** - - This command specifies the binary source address value to use when searching on an - Ethernet bus signal. The search condition needs to be set to IPHeader. The search number - is specified by x. + - This command specifies the binary sequence number value to use when searching on an + Ethernet bus signal. The default is all X's (don't care). The search condition needs to be + set to TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue? **Info:** - ```` is a quoted string of up to 32 characters where the allowable characters are @@ -35518,51 +36149,51 @@ class SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue(SCPICmdWrite, S _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetIpheaderSourceaddr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` command tree. +class SearchSearchItemTriggerABusEthernetTcpheaderSeqnum(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue( + self._value = SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSeqnumValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. **Description:** - - This command specifies the binary source address value to use when searching on an - Ethernet bus signal. The search condition needs to be set to IPHeader. The search - number is specified by x. + - This command specifies the binary sequence number value to use when searching on an + Ethernet bus signal. The default is all X's (don't care). The search condition needs + to be set to TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue? **Info:** - ```` is a quoted string of up to 32 characters where the allowable characters @@ -35572,32 +36203,32 @@ def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue: return self._value -class SearchSearchItemTriggerABusEthernetIpheaderProtocolValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` command. +class SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. **Description:** - - This command specifies the binary protocol value to use when searching on the Ethernet bus - signal. The search condition needs to be set to IPHeader. The search number is specified - by x. + - This command specifies the binary destination port value to use when searching on the + Ethernet TCP header destination port number. The search condition needs to be set to + TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue? **Info:** - - ```` is a quoted string of up to 8 characters where the allowable characters are + - ```` is a quoted string of up to 16 characters where the allowable characters are 0, 1, and X. The bits specified in the quoted string replace the least significant bits, leaving any unspecified upper bits unchanged. """ @@ -35605,83 +36236,84 @@ class SearchSearchItemTriggerABusEthernetIpheaderProtocolValue(SCPICmdWrite, SCP _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetIpheaderProtocol(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command tree. +class SearchSearchItemTriggerABusEthernetTcpheaderDestinationport(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` - command. + - ``.value``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetIpheaderProtocolValue( + self._value = SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderProtocolValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderDestinationportValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. **Description:** - - This command specifies the binary protocol value to use when searching on the Ethernet - bus signal. The search condition needs to be set to IPHeader. The search number is - specified by x. + - This command specifies the binary destination port value to use when searching on the + Ethernet TCP header destination port number. The search condition needs to be set to + TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue value`` + command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue? **Info:** - - ```` is a quoted string of up to 8 characters where the allowable characters + - ```` is a quoted string of up to 16 characters where the allowable characters are 0, 1, and X. The bits specified in the quoted string replace the least significant bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. +class SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` command. **Description:** - - This command specifies the binary destination address value to use when searching on an - Ethernet bus signal. The search condition needs to be set to IPHeader. The search number - is specified by x. + - This command specifies the binary ack number value to use when searching on an Ethernet + bus signal. The default is all X's (don't care). The search condition needs to be set to + TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue? **Info:** - ```` is a quoted string of up to 32 characters where the allowable characters are @@ -35692,52 +36324,51 @@ class SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue(SCPICmdWri _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. +class SearchSearchItemTriggerABusEthernetTcpheaderAcknum(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue( + self._value = SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetTcpheaderAcknumValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` command. **Description:** - - This command specifies the binary destination address value to use when searching on - an Ethernet bus signal. The search condition needs to be set to IPHeader. The search - number is specified by x. + - This command specifies the binary ack number value to use when searching on an + Ethernet bus signal. The default is all X's (don't care). The search condition needs + to be set to TCPHeader. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue value`` - command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue? **Info:** - ```` is a quoted string of up to 32 characters where the allowable characters @@ -35747,6255 +36378,6124 @@ def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrVal return self._value -class SearchSearchItemTriggerABusEthernetIpheader(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. +class SearchSearchItemTriggerABusEthernetTcpheader(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.destinationaddr``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. - - ``.protocol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command + - ``.acknum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command tree. - - ``.sourceaddr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` + - ``.destinationport``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. + - ``.seqnum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command + tree. + - ``.sourceport``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._destinationaddr = SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr( - device, f"{self._cmd_syntax}:DESTinationaddr" + self._acknum = SearchSearchItemTriggerABusEthernetTcpheaderAcknum( + device, f"{self._cmd_syntax}:ACKnum" ) - self._protocol = SearchSearchItemTriggerABusEthernetIpheaderProtocol( - device, f"{self._cmd_syntax}:PROTOcol" + self._destinationport = SearchSearchItemTriggerABusEthernetTcpheaderDestinationport( + device, f"{self._cmd_syntax}:DESTinationport" ) - self._sourceaddr = SearchSearchItemTriggerABusEthernetIpheaderSourceaddr( - device, f"{self._cmd_syntax}:SOUrceaddr" + self._seqnum = SearchSearchItemTriggerABusEthernetTcpheaderSeqnum( + device, f"{self._cmd_syntax}:SEQnum" + ) + self._sourceport = SearchSearchItemTriggerABusEthernetTcpheaderSourceport( + device, f"{self._cmd_syntax}:SOUrceport" ) @property - def destinationaddr(self) -> SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. + def acknum(self) -> SearchSearchItemTriggerABusEthernetTcpheaderAcknum: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query and raise + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum:VALue`` + command. + """ + return self._acknum + + @property + def destinationport(self) -> SearchSearchItemTriggerABusEthernetTcpheaderDestinationport: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - ``.value``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport:VALue`` command. """ - return self._destinationaddr + return self._destinationport @property - def protocol(self) -> SearchSearchItemTriggerABusEthernetIpheaderProtocol: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command tree. + def seqnum(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSeqnum: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum:VALue`` command. """ - return self._protocol + return self._seqnum @property - def sourceaddr(self) -> SearchSearchItemTriggerABusEthernetIpheaderSourceaddr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` command tree. + def sourceport(self) -> SearchSearchItemTriggerABusEthernetTcpheaderSourceport: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport:VALue`` command. """ - return self._sourceaddr + return self._sourceport -class SearchSearchItemTriggerABusEthernetDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. +class SearchSearchItemTriggerABusEthernetQtagValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. **Description:** - - This command specifies the binary value to use when searching on the Ethernet bus signal. - The search condition needs to be set to DATa. The search number is specified by x. + - This command specifies the binary Q-tag information to use when searching on an Ethernet + bus signal. The search condition needs to be set to QTAG. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue? **Info:** - - ```` is a quoted string where the allowable characters are 0, 1, and X. The - allowable number of characters depends on the setting for size (using - ``SEARCH:SEARCHX:TRIGGER:A:BUS:ETHERNET:DATA:SIZE``). The bits specified in the quoted - string replace the least significant bits, leaving any unspecified upper bits unchanged. + - ```` is a quoted string of up to 32 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string, in bytes, to use when searching on - the Ethernet bus signal. The search condition needs to be set to DATa. The search number - is specified by x. +class SearchSearchItemTriggerABusEthernetQtag(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe? + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Info:** - - ```` specifies the length of the data string, in bytes. The minimum and default - values are 1, and the maximum value is 16. + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. """ + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthernetQtagValue( + device, f"{self._cmd_syntax}:VALue" + ) -class SearchSearchItemTriggerABusEthernetDataQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. + @property + def value(self) -> SearchSearchItemTriggerABusEthernetQtagValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. - **Description:** - - This command specifies the qualifier to be used when searching on an Ethernet bus signal. - The search condition must be set to DATa. The search number is specified by x. + **Description:** + - This command specifies the binary Q-tag information to use when searching on an + Ethernet bus signal. The search condition needs to be set to QTAG. The search number + is specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier {LESSthan|MOREthan|EQual|UNEQual|LESSEQual|MOREEQual| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue? - **Info:** - - ``LESSthan`` sets the qualifier to less than. - - ``MOREthan`` sets the qualifier to greater than. - - ``EQual`` sets the qualifier to equal. - - ``UNEQual`` sets the qualifier to not equal. - - ``LESSEQual`` sets the qualifier to less than or equal. - - ``MOREEQual`` sets the qualifier to greater than or equal. - - ``INrange`` sets the qualifier to in range. - - ``OUTrange`` sets the qualifier to out of range. - """ # noqa: E501 + **Info:** + - ```` is a quoted string of up to 32 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. + """ + return self._value -class SearchSearchItemTriggerABusEthernetDataOffset(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. +class SearchSearchItemTriggerABusEthernetMacLengthValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. **Description:** - - This command specifies the data offset value, in bytes, to use when searching on the - Ethernet data field. The search condition needs to be set to DATa. The search number is - specified by x. + - This command specifies the MAC length value to use when searching on an Ethernet bus + signal. The search condition needs to be set to MACADDRess. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue? **Info:** - - ```` is an integer whose minimum and default values are -1 (don't care) and maximum - is 1,499. + - ```` is a quoted string of up to 16 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetDataHivalue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. + +class SearchSearchItemTriggerABusEthernetMacLengthHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. **Description:** - - This command sets or queries the binary data value to be used when searching on an - Ethernet bus signal. The search condition must be set to DATA and the data qualifier to - inside or outside range. The search number is specified by x. + - This command specifies the binary MAC length high value to use when searching on an + Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue? **Info:** - - ```` is the binary data value to be used when searching on an Ethernet bus - signal. + - ```` is a quoted string of up to 16 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernetData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. +class SearchSearchItemTriggerABusEthernetMacLength(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._hivalue = SearchSearchItemTriggerABusEthernetDataHivalue( + self._hivalue = SearchSearchItemTriggerABusEthernetMacLengthHivalue( device, f"{self._cmd_syntax}:HIVALue" ) - self._offset = SearchSearchItemTriggerABusEthernetDataOffset( - device, f"{self._cmd_syntax}:OFFSet" - ) - self._qualifier = SearchSearchItemTriggerABusEthernetDataQualifier( - device, f"{self._cmd_syntax}:QUALifier" - ) - self._size = SearchSearchItemTriggerABusEthernetDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusEthernetDataValue( + self._value = SearchSearchItemTriggerABusEthernetMacLengthValue( device, f"{self._cmd_syntax}:VALue" ) @property - def hivalue(self) -> SearchSearchItemTriggerABusEthernetDataHivalue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. - - **Description:** - - This command sets or queries the binary data value to be used when searching on an - Ethernet bus signal. The search condition must be set to DATA and the data qualifier - to inside or outside range. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue? - - **Info:** - - ```` is the binary data value to be used when searching on an Ethernet bus - signal. - """ - return self._hivalue - - @property - def offset(self) -> SearchSearchItemTriggerABusEthernetDataOffset: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. - - **Description:** - - This command specifies the data offset value, in bytes, to use when searching on the - Ethernet data field. The search condition needs to be set to DATa. The search number - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet? - - **Info:** - - ```` is an integer whose minimum and default values are -1 (don't care) and - maximum is 1,499. - """ - return self._offset - - @property - def qualifier(self) -> SearchSearchItemTriggerABusEthernetDataQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. + def hivalue(self) -> SearchSearchItemTriggerABusEthernetMacLengthHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` command. **Description:** - - This command specifies the qualifier to be used when searching on an Ethernet bus - signal. The search condition must be set to DATa. The search number is specified by x. + - This command specifies the binary MAC length high value to use when searching on an + Ethernet bus signal. The search condition needs to be set to MACADDRess. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier {LESSthan|MOREthan|EQual|UNEQual|LESSEQual|MOREEQual| INrange|OUTrange} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue? **Info:** - - ``LESSthan`` sets the qualifier to less than. - - ``MOREthan`` sets the qualifier to greater than. - - ``EQual`` sets the qualifier to equal. - - ``UNEQual`` sets the qualifier to not equal. - - ``LESSEQual`` sets the qualifier to less than or equal. - - ``MOREEQual`` sets the qualifier to greater than or equal. - - ``INrange`` sets the qualifier to in range. - - ``OUTrange`` sets the qualifier to out of range. - """ # noqa: E501 - return self._qualifier + - ```` is a quoted string of up to 16 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. + """ + return self._hivalue @property - def size(self) -> SearchSearchItemTriggerABusEthernetDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetMacLengthValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. **Description:** - - This command specifies the length of the data string, in bytes, to use when searching - on the Ethernet bus signal. The search condition needs to be set to DATa. The search - number is specified by x. + - This command specifies the MAC length value to use when searching on an Ethernet bus + signal. The search condition needs to be set to MACADDRess. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue? **Info:** - - ```` specifies the length of the data string, in bytes. The minimum and default - values are 1, and the maximum value is 16. + - ```` is a quoted string of up to 16 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. """ - return self._size + return self._value + + +class SearchSearchItemTriggerABusEthernetMacAddressSourceValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` command. + + **Description:** + - This command specifies the binary MAC address source value to use when searching on an + Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue? + + **Info:** + - ```` is a quoted string of up to 48 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusEthernetMacAddressSource(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` + command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthernetMacAddressSourceValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusEthernetDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetMacAddressSourceValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` command. **Description:** - - This command specifies the binary value to use when searching on the Ethernet bus - signal. The search condition needs to be set to DATa. The search number is specified - by x. + - This command specifies the binary MAC address source value to use when searching on an + Ethernet bus signal. The search condition needs to be set to MACADDRess. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue? **Info:** - - ```` is a quoted string where the allowable characters are 0, 1, and X. The - allowable number of characters depends on the setting for size (using - ``SEARCH:SEARCHX:TRIGGER:A:BUS:ETHERNET:DATA:SIZE``). The bits specified in the quoted - string replace the least significant bits, leaving any unspecified upper bits - unchanged. + - ```` is a quoted string of up to 48 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthernetCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. +class SearchSearchItemTriggerABusEthernetMacAddressDestinationValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. **Description:** - - This command specifies a field or condition for an Ethernet bus to search on. The search + - This command specifies the binary MAC address destination value to use when searching on + an Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition {SFD|MACADDRess|MACLENgth|IPHeader|TCPHeader|DATa|EOP| IDLe|FCSError|QTAG} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue? **Info:** - - ``SFD`` - Start of frame delimiter. - - ``MACADDRess`` - MAC addresses field. - - ``MACLENgth`` - MAC length/type field. - - ``IPHeader`` - IP header field. - - ``TCPHeader`` - TCP header field. - - ``DATa`` - TCP/IPv4 or MAC protocol client data field. - - ``EOP`` - End of Packet field. - - ``IDLe`` - Idle field. - - ``FCSError`` - Frame Check Sequence Error (CRC) field. - - ``QTAG`` - IEEE 802.1Q (VLAN) control information field. - """ # noqa: E501 + - ```` is a quoted string of up to 48 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthernet(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet`` command tree. + +class SearchSearchItemTriggerABusEthernetMacAddressDestination(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. - - ``.ipheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. - - ``.mac``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. - - ``.qtag``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. - - ``.tcpheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusEthernetCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusEthernetData(device, f"{self._cmd_syntax}:DATa") - self._ipheader = SearchSearchItemTriggerABusEthernetIpheader( - device, f"{self._cmd_syntax}:IPHeader" - ) - self._mac = SearchSearchItemTriggerABusEthernetMac(device, f"{self._cmd_syntax}:MAC") - self._qtag = SearchSearchItemTriggerABusEthernetQtag(device, f"{self._cmd_syntax}:QTAG") - self._tcpheader = SearchSearchItemTriggerABusEthernetTcpheader( - device, f"{self._cmd_syntax}:TCPHeader" + self._value = SearchSearchItemTriggerABusEthernetMacAddressDestinationValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def condition(self) -> SearchSearchItemTriggerABusEthernetCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetMacAddressDestinationValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. **Description:** - - This command specifies a field or condition for an Ethernet bus to search on. The + - This command specifies the binary MAC address destination value to use when searching + on an Ethernet bus signal. The search condition needs to be set to MACADDRess. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue value`` + command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition {SFD|MACADDRess|MACLENgth|IPHeader|TCPHeader|DATa|EOP| IDLe|FCSError|QTAG} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue? **Info:** - - ``SFD`` - Start of frame delimiter. - - ``MACADDRess`` - MAC addresses field. - - ``MACLENgth`` - MAC length/type field. - - ``IPHeader`` - IP header field. - - ``TCPHeader`` - TCP header field. - - ``DATa`` - TCP/IPv4 or MAC protocol client data field. - - ``EOP`` - End of Packet field. - - ``IDLe`` - Idle field. - - ``FCSError`` - Frame Check Sequence Error (CRC) field. - - ``QTAG`` - IEEE 802.1Q (VLAN) control information field. - """ # noqa: E501 - return self._condition + - ```` is a quoted string of up to 48 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. + """ + return self._value + + +class SearchSearchItemTriggerABusEthernetMacAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Properties: + - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` + command tree. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command + tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._destination = SearchSearchItemTriggerABusEthernetMacAddressDestination( + device, f"{self._cmd_syntax}:DESTination" + ) + self._source = SearchSearchItemTriggerABusEthernetMacAddressSource( + device, f"{self._cmd_syntax}:SOUrce" + ) @property - def data(self) -> SearchSearchItemTriggerABusEthernetData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. + def destination(self) -> SearchSearchItemTriggerABusEthernetMacAddressDestination: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination?`` query and raise + an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` - command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. + - ``.value``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination:VALue`` command. """ - return self._data + return self._destination @property - def ipheader(self) -> SearchSearchItemTriggerABusEthernetIpheader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. + def source(self) -> SearchSearchItemTriggerABusEthernetMacAddressSource: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.destinationaddr``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. - - ``.protocol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` - command tree. - - ``.sourceaddr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` - command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce:VALue`` + command. """ - return self._ipheader + return self._source - @property - def mac(self) -> SearchSearchItemTriggerABusEthernetMac: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthernetMac(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command - tree. - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. - """ - return self._mac + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEthernetMacAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + self._length = SearchSearchItemTriggerABusEthernetMacLength( + device, f"{self._cmd_syntax}:LENgth" + ) @property - def qtag(self) -> SearchSearchItemTriggerABusEthernetQtag: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. + def address(self) -> SearchSearchItemTriggerABusEthernetMacAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. + - ``.destination``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:DESTination`` command tree. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess:SOUrce`` + command tree. """ - return self._qtag + return self._address @property - def tcpheader(self) -> SearchSearchItemTriggerABusEthernetTcpheader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. + def length(self) -> SearchSearchItemTriggerABusEthernetMacLength: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.acknum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command - tree. - - ``.destinationport``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. - - ``.seqnum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command - tree. - - ``.sourceport``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` - command tree. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:HIVALue`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth:VALue`` command. """ - return self._tcpheader + return self._length -class SearchSearchItemTriggerABusEthercatWkcValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. +class SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` command. **Description:** - - This command sets the binary Working Counter information to be used for EtherCAT bus. The - search number is specified by x. + - This command specifies the binary source address value to use when searching on an + Ethernet bus signal. The search condition needs to be set to IPHeader. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue? **Info:** - - ```` is the binary Working Counter information value to be used when searching on - an EtherCAT bus signal. The default size and value of Working Counter information is 16 - bits and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is a quoted string of up to 32 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatWkc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. +class SearchSearchItemTriggerABusEthernetIpheaderSourceaddr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatWkcValue( + self._value = SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatWkcValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderSourceaddrValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` command. **Description:** - - This command sets the binary Working Counter information to be used for EtherCAT bus. - The search number is specified by x. + - This command specifies the binary source address value to use when searching on an + Ethernet bus signal. The search condition needs to be set to IPHeader. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue? **Info:** - - ```` is the binary Working Counter information value to be used when - searching on an EtherCAT bus signal. The default size and value of Working Counter - information is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is a quoted string of up to 32 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthercatTciValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. +class SearchSearchItemTriggerABusEthernetIpheaderProtocolValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` command. **Description:** - - This command sets the binary Tag control Information to be used for EtherCAT bus. The - search number is specified by x. + - This command specifies the binary protocol value to use when searching on the Ethernet bus + signal. The search condition needs to be set to IPHeader. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue? **Info:** - - ```` is the binary TCI value to be used when searching on an EtherCAT bus signal. - The default size and value of TCI is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is a quoted string of up to 8 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatTci(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. +class SearchSearchItemTriggerABusEthernetIpheaderProtocol(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatTciValue( + self._value = SearchSearchItemTriggerABusEthernetIpheaderProtocolValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatTciValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderProtocolValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` command. **Description:** - - This command sets the binary Tag control Information to be used for EtherCAT bus. The - search number is specified by x. + - This command specifies the binary protocol value to use when searching on the Ethernet + bus signal. The search condition needs to be set to IPHeader. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue? **Info:** - - ```` is the binary TCI value to be used when searching on an EtherCAT bus - signal. The default size and value of TCI is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. + - ```` is a quoted string of up to 8 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthercatSrcPortValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. +class SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. **Description:** - - This command sets the UDP Source port to be used for EtherCAT bus. The search number is - specified by x. + - This command specifies the binary destination address value to use when searching on an + Ethernet bus signal. The search condition needs to be set to IPHeader. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue? **Info:** - - ```` is the binary Source Port value to be used when searching on an EtherCAT bus - signal. The default size and value of Source Port is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. + - ```` is a quoted string of up to 32 characters where the allowable characters are + 0, 1, and X. The bits specified in the quoted string replace the least significant bits, + leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatSrcPort(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. +class SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatSrcPortValue( + self._value = SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatSrcPortValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetIpheaderDestinationaddrValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. **Description:** - - This command sets the UDP Source port to be used for EtherCAT bus. The search number - is specified by x. + - This command specifies the binary destination address value to use when searching on + an Ethernet bus signal. The search condition needs to be set to IPHeader. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue value`` + command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue? **Info:** - - ```` is the binary Source Port value to be used when searching on an EtherCAT - bus signal. The default size and value of Source Port is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is a quoted string of up to 32 characters where the allowable characters + are 0, 1, and X. The bits specified in the quoted string replace the least significant + bits, leaving any unspecified upper bits unchanged. """ return self._value -class SearchSearchItemTriggerABusEthercatSrc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. +class SearchSearchItemTriggerABusEthernetIpheader(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. + - ``.destinationaddr``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. + - ``.protocol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command + tree. + - ``.sourceaddr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` + command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._port = SearchSearchItemTriggerABusEthercatSrcPort(device, f"{self._cmd_syntax}:PORT") + self._destinationaddr = SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr( + device, f"{self._cmd_syntax}:DESTinationaddr" + ) + self._protocol = SearchSearchItemTriggerABusEthernetIpheaderProtocol( + device, f"{self._cmd_syntax}:PROTOcol" + ) + self._sourceaddr = SearchSearchItemTriggerABusEthernetIpheaderSourceaddr( + device, f"{self._cmd_syntax}:SOUrceaddr" + ) @property - def port(self) -> SearchSearchItemTriggerABusEthercatSrcPort: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. + def destinationaddr(self) -> SearchSearchItemTriggerABusEthernetIpheaderDestinationaddr: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr?`` query and raise + an AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr:VALue`` command. + """ + return self._destinationaddr + + @property + def protocol(self) -> SearchSearchItemTriggerABusEthernetIpheaderProtocol: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol:VALue`` + command. """ - return self._port + return self._protocol + @property + def sourceaddr(self) -> SearchSearchItemTriggerABusEthernetIpheaderSourceaddr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr:VALue`` + command. + """ + return self._sourceaddr -class SearchSearchItemTriggerABusEthercatSourceaddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. + +class SearchSearchItemTriggerABusEthernetDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. **Description:** - - This command sets the binary MAC source address value to be used for EtherCAT bus. The - search number is specified by x. + - This command specifies the binary value to use when searching on the Ethernet bus signal. + The search condition needs to be set to DATa. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue? **Info:** - - ```` is the binary MAC source address value to be used when searching on an - EtherCAT bus signal. The default size and value of MAC Source Address is 48 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + - ```` is a quoted string where the allowable characters are 0, 1, and X. The + allowable number of characters depends on the setting for size (using + ``SEARCH:SEARCHX:TRIGGER:A:BUS:ETHERNET:DATA:SIZE``). The bits specified in the quoted + string replace the least significant bits, leaving any unspecified upper bits unchanged. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatSourceaddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command tree. +class SearchSearchItemTriggerABusEthernetDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. + + **Description:** + - This command specifies the length of the data string, in bytes, to use when searching on + the Ethernet bus signal. The search condition needs to be set to DATa. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatSourceaddressValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusEthercatSourceaddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. - - **Description:** - - This command sets the binary MAC source address value to be used for EtherCAT bus. The - search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe? - **Info:** - - ```` is the binary MAC source address value to be used when searching on an - EtherCAT bus signal. The default size and value of MAC Source Address is 48 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. - """ - return self._value + **Info:** + - ```` specifies the length of the data string, in bytes. The minimum and default + values are 1, and the maximum value is 16. + """ -class SearchSearchItemTriggerABusEthercatServiceDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. +class SearchSearchItemTriggerABusEthernetDataQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. **Description:** - - This command specifies the length of the service data string in bytes to be used for - EtherCAT bus. The search number is specified by x. + - This command specifies the qualifier to be used when searching on an Ethernet bus signal. + The search condition must be set to DATa. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier {LESSthan|MOREthan|EQual|UNEQual|LESSEQual|MOREEQual| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier? **Info:** - - ```` is the binary Service Data value to be used when searching on an EtherCAT - bus signal. The default size and value of Service Data is 8 bits and 'XXXXXXXX' - respectively. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``LESSthan`` sets the qualifier to less than. + - ``MOREthan`` sets the qualifier to greater than. + - ``EQual`` sets the qualifier to equal. + - ``UNEQual`` sets the qualifier to not equal. + - ``LESSEQual`` sets the qualifier to less than or equal. + - ``MOREEQual`` sets the qualifier to greater than or equal. + - ``INrange`` sets the qualifier to in range. + - ``OUTrange`` sets the qualifier to out of range. + """ # noqa: E501 -class SearchSearchItemTriggerABusEthercatServiceDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. +class SearchSearchItemTriggerABusEthernetDataOffset(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. **Description:** - - This command specifies the length of the service data string in bytes to be used for - EtherCAT bus. The search number is specified by x. + - This command specifies the data offset value, in bytes, to use when searching on the + Ethernet data field. The search condition needs to be set to DATa. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet? **Info:** - - ```` is the Service Data size. The default value is 1. The valid range is 1 to 5. + - ```` is an integer whose minimum and default values are -1 (don't care) and maximum + is 1,499. """ -class SearchSearchItemTriggerABusEthercatServiceDataLength(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. +class SearchSearchItemTriggerABusEthernetDataHivalue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. **Description:** - - This command sets the binary Service Data Length to be used for EtherCAT bus. The search - number is specified by x. + - This command sets or queries the binary data value to be used when searching on an + Ethernet bus signal. The search condition must be set to DATA and the data qualifier to + inside or outside range. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue? **Info:** - - ```` is the binary Service Data Length to be used when searching on an EtherCAT - bus signal. The default size and value of Service Data Length is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is the binary data value to be used when searching on an Ethernet bus + signal. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatServiceData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. +class SearchSearchItemTriggerABusEthernetData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._length = SearchSearchItemTriggerABusEthercatServiceDataLength( - device, f"{self._cmd_syntax}:LENGth" + self._hivalue = SearchSearchItemTriggerABusEthernetDataHivalue( + device, f"{self._cmd_syntax}:HIVALue" ) - self._size = SearchSearchItemTriggerABusEthercatServiceDataSize( - device, f"{self._cmd_syntax}:SIZe" + self._offset = SearchSearchItemTriggerABusEthernetDataOffset( + device, f"{self._cmd_syntax}:OFFSet" ) - self._value = SearchSearchItemTriggerABusEthercatServiceDataValue( + self._qualifier = SearchSearchItemTriggerABusEthernetDataQualifier( + device, f"{self._cmd_syntax}:QUALifier" + ) + self._size = SearchSearchItemTriggerABusEthernetDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusEthernetDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def length(self) -> SearchSearchItemTriggerABusEthercatServiceDataLength: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. + def hivalue(self) -> SearchSearchItemTriggerABusEthernetDataHivalue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. **Description:** - - This command sets the binary Service Data Length to be used for EtherCAT bus. The - search number is specified by x. + - This command sets or queries the binary data value to be used when searching on an + Ethernet bus signal. The search condition must be set to DATA and the data qualifier + to inside or outside range. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue? **Info:** - - ```` is the binary Service Data Length to be used when searching on an - EtherCAT bus signal. The default size and value of Service Data Length is 16 bits and - 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary data value to be used when searching on an Ethernet bus + signal. """ - return self._length + return self._hivalue @property - def size(self) -> SearchSearchItemTriggerABusEthercatServiceDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. + def offset(self) -> SearchSearchItemTriggerABusEthernetDataOffset: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. **Description:** - - This command specifies the length of the service data string in bytes to be used for - EtherCAT bus. The search number is specified by x. + - This command specifies the data offset value, in bytes, to use when searching on the + Ethernet data field. The search condition needs to be set to DATa. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet? **Info:** - - ```` is the Service Data size. The default value is 1. The valid range is 1 to 5. + - ```` is an integer whose minimum and default values are -1 (don't care) and + maximum is 1,499. """ - return self._size + return self._offset @property - def value(self) -> SearchSearchItemTriggerABusEthercatServiceDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. + def qualifier(self) -> SearchSearchItemTriggerABusEthernetDataQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` command. **Description:** - - This command specifies the length of the service data string in bytes to be used for - EtherCAT bus. The search number is specified by x. + - This command specifies the qualifier to be used when searching on an Ethernet bus + signal. The search condition must be set to DATa. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier {LESSthan|MOREthan|EQual|UNEQual|LESSEQual|MOREEQual| INrange|OUTrange} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier? **Info:** - - ```` is the binary Service Data value to be used when searching on an - EtherCAT bus signal. The default size and value of Service Data is 8 bits and - 'XXXXXXXX' respectively. - """ - return self._value - - -class SearchSearchItemTriggerABusEthercatService(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._data = SearchSearchItemTriggerABusEthercatServiceData( - device, f"{self._cmd_syntax}:DATa" - ) + - ``LESSthan`` sets the qualifier to less than. + - ``MOREthan`` sets the qualifier to greater than. + - ``EQual`` sets the qualifier to equal. + - ``UNEQual`` sets the qualifier to not equal. + - ``LESSEQual`` sets the qualifier to less than or equal. + - ``MOREEQual`` sets the qualifier to greater than or equal. + - ``INrange`` sets the qualifier to in range. + - ``OUTrange`` sets the qualifier to out of range. + """ # noqa: E501 + return self._qualifier @property - def data(self) -> SearchSearchItemTriggerABusEthercatServiceData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` - command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` - command. - """ - return self._data - - -class SearchSearchItemTriggerABusEthercatQualityValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. - - **Description:** - - This command sets the binary quality to be used for EtherCAT bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue? - - **Info:** - - ```` is the binary Quality value to be used when searching on an EtherCAT bus - signal. The default size and value of Quality is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. - """ + def size(self) -> SearchSearchItemTriggerABusEthernetDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. - _WRAP_ARG_WITH_QUOTES = True + **Description:** + - This command specifies the length of the data string, in bytes, to use when searching + on the Ethernet bus signal. The search condition needs to be set to DATa. The search + number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe value`` command. -class SearchSearchItemTriggerABusEthercatQuality(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query and raise an AssertionError if - the returned value does not match ``value``. + :: - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe? - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatQualityValue( - device, f"{self._cmd_syntax}:VALue" - ) + **Info:** + - ```` specifies the length of the data string, in bytes. The minimum and default + values are 1, and the maximum value is 16. + """ + return self._size @property - def value(self) -> SearchSearchItemTriggerABusEthercatQualityValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthernetDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. **Description:** - - This command sets the binary quality to be used for EtherCAT bus. The search number is - specified by x. + - This command specifies the binary value to use when searching on the Ethernet bus + signal. The search condition needs to be set to DATa. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue? **Info:** - - ```` is the binary Quality value to be used when searching on an EtherCAT bus - signal. The default size and value of Quality is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. + - ```` is a quoted string where the allowable characters are 0, 1, and X. The + allowable number of characters depends on the setting for size (using + ``SEARCH:SEARCHX:TRIGGER:A:BUS:ETHERNET:DATA:SIZE``). The bits specified in the quoted + string replace the least significant bits, leaving any unspecified upper bits + unchanged. """ return self._value -class SearchSearchItemTriggerABusEthercatPubidValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. +class SearchSearchItemTriggerABusEthernetCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. **Description:** - - This command sets the binary Publisher ID to be used for EtherCAT bus. The search number - is specified by x. + - This command specifies a field or condition for an Ethernet bus to search on. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition {SFD|MACADDRess|MACLENgth|IPHeader|TCPHeader|DATa|EOP| IDLe|FCSError|QTAG} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition? **Info:** - - ```` is the binary Publisher ID value to be used when searching on an EtherCAT - bus signal. The default size and value of Publisher ID is 48 bits and 'XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``SFD`` - Start of frame delimiter. + - ``MACADDRess`` - MAC addresses field. + - ``MACLENgth`` - MAC length/type field. + - ``IPHeader`` - IP header field. + - ``TCPHeader`` - TCP header field. + - ``DATa`` - TCP/IPv4 or MAC protocol client data field. + - ``EOP`` - End of Packet field. + - ``IDLe`` - Idle field. + - ``FCSError`` - Frame Check Sequence Error (CRC) field. + - ``QTAG`` - IEEE 802.1Q (VLAN) control information field. + """ # noqa: E501 -class SearchSearchItemTriggerABusEthercatPubid(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. +class SearchSearchItemTriggerABusEthernet(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. + - ``.ipheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. + - ``.mac``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. + - ``.qtag``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. + - ``.tcpheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatPubidValue( - device, f"{self._cmd_syntax}:VALue" + self._condition = SearchSearchItemTriggerABusEthernetCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusEthernetData(device, f"{self._cmd_syntax}:DATa") + self._ipheader = SearchSearchItemTriggerABusEthernetIpheader( + device, f"{self._cmd_syntax}:IPHeader" + ) + self._mac = SearchSearchItemTriggerABusEthernetMac(device, f"{self._cmd_syntax}:MAC") + self._qtag = SearchSearchItemTriggerABusEthernetQtag(device, f"{self._cmd_syntax}:QTAG") + self._tcpheader = SearchSearchItemTriggerABusEthernetTcpheader( + device, f"{self._cmd_syntax}:TCPHeader" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatPubidValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. + def condition(self) -> SearchSearchItemTriggerABusEthernetCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition`` command. **Description:** - - This command sets the binary Publisher ID to be used for EtherCAT bus. The search - number is specified by x. + - This command specifies a field or condition for an Ethernet bus to search on. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition {SFD|MACADDRess|MACLENgth|IPHeader|TCPHeader|DATa|EOP| IDLe|FCSError|QTAG} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:CONDition? **Info:** - - ```` is the binary Publisher ID value to be used when searching on an - EtherCAT bus signal. The default size and value of Publisher ID is 48 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. - """ - return self._value - - -class SearchSearchItemTriggerABusEthercatProtocoltype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. - - **Description:** - - This command sets or queries the EtherCAT Protocol Type in EtherCAT bus. The search number - is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe {PDU|NETWORKVARiables|MAILbox} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe? - - **Info:** - - ``PDU`` specifies the Protocol Type as PDU. This is the default value. - - ``NETWORKVARiables`` specifies the Protocol Type as NETWORKVARiables. - - ``MAILbox`` specifies the Protocol Type as MAILbox. - """ - - -class SearchSearchItemTriggerABusEthercatPositionValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. + - ``SFD`` - Start of frame delimiter. + - ``MACADDRess`` - MAC addresses field. + - ``MACLENgth`` - MAC length/type field. + - ``IPHeader`` - IP header field. + - ``TCPHeader`` - TCP header field. + - ``DATa`` - TCP/IPv4 or MAC protocol client data field. + - ``EOP`` - End of Packet field. + - ``IDLe`` - Idle field. + - ``FCSError`` - Frame Check Sequence Error (CRC) field. + - ``QTAG`` - IEEE 802.1Q (VLAN) control information field. + """ # noqa: E501 + return self._condition - **Description:** - - This command sets the binary address position information to be used for EtherCAT bus. The - search number is specified by x. + @property + def data(self) -> SearchSearchItemTriggerABusEthernetData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.hivalue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:HIVALue`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:QUALifier`` + command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:DATa:VALue`` command. + """ + return self._data - :: + @property + def ipheader(self) -> SearchSearchItemTriggerABusEthernetIpheader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader?`` query and raise an + AssertionError if the returned value does not match ``value``. - **Info:** - - ```` is the binary Address Position value to be used when searching on an - EtherCAT bus signal. The default size and value Address Position is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. - """ + Sub-properties: + - ``.destinationaddr``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:DESTinationaddr`` command tree. + - ``.protocol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:PROTOcol`` + command tree. + - ``.sourceaddr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:IPHeader:SOUrceaddr`` + command tree. + """ + return self._ipheader - _WRAP_ARG_WITH_QUOTES = True + @property + def mac(self) -> SearchSearchItemTriggerABusEthernetMac: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusEthercatPosition(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:ADDRess`` command + tree. + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:MAC:LENgth`` command tree. + """ + return self._mac - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def qtag(self) -> SearchSearchItemTriggerABusEthernetQtag: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatPositionValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:QTAG:VALue`` command. + """ + return self._qtag @property - def value(self) -> SearchSearchItemTriggerABusEthercatPositionValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. - - **Description:** - - This command sets the binary address position information to be used for EtherCAT bus. - The search number is specified by x. + def tcpheader(self) -> SearchSearchItemTriggerABusEthernetTcpheader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue? - **Info:** - - ```` is the binary Address Position value to be used when searching on an - EtherCAT bus signal. The default size and value Address Position is 16 bits and - 'XXXXXXXX XXXXXXXX' respectively. + Sub-properties: + - ``.acknum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:ACKnum`` command + tree. + - ``.destinationport``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:DESTinationport`` command tree. + - ``.seqnum``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SEQnum`` command + tree. + - ``.sourceport``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERnet:TCPHeader:SOUrceport`` + command tree. """ - return self._value + return self._tcpheader -class SearchSearchItemTriggerABusEthercatOffsetValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. +class SearchSearchItemTriggerABusEthercatWkcValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. **Description:** - - This command sets the binary address offset information to be used for EtherCAT bus. The + - This command sets the binary Working Counter information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue? **Info:** - - ```` is the binary Address Offset data value to be used when searching on an - EtherCAT bus signal. The default size and value Address Offset is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is the binary Working Counter information value to be used when searching on + an EtherCAT bus signal. The default size and value of Working Counter information is 16 + bits and 'XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatOffset(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. +class SearchSearchItemTriggerABusEthercatWkc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatOffsetValue( + self._value = SearchSearchItemTriggerABusEthercatWkcValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatOffsetValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatWkcValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. **Description:** - - This command sets the binary address offset information to be used for EtherCAT bus. + - This command sets the binary Working Counter information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue? **Info:** - - ```` is the binary Address Offset data value to be used when searching on an - EtherCAT bus signal. The default size and value Address Offset is 16 bits and - 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary Working Counter information value to be used when + searching on an EtherCAT bus signal. The default size and value of Working Counter + information is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatNetworkVariableHeader(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. +class SearchSearchItemTriggerABusEthercatTciValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. **Description:** - - This command sets or queries the Network Variable Header fields in EtherCAT bus. The + - This command sets the binary Tag control Information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer {INDex|HASH|NVLEN|Q} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue? **Info:** - - ``INDex`` specifies the Network Variable Header field as INDex. This is the default value. - - ``HASH`` specifies the Network Variable Header field as HASH. - - ``NVLEN`` specifies the Network Variable Header field as NVLEN. - - ``Q`` specifies the Network Variable Header field as Q. + - ```` is the binary TCI value to be used when searching on an EtherCAT bus signal. + The default size and value of TCI is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatNetworkVariable(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. - **Description:** - - This command sets or queries the Network Variable fields in EtherCAT bus. The search - number is specified by x. +class SearchSearchItemTriggerABusEthercatTci(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable {PUBHEADer|NVHEADer|NVDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable? - - **Info:** - - ``PUBHEADer`` specifies the Network Variable as PUBHEADer. This is the default value. - - ``NVHEADer`` specifies the Network Variable as NVHEADer. - - ``NVDATa`` specifies the Network Variable as NVDATa. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._header = SearchSearchItemTriggerABusEthercatNetworkVariableHeader( - device, f"{self._cmd_syntax}:HEADer" + self._value = SearchSearchItemTriggerABusEthercatTciValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def header(self) -> SearchSearchItemTriggerABusEthercatNetworkVariableHeader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatTciValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. **Description:** - - This command sets or queries the Network Variable Header fields in EtherCAT bus. The + - This command sets the binary Tag control Information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer {INDex|HASH|NVLEN|Q} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer? - - **Info:** - - ``INDex`` specifies the Network Variable Header field as INDex. This is the default - value. - - ``HASH`` specifies the Network Variable Header field as HASH. - - ``NVLEN`` specifies the Network Variable Header field as NVLEN. - - ``Q`` specifies the Network Variable Header field as Q. - """ - return self._header - - -class SearchSearchItemTriggerABusEthercatNetwork(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Properties: - - ``.variable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._variable = SearchSearchItemTriggerABusEthercatNetworkVariable( - device, f"{self._cmd_syntax}:VARiable" - ) - - @property - def variable(self) -> SearchSearchItemTriggerABusEthercatNetworkVariable: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. - - **Description:** - - This command sets or queries the Network Variable fields in EtherCAT bus. The search - number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable {PUBHEADer|NVHEADer|NVDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue? **Info:** - - ``PUBHEADer`` specifies the Network Variable as PUBHEADer. This is the default value. - - ``NVHEADer`` specifies the Network Variable as NVHEADer. - - ``NVDATa`` specifies the Network Variable as NVDATa. - - Sub-properties: - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` - command. + - ```` is the binary TCI value to be used when searching on an EtherCAT bus + signal. The default size and value of TCI is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. """ - return self._variable + return self._value -class SearchSearchItemTriggerABusEthercatNetworkvariableDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` command. +class SearchSearchItemTriggerABusEthercatSrcPortValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. **Description:** - - This command specifies the binary network variable data string used for EtherCAT bus. The - search number is specified by x. + - This command sets the UDP Source port to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue? **Info:** - - ```` is the binary network variable data value to be used when searching on an - EtherCAT bus signal. The default Network Variable Data value is 'XXXXXXXX'. + - ```` is the binary Source Port value to be used when searching on an EtherCAT bus + signal. The default size and value of Source Port is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatNetworkvariableDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the network variable data string in bytes to be used - for EtherCAT bus. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe? - - **Info:** - - ```` is the Network Variable Data size. The default value is 1. The valid range is 1 - to 5. - """ - - -class SearchSearchItemTriggerABusEthercatNetworkvariableData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command tree. +class SearchSearchItemTriggerABusEthercatSrcPort(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEthercatNetworkvariableDataSize( - device, f"{self._cmd_syntax}:SIZe" - ) - self._value = SearchSearchItemTriggerABusEthercatNetworkvariableDataValue( + self._value = SearchSearchItemTriggerABusEthercatSrcPortValue( device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatSrcPortValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. **Description:** - - This command specifies the length of the network variable data string in bytes to be - used for EtherCAT bus. The search number is specified by x. + - This command sets the UDP Source port to be used for EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue? **Info:** - - ```` is the Network Variable Data size. The default value is 1. The valid range - is 1 to 5. + - ```` is the binary Source Port value to be used when searching on an EtherCAT + bus signal. The default size and value of Source Port is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ - return self._size + return self._value - @property - def value(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableDataValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` command. - **Description:** - - This command specifies the binary network variable data string used for EtherCAT bus. - The search number is specified by x. +class SearchSearchItemTriggerABusEthercatSrc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._port = SearchSearchItemTriggerABusEthercatSrcPort(device, f"{self._cmd_syntax}:PORT") + + @property + def port(self) -> SearchSearchItemTriggerABusEthercatSrcPort: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT?`` query and raise an + AssertionError if the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT:VALue`` command. + """ + return self._port - :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue? +class SearchSearchItemTriggerABusEthercatSourceaddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. - **Info:** - - ```` is the binary network variable data value to be used when searching on - an EtherCAT bus signal. The default Network Variable Data value is 'XXXXXXXX'. - """ - return self._value + **Description:** + - This command sets the binary MAC source address value to be used for EtherCAT bus. The + search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue value`` command. + + **SCPI Syntax:** + :: -class SearchSearchItemTriggerABusEthercatNetworkvariable(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue? + + **Info:** + - ```` is the binary MAC source address value to be used when searching on an + EtherCAT bus signal. The default size and value of MAC Source Address is 48 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusEthercatSourceaddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command - tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._data = SearchSearchItemTriggerABusEthercatNetworkvariableData( - device, f"{self._cmd_syntax}:DATa" + self._value = SearchSearchItemTriggerABusEthercatSourceaddressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def data(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command tree. + def value(self) -> SearchSearchItemTriggerABusEthercatSourceaddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` command. + + **Description:** + - This command sets the binary MAC source address value to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue value`` command. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` - command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` - command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue? + + **Info:** + - ```` is the binary MAC source address value to be used when searching on an + EtherCAT bus signal. The default size and value of MAC Source Address is 48 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. """ - return self._data + return self._value -class SearchSearchItemTriggerABusEthercatMailboxHeader(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. +class SearchSearchItemTriggerABusEthercatServiceDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. **Description:** - - This command sets or queries the Mailbox Header fields in EtherCAT bus. The search number - is specified by x. + - This command specifies the length of the service data string in bytes to be used for + EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer {LENGth| ADDRess| CHANnel| PRIority| TYPe| CNT} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue? **Info:** - - ``LENGth`` specifies the Mailbox Header as Length. This is the default value. - - ``ADDRess`` specifies the Mailbox Header as Address. - - ``CHANnel`` specifies the Mailbox Header as Channel. - - ``PRIority`` specifies the Mailbox Header as Priority. - - ``TYPe`` specifies the Mailbox Header as Type. - - ``CNT`` specifies the Mailbox Header as Count. - """ # noqa: E501 + - ```` is the binary Service Data value to be used when searching on an EtherCAT + bus signal. The default size and value of Service Data is 8 bits and 'XXXXXXXX' + respectively. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatMailboxDetail(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. + +class SearchSearchItemTriggerABusEthercatServiceDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. **Description:** - - This command sets or queries the Error Reply Service Data Details in EtherCAT bus. The - search number is specified by x. + - This command specifies the length of the service data string in bytes to be used for + EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail {ONE| TWO| THRee| FOUR| FIVe| SIX| SEVEn| EIGHt| NINe} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe? **Info:** - - ``ONE`` specifies the Detail field as ONE. This is the default value. - - ``TWO`` specifies the Detail field as TWO. - - ``THRee`` specifies the Detail field as THRee. - - ``FOUR`` specifies the Detail field as FOUR. - - ``FIVe`` specifies the Detail field as FIVe. - - ``SIX`` specifies the Detail field as SIX. - - ``SEVEn`` specifies the Detail field as SEVEn. - - ``EIGHt`` specifies the Detail field as EIGHt. - - ``NINe`` specifies the Detail field as NINe. - """ # noqa: E501 + - ```` is the Service Data size. The default value is 1. The valid range is 1 to 5. + """ -class SearchSearchItemTriggerABusEthercatMailboxCntValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. +class SearchSearchItemTriggerABusEthercatServiceDataLength(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. **Description:** - - This command sets the binary counter of the mailbox services to be used for EtherCAT bus. - The search number is specified by x. + - This command sets the binary Service Data Length to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth? **Info:** - - ```` is the binary Counter value to be used when searching on an EtherCAT bus - signal. The default size and value of Counter is 3 bits and 'XXX' respectively. + - ```` is the binary Service Data Length to be used when searching on an EtherCAT + bus signal. The default size and value of Service Data Length is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatMailboxCnt(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. +class SearchSearchItemTriggerABusEthercatServiceData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatMailboxCntValue( + self._length = SearchSearchItemTriggerABusEthercatServiceDataLength( + device, f"{self._cmd_syntax}:LENGth" + ) + self._size = SearchSearchItemTriggerABusEthercatServiceDataSize( + device, f"{self._cmd_syntax}:SIZe" + ) + self._value = SearchSearchItemTriggerABusEthercatServiceDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatMailboxCntValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. + def length(self) -> SearchSearchItemTriggerABusEthercatServiceDataLength: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` command. **Description:** - - This command sets the binary counter of the mailbox services to be used for EtherCAT - bus. The search number is specified by x. + - This command sets the binary Service Data Length to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth? **Info:** - - ```` is the binary Counter value to be used when searching on an EtherCAT bus - signal. The default size and value of Counter is 3 bits and 'XXX' respectively. + - ```` is the binary Service Data Length to be used when searching on an + EtherCAT bus signal. The default size and value of Service Data Length is 16 bits and + 'XXXXXXXX XXXXXXXX' respectively. """ - return self._value - - -class SearchSearchItemTriggerABusEthercatMailboxAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. - - **Description:** - - This command sets the binary Mailbox Address to be used for EtherCAT bus. The search - number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue? + return self._length - **Info:** - - ```` is the binary Mailbox Address to be used when searching on an EtherCAT bus - signal. The default size and value of Address is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. - """ + @property + def size(self) -> SearchSearchItemTriggerABusEthercatServiceDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. - _WRAP_ARG_WITH_QUOTES = True + **Description:** + - This command specifies the length of the service data string in bytes to be used for + EtherCAT bus. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe value`` command. -class SearchSearchItemTriggerABusEthercatMailboxAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + :: - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe? - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatMailboxAddressValue( - device, f"{self._cmd_syntax}:VALue" - ) + **Info:** + - ```` is the Service Data size. The default value is 1. The valid range is 1 to 5. + """ + return self._size @property - def value(self) -> SearchSearchItemTriggerABusEthercatMailboxAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatServiceDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. **Description:** - - This command sets the binary Mailbox Address to be used for EtherCAT bus. The search - number is specified by x. + - This command specifies the length of the service data string in bytes to be used for + EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue? **Info:** - - ```` is the binary Mailbox Address to be used when searching on an EtherCAT - bus signal. The default size and value of Address is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. + - ```` is the binary Service Data value to be used when searching on an + EtherCAT bus signal. The default size and value of Service Data is 8 bits and + 'XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatMailbox(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. - - **Description:** - - This command sets or queries the Mailbox fields in EtherCAT bus. The search number is - specified by x. +class SearchSearchItemTriggerABusEthercatService(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox {MAILBOXHEADer|SERVICEDATa|ERRSERVICEDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox? - - **Info:** - - ``MAILBOXHEADer`` specifies the Mailbox fields as mailbox header. This is the default - value. - - ``SERVICEDATa`` specifies the Mailbox fields as service data. - - ``ERRSERVICEDATa`` specifies the Mailbox fields as error reply service data. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command - tree. - - ``.cnt``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. - - ``.detail``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEthercatMailboxAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) - self._cnt = SearchSearchItemTriggerABusEthercatMailboxCnt(device, f"{self._cmd_syntax}:CNT") - self._detail = SearchSearchItemTriggerABusEthercatMailboxDetail( - device, f"{self._cmd_syntax}:DETail" - ) - self._header = SearchSearchItemTriggerABusEthercatMailboxHeader( - device, f"{self._cmd_syntax}:HEADer" + self._data = SearchSearchItemTriggerABusEthercatServiceData( + device, f"{self._cmd_syntax}:DATa" ) @property - def address(self) -> SearchSearchItemTriggerABusEthercatMailboxAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command tree. + def data(self) -> SearchSearchItemTriggerABusEthercatServiceData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:LENGth`` + command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa:VALue`` command. """ - return self._address + return self._data - @property - def cnt(self) -> SearchSearchItemTriggerABusEthercatMailboxCnt: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query and raise an - AssertionError if the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatQualityValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. - """ - return self._cnt + **Description:** + - This command sets the binary quality to be used for EtherCAT bus. The search number is + specified by x. - @property - def detail(self) -> SearchSearchItemTriggerABusEthercatMailboxDetail: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue value`` command. - **Description:** - - This command sets or queries the Error Reply Service Data Details in EtherCAT bus. The - search number is specified by x. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail value`` command. + :: - **SCPI Syntax:** + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue? - :: + **Info:** + - ```` is the binary Quality value to be used when searching on an EtherCAT bus + signal. The default size and value of Quality is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. + """ - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail {ONE| TWO| THRee| FOUR| FIVe| SIX| SEVEn| EIGHt| NINe} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail? + _WRAP_ARG_WITH_QUOTES = True - **Info:** - - ``ONE`` specifies the Detail field as ONE. This is the default value. - - ``TWO`` specifies the Detail field as TWO. - - ``THRee`` specifies the Detail field as THRee. - - ``FOUR`` specifies the Detail field as FOUR. - - ``FIVe`` specifies the Detail field as FIVe. - - ``SIX`` specifies the Detail field as SIX. - - ``SEVEn`` specifies the Detail field as SEVEn. - - ``EIGHt`` specifies the Detail field as EIGHt. - - ``NINe`` specifies the Detail field as NINe. - """ # noqa: E501 - return self._detail + +class SearchSearchItemTriggerABusEthercatQuality(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthercatQualityValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def header(self) -> SearchSearchItemTriggerABusEthercatMailboxHeader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatQualityValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. **Description:** - - This command sets or queries the Mailbox Header fields in EtherCAT bus. The search - number is specified by x. + - This command sets the binary quality to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer {LENGth| ADDRess| CHANnel| PRIority| TYPe| CNT} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue? **Info:** - - ``LENGth`` specifies the Mailbox Header as Length. This is the default value. - - ``ADDRess`` specifies the Mailbox Header as Address. - - ``CHANnel`` specifies the Mailbox Header as Channel. - - ``PRIority`` specifies the Mailbox Header as Priority. - - ``TYPe`` specifies the Mailbox Header as Type. - - ``CNT`` specifies the Mailbox Header as Count. - """ # noqa: E501 - return self._header + - ```` is the binary Quality value to be used when searching on an EtherCAT bus + signal. The default size and value of Quality is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. + """ + return self._value -class SearchSearchItemTriggerABusEthercatMailboxtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. +class SearchSearchItemTriggerABusEthercatPubidValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. **Description:** - - This command sets or queries the Mailbox Type fields in EtherCAT bus. The search number is - specified by x. + - This command sets the binary Publisher ID to be used for EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe {ZERo| ONE| TWO| THRee| FOUR| FIVe| RESERved| FIFTeen} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe? - - **Info:** - - ``ZERo`` specifies the Mailbox Type as ZERo. This is the default value. - - ``ONE`` specifies the Mailbox Type as ONE. - - ``TWO`` specifies the Mailbox Type as TWO. - - ``THRee`` specifies the Mailbox Type as THRee. - - ``FOUR`` specifies the Mailbox Type as FOUR. - - ``FIVe`` specifies the Mailbox Type as FIVe. - - ``RESERved`` specifies the Mailbox Type as RESERved. - - ``FIFTeen`` specifies the Mailbox Type as FIFTeen. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusEthercatLogicaladdressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. - - **Description:** - - This command sets the binary logical address information to be used for EtherCAT bus. The - search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue? **Info:** - - ```` is the binary Logical Address to be used when searching on an EtherCAT bus - signal. The default size and value Logical Address is 32 bits and 'XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary Publisher ID value to be used when searching on an EtherCAT + bus signal. The default size and value of Publisher ID is 48 bits and 'XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatLogicaladdress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` command tree. +class SearchSearchItemTriggerABusEthercatPubid(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatLogicaladdressValue( + self._value = SearchSearchItemTriggerABusEthercatPubidValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatLogicaladdressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatPubidValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. **Description:** - - This command sets the binary logical address information to be used for EtherCAT bus. - The search number is specified by x. + - This command sets the binary Publisher ID to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue? **Info:** - - ```` is the binary Logical Address to be used when searching on an EtherCAT - bus signal. The default size and value Logical Address is 32 bits and 'XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary Publisher ID value to be used when searching on an + EtherCAT bus signal. The default size and value of Publisher ID is 48 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatLenValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. +class SearchSearchItemTriggerABusEthercatProtocoltype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. **Description:** - - This command sets the binary Length to be used for EtherCAT bus. The search number is - specified by x. + - This command sets or queries the EtherCAT Protocol Type in EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe {PDU|NETWORKVARiables|MAILbox} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe? **Info:** - - ```` is the binary Length to be used when searching on an EtherCAT bus signal. - The default size and value of Length is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. + - ``PDU`` specifies the Protocol Type as PDU. This is the default value. + - ``NETWORKVARiables`` specifies the Protocol Type as NETWORKVARiables. + - ``MAILbox`` specifies the Protocol Type as MAILbox. + """ + + +class SearchSearchItemTriggerABusEthercatPositionValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. + + **Description:** + - This command sets the binary address position information to be used for EtherCAT bus. The + search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue? + + **Info:** + - ```` is the binary Address Position value to be used when searching on an + EtherCAT bus signal. The default size and value Address Position is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatLen(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. +class SearchSearchItemTriggerABusEthercatPosition(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatLenValue( + self._value = SearchSearchItemTriggerABusEthercatPositionValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatLenValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatPositionValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. **Description:** - - This command sets the binary Length to be used for EtherCAT bus. The search number is - specified by x. + - This command sets the binary address position information to be used for EtherCAT bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue? **Info:** - - ```` is the binary Length to be used when searching on an EtherCAT bus - signal. The default size and value of Length is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. + - ```` is the binary Address Position value to be used when searching on an + EtherCAT bus signal. The default size and value Address Position is 16 bits and + 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatIrqValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. +class SearchSearchItemTriggerABusEthercatOffsetValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. **Description:** - - This command sets the binary interrupt request information to be used for EtherCAT bus. - The search number is specified by x. + - This command sets the binary address offset information to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue? **Info:** - - ```` is the binary interrupt request information to be used when searching on an - EtherCAT bus signal. The default size and value interrupt request information is 16 bits - and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary Address Offset data value to be used when searching on an + EtherCAT bus signal. The default size and value Address Offset is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatIrq(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. +class SearchSearchItemTriggerABusEthercatOffset(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIrqValue( + self._value = SearchSearchItemTriggerABusEthercatOffsetValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatIrqValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatOffsetValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. **Description:** - - This command sets the binary interrupt request information to be used for EtherCAT - bus. The search number is specified by x. + - This command sets the binary address offset information to be used for EtherCAT bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue? **Info:** - - ```` is the binary interrupt request information to be used when searching on - an EtherCAT bus signal. The default size and value interrupt request information is 16 - bits and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary Address Offset data value to be used when searching on an + EtherCAT bus signal. The default size and value Address Offset is 16 bits and + 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatIpsourceAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusEthercatNetworkVariableHeader(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. **Description:** - - This command sets the Source IP Address to be used for EtherCAT bus. The search number is - specified by x. + - This command sets or queries the Network Variable Header fields in EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer {INDex|HASH|NVLEN|Q} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer? **Info:** - - ```` is the binary Source IP Address to be used when searching on an EtherCAT bus - signal. The default size and value of Source Address is 32 bits and 'XXXXXXXX XXXXXXXX - XXXXXXXX XXXXXXXX'. + - ``INDex`` specifies the Network Variable Header field as INDex. This is the default value. + - ``HASH`` specifies the Network Variable Header field as HASH. + - ``NVLEN`` specifies the Network Variable Header field as NVLEN. + - ``Q`` specifies the Network Variable Header field as Q. """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusEthercatNetworkVariable(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. -class SearchSearchItemTriggerABusEthercatIpsourceAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command tree. + **Description:** + - This command sets or queries the Network Variable fields in EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable {PUBHEADer|NVHEADer|NVDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable? + + **Info:** + - ``PUBHEADer`` specifies the Network Variable as PUBHEADer. This is the default value. + - ``NVHEADer`` specifies the Network Variable as NVHEADer. + - ``NVDATa`` specifies the Network Variable as NVDATa. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIpsourceAddressValue( - device, f"{self._cmd_syntax}:VALue" + self._header = SearchSearchItemTriggerABusEthercatNetworkVariableHeader( + device, f"{self._cmd_syntax}:HEADer" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatIpsourceAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` command. + def header(self) -> SearchSearchItemTriggerABusEthercatNetworkVariableHeader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. **Description:** - - This command sets the Source IP Address to be used for EtherCAT bus. The search number - is specified by x. + - This command sets or queries the Network Variable Header fields in EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer {INDex|HASH|NVLEN|Q} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer? **Info:** - - ```` is the binary Source IP Address to be used when searching on an EtherCAT - bus signal. The default size and value of Source Address is 32 bits and 'XXXXXXXX - XXXXXXXX XXXXXXXX XXXXXXXX'. + - ``INDex`` specifies the Network Variable Header field as INDex. This is the default + value. + - ``HASH`` specifies the Network Variable Header field as HASH. + - ``NVLEN`` specifies the Network Variable Header field as NVLEN. + - ``Q`` specifies the Network Variable Header field as Q. """ - return self._value + return self._header -class SearchSearchItemTriggerABusEthercatIpsource(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. +class SearchSearchItemTriggerABusEthercatNetwork(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command - tree. + - ``.variable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEthercatIpsourceAddress( - device, f"{self._cmd_syntax}:ADDRess" + self._variable = SearchSearchItemTriggerABusEthercatNetworkVariable( + device, f"{self._cmd_syntax}:VARiable" ) @property - def address(self) -> SearchSearchItemTriggerABusEthercatIpsourceAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command tree. + def variable(self) -> SearchSearchItemTriggerABusEthercatNetworkVariable: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` command. + + **Description:** + - This command sets or queries the Network Variable fields in EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable {PUBHEADer|NVHEADer|NVDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable? + + **Info:** + - ``PUBHEADer`` specifies the Network Variable as PUBHEADer. This is the default value. + - ``NVHEADer`` specifies the Network Variable as NVHEADer. + - ``NVDATa`` specifies the Network Variable as NVDATa. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable:HEADer`` command. """ - return self._address + return self._variable -class SearchSearchItemTriggerABusEthercatIpdestinationAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusEthercatNetworkvariableDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` command. **Description:** - - This command sets the Destination IP Address to be used for EtherCAT bus. The search - number is specified by x. + - This command specifies the binary network variable data string used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue? **Info:** - - ```` is the binary Destination IP Address to be used when searching on an - EtherCAT bus signal. The default size and value of Destination Address is 32 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + - ```` is the binary network variable data value to be used when searching on an + EtherCAT bus signal. The default Network Variable Data value is 'XXXXXXXX'. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatIpdestinationAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` command tree. +class SearchSearchItemTriggerABusEthercatNetworkvariableDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` command. + + **Description:** + - This command specifies the length of the network variable data string in bytes to be used + for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe? + + **Info:** + - ```` is the Network Variable Data size. The default value is 1. The valid range is 1 + to 5. + """ + + +class SearchSearchItemTriggerABusEthercatNetworkvariableData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIpdestinationAddressValue( + self._size = SearchSearchItemTriggerABusEthercatNetworkvariableDataSize( + device, f"{self._cmd_syntax}:SIZe" + ) + self._value = SearchSearchItemTriggerABusEthercatNetworkvariableDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatIpdestinationAddressValue: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` command. **Description:** - - This command sets the Destination IP Address to be used for EtherCAT bus. The search - number is specified by x. + - This command specifies the length of the network variable data string in bytes to be + used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query and + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe?`` query and raise + an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe? + + **Info:** + - ```` is the Network Variable Data size. The default value is 1. The valid range + is 1 to 5. + """ + return self._size + + @property + def value(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableDataValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` command. + + **Description:** + - This command specifies the binary network variable data string used for EtherCAT bus. + The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue? **Info:** - - ```` is the binary Destination IP Address to be used when searching on an - EtherCAT bus signal. The default size and value of Destination Address is 32 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. + - ```` is the binary network variable data value to be used when searching on + an EtherCAT bus signal. The default Network Variable Data value is 'XXXXXXXX'. """ return self._value -class SearchSearchItemTriggerABusEthercatIpdestination(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command tree. +class SearchSearchItemTriggerABusEthercatNetworkvariable(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` - command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command + tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEthercatIpdestinationAddress( - device, f"{self._cmd_syntax}:ADDRess" + self._data = SearchSearchItemTriggerABusEthercatNetworkvariableData( + device, f"{self._cmd_syntax}:DATa" ) @property - def address(self) -> SearchSearchItemTriggerABusEthercatIpdestinationAddress: - """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` command tree. + def data(self) -> SearchSearchItemTriggerABusEthercatNetworkvariableData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:SIZe`` + command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa:VALue`` + command. """ - return self._address + return self._data -class SearchSearchItemTriggerABusEthercatIndexValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. +class SearchSearchItemTriggerABusEthercatMailboxHeader(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. **Description:** - - This command sets the binary Index to be used for EtherCAT bus. The search number is - specified by x. + - This command sets or queries the Mailbox Header fields in EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer {LENGth| ADDRess| CHANnel| PRIority| TYPe| CNT} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer? **Info:** - - ```` is the binary Index to be used when searching on an EtherCAT bus signal. The - default size and value of Index is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. - """ + - ``LENGth`` specifies the Mailbox Header as Length. This is the default value. + - ``ADDRess`` specifies the Mailbox Header as Address. + - ``CHANnel`` specifies the Mailbox Header as Channel. + - ``PRIority`` specifies the Mailbox Header as Priority. + - ``TYPe`` specifies the Mailbox Header as Type. + - ``CNT`` specifies the Mailbox Header as Count. + """ # noqa: E501 - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusEthercatMailboxDetail(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. -class SearchSearchItemTriggerABusEthercatIndex(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. + **Description:** + - This command sets or queries the Error Reply Service Data Details in EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIndexValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusEthercatIndexValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. - - **Description:** - - This command sets the binary Index to be used for EtherCAT bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail {ONE| TWO| THRee| FOUR| FIVe| SIX| SEVEn| EIGHt| NINe} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail? - **Info:** - - ```` is the binary Index to be used when searching on an EtherCAT bus signal. - The default size and value of Index is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. - """ - return self._value + **Info:** + - ``ONE`` specifies the Detail field as ONE. This is the default value. + - ``TWO`` specifies the Detail field as TWO. + - ``THRee`` specifies the Detail field as THRee. + - ``FOUR`` specifies the Detail field as FOUR. + - ``FIVe`` specifies the Detail field as FIVe. + - ``SIX`` specifies the Detail field as SIX. + - ``SEVEn`` specifies the Detail field as SEVEn. + - ``EIGHt`` specifies the Detail field as EIGHt. + - ``NINe`` specifies the Detail field as NINe. + """ # noqa: E501 -class SearchSearchItemTriggerABusEthercatIdxValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. +class SearchSearchItemTriggerABusEthercatMailboxCntValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. **Description:** - - This command sets the binary Indexing information to be used for EtherCAT bus. The search - number is specified by x. + - This command sets the binary counter of the mailbox services to be used for EtherCAT bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue? **Info:** - - ```` is the binary Index value to be used when searching on an EtherCAT bus - signal. The default size and value of Index is 8 bits and 'XXXXXXXX' respectively. + - ```` is the binary Counter value to be used when searching on an EtherCAT bus + signal. The default size and value of Counter is 3 bits and 'XXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatIdx(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. +class SearchSearchItemTriggerABusEthercatMailboxCnt(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query and raise an AssertionError + if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIdxValue( + self._value = SearchSearchItemTriggerABusEthercatMailboxCntValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatIdxValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatMailboxCntValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. **Description:** - - This command sets the binary Indexing information to be used for EtherCAT bus. The - search number is specified by x. + - This command sets the binary counter of the mailbox services to be used for EtherCAT + bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue? **Info:** - - ```` is the binary Index value to be used when searching on an EtherCAT bus - signal. The default size and value of Index is 8 bits and 'XXXXXXXX' respectively. + - ```` is the binary Counter value to be used when searching on an EtherCAT bus + signal. The default size and value of Counter is 3 bits and 'XXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatIdentificationValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. +class SearchSearchItemTriggerABusEthercatMailboxAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. **Description:** - - This command sets the IP Identification to be used for EtherCAT bus. The search number is - specified by x. + - This command sets the binary Mailbox Address to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue? **Info:** - - ```` is the binary IP Identification to be used when searching on an EtherCAT bus - signal. The default size and value of Identification is 16 bits and 'XXXXXXXX XXXXXXXX' + - ```` is the binary Mailbox Address to be used when searching on an EtherCAT bus + signal. The default size and value of Address is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatIdentification(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` command tree. +class SearchSearchItemTriggerABusEthercatMailboxAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatIdentificationValue( + self._value = SearchSearchItemTriggerABusEthercatMailboxAddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatIdentificationValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatMailboxAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` command. **Description:** - - This command sets the IP Identification to be used for EtherCAT bus. The search number - is specified by x. + - This command sets the binary Mailbox Address to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue? **Info:** - - ```` is the binary IP Identification to be used when searching on an EtherCAT - bus signal. The default size and value of Identification is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is the binary Mailbox Address to be used when searching on an EtherCAT + bus signal. The default size and value of Address is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatHeaderLength(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. +class SearchSearchItemTriggerABusEthercatMailbox(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. **Description:** - - This command sets or queries the binary header length to be used for EtherCAT bus. The - search number is specified by x. + - This command sets or queries the Mailbox fields in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox {MAILBOXHEADer|SERVICEDATa|ERRSERVICEDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox? **Info:** - - ```` is the binary header length to be used when searching on an EtherCAT bus - signal. The default size and value of Length is 11 bits and 'XXX XXXXXXXX' respectively. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEthercatHeader(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query and raise an AssertionError if - the returned value does not match ``value``. + - ``MAILBOXHEADer`` specifies the Mailbox fields as mailbox header. This is the default + value. + - ``SERVICEDATa`` specifies the Mailbox fields as service data. + - ``ERRSERVICEDATa`` specifies the Mailbox fields as error reply service data. Properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command + tree. + - ``.cnt``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. + - ``.detail``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._length = SearchSearchItemTriggerABusEthercatHeaderLength( - device, f"{self._cmd_syntax}:LENGth" + self._address = SearchSearchItemTriggerABusEthercatMailboxAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + self._cnt = SearchSearchItemTriggerABusEthercatMailboxCnt(device, f"{self._cmd_syntax}:CNT") + self._detail = SearchSearchItemTriggerABusEthercatMailboxDetail( + device, f"{self._cmd_syntax}:DETail" + ) + self._header = SearchSearchItemTriggerABusEthercatMailboxHeader( + device, f"{self._cmd_syntax}:HEADer" ) @property - def length(self) -> SearchSearchItemTriggerABusEthercatHeaderLength: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. - - **Description:** - - This command sets or queries the binary header length to be used for EtherCAT bus. The - search number is specified by x. + def address(self) -> SearchSearchItemTriggerABusEthercatMailboxAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth value`` command. - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth? - - **Info:** - - ```` is the binary header length to be used when searching on an EtherCAT bus - signal. The default size and value of Length is 11 bits and 'XXX XXXXXXXX' - respectively. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess:VALue`` + command. """ - return self._length - - -class SearchSearchItemTriggerABusEthercatHashValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. - - **Description:** - - This command sets the binary HASH to be used for EtherCAT bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue value`` command. + return self._address - **SCPI Syntax:** + @property + def cnt(self) -> SearchSearchItemTriggerABusEthercatMailboxCnt: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT?`` query and raise an + AssertionError if the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue? + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT:VALue`` command. + """ + return self._cnt - **Info:** - - ```` is the binary Hash value to be used when searching on an EtherCAT bus - signal. The default size and value of Hash is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. - """ + @property + def detail(self) -> SearchSearchItemTriggerABusEthercatMailboxDetail: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. - _WRAP_ARG_WITH_QUOTES = True + **Description:** + - This command sets or queries the Error Reply Service Data Details in EtherCAT bus. The + search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail value`` command. -class SearchSearchItemTriggerABusEthercatHash(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query and raise an AssertionError if the - returned value does not match ``value``. + :: - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. - """ + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail {ONE| TWO| THRee| FOUR| FIVe| SIX| SEVEn| EIGHt| NINe} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail? - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatHashValue( - device, f"{self._cmd_syntax}:VALue" - ) + **Info:** + - ``ONE`` specifies the Detail field as ONE. This is the default value. + - ``TWO`` specifies the Detail field as TWO. + - ``THRee`` specifies the Detail field as THRee. + - ``FOUR`` specifies the Detail field as FOUR. + - ``FIVe`` specifies the Detail field as FIVe. + - ``SIX`` specifies the Detail field as SIX. + - ``SEVEn`` specifies the Detail field as SEVEn. + - ``EIGHt`` specifies the Detail field as EIGHt. + - ``NINe`` specifies the Detail field as NINe. + """ # noqa: E501 + return self._detail @property - def value(self) -> SearchSearchItemTriggerABusEthercatHashValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. + def header(self) -> SearchSearchItemTriggerABusEthercatMailboxHeader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. **Description:** - - This command sets the binary HASH to be used for EtherCAT bus. The search number is - specified by x. + - This command sets or queries the Mailbox Header fields in EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer {LENGth| ADDRess| CHANnel| PRIority| TYPe| CNT} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer? **Info:** - - ```` is the binary Hash value to be used when searching on an EtherCAT bus - signal. The default size and value of Hash is 16 bits and 'XXXXXXXX XXXXXXXX' - respectively. - """ - return self._value + - ``LENGth`` specifies the Mailbox Header as Length. This is the default value. + - ``ADDRess`` specifies the Mailbox Header as Address. + - ``CHANnel`` specifies the Mailbox Header as Channel. + - ``PRIority`` specifies the Mailbox Header as Priority. + - ``TYPe`` specifies the Mailbox Header as Type. + - ``CNT`` specifies the Mailbox Header as Count. + """ # noqa: E501 + return self._header -class SearchSearchItemTriggerABusEthercatFrametype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. +class SearchSearchItemTriggerABusEthercatMailboxtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. **Description:** - - This command sets or queries the Frame Type in EtherCAT bus. The search number is + - This command sets or queries the Mailbox Type fields in EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe {BASic|UDPIP} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe {ZERo| ONE| TWO| THRee| FOUR| FIVe| RESERved| FIFTeen} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe? **Info:** - - ``BASic`` specifies the Frame Type as BASic. This is the default value. - - ``UDPIP`` specifies the Frame Type as UDPIP. - """ + - ``ZERo`` specifies the Mailbox Type as ZERo. This is the default value. + - ``ONE`` specifies the Mailbox Type as ONE. + - ``TWO`` specifies the Mailbox Type as TWO. + - ``THRee`` specifies the Mailbox Type as THRee. + - ``FOUR`` specifies the Mailbox Type as FOUR. + - ``FIVe`` specifies the Mailbox Type as FIVe. + - ``RESERved`` specifies the Mailbox Type as RESERved. + - ``FIFTeen`` specifies the Mailbox Type as FIFTeen. + """ # noqa: E501 -class SearchSearchItemTriggerABusEthercatErrorReplyServiceData(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` command. +class SearchSearchItemTriggerABusEthercatLogicaladdressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. **Description:** - - This command sets or queries the error reply service data fields in EtherCAT bus. The + - This command sets the binary logical address information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa {TYPe|DETail} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue? **Info:** - - ``TYPe`` specifies the Error Reply Service Data to type. This is the default value. - - ``DETail`` specifies the Error Reply Service Data to detail. + - ```` is the binary Logical Address to be used when searching on an EtherCAT bus + signal. The default size and value Logical Address is 32 bits and 'XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX' respectively. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatErrorReplyService(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command tree. + +class SearchSearchItemTriggerABusEthercatLogicaladdress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._data = SearchSearchItemTriggerABusEthercatErrorReplyServiceData( - device, f"{self._cmd_syntax}:DATa" + self._value = SearchSearchItemTriggerABusEthercatLogicaladdressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def data(self) -> SearchSearchItemTriggerABusEthercatErrorReplyServiceData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatLogicaladdressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` command. **Description:** - - This command sets or queries the error reply service data fields in EtherCAT bus. The - search number is specified by x. + - This command sets the binary logical address information to be used for EtherCAT bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa {TYPe|DETail} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue? **Info:** - - ``TYPe`` specifies the Error Reply Service Data to type. This is the default value. - - ``DETail`` specifies the Error Reply Service Data to detail. + - ```` is the binary Logical Address to be used when searching on an EtherCAT + bus signal. The default size and value Logical Address is 32 bits and 'XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX' respectively. """ - return self._data + return self._value -class SearchSearchItemTriggerABusEthercatErrorReply(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. +class SearchSearchItemTriggerABusEthercatLenValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. + + **Description:** + - This command sets the binary Length to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue value`` command. - Properties: - - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command - tree. - """ + **SCPI Syntax:** - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._service = SearchSearchItemTriggerABusEthercatErrorReplyService( - device, f"{self._cmd_syntax}:SERVice" - ) + :: - @property - def service(self) -> SearchSearchItemTriggerABusEthercatErrorReplyService: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Info:** + - ```` is the binary Length to be used when searching on an EtherCAT bus signal. + The default size and value of Length is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. + """ - Sub-properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` - command. - """ - return self._service + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. +class SearchSearchItemTriggerABusEthercatLen(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.reply``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._reply = SearchSearchItemTriggerABusEthercatErrorReply( - device, f"{self._cmd_syntax}:REPLy" + self._value = SearchSearchItemTriggerABusEthercatLenValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def reply(self) -> SearchSearchItemTriggerABusEthercatErrorReply: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. + def value(self) -> SearchSearchItemTriggerABusEthercatLenValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. + + **Description:** + - This command sets the binary Length to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue value`` command. - Sub-properties: - - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` - command tree. - """ - return self._reply - - -class SearchSearchItemTriggerABusEthercatDeviceaddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. - - **Description:** - - This command sets or queries the Device Address in EtherCAT bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess value`` command. - - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess {POSition|OFFSet} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue? - **Info:** - - ``POSition`` specifies the Device Address to position. This is the default value. - - ``OFFSet`` specifies the Device Address to offset. - """ + **Info:** + - ```` is the binary Length to be used when searching on an EtherCAT bus + signal. The default size and value of Length is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. + """ + return self._value -class SearchSearchItemTriggerABusEthercatDestinationaddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` command. +class SearchSearchItemTriggerABusEthercatIrqValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. **Description:** - - This command sets the binary MAC destination address value to be used for EtherCAT bus. + - This command sets the binary interrupt request information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue? **Info:** - - ```` is the binary MAC destination address value to be used when searching on an - EtherCAT bus signal. The default size and value of MAC Destination Address is 48 bits and - 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary interrupt request information to be used when searching on an + EtherCAT bus signal. The default size and value interrupt request information is 16 bits + and 'XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatDestinationaddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. +class SearchSearchItemTriggerABusEthercatIrq(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatDestinationaddressValue( + self._value = SearchSearchItemTriggerABusEthercatIrqValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatDestinationaddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatIrqValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. **Description:** - - This command sets the binary MAC destination address value to be used for EtherCAT + - This command sets the binary interrupt request information to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue? **Info:** - - ```` is the binary MAC destination address value to be used when searching on - an EtherCAT bus signal. The default size and value of MAC Destination Address is 48 - bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary interrupt request information to be used when searching on + an EtherCAT bus signal. The default size and value interrupt request information is 16 + bits and 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. +class SearchSearchItemTriggerABusEthercatIpsourceAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` command. **Description:** - - This command specifies the binary data string used for EtherCAT bus. The search number is + - This command sets the Source IP Address to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue? **Info:** - - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus - signal. The default data size and value is 8 bits and 'XXXXXXXX' respectively. + - ```` is the binary Source IP Address to be used when searching on an EtherCAT bus + signal. The default size and value of Source Address is 32 bits and 'XXXXXXXX XXXXXXXX + XXXXXXXX XXXXXXXX'. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for EtherCAT bus. - The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe? - - **Info:** - - ```` is the binary data value to be used when searching on an Ethernet bus signal. - The default size is 1. The valid range is 1 to 5. - """ - - -class SearchSearchItemTriggerABusEthercatData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. +class SearchSearchItemTriggerABusEthercatIpsourceAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEthercatDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusEthercatDataValue( + self._value = SearchSearchItemTriggerABusEthercatIpsourceAddressValue( device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusEthercatDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatIpsourceAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for EtherCAT - bus. The search number is specified by x. + - This command sets the Source IP Address to be used for EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue? **Info:** - - ```` is the binary data value to be used when searching on an Ethernet bus - signal. The default size is 1. The valid range is 1 to 5. + - ```` is the binary Source IP Address to be used when searching on an EtherCAT + bus signal. The default size and value of Source Address is 32 bits and 'XXXXXXXX + XXXXXXXX XXXXXXXX XXXXXXXX'. """ - return self._size + return self._value - @property - def value(self) -> SearchSearchItemTriggerABusEthercatDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. - **Description:** - - This command specifies the binary data string used for EtherCAT bus. The search number - is specified by x. +class SearchSearchItemTriggerABusEthercatIpsource(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command + tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEthercatIpsourceAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + + @property + def address(self) -> SearchSearchItemTriggerABusEthercatIpsourceAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue value`` command. - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue? - - **Info:** - - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus - signal. The default data size and value is 8 bits and 'XXXXXXXX' respectively. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess:VALue`` + command. """ - return self._value + return self._address -class SearchSearchItemTriggerABusEthercatDatagramheaderLength(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` command. +class SearchSearchItemTriggerABusEthercatIpdestinationAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. **Description:** - - This command sets the binary Datagram length information to be used for EtherCAT bus. The - search number is specified by x. + - This command sets the Destination IP Address to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue? **Info:** - - ```` is the binary Datagram length information to be used when searching on an - EtherCAT bus signal. The default size and value Datagram length information is 11 bits and - 'XXXXXXXX XXX' respectively. + - ```` is the binary Destination IP Address to be used when searching on an + EtherCAT bus signal. The default size and value of Destination Address is 32 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatDatagramheader(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` command. - - **Description:** - - This command sets or queries the Datagram Header fields in EtherCAT bus. The search number - is specified by x. +class SearchSearchItemTriggerABusEthercatIpdestinationAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer {CMD|IDX|ADDRess|LEN|CIRCulating|IRQ} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer? - - **Info:** - - ``CMD`` specifies the Datagram Header field as CMD. This is the default value. - - ``IDX`` specifies the Datagram Header field as IDX. - - ``ADDRess`` specifies the Datagram Header field as ADDRess. - - ``LEN`` specifies the Datagram Header field as LEN. - - ``CIRCulating`` specifies the Datagram Header field as CIRCulating. - - ``IRQ`` specifies the Datagram Header field as IRQ. Properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. - """ # noqa: E501 + """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._length = SearchSearchItemTriggerABusEthercatDatagramheaderLength( - device, f"{self._cmd_syntax}:LENGth" + self._value = SearchSearchItemTriggerABusEthercatIpdestinationAddressValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def length(self) -> SearchSearchItemTriggerABusEthercatDatagramheaderLength: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatIpdestinationAddressValue: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. **Description:** - - This command sets the binary Datagram length information to be used for EtherCAT bus. - The search number is specified by x. + - This command sets the Destination IP Address to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue?`` query and + raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue? **Info:** - - ```` is the binary Datagram length information to be used when searching on - an EtherCAT bus signal. The default size and value Datagram length information is 11 - bits and 'XXXXXXXX XXX' respectively. + - ```` is the binary Destination IP Address to be used when searching on an + EtherCAT bus signal. The default size and value of Destination Address is 32 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX'. """ - return self._length - + return self._value -class SearchSearchItemTriggerABusEthercatDatagram(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. - **Description:** - - This command sets or queries the Datagram fields in EtherCAT bus. The search number is - specified by x. +class SearchSearchItemTriggerABusEthercatIpdestination(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query and raise an + AssertionError if the returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` + command tree. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEthercatIpdestinationAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM {HEADer|DATa|WKC} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM? + @property + def address(self) -> SearchSearchItemTriggerABusEthercatIpdestinationAddress: + """``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` command tree. - **Info:** - - ``HEADer`` specifies the Datagram field and sets it to Header. This is the default value. - - ``DATa`` specifies the Datagram field and sets it to Data. - - ``WKC`` specifies the Datagram field and sets it to WKC. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess:VALue`` command. + """ + return self._address -class SearchSearchItemTriggerABusEthercatCycValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. +class SearchSearchItemTriggerABusEthercatIndexValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. **Description:** - - This command sets the binary Cycle Number to be used for EtherCAT bus. The search number - is specified by x. + - This command sets the binary Index to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue? **Info:** - - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus - signal. The default size and value of Network Variable Count is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is the binary Index to be used when searching on an EtherCAT bus signal. The + default size and value of Index is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatCyc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. +class SearchSearchItemTriggerABusEthercatIndex(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatCycValue( + self._value = SearchSearchItemTriggerABusEthercatIndexValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatCycValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatIndexValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. **Description:** - - This command sets the binary Cycle Number to be used for EtherCAT bus. The search - number is specified by x. + - This command sets the binary Index to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue? **Info:** - - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus - signal. The default size and value of Network Variable Count is 16 bits and 'XXXXXXXX - XXXXXXXX' respectively. + - ```` is the binary Index to be used when searching on an EtherCAT bus signal. + The default size and value of Index is 16 bits and 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. +class SearchSearchItemTriggerABusEthercatIdxValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. **Description:** - - This command sets or queries the trigger condition for a EtherCAT bus. The search number - is specified by x. + - This command sets the binary Indexing information to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition {SOF| PROTocol| IPHEADer| UDPIPHEADer| MACADDRess| TCI| ECATHEADERLENGth| DATagram| NETWORKVARiable| MAILBOX| FCSERRor| EOF} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue? **Info:** - - ``SOF`` specifies the field within a EtherCAT frame to search on as SOF. This is the - default value. - - ``PROTocol`` specifies the field within a EtherCAT frame to search on as PROTocol. - - ``IPHEADer`` specifies the field within a EtherCAT frame to search on as IPHEADer. - - ``UDPIPHEADer`` specifies the field within a EtherCAT frame to search on as UDPIPHEADer. - - ``MACADDRess`` specifies the field within a EtherCAT frame to search on as MACADDRess. - - ``TCI`` specifies the field within a EtherCAT frame to search on as TCI. - - ``ECATHEADERLENGth`` specifies the field within a EtherCAT frame to search on as - ECATHEADERLENGth. - - ``DATagram`` specifies the field within a EtherCAT frame to search on as DATagram. - - ``NETWORKVARiable`` specifies the field within a EtherCAT frame to search on as - NETWORKVARiable. - - ``MAILBOX`` specifies the field within a EtherCAT frame to search on as MAILBOX. - - ``FCSERRor`` specifies the field within a EtherCAT frame to search on as FCSERRor. - - ``EOF`` specifies the field within a EtherCAT frame to search on as EOF. - """ # noqa: E501 + - ```` is the binary Index value to be used when searching on an EtherCAT bus + signal. The default size and value of Index is 8 bits and 'XXXXXXXX' respectively. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatCommandtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. - **Description:** - - This command sets or queries the Command Type in EtherCAT bus. The search number is - specified by x. +class SearchSearchItemTriggerABusEthercatIdx(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query and raise an AssertionError if the + returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthercatIdxValue( + device, f"{self._cmd_syntax}:VALue" + ) - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe {NOP| APRD| APWR| APRW| FPRD| FPWR| FPRW| BRD| BWR| BRW| LRD| LWR| LRW| ARMW| FRMW| REServed} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe? + @property + def value(self) -> SearchSearchItemTriggerABusEthercatIdxValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. - **Info:** - - ``NOP`` specifies the Command Type and sets it to NOP. This is the default value. - - ``APRD`` specifies the Command Type and sets it to APRD. - - ``APWR`` specifies the Command Type and sets it to APWR. - - ``APRW`` specifies the Command Type and sets it to APRW. - - ``FPRD`` specifies the Command Type and sets it to FPRD. - - ``FPWR`` specifies the Command Type and sets it to FPWR. - - ``FPRW`` specifies the Command Type and sets it to FPRW. - - ``BRD`` specifies the Command Type and sets it to BRD. - - ``BWR`` specifies the Command Type and sets it to BWR. - - ``BRW`` specifies the Command Type and sets it to BRW. - - ``LRD`` specifies the Command Type and sets it to LRD. - - ``LWR`` specifies the Command Type and sets it to LWR. - - ``LRW`` specifies the Command Type and sets it to LRW. - - ``ARMW`` specifies the Command Type and sets it to ARMW. - - ``FRMW`` specifies the Command Type and sets it to FRMW. - - ``REServed`` specifies the Command Type and sets it to REServed. - """ # noqa: E501 + **Description:** + - This command sets the binary Indexing information to be used for EtherCAT bus. The + search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue value`` command. + **SCPI Syntax:** -class SearchSearchItemTriggerABusEthercatCntnvValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue? + + **Info:** + - ```` is the binary Index value to be used when searching on an EtherCAT bus + signal. The default size and value of Index is 8 bits and 'XXXXXXXX' respectively. + """ + return self._value + + +class SearchSearchItemTriggerABusEthercatIdentificationValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. **Description:** - - This command sets the binary Network Variable Count to be used for EtherCAT bus. The - search number is specified by x. + - This command sets the IP Identification to be used for EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue? **Info:** - - ```` is the binary Network Variable Count to be used when searching on an - EtherCAT bus signal. The default size and value of Network Variable Count is 16 bits and - 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary IP Identification to be used when searching on an EtherCAT bus + signal. The default size and value of Identification is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEthercatCntnv(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. +class SearchSearchItemTriggerABusEthercatIdentification(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEthercatCntnvValue( + self._value = SearchSearchItemTriggerABusEthercatIdentificationValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEthercatCntnvValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatIdentificationValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. **Description:** - - This command sets the binary Network Variable Count to be used for EtherCAT bus. The - search number is specified by x. + - This command sets the IP Identification to be used for EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue? **Info:** - - ```` is the binary Network Variable Count to be used when searching on an - EtherCAT bus signal. The default size and value of Network Variable Count is 16 bits - and 'XXXXXXXX XXXXXXXX' respectively. + - ```` is the binary IP Identification to be used when searching on an EtherCAT + bus signal. The default size and value of Identification is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEthercatAddressmode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. +class SearchSearchItemTriggerABusEthercatHeaderLength(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. **Description:** - - This command sets or queries the Address Mode in EtherCAT bus. The search number is - specified by x. + - This command sets or queries the binary header length to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe {DEVice|LOGical} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth? **Info:** - - ``DEVice`` sets the Address Mode to Device. This is the default value. - - ``LOGical`` sets the Address Mode to Logical. + - ```` is the binary header length to be used when searching on an EtherCAT bus + signal. The default size and value of Length is 11 bits and 'XXX XXXXXXXX' respectively. """ + _WRAP_ARG_WITH_QUOTES = True -# pylint: disable=too-many-instance-attributes,too-many-public-methods -class SearchSearchItemTriggerABusEthercat(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT`` command tree. + +class SearchSearchItemTriggerABusEthercatHeader(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.addressmode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. - - ``.cntnv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. - - ``.commandtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. - - ``.cyc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. - - ``.datagram``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. - - ``.datagramheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` - command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. - - ``.destinationaddress``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. - - ``.deviceaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. - - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. - - ``.hash``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. - - ``.identification``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` - command tree. - - ``.idx``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. - - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. - - ``.ipdestination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command - tree. - - ``.ipsource``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. - - ``.irq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. - - ``.len``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. - - ``.logicaladdress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` - command tree. - - ``.mailboxtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. - - ``.mailbox``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. - - ``.networkvariable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` - command tree. - - ``.network``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. - - ``.position``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. - - ``.protocoltype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. - - ``.pubid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. - - ``.quality``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. - - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. - - ``.sourceaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command - tree. - - ``.src``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. - - ``.tci``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. - - ``.wkc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._addressmode = SearchSearchItemTriggerABusEthercatAddressmode( - device, f"{self._cmd_syntax}:ADDRESSMODe" - ) - self._cntnv = SearchSearchItemTriggerABusEthercatCntnv(device, f"{self._cmd_syntax}:CNTNV") - self._commandtype = SearchSearchItemTriggerABusEthercatCommandtype( - device, f"{self._cmd_syntax}:COMMANDTYPe" - ) - self._condition = SearchSearchItemTriggerABusEthercatCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._cyc = SearchSearchItemTriggerABusEthercatCyc(device, f"{self._cmd_syntax}:CYC") - self._datagram = SearchSearchItemTriggerABusEthercatDatagram( - device, f"{self._cmd_syntax}:DATAGRAM" - ) - self._datagramheader = SearchSearchItemTriggerABusEthercatDatagramheader( - device, f"{self._cmd_syntax}:DATAGRAMHEADer" - ) - self._data = SearchSearchItemTriggerABusEthercatData(device, f"{self._cmd_syntax}:DATa") - self._destinationaddress = SearchSearchItemTriggerABusEthercatDestinationaddress( - device, f"{self._cmd_syntax}:DESTINATIONADDRess" - ) - self._deviceaddress = SearchSearchItemTriggerABusEthercatDeviceaddress( - device, f"{self._cmd_syntax}:DEVICEADDRess" - ) - self._error = SearchSearchItemTriggerABusEthercatError(device, f"{self._cmd_syntax}:ERRor") - self._frametype = SearchSearchItemTriggerABusEthercatFrametype( - device, f"{self._cmd_syntax}:FRAMETYPe" - ) - self._hash = SearchSearchItemTriggerABusEthercatHash(device, f"{self._cmd_syntax}:HASH") - self._header = SearchSearchItemTriggerABusEthercatHeader( - device, f"{self._cmd_syntax}:HEADer" - ) - self._identification = SearchSearchItemTriggerABusEthercatIdentification( - device, f"{self._cmd_syntax}:IDENtification" - ) - self._idx = SearchSearchItemTriggerABusEthercatIdx(device, f"{self._cmd_syntax}:IDX") - self._index = SearchSearchItemTriggerABusEthercatIndex(device, f"{self._cmd_syntax}:INDex") - self._ipdestination = SearchSearchItemTriggerABusEthercatIpdestination( - device, f"{self._cmd_syntax}:IPDESTination" - ) - self._ipsource = SearchSearchItemTriggerABusEthercatIpsource( - device, f"{self._cmd_syntax}:IPSOURce" - ) - self._irq = SearchSearchItemTriggerABusEthercatIrq(device, f"{self._cmd_syntax}:IRQ") - self._len = SearchSearchItemTriggerABusEthercatLen(device, f"{self._cmd_syntax}:LEN") - self._logicaladdress = SearchSearchItemTriggerABusEthercatLogicaladdress( - device, f"{self._cmd_syntax}:LOGICALADDRess" - ) - self._mailboxtype = SearchSearchItemTriggerABusEthercatMailboxtype( - device, f"{self._cmd_syntax}:MAILBOXTYPe" - ) - self._mailbox = SearchSearchItemTriggerABusEthercatMailbox( - device, f"{self._cmd_syntax}:MAILbox" - ) - self._networkvariable = SearchSearchItemTriggerABusEthercatNetworkvariable( - device, f"{self._cmd_syntax}:NETWORKVARiable" - ) - self._network = SearchSearchItemTriggerABusEthercatNetwork( - device, f"{self._cmd_syntax}:NETWork" - ) - self._offset = SearchSearchItemTriggerABusEthercatOffset( - device, f"{self._cmd_syntax}:OFFSet" - ) - self._position = SearchSearchItemTriggerABusEthercatPosition( - device, f"{self._cmd_syntax}:POSition" - ) - self._protocoltype = SearchSearchItemTriggerABusEthercatProtocoltype( - device, f"{self._cmd_syntax}:PROTOCOLTYPe" - ) - self._pubid = SearchSearchItemTriggerABusEthercatPubid(device, f"{self._cmd_syntax}:PUBID") - self._quality = SearchSearchItemTriggerABusEthercatQuality( - device, f"{self._cmd_syntax}:QUALity" - ) - self._service = SearchSearchItemTriggerABusEthercatService( - device, f"{self._cmd_syntax}:SERVice" - ) - self._sourceaddress = SearchSearchItemTriggerABusEthercatSourceaddress( - device, f"{self._cmd_syntax}:SOURCEADDRess" + super().__init__(device, cmd_syntax) + self._length = SearchSearchItemTriggerABusEthercatHeaderLength( + device, f"{self._cmd_syntax}:LENGth" ) - self._src = SearchSearchItemTriggerABusEthercatSrc(device, f"{self._cmd_syntax}:SRC") - self._tci = SearchSearchItemTriggerABusEthercatTci(device, f"{self._cmd_syntax}:TCI") - self._wkc = SearchSearchItemTriggerABusEthercatWkc(device, f"{self._cmd_syntax}:WKC") @property - def addressmode(self) -> SearchSearchItemTriggerABusEthercatAddressmode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. + def length(self) -> SearchSearchItemTriggerABusEthercatHeaderLength: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. **Description:** - - This command sets or queries the Address Mode in EtherCAT bus. The search number is - specified by x. + - This command sets or queries the binary header length to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe {DEVice|LOGical} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth? **Info:** - - ``DEVice`` sets the Address Mode to Device. This is the default value. - - ``LOGical`` sets the Address Mode to Logical. + - ```` is the binary header length to be used when searching on an EtherCAT bus + signal. The default size and value of Length is 11 bits and 'XXX XXXXXXXX' + respectively. """ - return self._addressmode + return self._length - @property - def cntnv(self) -> SearchSearchItemTriggerABusEthercatCntnv: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query and raise an AssertionError - if the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatHashValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. - """ - return self._cntnv + **Description:** + - This command sets the binary HASH to be used for EtherCAT bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue? + + **Info:** + - ```` is the binary Hash value to be used when searching on an EtherCAT bus + signal. The default size and value of Hash is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusEthercatHash(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthercatHashValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def commandtype(self) -> SearchSearchItemTriggerABusEthercatCommandtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatHashValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. **Description:** - - This command sets or queries the Command Type in EtherCAT bus. The search number is + - This command sets the binary HASH to be used for EtherCAT bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe {NOP| APRD| APWR| APRW| FPRD| FPWR| FPRW| BRD| BWR| BRW| LRD| LWR| LRW| ARMW| FRMW| REServed} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue? **Info:** - - ``NOP`` specifies the Command Type and sets it to NOP. This is the default value. - - ``APRD`` specifies the Command Type and sets it to APRD. - - ``APWR`` specifies the Command Type and sets it to APWR. - - ``APRW`` specifies the Command Type and sets it to APRW. - - ``FPRD`` specifies the Command Type and sets it to FPRD. - - ``FPWR`` specifies the Command Type and sets it to FPWR. - - ``FPRW`` specifies the Command Type and sets it to FPRW. - - ``BRD`` specifies the Command Type and sets it to BRD. - - ``BWR`` specifies the Command Type and sets it to BWR. - - ``BRW`` specifies the Command Type and sets it to BRW. - - ``LRD`` specifies the Command Type and sets it to LRD. - - ``LWR`` specifies the Command Type and sets it to LWR. - - ``LRW`` specifies the Command Type and sets it to LRW. - - ``ARMW`` specifies the Command Type and sets it to ARMW. - - ``FRMW`` specifies the Command Type and sets it to FRMW. - - ``REServed`` specifies the Command Type and sets it to REServed. - """ # noqa: E501 - return self._commandtype + - ```` is the binary Hash value to be used when searching on an EtherCAT bus + signal. The default size and value of Hash is 16 bits and 'XXXXXXXX XXXXXXXX' + respectively. + """ + return self._value - @property - def condition(self) -> SearchSearchItemTriggerABusEthercatCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. - **Description:** - - This command sets or queries the trigger condition for a EtherCAT bus. The search - number is specified by x. +class SearchSearchItemTriggerABusEthercatFrametype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition value`` command. + **Description:** + - This command sets or queries the Frame Type in EtherCAT bus. The search number is + specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition {SOF| PROTocol| IPHEADer| UDPIPHEADer| MACADDRess| TCI| ECATHEADERLENGth| DATagram| NETWORKVARiable| MAILBOX| FCSERRor| EOF} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition? + :: - **Info:** - - ``SOF`` specifies the field within a EtherCAT frame to search on as SOF. This is the - default value. - - ``PROTocol`` specifies the field within a EtherCAT frame to search on as PROTocol. - - ``IPHEADer`` specifies the field within a EtherCAT frame to search on as IPHEADer. - - ``UDPIPHEADer`` specifies the field within a EtherCAT frame to search on as - UDPIPHEADer. - - ``MACADDRess`` specifies the field within a EtherCAT frame to search on as MACADDRess. - - ``TCI`` specifies the field within a EtherCAT frame to search on as TCI. - - ``ECATHEADERLENGth`` specifies the field within a EtherCAT frame to search on as - ECATHEADERLENGth. - - ``DATagram`` specifies the field within a EtherCAT frame to search on as DATagram. - - ``NETWORKVARiable`` specifies the field within a EtherCAT frame to search on as - NETWORKVARiable. - - ``MAILBOX`` specifies the field within a EtherCAT frame to search on as MAILBOX. - - ``FCSERRor`` specifies the field within a EtherCAT frame to search on as FCSERRor. - - ``EOF`` specifies the field within a EtherCAT frame to search on as EOF. - """ # noqa: E501 - return self._condition + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe {BASic|UDPIP} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe? - @property - def cyc(self) -> SearchSearchItemTriggerABusEthercatCyc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. + **Info:** + - ``BASic`` specifies the Frame Type as BASic. This is the default value. + - ``UDPIP`` specifies the Frame Type as UDPIP. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query and raise an AssertionError if - the returned value does not match ``value``. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. - """ - return self._cyc +class SearchSearchItemTriggerABusEthercatErrorReplyServiceData(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` command. - @property - def datagram(self) -> SearchSearchItemTriggerABusEthercatDatagram: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. + **Description:** + - This command sets or queries the error reply service data fields in EtherCAT bus. The + search number is specified by x. - **Description:** - - This command sets or queries the Datagram fields in EtherCAT bus. The search number is - specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa {TYPe|DETail} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa? - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM {HEADer|DATa|WKC} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM? + **Info:** + - ``TYPe`` specifies the Error Reply Service Data to type. This is the default value. + - ``DETail`` specifies the Error Reply Service Data to detail. + """ - **Info:** - - ``HEADer`` specifies the Datagram field and sets it to Header. This is the default - value. - - ``DATa`` specifies the Datagram field and sets it to Data. - - ``WKC`` specifies the Datagram field and sets it to WKC. - """ - return self._datagram + +class SearchSearchItemTriggerABusEthercatErrorReplyService(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` + command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._data = SearchSearchItemTriggerABusEthercatErrorReplyServiceData( + device, f"{self._cmd_syntax}:DATa" + ) @property - def datagramheader(self) -> SearchSearchItemTriggerABusEthercatDatagramheader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` command. + def data(self) -> SearchSearchItemTriggerABusEthercatErrorReplyServiceData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` command. **Description:** - - This command sets or queries the Datagram Header fields in EtherCAT bus. The search - number is specified by x. + - This command sets or queries the error reply service data fields in EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa?`` query and raise + an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer {CMD|IDX|ADDRess|LEN|CIRCulating|IRQ} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa {TYPe|DETail} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa? **Info:** - - ``CMD`` specifies the Datagram Header field as CMD. This is the default value. - - ``IDX`` specifies the Datagram Header field as IDX. - - ``ADDRess`` specifies the Datagram Header field as ADDRess. - - ``LEN`` specifies the Datagram Header field as LEN. - - ``CIRCulating`` specifies the Datagram Header field as CIRCulating. - - ``IRQ`` specifies the Datagram Header field as IRQ. + - ``TYPe`` specifies the Error Reply Service Data to type. This is the default value. + - ``DETail`` specifies the Error Reply Service Data to detail. + """ + return self._data - Sub-properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` - command. - """ # noqa: E501 - return self._datagramheader + +class SearchSearchItemTriggerABusEthercatErrorReply(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Properties: + - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command + tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._service = SearchSearchItemTriggerABusEthercatErrorReplyService( + device, f"{self._cmd_syntax}:SERVice" + ) @property - def data(self) -> SearchSearchItemTriggerABusEthercatData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. + def service(self) -> SearchSearchItemTriggerABusEthercatErrorReplyService: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice:DATa`` + command. """ - return self._data + return self._service + + +class SearchSearchItemTriggerABusEthercatError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.reply``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._reply = SearchSearchItemTriggerABusEthercatErrorReply( + device, f"{self._cmd_syntax}:REPLy" + ) @property - def destinationaddress(self) -> SearchSearchItemTriggerABusEthercatDestinationaddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. + def reply(self) -> SearchSearchItemTriggerABusEthercatErrorReply: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` - command. + - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy:SERVice`` + command tree. """ - return self._destinationaddress + return self._reply - @property - def deviceaddress(self) -> SearchSearchItemTriggerABusEthercatDeviceaddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. - **Description:** - - This command sets or queries the Device Address in EtherCAT bus. The search number is - specified by x. +class SearchSearchItemTriggerABusEthercatDeviceaddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess value`` command. + **Description:** + - This command sets or queries the Device Address in EtherCAT bus. The search number is + specified by x. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess value`` command. - :: + **SCPI Syntax:** - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess {POSition|OFFSet} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess? + :: - **Info:** - - ``POSition`` specifies the Device Address to position. This is the default value. - - ``OFFSet`` specifies the Device Address to offset. - """ - return self._deviceaddress + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess {POSition|OFFSet} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess? - @property - def error(self) -> SearchSearchItemTriggerABusEthercatError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. + **Info:** + - ``POSition`` specifies the Device Address to position. This is the default value. + - ``OFFSet`` specifies the Device Address to offset. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query and raise an AssertionError - if the returned value does not match ``value``. - Sub-properties: - - ``.reply``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. - """ - return self._error +class SearchSearchItemTriggerABusEthercatDestinationaddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` command. - @property - def frametype(self) -> SearchSearchItemTriggerABusEthercatFrametype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. + **Description:** + - This command sets the binary MAC destination address value to be used for EtherCAT bus. + The search number is specified by x. - **Description:** - - This command sets or queries the Frame Type in EtherCAT bus. The search number is - specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue? - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe {BASic|UDPIP} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe? + **Info:** + - ```` is the binary MAC destination address value to be used when searching on an + EtherCAT bus signal. The default size and value of MAC Destination Address is 48 bits and + 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. + """ - **Info:** - - ``BASic`` specifies the Frame Type as BASic. This is the default value. - - ``UDPIP`` specifies the Frame Type as UDPIP. - """ - return self._frametype + _WRAP_ARG_WITH_QUOTES = True - @property - def hash(self) -> SearchSearchItemTriggerABusEthercatHash: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatDestinationaddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. - """ - return self._hash + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` + command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthercatDestinationaddressValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def header(self) -> SearchSearchItemTriggerABusEthercatHeader: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. + def value(self) -> SearchSearchItemTriggerABusEthercatDestinationaddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` command. + + **Description:** + - This command sets the binary MAC destination address value to be used for EtherCAT + bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue?`` query and raise + an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue value`` command. - Sub-properties: - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. - """ - return self._header + **SCPI Syntax:** - @property - def identification(self) -> SearchSearchItemTriggerABusEthercatIdentification: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query and raise an - AssertionError if the returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue? - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` - command. + **Info:** + - ```` is the binary MAC destination address value to be used when searching on + an EtherCAT bus signal. The default size and value of MAC Destination Address is 48 + bits and 'XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX' respectively. """ - return self._identification + return self._value - @property - def idx(self) -> SearchSearchItemTriggerABusEthercatIdx: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. - """ - return self._idx + **Description:** + - This command specifies the binary data string used for EtherCAT bus. The search number is + specified by x. - @property - def index(self) -> SearchSearchItemTriggerABusEthercatIndex: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query and raise an AssertionError - if the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. - """ - return self._index + :: - @property - def ipdestination(self) -> SearchSearchItemTriggerABusEthercatIpdestination: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Info:** + - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus + signal. The default data size and value is 8 bits and 'XXXXXXXX' respectively. + """ - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` - command tree. - """ - return self._ipdestination + _WRAP_ARG_WITH_QUOTES = True - @property - def ipsource(self) -> SearchSearchItemTriggerABusEthercatIpsource: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query and raise an - AssertionError if the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command - tree. - """ - return self._ipsource + **Description:** + - This command specifies the length of the data string in bytes to be used for EtherCAT bus. + The search number is specified by x. - @property - def irq(self) -> SearchSearchItemTriggerABusEthercatIrq: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query and raise an AssertionError if - the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. - """ - return self._irq + :: - @property - def len(self) -> SearchSearchItemTriggerABusEthercatLen: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Info:** + - ```` is the binary data value to be used when searching on an Ethernet bus signal. + The default size is 1. The valid range is 1 to 5. + """ - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. - """ - return self._len - @property - def logicaladdress(self) -> SearchSearchItemTriggerABusEthercatLogicaladdress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` command tree. +class SearchSearchItemTriggerABusEthercatData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` - command. - """ - return self._logicaladdress + Properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._size = SearchSearchItemTriggerABusEthercatDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusEthercatDataValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def mailboxtype(self) -> SearchSearchItemTriggerABusEthercatMailboxtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. + def size(self) -> SearchSearchItemTriggerABusEthercatDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. **Description:** - - This command sets or queries the Mailbox Type fields in EtherCAT bus. The search - number is specified by x. + - This command specifies the length of the data string in bytes to be used for EtherCAT + bus. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe {ZERo| ONE| TWO| THRee| FOUR| FIVe| RESERved| FIFTeen} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe? **Info:** - - ``ZERo`` specifies the Mailbox Type as ZERo. This is the default value. - - ``ONE`` specifies the Mailbox Type as ONE. - - ``TWO`` specifies the Mailbox Type as TWO. - - ``THRee`` specifies the Mailbox Type as THRee. - - ``FOUR`` specifies the Mailbox Type as FOUR. - - ``FIVe`` specifies the Mailbox Type as FIVe. - - ``RESERved`` specifies the Mailbox Type as RESERved. - - ``FIFTeen`` specifies the Mailbox Type as FIFTeen. - """ # noqa: E501 - return self._mailboxtype + - ```` is the binary data value to be used when searching on an Ethernet bus + signal. The default size is 1. The valid range is 1 to 5. + """ + return self._size @property - def mailbox(self) -> SearchSearchItemTriggerABusEthercatMailbox: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. **Description:** - - This command sets or queries the Mailbox fields in EtherCAT bus. The search number is - specified by x. + - This command specifies the binary data string used for EtherCAT bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox {MAILBOXHEADer|SERVICEDATa|ERRSERVICEDATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue? **Info:** - - ``MAILBOXHEADer`` specifies the Mailbox fields as mailbox header. This is the default - value. - - ``SERVICEDATa`` specifies the Mailbox fields as service data. - - ``ERRSERVICEDATa`` specifies the Mailbox fields as error reply service data. + - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus + signal. The default data size and value is 8 bits and 'XXXXXXXX' respectively. + """ + return self._value - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command - tree. - - ``.cnt``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. - - ``.detail``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. - - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. - """ # noqa: E501 - return self._mailbox - @property - def networkvariable(self) -> SearchSearchItemTriggerABusEthercatNetworkvariable: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` command tree. +class SearchSearchItemTriggerABusEthercatDatagramheaderLength(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Description:** + - This command sets the binary Datagram length information to be used for EtherCAT bus. The + search number is specified by x. - Sub-properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` - command tree. - """ - return self._networkvariable + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth value`` command. - @property - def network(self) -> SearchSearchItemTriggerABusEthercatNetwork: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query and raise an AssertionError - if the returned value does not match ``value``. + :: - Sub-properties: - - ``.variable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` - command. - """ - return self._network + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth? - @property - def offset(self) -> SearchSearchItemTriggerABusEthercatOffset: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. + **Info:** + - ```` is the binary Datagram length information to be used when searching on an + EtherCAT bus signal. The default size and value Datagram length information is 11 bits and + 'XXXXXXXX XXX' respectively. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query and raise an AssertionError - if the returned value does not match ``value``. + _WRAP_ARG_WITH_QUOTES = True - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. - """ - return self._offset - @property - def position(self) -> SearchSearchItemTriggerABusEthercatPosition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. +class SearchSearchItemTriggerABusEthercatDatagramheader(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Description:** + - This command sets or queries the Datagram Header fields in EtherCAT bus. The search number + is specified by x. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. - """ - return self._position + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer {CMD|IDX|ADDRess|LEN|CIRCulating|IRQ} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer? + + **Info:** + - ``CMD`` specifies the Datagram Header field as CMD. This is the default value. + - ``IDX`` specifies the Datagram Header field as IDX. + - ``ADDRess`` specifies the Datagram Header field as ADDRess. + - ``LEN`` specifies the Datagram Header field as LEN. + - ``CIRCulating`` specifies the Datagram Header field as CIRCulating. + - ``IRQ`` specifies the Datagram Header field as IRQ. + + Properties: + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` + command. + """ # noqa: E501 + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._length = SearchSearchItemTriggerABusEthercatDatagramheaderLength( + device, f"{self._cmd_syntax}:LENGth" + ) @property - def protocoltype(self) -> SearchSearchItemTriggerABusEthercatProtocoltype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. + def length(self) -> SearchSearchItemTriggerABusEthercatDatagramheaderLength: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` command. **Description:** - - This command sets or queries the EtherCAT Protocol Type in EtherCAT bus. The search - number is specified by x. + - This command sets the binary Datagram length information to be used for EtherCAT bus. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe {PDU|NETWORKVARiables|MAILbox} - - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth? **Info:** - - ``PDU`` specifies the Protocol Type as PDU. This is the default value. - - ``NETWORKVARiables`` specifies the Protocol Type as NETWORKVARiables. - - ``MAILbox`` specifies the Protocol Type as MAILbox. + - ```` is the binary Datagram length information to be used when searching on + an EtherCAT bus signal. The default size and value Datagram length information is 11 + bits and 'XXXXXXXX XXX' respectively. """ - return self._protocoltype + return self._length - @property - def pubid(self) -> SearchSearchItemTriggerABusEthercatPubid: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query and raise an AssertionError - if the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatDatagram(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. - """ - return self._pubid + **Description:** + - This command sets or queries the Datagram fields in EtherCAT bus. The search number is + specified by x. - @property - def quality(self) -> SearchSearchItemTriggerABusEthercatQuality: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query and raise an AssertionError - if the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. - """ - return self._quality + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM {HEADer|DATa|WKC} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM? + + **Info:** + - ``HEADer`` specifies the Datagram field and sets it to Header. This is the default value. + - ``DATa`` specifies the Datagram field and sets it to Data. + - ``WKC`` specifies the Datagram field and sets it to WKC. + """ + + +class SearchSearchItemTriggerABusEthercatCycValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + + **Description:** + - This command sets the binary Cycle Number to be used for EtherCAT bus. The search number + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue? + + **Info:** + - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus + signal. The default size and value of Network Variable Count is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusEthercatCyc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEthercatCycValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def service(self) -> SearchSearchItemTriggerABusEthercatService: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. + def value(self) -> SearchSearchItemTriggerABusEthercatCycValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + + **Description:** + - This command sets the binary Cycle Number to be used for EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue value`` command. - Sub-properties: - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. - """ - return self._service + **SCPI Syntax:** - @property - def sourceaddress(self) -> SearchSearchItemTriggerABusEthercatSourceaddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue? - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` - command. + **Info:** + - ```` is the binary Cycle Number to be used when searching on an EtherCAT bus + signal. The default size and value of Network Variable Count is 16 bits and 'XXXXXXXX + XXXXXXXX' respectively. """ - return self._sourceaddress + return self._value - @property - def src(self) -> SearchSearchItemTriggerABusEthercatSrc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusEthercatCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. - Sub-properties: - - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. - """ - return self._src + **Description:** + - This command sets or queries the trigger condition for a EtherCAT bus. The search number + is specified by x. - @property - def tci(self) -> SearchSearchItemTriggerABusEthercatTci: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query and raise an AssertionError if - the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. - """ - return self._tci + :: - @property - def wkc(self) -> SearchSearchItemTriggerABusEthercatWkc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition {SOF| PROTocol| IPHEADer| UDPIPHEADer| MACADDRess| TCI| ECATHEADERLENGth| DATagram| NETWORKVARiable| MAILBOX| FCSERRor| EOF} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Info:** + - ``SOF`` specifies the field within a EtherCAT frame to search on as SOF. This is the + default value. + - ``PROTocol`` specifies the field within a EtherCAT frame to search on as PROTocol. + - ``IPHEADer`` specifies the field within a EtherCAT frame to search on as IPHEADer. + - ``UDPIPHEADer`` specifies the field within a EtherCAT frame to search on as UDPIPHEADer. + - ``MACADDRess`` specifies the field within a EtherCAT frame to search on as MACADDRess. + - ``TCI`` specifies the field within a EtherCAT frame to search on as TCI. + - ``ECATHEADERLENGth`` specifies the field within a EtherCAT frame to search on as + ECATHEADERLENGth. + - ``DATagram`` specifies the field within a EtherCAT frame to search on as DATagram. + - ``NETWORKVARiable`` specifies the field within a EtherCAT frame to search on as + NETWORKVARiable. + - ``MAILBOX`` specifies the field within a EtherCAT frame to search on as MAILBOX. + - ``FCSERRor`` specifies the field within a EtherCAT frame to search on as FCSERRor. + - ``EOF`` specifies the field within a EtherCAT frame to search on as EOF. + """ # noqa: E501 - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. - """ - return self._wkc +class SearchSearchItemTriggerABusEthercatCommandtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. -class SearchSearchItemTriggerABusEspiVirtualwireStatusValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. + **Description:** + - This command sets or queries the Command Type in EtherCAT bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe {NOP| APRD| APWR| APRW| FPRD| FPWR| FPRW| BRD| BWR| BRW| LRD| LWR| LRW| ARMW| FRMW| REServed} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe? + + **Info:** + - ``NOP`` specifies the Command Type and sets it to NOP. This is the default value. + - ``APRD`` specifies the Command Type and sets it to APRD. + - ``APWR`` specifies the Command Type and sets it to APWR. + - ``APRW`` specifies the Command Type and sets it to APRW. + - ``FPRD`` specifies the Command Type and sets it to FPRD. + - ``FPWR`` specifies the Command Type and sets it to FPWR. + - ``FPRW`` specifies the Command Type and sets it to FPRW. + - ``BRD`` specifies the Command Type and sets it to BRD. + - ``BWR`` specifies the Command Type and sets it to BWR. + - ``BRW`` specifies the Command Type and sets it to BRW. + - ``LRD`` specifies the Command Type and sets it to LRD. + - ``LWR`` specifies the Command Type and sets it to LWR. + - ``LRW`` specifies the Command Type and sets it to LRW. + - ``ARMW`` specifies the Command Type and sets it to ARMW. + - ``FRMW`` specifies the Command Type and sets it to FRMW. + - ``REServed`` specifies the Command Type and sets it to REServed. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusEthercatCntnvValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Status. The search number is specified by x. + - This command sets the binary Network Variable Count to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue? **Info:** - - ```` is the identifier value. The default value is XXXXXXXXXXXXXXXX. + - ```` is the binary Network Variable Count to be used when searching on an + EtherCAT bus signal. The default size and value of Network Variable Count is 16 bits and + 'XXXXXXXX XXXXXXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEspiVirtualwireStatus(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. +class SearchSearchItemTriggerABusEthercatCntnv(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiVirtualwireStatusValue( + self._value = SearchSearchItemTriggerABusEthercatCntnvValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireStatusValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEthercatCntnvValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Status. The search number is specified by x. + - This command sets the binary Network Variable Count to be used for EtherCAT bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue? **Info:** - - ```` is the identifier value. The default value is XXXXXXXXXXXXXXXX. + - ```` is the binary Network Variable Count to be used when searching on an + EtherCAT bus signal. The default size and value of Network Variable Count is 16 bits + and 'XXXXXXXX XXXXXXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusEspiVirtualwireResponseValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` command. +class SearchSearchItemTriggerABusEthercatAddressmode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Response. The search number is specified by x. + - This command sets or queries the Address Mode in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe {DEVice|LOGical} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ``DEVice`` sets the Address Mode to Device. This is the default value. + - ``LOGical`` sets the Address Mode to Logical. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusEspiVirtualwireResponse(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command tree. +# pylint: disable=too-many-instance-attributes,too-many-public-methods +class SearchSearchItemTriggerABusEthercat(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` + - ``.addressmode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. + - ``.cntnv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. + - ``.commandtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. + - ``.cyc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. + - ``.datagram``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. + - ``.datagramheader``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. + - ``.destinationaddress``: The + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. + - ``.deviceaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. + - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. + - ``.hash``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. + - ``.identification``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` + command tree. + - ``.idx``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. + - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. + - ``.ipdestination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command + tree. + - ``.ipsource``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. + - ``.irq``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. + - ``.len``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. + - ``.logicaladdress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` + command tree. + - ``.mailboxtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. + - ``.mailbox``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. + - ``.networkvariable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` + command tree. + - ``.network``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. + - ``.position``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. + - ``.protocoltype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. + - ``.pubid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. + - ``.quality``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. + - ``.service``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. + - ``.sourceaddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command + tree. + - ``.src``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. + - ``.tci``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. + - ``.wkc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiVirtualwireResponseValue( - device, f"{self._cmd_syntax}:VALue" + self._addressmode = SearchSearchItemTriggerABusEthercatAddressmode( + device, f"{self._cmd_syntax}:ADDRESSMODe" + ) + self._cntnv = SearchSearchItemTriggerABusEthercatCntnv(device, f"{self._cmd_syntax}:CNTNV") + self._commandtype = SearchSearchItemTriggerABusEthercatCommandtype( + device, f"{self._cmd_syntax}:COMMANDTYPe" + ) + self._condition = SearchSearchItemTriggerABusEthercatCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._cyc = SearchSearchItemTriggerABusEthercatCyc(device, f"{self._cmd_syntax}:CYC") + self._datagram = SearchSearchItemTriggerABusEthercatDatagram( + device, f"{self._cmd_syntax}:DATAGRAM" + ) + self._datagramheader = SearchSearchItemTriggerABusEthercatDatagramheader( + device, f"{self._cmd_syntax}:DATAGRAMHEADer" + ) + self._data = SearchSearchItemTriggerABusEthercatData(device, f"{self._cmd_syntax}:DATa") + self._destinationaddress = SearchSearchItemTriggerABusEthercatDestinationaddress( + device, f"{self._cmd_syntax}:DESTINATIONADDRess" ) + self._deviceaddress = SearchSearchItemTriggerABusEthercatDeviceaddress( + device, f"{self._cmd_syntax}:DEVICEADDRess" + ) + self._error = SearchSearchItemTriggerABusEthercatError(device, f"{self._cmd_syntax}:ERRor") + self._frametype = SearchSearchItemTriggerABusEthercatFrametype( + device, f"{self._cmd_syntax}:FRAMETYPe" + ) + self._hash = SearchSearchItemTriggerABusEthercatHash(device, f"{self._cmd_syntax}:HASH") + self._header = SearchSearchItemTriggerABusEthercatHeader( + device, f"{self._cmd_syntax}:HEADer" + ) + self._identification = SearchSearchItemTriggerABusEthercatIdentification( + device, f"{self._cmd_syntax}:IDENtification" + ) + self._idx = SearchSearchItemTriggerABusEthercatIdx(device, f"{self._cmd_syntax}:IDX") + self._index = SearchSearchItemTriggerABusEthercatIndex(device, f"{self._cmd_syntax}:INDex") + self._ipdestination = SearchSearchItemTriggerABusEthercatIpdestination( + device, f"{self._cmd_syntax}:IPDESTination" + ) + self._ipsource = SearchSearchItemTriggerABusEthercatIpsource( + device, f"{self._cmd_syntax}:IPSOURce" + ) + self._irq = SearchSearchItemTriggerABusEthercatIrq(device, f"{self._cmd_syntax}:IRQ") + self._len = SearchSearchItemTriggerABusEthercatLen(device, f"{self._cmd_syntax}:LEN") + self._logicaladdress = SearchSearchItemTriggerABusEthercatLogicaladdress( + device, f"{self._cmd_syntax}:LOGICALADDRess" + ) + self._mailboxtype = SearchSearchItemTriggerABusEthercatMailboxtype( + device, f"{self._cmd_syntax}:MAILBOXTYPe" + ) + self._mailbox = SearchSearchItemTriggerABusEthercatMailbox( + device, f"{self._cmd_syntax}:MAILbox" + ) + self._networkvariable = SearchSearchItemTriggerABusEthercatNetworkvariable( + device, f"{self._cmd_syntax}:NETWORKVARiable" + ) + self._network = SearchSearchItemTriggerABusEthercatNetwork( + device, f"{self._cmd_syntax}:NETWork" + ) + self._offset = SearchSearchItemTriggerABusEthercatOffset( + device, f"{self._cmd_syntax}:OFFSet" + ) + self._position = SearchSearchItemTriggerABusEthercatPosition( + device, f"{self._cmd_syntax}:POSition" + ) + self._protocoltype = SearchSearchItemTriggerABusEthercatProtocoltype( + device, f"{self._cmd_syntax}:PROTOCOLTYPe" + ) + self._pubid = SearchSearchItemTriggerABusEthercatPubid(device, f"{self._cmd_syntax}:PUBID") + self._quality = SearchSearchItemTriggerABusEthercatQuality( + device, f"{self._cmd_syntax}:QUALity" + ) + self._service = SearchSearchItemTriggerABusEthercatService( + device, f"{self._cmd_syntax}:SERVice" + ) + self._sourceaddress = SearchSearchItemTriggerABusEthercatSourceaddress( + device, f"{self._cmd_syntax}:SOURCEADDRess" + ) + self._src = SearchSearchItemTriggerABusEthercatSrc(device, f"{self._cmd_syntax}:SRC") + self._tci = SearchSearchItemTriggerABusEthercatTci(device, f"{self._cmd_syntax}:TCI") + self._wkc = SearchSearchItemTriggerABusEthercatWkc(device, f"{self._cmd_syntax}:WKC") @property - def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireResponseValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` command. + def addressmode(self) -> SearchSearchItemTriggerABusEthercatAddressmode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Response. The search number is specified by x. + - This command sets or queries the Address Mode in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe {DEVice|LOGical} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ADDRESSMODe? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ``DEVice`` sets the Address Mode to Device. This is the default value. + - ``LOGical`` sets the Address Mode to Logical. """ - return self._value + return self._addressmode + @property + def cntnv(self) -> SearchSearchItemTriggerABusEthercatCntnv: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV`` command tree. -class SearchSearchItemTriggerABusEspiVirtualwireIndexValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Index. The search number is specified by x. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CNTNV:VALue`` command. + """ + return self._cntnv - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue value`` command. + @property + def commandtype(self) -> SearchSearchItemTriggerABusEthercatCommandtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe`` command. - **SCPI Syntax:** + **Description:** + - This command sets or queries the Command Type in EtherCAT bus. The search number is + specified by x. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe value`` command. - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue? + **SCPI Syntax:** - **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ + :: - _WRAP_ARG_WITH_QUOTES = True + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe {NOP| APRD| APWR| APRW| FPRD| FPWR| FPRW| BRD| BWR| BRW| LRD| LWR| LRW| ARMW| FRMW| REServed} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:COMMANDTYPe? + **Info:** + - ``NOP`` specifies the Command Type and sets it to NOP. This is the default value. + - ``APRD`` specifies the Command Type and sets it to APRD. + - ``APWR`` specifies the Command Type and sets it to APWR. + - ``APRW`` specifies the Command Type and sets it to APRW. + - ``FPRD`` specifies the Command Type and sets it to FPRD. + - ``FPWR`` specifies the Command Type and sets it to FPWR. + - ``FPRW`` specifies the Command Type and sets it to FPRW. + - ``BRD`` specifies the Command Type and sets it to BRD. + - ``BWR`` specifies the Command Type and sets it to BWR. + - ``BRW`` specifies the Command Type and sets it to BRW. + - ``LRD`` specifies the Command Type and sets it to LRD. + - ``LWR`` specifies the Command Type and sets it to LWR. + - ``LRW`` specifies the Command Type and sets it to LRW. + - ``ARMW`` specifies the Command Type and sets it to ARMW. + - ``FRMW`` specifies the Command Type and sets it to FRMW. + - ``REServed`` specifies the Command Type and sets it to REServed. + """ # noqa: E501 + return self._commandtype -class SearchSearchItemTriggerABusEspiVirtualwireIndex(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. + @property + def condition(self) -> SearchSearchItemTriggerABusEthercatCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition`` command. + + **Description:** + - This command sets or queries the trigger condition for a EtherCAT bus. The search + number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition {SOF| PROTocol| IPHEADer| UDPIPHEADer| MACADDRess| TCI| ECATHEADERLENGth| DATagram| NETWORKVARiable| MAILBOX| FCSERRor| EOF} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CONDition? + + **Info:** + - ``SOF`` specifies the field within a EtherCAT frame to search on as SOF. This is the + default value. + - ``PROTocol`` specifies the field within a EtherCAT frame to search on as PROTocol. + - ``IPHEADer`` specifies the field within a EtherCAT frame to search on as IPHEADer. + - ``UDPIPHEADer`` specifies the field within a EtherCAT frame to search on as + UDPIPHEADer. + - ``MACADDRess`` specifies the field within a EtherCAT frame to search on as MACADDRess. + - ``TCI`` specifies the field within a EtherCAT frame to search on as TCI. + - ``ECATHEADERLENGth`` specifies the field within a EtherCAT frame to search on as + ECATHEADERLENGth. + - ``DATagram`` specifies the field within a EtherCAT frame to search on as DATagram. + - ``NETWORKVARiable`` specifies the field within a EtherCAT frame to search on as + NETWORKVARiable. + - ``MAILBOX`` specifies the field within a EtherCAT frame to search on as MAILBOX. + - ``FCSERRor`` specifies the field within a EtherCAT frame to search on as FCSERRor. + - ``EOF`` specifies the field within a EtherCAT frame to search on as EOF. + """ # noqa: E501 + return self._condition - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query and raise an - AssertionError if the returned value does not match ``value``. + @property + def cyc(self) -> SearchSearchItemTriggerABusEthercatCyc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiVirtualwireIndexValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:CYC:VALue`` command. + """ + return self._cyc @property - def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireIndexValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. + def datagram(self) -> SearchSearchItemTriggerABusEthercatDatagram: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Index. The search number is specified by x. + - This command sets or queries the Datagram fields in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM {HEADer|DATa|WKC} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAM? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ``HEADer`` specifies the Datagram field and sets it to Header. This is the default + value. + - ``DATa`` specifies the Datagram field and sets it to Data. + - ``WKC`` specifies the Datagram field and sets it to WKC. """ - return self._value + return self._datagram + @property + def datagramheader(self) -> SearchSearchItemTriggerABusEthercatDatagramheader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer`` command. -class SearchSearchItemTriggerABusEspiVirtualwireDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. + **Description:** + - This command sets or queries the Datagram Header fields in EtherCAT bus. The search + number is specified by x. - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Data. The search number is specified by x. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer {CMD|IDX|ADDRess|LEN|CIRCulating|IRQ} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer? - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue? + **Info:** + - ``CMD`` specifies the Datagram Header field as CMD. This is the default value. + - ``IDX`` specifies the Datagram Header field as IDX. + - ``ADDRess`` specifies the Datagram Header field as ADDRess. + - ``LEN`` specifies the Datagram Header field as LEN. + - ``CIRCulating`` specifies the Datagram Header field as CIRCulating. + - ``IRQ`` specifies the Datagram Header field as IRQ. - **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ + Sub-properties: + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATAGRAMHEADer:LENGth`` + command. + """ # noqa: E501 + return self._datagramheader - _WRAP_ARG_WITH_QUOTES = True + @property + def data(self) -> SearchSearchItemTriggerABusEthercatData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusEspiVirtualwireData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DATa:VALue`` command. + """ + return self._data - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query and raise an - AssertionError if the returned value does not match ``value``. + @property + def destinationaddress(self) -> SearchSearchItemTriggerABusEthercatDestinationaddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiVirtualwireDataValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DESTINATIONADDRess:VALue`` + command. + """ + return self._destinationaddress @property - def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. + def deviceaddress(self) -> SearchSearchItemTriggerABusEthercatDeviceaddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire Data. The search number is specified by x. + - This command sets or queries the Device Address in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess {POSition|OFFSet} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:DEVICEADDRess? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ``POSition`` specifies the Device Address to position. This is the default value. + - ``OFFSet`` specifies the Device Address to offset. """ - return self._value - - -class SearchSearchItemTriggerABusEspiVirtualwireCountValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire count. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue? - - **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEspiVirtualwireCount(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. + return self._deviceaddress - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query and raise an - AssertionError if the returned value does not match ``value``. + @property + def error(self) -> SearchSearchItemTriggerABusEthercatError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor?`` query and raise an AssertionError + if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiVirtualwireCountValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.reply``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:ERRor:REPLy`` command tree. + """ + return self._error @property - def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireCountValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. + def frametype(self) -> SearchSearchItemTriggerABusEthercatFrametype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Virtual wire count. The search number is specified by x. + - This command sets or queries the Frame Type in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe {BASic|UDPIP} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:FRAMETYPe? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ``BASic`` specifies the Frame Type as BASic. This is the default value. + - ``UDPIP`` specifies the Frame Type as UDPIP. """ - return self._value + return self._frametype + @property + def hash(self) -> SearchSearchItemTriggerABusEthercatHash: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH`` command tree. -class SearchSearchItemTriggerABusEspiVirtualwire(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query and raise an AssertionError if - the returned value does not match ``value``. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HASH:VALue`` command. + """ + return self._hash - Properties: - - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. - - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. - - ``.response``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command - tree. - - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. - """ + @property + def header(self) -> SearchSearchItemTriggerABusEthercatHeader: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer`` command tree. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._count = SearchSearchItemTriggerABusEspiVirtualwireCount( - device, f"{self._cmd_syntax}:COUNt" - ) - self._data = SearchSearchItemTriggerABusEspiVirtualwireData( - device, f"{self._cmd_syntax}:DATa" - ) - self._index = SearchSearchItemTriggerABusEspiVirtualwireIndex( - device, f"{self._cmd_syntax}:INDex" - ) - self._response = SearchSearchItemTriggerABusEspiVirtualwireResponse( - device, f"{self._cmd_syntax}:RESPonse" - ) - self._status = SearchSearchItemTriggerABusEspiVirtualwireStatus( - device, f"{self._cmd_syntax}:STATus" - ) + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer?`` query and raise an AssertionError + if the returned value does not match ``value``. + + Sub-properties: + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:HEADer:LENGth`` command. + """ + return self._header @property - def count(self) -> SearchSearchItemTriggerABusEspiVirtualwireCount: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. + def identification(self) -> SearchSearchItemTriggerABusEthercatIdentification: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDENtification:VALue`` command. """ - return self._count + return self._identification @property - def data(self) -> SearchSearchItemTriggerABusEspiVirtualwireData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. + def idx(self) -> SearchSearchItemTriggerABusEthercatIdx: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IDX:VALue`` command. """ - return self._data + return self._idx @property - def index(self) -> SearchSearchItemTriggerABusEspiVirtualwireIndex: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. + def index(self) -> SearchSearchItemTriggerABusEthercatIndex: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex?`` query and raise an AssertionError + if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:INDex:VALue`` command. """ return self._index @property - def response(self) -> SearchSearchItemTriggerABusEspiVirtualwireResponse: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command tree. + def ipdestination(self) -> SearchSearchItemTriggerABusEthercatIpdestination: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` - command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPDESTination:ADDRess`` + command tree. """ - return self._response + return self._ipdestination @property - def status(self) -> SearchSearchItemTriggerABusEspiVirtualwireStatus: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. + def ipsource(self) -> SearchSearchItemTriggerABusEthercatIpsource: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` - command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IPSOURce:ADDRess`` command + tree. """ - return self._status - - -class SearchSearchItemTriggerABusEspiTagValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Tag. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue? - - **Info:** - - ```` is the identifier value. The default value is XXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEspiTag(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiTagValue(device, f"{self._cmd_syntax}:VALue") + return self._ipsource @property - def value(self) -> SearchSearchItemTriggerABusEspiTagValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Tag. The search number is specified by x. + def irq(self) -> SearchSearchItemTriggerABusEthercatIrq: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue? + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default value is XXXX. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:IRQ:VALue`` command. """ - return self._value - - -class SearchSearchItemTriggerABusEspiSmbusSlaveAddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is SMBus Slave Address. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess? - - **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ + return self._irq - _WRAP_ARG_WITH_QUOTES = True + @property + def len(self) -> SearchSearchItemTriggerABusEthercatLen: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusEspiSmbusSlave(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LEN:VALue`` command. + """ + return self._len - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def logicaladdress(self) -> SearchSearchItemTriggerABusEthercatLogicaladdress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess`` command tree. - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEspiSmbusSlaveAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:LOGICALADDRess:VALue`` + command. + """ + return self._logicaladdress @property - def address(self) -> SearchSearchItemTriggerABusEspiSmbusSlaveAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. + def mailboxtype(self) -> SearchSearchItemTriggerABusEthercatMailboxtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is SMBus Slave Address. The search number is specified by x. + - This command sets or queries the Mailbox Type fields in EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe {ZERo| ONE| TWO| THRee| FOUR| FIVe| RESERved| FIFTeen} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILBOXTYPe? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ - return self._address - - -class SearchSearchItemTriggerABusEspiSmbusDestinationAddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is SMBus Source/Destination Address. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess? - - **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusEspiSmbusDestination(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` - command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEspiSmbusDestinationAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) + - ``ZERo`` specifies the Mailbox Type as ZERo. This is the default value. + - ``ONE`` specifies the Mailbox Type as ONE. + - ``TWO`` specifies the Mailbox Type as TWO. + - ``THRee`` specifies the Mailbox Type as THRee. + - ``FOUR`` specifies the Mailbox Type as FOUR. + - ``FIVe`` specifies the Mailbox Type as FIVe. + - ``RESERved`` specifies the Mailbox Type as RESERved. + - ``FIFTeen`` specifies the Mailbox Type as FIFTeen. + """ # noqa: E501 + return self._mailboxtype @property - def address(self) -> SearchSearchItemTriggerABusEspiSmbusDestinationAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` command. + def mailbox(self) -> SearchSearchItemTriggerABusEthercatMailbox: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox`` command. **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is SMBus Source/Destination Address. The search number is specified by x. + - This command sets or queries the Mailbox fields in EtherCAT bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox {MAILBOXHEADer|SERVICEDATa|ERRSERVICEDATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. - """ - return self._address - - -class SearchSearchItemTriggerABusEspiSmbus(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command - tree. - - ``.slave``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. - """ + - ``MAILBOXHEADer`` specifies the Mailbox fields as mailbox header. This is the default + value. + - ``SERVICEDATa`` specifies the Mailbox fields as service data. + - ``ERRSERVICEDATa`` specifies the Mailbox fields as error reply service data. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._destination = SearchSearchItemTriggerABusEspiSmbusDestination( - device, f"{self._cmd_syntax}:DESTination" - ) - self._slave = SearchSearchItemTriggerABusEspiSmbusSlave(device, f"{self._cmd_syntax}:SLAVe") + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:ADDRess`` command + tree. + - ``.cnt``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:CNT`` command tree. + - ``.detail``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:DETail`` command. + - ``.header``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:MAILbox:HEADer`` command. + """ # noqa: E501 + return self._mailbox @property - def destination(self) -> SearchSearchItemTriggerABusEspiSmbusDestination: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command tree. + def networkvariable(self) -> SearchSearchItemTriggerABusEthercatNetworkvariable: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` - command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWORKVARiable:DATa`` + command tree. """ - return self._destination + return self._networkvariable @property - def slave(self) -> SearchSearchItemTriggerABusEspiSmbusSlave: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. + def network(self) -> SearchSearchItemTriggerABusEthercatNetwork: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. + - ``.variable``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:NETWork:VARiable`` + command. """ - return self._slave - - -class SearchSearchItemTriggerABusEspiRespcycleType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. - - **Description:** - - This command sets or queries the response cycle type on command in ESPI bus. The search - number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe {MEMRDWR32| MEMRDWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| LTR| FLASHREAD| FLASHWRITe| FLASHERASe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe? + return self._network - **Info:** - - ``MEMRDWR32`` specifies Memory Read/Write 32 as the cycle type to search on. - - ``MEMRDWR64`` specifies Memory Read/Write 64 as the cycle type to search on. - - ``MESSage`` specifies message as the cycle type to search on. - - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. - - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. - - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. - - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. - - ``LTR`` specifies LTR as the cycle type to search on. - - ``FLASHREAD`` specifies flash read as the cycle type to search on. - - ``FLASHWRITe`` specifies flash write as the cycle type to search on. - - ``FLASHERASe`` specifies flash erase as the cycle type to search on. - """ # noqa: E501 + @property + def offset(self) -> SearchSearchItemTriggerABusEthercatOffset: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet?`` query and raise an AssertionError + if the returned value does not match ``value``. -class SearchSearchItemTriggerABusEspiRespcycle(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:OFFSet:VALue`` command. + """ + return self._offset - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def position(self) -> SearchSearchItemTriggerABusEthercatPosition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition`` command tree. - Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition?`` query and raise an + AssertionError if the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusEspiRespcycleType( - device, f"{self._cmd_syntax}:TYPe" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:POSition:VALue`` command. + """ + return self._position @property - def type(self) -> SearchSearchItemTriggerABusEspiRespcycleType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. + def protocoltype(self) -> SearchSearchItemTriggerABusEthercatProtocoltype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe`` command. **Description:** - - This command sets or queries the response cycle type on command in ESPI bus. The - search number is specified by x. + - This command sets or queries the EtherCAT Protocol Type in EtherCAT bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe {MEMRDWR32| MEMRDWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| LTR| FLASHREAD| FLASHWRITe| FLASHERASe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe {PDU|NETWORKVARiables|MAILbox} + - SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PROTOCOLTYPe? **Info:** - - ``MEMRDWR32`` specifies Memory Read/Write 32 as the cycle type to search on. - - ``MEMRDWR64`` specifies Memory Read/Write 64 as the cycle type to search on. - - ``MESSage`` specifies message as the cycle type to search on. - - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. - - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. - - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. - - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. - - ``LTR`` specifies LTR as the cycle type to search on. - - ``FLASHREAD`` specifies flash read as the cycle type to search on. - - ``FLASHWRITe`` specifies flash write as the cycle type to search on. - - ``FLASHERASe`` specifies flash erase as the cycle type to search on. - """ # noqa: E501 - return self._type - - -class SearchSearchItemTriggerABusEspiPhase(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. - - **Description:** - - This command sets or queries the phase in ESPI bus. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe {COMMand| RESPONSE| RESPONSEHEADer| RESPONSENOHEADer} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe? + - ``PDU`` specifies the Protocol Type as PDU. This is the default value. + - ``NETWORKVARiables`` specifies the Protocol Type as NETWORKVARiables. + - ``MAILbox`` specifies the Protocol Type as MAILbox. + """ + return self._protocoltype - **Info:** - - ``COMMand`` specifies command as the field/packet to search on. - - ``RESPONSE`` specifies response as the field/packet to search on. - - ``RESPONSEHEADer`` specifies the response header as the field/packet to search on. - - ``RESPONSENOHEADer`` specifies the response without header as the field/packet to search - on. - """ # noqa: E501 + @property + def pubid(self) -> SearchSearchItemTriggerABusEthercatPubid: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID?`` query and raise an AssertionError + if the returned value does not match ``value``. -class SearchSearchItemTriggerABusEspiLengthValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:PUBID:VALue`` command. + """ + return self._pubid - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Length. The search number is specified by x. + @property + def quality(self) -> SearchSearchItemTriggerABusEthercatQuality: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue value`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity?`` query and raise an AssertionError + if the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:QUALity:VALue`` command. + """ + return self._quality - :: + @property + def service(self) -> SearchSearchItemTriggerABusEthercatService: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default value is XXXXXXXXXXXX. - """ + Sub-properties: + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SERVice:DATa`` command tree. + """ + return self._service - _WRAP_ARG_WITH_QUOTES = True + @property + def sourceaddress(self) -> SearchSearchItemTriggerABusEthercatSourceaddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. -class SearchSearchItemTriggerABusEspiLength(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SOURCEADDRess:VALue`` + command. + """ + return self._sourceaddress - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query and raise an AssertionError if the - returned value does not match ``value``. + @property + def src(self) -> SearchSearchItemTriggerABusEthercatSrc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiLengthValue( - device, f"{self._cmd_syntax}:VALue" - ) + Sub-properties: + - ``.port``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:SRC:PORT`` command tree. + """ + return self._src @property - def value(self) -> SearchSearchItemTriggerABusEspiLengthValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. - - **Description:** - - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Length. The search number is specified by x. + def tci(self) -> SearchSearchItemTriggerABusEthercatTci: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:TCI:VALue`` command. + """ + return self._tci - :: + @property + def wkc(self) -> SearchSearchItemTriggerABusEthercatWkc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default value is XXXXXXXXXXXX. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ETHERCAT:WKC:VALue`` command. """ - return self._value + return self._wkc -class SearchSearchItemTriggerABusEspiErrorType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. +class SearchSearchItemTriggerABusEspiVirtualwireStatusValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. **Description:** - - This command sets or queries the error type on command or response in ESPI bus. The search - number is specified by x. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire Status. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe {CRC| DEFer| FATal| NONFATal| NORESPonse| CMDOPCODe| CYCLETYPe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue? **Info:** - - ``CRC`` specifies CRC as the error type to search on. - - ``DEFer`` specifies DEFer as the error type to search on. - - ``FATal`` specifies FATal as the error type to search on. - - ``NONFATal`` specifies NONFATal as the error type to search on. - - ``NORESPonse`` specifies NORESPonse as the error type to search on. - - ``CMDOPCODe`` specifies CMDOPCODe as the error type to search on. - - ``CYCLETYPe`` specifies CYCLETYPe as the error type to search on. - """ # noqa: E501 + - ```` is the identifier value. The default value is XXXXXXXXXXXXXXXX. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEspiError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. + +class SearchSearchItemTriggerABusEspiVirtualwireStatus(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusEspiErrorType(device, f"{self._cmd_syntax}:TYPe") + self._value = SearchSearchItemTriggerABusEspiVirtualwireStatusValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def type(self) -> SearchSearchItemTriggerABusEspiErrorType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. + def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireStatusValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` command. **Description:** - - This command sets or queries the error type on command or response in ESPI bus. The - search number is specified by x. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire Status. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe {CRC| DEFer| FATal| NONFATal| NORESPonse| CMDOPCODe| CYCLETYPe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue? **Info:** - - ``CRC`` specifies CRC as the error type to search on. - - ``DEFer`` specifies DEFer as the error type to search on. - - ``FATal`` specifies FATal as the error type to search on. - - ``NONFATal`` specifies NONFATal as the error type to search on. - - ``NORESPonse`` specifies NORESPonse as the error type to search on. - - ``CMDOPCODe`` specifies CMDOPCODe as the error type to search on. - - ``CYCLETYPe`` specifies CYCLETYPe as the error type to search on. - """ # noqa: E501 - return self._type + - ```` is the identifier value. The default value is XXXXXXXXXXXXXXXX. + """ + return self._value -class SearchSearchItemTriggerABusEspiDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. +class SearchSearchItemTriggerABusEspiVirtualwireResponseValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` command. **Description:** - This command specifies the binary data string used for ESPI triggering if the trigger - condition is DATA. The search number is specified by x. + condition is Virtual wire Response. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue? **Info:** - ```` is the identifier value. The default value is XXXXXXXX. @@ -42004,110 +42504,50 @@ class SearchSearchItemTriggerABusEspiDataValue(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEspiDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for ESPI - triggering if the trigger condition is DATA. The default data size is 1 byte and ranges - between 1 and 5. The search number is specified by x. +class SearchSearchItemTriggerABusEspiVirtualwireResponse(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe? - - **Info:** - - ```` specifies the data size. The default data size is 1 and the valid range is 1 to - 5. - """ - - -class SearchSearchItemTriggerABusEspiData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` - query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` + command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusEspiDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusEspiDataValue(device, f"{self._cmd_syntax}:VALue") - - @property - def size(self) -> SearchSearchItemTriggerABusEspiDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for ESPI - triggering if the trigger condition is DATA. The default data size is 1 byte and - ranges between 1 and 5. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe? - - **Info:** - - ```` specifies the data size. The default data size is 1 and the valid range is 1 - to 5. - """ - return self._size + self._value = SearchSearchItemTriggerABusEspiVirtualwireResponseValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusEspiDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireResponseValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` command. **Description:** - This command specifies the binary data string used for ESPI triggering if the trigger - condition is DATA. The search number is specified by x. + condition is Virtual wire Response. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue? **Info:** - ```` is the identifier value. The default value is XXXXXXXX. @@ -42115,233 +42555,108 @@ def value(self) -> SearchSearchItemTriggerABusEspiDataValue: return self._value -class SearchSearchItemTriggerABusEspiCycletype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. - - **Description:** - - This command sets or queries the cycle type on command in ESPI bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe {MEMRD32| MEMRD64| MEMWR32| MEMWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| OOBSMBUS| MCTP| FLASHREAD| FLASHWRITe| FLASHERASe| FLSUCCESSNODATa| FLSUCCESSDATa| FLUNSUCCESSNODATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe? - - **Info:** - - ``MEMRD32`` specifies Memory Read 32 as the cycle type to search on. - - ``MEMRD64`` specifies Memory Read 64 as the cycle type to search on. - - ``MEMWR32`` specifies Memory Read Write 32 as the cycle type to search on. - - ``MEMWR64`` specifies Memory Read Write 64 as the cycle type to search on. - - ``MESSage`` specifies MESSage as the cycle type to search on. - - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. - - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. - - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. - - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. - - ``OOBSMBUS`` specifies OOB SMBus as the cycle type to search on. - - ``MCTP`` specifies MCTP as the cycle type to search on. - - ``FLASHREAD`` specifies FLASHREAD as the cycle type to search on. - - ``FLASHWRITe`` specifies FLASHWRITe as the cycle type to search on. - - ``FLASHERASe`` specifies FLASHERASe as the cycle type to search on. - - ``FLSUCCESSNODATa`` specifies flash success without data as the cycle type to search on. - - ``FLSUCCESSDATa`` specifies flash Success with data as the cycle type to search on. - - ``FLUNSUCCESSNODATa`` specifies flash unsuccess without data as the cycle type to search - on. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusEspiCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. +class SearchSearchItemTriggerABusEspiVirtualwireIndexValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. **Description:** - - This command sets or queries the trigger condition for a ESPI bus. The search number is - specified by x. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire Index. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition {STARt| CHINDependent| PERICHANnel| OOBCHANnel| VWCHANnel| FACHANnel| DATa| STATus| ERRors| WAIT| END} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue? **Info:** - - ``STARt`` specifies STARt as the event for ESPI frame to search on. - - ``CHINDependent`` specifies CHINDependent channel for ESPI protocol to search on. - - ``PERICHANnel`` specifies peripheral channel for ESPI protocol to search on. - - ``OOBCHANnel`` specifies OOBCHANnel channel for ESPI protocol to search on. - - ``VWCHANnel`` specifies virtual wire channel for ESPI protocol to search on. - - ``FACHANnel`` specifies flash channel for ESPI protocol to search on. - - ``DATa`` specifies DATa as the field within a ESPI frame to search on. - - ``STATus`` specifies STATus as the field within a ESPI frame to search on. - - ``ERRors`` specifies ERRors as the type of error ESPI frame to search on. - - ``WAIT`` specifies WAIT as the field within a ESPI frame to search on. - - ``END`` specifies END as the event for a ESPI frame to search on. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusEspiCommandOpcode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. - - **Description:** - - This command sets or queries the command opcode in ESPI bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode {GETSTATus| GETCONFig| SETCONFig| GETNP| GETPC| PUTNP| PUTPC| PUTIORDSHORt| PUTIOWRSHORt| PUTMEMRD32SHORt| PUTMEMWR32SHORt| PUTOOB| GETOOB| PUTFLASHC| GETFLASHNP| PUTVWIRe| GETVWIRe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode? + - ```` is the identifier value. The default value is XXXXXXXX. + """ - **Info:** - - ``GETSTATus`` specifies get status as the command opcode in ESPI bus to search on. - - ``GETCONFig`` specifies get configuration as the command opcode in ESPI bus to search on. - - ``SETCONFig`` specifies set configuration as the command opcode in ESPI bus to search on. - - ``GETNP`` specifies GETNP as the command opcode in ESPI bus to search on. - - ``GETPC`` specifies GETPC as the command opcode in ESPI bus to search on. - - ``PUTNP`` specifies PUTNP as the command opcode in ESPI bus to search on. - - ``PUTPC`` specifies PUTPC as the command opcode in ESPI bus to search on. - - ``PUTIORDSHORt`` specifies put IO read short as the command opcode in ESPI bus to search - on. - - ``PUTIOWRSHORt`` specifies put IO write short as the command opcode in ESPI bus to search - on. - - ``PUTMEMRD32SHORt`` specifies put memory read 32 short as the command opcode in ESPI bus - to search on. - - ``PUTMEMWR32SHORt`` specifies put memory write 32 short as the command opcode in ESPI bus - to search on. - - ``PUTOOB`` specifies PUTOOB as the command opcode in ESPI bus to search on. - - ``GETOOB`` specifies GETOOB as the command opcode in ESPI bus to search on. - - ``PUTFLASHC`` specifies PUTFLASHC as the command opcode in ESPI bus to search on. - - ``GETFLASHNP`` specifies GETFLASHNP as the command opcode in ESPI bus to search on. - - ``PUTVWIRe`` specifies put virtual wire as the command opcode in ESPI bus to search on. - - ``GETVWIRe`` specifies get virtual wire as the command opcode in ESPI bus to search on. - """ # noqa: E501 + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEspiCommand(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. +class SearchSearchItemTriggerABusEspiVirtualwireIndex(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._opcode = SearchSearchItemTriggerABusEspiCommandOpcode( - device, f"{self._cmd_syntax}:OPCode" + self._value = SearchSearchItemTriggerABusEspiVirtualwireIndexValue( + device, f"{self._cmd_syntax}:VALue" ) @property - def opcode(self) -> SearchSearchItemTriggerABusEspiCommandOpcode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. + def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireIndexValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` command. **Description:** - - This command sets or queries the command opcode in ESPI bus. The search number is - specified by x. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire Index. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode {GETSTATus| GETCONFig| SETCONFig| GETNP| GETPC| PUTNP| PUTPC| PUTIORDSHORt| PUTIOWRSHORt| PUTMEMRD32SHORt| PUTMEMWR32SHORt| PUTOOB| GETOOB| PUTFLASHC| GETFLASHNP| PUTVWIRe| GETVWIRe} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue? **Info:** - - ``GETSTATus`` specifies get status as the command opcode in ESPI bus to search on. - - ``GETCONFig`` specifies get configuration as the command opcode in ESPI bus to search - on. - - ``SETCONFig`` specifies set configuration as the command opcode in ESPI bus to search - on. - - ``GETNP`` specifies GETNP as the command opcode in ESPI bus to search on. - - ``GETPC`` specifies GETPC as the command opcode in ESPI bus to search on. - - ``PUTNP`` specifies PUTNP as the command opcode in ESPI bus to search on. - - ``PUTPC`` specifies PUTPC as the command opcode in ESPI bus to search on. - - ``PUTIORDSHORt`` specifies put IO read short as the command opcode in ESPI bus to - search on. - - ``PUTIOWRSHORt`` specifies put IO write short as the command opcode in ESPI bus to - search on. - - ``PUTMEMRD32SHORt`` specifies put memory read 32 short as the command opcode in ESPI - bus to search on. - - ``PUTMEMWR32SHORt`` specifies put memory write 32 short as the command opcode in ESPI - bus to search on. - - ``PUTOOB`` specifies PUTOOB as the command opcode in ESPI bus to search on. - - ``GETOOB`` specifies GETOOB as the command opcode in ESPI bus to search on. - - ``PUTFLASHC`` specifies PUTFLASHC as the command opcode in ESPI bus to search on. - - ``GETFLASHNP`` specifies GETFLASHNP as the command opcode in ESPI bus to search on. - - ``PUTVWIRe`` specifies put virtual wire as the command opcode in ESPI bus to search - on. - - ``GETVWIRe`` specifies get virtual wire as the command opcode in ESPI bus to search - on. - """ # noqa: E501 - return self._opcode + - ```` is the identifier value. The default value is XXXXXXXX. + """ + return self._value -class SearchSearchItemTriggerABusEspiAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusEspiVirtualwireDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. **Description:** - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Address. The search number is specified by x. + condition is Virtual wire Data. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue? **Info:** - ```` is the identifier value. The default value is XXXXXXXX. @@ -42350,49 +42665,49 @@ class SearchSearchItemTriggerABusEspiAddressValue(SCPICmdWrite, SCPICmdRead): _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusEspiAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. +class SearchSearchItemTriggerABusEspiVirtualwireData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query and raise an + AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusEspiAddressValue( + self._value = SearchSearchItemTriggerABusEspiVirtualwireDataValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusEspiAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` command. **Description:** - This command specifies the binary data string used for ESPI triggering if the trigger - condition is Address. The search number is specified by x. + condition is Virtual wire Data. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue? **Info:** - ```` is the identifier value. The default value is XXXXXXXX. @@ -42400,7936 +42715,7526 @@ def value(self) -> SearchSearchItemTriggerABusEspiAddressValue: return self._value -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusEspi(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI?`` - query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. - - ``.cycletype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. - - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. - - ``.phase``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. - - ``.respcycle``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. - - ``.smbus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. - - ``.tag``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. - - ``.virtualwire``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusEspiAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) - self._command = SearchSearchItemTriggerABusEspiCommand( - device, f"{self._cmd_syntax}:COMMAND" - ) - self._condition = SearchSearchItemTriggerABusEspiCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._cycletype = SearchSearchItemTriggerABusEspiCycletype( - device, f"{self._cmd_syntax}:CYCLETYPe" - ) - self._data = SearchSearchItemTriggerABusEspiData(device, f"{self._cmd_syntax}:DATa") - self._error = SearchSearchItemTriggerABusEspiError(device, f"{self._cmd_syntax}:ERRor") - self._length = SearchSearchItemTriggerABusEspiLength(device, f"{self._cmd_syntax}:LENGth") - self._phase = SearchSearchItemTriggerABusEspiPhase(device, f"{self._cmd_syntax}:PHASe") - self._respcycle = SearchSearchItemTriggerABusEspiRespcycle( - device, f"{self._cmd_syntax}:RESPCYCLE" - ) - self._smbus = SearchSearchItemTriggerABusEspiSmbus(device, f"{self._cmd_syntax}:SMBUS") - self._tag = SearchSearchItemTriggerABusEspiTag(device, f"{self._cmd_syntax}:TAG") - self._virtualwire = SearchSearchItemTriggerABusEspiVirtualwire( - device, f"{self._cmd_syntax}:VIRTUALWIRe" - ) - - @property - def address(self) -> SearchSearchItemTriggerABusEspiAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. +class SearchSearchItemTriggerABusEspiVirtualwireCountValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Description:** + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire count. The search number is specified by x. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. - """ - return self._address + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue value`` command. - @property - def command(self) -> SearchSearchItemTriggerABusEspiCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query and raise an AssertionError if - the returned value does not match ``value``. + :: - Sub-properties: - - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. - """ - return self._command + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue? - @property - def condition(self) -> SearchSearchItemTriggerABusEspiCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. + **Info:** + - ```` is the identifier value. The default value is XXXXXXXX. + """ - **Description:** - - This command sets or queries the trigger condition for a ESPI bus. The search number - is specified by x. + _WRAP_ARG_WITH_QUOTES = True - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition value`` command. - **SCPI Syntax:** +class SearchSearchItemTriggerABusEspiVirtualwireCount(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query and raise an + AssertionError if the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition {STARt| CHINDependent| PERICHANnel| OOBCHANnel| VWCHANnel| FACHANnel| DATa| STATus| ERRors| WAIT| END} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition? + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. + """ - **Info:** - - ``STARt`` specifies STARt as the event for ESPI frame to search on. - - ``CHINDependent`` specifies CHINDependent channel for ESPI protocol to search on. - - ``PERICHANnel`` specifies peripheral channel for ESPI protocol to search on. - - ``OOBCHANnel`` specifies OOBCHANnel channel for ESPI protocol to search on. - - ``VWCHANnel`` specifies virtual wire channel for ESPI protocol to search on. - - ``FACHANnel`` specifies flash channel for ESPI protocol to search on. - - ``DATa`` specifies DATa as the field within a ESPI frame to search on. - - ``STATus`` specifies STATus as the field within a ESPI frame to search on. - - ``ERRors`` specifies ERRors as the type of error ESPI frame to search on. - - ``WAIT`` specifies WAIT as the field within a ESPI frame to search on. - - ``END`` specifies END as the event for a ESPI frame to search on. - """ # noqa: E501 - return self._condition + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEspiVirtualwireCountValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def cycletype(self) -> SearchSearchItemTriggerABusEspiCycletype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. + def value(self) -> SearchSearchItemTriggerABusEspiVirtualwireCountValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` command. **Description:** - - This command sets or queries the cycle type on command in ESPI bus. The search number - is specified by x. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Virtual wire count. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe {MEMRD32| MEMRD64| MEMWR32| MEMWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| OOBSMBUS| MCTP| FLASHREAD| FLASHWRITe| FLASHERASe| FLSUCCESSNODATa| FLSUCCESSDATa| FLUNSUCCESSNODATa} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue? **Info:** - - ``MEMRD32`` specifies Memory Read 32 as the cycle type to search on. - - ``MEMRD64`` specifies Memory Read 64 as the cycle type to search on. - - ``MEMWR32`` specifies Memory Read Write 32 as the cycle type to search on. - - ``MEMWR64`` specifies Memory Read Write 64 as the cycle type to search on. - - ``MESSage`` specifies MESSage as the cycle type to search on. - - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. - - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. - - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. - - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. - - ``OOBSMBUS`` specifies OOB SMBus as the cycle type to search on. - - ``MCTP`` specifies MCTP as the cycle type to search on. - - ``FLASHREAD`` specifies FLASHREAD as the cycle type to search on. - - ``FLASHWRITe`` specifies FLASHWRITe as the cycle type to search on. - - ``FLASHERASe`` specifies FLASHERASe as the cycle type to search on. - - ``FLSUCCESSNODATa`` specifies flash success without data as the cycle type to search - on. - - ``FLSUCCESSDATa`` specifies flash Success with data as the cycle type to search on. - - ``FLUNSUCCESSNODATa`` specifies flash unsuccess without data as the cycle type to - search on. - """ # noqa: E501 - return self._cycletype - - @property - def data(self) -> SearchSearchItemTriggerABusEspiData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. + - ```` is the identifier value. The default value is XXXXXXXX. + """ + return self._value - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. - """ - return self._data +class SearchSearchItemTriggerABusEspiVirtualwire(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. - @property - def error(self) -> SearchSearchItemTriggerABusEspiError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query and raise an AssertionError if - the returned value does not match ``value``. + Properties: + - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. + - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. + - ``.response``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command + tree. + - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. + """ - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. - """ - return self._error + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._count = SearchSearchItemTriggerABusEspiVirtualwireCount( + device, f"{self._cmd_syntax}:COUNt" + ) + self._data = SearchSearchItemTriggerABusEspiVirtualwireData( + device, f"{self._cmd_syntax}:DATa" + ) + self._index = SearchSearchItemTriggerABusEspiVirtualwireIndex( + device, f"{self._cmd_syntax}:INDex" + ) + self._response = SearchSearchItemTriggerABusEspiVirtualwireResponse( + device, f"{self._cmd_syntax}:RESPonse" + ) + self._status = SearchSearchItemTriggerABusEspiVirtualwireStatus( + device, f"{self._cmd_syntax}:STATus" + ) @property - def length(self) -> SearchSearchItemTriggerABusEspiLength: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. + def count(self) -> SearchSearchItemTriggerABusEspiVirtualwireCount: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt:VALue`` + command. """ - return self._length - - @property - def phase(self) -> SearchSearchItemTriggerABusEspiPhase: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. - - **Description:** - - This command sets or queries the phase in ESPI bus. The search number is specified by - x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe {COMMand| RESPONSE| RESPONSEHEADer| RESPONSENOHEADer} - - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe? - - **Info:** - - ``COMMand`` specifies command as the field/packet to search on. - - ``RESPONSE`` specifies response as the field/packet to search on. - - ``RESPONSEHEADer`` specifies the response header as the field/packet to search on. - - ``RESPONSENOHEADer`` specifies the response without header as the field/packet to - search on. - """ # noqa: E501 - return self._phase + return self._count @property - def respcycle(self) -> SearchSearchItemTriggerABusEspiRespcycle: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. + def data(self) -> SearchSearchItemTriggerABusEspiVirtualwireData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa:VALue`` + command. """ - return self._respcycle + return self._data @property - def smbus(self) -> SearchSearchItemTriggerABusEspiSmbus: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. + def index(self) -> SearchSearchItemTriggerABusEspiVirtualwireIndex: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` - command tree. - - ``.slave``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex:VALue`` + command. """ - return self._smbus + return self._index @property - def tag(self) -> SearchSearchItemTriggerABusEspiTag: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. + def response(self) -> SearchSearchItemTriggerABusEspiVirtualwireResponse: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse:VALue`` + command. """ - return self._tag + return self._response @property - def virtualwire(self) -> SearchSearchItemTriggerABusEspiVirtualwire: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. + def status(self) -> SearchSearchItemTriggerABusEspiVirtualwireStatus: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus?`` query and raise an + AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command - tree. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. - - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command - tree. - - ``.response``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` - command tree. - - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command - tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus:VALue`` + command. """ - return self._virtualwire + return self._status -class SearchSearchItemTriggerABusDphyYuvY(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. +class SearchSearchItemTriggerABusEspiTagValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. **Description:** - - This command specifies the Y data string used for DPHY triggering if the trigger condition - is on YUV packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Tag. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue? **Info:** - - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyYuvV(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. - - **Description:** - - This command specifies the V data string used for DPHY triggering if the trigger condition - is on YUV packet. +class SearchSearchItemTriggerABusEspiTag(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V value`` command. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusEspiTagValue(device, f"{self._cmd_syntax}:VALue") - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V? + @property + def value(self) -> SearchSearchItemTriggerABusEspiTagValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. - **Info:** - - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. - """ + **Description:** + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Tag. The search number is specified by x. - _WRAP_ARG_WITH_QUOTES = True + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue value`` command. + **SCPI Syntax:** -class SearchSearchItemTriggerABusDphyYuvU(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue? + + **Info:** + - ```` is the identifier value. The default value is XXXX. + """ + return self._value + + +class SearchSearchItemTriggerABusEspiSmbusSlaveAddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. **Description:** - - This command specifies the U data string used for DPHY triggering if the trigger condition - is on YUV packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is SMBus Slave Address. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess? **Info:** - - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyYuv(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. +class SearchSearchItemTriggerABusEspiSmbusSlave(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. - - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._u = SearchSearchItemTriggerABusDphyYuvU(device, f"{self._cmd_syntax}:U") - self._v = SearchSearchItemTriggerABusDphyYuvV(device, f"{self._cmd_syntax}:V") - self._y = SearchSearchItemTriggerABusDphyYuvY(device, f"{self._cmd_syntax}:Y") + self._address = SearchSearchItemTriggerABusEspiSmbusSlaveAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) @property - def u(self) -> SearchSearchItemTriggerABusDphyYuvU: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. + def address(self) -> SearchSearchItemTriggerABusEspiSmbusSlaveAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. **Description:** - - This command specifies the U data string used for DPHY triggering if the trigger - condition is on YUV packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is SMBus Slave Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess? **Info:** - - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXX. """ - return self._u + return self._address + + +class SearchSearchItemTriggerABusEspiSmbusDestinationAddress(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` command. + + **Description:** + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is SMBus Source/Destination Address. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess? + + **Info:** + - ```` is the identifier value. The default value is XXXXXXXX. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusEspiSmbusDestination(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` + command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEspiSmbusDestinationAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) @property - def v(self) -> SearchSearchItemTriggerABusDphyYuvV: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. + def address(self) -> SearchSearchItemTriggerABusEspiSmbusDestinationAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` command. **Description:** - - This command specifies the V data string used for DPHY triggering if the trigger - condition is on YUV packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is SMBus Source/Destination Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess? **Info:** - - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXX. """ - return self._v + return self._address + + +class SearchSearchItemTriggerABusEspiSmbus(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command + tree. + - ``.slave``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._destination = SearchSearchItemTriggerABusEspiSmbusDestination( + device, f"{self._cmd_syntax}:DESTination" + ) + self._slave = SearchSearchItemTriggerABusEspiSmbusSlave(device, f"{self._cmd_syntax}:SLAVe") @property - def y(self) -> SearchSearchItemTriggerABusDphyYuvY: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. - - **Description:** - - This command specifies the Y data string used for DPHY triggering if the trigger - condition is on YUV packet. + def destination(self) -> SearchSearchItemTriggerABusEspiSmbusDestination: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination?`` query and raise an + AssertionError if the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination:ADDRess`` + command. + """ + return self._destination - :: + @property + def slave(self) -> SearchSearchItemTriggerABusEspiSmbusSlave: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. + Sub-properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe:ADDRess`` command. """ - return self._y + return self._slave -class SearchSearchItemTriggerABusDphyYcbcrY(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. +class SearchSearchItemTriggerABusEspiRespcycleType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. **Description:** - - This command specifies the Y data string used for DPHY triggering if the trigger condition - is on YCbCr packet. + - This command sets or queries the response cycle type on command in ESPI bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe {MEMRDWR32| MEMRDWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| LTR| FLASHREAD| FLASHWRITe| FLASHERASe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe? **Info:** - - ```` is the identifier value. The default YCBCR packets Y value is XXXXXXXXXX. + - ``MEMRDWR32`` specifies Memory Read/Write 32 as the cycle type to search on. + - ``MEMRDWR64`` specifies Memory Read/Write 64 as the cycle type to search on. + - ``MESSage`` specifies message as the cycle type to search on. + - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. + - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. + - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. + - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. + - ``LTR`` specifies LTR as the cycle type to search on. + - ``FLASHREAD`` specifies flash read as the cycle type to search on. + - ``FLASHWRITe`` specifies flash write as the cycle type to search on. + - ``FLASHERASe`` specifies flash erase as the cycle type to search on. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusEspiRespcycle(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. """ - _WRAP_ARG_WITH_QUOTES = True + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._type = SearchSearchItemTriggerABusEspiRespcycleType( + device, f"{self._cmd_syntax}:TYPe" + ) + + @property + def type(self) -> SearchSearchItemTriggerABusEspiRespcycleType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. + **Description:** + - This command sets or queries the response cycle type on command in ESPI bus. The + search number is specified by x. -class SearchSearchItemTriggerABusDphyYcbcrCr(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe {MEMRDWR32| MEMRDWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| LTR| FLASHREAD| FLASHWRITe| FLASHERASe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe? + + **Info:** + - ``MEMRDWR32`` specifies Memory Read/Write 32 as the cycle type to search on. + - ``MEMRDWR64`` specifies Memory Read/Write 64 as the cycle type to search on. + - ``MESSage`` specifies message as the cycle type to search on. + - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. + - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. + - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. + - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. + - ``LTR`` specifies LTR as the cycle type to search on. + - ``FLASHREAD`` specifies flash read as the cycle type to search on. + - ``FLASHWRITe`` specifies flash write as the cycle type to search on. + - ``FLASHERASe`` specifies flash erase as the cycle type to search on. + """ # noqa: E501 + return self._type + + +class SearchSearchItemTriggerABusEspiPhase(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. **Description:** - - This command specifies the Cr data string used for DPHY triggering if the trigger - condition is on YCbCr packet. + - This command sets or queries the phase in ESPI bus. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe {COMMand| RESPONSE| RESPONSEHEADer| RESPONSENOHEADer} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe? **Info:** - - ```` is the identifier value. The default YCBCR packets CR value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``COMMand`` specifies command as the field/packet to search on. + - ``RESPONSE`` specifies response as the field/packet to search on. + - ``RESPONSEHEADer`` specifies the response header as the field/packet to search on. + - ``RESPONSENOHEADer`` specifies the response without header as the field/packet to search + on. + """ # noqa: E501 -class SearchSearchItemTriggerABusDphyYcbcrCb(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. +class SearchSearchItemTriggerABusEspiLengthValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. **Description:** - - This command specifies the Cb data string used for DPHY triggering if the trigger - condition is on YCbCr packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Length. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue? **Info:** - - ```` is the identifier value. The default YCBCR packets CB value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyYcbcr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. +class SearchSearchItemTriggerABusEspiLength(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. - - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._cb = SearchSearchItemTriggerABusDphyYcbcrCb(device, f"{self._cmd_syntax}:CB") - self._cr = SearchSearchItemTriggerABusDphyYcbcrCr(device, f"{self._cmd_syntax}:CR") - self._y = SearchSearchItemTriggerABusDphyYcbcrY(device, f"{self._cmd_syntax}:Y") - - @property - def cb(self) -> SearchSearchItemTriggerABusDphyYcbcrCb: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. - - **Description:** - - This command specifies the Cb data string used for DPHY triggering if the trigger - condition is on YCbCr packet. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB? - - **Info:** - - ```` is the identifier value. The default YCBCR packets CB value is - XXXXXXXXXX. - """ - return self._cb - - @property - def cr(self) -> SearchSearchItemTriggerABusDphyYcbcrCr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. - - **Description:** - - This command specifies the Cr data string used for DPHY triggering if the trigger - condition is on YCbCr packet. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR? - - **Info:** - - ```` is the identifier value. The default YCBCR packets CR value is - XXXXXXXXXX. - """ - return self._cr + self._value = SearchSearchItemTriggerABusEspiLengthValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def y(self) -> SearchSearchItemTriggerABusDphyYcbcrY: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. + def value(self) -> SearchSearchItemTriggerABusEspiLengthValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. **Description:** - - This command specifies the Y data string used for DPHY triggering if the trigger - condition is on YCbCr packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Length. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue? **Info:** - - ```` is the identifier value. The default YCBCR packets Y value is - XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXXXXXX. """ - return self._y + return self._value -class SearchSearchItemTriggerABusDphyWordcountValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. +class SearchSearchItemTriggerABusEspiErrorType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. **Description:** - - This command specifies the word count data string used for DPHY triggering if the trigger - condition is set on any pixel packet. + - This command sets or queries the error type on command or response in ESPI bus. The search + number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe {CRC| DEFer| FATal| NONFATal| NORESPonse| CMDOPCODe| CYCLETYPe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe? **Info:** - - ```` is the identifier value. The default word count value is XXXXXXXXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``CRC`` specifies CRC as the error type to search on. + - ``DEFer`` specifies DEFer as the error type to search on. + - ``FATal`` specifies FATal as the error type to search on. + - ``NONFATal`` specifies NONFATal as the error type to search on. + - ``NORESPonse`` specifies NORESPonse as the error type to search on. + - ``CMDOPCODe`` specifies CMDOPCODe as the error type to search on. + - ``CYCLETYPe`` specifies CYCLETYPe as the error type to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusDphyWordcount(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. +class SearchSearchItemTriggerABusEspiError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusDphyWordcountValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._type = SearchSearchItemTriggerABusEspiErrorType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusDphyWordcountValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusEspiErrorType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. **Description:** - - This command specifies the word count data string used for DPHY triggering if the - trigger condition is set on any pixel packet. + - This command sets or queries the error type on command or response in ESPI bus. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe {CRC| DEFer| FATal| NONFATal| NORESPonse| CMDOPCODe| CYCLETYPe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe? **Info:** - - ```` is the identifier value. The default word count value is - XXXXXXXXXXXXXXXX. - """ - return self._value + - ``CRC`` specifies CRC as the error type to search on. + - ``DEFer`` specifies DEFer as the error type to search on. + - ``FATal`` specifies FATal as the error type to search on. + - ``NONFATal`` specifies NONFATal as the error type to search on. + - ``NORESPonse`` specifies NORESPonse as the error type to search on. + - ``CMDOPCODe`` specifies CMDOPCODe as the error type to search on. + - ``CYCLETYPe`` specifies CYCLETYPe as the error type to search on. + """ # noqa: E501 + return self._type -class SearchSearchItemTriggerABusDphyRedValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. +class SearchSearchItemTriggerABusEspiDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. **Description:** - - This command specifies the red data string used for DPHY triggering if the trigger - condition is on RGB packet. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue? **Info:** - - ```` is the identifier value. The default red value is XXXXXXXXXX. + - ```` is the identifier value. The default value is XXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyRed(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. +class SearchSearchItemTriggerABusEspiDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. + + **Description:** + - This command specifies the length of the data string in bytes to be used for ESPI + triggering if the trigger condition is DATA. The default data size is 1 byte and ranges + between 1 and 5. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe? + + **Info:** + - ```` specifies the data size. The default data size is 1 and the valid range is 1 to + 5. + """ + + +class SearchSearchItemTriggerABusEspiData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusDphyRedValue(device, f"{self._cmd_syntax}:VALue") + self._size = SearchSearchItemTriggerABusEspiDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusEspiDataValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusDphyRedValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusEspiDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. **Description:** - - This command specifies the red data string used for DPHY triggering if the trigger - condition is on RGB packet. + - This command specifies the length of the data string in bytes to be used for ESPI + triggering if the trigger condition is DATA. The default data size is 1 byte and + ranges between 1 and 5. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe? + + **Info:** + - ```` specifies the data size. The default data size is 1 and the valid range is 1 + to 5. + """ + return self._size + + @property + def value(self) -> SearchSearchItemTriggerABusEspiDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. + + **Description:** + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is DATA. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue? + + **Info:** + - ```` is the identifier value. The default value is XXXXXXXX. + """ + return self._value + + +class SearchSearchItemTriggerABusEspiCycletype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. + + **Description:** + - This command sets or queries the cycle type on command in ESPI bus. The search number is + specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe value`` command. + + **SCPI Syntax:** + + :: - **Info:** - - ```` is the identifier value. The default red value is XXXXXXXXXX. - """ - return self._value + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe {MEMRD32| MEMRD64| MEMWR32| MEMWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| OOBSMBUS| MCTP| FLASHREAD| FLASHWRITe| FLASHERASe| FLSUCCESSNODATa| FLSUCCESSDATa| FLUNSUCCESSNODATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe? + + **Info:** + - ``MEMRD32`` specifies Memory Read 32 as the cycle type to search on. + - ``MEMRD64`` specifies Memory Read 64 as the cycle type to search on. + - ``MEMWR32`` specifies Memory Read Write 32 as the cycle type to search on. + - ``MEMWR64`` specifies Memory Read Write 64 as the cycle type to search on. + - ``MESSage`` specifies MESSage as the cycle type to search on. + - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. + - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. + - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. + - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. + - ``OOBSMBUS`` specifies OOB SMBus as the cycle type to search on. + - ``MCTP`` specifies MCTP as the cycle type to search on. + - ``FLASHREAD`` specifies FLASHREAD as the cycle type to search on. + - ``FLASHWRITe`` specifies FLASHWRITe as the cycle type to search on. + - ``FLASHERASe`` specifies FLASHERASe as the cycle type to search on. + - ``FLSUCCESSNODATa`` specifies flash success without data as the cycle type to search on. + - ``FLSUCCESSDATa`` specifies flash Success with data as the cycle type to search on. + - ``FLUNSUCCESSNODATa`` specifies flash unsuccess without data as the cycle type to search + on. + """ # noqa: E501 -class SearchSearchItemTriggerABusDphyPixelSearchoption(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. +class SearchSearchItemTriggerABusEspiCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. **Description:** - - This command sets or queries the search pattern type for DPHY bus. The default search - pattern type value is PIXELVALue. + - This command sets or queries the trigger condition for a ESPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition {STARt| CHINDependent| PERICHANnel| OOBCHANnel| VWCHANnel| FACHANnel| DATa| STATus| ERRors| WAIT| END} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition? **Info:** - - ``PIXELVALue`` specifies PIXELVALue as the field within a DPHY frame to search on. - - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a DPHY frame to search on. - """ + - ``STARt`` specifies STARt as the event for ESPI frame to search on. + - ``CHINDependent`` specifies CHINDependent channel for ESPI protocol to search on. + - ``PERICHANnel`` specifies peripheral channel for ESPI protocol to search on. + - ``OOBCHANnel`` specifies OOBCHANnel channel for ESPI protocol to search on. + - ``VWCHANnel`` specifies virtual wire channel for ESPI protocol to search on. + - ``FACHANnel`` specifies flash channel for ESPI protocol to search on. + - ``DATa`` specifies DATa as the field within a ESPI frame to search on. + - ``STATus`` specifies STATus as the field within a ESPI frame to search on. + - ``ERRors`` specifies ERRors as the type of error ESPI frame to search on. + - ``WAIT`` specifies WAIT as the field within a ESPI frame to search on. + - ``END`` specifies END as the event for a ESPI frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusDphyPixelNumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. +class SearchSearchItemTriggerABusEspiCommandOpcode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. **Description:** - - This command specifies the pixel number to be used for DPHY triggering if the trigger - condition is on pixel number pattern. The search number is specified by x. + - This command sets or queries the command opcode in ESPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode {GETSTATus| GETCONFig| SETCONFig| GETNP| GETPC| PUTNP| PUTPC| PUTIORDSHORt| PUTIOWRSHORt| PUTMEMRD32SHORt| PUTMEMWR32SHORt| PUTOOB| GETOOB| PUTFLASHC| GETFLASHNP| PUTVWIRe| GETVWIRe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode? **Info:** - - ```` specifies the pixel number. The default pixel number value is 0. - """ + - ``GETSTATus`` specifies get status as the command opcode in ESPI bus to search on. + - ``GETCONFig`` specifies get configuration as the command opcode in ESPI bus to search on. + - ``SETCONFig`` specifies set configuration as the command opcode in ESPI bus to search on. + - ``GETNP`` specifies GETNP as the command opcode in ESPI bus to search on. + - ``GETPC`` specifies GETPC as the command opcode in ESPI bus to search on. + - ``PUTNP`` specifies PUTNP as the command opcode in ESPI bus to search on. + - ``PUTPC`` specifies PUTPC as the command opcode in ESPI bus to search on. + - ``PUTIORDSHORt`` specifies put IO read short as the command opcode in ESPI bus to search + on. + - ``PUTIOWRSHORt`` specifies put IO write short as the command opcode in ESPI bus to search + on. + - ``PUTMEMRD32SHORt`` specifies put memory read 32 short as the command opcode in ESPI bus + to search on. + - ``PUTMEMWR32SHORt`` specifies put memory write 32 short as the command opcode in ESPI bus + to search on. + - ``PUTOOB`` specifies PUTOOB as the command opcode in ESPI bus to search on. + - ``GETOOB`` specifies GETOOB as the command opcode in ESPI bus to search on. + - ``PUTFLASHC`` specifies PUTFLASHC as the command opcode in ESPI bus to search on. + - ``GETFLASHNP`` specifies GETFLASHNP as the command opcode in ESPI bus to search on. + - ``PUTVWIRe`` specifies put virtual wire as the command opcode in ESPI bus to search on. + - ``GETVWIRe`` specifies get virtual wire as the command opcode in ESPI bus to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusDphyPixel(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. +class SearchSearchItemTriggerABusEspiCommand(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. - - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. + - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._number = SearchSearchItemTriggerABusDphyPixelNumber( - device, f"{self._cmd_syntax}:NUMBer" - ) - self._searchoption = SearchSearchItemTriggerABusDphyPixelSearchoption( - device, f"{self._cmd_syntax}:SEARCHOPTion" + self._opcode = SearchSearchItemTriggerABusEspiCommandOpcode( + device, f"{self._cmd_syntax}:OPCode" ) @property - def number(self) -> SearchSearchItemTriggerABusDphyPixelNumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. - - **Description:** - - This command specifies the pixel number to be used for DPHY triggering if the trigger - condition is on pixel number pattern. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer? - - **Info:** - - ```` specifies the pixel number. The default pixel number value is 0. - """ - return self._number - - @property - def searchoption(self) -> SearchSearchItemTriggerABusDphyPixelSearchoption: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. + def opcode(self) -> SearchSearchItemTriggerABusEspiCommandOpcode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. **Description:** - - This command sets or queries the search pattern type for DPHY bus. The default search - pattern type value is PIXELVALue. + - This command sets or queries the command opcode in ESPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode {GETSTATus| GETCONFig| SETCONFig| GETNP| GETPC| PUTNP| PUTPC| PUTIORDSHORt| PUTIOWRSHORt| PUTMEMRD32SHORt| PUTMEMWR32SHORt| PUTOOB| GETOOB| PUTFLASHC| GETFLASHNP| PUTVWIRe| GETVWIRe} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode? **Info:** - - ``PIXELVALue`` specifies PIXELVALue as the field within a DPHY frame to search on. - - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a DPHY frame to search on. - """ - return self._searchoption + - ``GETSTATus`` specifies get status as the command opcode in ESPI bus to search on. + - ``GETCONFig`` specifies get configuration as the command opcode in ESPI bus to search + on. + - ``SETCONFig`` specifies set configuration as the command opcode in ESPI bus to search + on. + - ``GETNP`` specifies GETNP as the command opcode in ESPI bus to search on. + - ``GETPC`` specifies GETPC as the command opcode in ESPI bus to search on. + - ``PUTNP`` specifies PUTNP as the command opcode in ESPI bus to search on. + - ``PUTPC`` specifies PUTPC as the command opcode in ESPI bus to search on. + - ``PUTIORDSHORt`` specifies put IO read short as the command opcode in ESPI bus to + search on. + - ``PUTIOWRSHORt`` specifies put IO write short as the command opcode in ESPI bus to + search on. + - ``PUTMEMRD32SHORt`` specifies put memory read 32 short as the command opcode in ESPI + bus to search on. + - ``PUTMEMWR32SHORt`` specifies put memory write 32 short as the command opcode in ESPI + bus to search on. + - ``PUTOOB`` specifies PUTOOB as the command opcode in ESPI bus to search on. + - ``GETOOB`` specifies GETOOB as the command opcode in ESPI bus to search on. + - ``PUTFLASHC`` specifies PUTFLASHC as the command opcode in ESPI bus to search on. + - ``GETFLASHNP`` specifies GETFLASHNP as the command opcode in ESPI bus to search on. + - ``PUTVWIRe`` specifies put virtual wire as the command opcode in ESPI bus to search + on. + - ``GETVWIRe`` specifies get virtual wire as the command opcode in ESPI bus to search + on. + """ # noqa: E501 + return self._opcode -class SearchSearchItemTriggerABusDphyPacketsType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. +class SearchSearchItemTriggerABusEspiAddressValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. **Description:** - - This command sets or queries the packet type for DPHY bus. The default packet type - condition is SHORt. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe {SHORt|LONG} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue? **Info:** - - ``SHORt`` specifies SHORt as the field within a DPHY frame to search on. SHORt is the - default packet type condition. - - ``LONG`` specifies LONG as the field within a DPHY frame to search on. + - ```` is the identifier value. The default value is XXXXXXXX. """ - -class SearchSearchItemTriggerABusDphyPacketsList(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. - - **Description:** - - This command sets or queries the packet list for DPHY bus. The default packet list - condition is VSYNCSTART. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST? - - **Info:** - - ``VSYNCSTART`` specifies VSYNCSTART as the packet within DPHY frame to search on. - - ``VSYNCEND`` specifies VSYNCEND as the packet within DPHY frame to search on. - - ``HSYNCSTART`` specifies HSYNCSTART as the packet within DPHY frame to search on. - - ``HSYNCEND`` specifies HSYNCEND as the packet within DPHY frame to search on. - - ``EOTP`` specifies EOTP as the packet within DPHY frame to search on. - - ``COLOROFF`` specifies COLOROFF as the packet within DPHY frame to search on. - - ``COLORON`` specifies COLORON as the packet within DPHY frame to search on. - - ``SHUTDOWN`` specifies SHUTDOWN as the packet within DPHY frame to search on. - - ``TURNON`` specifies TURNON as the packet within DPHY frame to search on. - - ``GSW`` specifies GSW as the packet within DPHY frame to search on. - - ``GR`` specifies GR as the packet within DPHY frame to search on. - - ``COMPRESSION`` specifies COMPRESSION as the packet within DPHY frame to search on. - - ``SCRAMBLING`` specifies SCRAMBLING as the packet within DPHY frame to search on. - - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within DPHY frame to search on. - - ``DCSSW`` specifies DCSSW as the packet within DPHY frame to search on. - - ``DCSR`` specifies DCSR as the packet within DPHY frame to search on. - - ``GLONGWRITE`` specifies GLONGWRITE as the packet within DPHY frame to search on. - - ``DSINULL`` specifies DSINULL as the packet within DPHY frame to search on. - - ``DSIBLANk`` specifies DSIBLANk as the packet within DPHY frame to search on. - - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within DPHY frame to search on. - - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within DPHY frame to search on. - - ``PICPARameter`` specifies PICPARameter as the packet within DPHY frame to search on. - - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within DPHY frame to - search on. - - ``PPS101010`` specifies PPS101010 as the packet within DPHY frame to search on. - - ``PPS121212`` specifies PPS121212 as the packet within DPHY frame to search on. - - ``PPS565`` specifies PPS565 as the packet within DPHY frame to search on. - - ``PPS666`` specifies PPS666 as the packet within DPHY frame to search on. - - ``LPS666`` specifies LPS666 as the packet within DPHY frame to search on. - - ``PPS888`` specifies LPS666 as the packet within DPHY frame to search on. - - ``YCBCR24`` specifies YCBCR24 as the packet within DPHY frame to search on. - - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within DPHY frame to search on. - - ``YCBCR16`` specifies YCBCR16 as the packet within DPHY frame to search on. - - ``YCBCR12`` specifies YCBCR12 as the packet within DPHY frame to search on. - - ``ACKNowledge`` specifies ACKNowledge as the packet within DPHY frame to search on. - - ``ERRORREPort`` specifies ERRORREPort as the packet within DPHY frame to search on. - - ``GSRR`` specifies GSRR as the packet within DPHY frame to search on. - - ``GLONGREAD`` specifies GLONGREAD as the packet within DPHY frame to search on. - - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within DPHY frame to search on. - - ``DCSSRR`` specifies DCSSRR as the packet within DPHY frame to search on. - - ``FRAMESTARt`` specifies FRAMESTARt as the packet within DPHY frame to search on. - - ``FRAMEEND`` specifies FRAMEEND as the packet within DPHY frame to search on. - - ``LINESTARt`` specifies LINESTARt as the packet within DPHY frame to search on. - - ``LINEEND`` specifies LINEEND as the packet within DPHY frame to search on. - - ``GSP`` specifies GSP as the packet within DPHY frame to search on. - - ``CSINULL`` specifies CSINULL as the packet within DPHY frame to search on. - - ``CSIBLANk`` specifies CSIBLANk as the packet within DPHY frame to search on. - - ``EMBEDDED`` specifies EMBEDDED as the packet within DPHY frame to search on. - - ``USEREIGHTB`` specifies USEREIGHTB as the packet within DPHY frame to search on. - - ``RGB565`` specifies RGB565 as the packet within DPHY frame to search on. - - ``RGB555`` specifies RGB555 as the packet within DPHY frame to search on. - - ``RGB444`` specifies RGB444 as the packet within DPHY frame to search on. - - ``RGB666`` specifies RGB666 as the packet within DPHY frame to search on. - - ``RAW6`` specifies RAW6 as the packet within DPHY frame to search on. - - ``RAW7`` specifies RAW7 as the packet within DPHY frame to search on. - - ``RAW8`` specifies RAW8 as the packet within DPHY frame to search on. - - ``RAW10`` specifies RAW10 as the packet within DPHY frame to search on. - - ``RAW12`` specifies RAW12 as the packet within DPHY frame to search on. - - ``RAW14`` specifies RAW14 as the packet within DPHY frame to search on. - - ``RAW16`` specifies RAW16 as the packet within DPHY frame to search on. - - ``RAW20`` specifies RAW20 as the packet within DPHY frame to search on. - - ``RGB888`` specifies RGB888 as the packet within DPHY frame to search on. - - ``YUV420L8`` specifies YUV420L8 as the packet within DPHY frame to search on. - - ``YUV8BIT`` specifies YUV8BIT as the packet within DPHY frame to search on. - - ``YUV422B10`` specifies YUV422B10 as the packet within DPHY frame to search on. - - ``YUV420B10`` specifies YUV420B10 as the packet within DPHY frame to search on. - """ # noqa: E501 + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyPackets(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. +class SearchSearchItemTriggerABusEspiAddress(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._list = SearchSearchItemTriggerABusDphyPacketsList(device, f"{self._cmd_syntax}:LIST") - self._type = SearchSearchItemTriggerABusDphyPacketsType(device, f"{self._cmd_syntax}:TYPe") + self._value = SearchSearchItemTriggerABusEspiAddressValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def list(self) -> SearchSearchItemTriggerABusDphyPacketsList: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. + def value(self) -> SearchSearchItemTriggerABusEspiAddressValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. **Description:** - - This command sets or queries the packet list for DPHY bus. The default packet list - condition is VSYNCSTART. + - This command specifies the binary data string used for ESPI triggering if the trigger + condition is Address. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue? **Info:** - - ``VSYNCSTART`` specifies VSYNCSTART as the packet within DPHY frame to search on. - - ``VSYNCEND`` specifies VSYNCEND as the packet within DPHY frame to search on. - - ``HSYNCSTART`` specifies HSYNCSTART as the packet within DPHY frame to search on. - - ``HSYNCEND`` specifies HSYNCEND as the packet within DPHY frame to search on. - - ``EOTP`` specifies EOTP as the packet within DPHY frame to search on. - - ``COLOROFF`` specifies COLOROFF as the packet within DPHY frame to search on. - - ``COLORON`` specifies COLORON as the packet within DPHY frame to search on. - - ``SHUTDOWN`` specifies SHUTDOWN as the packet within DPHY frame to search on. - - ``TURNON`` specifies TURNON as the packet within DPHY frame to search on. - - ``GSW`` specifies GSW as the packet within DPHY frame to search on. - - ``GR`` specifies GR as the packet within DPHY frame to search on. - - ``COMPRESSION`` specifies COMPRESSION as the packet within DPHY frame to search on. - - ``SCRAMBLING`` specifies SCRAMBLING as the packet within DPHY frame to search on. - - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within DPHY frame to search on. - - ``DCSSW`` specifies DCSSW as the packet within DPHY frame to search on. - - ``DCSR`` specifies DCSR as the packet within DPHY frame to search on. - - ``GLONGWRITE`` specifies GLONGWRITE as the packet within DPHY frame to search on. - - ``DSINULL`` specifies DSINULL as the packet within DPHY frame to search on. - - ``DSIBLANk`` specifies DSIBLANk as the packet within DPHY frame to search on. - - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within DPHY frame to search on. - - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within DPHY frame to search - on. - - ``PICPARameter`` specifies PICPARameter as the packet within DPHY frame to search on. - - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within DPHY frame to - search on. - - ``PPS101010`` specifies PPS101010 as the packet within DPHY frame to search on. - - ``PPS121212`` specifies PPS121212 as the packet within DPHY frame to search on. - - ``PPS565`` specifies PPS565 as the packet within DPHY frame to search on. - - ``PPS666`` specifies PPS666 as the packet within DPHY frame to search on. - - ``LPS666`` specifies LPS666 as the packet within DPHY frame to search on. - - ``PPS888`` specifies LPS666 as the packet within DPHY frame to search on. - - ``YCBCR24`` specifies YCBCR24 as the packet within DPHY frame to search on. - - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within DPHY frame to search on. - - ``YCBCR16`` specifies YCBCR16 as the packet within DPHY frame to search on. - - ``YCBCR12`` specifies YCBCR12 as the packet within DPHY frame to search on. - - ``ACKNowledge`` specifies ACKNowledge as the packet within DPHY frame to search on. - - ``ERRORREPort`` specifies ERRORREPort as the packet within DPHY frame to search on. - - ``GSRR`` specifies GSRR as the packet within DPHY frame to search on. - - ``GLONGREAD`` specifies GLONGREAD as the packet within DPHY frame to search on. - - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within DPHY frame to search on. - - ``DCSSRR`` specifies DCSSRR as the packet within DPHY frame to search on. - - ``FRAMESTARt`` specifies FRAMESTARt as the packet within DPHY frame to search on. - - ``FRAMEEND`` specifies FRAMEEND as the packet within DPHY frame to search on. - - ``LINESTARt`` specifies LINESTARt as the packet within DPHY frame to search on. - - ``LINEEND`` specifies LINEEND as the packet within DPHY frame to search on. - - ``GSP`` specifies GSP as the packet within DPHY frame to search on. - - ``CSINULL`` specifies CSINULL as the packet within DPHY frame to search on. - - ``CSIBLANk`` specifies CSIBLANk as the packet within DPHY frame to search on. - - ``EMBEDDED`` specifies EMBEDDED as the packet within DPHY frame to search on. - - ``USEREIGHTB`` specifies USEREIGHTB as the packet within DPHY frame to search on. - - ``RGB565`` specifies RGB565 as the packet within DPHY frame to search on. - - ``RGB555`` specifies RGB555 as the packet within DPHY frame to search on. - - ``RGB444`` specifies RGB444 as the packet within DPHY frame to search on. - - ``RGB666`` specifies RGB666 as the packet within DPHY frame to search on. - - ``RAW6`` specifies RAW6 as the packet within DPHY frame to search on. - - ``RAW7`` specifies RAW7 as the packet within DPHY frame to search on. - - ``RAW8`` specifies RAW8 as the packet within DPHY frame to search on. - - ``RAW10`` specifies RAW10 as the packet within DPHY frame to search on. - - ``RAW12`` specifies RAW12 as the packet within DPHY frame to search on. - - ``RAW14`` specifies RAW14 as the packet within DPHY frame to search on. - - ``RAW16`` specifies RAW16 as the packet within DPHY frame to search on. - - ``RAW20`` specifies RAW20 as the packet within DPHY frame to search on. - - ``RGB888`` specifies RGB888 as the packet within DPHY frame to search on. - - ``YUV420L8`` specifies YUV420L8 as the packet within DPHY frame to search on. - - ``YUV8BIT`` specifies YUV8BIT as the packet within DPHY frame to search on. - - ``YUV422B10`` specifies YUV422B10 as the packet within DPHY frame to search on. - - ``YUV420B10`` specifies YUV420B10 as the packet within DPHY frame to search on. - """ # noqa: E501 - return self._list + - ```` is the identifier value. The default value is XXXXXXXX. + """ + return self._value + + +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusEspi(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI?`` + query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI?`` + query and raise an AssertionError if the returned value does not match ``value``. + + Properties: + - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. + - ``.cycletype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. + - ``.length``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. + - ``.phase``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. + - ``.respcycle``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. + - ``.smbus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. + - ``.tag``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. + - ``.virtualwire``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._address = SearchSearchItemTriggerABusEspiAddress( + device, f"{self._cmd_syntax}:ADDRess" + ) + self._command = SearchSearchItemTriggerABusEspiCommand( + device, f"{self._cmd_syntax}:COMMAND" + ) + self._condition = SearchSearchItemTriggerABusEspiCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._cycletype = SearchSearchItemTriggerABusEspiCycletype( + device, f"{self._cmd_syntax}:CYCLETYPe" + ) + self._data = SearchSearchItemTriggerABusEspiData(device, f"{self._cmd_syntax}:DATa") + self._error = SearchSearchItemTriggerABusEspiError(device, f"{self._cmd_syntax}:ERRor") + self._length = SearchSearchItemTriggerABusEspiLength(device, f"{self._cmd_syntax}:LENGth") + self._phase = SearchSearchItemTriggerABusEspiPhase(device, f"{self._cmd_syntax}:PHASe") + self._respcycle = SearchSearchItemTriggerABusEspiRespcycle( + device, f"{self._cmd_syntax}:RESPCYCLE" + ) + self._smbus = SearchSearchItemTriggerABusEspiSmbus(device, f"{self._cmd_syntax}:SMBUS") + self._tag = SearchSearchItemTriggerABusEspiTag(device, f"{self._cmd_syntax}:TAG") + self._virtualwire = SearchSearchItemTriggerABusEspiVirtualwire( + device, f"{self._cmd_syntax}:VIRTUALWIRe" + ) + + @property + def address(self) -> SearchSearchItemTriggerABusEspiAddress: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ADDRess:VALue`` command. + """ + return self._address + + @property + def command(self) -> SearchSearchItemTriggerABusEspiCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.opcode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:COMMAND:OPCode`` command. + """ + return self._command @property - def type(self) -> SearchSearchItemTriggerABusDphyPacketsType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. + def condition(self) -> SearchSearchItemTriggerABusEspiCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition`` command. **Description:** - - This command sets or queries the packet type for DPHY bus. The default packet type - condition is SHORt. + - This command sets or queries the trigger condition for a ESPI bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe {SHORt|LONG} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition {STARt| CHINDependent| PERICHANnel| OOBCHANnel| VWCHANnel| FACHANnel| DATa| STATus| ERRors| WAIT| END} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CONDition? **Info:** - - ``SHORt`` specifies SHORt as the field within a DPHY frame to search on. SHORt is the - default packet type condition. - - ``LONG`` specifies LONG as the field within a DPHY frame to search on. - """ - return self._type - - -class SearchSearchItemTriggerABusDphyModeType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. - - **Description:** - - This command sets or queries the mode type for DPHY bus. The default mode type condition - is HS. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe {HS|LP} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe? - - **Info:** - - ``HS`` specifies HS as the mode within a DPHY frame to search on. HS is default mode type - condition. - - ``LP`` specifies LP as the mode within a DPHY frame to search on. - """ - - -class SearchSearchItemTriggerABusDphyMode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusDphyModeType(device, f"{self._cmd_syntax}:TYPe") + - ``STARt`` specifies STARt as the event for ESPI frame to search on. + - ``CHINDependent`` specifies CHINDependent channel for ESPI protocol to search on. + - ``PERICHANnel`` specifies peripheral channel for ESPI protocol to search on. + - ``OOBCHANnel`` specifies OOBCHANnel channel for ESPI protocol to search on. + - ``VWCHANnel`` specifies virtual wire channel for ESPI protocol to search on. + - ``FACHANnel`` specifies flash channel for ESPI protocol to search on. + - ``DATa`` specifies DATa as the field within a ESPI frame to search on. + - ``STATus`` specifies STATus as the field within a ESPI frame to search on. + - ``ERRors`` specifies ERRors as the type of error ESPI frame to search on. + - ``WAIT`` specifies WAIT as the field within a ESPI frame to search on. + - ``END`` specifies END as the event for a ESPI frame to search on. + """ # noqa: E501 + return self._condition @property - def type(self) -> SearchSearchItemTriggerABusDphyModeType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. + def cycletype(self) -> SearchSearchItemTriggerABusEspiCycletype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe`` command. **Description:** - - This command sets or queries the mode type for DPHY bus. The default mode type - condition is HS. + - This command sets or queries the cycle type on command in ESPI bus. The search number + is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe {HS|LP} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe {MEMRD32| MEMRD64| MEMWR32| MEMWR64| MESSage| MSGWITHDATa| SUCCESSNODATa| SUCCESSDATa| UNSUCCESSNODATa| OOBSMBUS| MCTP| FLASHREAD| FLASHWRITe| FLASHERASe| FLSUCCESSNODATa| FLSUCCESSDATa| FLUNSUCCESSNODATa} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:CYCLETYPe? **Info:** - - ``HS`` specifies HS as the mode within a DPHY frame to search on. HS is default mode - type condition. - - ``LP`` specifies LP as the mode within a DPHY frame to search on. - """ - return self._type - - -class SearchSearchItemTriggerABusDphyGreenValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. - - **Description:** - - This command specifies the green data string used for DPHY triggering if the trigger - condition is on RGB packet. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue value`` command. - - **SCPI Syntax:** + - ``MEMRD32`` specifies Memory Read 32 as the cycle type to search on. + - ``MEMRD64`` specifies Memory Read 64 as the cycle type to search on. + - ``MEMWR32`` specifies Memory Read Write 32 as the cycle type to search on. + - ``MEMWR64`` specifies Memory Read Write 64 as the cycle type to search on. + - ``MESSage`` specifies MESSage as the cycle type to search on. + - ``MSGWITHDATa`` specifies message with Data as the cycle type to search on. + - ``SUCCESSNODATa`` specifies success without data as the cycle type to search on. + - ``SUCCESSDATa`` specifies success with data as the cycle type to search on. + - ``UNSUCCESSNODATa`` specifies unsuccess without data as the cycle type to search on. + - ``OOBSMBUS`` specifies OOB SMBus as the cycle type to search on. + - ``MCTP`` specifies MCTP as the cycle type to search on. + - ``FLASHREAD`` specifies FLASHREAD as the cycle type to search on. + - ``FLASHWRITe`` specifies FLASHWRITe as the cycle type to search on. + - ``FLASHERASe`` specifies FLASHERASe as the cycle type to search on. + - ``FLSUCCESSNODATa`` specifies flash success without data as the cycle type to search + on. + - ``FLSUCCESSDATa`` specifies flash Success with data as the cycle type to search on. + - ``FLUNSUCCESSNODATa`` specifies flash unsuccess without data as the cycle type to + search on. + """ # noqa: E501 + return self._cycletype - :: + @property + def data(self) -> SearchSearchItemTriggerABusEspiData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default green value is XXXXXXXXXX. - """ + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:DATa:VALue`` command. + """ + return self._data - _WRAP_ARG_WITH_QUOTES = True + @property + def error(self) -> SearchSearchItemTriggerABusEspiError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusDphyGreen(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:ERRor:TYPe`` command. + """ + return self._error - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query and raise an AssertionError if the - returned value does not match ``value``. + @property + def length(self) -> SearchSearchItemTriggerABusEspiLength: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth`` command tree. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusDphyGreenValue(device, f"{self._cmd_syntax}:VALue") + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:LENGth:VALue`` command. + """ + return self._length @property - def value(self) -> SearchSearchItemTriggerABusDphyGreenValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. + def phase(self) -> SearchSearchItemTriggerABusEspiPhase: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe`` command. **Description:** - - This command specifies the green data string used for DPHY triggering if the trigger - condition is on RGB packet. + - This command sets or queries the phase in ESPI bus. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe {COMMand| RESPONSE| RESPONSEHEADer| RESPONSENOHEADer} + - SEARCH:SEARCH:TRIGger:A:BUS:ESPI:PHASe? **Info:** - - ```` is the identifier value. The default green value is XXXXXXXXXX. - """ - return self._value - - -class SearchSearchItemTriggerABusDphyEscapemodeCommand(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. - - **Description:** - - This command sets or queries the escape mode command type for DPHY bus. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand? + - ``COMMand`` specifies command as the field/packet to search on. + - ``RESPONSE`` specifies response as the field/packet to search on. + - ``RESPONSEHEADer`` specifies the response header as the field/packet to search on. + - ``RESPONSENOHEADer`` specifies the response without header as the field/packet to + search on. + """ # noqa: E501 + return self._phase - **Info:** - - ``LPDT`` specifies LPDT as the field within a DPHY frame to search on. - - ``ULPS`` specifies ULPS as the field within a DPHY frame to search on. - - ``RESETTRIGger`` specifies RESETTRIGger as the field within a DPHY frame to search on. - - ``ANY`` specifies ANY as the field within a DPHY frame to search on. ANY is the default - value. - """ + @property + def respcycle(self) -> SearchSearchItemTriggerABusEspiRespcycle: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE?`` query and raise an AssertionError + if the returned value does not match ``value``. -class SearchSearchItemTriggerABusDphyEscapemode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:RESPCYCLE:TYPe`` command. + """ + return self._respcycle - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def smbus(self) -> SearchSearchItemTriggerABusEspiSmbus: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS`` command tree. - Properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._command = SearchSearchItemTriggerABusDphyEscapemodeCommand( - device, f"{self._cmd_syntax}:COMMand" - ) + Sub-properties: + - ``.destination``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:DESTination`` + command tree. + - ``.slave``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:SMBUS:SLAVe`` command tree. + """ + return self._smbus @property - def command(self) -> SearchSearchItemTriggerABusDphyEscapemodeCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. - - **Description:** - - This command sets or queries the escape mode command type for DPHY bus. + def tag(self) -> SearchSearchItemTriggerABusEspiTag: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG?`` query and raise an AssertionError if the + returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:TAG:VALue`` command. + """ + return self._tag - :: + @property + def virtualwire(self) -> SearchSearchItemTriggerABusEspiVirtualwire: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Info:** - - ``LPDT`` specifies LPDT as the field within a DPHY frame to search on. - - ``ULPS`` specifies ULPS as the field within a DPHY frame to search on. - - ``RESETTRIGger`` specifies RESETTRIGger as the field within a DPHY frame to search on. - - ``ANY`` specifies ANY as the field within a DPHY frame to search on. ANY is the - default value. + Sub-properties: + - ``.count``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:COUNt`` command + tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:DATa`` command tree. + - ``.index``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:INDex`` command + tree. + - ``.response``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:RESPonse`` + command tree. + - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ESPI:VIRTUALWIRe:STATus`` command + tree. """ - return self._command + return self._virtualwire -class SearchSearchItemTriggerABusDphyErrorType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. +class SearchSearchItemTriggerABusDphyYuvY(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. **Description:** - - This command sets or queries the error type for DPHY bus. The default error type condition - is ANY. + - This command specifies the Y data string used for DPHY triggering if the trigger condition + is on YUV packet. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe {ANY|ECC|CRC} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y? **Info:** - - ``ANY`` specifies ANY as the field within a DPHY frame to search on. - - ``ECC`` specifies ECC as the field within a DPHY frame to search on. - - ``CRC`` specifies CRC as the field within a DPHY frame to search on. + - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusDphyError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. +class SearchSearchItemTriggerABusDphyYuvV(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. + + **Description:** + - This command specifies the V data string used for DPHY triggering if the trigger condition + is on YUV packet. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V value`` command. - Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusDphyErrorType(device, f"{self._cmd_syntax}:TYPe") - - @property - def type(self) -> SearchSearchItemTriggerABusDphyErrorType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. - - **Description:** - - This command sets or queries the error type for DPHY bus. The default error type - condition is ANY. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V? - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe {ANY|ECC|CRC} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe? + **Info:** + - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. + """ - **Info:** - - ``ANY`` specifies ANY as the field within a DPHY frame to search on. - - ``ECC`` specifies ECC as the field within a DPHY frame to search on. - - ``CRC`` specifies CRC as the field within a DPHY frame to search on. - """ - return self._type + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. +class SearchSearchItemTriggerABusDphyYuvU(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. **Description:** - - This command specifies the binary data string used for DPHY triggering if the trigger - condition is DATA. + - This command specifies the U data string used for DPHY triggering if the trigger condition + is on YUV packet. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for an DPHY - trigger if the trigger condition is DATA. The default data size is 1 byte and ranges - between 1 and 5. The search number is specified by x. +class SearchSearchItemTriggerABusDphyYuv(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe value`` command. - - **SCPI Syntax:** + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query and raise an AssertionError if the + returned value does not match ``value``. - :: + Properties: + - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. + - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. + """ - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe? + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._u = SearchSearchItemTriggerABusDphyYuvU(device, f"{self._cmd_syntax}:U") + self._v = SearchSearchItemTriggerABusDphyYuvV(device, f"{self._cmd_syntax}:V") + self._y = SearchSearchItemTriggerABusDphyYuvY(device, f"{self._cmd_syntax}:Y") - **Info:** - - ```` specifies the data size. - """ + @property + def u(self) -> SearchSearchItemTriggerABusDphyYuvU: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. + **Description:** + - This command specifies the U data string used for DPHY triggering if the trigger + condition is on YUV packet. -class SearchSearchItemTriggerABusDphyData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U value`` command. - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + **SCPI Syntax:** - Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. - """ + :: - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusDphyDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusDphyDataValue(device, f"{self._cmd_syntax}:VALue") + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U? + + **Info:** + - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. + """ + return self._u @property - def size(self) -> SearchSearchItemTriggerABusDphyDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. + def v(self) -> SearchSearchItemTriggerABusDphyYuvV: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for an DPHY - trigger if the trigger condition is DATA. The default data size is 1 byte and ranges - between 1 and 5. The search number is specified by x. + - This command specifies the V data string used for DPHY triggering if the trigger + condition is on YUV packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V? **Info:** - - ```` specifies the data size. + - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. """ - return self._size + return self._v @property - def value(self) -> SearchSearchItemTriggerABusDphyDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. + def y(self) -> SearchSearchItemTriggerABusDphyYuvY: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. **Description:** - - This command specifies the binary data string used for DPHY triggering if the trigger - condition is DATA. + - This command specifies the Y data string used for DPHY triggering if the trigger + condition is on YUV packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. """ - return self._value + return self._y -class SearchSearchItemTriggerABusDphyCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. +class SearchSearchItemTriggerABusDphyYcbcrY(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. **Description:** - - This command sets or queries the trigger condition for an DPHY bus. The default trigger on - condition is SOT. + - This command specifies the Y data string used for DPHY triggering if the trigger condition + is on YCbCr packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y? **Info:** - - ``SOT`` specifies SOT as the field within a DPHY frame to search on. - - ``EOT`` specifies EOT as the field within a DPHY frame to search on. - - ``DATa`` specifies DATa as the field within a DPHY frame to search on. - - ``EOTPDATa`` specifies EOTPDATa as the field within a DPHY frame to search on. - - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a DPHY frame to search on. - - ``SCRambling`` specifies SCRambling as the field within a DPHY frame to search on. - - ``COMPression`` specifies COMPression as the field within a DPHY frame to search on. - - ``PACKets`` specifies PACKets as the field within a DPHY frame to search on. - - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a DPHY frame to search on. - - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a DPHY frame to search on. - - ``STop`` specifies STop as the field within a DPHY frame to search on. - - ``ERRors`` specifies ERRors as the field within a DPHY frame to search on. - - ``MODe`` specifies MODe as the field within a DPHY frame to search on. - """ # noqa: E501 + - ```` is the identifier value. The default YCBCR packets Y value is XXXXXXXXXX. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyBlueValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + +class SearchSearchItemTriggerABusDphyYcbcrCr(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. **Description:** - - This command specifies the blue data string used for DPHY triggering if the trigger - condition is on RGB packet. + - This command specifies the Cr data string used for DPHY triggering if the trigger + condition is on YCbCr packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR? **Info:** - - ```` is the identifier value. The default blue value is XXXXXXXXXX. + - ```` is the identifier value. The default YCBCR packets CR value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusDphyBlue(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. +class SearchSearchItemTriggerABusDphyYcbcrCb(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. + + **Description:** + - This command specifies the Cb data string used for DPHY triggering if the trigger + condition is on YCbCr packet. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB? + + **Info:** + - ```` is the identifier value. The default YCBCR packets CB value is XXXXXXXXXX. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusDphyYcbcr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. + - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusDphyBlueValue(device, f"{self._cmd_syntax}:VALue") + self._cb = SearchSearchItemTriggerABusDphyYcbcrCb(device, f"{self._cmd_syntax}:CB") + self._cr = SearchSearchItemTriggerABusDphyYcbcrCr(device, f"{self._cmd_syntax}:CR") + self._y = SearchSearchItemTriggerABusDphyYcbcrY(device, f"{self._cmd_syntax}:Y") @property - def value(self) -> SearchSearchItemTriggerABusDphyBlueValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + def cb(self) -> SearchSearchItemTriggerABusDphyYcbcrCb: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. **Description:** - - This command specifies the blue data string used for DPHY triggering if the trigger - condition is on RGB packet. + - This command specifies the Cb data string used for DPHY triggering if the trigger + condition is on YCbCr packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB? **Info:** - - ```` is the identifier value. The default blue value is XXXXXXXXXX. + - ```` is the identifier value. The default YCBCR packets CB value is + XXXXXXXXXX. """ - return self._value - - -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusDphy(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY?`` - query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY?`` - query and raise an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.blue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. - - ``.escapemode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. - - ``.green``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. - - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. - - ``.packets``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. - - ``.pixel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. - - ``.red``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. - - ``.wordcount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. - - ``.ycbcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. - - ``.yuv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._blue = SearchSearchItemTriggerABusDphyBlue(device, f"{self._cmd_syntax}:BLUe") - self._condition = SearchSearchItemTriggerABusDphyCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusDphyData(device, f"{self._cmd_syntax}:DATa") - self._error = SearchSearchItemTriggerABusDphyError(device, f"{self._cmd_syntax}:ERRor") - self._escapemode = SearchSearchItemTriggerABusDphyEscapemode( - device, f"{self._cmd_syntax}:ESCAPEMODe" - ) - self._green = SearchSearchItemTriggerABusDphyGreen(device, f"{self._cmd_syntax}:GREen") - self._mode = SearchSearchItemTriggerABusDphyMode(device, f"{self._cmd_syntax}:MODe") - self._packets = SearchSearchItemTriggerABusDphyPackets( - device, f"{self._cmd_syntax}:PACKets" - ) - self._pixel = SearchSearchItemTriggerABusDphyPixel(device, f"{self._cmd_syntax}:PIXel") - self._red = SearchSearchItemTriggerABusDphyRed(device, f"{self._cmd_syntax}:RED") - self._wordcount = SearchSearchItemTriggerABusDphyWordcount( - device, f"{self._cmd_syntax}:WORDCOUNt" - ) - self._ycbcr = SearchSearchItemTriggerABusDphyYcbcr(device, f"{self._cmd_syntax}:YCBCR") - self._yuv = SearchSearchItemTriggerABusDphyYuv(device, f"{self._cmd_syntax}:YUV") + return self._cb @property - def blue(self) -> SearchSearchItemTriggerABusDphyBlue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. + def cr(self) -> SearchSearchItemTriggerABusDphyYcbcrCr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. + + **Description:** + - This command specifies the Cr data string used for DPHY triggering if the trigger + condition is on YCbCr packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR? + + **Info:** + - ```` is the identifier value. The default YCBCR packets CR value is + XXXXXXXXXX. """ - return self._blue + return self._cr @property - def condition(self) -> SearchSearchItemTriggerABusDphyCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. + def y(self) -> SearchSearchItemTriggerABusDphyYcbcrY: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. **Description:** - - This command sets or queries the trigger condition for an DPHY bus. The default - trigger on condition is SOT. + - This command specifies the Y data string used for DPHY triggering if the trigger + condition is on YCbCr packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe} - - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y? **Info:** - - ``SOT`` specifies SOT as the field within a DPHY frame to search on. - - ``EOT`` specifies EOT as the field within a DPHY frame to search on. - - ``DATa`` specifies DATa as the field within a DPHY frame to search on. - - ``EOTPDATa`` specifies EOTPDATa as the field within a DPHY frame to search on. - - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a DPHY frame to search - on. - - ``SCRambling`` specifies SCRambling as the field within a DPHY frame to search on. - - ``COMPression`` specifies COMPression as the field within a DPHY frame to search on. - - ``PACKets`` specifies PACKets as the field within a DPHY frame to search on. - - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a DPHY frame to search - on. - - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a DPHY frame to search on. - - ``STop`` specifies STop as the field within a DPHY frame to search on. - - ``ERRors`` specifies ERRors as the field within a DPHY frame to search on. - - ``MODe`` specifies MODe as the field within a DPHY frame to search on. - """ # noqa: E501 - return self._condition + - ```` is the identifier value. The default YCBCR packets Y value is + XXXXXXXXXX. + """ + return self._y - @property - def data(self) -> SearchSearchItemTriggerABusDphyData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. +class SearchSearchItemTriggerABusDphyWordcountValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. - """ - return self._data + **Description:** + - This command specifies the word count data string used for DPHY triggering if the trigger + condition is set on any pixel packet. - @property - def error(self) -> SearchSearchItemTriggerABusDphyError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue value`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query and raise an AssertionError if - the returned value does not match ``value``. + **SCPI Syntax:** - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. - """ - return self._error + :: - @property - def escapemode(self) -> SearchSearchItemTriggerABusDphyEscapemode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue? - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query and raise an AssertionError - if the returned value does not match ``value``. + **Info:** + - ```` is the identifier value. The default word count value is XXXXXXXXXXXXXXXX. + """ - Sub-properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. - """ - return self._escapemode + _WRAP_ARG_WITH_QUOTES = True - @property - def green(self) -> SearchSearchItemTriggerABusDphyGreen: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusDphyWordcount(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. - """ - return self._green + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusDphyWordcountValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def mode(self) -> SearchSearchItemTriggerABusDphyMode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. + def value(self) -> SearchSearchItemTriggerABusDphyWordcountValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. + + **Description:** + - This command specifies the word count data string used for DPHY triggering if the + trigger condition is set on any pixel packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue value`` command. - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. - """ - return self._mode + **SCPI Syntax:** - @property - def packets(self) -> SearchSearchItemTriggerABusDphyPackets: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query and raise an AssertionError if - the returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue? - Sub-properties: - - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. + **Info:** + - ```` is the identifier value. The default word count value is + XXXXXXXXXXXXXXXX. """ - return self._packets + return self._value - @property - def pixel(self) -> SearchSearchItemTriggerABusDphyPixel: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query and raise an AssertionError if - the returned value does not match ``value``. +class SearchSearchItemTriggerABusDphyRedValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. - Sub-properties: - - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. - - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` - command. - """ - return self._pixel + **Description:** + - This command specifies the red data string used for DPHY triggering if the trigger + condition is on RGB packet. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue? + + **Info:** + - ```` is the identifier value. The default red value is XXXXXXXXXX. + """ - @property - def red(self) -> SearchSearchItemTriggerABusDphyRed: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. + _WRAP_ARG_WITH_QUOTES = True - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query and raise an AssertionError if the - returned value does not match ``value``. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. - """ - return self._red +class SearchSearchItemTriggerABusDphyRed(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. - @property - def wordcount(self) -> SearchSearchItemTriggerABusDphyWordcount: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query and raise an AssertionError - if the returned value does not match ``value``. + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. + """ - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. - """ - return self._wordcount + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusDphyRedValue(device, f"{self._cmd_syntax}:VALue") @property - def ycbcr(self) -> SearchSearchItemTriggerABusDphyYcbcr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. + def value(self) -> SearchSearchItemTriggerABusDphyRedValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. + + **Description:** + - This command specifies the red data string used for DPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue value`` command. - Sub-properties: - - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. - - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. - """ - return self._ycbcr + **SCPI Syntax:** - @property - def yuv(self) -> SearchSearchItemTriggerABusDphyYuv: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query and raise an AssertionError if the - returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue? - Sub-properties: - - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. - - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. + **Info:** + - ```` is the identifier value. The default red value is XXXXXXXXXX. """ - return self._yuv + return self._value -class SearchSearchItemTriggerABusCxpiNetmnWakeupind(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. +class SearchSearchItemTriggerABusDphyPixelSearchoption(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. **Description:** - - This command sets or queries the Wakeup Status in CXPI bus. The search number is specified - by x. + - This command sets or queries the search pattern type for DPHY bus. The default search + pattern type value is PIXELVALue. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND {ON|OFF|EITHer} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion? **Info:** - - ``ON`` specifies the Wakeup Status as on. The default status is on. - - ``OFF`` specifies the Wakeup Status as off. - - ``EITHer`` specifies the Wakeup Status as either. + - ``PIXELVALue`` specifies PIXELVALue as the field within a DPHY frame to search on. + - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a DPHY frame to search on. """ -class SearchSearchItemTriggerABusCxpiNetmnSleepind(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. +class SearchSearchItemTriggerABusDphyPixelNumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. **Description:** - - This command sets or queries the Sleep Status in CXPI bus. The search number is specified - by x. + - This command specifies the pixel number to be used for DPHY triggering if the trigger + condition is on pixel number pattern. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND {ON|OFF|EITHer} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer? **Info:** - - ``ON`` specifies the Sleep Status as on. The default status is on. - - ``OFF`` specifies the Sleep Status as off. - - ``EITHer`` specifies the Sleep Status as either. + - ```` specifies the pixel number. The default pixel number value is 0. """ -class SearchSearchItemTriggerABusCxpiNetmn(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. +class SearchSearchItemTriggerABusDphyPixel(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.sleepind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. - - ``.wakeupind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. + - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. + - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._sleepind = SearchSearchItemTriggerABusCxpiNetmnSleepind( - device, f"{self._cmd_syntax}:SLEEPIND" + self._number = SearchSearchItemTriggerABusDphyPixelNumber( + device, f"{self._cmd_syntax}:NUMBer" ) - self._wakeupind = SearchSearchItemTriggerABusCxpiNetmnWakeupind( - device, f"{self._cmd_syntax}:WAKEUPIND" + self._searchoption = SearchSearchItemTriggerABusDphyPixelSearchoption( + device, f"{self._cmd_syntax}:SEARCHOPTion" ) @property - def sleepind(self) -> SearchSearchItemTriggerABusCxpiNetmnSleepind: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. + def number(self) -> SearchSearchItemTriggerABusDphyPixelNumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. **Description:** - - This command sets or queries the Sleep Status in CXPI bus. The search number is - specified by x. + - This command specifies the pixel number to be used for DPHY triggering if the trigger + condition is on pixel number pattern. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND {ON|OFF|EITHer} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer? **Info:** - - ``ON`` specifies the Sleep Status as on. The default status is on. - - ``OFF`` specifies the Sleep Status as off. - - ``EITHer`` specifies the Sleep Status as either. + - ```` specifies the pixel number. The default pixel number value is 0. """ - return self._sleepind + return self._number @property - def wakeupind(self) -> SearchSearchItemTriggerABusCxpiNetmnWakeupind: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. + def searchoption(self) -> SearchSearchItemTriggerABusDphyPixelSearchoption: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` command. **Description:** - - This command sets or queries the Wakeup Status in CXPI bus. The search number is - specified by x. + - This command sets or queries the search pattern type for DPHY bus. The default search + pattern type value is PIXELVALue. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND {ON|OFF|EITHer} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion? **Info:** - - ``ON`` specifies the Wakeup Status as on. The default status is on. - - ``OFF`` specifies the Wakeup Status as off. - - ``EITHer`` specifies the Wakeup Status as either. + - ``PIXELVALue`` specifies PIXELVALue as the field within a DPHY frame to search on. + - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a DPHY frame to search on. """ - return self._wakeupind + return self._searchoption -class SearchSearchItemTriggerABusCxpiFrameType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. +class SearchSearchItemTriggerABusDphyPacketsType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. **Description:** - - This command sets or queries the frame type in CXPI bus. The search number is specified by - x. + - This command sets or queries the packet type for DPHY bus. The default packet type + condition is SHORt. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe {NORMal| SLEep| LONG| POLLINGNORMal| POLLINGLONG} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe {SHORt|LONG} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe? **Info:** - - ``NORMal`` specifies NORMal as the packet type CXPI frame to search on. The default frame - type is normal. - - ``SLEep`` specifies SLEep as the packet type CXPI frame to search on. - - ``LONG`` specifies LONG as the packet type CXPI frame to search on. - - ``POLLINGNORMal`` specifies POLLINGNORMal as the packet type CXPI frame to search on. - - ``POLLINGLONG`` specifies POLLINGLONG as the packet type CXPI frame to search on. + - ``SHORt`` specifies SHORt as the field within a DPHY frame to search on. SHORt is the + default packet type condition. + - ``LONG`` specifies LONG as the field within a DPHY frame to search on. + """ + + +class SearchSearchItemTriggerABusDphyPacketsList(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. + + **Description:** + - This command sets or queries the packet list for DPHY bus. The default packet list + condition is VSYNCSTART. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST? + + **Info:** + - ``VSYNCSTART`` specifies VSYNCSTART as the packet within DPHY frame to search on. + - ``VSYNCEND`` specifies VSYNCEND as the packet within DPHY frame to search on. + - ``HSYNCSTART`` specifies HSYNCSTART as the packet within DPHY frame to search on. + - ``HSYNCEND`` specifies HSYNCEND as the packet within DPHY frame to search on. + - ``EOTP`` specifies EOTP as the packet within DPHY frame to search on. + - ``COLOROFF`` specifies COLOROFF as the packet within DPHY frame to search on. + - ``COLORON`` specifies COLORON as the packet within DPHY frame to search on. + - ``SHUTDOWN`` specifies SHUTDOWN as the packet within DPHY frame to search on. + - ``TURNON`` specifies TURNON as the packet within DPHY frame to search on. + - ``GSW`` specifies GSW as the packet within DPHY frame to search on. + - ``GR`` specifies GR as the packet within DPHY frame to search on. + - ``COMPRESSION`` specifies COMPRESSION as the packet within DPHY frame to search on. + - ``SCRAMBLING`` specifies SCRAMBLING as the packet within DPHY frame to search on. + - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within DPHY frame to search on. + - ``DCSSW`` specifies DCSSW as the packet within DPHY frame to search on. + - ``DCSR`` specifies DCSR as the packet within DPHY frame to search on. + - ``GLONGWRITE`` specifies GLONGWRITE as the packet within DPHY frame to search on. + - ``DSINULL`` specifies DSINULL as the packet within DPHY frame to search on. + - ``DSIBLANk`` specifies DSIBLANk as the packet within DPHY frame to search on. + - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within DPHY frame to search on. + - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within DPHY frame to search on. + - ``PICPARameter`` specifies PICPARameter as the packet within DPHY frame to search on. + - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within DPHY frame to + search on. + - ``PPS101010`` specifies PPS101010 as the packet within DPHY frame to search on. + - ``PPS121212`` specifies PPS121212 as the packet within DPHY frame to search on. + - ``PPS565`` specifies PPS565 as the packet within DPHY frame to search on. + - ``PPS666`` specifies PPS666 as the packet within DPHY frame to search on. + - ``LPS666`` specifies LPS666 as the packet within DPHY frame to search on. + - ``PPS888`` specifies LPS666 as the packet within DPHY frame to search on. + - ``YCBCR24`` specifies YCBCR24 as the packet within DPHY frame to search on. + - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within DPHY frame to search on. + - ``YCBCR16`` specifies YCBCR16 as the packet within DPHY frame to search on. + - ``YCBCR12`` specifies YCBCR12 as the packet within DPHY frame to search on. + - ``ACKNowledge`` specifies ACKNowledge as the packet within DPHY frame to search on. + - ``ERRORREPort`` specifies ERRORREPort as the packet within DPHY frame to search on. + - ``GSRR`` specifies GSRR as the packet within DPHY frame to search on. + - ``GLONGREAD`` specifies GLONGREAD as the packet within DPHY frame to search on. + - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within DPHY frame to search on. + - ``DCSSRR`` specifies DCSSRR as the packet within DPHY frame to search on. + - ``FRAMESTARt`` specifies FRAMESTARt as the packet within DPHY frame to search on. + - ``FRAMEEND`` specifies FRAMEEND as the packet within DPHY frame to search on. + - ``LINESTARt`` specifies LINESTARt as the packet within DPHY frame to search on. + - ``LINEEND`` specifies LINEEND as the packet within DPHY frame to search on. + - ``GSP`` specifies GSP as the packet within DPHY frame to search on. + - ``CSINULL`` specifies CSINULL as the packet within DPHY frame to search on. + - ``CSIBLANk`` specifies CSIBLANk as the packet within DPHY frame to search on. + - ``EMBEDDED`` specifies EMBEDDED as the packet within DPHY frame to search on. + - ``USEREIGHTB`` specifies USEREIGHTB as the packet within DPHY frame to search on. + - ``RGB565`` specifies RGB565 as the packet within DPHY frame to search on. + - ``RGB555`` specifies RGB555 as the packet within DPHY frame to search on. + - ``RGB444`` specifies RGB444 as the packet within DPHY frame to search on. + - ``RGB666`` specifies RGB666 as the packet within DPHY frame to search on. + - ``RAW6`` specifies RAW6 as the packet within DPHY frame to search on. + - ``RAW7`` specifies RAW7 as the packet within DPHY frame to search on. + - ``RAW8`` specifies RAW8 as the packet within DPHY frame to search on. + - ``RAW10`` specifies RAW10 as the packet within DPHY frame to search on. + - ``RAW12`` specifies RAW12 as the packet within DPHY frame to search on. + - ``RAW14`` specifies RAW14 as the packet within DPHY frame to search on. + - ``RAW16`` specifies RAW16 as the packet within DPHY frame to search on. + - ``RAW20`` specifies RAW20 as the packet within DPHY frame to search on. + - ``RGB888`` specifies RGB888 as the packet within DPHY frame to search on. + - ``YUV420L8`` specifies YUV420L8 as the packet within DPHY frame to search on. + - ``YUV8BIT`` specifies YUV8BIT as the packet within DPHY frame to search on. + - ``YUV422B10`` specifies YUV422B10 as the packet within DPHY frame to search on. + - ``YUV420B10`` specifies YUV420B10 as the packet within DPHY frame to search on. """ # noqa: E501 -class SearchSearchItemTriggerABusCxpiFrame(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. +class SearchSearchItemTriggerABusDphyPackets(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. + - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusCxpiFrameType(device, f"{self._cmd_syntax}:TYPe") + self._list = SearchSearchItemTriggerABusDphyPacketsList(device, f"{self._cmd_syntax}:LIST") + self._type = SearchSearchItemTriggerABusDphyPacketsType(device, f"{self._cmd_syntax}:TYPe") @property - def type(self) -> SearchSearchItemTriggerABusCxpiFrameType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. + def list(self) -> SearchSearchItemTriggerABusDphyPacketsList: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. **Description:** - - This command sets or queries the frame type in CXPI bus. The search number is - specified by x. + - This command sets or queries the packet list for DPHY bus. The default packet list + condition is VSYNCSTART. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe {NORMal| SLEep| LONG| POLLINGNORMal| POLLINGLONG} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST? **Info:** - - ``NORMal`` specifies NORMal as the packet type CXPI frame to search on. The default - frame type is normal. - - ``SLEep`` specifies SLEep as the packet type CXPI frame to search on. - - ``LONG`` specifies LONG as the packet type CXPI frame to search on. - - ``POLLINGNORMal`` specifies POLLINGNORMal as the packet type CXPI frame to search on. - - ``POLLINGLONG`` specifies POLLINGLONG as the packet type CXPI frame to search on. + - ``VSYNCSTART`` specifies VSYNCSTART as the packet within DPHY frame to search on. + - ``VSYNCEND`` specifies VSYNCEND as the packet within DPHY frame to search on. + - ``HSYNCSTART`` specifies HSYNCSTART as the packet within DPHY frame to search on. + - ``HSYNCEND`` specifies HSYNCEND as the packet within DPHY frame to search on. + - ``EOTP`` specifies EOTP as the packet within DPHY frame to search on. + - ``COLOROFF`` specifies COLOROFF as the packet within DPHY frame to search on. + - ``COLORON`` specifies COLORON as the packet within DPHY frame to search on. + - ``SHUTDOWN`` specifies SHUTDOWN as the packet within DPHY frame to search on. + - ``TURNON`` specifies TURNON as the packet within DPHY frame to search on. + - ``GSW`` specifies GSW as the packet within DPHY frame to search on. + - ``GR`` specifies GR as the packet within DPHY frame to search on. + - ``COMPRESSION`` specifies COMPRESSION as the packet within DPHY frame to search on. + - ``SCRAMBLING`` specifies SCRAMBLING as the packet within DPHY frame to search on. + - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within DPHY frame to search on. + - ``DCSSW`` specifies DCSSW as the packet within DPHY frame to search on. + - ``DCSR`` specifies DCSR as the packet within DPHY frame to search on. + - ``GLONGWRITE`` specifies GLONGWRITE as the packet within DPHY frame to search on. + - ``DSINULL`` specifies DSINULL as the packet within DPHY frame to search on. + - ``DSIBLANk`` specifies DSIBLANk as the packet within DPHY frame to search on. + - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within DPHY frame to search on. + - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within DPHY frame to search + on. + - ``PICPARameter`` specifies PICPARameter as the packet within DPHY frame to search on. + - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within DPHY frame to + search on. + - ``PPS101010`` specifies PPS101010 as the packet within DPHY frame to search on. + - ``PPS121212`` specifies PPS121212 as the packet within DPHY frame to search on. + - ``PPS565`` specifies PPS565 as the packet within DPHY frame to search on. + - ``PPS666`` specifies PPS666 as the packet within DPHY frame to search on. + - ``LPS666`` specifies LPS666 as the packet within DPHY frame to search on. + - ``PPS888`` specifies LPS666 as the packet within DPHY frame to search on. + - ``YCBCR24`` specifies YCBCR24 as the packet within DPHY frame to search on. + - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within DPHY frame to search on. + - ``YCBCR16`` specifies YCBCR16 as the packet within DPHY frame to search on. + - ``YCBCR12`` specifies YCBCR12 as the packet within DPHY frame to search on. + - ``ACKNowledge`` specifies ACKNowledge as the packet within DPHY frame to search on. + - ``ERRORREPort`` specifies ERRORREPort as the packet within DPHY frame to search on. + - ``GSRR`` specifies GSRR as the packet within DPHY frame to search on. + - ``GLONGREAD`` specifies GLONGREAD as the packet within DPHY frame to search on. + - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within DPHY frame to search on. + - ``DCSSRR`` specifies DCSSRR as the packet within DPHY frame to search on. + - ``FRAMESTARt`` specifies FRAMESTARt as the packet within DPHY frame to search on. + - ``FRAMEEND`` specifies FRAMEEND as the packet within DPHY frame to search on. + - ``LINESTARt`` specifies LINESTARt as the packet within DPHY frame to search on. + - ``LINEEND`` specifies LINEEND as the packet within DPHY frame to search on. + - ``GSP`` specifies GSP as the packet within DPHY frame to search on. + - ``CSINULL`` specifies CSINULL as the packet within DPHY frame to search on. + - ``CSIBLANk`` specifies CSIBLANk as the packet within DPHY frame to search on. + - ``EMBEDDED`` specifies EMBEDDED as the packet within DPHY frame to search on. + - ``USEREIGHTB`` specifies USEREIGHTB as the packet within DPHY frame to search on. + - ``RGB565`` specifies RGB565 as the packet within DPHY frame to search on. + - ``RGB555`` specifies RGB555 as the packet within DPHY frame to search on. + - ``RGB444`` specifies RGB444 as the packet within DPHY frame to search on. + - ``RGB666`` specifies RGB666 as the packet within DPHY frame to search on. + - ``RAW6`` specifies RAW6 as the packet within DPHY frame to search on. + - ``RAW7`` specifies RAW7 as the packet within DPHY frame to search on. + - ``RAW8`` specifies RAW8 as the packet within DPHY frame to search on. + - ``RAW10`` specifies RAW10 as the packet within DPHY frame to search on. + - ``RAW12`` specifies RAW12 as the packet within DPHY frame to search on. + - ``RAW14`` specifies RAW14 as the packet within DPHY frame to search on. + - ``RAW16`` specifies RAW16 as the packet within DPHY frame to search on. + - ``RAW20`` specifies RAW20 as the packet within DPHY frame to search on. + - ``RGB888`` specifies RGB888 as the packet within DPHY frame to search on. + - ``YUV420L8`` specifies YUV420L8 as the packet within DPHY frame to search on. + - ``YUV8BIT`` specifies YUV8BIT as the packet within DPHY frame to search on. + - ``YUV422B10`` specifies YUV422B10 as the packet within DPHY frame to search on. + - ``YUV420B10`` specifies YUV420B10 as the packet within DPHY frame to search on. """ # noqa: E501 + return self._list + + @property + def type(self) -> SearchSearchItemTriggerABusDphyPacketsType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. + + **Description:** + - This command sets or queries the packet type for DPHY bus. The default packet type + condition is SHORt. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe {SHORt|LONG} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe? + + **Info:** + - ``SHORt`` specifies SHORt as the field within a DPHY frame to search on. SHORt is the + default packet type condition. + - ``LONG`` specifies LONG as the field within a DPHY frame to search on. + """ return self._type -class SearchSearchItemTriggerABusCxpiFrameidValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. +class SearchSearchItemTriggerABusDphyModeType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. **Description:** - - This command specifies the binary frameId string used for CXPI triggering if the trigger - condition is FRAMEID. The search number is specified by x. + - This command sets or queries the mode type for DPHY bus. The default mode type condition + is HS. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe {HS|LP} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe? **Info:** - - ```` is the identifier value. The default size and value of frame ID is 7 bits - and 'XXX XXXX' respectively. + - ``HS`` specifies HS as the mode within a DPHY frame to search on. HS is default mode type + condition. + - ``LP`` specifies LP as the mode within a DPHY frame to search on. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusCxpiFrameid(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. +class SearchSearchItemTriggerABusDphyMode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCxpiFrameidValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._type = SearchSearchItemTriggerABusDphyModeType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusCxpiFrameidValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusDphyModeType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. - **Description:** - - This command specifies the binary frameId string used for CXPI triggering if the - trigger condition is FRAMEID. The search number is specified by x. + **Description:** + - This command sets or queries the mode type for DPHY bus. The default mode type + condition is HS. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe {HS|LP} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe? **Info:** - - ```` is the identifier value. The default size and value of frame ID is 7 - bits and 'XXX XXXX' respectively. + - ``HS`` specifies HS as the mode within a DPHY frame to search on. HS is default mode + type condition. + - ``LP`` specifies LP as the mode within a DPHY frame to search on. """ - return self._value + return self._type -class SearchSearchItemTriggerABusCxpiExtdlcValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. +class SearchSearchItemTriggerABusDphyGreenValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. **Description:** - - This command specifies the binary DLC string used for CXPI triggering if the trigger - condition is Ext DLC. The search number is specified by x. + - This command specifies the green data string used for DPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue? **Info:** - - ```` is the identifier value. The default size and value of Ext DLC is 8 bits and - 'XXXX XXXX' respectively. + - ```` is the identifier value. The default green value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCxpiExtdlc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. +class SearchSearchItemTriggerABusDphyGreen(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCxpiExtdlcValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._value = SearchSearchItemTriggerABusDphyGreenValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusCxpiExtdlcValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusDphyGreenValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. **Description:** - - This command specifies the binary DLC string used for CXPI triggering if the trigger - condition is Ext DLC. The search number is specified by x. + - This command specifies the green data string used for DPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue? **Info:** - - ```` is the identifier value. The default size and value of Ext DLC is 8 bits - and 'XXXX XXXX' respectively. + - ```` is the identifier value. The default green value is XXXXXXXXXX. """ return self._value -class SearchSearchItemTriggerABusCxpiErrorType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. +class SearchSearchItemTriggerABusDphyEscapemodeCommand(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. **Description:** - - This command sets or queries the Error Type in CXPI bus. The search number is specified by - x. + - This command sets or queries the escape mode command type for DPHY bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe {CRC| PARity| FRAMe| IBS| ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand? **Info:** - - ``CRC`` specifies CRC as the field within a CXPI frame to search on. - - ``PARity`` specifies PARity as the field within a CXPI frame to search on. The default - Error Type is Parity. - - ``FRAMe`` specifies FRAMe as the field within a CXPI frame to search on. - - ``IBS`` specifies IBS as the field within a CXPI frame to search on. - - ``ANY`` specifies ANY as any type of error within a CXPI frame to search on. + - ``LPDT`` specifies LPDT as the field within a DPHY frame to search on. + - ``ULPS`` specifies ULPS as the field within a DPHY frame to search on. + - ``RESETTRIGger`` specifies RESETTRIGger as the field within a DPHY frame to search on. + - ``ANY`` specifies ANY as the field within a DPHY frame to search on. ANY is the default + value. """ -class SearchSearchItemTriggerABusCxpiError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. +class SearchSearchItemTriggerABusDphyEscapemode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusCxpiErrorType(device, f"{self._cmd_syntax}:TYPe") + self._command = SearchSearchItemTriggerABusDphyEscapemodeCommand( + device, f"{self._cmd_syntax}:COMMand" + ) @property - def type(self) -> SearchSearchItemTriggerABusCxpiErrorType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. + def command(self) -> SearchSearchItemTriggerABusDphyEscapemodeCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. **Description:** - - This command sets or queries the Error Type in CXPI bus. The search number is - specified by x. + - This command sets or queries the escape mode command type for DPHY bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe {CRC| PARity| FRAMe| IBS| ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand? **Info:** - - ``CRC`` specifies CRC as the field within a CXPI frame to search on. - - ``PARity`` specifies PARity as the field within a CXPI frame to search on. The default - Error Type is Parity. - - ``FRAMe`` specifies FRAMe as the field within a CXPI frame to search on. - - ``IBS`` specifies IBS as the field within a CXPI frame to search on. - - ``ANY`` specifies ANY as any type of error within a CXPI frame to search on. + - ``LPDT`` specifies LPDT as the field within a DPHY frame to search on. + - ``ULPS`` specifies ULPS as the field within a DPHY frame to search on. + - ``RESETTRIGger`` specifies RESETTRIGger as the field within a DPHY frame to search on. + - ``ANY`` specifies ANY as the field within a DPHY frame to search on. ANY is the + default value. """ - return self._type + return self._command -class SearchSearchItemTriggerABusCxpiDlcValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. +class SearchSearchItemTriggerABusDphyErrorType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. **Description:** - - This command specifies the binary DLC string used for CXPI triggering if the trigger - condition is DLC. The search number is specified by x. + - This command sets or queries the error type for DPHY bus. The default error type condition + is ANY. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe {ANY|ECC|CRC} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe? **Info:** - - ```` is the identifier value. The default size and value of DLC is 4 bits and - 'XXXX' respectively. + - ``ANY`` specifies ANY as the field within a DPHY frame to search on. + - ``ECC`` specifies ECC as the field within a DPHY frame to search on. + - ``CRC`` specifies CRC as the field within a DPHY frame to search on. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusCxpiDlc(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. +class SearchSearchItemTriggerABusDphyError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCxpiDlcValue(device, f"{self._cmd_syntax}:VALue") + self._type = SearchSearchItemTriggerABusDphyErrorType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusCxpiDlcValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusDphyErrorType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. **Description:** - - This command specifies the binary DLC string used for CXPI triggering if the trigger - condition is DLC. The search number is specified by x. + - This command sets or queries the error type for DPHY bus. The default error type + condition is ANY. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe {ANY|ECC|CRC} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe? **Info:** - - ```` is the identifier value. The default size and value of DLC is 4 bits and - 'XXXX' respectively. + - ``ANY`` specifies ANY as the field within a DPHY frame to search on. + - ``ECC`` specifies ECC as the field within a DPHY frame to search on. + - ``CRC`` specifies CRC as the field within a DPHY frame to search on. """ - return self._value + return self._type -class SearchSearchItemTriggerABusCxpiDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. +class SearchSearchItemTriggerABusDphyDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. **Description:** - - This command specifies the binary data string used for CXPI triggering if the trigger - condition is DATA. The search number is specified by x. + - This command specifies the binary data string used for DPHY triggering if the trigger + condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue? **Info:** - - ```` is the identifier value. The default size and value for DATA is 8 bits and - 'XXXX XXXX' respectively. + - ```` is the identifier value. The default value is XXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCxpiDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. +class SearchSearchItemTriggerABusDphyDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for CXPI - triggering if the trigger condition is DATA. The search number is specified by x. + - This command specifies the length of the data string in bytes to be used for an DPHY + trigger if the trigger condition is DATA. The default data size is 1 byte and ranges + between 1 and 5. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe? **Info:** - - ```` specifies the data size. The default data size is 1 and the calid range is 1 to - 5. + - ```` specifies the data size. """ -class SearchSearchItemTriggerABusCxpiData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. +class SearchSearchItemTriggerABusDphyData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusCxpiDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusCxpiDataValue(device, f"{self._cmd_syntax}:VALue") + self._size = SearchSearchItemTriggerABusDphyDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusDphyDataValue(device, f"{self._cmd_syntax}:VALue") @property - def size(self) -> SearchSearchItemTriggerABusCxpiDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. + def size(self) -> SearchSearchItemTriggerABusDphyDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for CXPI - triggering if the trigger condition is DATA. The search number is specified by x. + - This command specifies the length of the data string in bytes to be used for an DPHY + trigger if the trigger condition is DATA. The default data size is 1 byte and ranges + between 1 and 5. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe? **Info:** - - ```` specifies the data size. The default data size is 1 and the calid range is 1 - to 5. + - ```` specifies the data size. """ return self._size @property - def value(self) -> SearchSearchItemTriggerABusCxpiDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusDphyDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. **Description:** - - This command specifies the binary data string used for CXPI triggering if the trigger - condition is DATA. The search number is specified by x. + - This command specifies the binary data string used for DPHY triggering if the trigger + condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue? **Info:** - - ```` is the identifier value. The default size and value for DATA is 8 bits - and 'XXXX XXXX' respectively. + - ```` is the identifier value. The default value is XXXXXXXX. """ return self._value -class SearchSearchItemTriggerABusCxpiCounterValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. +class SearchSearchItemTriggerABusDphyCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. **Description:** - - This command specifies the binary counter string used for CXPI triggering if the trigger - condition is COUNTER. The search number is specified by x. + - This command sets or queries the trigger condition for an DPHY bus. The default trigger on + condition is SOT. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition? **Info:** - - ```` specifies the binary counter string. The default size and value Counter is 2 - bits and 'XX' respectively. - """ + - ``SOT`` specifies SOT as the field within a DPHY frame to search on. + - ``EOT`` specifies EOT as the field within a DPHY frame to search on. + - ``DATa`` specifies DATa as the field within a DPHY frame to search on. + - ``EOTPDATa`` specifies EOTPDATa as the field within a DPHY frame to search on. + - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a DPHY frame to search on. + - ``SCRambling`` specifies SCRambling as the field within a DPHY frame to search on. + - ``COMPression`` specifies COMPression as the field within a DPHY frame to search on. + - ``PACKets`` specifies PACKets as the field within a DPHY frame to search on. + - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a DPHY frame to search on. + - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a DPHY frame to search on. + - ``STop`` specifies STop as the field within a DPHY frame to search on. + - ``ERRors`` specifies ERRors as the field within a DPHY frame to search on. + - ``MODe`` specifies MODe as the field within a DPHY frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusCxpiCounter(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. +class SearchSearchItemTriggerABusDphyBlueValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + + **Description:** + - This command specifies the blue data string used for DPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue? + + **Info:** + - ```` is the identifier value. The default blue value is XXXXXXXXXX. + """ + + _WRAP_ARG_WITH_QUOTES = True + + +class SearchSearchItemTriggerABusDphyBlue(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCxpiCounterValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._value = SearchSearchItemTriggerABusDphyBlueValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusCxpiCounterValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusDphyBlueValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. **Description:** - - This command specifies the binary counter string used for CXPI triggering if the - trigger condition is COUNTER. The search number is specified by x. + - This command specifies the blue data string used for DPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue? **Info:** - - ```` specifies the binary counter string. The default size and value Counter - is 2 bits and 'XX' respectively. + - ```` is the identifier value. The default blue value is XXXXXXXXXX. """ return self._value -class SearchSearchItemTriggerABusCxpiCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. - - **Description:** - - This command sets or queries the trigger condition for a CXPI bus. The search number is - specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition {STARt| FRAMes| FRAMEID| PTYPe| DLC| EXTDLC| NETMN| COUNter| DATa| ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition? - - **Info:** - - ``STARt`` specifies STARt as the event for a CXPI frame to search on. This is the default - value. - - ``FRAMes`` specifies FRAMes as the frame types for CXPI packets to search on. - - ``FRAMEID`` specifies FRAMEID as the field within a CXPI frame to search on. - - ``PTYPe`` specifies PTYPe as the field within a CXPI frame to search on. - - ``DLC`` specifies DLC as the field within a CXPI frame to search on. - - ``EXTDLC`` specifies EXTDLC as the field within a CXPI frame to search on. - - ``NETMN`` specifies NETMN as the field within a CXPI frame to search on. - - ``COUNter`` specifies COUNter as the field within a CXPI frame to search on. - - ``DATa`` specifies DATa as the field within a CXPI frame to search on. - - ``ERRors`` specifies ERRors as type of error within a CXPI frame to search on. - """ # noqa: E501 - - # pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusCxpi(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI`` command tree. +class SearchSearchItemTriggerABusDphy(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY?`` query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI?`` + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. - - ``.counter``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. - - ``.dlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. - - ``.extdlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. - - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. - - ``.frame``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. - - ``.netmn``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. + - ``.blue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. + - ``.escapemode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. + - ``.green``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. + - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. + - ``.packets``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. + - ``.pixel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. + - ``.red``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. + - ``.wordcount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. + - ``.ycbcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. + - ``.yuv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusCxpiCondition( + self._blue = SearchSearchItemTriggerABusDphyBlue(device, f"{self._cmd_syntax}:BLUe") + self._condition = SearchSearchItemTriggerABusDphyCondition( device, f"{self._cmd_syntax}:CONDition" ) - self._counter = SearchSearchItemTriggerABusCxpiCounter( - device, f"{self._cmd_syntax}:COUNter" + self._data = SearchSearchItemTriggerABusDphyData(device, f"{self._cmd_syntax}:DATa") + self._error = SearchSearchItemTriggerABusDphyError(device, f"{self._cmd_syntax}:ERRor") + self._escapemode = SearchSearchItemTriggerABusDphyEscapemode( + device, f"{self._cmd_syntax}:ESCAPEMODe" + ) + self._green = SearchSearchItemTriggerABusDphyGreen(device, f"{self._cmd_syntax}:GREen") + self._mode = SearchSearchItemTriggerABusDphyMode(device, f"{self._cmd_syntax}:MODe") + self._packets = SearchSearchItemTriggerABusDphyPackets( + device, f"{self._cmd_syntax}:PACKets" ) - self._data = SearchSearchItemTriggerABusCxpiData(device, f"{self._cmd_syntax}:DATa") - self._dlc = SearchSearchItemTriggerABusCxpiDlc(device, f"{self._cmd_syntax}:DLC") - self._error = SearchSearchItemTriggerABusCxpiError(device, f"{self._cmd_syntax}:ERROR") - self._extdlc = SearchSearchItemTriggerABusCxpiExtdlc(device, f"{self._cmd_syntax}:EXTDLC") - self._frameid = SearchSearchItemTriggerABusCxpiFrameid( - device, f"{self._cmd_syntax}:FRAMEID" + self._pixel = SearchSearchItemTriggerABusDphyPixel(device, f"{self._cmd_syntax}:PIXel") + self._red = SearchSearchItemTriggerABusDphyRed(device, f"{self._cmd_syntax}:RED") + self._wordcount = SearchSearchItemTriggerABusDphyWordcount( + device, f"{self._cmd_syntax}:WORDCOUNt" ) - self._frame = SearchSearchItemTriggerABusCxpiFrame(device, f"{self._cmd_syntax}:FRAMe") - self._netmn = SearchSearchItemTriggerABusCxpiNetmn(device, f"{self._cmd_syntax}:NETMN") + self._ycbcr = SearchSearchItemTriggerABusDphyYcbcr(device, f"{self._cmd_syntax}:YCBCR") + self._yuv = SearchSearchItemTriggerABusDphyYuv(device, f"{self._cmd_syntax}:YUV") @property - def condition(self) -> SearchSearchItemTriggerABusCxpiCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. + def blue(self) -> SearchSearchItemTriggerABusDphyBlue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:BLUe:VALue`` command. + """ + return self._blue + + @property + def condition(self) -> SearchSearchItemTriggerABusDphyCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition`` command. **Description:** - - This command sets or queries the trigger condition for a CXPI bus. The search number - is specified by x. + - This command sets or queries the trigger condition for an DPHY bus. The default + trigger on condition is SOT. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition {STARt| FRAMes| FRAMEID| PTYPe| DLC| EXTDLC| NETMN| COUNter| DATa| ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe} + - SEARCH:SEARCH:TRIGger:A:BUS:DPHY:CONDition? **Info:** - - ``STARt`` specifies STARt as the event for a CXPI frame to search on. This is the - default value. - - ``FRAMes`` specifies FRAMes as the frame types for CXPI packets to search on. - - ``FRAMEID`` specifies FRAMEID as the field within a CXPI frame to search on. - - ``PTYPe`` specifies PTYPe as the field within a CXPI frame to search on. - - ``DLC`` specifies DLC as the field within a CXPI frame to search on. - - ``EXTDLC`` specifies EXTDLC as the field within a CXPI frame to search on. - - ``NETMN`` specifies NETMN as the field within a CXPI frame to search on. - - ``COUNter`` specifies COUNter as the field within a CXPI frame to search on. - - ``DATa`` specifies DATa as the field within a CXPI frame to search on. - - ``ERRors`` specifies ERRors as type of error within a CXPI frame to search on. + - ``SOT`` specifies SOT as the field within a DPHY frame to search on. + - ``EOT`` specifies EOT as the field within a DPHY frame to search on. + - ``DATa`` specifies DATa as the field within a DPHY frame to search on. + - ``EOTPDATa`` specifies EOTPDATa as the field within a DPHY frame to search on. + - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a DPHY frame to search + on. + - ``SCRambling`` specifies SCRambling as the field within a DPHY frame to search on. + - ``COMPression`` specifies COMPression as the field within a DPHY frame to search on. + - ``PACKets`` specifies PACKets as the field within a DPHY frame to search on. + - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a DPHY frame to search + on. + - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a DPHY frame to search on. + - ``STop`` specifies STop as the field within a DPHY frame to search on. + - ``ERRors`` specifies ERRors as the field within a DPHY frame to search on. + - ``MODe`` specifies MODe as the field within a DPHY frame to search on. """ # noqa: E501 return self._condition @property - def counter(self) -> SearchSearchItemTriggerABusCxpiCounter: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. + def data(self) -> SearchSearchItemTriggerABusDphyData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:DATa:VALue`` command. """ - return self._counter + return self._data @property - def data(self) -> SearchSearchItemTriggerABusCxpiData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. + def error(self) -> SearchSearchItemTriggerABusDphyError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor?`` query and raise an AssertionError if + the returned value does not match ``value``. Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ERRor:TYPe`` command. """ - return self._data + return self._error @property - def dlc(self) -> SearchSearchItemTriggerABusCxpiDlc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. + def escapemode(self) -> SearchSearchItemTriggerABusDphyEscapemode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe?`` query and raise an AssertionError + if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:ESCAPEMODe:COMMand`` command. """ - return self._dlc + return self._escapemode @property - def error(self) -> SearchSearchItemTriggerABusCxpiError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. + def green(self) -> SearchSearchItemTriggerABusDphyGreen: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:GREen:VALue`` command. """ - return self._error + return self._green @property - def extdlc(self) -> SearchSearchItemTriggerABusCxpiExtdlc: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. + def mode(self) -> SearchSearchItemTriggerABusDphyMode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:MODe:TYPe`` command. """ - return self._extdlc + return self._mode @property - def frameid(self) -> SearchSearchItemTriggerABusCxpiFrameid: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. + def packets(self) -> SearchSearchItemTriggerABusDphyPackets: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. + - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:LIST`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PACKets:TYPe`` command. """ - return self._frameid + return self._packets @property - def frame(self) -> SearchSearchItemTriggerABusCxpiFrame: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. + def pixel(self) -> SearchSearchItemTriggerABusDphyPixel: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. + - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:NUMBer`` command. + - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:PIXel:SEARCHOPTion`` + command. """ - return self._frame + return self._pixel @property - def netmn(self) -> SearchSearchItemTriggerABusCxpiNetmn: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. + def red(self) -> SearchSearchItemTriggerABusDphyRed: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.sleepind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. - - ``.wakeupind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:RED:VALue`` command. """ - return self._netmn - - -class SearchSearchItemTriggerABusCphyYuvY(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. - - **Description:** - - This command specifies the Y data string used for CPHY triggering if the trigger condition - is on YUV packet. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y? - - **Info:** - - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusCphyYuvV(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. - - **Description:** - - This command specifies the V data string used for CPHY triggering if the trigger condition - is on YUV packet. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V? - - **Info:** - - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusCphyYuvU(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. - - **Description:** - - This command specifies the U data string used for CPHY triggering if the trigger condition - is on YUV packet. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U? - - **Info:** - - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusCphyYuv(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. - - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._u = SearchSearchItemTriggerABusCphyYuvU(device, f"{self._cmd_syntax}:U") - self._v = SearchSearchItemTriggerABusCphyYuvV(device, f"{self._cmd_syntax}:V") - self._y = SearchSearchItemTriggerABusCphyYuvY(device, f"{self._cmd_syntax}:Y") + return self._red @property - def u(self) -> SearchSearchItemTriggerABusCphyYuvU: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. - - **Description:** - - This command specifies the U data string used for CPHY triggering if the trigger - condition is on YUV packet. The search number is specified by x. + def wordcount(self) -> SearchSearchItemTriggerABusDphyWordcount: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U? + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:WORDCOUNt:VALue`` command. """ - return self._u + return self._wordcount @property - def v(self) -> SearchSearchItemTriggerABusCphyYuvV: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. - - **Description:** - - This command specifies the V data string used for CPHY triggering if the trigger - condition is on YUV packet. The search number is specified by x. + def ycbcr(self) -> SearchSearchItemTriggerABusDphyYcbcr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR?`` query and raise an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V value`` command. - - **SCPI Syntax:** - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V? - - **Info:** - - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. + Sub-properties: + - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CB`` command. + - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:CR`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YCBCR:Y`` command. """ - return self._v + return self._ycbcr @property - def y(self) -> SearchSearchItemTriggerABusCphyYuvY: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. - - **Description:** - - This command specifies the Y data string used for CPHY triggering if the trigger - condition is on YUV packet. The search number is specified by x. + def yuv(self) -> SearchSearchItemTriggerABusDphyYuv: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y? + ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. + Sub-properties: + - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:U`` command. + - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:V`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:DPHY:YUV:Y`` command. """ - return self._y - - -class SearchSearchItemTriggerABusCphyYcbcrY(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. - - **Description:** - - This command specifies the Y data string used for CPHY triggering if the trigger condition - is on YCbCr packet. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y? - - **Info:** - - ```` is the identifier value. The default YCBCR packets Y value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True + return self._yuv -class SearchSearchItemTriggerABusCphyYcbcrCr(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. +class SearchSearchItemTriggerABusCxpiNetmnWakeupind(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. **Description:** - - This command specifies the Cr data string used for CPHY triggering if the trigger - condition is on YCbCr packet. The search number is specified by x. + - This command sets or queries the Wakeup Status in CXPI bus. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND {ON|OFF|EITHer} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND? **Info:** - - ```` is the identifier value. The default YCBCR packets CR value is XXXXXXXXXX. + - ``ON`` specifies the Wakeup Status as on. The default status is on. + - ``OFF`` specifies the Wakeup Status as off. + - ``EITHer`` specifies the Wakeup Status as either. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusCphyYcbcrCb(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. +class SearchSearchItemTriggerABusCxpiNetmnSleepind(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. **Description:** - - This command specifies the Cb data string used for CPHY triggering if the trigger - condition is on YCbCr packet. The search number is specified by x. + - This command sets or queries the Sleep Status in CXPI bus. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND {ON|OFF|EITHer} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND? **Info:** - - ```` is the identifier value. The default YCBCR packets CB value is XXXXXXXXXX. + - ``ON`` specifies the Sleep Status as on. The default status is on. + - ``OFF`` specifies the Sleep Status as off. + - ``EITHer`` specifies the Sleep Status as either. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusCphyYcbcr(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. +class SearchSearchItemTriggerABusCxpiNetmn(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. - - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._cb = SearchSearchItemTriggerABusCphyYcbcrCb(device, f"{self._cmd_syntax}:CB") - self._cr = SearchSearchItemTriggerABusCphyYcbcrCr(device, f"{self._cmd_syntax}:CR") - self._y = SearchSearchItemTriggerABusCphyYcbcrY(device, f"{self._cmd_syntax}:Y") - - @property - def cb(self) -> SearchSearchItemTriggerABusCphyYcbcrCb: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. - - **Description:** - - This command specifies the Cb data string used for CPHY triggering if the trigger - condition is on YCbCr packet. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB? + - ``.sleepind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. + - ``.wakeupind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. + """ - **Info:** - - ```` is the identifier value. The default YCBCR packets CB value is - XXXXXXXXXX. - """ - return self._cb + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._sleepind = SearchSearchItemTriggerABusCxpiNetmnSleepind( + device, f"{self._cmd_syntax}:SLEEPIND" + ) + self._wakeupind = SearchSearchItemTriggerABusCxpiNetmnWakeupind( + device, f"{self._cmd_syntax}:WAKEUPIND" + ) @property - def cr(self) -> SearchSearchItemTriggerABusCphyYcbcrCr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. + def sleepind(self) -> SearchSearchItemTriggerABusCxpiNetmnSleepind: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. **Description:** - - This command specifies the Cr data string used for CPHY triggering if the trigger - condition is on YCbCr packet. The search number is specified by x. + - This command sets or queries the Sleep Status in CXPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND {ON|OFF|EITHer} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND? **Info:** - - ```` is the identifier value. The default YCBCR packets CR value is - XXXXXXXXXX. + - ``ON`` specifies the Sleep Status as on. The default status is on. + - ``OFF`` specifies the Sleep Status as off. + - ``EITHer`` specifies the Sleep Status as either. """ - return self._cr + return self._sleepind @property - def y(self) -> SearchSearchItemTriggerABusCphyYcbcrY: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. + def wakeupind(self) -> SearchSearchItemTriggerABusCxpiNetmnWakeupind: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. **Description:** - - This command specifies the Y data string used for CPHY triggering if the trigger - condition is on YCbCr packet. The search number is specified by x. + - This command sets or queries the Wakeup Status in CXPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND {ON|OFF|EITHer} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND? **Info:** - - ```` is the identifier value. The default YCBCR packets Y value is - XXXXXXXXXX. + - ``ON`` specifies the Wakeup Status as on. The default status is on. + - ``OFF`` specifies the Wakeup Status as off. + - ``EITHer`` specifies the Wakeup Status as either. """ - return self._y + return self._wakeupind -class SearchSearchItemTriggerABusCphyWordcountValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. +class SearchSearchItemTriggerABusCxpiFrameType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. **Description:** - - This command specifies the word count data string used for CPHY triggering if the trigger - condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. + - This command sets or queries the frame type in CXPI bus. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe {NORMal| SLEep| LONG| POLLINGNORMal| POLLINGLONG} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe? **Info:** - - ```` specifies the word count data string. The default data value is - XXXXXXXXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``NORMal`` specifies NORMal as the packet type CXPI frame to search on. The default frame + type is normal. + - ``SLEep`` specifies SLEep as the packet type CXPI frame to search on. + - ``LONG`` specifies LONG as the packet type CXPI frame to search on. + - ``POLLINGNORMal`` specifies POLLINGNORMal as the packet type CXPI frame to search on. + - ``POLLINGLONG`` specifies POLLINGLONG as the packet type CXPI frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusCphyWordcount(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. +class SearchSearchItemTriggerABusCxpiFrame(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCphyWordcountValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._type = SearchSearchItemTriggerABusCxpiFrameType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusCphyWordcountValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusCxpiFrameType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. **Description:** - - This command specifies the word count data string used for CPHY triggering if the - trigger condition is on any rgb/ycbcr/yuv packet. The search number is specified by - x. + - This command sets or queries the frame type in CXPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe {NORMal| SLEep| LONG| POLLINGNORMal| POLLINGLONG} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe? **Info:** - - ```` specifies the word count data string. The default data value is - XXXXXXXXXXXXXXXX. - """ - return self._value + - ``NORMal`` specifies NORMal as the packet type CXPI frame to search on. The default + frame type is normal. + - ``SLEep`` specifies SLEep as the packet type CXPI frame to search on. + - ``LONG`` specifies LONG as the packet type CXPI frame to search on. + - ``POLLINGNORMal`` specifies POLLINGNORMal as the packet type CXPI frame to search on. + - ``POLLINGLONG`` specifies POLLINGLONG as the packet type CXPI frame to search on. + """ # noqa: E501 + return self._type -class SearchSearchItemTriggerABusCphyWordValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. +class SearchSearchItemTriggerABusCxpiFrameidValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is Word. The search number is specified by x. + - This command specifies the binary frameId string used for CXPI triggering if the trigger + condition is FRAMEID. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue? **Info:** - - ```` specifies the binary data string. The default data value is - XXXXXXXXXXXXXXXX. + - ```` is the identifier value. The default size and value of frame ID is 7 bits + and 'XXX XXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyWordSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. - - **Description:** - - This command specifies the length of the word string in bytes to be used for an CPHY - trigger if the trigger condition is WORD. The search number is specified by x. +class SearchSearchItemTriggerABusCxpiFrameid(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe? - - **Info:** - - ```` specifies the length of the data string. The default word size is 1 byte and - otherwise ranges between 1 and 5. - """ - - -class SearchSearchItemTriggerABusCphyWord(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` - query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusCphyWordSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusCphyWordValue(device, f"{self._cmd_syntax}:VALue") - - @property - def size(self) -> SearchSearchItemTriggerABusCphyWordSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. - - **Description:** - - This command specifies the length of the word string in bytes to be used for an CPHY - trigger if the trigger condition is WORD. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe? - - **Info:** - - ```` specifies the length of the data string. The default word size is 1 byte and - otherwise ranges between 1 and 5. - """ - return self._size + self._value = SearchSearchItemTriggerABusCxpiFrameidValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def value(self) -> SearchSearchItemTriggerABusCphyWordValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusCxpiFrameidValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is Word. The search number is specified by x. + - This command specifies the binary frameId string used for CXPI triggering if the + trigger condition is FRAMEID. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue? **Info:** - - ```` specifies the binary data string. The default data value is - XXXXXXXXXXXXXXXX. + - ```` is the identifier value. The default size and value of frame ID is 7 + bits and 'XXX XXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusCphySymbolValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. +class SearchSearchItemTriggerABusCxpiExtdlcValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is SYMBol. The search number is specified by x. + - This command specifies the binary DLC string used for CXPI triggering if the trigger + condition is Ext DLC. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue? **Info:** - - ```` specifies the binary data string. The default data value is XXX. + - ```` is the identifier value. The default size and value of Ext DLC is 8 bits and + 'XXXX XXXX' respectively. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphySymbolSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for an CPHY - trigger if the trigger condition is SYMBol. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe? - - **Info:** - - ```` specifies the length of the data string. The default symbol size is 7 symbols - and otherwise ranges between 1 and 14. - """ - - -class SearchSearchItemTriggerABusCphySymbol(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. +class SearchSearchItemTriggerABusCxpiExtdlc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusCphySymbolSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusCphySymbolValue( + self._value = SearchSearchItemTriggerABusCxpiExtdlcValue( device, f"{self._cmd_syntax}:VALue" ) @property - def size(self) -> SearchSearchItemTriggerABusCphySymbolSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. - - **Description:** - - This command specifies the length of the data string in bytes to be used for an CPHY - trigger if the trigger condition is SYMBol. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe? - - **Info:** - - ```` specifies the length of the data string. The default symbol size is 7 - symbols and otherwise ranges between 1 and 14. - """ - return self._size - - @property - def value(self) -> SearchSearchItemTriggerABusCphySymbolValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusCxpiExtdlcValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is SYMBol. The search number is specified by x. + - This command specifies the binary DLC string used for CXPI triggering if the trigger + condition is Ext DLC. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue? **Info:** - - ```` specifies the binary data string. The default data value is XXX. + - ```` is the identifier value. The default size and value of Ext DLC is 8 bits + and 'XXXX XXXX' respectively. """ return self._value -class SearchSearchItemTriggerABusCphyRedValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. +class SearchSearchItemTriggerABusCxpiErrorType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. **Description:** - - This command specifies the red data string used for CPHY triggering if the trigger - condition is on RGB packet. + - This command sets or queries the Error Type in CXPI bus. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe {CRC| PARity| FRAMe| IBS| ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe? **Info:** - - ```` is the identifier value. The default red value is XXXXXXXXXX. + - ``CRC`` specifies CRC as the field within a CXPI frame to search on. + - ``PARity`` specifies PARity as the field within a CXPI frame to search on. The default + Error Type is Parity. + - ``FRAMe`` specifies FRAMe as the field within a CXPI frame to search on. + - ``IBS`` specifies IBS as the field within a CXPI frame to search on. + - ``ANY`` specifies ANY as any type of error within a CXPI frame to search on. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusCphyRed(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. +class SearchSearchItemTriggerABusCxpiError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCphyRedValue(device, f"{self._cmd_syntax}:VALue") + self._type = SearchSearchItemTriggerABusCxpiErrorType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusCphyRedValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusCxpiErrorType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. **Description:** - - This command specifies the red data string used for CPHY triggering if the trigger - condition is on RGB packet. + - This command sets or queries the Error Type in CXPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe {CRC| PARity| FRAMe| IBS| ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe? **Info:** - - ```` is the identifier value. The default red value is XXXXXXXXXX. + - ``CRC`` specifies CRC as the field within a CXPI frame to search on. + - ``PARity`` specifies PARity as the field within a CXPI frame to search on. The default + Error Type is Parity. + - ``FRAMe`` specifies FRAMe as the field within a CXPI frame to search on. + - ``IBS`` specifies IBS as the field within a CXPI frame to search on. + - ``ANY`` specifies ANY as any type of error within a CXPI frame to search on. """ - return self._value - - -class SearchSearchItemTriggerABusCphyPixelSearchoption(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. - - **Description:** - - This command sets or queries the search pattern type for CPHY bus. The default search - pattern type value is PIXELVALue. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion? - - **Info:** - - ``PIXELVALue`` specifies PIXELVALue as the field within a CPHY frame to search on. - - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a CPHY frame to search on. - """ + return self._type -class SearchSearchItemTriggerABusCphyPixelNumber(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. +class SearchSearchItemTriggerABusCxpiDlcValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. **Description:** - - This command specifies the pixel number to be used for CPHY triggering if the trigger - condition is on pixel number pattern. The search number is specified by x. + - This command specifies the binary DLC string used for CXPI triggering if the trigger + condition is DLC. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue? **Info:** - - ```` specifies the pixel number. The default pixel number value is 0. + - ```` is the identifier value. The default size and value of DLC is 4 bits and + 'XXXX' respectively. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusCphyPixel(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. +class SearchSearchItemTriggerABusCxpiDlc(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. - - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._number = SearchSearchItemTriggerABusCphyPixelNumber( - device, f"{self._cmd_syntax}:NUMBer" - ) - self._searchoption = SearchSearchItemTriggerABusCphyPixelSearchoption( - device, f"{self._cmd_syntax}:SEARCHOPTion" - ) - - @property - def number(self) -> SearchSearchItemTriggerABusCphyPixelNumber: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. - - **Description:** - - This command specifies the pixel number to be used for CPHY triggering if the trigger - condition is on pixel number pattern. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer? - - **Info:** - - ```` specifies the pixel number. The default pixel number value is 0. - """ - return self._number + self._value = SearchSearchItemTriggerABusCxpiDlcValue(device, f"{self._cmd_syntax}:VALue") @property - def searchoption(self) -> SearchSearchItemTriggerABusCphyPixelSearchoption: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. + def value(self) -> SearchSearchItemTriggerABusCxpiDlcValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. **Description:** - - This command sets or queries the search pattern type for CPHY bus. The default search - pattern type value is PIXELVALue. + - This command specifies the binary DLC string used for CXPI triggering if the trigger + condition is DLC. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue? **Info:** - - ``PIXELVALue`` specifies PIXELVALue as the field within a CPHY frame to search on. - - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a CPHY frame to search on. + - ```` is the identifier value. The default size and value of DLC is 4 bits and + 'XXXX' respectively. """ - return self._searchoption + return self._value -class SearchSearchItemTriggerABusCphyPacketsType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. +class SearchSearchItemTriggerABusCxpiDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. **Description:** - - This command sets or queries the packet type for CPHY bus. + - This command specifies the binary data string used for CXPI triggering if the trigger + condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe {SHORt|LONG} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue? **Info:** - - ``SHORt`` specifies SHORt as the field within a CPHY frame to search on. SHORt is the - default packet type condition. - - ``LONG`` specifies LONG as the field within a CPHY frame to search on. + - ```` is the identifier value. The default size and value for DATA is 8 bits and + 'XXXX XXXX' respectively. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyPacketsList(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. + +class SearchSearchItemTriggerABusCxpiDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. **Description:** - - This command sets or queries the packet list for CPHY bus. The default packet list - condition is VSYNCSTART. + - This command specifies the length of the data string in bytes to be used for CXPI + triggering if the trigger condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe? **Info:** - - ``VSYNCSTART`` specifies VSYNCSTART as the packet within CPHY frame to search on. - - ``VSYNCEND`` specifies VSYNCEND as the packet within CPHY frame to search on. - - ``HSYNCSTART`` specifies HSYNCSTART as the packet within CPHY frame to search on. - - ``HSYNCEND`` specifies HSYNCEND as the packet within CPHY frame to search on. - - ``EOTP`` specifies EOTP as the packet within CPHY frame to search on. - - ``COLOROFF`` specifies COLOROFF as the packet within CPHY frame to search on. - - ``COLORON`` specifies COLORON as the packet within CPHY frame to search on. - - ``SHUTDOWN`` specifies SHUTDOWN as the packet within CPHY frame to search on. - - ``TURNON`` specifies TURNON as the packet within CPHY frame to search on. - - ``GSW`` specifies GSW as the packet within CPHY frame to search on. - - ``GR`` specifies GR as the packet within CPHY frame to search on. - - ``COMPRESSION`` specifies COMPRESSION as the packet within CPHY frame to search on. - - ``SCRAMBLING`` specifies SCRAMBLING as the packet within CPHY frame to search on. - - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within CPHY frame to search on. - - ``DCSSW`` specifies DCSSW as the packet within CPHY frame to search on. - - ``DCSR`` specifies DCSR as the packet within CPHY frame to search on. - - ``GLONGWRITE`` specifies GLONGWRITE as the packet within CPHY frame to search on. - - ``DSINULL`` specifies DSINULL as the packet within CPHY frame to search on. - - ``DSIBLANk`` specifies DSIBLANk as the packet within CPHY frame to search on. - - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within CPHY frame to search on. - - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within CPHY frame to search on. - - ``PICPARameter`` specifies PICPARameter as the packet within CPHY frame to search on. - - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within CPHY frame to - search on. - - ``PPS101010`` specifies PPS101010 as the packet within CPHY frame to search on. - - ``PPS121212`` specifies PPS121212 as the packet within CPHY frame to search on. - - ``PPS565`` specifies PPS565 as the packet within CPHY frame to search on. - - ``PPS666`` specifies PPS666 as the packet within CPHY frame to search on. - - ``LPS666`` specifies LPS666 as the packet within CPHY frame to search on. - - ``PPS888`` specifies LPS666 as the packet within CPHY frame to search on. - - ``YCBCR24`` specifies YCBCR24 as the packet within CPHY frame to search on. - - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within CPHY frame to search on. - - ``YCBCR16`` specifies YCBCR16 as the packet within CPHY frame to search on. - - ``YCBCR12`` specifies YCBCR12 as the packet within CPHY frame to search on. - - ``ACKNowledge`` specifies ACKNowledge as the packet within CPHY frame to search on. - - ``ERRORREPort`` specifies ERRORREPort as the packet within CPHY frame to search on. - - ``GSRR`` specifies GSRR as the packet within CPHY frame to search on. - - ``GLONGREAD`` specifies GLONGREAD as the packet within CPHY frame to search on. - - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within CPHY frame to search on. - - ``DCSSRR`` specifies DCSSRR as the packet within CPHY frame to search on. - - ``FRAMESTARt`` specifies FRAMESTARt as the packet within CPHY frame to search on. - - ``FRAMEEND`` specifies FRAMEEND as the packet within CPHY frame to search on. - - ``LINESTARt`` specifies LINESTARt as the packet within CPHY frame to search on. - - ``LINEEND`` specifies LINEEND as the packet within CPHY frame to search on. - - ``GSP`` specifies GSP as the packet within CPHY frame to search on. - - ``CSINULL`` specifies CSINULL as the packet within CPHY frame to search on. - - ``CSIBLANk`` specifies CSIBLANk as the packet within CPHY frame to search on. - - ``EMBEDDED`` specifies EMBEDDED as the packet within CPHY frame to search on. - - ``USEREIGHTB`` specifies USEREIGHTB as the packet within CPHY frame to search on. - - ``RGB565`` specifies RGB565 as the packet within CPHY frame to search on. - - ``RGB555`` specifies RGB555 as the packet within CPHY frame to search on. - - ``RGB444`` specifies RGB444 as the packet within CPHY frame to search on. - - ``RGB666`` specifies RGB666 as the packet within CPHY frame to search on. - - ``RAW6`` specifies RAW6 as the packet within CPHY frame to search on. - - ``RAW7`` specifies RAW7 as the packet within CPHY frame to search on. - - ``RAW8`` specifies RAW8 as the packet within CPHY frame to search on. - - ``RAW10`` specifies RAW10 as the packet within CPHY frame to search on. - - ``RAW12`` specifies RAW12 as the packet within CPHY frame to search on. - - ``RAW14`` specifies RAW14 as the packet within CPHY frame to search on. - - ``RAW16`` specifies RAW16 as the packet within CPHY frame to search on. - - ``RAW20`` specifies RAW20 as the packet within CPHY frame to search on. - - ``RGB888`` specifies RGB888 as the packet within CPHY frame to search on. - - ``YUV420L8`` specifies YUV420L8 as the packet within CPHY frame to search on. - - ``YUV8BIT`` specifies YUV8BIT as the packet within CPHY frame to search on. - - ``YUV422B10`` specifies YUV422B10 as the packet within CPHY frame to search on. - - ``YUV420B10`` specifies YUV420B10 as the packet within CPHY frame to search on. - """ # noqa: E501 + - ```` specifies the data size. The default data size is 1 and the calid range is 1 to + 5. + """ -class SearchSearchItemTriggerABusCphyPackets(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. +class SearchSearchItemTriggerABusCxpiData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._list = SearchSearchItemTriggerABusCphyPacketsList(device, f"{self._cmd_syntax}:LIST") - self._type = SearchSearchItemTriggerABusCphyPacketsType(device, f"{self._cmd_syntax}:TYPe") + self._size = SearchSearchItemTriggerABusCxpiDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusCxpiDataValue(device, f"{self._cmd_syntax}:VALue") @property - def list(self) -> SearchSearchItemTriggerABusCphyPacketsList: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. + def size(self) -> SearchSearchItemTriggerABusCxpiDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. **Description:** - - This command sets or queries the packet list for CPHY bus. The default packet list - condition is VSYNCSTART. + - This command specifies the length of the data string in bytes to be used for CXPI + triggering if the trigger condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe? **Info:** - - ``VSYNCSTART`` specifies VSYNCSTART as the packet within CPHY frame to search on. - - ``VSYNCEND`` specifies VSYNCEND as the packet within CPHY frame to search on. - - ``HSYNCSTART`` specifies HSYNCSTART as the packet within CPHY frame to search on. - - ``HSYNCEND`` specifies HSYNCEND as the packet within CPHY frame to search on. - - ``EOTP`` specifies EOTP as the packet within CPHY frame to search on. - - ``COLOROFF`` specifies COLOROFF as the packet within CPHY frame to search on. - - ``COLORON`` specifies COLORON as the packet within CPHY frame to search on. - - ``SHUTDOWN`` specifies SHUTDOWN as the packet within CPHY frame to search on. - - ``TURNON`` specifies TURNON as the packet within CPHY frame to search on. - - ``GSW`` specifies GSW as the packet within CPHY frame to search on. - - ``GR`` specifies GR as the packet within CPHY frame to search on. - - ``COMPRESSION`` specifies COMPRESSION as the packet within CPHY frame to search on. - - ``SCRAMBLING`` specifies SCRAMBLING as the packet within CPHY frame to search on. - - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within CPHY frame to search on. - - ``DCSSW`` specifies DCSSW as the packet within CPHY frame to search on. - - ``DCSR`` specifies DCSR as the packet within CPHY frame to search on. - - ``GLONGWRITE`` specifies GLONGWRITE as the packet within CPHY frame to search on. - - ``DSINULL`` specifies DSINULL as the packet within CPHY frame to search on. - - ``DSIBLANk`` specifies DSIBLANk as the packet within CPHY frame to search on. - - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within CPHY frame to search on. - - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within CPHY frame to search - on. - - ``PICPARameter`` specifies PICPARameter as the packet within CPHY frame to search on. - - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within CPHY frame to - search on. - - ``PPS101010`` specifies PPS101010 as the packet within CPHY frame to search on. - - ``PPS121212`` specifies PPS121212 as the packet within CPHY frame to search on. - - ``PPS565`` specifies PPS565 as the packet within CPHY frame to search on. - - ``PPS666`` specifies PPS666 as the packet within CPHY frame to search on. - - ``LPS666`` specifies LPS666 as the packet within CPHY frame to search on. - - ``PPS888`` specifies LPS666 as the packet within CPHY frame to search on. - - ``YCBCR24`` specifies YCBCR24 as the packet within CPHY frame to search on. - - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within CPHY frame to search on. - - ``YCBCR16`` specifies YCBCR16 as the packet within CPHY frame to search on. - - ``YCBCR12`` specifies YCBCR12 as the packet within CPHY frame to search on. - - ``ACKNowledge`` specifies ACKNowledge as the packet within CPHY frame to search on. - - ``ERRORREPort`` specifies ERRORREPort as the packet within CPHY frame to search on. - - ``GSRR`` specifies GSRR as the packet within CPHY frame to search on. - - ``GLONGREAD`` specifies GLONGREAD as the packet within CPHY frame to search on. - - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within CPHY frame to search on. - - ``DCSSRR`` specifies DCSSRR as the packet within CPHY frame to search on. - - ``FRAMESTARt`` specifies FRAMESTARt as the packet within CPHY frame to search on. - - ``FRAMEEND`` specifies FRAMEEND as the packet within CPHY frame to search on. - - ``LINESTARt`` specifies LINESTARt as the packet within CPHY frame to search on. - - ``LINEEND`` specifies LINEEND as the packet within CPHY frame to search on. - - ``GSP`` specifies GSP as the packet within CPHY frame to search on. - - ``CSINULL`` specifies CSINULL as the packet within CPHY frame to search on. - - ``CSIBLANk`` specifies CSIBLANk as the packet within CPHY frame to search on. - - ``EMBEDDED`` specifies EMBEDDED as the packet within CPHY frame to search on. - - ``USEREIGHTB`` specifies USEREIGHTB as the packet within CPHY frame to search on. - - ``RGB565`` specifies RGB565 as the packet within CPHY frame to search on. - - ``RGB555`` specifies RGB555 as the packet within CPHY frame to search on. - - ``RGB444`` specifies RGB444 as the packet within CPHY frame to search on. - - ``RGB666`` specifies RGB666 as the packet within CPHY frame to search on. - - ``RAW6`` specifies RAW6 as the packet within CPHY frame to search on. - - ``RAW7`` specifies RAW7 as the packet within CPHY frame to search on. - - ``RAW8`` specifies RAW8 as the packet within CPHY frame to search on. - - ``RAW10`` specifies RAW10 as the packet within CPHY frame to search on. - - ``RAW12`` specifies RAW12 as the packet within CPHY frame to search on. - - ``RAW14`` specifies RAW14 as the packet within CPHY frame to search on. - - ``RAW16`` specifies RAW16 as the packet within CPHY frame to search on. - - ``RAW20`` specifies RAW20 as the packet within CPHY frame to search on. - - ``RGB888`` specifies RGB888 as the packet within CPHY frame to search on. - - ``YUV420L8`` specifies YUV420L8 as the packet within CPHY frame to search on. - - ``YUV8BIT`` specifies YUV8BIT as the packet within CPHY frame to search on. - - ``YUV422B10`` specifies YUV422B10 as the packet within CPHY frame to search on. - - ``YUV420B10`` specifies YUV420B10 as the packet within CPHY frame to search on. - """ # noqa: E501 - return self._list + - ```` specifies the data size. The default data size is 1 and the calid range is 1 + to 5. + """ + return self._size @property - def type(self) -> SearchSearchItemTriggerABusCphyPacketsType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. + def value(self) -> SearchSearchItemTriggerABusCxpiDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. **Description:** - - This command sets or queries the packet type for CPHY bus. + - This command specifies the binary data string used for CXPI triggering if the trigger + condition is DATA. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe {SHORt|LONG} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue? **Info:** - - ``SHORt`` specifies SHORt as the field within a CPHY frame to search on. SHORt is the - default packet type condition. - - ``LONG`` specifies LONG as the field within a CPHY frame to search on. + - ```` is the identifier value. The default size and value for DATA is 8 bits + and 'XXXX XXXX' respectively. """ - return self._type + return self._value -class SearchSearchItemTriggerABusCphyModeType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. +class SearchSearchItemTriggerABusCxpiCounterValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. **Description:** - - This command sets or queries the mode type for CPHY bus. + - This command specifies the binary counter string used for CXPI triggering if the trigger + condition is COUNTER. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe {HS|LP} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue? **Info:** - - ``HS`` specifies HS as the mode within a CPHY frame to search on. HS is default mode type - condition. - - ``LP`` specifies LP as the mode within a CPHY frame to search on. + - ```` specifies the binary counter string. The default size and value Counter is 2 + bits and 'XX' respectively. """ -class SearchSearchItemTriggerABusCphyMode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. +class SearchSearchItemTriggerABusCxpiCounter(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusCphyModeType(device, f"{self._cmd_syntax}:TYPe") + self._value = SearchSearchItemTriggerABusCxpiCounterValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def type(self) -> SearchSearchItemTriggerABusCphyModeType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. + def value(self) -> SearchSearchItemTriggerABusCxpiCounterValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. **Description:** - - This command sets or queries the mode type for CPHY bus. + - This command specifies the binary counter string used for CXPI triggering if the + trigger condition is COUNTER. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe {HS|LP} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue? **Info:** - - ``HS`` specifies HS as the mode within a CPHY frame to search on. HS is default mode - type condition. - - ``LP`` specifies LP as the mode within a CPHY frame to search on. + - ```` specifies the binary counter string. The default size and value Counter + is 2 bits and 'XX' respectively. """ - return self._type + return self._value -class SearchSearchItemTriggerABusCphyGreenValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. +class SearchSearchItemTriggerABusCxpiCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. **Description:** - - This command specifies the green data string used for CPHY triggering if the trigger - condition is on RGB packet. + - This command sets or queries the trigger condition for a CXPI bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition {STARt| FRAMes| FRAMEID| PTYPe| DLC| EXTDLC| NETMN| COUNter| DATa| ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition? **Info:** - - ```` is the identifier value. The default green value is XXXXXXXXXX. - """ - - _WRAP_ARG_WITH_QUOTES = True + - ``STARt`` specifies STARt as the event for a CXPI frame to search on. This is the default + value. + - ``FRAMes`` specifies FRAMes as the frame types for CXPI packets to search on. + - ``FRAMEID`` specifies FRAMEID as the field within a CXPI frame to search on. + - ``PTYPe`` specifies PTYPe as the field within a CXPI frame to search on. + - ``DLC`` specifies DLC as the field within a CXPI frame to search on. + - ``EXTDLC`` specifies EXTDLC as the field within a CXPI frame to search on. + - ``NETMN`` specifies NETMN as the field within a CXPI frame to search on. + - ``COUNter`` specifies COUNter as the field within a CXPI frame to search on. + - ``DATa`` specifies DATa as the field within a CXPI frame to search on. + - ``ERRors`` specifies ERRors as type of error within a CXPI frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusCphyGreen(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusCxpi(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query and raise an AssertionError if the - returned value does not match ``value``. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI?`` + query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. + - ``.counter``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. + - ``.dlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. + - ``.extdlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. + - ``.frameid``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. + - ``.frame``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. + - ``.netmn``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCphyGreenValue(device, f"{self._cmd_syntax}:VALue") + self._condition = SearchSearchItemTriggerABusCxpiCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._counter = SearchSearchItemTriggerABusCxpiCounter( + device, f"{self._cmd_syntax}:COUNter" + ) + self._data = SearchSearchItemTriggerABusCxpiData(device, f"{self._cmd_syntax}:DATa") + self._dlc = SearchSearchItemTriggerABusCxpiDlc(device, f"{self._cmd_syntax}:DLC") + self._error = SearchSearchItemTriggerABusCxpiError(device, f"{self._cmd_syntax}:ERROR") + self._extdlc = SearchSearchItemTriggerABusCxpiExtdlc(device, f"{self._cmd_syntax}:EXTDLC") + self._frameid = SearchSearchItemTriggerABusCxpiFrameid( + device, f"{self._cmd_syntax}:FRAMEID" + ) + self._frame = SearchSearchItemTriggerABusCxpiFrame(device, f"{self._cmd_syntax}:FRAMe") + self._netmn = SearchSearchItemTriggerABusCxpiNetmn(device, f"{self._cmd_syntax}:NETMN") @property - def value(self) -> SearchSearchItemTriggerABusCphyGreenValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. + def condition(self) -> SearchSearchItemTriggerABusCxpiCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition`` command. **Description:** - - This command specifies the green data string used for CPHY triggering if the trigger - condition is on RGB packet. + - This command sets or queries the trigger condition for a CXPI bus. The search number + is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition {STARt| FRAMes| FRAMEID| PTYPe| DLC| EXTDLC| NETMN| COUNter| DATa| ERRors} + - SEARCH:SEARCH:TRIGger:A:BUS:CXPI:CONDition? + + **Info:** + - ``STARt`` specifies STARt as the event for a CXPI frame to search on. This is the + default value. + - ``FRAMes`` specifies FRAMes as the frame types for CXPI packets to search on. + - ``FRAMEID`` specifies FRAMEID as the field within a CXPI frame to search on. + - ``PTYPe`` specifies PTYPe as the field within a CXPI frame to search on. + - ``DLC`` specifies DLC as the field within a CXPI frame to search on. + - ``EXTDLC`` specifies EXTDLC as the field within a CXPI frame to search on. + - ``NETMN`` specifies NETMN as the field within a CXPI frame to search on. + - ``COUNter`` specifies COUNter as the field within a CXPI frame to search on. + - ``DATa`` specifies DATa as the field within a CXPI frame to search on. + - ``ERRors`` specifies ERRors as type of error within a CXPI frame to search on. + """ # noqa: E501 + return self._condition + + @property + def counter(self) -> SearchSearchItemTriggerABusCxpiCounter: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:COUNter:VALue`` command. + """ + return self._counter + + @property + def data(self) -> SearchSearchItemTriggerABusCxpiData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue? + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Info:** - - ```` is the identifier value. The default green value is XXXXXXXXXX. + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DATa:VALue`` command. """ - return self._value - + return self._data -class SearchSearchItemTriggerABusCphyEscapemodeCommand(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. + @property + def dlc(self) -> SearchSearchItemTriggerABusCxpiDlc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC`` command tree. - **Description:** - - This command sets or queries the escape mode command type for CPHY bus.. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand value`` command. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:DLC:VALue`` command. + """ + return self._dlc - **SCPI Syntax:** + @property + def error(self) -> SearchSearchItemTriggerABusCxpiError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR?`` query and raise an AssertionError if + the returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand? + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:ERROR:TYPe`` command. + """ + return self._error - **Info:** - - ``LPDT`` specifies LPDT as the field within a CPHY frame to search on. - - ``ULPS`` specifies ULPS as the field within a CPHY frame to search on. - - ``RESETTRIGger`` specifies RESETTRIGger as the field within a CPHY frame to search on. - - ``ANY`` specifies ANY as the field within a CPHY frame to search on. ANY is the default - value. - """ + @property + def extdlc(self) -> SearchSearchItemTriggerABusCxpiExtdlc: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC?`` query and raise an AssertionError if + the returned value does not match ``value``. -class SearchSearchItemTriggerABusCphyEscapemode(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:EXTDLC:VALue`` command. + """ + return self._extdlc - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query and raise an AssertionError if - the returned value does not match ``value``. + @property + def frameid(self) -> SearchSearchItemTriggerABusCxpiFrameid: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID`` command tree. - Properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID?`` query and raise an AssertionError if + the returned value does not match ``value``. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._command = SearchSearchItemTriggerABusCphyEscapemodeCommand( - device, f"{self._cmd_syntax}:COMMand" - ) + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMEID:VALue`` command. + """ + return self._frameid @property - def command(self) -> SearchSearchItemTriggerABusCphyEscapemodeCommand: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. - - **Description:** - - This command sets or queries the escape mode command type for CPHY bus.. + def frame(self) -> SearchSearchItemTriggerABusCxpiFrame: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:FRAMe:TYPe`` command. + """ + return self._frame - :: + @property + def netmn(self) -> SearchSearchItemTriggerABusCxpiNetmn: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Info:** - - ``LPDT`` specifies LPDT as the field within a CPHY frame to search on. - - ``ULPS`` specifies ULPS as the field within a CPHY frame to search on. - - ``RESETTRIGger`` specifies RESETTRIGger as the field within a CPHY frame to search on. - - ``ANY`` specifies ANY as the field within a CPHY frame to search on. ANY is the - default value. + Sub-properties: + - ``.sleepind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:SLEEPIND`` command. + - ``.wakeupind``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI:NETMN:WAKEUPIND`` command. """ - return self._command + return self._netmn -class SearchSearchItemTriggerABusCphyErrorType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. +class SearchSearchItemTriggerABusCphyYuvY(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. **Description:** - - This command sets or queries the error type for CPHY bus. The default error type condition - is ANY. + - This command specifies the Y data string used for CPHY triggering if the trigger condition + is on YUV packet. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe {ANY|ECC|CRC} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y? **Info:** - - ``ANY`` specifies ANY as the field within a CPHY frame to search on. - - ``ECC`` specifies ECC as the field within a CPHY frame to search on. - - ``CRC`` specifies CRC as the field within a CPHY frame to search on. - """ - - -class SearchSearchItemTriggerABusCphyError(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. + - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusCphyErrorType(device, f"{self._cmd_syntax}:TYPe") - - @property - def type(self) -> SearchSearchItemTriggerABusCphyErrorType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. - - **Description:** - - This command sets or queries the error type for CPHY bus. The default error type - condition is ANY. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe {ANY|ECC|CRC} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe? - - **Info:** - - ``ANY`` specifies ANY as the field within a CPHY frame to search on. - - ``ECC`` specifies ECC as the field within a CPHY frame to search on. - - ``CRC`` specifies CRC as the field within a CPHY frame to search on. - """ - return self._type + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyDataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. +class SearchSearchItemTriggerABusCphyYuvV(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is DATA. + - This command specifies the V data string used for CPHY triggering if the trigger condition + is on YUV packet. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. +class SearchSearchItemTriggerABusCphyYuvU(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for an CPHY - trigger if the trigger condition is DATA. + - This command specifies the U data string used for CPHY triggering if the trigger condition + is on YUV packet. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U? **Info:** - - ```` specifies the data size. The default data size is 1 byte and otherwise ranges - between 1 and 5. + - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. + +class SearchSearchItemTriggerABusCphyYuv(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. + - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. + - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._size = SearchSearchItemTriggerABusCphyDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusCphyDataValue(device, f"{self._cmd_syntax}:VALue") + self._u = SearchSearchItemTriggerABusCphyYuvU(device, f"{self._cmd_syntax}:U") + self._v = SearchSearchItemTriggerABusCphyYuvV(device, f"{self._cmd_syntax}:V") + self._y = SearchSearchItemTriggerABusCphyYuvY(device, f"{self._cmd_syntax}:Y") @property - def size(self) -> SearchSearchItemTriggerABusCphyDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. + def u(self) -> SearchSearchItemTriggerABusCphyYuvU: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. **Description:** - - This command specifies the length of the data string in bytes to be used for an CPHY - trigger if the trigger condition is DATA. + - This command specifies the U data string used for CPHY triggering if the trigger + condition is on YUV packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U? **Info:** - - ```` specifies the data size. The default data size is 1 byte and otherwise - ranges between 1 and 5. + - ```` is the identifier value. The default YUV packets U value is XXXXXXXXXX. """ - return self._size + return self._u @property - def value(self) -> SearchSearchItemTriggerABusCphyDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. + def v(self) -> SearchSearchItemTriggerABusCphyYuvV: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. **Description:** - - This command specifies the binary data string used for CPHY triggering if the trigger - condition is DATA. + - This command specifies the V data string used for CPHY triggering if the trigger + condition is on YUV packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V? **Info:** - - ```` is the identifier value. The default value is XXXXXXXX. + - ```` is the identifier value. The default YUV packets V value is XXXXXXXXXX. """ - return self._value + return self._v + @property + def y(self) -> SearchSearchItemTriggerABusCphyYuvY: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. -class SearchSearchItemTriggerABusCphyCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. + **Description:** + - This command specifies the Y data string used for CPHY triggering if the trigger + condition is on YUV packet. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y? + + **Info:** + - ```` is the identifier value. The default YUV packets Y value is XXXXXXXXXX. + """ + return self._y + + +class SearchSearchItemTriggerABusCphyYcbcrY(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. **Description:** - - This command sets or queries the trigger condition for an CPHY bus. The default trigger on - condition is SOT. + - This command specifies the Y data string used for CPHY triggering if the trigger condition + is on YCbCr packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe| WORD| SYMBol} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y? **Info:** - - ``SOT`` specifies SOT as the field within a CPHY frame to search on. - - ``EOT`` specifies EOT as the field within a CPHY frame to search on. - - ``DATa`` specifies DATa as the field within a CPHY frame to search on. - - ``EOTPDATa`` specifies EOTPDATa as the field within a CPHY frame to search on. - - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a CPHY frame to search on. - - ``SCRambling`` specifies SCRambling as the field within a CPHY frame to search on. - - ``COMPression`` specifies COMPression as the field within a CPHY frame to search on. - - ``PACKets`` specifies PACKets as the field within a CPHY frame to search on. - - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a CPHY frame to search on. - - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a CPHY frame to search on. - - ``STop`` specifies STop as the field within a CPHY frame to search on. - - ``ERRors`` specifies ERRors as the field within a CPHY frame to search on. - - ``MODe`` specifies MODe as the field within a CPHY frame to search on. - - ``WORD`` specifies WORD as the field within a CPHY frame to search on. - - ``SYMBol`` specifies SYMBol as the field within a CPHY frame to search on. - """ # noqa: E501 + - ```` is the identifier value. The default YCBCR packets Y value is XXXXXXXXXX. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyBlueValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. + +class SearchSearchItemTriggerABusCphyYcbcrCr(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. **Description:** - - This command specifies the blue data string used for CPHY triggering if the trigger - condition is on RGB packet. + - This command specifies the Cr data string used for CPHY triggering if the trigger + condition is on YCbCr packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR? **Info:** - - ```` is the identifier value. The default blue value is XXXXXXXXXX. + - ```` is the identifier value. The default YCBCR packets CR value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCphyBlue(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. +class SearchSearchItemTriggerABusCphyYcbcrCb(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. + + **Description:** + - This command specifies the Cb data string used for CPHY triggering if the trigger + condition is on YCbCr packet. The search number is specified by x. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusCphyBlueValue(device, f"{self._cmd_syntax}:VALue") - - @property - def value(self) -> SearchSearchItemTriggerABusCphyBlueValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. - - **Description:** - - This command specifies the blue data string used for CPHY triggering if the trigger - condition is on RGB packet. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue value`` command. + **SCPI Syntax:** - **SCPI Syntax:** + :: - :: + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB? - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue? + **Info:** + - ```` is the identifier value. The default YCBCR packets CB value is XXXXXXXXXX. + """ - **Info:** - - ```` is the identifier value. The default blue value is XXXXXXXXXX. - """ - return self._value + _WRAP_ARG_WITH_QUOTES = True -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusCphy(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY`` command tree. +class SearchSearchItemTriggerABusCphyYcbcr(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY?`` - query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.blue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. - - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. - - ``.escapemode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. - - ``.green``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. - - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. - - ``.packets``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. - - ``.pixel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. - - ``.red``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. - - ``.symbol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. - - ``.word``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. - - ``.wordcount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. - - ``.ycbcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. - - ``.yuv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. + - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. + - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._blue = SearchSearchItemTriggerABusCphyBlue(device, f"{self._cmd_syntax}:BLUe") - self._condition = SearchSearchItemTriggerABusCphyCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusCphyData(device, f"{self._cmd_syntax}:DATa") - self._error = SearchSearchItemTriggerABusCphyError(device, f"{self._cmd_syntax}:ERRor") - self._escapemode = SearchSearchItemTriggerABusCphyEscapemode( - device, f"{self._cmd_syntax}:ESCAPEMODe" - ) - self._green = SearchSearchItemTriggerABusCphyGreen(device, f"{self._cmd_syntax}:GREen") - self._mode = SearchSearchItemTriggerABusCphyMode(device, f"{self._cmd_syntax}:MODe") - self._packets = SearchSearchItemTriggerABusCphyPackets( - device, f"{self._cmd_syntax}:PACKets" - ) - self._pixel = SearchSearchItemTriggerABusCphyPixel(device, f"{self._cmd_syntax}:PIXel") - self._red = SearchSearchItemTriggerABusCphyRed(device, f"{self._cmd_syntax}:RED") - self._symbol = SearchSearchItemTriggerABusCphySymbol(device, f"{self._cmd_syntax}:SYMBol") - self._word = SearchSearchItemTriggerABusCphyWord(device, f"{self._cmd_syntax}:WORD") - self._wordcount = SearchSearchItemTriggerABusCphyWordcount( - device, f"{self._cmd_syntax}:WORDCOUNt" - ) - self._ycbcr = SearchSearchItemTriggerABusCphyYcbcr(device, f"{self._cmd_syntax}:YCBCR") - self._yuv = SearchSearchItemTriggerABusCphyYuv(device, f"{self._cmd_syntax}:YUV") - - @property - def blue(self) -> SearchSearchItemTriggerABusCphyBlue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. - """ - return self._blue + self._cb = SearchSearchItemTriggerABusCphyYcbcrCb(device, f"{self._cmd_syntax}:CB") + self._cr = SearchSearchItemTriggerABusCphyYcbcrCr(device, f"{self._cmd_syntax}:CR") + self._y = SearchSearchItemTriggerABusCphyYcbcrY(device, f"{self._cmd_syntax}:Y") @property - def condition(self) -> SearchSearchItemTriggerABusCphyCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. + def cb(self) -> SearchSearchItemTriggerABusCphyYcbcrCb: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. **Description:** - - This command sets or queries the trigger condition for an CPHY bus. The default - trigger on condition is SOT. + - This command specifies the Cb data string used for CPHY triggering if the trigger + condition is on YCbCr packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe| WORD| SYMBol} - - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB? **Info:** - - ``SOT`` specifies SOT as the field within a CPHY frame to search on. - - ``EOT`` specifies EOT as the field within a CPHY frame to search on. - - ``DATa`` specifies DATa as the field within a CPHY frame to search on. - - ``EOTPDATa`` specifies EOTPDATa as the field within a CPHY frame to search on. - - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a CPHY frame to search - on. - - ``SCRambling`` specifies SCRambling as the field within a CPHY frame to search on. - - ``COMPression`` specifies COMPression as the field within a CPHY frame to search on. - - ``PACKets`` specifies PACKets as the field within a CPHY frame to search on. - - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a CPHY frame to search - on. - - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a CPHY frame to search on. - - ``STop`` specifies STop as the field within a CPHY frame to search on. - - ``ERRors`` specifies ERRors as the field within a CPHY frame to search on. - - ``MODe`` specifies MODe as the field within a CPHY frame to search on. - - ``WORD`` specifies WORD as the field within a CPHY frame to search on. - - ``SYMBol`` specifies SYMBol as the field within a CPHY frame to search on. - """ # noqa: E501 - return self._condition - - @property - def data(self) -> SearchSearchItemTriggerABusCphyData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. + - ```` is the identifier value. The default YCBCR packets CB value is + XXXXXXXXXX. """ - return self._data + return self._cb @property - def error(self) -> SearchSearchItemTriggerABusCphyError: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. + def cr(self) -> SearchSearchItemTriggerABusCphyYcbcrCr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. + + **Description:** + - This command specifies the Cr data string used for CPHY triggering if the trigger + condition is on YCbCr packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR value`` command. - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. - """ - return self._error + **SCPI Syntax:** - @property - def escapemode(self) -> SearchSearchItemTriggerABusCphyEscapemode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query and raise an AssertionError - if the returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR? - Sub-properties: - - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. + **Info:** + - ```` is the identifier value. The default YCBCR packets CR value is + XXXXXXXXXX. """ - return self._escapemode + return self._cr @property - def green(self) -> SearchSearchItemTriggerABusCphyGreen: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. + def y(self) -> SearchSearchItemTriggerABusCphyYcbcrY: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. + + **Description:** + - This command specifies the Y data string used for CPHY triggering if the trigger + condition is on YCbCr packet. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. - """ - return self._green + **SCPI Syntax:** - @property - def mode(self) -> SearchSearchItemTriggerABusCphyMode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query and raise an AssertionError if the - returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y? - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. + **Info:** + - ```` is the identifier value. The default YCBCR packets Y value is + XXXXXXXXXX. """ - return self._mode - - @property - def packets(self) -> SearchSearchItemTriggerABusCphyPackets: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. + return self._y - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query and raise an AssertionError if - the returned value does not match ``value``. - Sub-properties: - - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. - """ - return self._packets +class SearchSearchItemTriggerABusCphyWordcountValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. - @property - def pixel(self) -> SearchSearchItemTriggerABusCphyPixel: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. + **Description:** + - This command specifies the word count data string used for CPHY triggering if the trigger + condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query and raise an AssertionError if - the returned value does not match ``value``. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue value`` command. - Sub-properties: - - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. - - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` - command. - """ - return self._pixel + **SCPI Syntax:** - @property - def red(self) -> SearchSearchItemTriggerABusCphyRed: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query and raise an AssertionError if the - returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue? - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. - """ - return self._red + **Info:** + - ```` specifies the word count data string. The default data value is + XXXXXXXXXXXXXXXX. + """ - @property - def symbol(self) -> SearchSearchItemTriggerABusCphySymbol: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. + _WRAP_ARG_WITH_QUOTES = True - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query and raise an AssertionError if - the returned value does not match ``value``. - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. - """ - return self._symbol +class SearchSearchItemTriggerABusCphyWordcount(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. - @property - def word(self) -> SearchSearchItemTriggerABusCphyWord: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query and raise an AssertionError if the - returned value does not match ``value``. + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. + """ - Sub-properties: - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. - """ - return self._word + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusCphyWordcountValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def wordcount(self) -> SearchSearchItemTriggerABusCphyWordcount: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. - """ - return self._wordcount + def value(self) -> SearchSearchItemTriggerABusCphyWordcountValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. - @property - def ycbcr(self) -> SearchSearchItemTriggerABusCphyYcbcr: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. + **Description:** + - This command specifies the word count data string used for CPHY triggering if the + trigger condition is on any rgb/ycbcr/yuv packet. The search number is specified by + x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue value`` command. - Sub-properties: - - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. - - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. - """ - return self._ycbcr + **SCPI Syntax:** - @property - def yuv(self) -> SearchSearchItemTriggerABusCphyYuv: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. + :: - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query and raise an AssertionError if the - returned value does not match ``value``. + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue? - Sub-properties: - - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. - - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. - - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. + **Info:** + - ```` specifies the word count data string. The default data value is + XXXXXXXXXXXXXXXX. """ - return self._yuv + return self._value -class SearchSearchItemTriggerABusCanIdentifierValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. +class SearchSearchItemTriggerABusCphyWordValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. **Description:** - - This command sets or queries CAN bus trigger identifier (address) value to be used when - searching on a CAN bus signal. The search number is specified by x. The search condition - must be set to IDANDDATA or DATA. + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is Word. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue? **Info:** - - ```` is the identifier value. + - ```` specifies the binary data string. The default data value is + XXXXXXXXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCanIdentifierMode(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. +class SearchSearchItemTriggerABusCphyWordSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. **Description:** - - This command sets or queries the CAN bus trigger identifier (address) mode to be used when - searching on a CAN bus signal. The search number is specified by x. The search condition - must be set to IDANDDATA or DATA. + - This command specifies the length of the word string in bytes to be used for an CPHY + trigger if the trigger condition is WORD. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe {EXTENDed|STandard} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe? **Info:** - - ``EXTENDed`` specifies the extended identifier mode. - - ``STandard`` specifies the standard identifier mode. + - ```` specifies the length of the data string. The default word size is 1 byte and + otherwise ranges between 1 and 5. """ -class SearchSearchItemTriggerABusCanIdentifier(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. +class SearchSearchItemTriggerABusCphyWord(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._mode = SearchSearchItemTriggerABusCanIdentifierMode( - device, f"{self._cmd_syntax}:MODe" - ) - self._value = SearchSearchItemTriggerABusCanIdentifierValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._size = SearchSearchItemTriggerABusCphyWordSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusCphyWordValue(device, f"{self._cmd_syntax}:VALue") @property - def mode(self) -> SearchSearchItemTriggerABusCanIdentifierMode: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. + def size(self) -> SearchSearchItemTriggerABusCphyWordSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. **Description:** - - This command sets or queries the CAN bus trigger identifier (address) mode to be used - when searching on a CAN bus signal. The search number is specified by x. The search - condition must be set to IDANDDATA or DATA. + - This command specifies the length of the word string in bytes to be used for an CPHY + trigger if the trigger condition is WORD. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe {EXTENDed|STandard} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe? **Info:** - - ``EXTENDed`` specifies the extended identifier mode. - - ``STandard`` specifies the standard identifier mode. + - ```` specifies the length of the data string. The default word size is 1 byte and + otherwise ranges between 1 and 5. """ - return self._mode + return self._size @property - def value(self) -> SearchSearchItemTriggerABusCanIdentifierValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusCphyWordValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. **Description:** - - This command sets or queries CAN bus trigger identifier (address) value to be used - when searching on a CAN bus signal. The search number is specified by x. The search - condition must be set to IDANDDATA or DATA. + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is Word. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue? - - **Info:** - - ```` is the identifier value. - """ - return self._value - - -class SearchSearchItemTriggerABusCanFrametype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. - - **Description:** - - This command sets or queries CAN bus trigger frame type to be used when searching on a CAN - bus signal. The search condition must be set to FRAMEtype. The search number is specified - by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue value`` command. - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype {DATa|ERRor|OVERLoad|REMote} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue? - **Info:** - - ``DATa`` sets the frame type to data. - - ``ERRor`` sets the frame type to error. - - ``OVERLoad`` sets the frame type to overload. - - ``REMote`` sets the frame type to remote. - """ + **Info:** + - ```` specifies the binary data string. The default data value is + XXXXXXXXXXXXXXXX. + """ + return self._value -class SearchSearchItemTriggerABusCanFdEsibit(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. +class SearchSearchItemTriggerABusCphySymbolValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. **Description:** - - This command sets or queries the value of the error state indicator bit (ESI bit) for a - CAN bus to search on. The search number is specified by x. The search condition must be - set to FDBITS, and the CAN standard must be FDISO or FDNONISO. + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is SYMBol. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue? **Info:** - - ``ONE`` filters CAN FD packets to only match those where the ESI bit has a value of 1 - (recessive). - - ``ZERo`` filters CAN FD packets to only match those where the ESI bit has a value of 0 - (dominant). - - ``NOCARE`` disables filtering of CAN FD packets on the ESI bit. + - ```` specifies the binary data string. The default data value is XXX. """ + _WRAP_ARG_WITH_QUOTES = True + -class SearchSearchItemTriggerABusCanFdBrsbit(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. +class SearchSearchItemTriggerABusCphySymbolSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. **Description:** - - This command sets or queries the value of the bit rate switch bit (BRS bit) for a CAN bus - to search on. The search number is specified by x. The search condition must be set to - FDBITS, and the CAN standard must be FDISO or FDNONISO. + - This command specifies the length of the data string in bytes to be used for an CPHY + trigger if the trigger condition is SYMBol. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe? **Info:** - - ``ONE`` filters CAN FD packets to only match those where the BRS bit has a value of 1 - (fast data enabled). - - ``ZERo`` filters CAN FD packets to only match those where the BRS bit has a value of 0 - (fast data disabled). - - ``NOCARE`` disables filtering of CAN FD packets on the BRS bit. + - ```` specifies the length of the data string. The default symbol size is 7 symbols + and otherwise ranges between 1 and 14. """ -class SearchSearchItemTriggerABusCanFd(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. +class SearchSearchItemTriggerABusCphySymbol(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.brsbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. - - ``.esibit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._brsbit = SearchSearchItemTriggerABusCanFdBrsbit(device, f"{self._cmd_syntax}:BRSBit") - self._esibit = SearchSearchItemTriggerABusCanFdEsibit(device, f"{self._cmd_syntax}:ESIBit") + self._size = SearchSearchItemTriggerABusCphySymbolSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusCphySymbolValue( + device, f"{self._cmd_syntax}:VALue" + ) @property - def brsbit(self) -> SearchSearchItemTriggerABusCanFdBrsbit: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. + def size(self) -> SearchSearchItemTriggerABusCphySymbolSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. **Description:** - - This command sets or queries the value of the bit rate switch bit (BRS bit) for a CAN - bus to search on. The search number is specified by x. The search condition must be - set to FDBITS, and the CAN standard must be FDISO or FDNONISO. + - This command specifies the length of the data string in bytes to be used for an CPHY + trigger if the trigger condition is SYMBol. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe? **Info:** - - ``ONE`` filters CAN FD packets to only match those where the BRS bit has a value of 1 - (fast data enabled). - - ``ZERo`` filters CAN FD packets to only match those where the BRS bit has a value of 0 - (fast data disabled). - - ``NOCARE`` disables filtering of CAN FD packets on the BRS bit. + - ```` specifies the length of the data string. The default symbol size is 7 + symbols and otherwise ranges between 1 and 14. """ - return self._brsbit + return self._size @property - def esibit(self) -> SearchSearchItemTriggerABusCanFdEsibit: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. + def value(self) -> SearchSearchItemTriggerABusCphySymbolValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. **Description:** - - This command sets or queries the value of the error state indicator bit (ESI bit) for - a CAN bus to search on. The search number is specified by x. The search condition must - be set to FDBITS, and the CAN standard must be FDISO or FDNONISO. + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is SYMBol. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit {ONE|ZERo|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue? **Info:** - - ``ONE`` filters CAN FD packets to only match those where the ESI bit has a value of 1 - (recessive). - - ``ZERo`` filters CAN FD packets to only match those where the ESI bit has a value of 0 - (dominant). - - ``NOCARE`` disables filtering of CAN FD packets on the ESI bit. + - ```` specifies the binary data string. The default data value is XXX. """ - return self._esibit + return self._value -class SearchSearchItemTriggerABusCanErrtype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. +class SearchSearchItemTriggerABusCphyRedValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. **Description:** - - This command sets or queries the type of error condition for a CAN bus to search on. The - search number is specified by x. The search condition must be set to ERRor. + - This command specifies the red data string used for CPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType {ACKMISS|BITSTUFFing|FORMERRor |ANYERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue? **Info:** - - ``ACKMISS`` specifies a search based on a missing ACK field. - - ``BITSTUFFing`` specifies a search based on a bit stuffing error. - - ``FORMERRor`` specifies a search based on a CAN FD form error. To use this option, the CAN - standard must be set to FDISO or FDNONISO. - - ``ANYERRor`` specifies a search based on any error type. + - ```` is the identifier value. The default red value is XXXXXXXXXX. """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. - **Description:** - - This command sets or queries the binary data value to be used when searching on a CAN bus - signal. The search condition must be set to IDANDDATA OR DATA. +class SearchSearchItemTriggerABusCphyRed(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. **Usage:** - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query and raise an AssertionError if the + returned value does not match ``value``. - **SCPI Syntax:** + Properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. + """ - :: + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._value = SearchSearchItemTriggerABusCphyRedValue(device, f"{self._cmd_syntax}:VALue") - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + @property + def value(self) -> SearchSearchItemTriggerABusCphyRedValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. - **Info:** - - ```` - """ + **Description:** + - This command specifies the red data string used for CPHY triggering if the trigger + condition is on RGB packet. - _WRAP_ARG_WITH_QUOTES = True + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue value`` command. + **SCPI Syntax:** -class SearchSearchItemTriggerABusCanDataSize(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue? + + **Info:** + - ```` is the identifier value. The default red value is XXXXXXXXXX. + """ + return self._value + + +class SearchSearchItemTriggerABusCphyPixelSearchoption(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. **Description:** - - This command sets or queries the length of the data string, in bytes, to be used when - searching on a CAN bus signal. The search condition must be set to IDANDDATA or DATA. The - search number is specified by x. + - This command sets or queries the search pattern type for CPHY bus. The default search + pattern type value is PIXELVALue. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion? **Info:** - - ```` specifies the data size. + - ``PIXELVALue`` specifies PIXELVALue as the field within a CPHY frame to search on. + - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a CPHY frame to search on. """ -class SearchSearchItemTriggerABusCanDataQualifier(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. +class SearchSearchItemTriggerABusCphyPixelNumber(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. **Description:** - - This command sets or queries the CAN bus trigger data qualifier to be used when searching - on a CAN bus signal. The search number is specified by x. + - This command specifies the pixel number to be used for CPHY triggering if the trigger + condition is on pixel number pattern. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier {EQUal|LESSEQual|MOREEQua|UNEQual|LESSthan|MOREthan} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer? **Info:** - - ``EQUal`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQua`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - """ # noqa: E501 + - ```` specifies the pixel number. The default pixel number value is 0. + """ -class SearchSearchItemTriggerABusCanDataOffset(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. +class SearchSearchItemTriggerABusCphyPixel(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Properties: + - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. + - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. + """ + + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._number = SearchSearchItemTriggerABusCphyPixelNumber( + device, f"{self._cmd_syntax}:NUMBer" + ) + self._searchoption = SearchSearchItemTriggerABusCphyPixelSearchoption( + device, f"{self._cmd_syntax}:SEARCHOPTion" + ) + + @property + def number(self) -> SearchSearchItemTriggerABusCphyPixelNumber: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. + + **Description:** + - This command specifies the pixel number to be used for CPHY triggering if the trigger + condition is on pixel number pattern. The search number is specified by x. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer? + + **Info:** + - ```` specifies the pixel number. The default pixel number value is 0. + """ + return self._number + + @property + def searchoption(self) -> SearchSearchItemTriggerABusCphyPixelSearchoption: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` command. + + **Description:** + - This command sets or queries the search pattern type for CPHY bus. The default search + pattern type value is PIXELVALue. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion {PIXELVALue|PIXELNUMBer} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion? + + **Info:** + - ``PIXELVALue`` specifies PIXELVALue as the field within a CPHY frame to search on. + - ``PIXELNUMBer`` specifies PIXELNUMBer as the field within a CPHY frame to search on. + """ + return self._searchoption + + +class SearchSearchItemTriggerABusCphyPacketsType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. **Description:** - - This command sets or queries the data offset value, in bytes, to use when searching on the - CAN data field. The search number is specified by x. The search condition must be set to - DATA or IDANDDATA. + - This command sets or queries the packet type for CPHY bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe {SHORt|LONG} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe? **Info:** - - ```` is an integer whose minimum and default values are -1 (don't care) and maximum - is up to 7 (for CAN 2.0) or up to 63 (for ISO CAN FD and Non-ISO CAN FD). The maximum is - dependent on the number of bytes being matched and the CAN standard selected. Its value is - calculated as [Absolute Maximum] - [Data Match Size]. For CAN 2.0, the absolute maximum is - 8 bytes. For ISO CAN FD and Non-ISO CAN FD, the absolute maximum is 64 bytes. The minimum - data match size is 1 byte, which produces the ranges listed above. Increasing the data - match size above 1 byte will adjust the range of valid data offset values accordingly. + - ``SHORt`` specifies SHORt as the field within a CPHY frame to search on. SHORt is the + default packet type condition. + - ``LONG`` specifies LONG as the field within a CPHY frame to search on. """ -class SearchSearchItemTriggerABusCanDataDirection(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. +class SearchSearchItemTriggerABusCphyPacketsList(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. **Description:** - - This command specifies the CAN search type to be valid on a Read, Write, or Either - condition. The search number is specified by x. + - This command sets or queries the packet list for CPHY bus. The default packet list + condition is VSYNCSTART. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection {READ|WRITE|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST? **Info:** - - ``READ`` specifies the read direction. - - ``WRITE`` specifies the write direction. - - ``NOCARE`` specifies either data direction. - """ + - ``VSYNCSTART`` specifies VSYNCSTART as the packet within CPHY frame to search on. + - ``VSYNCEND`` specifies VSYNCEND as the packet within CPHY frame to search on. + - ``HSYNCSTART`` specifies HSYNCSTART as the packet within CPHY frame to search on. + - ``HSYNCEND`` specifies HSYNCEND as the packet within CPHY frame to search on. + - ``EOTP`` specifies EOTP as the packet within CPHY frame to search on. + - ``COLOROFF`` specifies COLOROFF as the packet within CPHY frame to search on. + - ``COLORON`` specifies COLORON as the packet within CPHY frame to search on. + - ``SHUTDOWN`` specifies SHUTDOWN as the packet within CPHY frame to search on. + - ``TURNON`` specifies TURNON as the packet within CPHY frame to search on. + - ``GSW`` specifies GSW as the packet within CPHY frame to search on. + - ``GR`` specifies GR as the packet within CPHY frame to search on. + - ``COMPRESSION`` specifies COMPRESSION as the packet within CPHY frame to search on. + - ``SCRAMBLING`` specifies SCRAMBLING as the packet within CPHY frame to search on. + - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within CPHY frame to search on. + - ``DCSSW`` specifies DCSSW as the packet within CPHY frame to search on. + - ``DCSR`` specifies DCSR as the packet within CPHY frame to search on. + - ``GLONGWRITE`` specifies GLONGWRITE as the packet within CPHY frame to search on. + - ``DSINULL`` specifies DSINULL as the packet within CPHY frame to search on. + - ``DSIBLANk`` specifies DSIBLANk as the packet within CPHY frame to search on. + - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within CPHY frame to search on. + - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within CPHY frame to search on. + - ``PICPARameter`` specifies PICPARameter as the packet within CPHY frame to search on. + - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within CPHY frame to + search on. + - ``PPS101010`` specifies PPS101010 as the packet within CPHY frame to search on. + - ``PPS121212`` specifies PPS121212 as the packet within CPHY frame to search on. + - ``PPS565`` specifies PPS565 as the packet within CPHY frame to search on. + - ``PPS666`` specifies PPS666 as the packet within CPHY frame to search on. + - ``LPS666`` specifies LPS666 as the packet within CPHY frame to search on. + - ``PPS888`` specifies LPS666 as the packet within CPHY frame to search on. + - ``YCBCR24`` specifies YCBCR24 as the packet within CPHY frame to search on. + - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within CPHY frame to search on. + - ``YCBCR16`` specifies YCBCR16 as the packet within CPHY frame to search on. + - ``YCBCR12`` specifies YCBCR12 as the packet within CPHY frame to search on. + - ``ACKNowledge`` specifies ACKNowledge as the packet within CPHY frame to search on. + - ``ERRORREPort`` specifies ERRORREPort as the packet within CPHY frame to search on. + - ``GSRR`` specifies GSRR as the packet within CPHY frame to search on. + - ``GLONGREAD`` specifies GLONGREAD as the packet within CPHY frame to search on. + - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within CPHY frame to search on. + - ``DCSSRR`` specifies DCSSRR as the packet within CPHY frame to search on. + - ``FRAMESTARt`` specifies FRAMESTARt as the packet within CPHY frame to search on. + - ``FRAMEEND`` specifies FRAMEEND as the packet within CPHY frame to search on. + - ``LINESTARt`` specifies LINESTARt as the packet within CPHY frame to search on. + - ``LINEEND`` specifies LINEEND as the packet within CPHY frame to search on. + - ``GSP`` specifies GSP as the packet within CPHY frame to search on. + - ``CSINULL`` specifies CSINULL as the packet within CPHY frame to search on. + - ``CSIBLANk`` specifies CSIBLANk as the packet within CPHY frame to search on. + - ``EMBEDDED`` specifies EMBEDDED as the packet within CPHY frame to search on. + - ``USEREIGHTB`` specifies USEREIGHTB as the packet within CPHY frame to search on. + - ``RGB565`` specifies RGB565 as the packet within CPHY frame to search on. + - ``RGB555`` specifies RGB555 as the packet within CPHY frame to search on. + - ``RGB444`` specifies RGB444 as the packet within CPHY frame to search on. + - ``RGB666`` specifies RGB666 as the packet within CPHY frame to search on. + - ``RAW6`` specifies RAW6 as the packet within CPHY frame to search on. + - ``RAW7`` specifies RAW7 as the packet within CPHY frame to search on. + - ``RAW8`` specifies RAW8 as the packet within CPHY frame to search on. + - ``RAW10`` specifies RAW10 as the packet within CPHY frame to search on. + - ``RAW12`` specifies RAW12 as the packet within CPHY frame to search on. + - ``RAW14`` specifies RAW14 as the packet within CPHY frame to search on. + - ``RAW16`` specifies RAW16 as the packet within CPHY frame to search on. + - ``RAW20`` specifies RAW20 as the packet within CPHY frame to search on. + - ``RGB888`` specifies RGB888 as the packet within CPHY frame to search on. + - ``YUV420L8`` specifies YUV420L8 as the packet within CPHY frame to search on. + - ``YUV8BIT`` specifies YUV8BIT as the packet within CPHY frame to search on. + - ``YUV422B10`` specifies YUV422B10 as the packet within CPHY frame to search on. + - ``YUV420B10`` specifies YUV420B10 as the packet within CPHY frame to search on. + """ # noqa: E501 -class SearchSearchItemTriggerABusCanData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. +class SearchSearchItemTriggerABusCphyPackets(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` - query. + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query and raise an AssertionError if the returned value does not match ``value``. - Properties: - - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. + Properties: + - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._direction = SearchSearchItemTriggerABusCanDataDirection( - device, f"{self._cmd_syntax}:DIRection" - ) - self._offset = SearchSearchItemTriggerABusCanDataOffset( - device, f"{self._cmd_syntax}:OFFSet" - ) - self._qualifier = SearchSearchItemTriggerABusCanDataQualifier( - device, f"{self._cmd_syntax}:QUALifier" - ) - self._size = SearchSearchItemTriggerABusCanDataSize(device, f"{self._cmd_syntax}:SIZe") - self._value = SearchSearchItemTriggerABusCanDataValue(device, f"{self._cmd_syntax}:VALue") + self._list = SearchSearchItemTriggerABusCphyPacketsList(device, f"{self._cmd_syntax}:LIST") + self._type = SearchSearchItemTriggerABusCphyPacketsType(device, f"{self._cmd_syntax}:TYPe") @property - def direction(self) -> SearchSearchItemTriggerABusCanDataDirection: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. + def list(self) -> SearchSearchItemTriggerABusCphyPacketsList: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. **Description:** - - This command specifies the CAN search type to be valid on a Read, Write, or Either - condition. The search number is specified by x. + - This command sets or queries the packet list for CPHY bus. The default packet list + condition is VSYNCSTART. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection {READ|WRITE|NOCARE} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST {VSYNCSTART| VSYNCEND| HSYNCSTART| HSYNCEND| EOTP| COLOROFF| COLORON| SHUTDOWN| TURNON| GSW| GR| COMPRESSION| SCRAMBLING| EXECUTEQUEue| DCSSW| DCSR| GLONGWRITE| DSINULL| DSIBLANk| MAXRETSIZE| DCSGLONGWRITE| PICPARameter| COMPRESSEDPSTReam| PPS101010| PPS121212| PPS565| PPS666| LPS666| PPS888| YCBCR24| LPYCBCR24| YCBCR16| YCBCR12| ACKNowledge| ERRORREPort| GSRR| GLONGREAD| DCSLONGREAD| DCSSRR| FRAMESTARt| FRAMEEND| LINESTARt| LINEEND| GSP| CSINULL| CSIBLANk| EMBEDDED| USEREIGHTB| RGB565| RGB555| RGB444| RGB666| RAW6| RAW7| RAW8| RAW10| RAW12| RAW14| RAW16| RAW20| RGB888| YUV420L8| YUV8BIT| YUV422B10| YUV420B10} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST? **Info:** - - ``READ`` specifies the read direction. - - ``WRITE`` specifies the write direction. - - ``NOCARE`` specifies either data direction. - """ - return self._direction + - ``VSYNCSTART`` specifies VSYNCSTART as the packet within CPHY frame to search on. + - ``VSYNCEND`` specifies VSYNCEND as the packet within CPHY frame to search on. + - ``HSYNCSTART`` specifies HSYNCSTART as the packet within CPHY frame to search on. + - ``HSYNCEND`` specifies HSYNCEND as the packet within CPHY frame to search on. + - ``EOTP`` specifies EOTP as the packet within CPHY frame to search on. + - ``COLOROFF`` specifies COLOROFF as the packet within CPHY frame to search on. + - ``COLORON`` specifies COLORON as the packet within CPHY frame to search on. + - ``SHUTDOWN`` specifies SHUTDOWN as the packet within CPHY frame to search on. + - ``TURNON`` specifies TURNON as the packet within CPHY frame to search on. + - ``GSW`` specifies GSW as the packet within CPHY frame to search on. + - ``GR`` specifies GR as the packet within CPHY frame to search on. + - ``COMPRESSION`` specifies COMPRESSION as the packet within CPHY frame to search on. + - ``SCRAMBLING`` specifies SCRAMBLING as the packet within CPHY frame to search on. + - ``EXECUTEQUEue`` specifies EXECUTEQUEue as the packet within CPHY frame to search on. + - ``DCSSW`` specifies DCSSW as the packet within CPHY frame to search on. + - ``DCSR`` specifies DCSR as the packet within CPHY frame to search on. + - ``GLONGWRITE`` specifies GLONGWRITE as the packet within CPHY frame to search on. + - ``DSINULL`` specifies DSINULL as the packet within CPHY frame to search on. + - ``DSIBLANk`` specifies DSIBLANk as the packet within CPHY frame to search on. + - ``MAXRETSIZE`` specifies MAXRETSIZE as the packet within CPHY frame to search on. + - ``DCSGLONGWRITE`` specifies DCSGLONGWRITE as the packet within CPHY frame to search + on. + - ``PICPARameter`` specifies PICPARameter as the packet within CPHY frame to search on. + - ``COMPRESSEDPSTReam`` specifies COMPRESSEDPSTReam as the packet within CPHY frame to + search on. + - ``PPS101010`` specifies PPS101010 as the packet within CPHY frame to search on. + - ``PPS121212`` specifies PPS121212 as the packet within CPHY frame to search on. + - ``PPS565`` specifies PPS565 as the packet within CPHY frame to search on. + - ``PPS666`` specifies PPS666 as the packet within CPHY frame to search on. + - ``LPS666`` specifies LPS666 as the packet within CPHY frame to search on. + - ``PPS888`` specifies LPS666 as the packet within CPHY frame to search on. + - ``YCBCR24`` specifies YCBCR24 as the packet within CPHY frame to search on. + - ``LPYCBCR24`` specifies LPYCBCR24 as the packet within CPHY frame to search on. + - ``YCBCR16`` specifies YCBCR16 as the packet within CPHY frame to search on. + - ``YCBCR12`` specifies YCBCR12 as the packet within CPHY frame to search on. + - ``ACKNowledge`` specifies ACKNowledge as the packet within CPHY frame to search on. + - ``ERRORREPort`` specifies ERRORREPort as the packet within CPHY frame to search on. + - ``GSRR`` specifies GSRR as the packet within CPHY frame to search on. + - ``GLONGREAD`` specifies GLONGREAD as the packet within CPHY frame to search on. + - ``DCSLONGREAD`` specifies DCSLONGREAD as the packet within CPHY frame to search on. + - ``DCSSRR`` specifies DCSSRR as the packet within CPHY frame to search on. + - ``FRAMESTARt`` specifies FRAMESTARt as the packet within CPHY frame to search on. + - ``FRAMEEND`` specifies FRAMEEND as the packet within CPHY frame to search on. + - ``LINESTARt`` specifies LINESTARt as the packet within CPHY frame to search on. + - ``LINEEND`` specifies LINEEND as the packet within CPHY frame to search on. + - ``GSP`` specifies GSP as the packet within CPHY frame to search on. + - ``CSINULL`` specifies CSINULL as the packet within CPHY frame to search on. + - ``CSIBLANk`` specifies CSIBLANk as the packet within CPHY frame to search on. + - ``EMBEDDED`` specifies EMBEDDED as the packet within CPHY frame to search on. + - ``USEREIGHTB`` specifies USEREIGHTB as the packet within CPHY frame to search on. + - ``RGB565`` specifies RGB565 as the packet within CPHY frame to search on. + - ``RGB555`` specifies RGB555 as the packet within CPHY frame to search on. + - ``RGB444`` specifies RGB444 as the packet within CPHY frame to search on. + - ``RGB666`` specifies RGB666 as the packet within CPHY frame to search on. + - ``RAW6`` specifies RAW6 as the packet within CPHY frame to search on. + - ``RAW7`` specifies RAW7 as the packet within CPHY frame to search on. + - ``RAW8`` specifies RAW8 as the packet within CPHY frame to search on. + - ``RAW10`` specifies RAW10 as the packet within CPHY frame to search on. + - ``RAW12`` specifies RAW12 as the packet within CPHY frame to search on. + - ``RAW14`` specifies RAW14 as the packet within CPHY frame to search on. + - ``RAW16`` specifies RAW16 as the packet within CPHY frame to search on. + - ``RAW20`` specifies RAW20 as the packet within CPHY frame to search on. + - ``RGB888`` specifies RGB888 as the packet within CPHY frame to search on. + - ``YUV420L8`` specifies YUV420L8 as the packet within CPHY frame to search on. + - ``YUV8BIT`` specifies YUV8BIT as the packet within CPHY frame to search on. + - ``YUV422B10`` specifies YUV422B10 as the packet within CPHY frame to search on. + - ``YUV420B10`` specifies YUV420B10 as the packet within CPHY frame to search on. + """ # noqa: E501 + return self._list @property - def offset(self) -> SearchSearchItemTriggerABusCanDataOffset: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. + def type(self) -> SearchSearchItemTriggerABusCphyPacketsType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. **Description:** - - This command sets or queries the data offset value, in bytes, to use when searching on - the CAN data field. The search number is specified by x. The search condition must be - set to DATA or IDANDDATA. + - This command sets or queries the packet type for CPHY bus. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe {SHORt|LONG} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe? **Info:** - - ```` is an integer whose minimum and default values are -1 (don't care) and - maximum is up to 7 (for CAN 2.0) or up to 63 (for ISO CAN FD and Non-ISO CAN FD). The - maximum is dependent on the number of bytes being matched and the CAN standard - selected. Its value is calculated as [Absolute Maximum] - [Data Match Size]. For CAN - 2.0, the absolute maximum is 8 bytes. For ISO CAN FD and Non-ISO CAN FD, the absolute - maximum is 64 bytes. The minimum data match size is 1 byte, which produces the ranges - listed above. Increasing the data match size above 1 byte will adjust the range of - valid data offset values accordingly. + - ``SHORt`` specifies SHORt as the field within a CPHY frame to search on. SHORt is the + default packet type condition. + - ``LONG`` specifies LONG as the field within a CPHY frame to search on. """ - return self._offset - - @property - def qualifier(self) -> SearchSearchItemTriggerABusCanDataQualifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. + return self._type - **Description:** - - This command sets or queries the CAN bus trigger data qualifier to be used when - searching on a CAN bus signal. The search number is specified by x. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier value`` command. +class SearchSearchItemTriggerABusCphyModeType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. - **SCPI Syntax:** + **Description:** + - This command sets or queries the mode type for CPHY bus. - :: + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe value`` command. - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier {EQUal|LESSEQual|MOREEQua|UNEQual|LESSthan|MOREthan} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier? + **SCPI Syntax:** - **Info:** - - ``EQUal`` sets the data qualifier to equal. - - ``LESSEQual`` sets the data qualifier to less equal. - - ``MOREEQua`` sets the data qualifier to more equal. - - ``UNEQual`` sets the data qualifier to unequal. - - ``LESSthan`` sets the data qualifier to less than. - - ``MOREthan`` sets the data qualifier to more than. - """ # noqa: E501 - return self._qualifier + :: - @property - def size(self) -> SearchSearchItemTriggerABusCanDataSize: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe {HS|LP} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe? - **Description:** - - This command sets or queries the length of the data string, in bytes, to be used when - searching on a CAN bus signal. The search condition must be set to IDANDDATA or DATA. - The search number is specified by x. + **Info:** + - ``HS`` specifies HS as the mode within a CPHY frame to search on. HS is default mode type + condition. + - ``LP`` specifies LP as the mode within a CPHY frame to search on. + """ - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe value`` command. - **SCPI Syntax:** +class SearchSearchItemTriggerABusCphyMode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. - :: + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query and raise an AssertionError if the + returned value does not match ``value``. - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe? + Properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. + """ - **Info:** - - ```` specifies the data size. - """ - return self._size + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._type = SearchSearchItemTriggerABusCphyModeType(device, f"{self._cmd_syntax}:TYPe") @property - def value(self) -> SearchSearchItemTriggerABusCanDataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. + def type(self) -> SearchSearchItemTriggerABusCphyModeType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. **Description:** - - This command sets or queries the binary data value to be used when searching on a CAN - bus signal. The search condition must be set to IDANDDATA OR DATA. + - This command sets or queries the mode type for CPHY bus. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe {HS|LP} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe? **Info:** - - ```` + - ``HS`` specifies HS as the mode within a CPHY frame to search on. HS is default mode + type condition. + - ``LP`` specifies LP as the mode within a CPHY frame to search on. """ - return self._value + return self._type -class SearchSearchItemTriggerABusCanCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. +class SearchSearchItemTriggerABusCphyGreenValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. **Description:** - - This command sets or queries the search condition for a CAN bus. The search number is - specified by x. + - This command specifies the green data string used for CPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition {SOF| FRAMEtype| IDentifier| DATa| IDANDDATA| EOF| ERRor| FDBITS} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue? **Info:** - - ``SOF`` specifies the search condition for a CAN bus as start of frame. - - ``FRAMEtype`` specifies the search condition for a CAN bus as frame type. - - ``IDentifier`` specifies the search condition for a CAN bus as identifier. - - ``IDANDDATA`` specifies the search condition for a CAN bus as ID and data. - - ``EOF`` specifies the search condition for a CAN bus as end of frame. - - ``ERRor`` specifies the search condition for a CAN bus as error. - - ``FDBITS`` specifies the search condition for a CAN bus as FD bits. - """ # noqa: E501 + - ```` is the identifier value. The default green value is XXXXXXXXXX. + """ + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusCan(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN`` command tree. + +class SearchSearchItemTriggerABusCphyGreen(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN?`` query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN?`` - query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. - - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. - - ``.fd``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. - - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. - - ``.identifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusCanCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._data = SearchSearchItemTriggerABusCanData(device, f"{self._cmd_syntax}:DATa") - self._errtype = SearchSearchItemTriggerABusCanErrtype(device, f"{self._cmd_syntax}:ERRType") - self._fd = SearchSearchItemTriggerABusCanFd(device, f"{self._cmd_syntax}:FD") - self._frametype = SearchSearchItemTriggerABusCanFrametype( - device, f"{self._cmd_syntax}:FRAMEtype" - ) - self._identifier = SearchSearchItemTriggerABusCanIdentifier( - device, f"{self._cmd_syntax}:IDentifier" - ) + self._value = SearchSearchItemTriggerABusCphyGreenValue(device, f"{self._cmd_syntax}:VALue") @property - def condition(self) -> SearchSearchItemTriggerABusCanCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. + def value(self) -> SearchSearchItemTriggerABusCphyGreenValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. **Description:** - - This command sets or queries the search condition for a CAN bus. The search number is - specified by x. + - This command specifies the green data string used for CPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition {SOF| FRAMEtype| IDentifier| DATa| IDANDDATA| EOF| ERRor| FDBITS} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue? **Info:** - - ``SOF`` specifies the search condition for a CAN bus as start of frame. - - ``FRAMEtype`` specifies the search condition for a CAN bus as frame type. - - ``IDentifier`` specifies the search condition for a CAN bus as identifier. - - ``IDANDDATA`` specifies the search condition for a CAN bus as ID and data. - - ``EOF`` specifies the search condition for a CAN bus as end of frame. - - ``ERRor`` specifies the search condition for a CAN bus as error. - - ``FDBITS`` specifies the search condition for a CAN bus as FD bits. - """ # noqa: E501 - return self._condition + - ```` is the identifier value. The default green value is XXXXXXXXXX. + """ + return self._value - @property - def data(self) -> SearchSearchItemTriggerABusCanData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query and raise an AssertionError if the - returned value does not match ``value``. +class SearchSearchItemTriggerABusCphyEscapemodeCommand(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. - Sub-properties: - - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. - - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. - - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. - - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. - """ - return self._data + **Description:** + - This command sets or queries the escape mode command type for CPHY bus.. - @property - def errtype(self) -> SearchSearchItemTriggerABusCanErrtype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query and raise an + AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand value`` command. - **Description:** - - This command sets or queries the type of error condition for a CAN bus to search on. - The search number is specified by x. The search condition must be set to ERRor. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query and raise an AssertionError if - the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType value`` command. + :: - **SCPI Syntax:** + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand? - :: + **Info:** + - ``LPDT`` specifies LPDT as the field within a CPHY frame to search on. + - ``ULPS`` specifies ULPS as the field within a CPHY frame to search on. + - ``RESETTRIGger`` specifies RESETTRIGger as the field within a CPHY frame to search on. + - ``ANY`` specifies ANY as the field within a CPHY frame to search on. ANY is the default + value. + """ - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType {ACKMISS|BITSTUFFing|FORMERRor |ANYERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType? - **Info:** - - ``ACKMISS`` specifies a search based on a missing ACK field. - - ``BITSTUFFing`` specifies a search based on a bit stuffing error. - - ``FORMERRor`` specifies a search based on a CAN FD form error. To use this option, the - CAN standard must be set to FDISO or FDNONISO. - - ``ANYERRor`` specifies a search based on any error type. - """ - return self._errtype +class SearchSearchItemTriggerABusCphyEscapemode(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. - @property - def fd(self) -> SearchSearchItemTriggerABusCanFd: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` query and raise an AssertionError if the - returned value does not match ``value``. + Properties: + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. + """ - Sub-properties: - - ``.brsbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. - - ``.esibit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. - """ - return self._fd + def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: + super().__init__(device, cmd_syntax) + self._command = SearchSearchItemTriggerABusCphyEscapemodeCommand( + device, f"{self._cmd_syntax}:COMMand" + ) @property - def frametype(self) -> SearchSearchItemTriggerABusCanFrametype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. + def command(self) -> SearchSearchItemTriggerABusCphyEscapemodeCommand: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. **Description:** - - This command sets or queries CAN bus trigger frame type to be used when searching on a - CAN bus signal. The search condition must be set to FRAMEtype. The search number is - specified by x. + - This command sets or queries the escape mode command type for CPHY bus.. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype {DATa|ERRor|OVERLoad|REMote} - - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand {LPDT|ULPS|RESETTRIGger|ANY} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand? **Info:** - - ``DATa`` sets the frame type to data. - - ``ERRor`` sets the frame type to error. - - ``OVERLoad`` sets the frame type to overload. - - ``REMote`` sets the frame type to remote. - """ - return self._frametype - - @property - def identifier(self) -> SearchSearchItemTriggerABusCanIdentifier: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. + - ``LPDT`` specifies LPDT as the field within a CPHY frame to search on. + - ``ULPS`` specifies ULPS as the field within a CPHY frame to search on. + - ``RESETTRIGger`` specifies RESETTRIGger as the field within a CPHY frame to search on. + - ``ANY`` specifies ANY as the field within a CPHY frame to search on. ANY is the + default value. """ - return self._identifier + return self._command -class SearchSearchItemTriggerABusBS8b10bCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition`` command. +class SearchSearchItemTriggerABusCphyErrorType(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. **Description:** - - This command sets or queries the type of data search for an 8B10B bus. The search number - is specified by x. + - This command sets or queries the error type for CPHY bus. The default error type condition + is ANY. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition {SYMbols|ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe {ANY|ECC|CRC} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe? **Info:** - - ``Search`` is the number of the search. - - ``SYMbols`` specifies the search condition as data or control. - - ``ERRors`` specifies the search condition as Symbol error or disparity error. + - ``ANY`` specifies ANY as the field within a CPHY frame to search on. + - ``ECC`` specifies ECC as the field within a CPHY frame to search on. + - ``CRC`` specifies CRC as the field within a CPHY frame to search on. """ -class SearchSearchItemTriggerABusBS8b10b(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B`` command tree. +class SearchSearchItemTriggerABusCphyError(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusBS8b10bCondition( - device, f"{self._cmd_syntax}:CONDition" - ) + self._type = SearchSearchItemTriggerABusCphyErrorType(device, f"{self._cmd_syntax}:TYPe") @property - def condition(self) -> SearchSearchItemTriggerABusBS8b10bCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition`` command. + def type(self) -> SearchSearchItemTriggerABusCphyErrorType: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. **Description:** - - This command sets or queries the type of data search for an 8B10B bus. The search - number is specified by x. + - This command sets or queries the error type for CPHY bus. The default error type + condition is ANY. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition {SYMbols|ERRors} - - SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe {ANY|ECC|CRC} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe? **Info:** - - ``Search`` is the number of the search. - - ``SYMbols`` specifies the search condition as data or control. - - ``ERRors`` specifies the search condition as Symbol error or disparity error. + - ``ANY`` specifies ANY as the field within a CPHY frame to search on. + - ``ECC`` specifies ECC as the field within a CPHY frame to search on. + - ``CRC`` specifies CRC as the field within a CPHY frame to search on. """ - return self._condition + return self._type -class SearchSearchItemTriggerABusBPsifiveStatusValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue`` command. +class SearchSearchItemTriggerABusCphyDataValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. **Description:** - - This command sets or queries the binary status string used for PSI5 triggering if the - trigger condition is status. + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + - ```` is the identifier value. The default value is XXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusBPsifiveStatus(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus`` command tree. +class SearchSearchItemTriggerABusCphyDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. + + **Description:** + - This command specifies the length of the data string in bytes to be used for an CPHY + trigger if the trigger condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus?`` query and raise an AssertionError if + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe? + + **Info:** + - ```` specifies the data size. The default data size is 1 byte and otherwise ranges + between 1 and 5. + """ + + +class SearchSearchItemTriggerABusCphyData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveStatusValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._size = SearchSearchItemTriggerABusCphyDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusCphyDataValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveStatusValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue`` command. + def size(self) -> SearchSearchItemTriggerABusCphyDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. **Description:** - - This command sets or queries the binary status string used for PSI5 triggering if the - trigger condition is status. + - This command specifies the length of the data string in bytes to be used for an CPHY + trigger if the trigger condition is DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ```` specifies the data size. The default data size is 1 byte and otherwise + ranges between 1 and 5. + """ + return self._size + + @property + def value(self) -> SearchSearchItemTriggerABusCphyDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. + + **Description:** + - This command specifies the binary data string used for CPHY triggering if the trigger + condition is DATA. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue? + + **Info:** + - ```` is the identifier value. The default value is XXXXXXXX. """ return self._value -class SearchSearchItemTriggerABusBPsifiveSensorAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue`` command. +class SearchSearchItemTriggerABusCphyCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. **Description:** - - This command sets or queries the binary sensor address string used for PSI5 triggering if - the trigger condition is Sensor Address. The search number is specified by x. + - This command sets or queries the trigger condition for an CPHY bus. The default trigger on + condition is SOT. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe| WORD| SYMBol} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + - ``SOT`` specifies SOT as the field within a CPHY frame to search on. + - ``EOT`` specifies EOT as the field within a CPHY frame to search on. + - ``DATa`` specifies DATa as the field within a CPHY frame to search on. + - ``EOTPDATa`` specifies EOTPDATa as the field within a CPHY frame to search on. + - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a CPHY frame to search on. + - ``SCRambling`` specifies SCRambling as the field within a CPHY frame to search on. + - ``COMPression`` specifies COMPression as the field within a CPHY frame to search on. + - ``PACKets`` specifies PACKets as the field within a CPHY frame to search on. + - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a CPHY frame to search on. + - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a CPHY frame to search on. + - ``STop`` specifies STop as the field within a CPHY frame to search on. + - ``ERRors`` specifies ERRors as the field within a CPHY frame to search on. + - ``MODe`` specifies MODe as the field within a CPHY frame to search on. + - ``WORD`` specifies WORD as the field within a CPHY frame to search on. + - ``SYMBol`` specifies SYMBol as the field within a CPHY frame to search on. + """ # noqa: E501 + + +class SearchSearchItemTriggerABusCphyBlueValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. + + **Description:** + - This command specifies the blue data string used for CPHY triggering if the trigger + condition is on RGB packet. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue value`` command. + + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue? + + **Info:** + - ```` is the identifier value. The default blue value is XXXXXXXXXX. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusBPsifiveSensorAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess`` command tree. +class SearchSearchItemTriggerABusCphyBlue(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveSensorAddressValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._value = SearchSearchItemTriggerABusCphyBlueValue(device, f"{self._cmd_syntax}:VALue") @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveSensorAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusCphyBlueValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. **Description:** - - This command sets or queries the binary sensor address string used for PSI5 triggering - if the trigger condition is Sensor Address. The search number is specified by x. + - This command specifies the blue data string used for CPHY triggering if the trigger + condition is on RGB packet. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ```` is the identifier value. The default blue value is XXXXXXXXXX. """ return self._value -class SearchSearchItemTriggerABusBPsifiveSensor(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor`` command tree. +# pylint: disable=too-many-instance-attributes +class SearchSearchItemTriggerABusCphy(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor?`` query and raise an AssertionError if - the returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY?`` + query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY?`` + query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess`` command - tree. + - ``.blue``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. + - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. + - ``.escapemode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. + - ``.green``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. + - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. + - ``.packets``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. + - ``.pixel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. + - ``.red``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. + - ``.symbol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. + - ``.word``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. + - ``.wordcount``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. + - ``.ycbcr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. + - ``.yuv``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusBPsifiveSensorAddress( - device, f"{self._cmd_syntax}:ADDRess" + self._blue = SearchSearchItemTriggerABusCphyBlue(device, f"{self._cmd_syntax}:BLUe") + self._condition = SearchSearchItemTriggerABusCphyCondition( + device, f"{self._cmd_syntax}:CONDition" + ) + self._data = SearchSearchItemTriggerABusCphyData(device, f"{self._cmd_syntax}:DATa") + self._error = SearchSearchItemTriggerABusCphyError(device, f"{self._cmd_syntax}:ERRor") + self._escapemode = SearchSearchItemTriggerABusCphyEscapemode( + device, f"{self._cmd_syntax}:ESCAPEMODe" + ) + self._green = SearchSearchItemTriggerABusCphyGreen(device, f"{self._cmd_syntax}:GREen") + self._mode = SearchSearchItemTriggerABusCphyMode(device, f"{self._cmd_syntax}:MODe") + self._packets = SearchSearchItemTriggerABusCphyPackets( + device, f"{self._cmd_syntax}:PACKets" + ) + self._pixel = SearchSearchItemTriggerABusCphyPixel(device, f"{self._cmd_syntax}:PIXel") + self._red = SearchSearchItemTriggerABusCphyRed(device, f"{self._cmd_syntax}:RED") + self._symbol = SearchSearchItemTriggerABusCphySymbol(device, f"{self._cmd_syntax}:SYMBol") + self._word = SearchSearchItemTriggerABusCphyWord(device, f"{self._cmd_syntax}:WORD") + self._wordcount = SearchSearchItemTriggerABusCphyWordcount( + device, f"{self._cmd_syntax}:WORDCOUNt" ) + self._ycbcr = SearchSearchItemTriggerABusCphyYcbcr(device, f"{self._cmd_syntax}:YCBCR") + self._yuv = SearchSearchItemTriggerABusCphyYuv(device, f"{self._cmd_syntax}:YUV") @property - def address(self) -> SearchSearchItemTriggerABusBPsifiveSensorAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess`` command tree. + def blue(self) -> SearchSearchItemTriggerABusCphyBlue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue`` - command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:BLUe:VALue`` command. """ - return self._address - - -class SearchSearchItemTriggerABusBPsifiveSensorstatusType(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe`` command. - - **Description:** - - This command sets or queries the sensor status for PSI5 bus. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe? - - **Info:** - - ``READy`` specifies the sensor status as ready. This is the default value. - - ``BUSY`` specifies the sensor status as busy. - - ``DEFect`` specifies the sensor status as defect. - - ``SERVICEMODe`` specifies the sensor status as service mode. - - ``UNLocked`` specifies the sensor status as unlocked. - """ # noqa: E501 - - -class SearchSearchItemTriggerABusBPsifiveSensorstatus(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._type = SearchSearchItemTriggerABusBPsifiveSensorstatusType( - device, f"{self._cmd_syntax}:TYPe" - ) + return self._blue @property - def type(self) -> SearchSearchItemTriggerABusBPsifiveSensorstatusType: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe`` command. + def condition(self) -> SearchSearchItemTriggerABusCphyCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition`` command. **Description:** - - This command sets or queries the sensor status for PSI5 bus. + - This command sets or queries the trigger condition for an CPHY bus. The default + trigger on condition is SOT. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe {READy|BUSY|DEFect|SERVICEMODe|UNLocked} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition {SOT| EOT| DATa| EOTPDATa| OPTIONALPARam| SCRambling| COMPression| PACKets| BUSTURNAROUnd| ESCAPEMODe| STop| ERRors| MODe| WORD| SYMBol} + - SEARCH:SEARCH:TRIGger:A:BUS:CPHY:CONDition? **Info:** - - ``READy`` specifies the sensor status as ready. This is the default value. - - ``BUSY`` specifies the sensor status as busy. - - ``DEFect`` specifies the sensor status as defect. - - ``SERVICEMODe`` specifies the sensor status as service mode. - - ``UNLocked`` specifies the sensor status as unlocked. + - ``SOT`` specifies SOT as the field within a CPHY frame to search on. + - ``EOT`` specifies EOT as the field within a CPHY frame to search on. + - ``DATa`` specifies DATa as the field within a CPHY frame to search on. + - ``EOTPDATa`` specifies EOTPDATa as the field within a CPHY frame to search on. + - ``OPTIONALPARam`` specifies OPTIONALPARam as the field within a CPHY frame to search + on. + - ``SCRambling`` specifies SCRambling as the field within a CPHY frame to search on. + - ``COMPression`` specifies COMPression as the field within a CPHY frame to search on. + - ``PACKets`` specifies PACKets as the field within a CPHY frame to search on. + - ``BUSTURNAROUnd`` specifies BUSTURNAROUnd as the field within a CPHY frame to search + on. + - ``ESCAPEMODe`` specifies ESCAPEMODe as the field within a CPHY frame to search on. + - ``STop`` specifies STop as the field within a CPHY frame to search on. + - ``ERRors`` specifies ERRors as the field within a CPHY frame to search on. + - ``MODe`` specifies MODe as the field within a CPHY frame to search on. + - ``WORD`` specifies WORD as the field within a CPHY frame to search on. + - ``SYMBol`` specifies SYMBol as the field within a CPHY frame to search on. """ # noqa: E501 - return self._type + return self._condition + @property + def data(self) -> SearchSearchItemTriggerABusCphyData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa`` command tree. -class SearchSearchItemTriggerABusBPsifiveRegisterAddressValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Description:** - - This command sets or queries the binary register address string used for PSI5 triggering - if the trigger condition is Register Address. The search number is specified by x. + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:DATa:VALue`` command. + """ + return self._data - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue value`` command. + @property + def error(self) -> SearchSearchItemTriggerABusCphyError: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor?`` query and raise an AssertionError if + the returned value does not match ``value``. - :: + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ERRor:TYPe`` command. + """ + return self._error - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue? + @property + def escapemode(self) -> SearchSearchItemTriggerABusCphyEscapemode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe`` command tree. - **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe?`` query and raise an AssertionError + if the returned value does not match ``value``. - _WRAP_ARG_WITH_QUOTES = True + Sub-properties: + - ``.command``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:ESCAPEMODe:COMMand`` command. + """ + return self._escapemode + @property + def green(self) -> SearchSearchItemTriggerABusCphyGreen: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen`` command tree. -class SearchSearchItemTriggerABusBPsifiveRegisterAddress(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:GREen:VALue`` command. + """ + return self._green - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue`` - command. - """ + @property + def mode(self) -> SearchSearchItemTriggerABusCphyMode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe`` command tree. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveRegisterAddressValue( - device, f"{self._cmd_syntax}:VALue" - ) + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe?`` query and raise an AssertionError if the + returned value does not match ``value``. - @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveRegisterAddressValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue`` command. + Sub-properties: + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:MODe:TYPe`` command. + """ + return self._mode - **Description:** - - This command sets or queries the binary register address string used for PSI5 - triggering if the trigger condition is Register Address. The search number is - specified by x. + @property + def packets(self) -> SearchSearchItemTriggerABusCphyPackets: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets?`` query and raise an AssertionError if + the returned value does not match ``value``. - **SCPI Syntax:** + Sub-properties: + - ``.list``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:LIST`` command. + - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PACKets:TYPe`` command. + """ + return self._packets - :: + @property + def pixel(self) -> SearchSearchItemTriggerABusCphyPixel: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel`` command tree. - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue? + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel?`` query and raise an AssertionError if + the returned value does not match ``value``. - **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + Sub-properties: + - ``.number``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:NUMBer`` command. + - ``.searchoption``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:PIXel:SEARCHOPTion`` + command. """ - return self._value + return self._pixel + @property + def red(self) -> SearchSearchItemTriggerABusCphyRed: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED`` command tree. -class SearchSearchItemTriggerABusBPsifiveRegister(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister`` command tree. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED?`` query and raise an AssertionError if the + returned value does not match ``value``. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister?`` query and raise an AssertionError - if the returned value does not match ``value``. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:RED:VALue`` command. + """ + return self._red - Properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess`` command - tree. - """ + @property + def symbol(self) -> SearchSearchItemTriggerABusCphySymbol: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol`` command tree. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._address = SearchSearchItemTriggerABusBPsifiveRegisterAddress( - device, f"{self._cmd_syntax}:ADDRess" - ) + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol?`` query and raise an AssertionError if + the returned value does not match ``value``. + + Sub-properties: + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:SYMBol:VALue`` command. + """ + return self._symbol @property - def address(self) -> SearchSearchItemTriggerABusBPsifiveRegisterAddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess`` command tree. + def word(self) -> SearchSearchItemTriggerABusCphyWord: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD?`` query and raise an AssertionError if the + returned value does not match ``value``. Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue`` - command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORD:VALue`` command. """ - return self._address + return self._word + @property + def wordcount(self) -> SearchSearchItemTriggerABusCphyWordcount: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt`` command tree. -class SearchSearchItemTriggerABusBPsifiveRegisteraddress(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess`` command. + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt?`` query and raise an AssertionError + if the returned value does not match ``value``. - **Description:** - - This command sets or queries the register address for PSI5 bus. The search number is - specified by x. + Sub-properties: + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:WORDCOUNt:VALue`` command. + """ + return self._wordcount - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess value`` command. + @property + def ycbcr(self) -> SearchSearchItemTriggerABusCphyYcbcr: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR`` command tree. - **SCPI Syntax:** + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR?`` query and raise an AssertionError if + the returned value does not match ``value``. - :: + Sub-properties: + - ``.cb``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CB`` command. + - ``.cr``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:CR`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YCBCR:Y`` command. + """ + return self._ycbcr - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess? + @property + def yuv(self) -> SearchSearchItemTriggerABusCphyYuv: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV`` command tree. - **Info:** - - ``TWOBIT`` specifies the register address value as 2 bit. This is the default value. - - ``SIXBIT`` specifies the register address value as 6 bit. - - ``EIGHTBIT`` specifies the register address value as 8 bit. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.u``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:U`` command. + - ``.v``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:V`` command. + - ``.y``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY:YUV:Y`` command. + """ + return self._yuv -class SearchSearchItemTriggerABusBPsifiveFunctioncodetype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe`` command. +class SearchSearchItemTriggerABusCanIdentifierValue(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is a Function Code. The search number is specified by x. + - This command sets or queries CAN bus trigger identifier (address) value to be used when + searching on a CAN bus signal. The search number is specified by x. The search condition + must be set to IDANDDATA or DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + - ```` is the identifier value. """ _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusBPsifiveErrortype(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe`` command. +class SearchSearchItemTriggerABusCanIdentifierMode(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. **Description:** - - This command sets or queries the error type for an PSI5 bus. The search number is - specified by x. + - This command sets or queries the CAN bus trigger identifier (address) mode to be used when + searching on a CAN bus signal. The search number is specified by x. The search condition + must be set to IDANDDATA or DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe? - - **Info:** - - ``ANY`` specifies the error type value as any. This is the default value. - - ``PARity`` specifies the error type value as parity. - - ``CRC`` specifies the error type value as CRC. - - ``RESPONSECODe`` specifies the error type value as response code. - """ - - -class SearchSearchItemTriggerABusBPsifiveDataRegionBValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue`` command. - - **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is data region B. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe {EXTENDed|STandard} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + - ``EXTENDed`` specifies the extended identifier mode. + - ``STandard`` specifies the standard identifier mode. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusBPsifiveDataRegionB(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B`` command tree. +class SearchSearchItemTriggerABusCanIdentifier(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query and raise an AssertionError if + the returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue`` command. + - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveDataRegionBValue( + self._mode = SearchSearchItemTriggerABusCanIdentifierMode( + device, f"{self._cmd_syntax}:MODe" + ) + self._value = SearchSearchItemTriggerABusCanIdentifierValue( device, f"{self._cmd_syntax}:VALue" ) @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveDataRegionBValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue`` command. + def mode(self) -> SearchSearchItemTriggerABusCanIdentifierMode: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is data region B. The search number is specified by x. + - This command sets or queries the CAN bus trigger identifier (address) mode to be used + when searching on a CAN bus signal. The search number is specified by x. The search + condition must be set to IDANDDATA or DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe {EXTENDed|STandard} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ``EXTENDed`` specifies the extended identifier mode. + - ``STandard`` specifies the standard identifier mode. """ - return self._value - - -class SearchSearchItemTriggerABusBPsifiveDataRegionAValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue`` command. - - **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is data region A. The search number is specified by x. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue value`` command. - - **SCPI Syntax:** - - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue? - - **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. - """ - - _WRAP_ARG_WITH_QUOTES = True - - -class SearchSearchItemTriggerABusBPsifiveDataRegionA(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveDataRegionAValue( - device, f"{self._cmd_syntax}:VALue" - ) + return self._mode @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveDataRegionAValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue`` command. + def value(self) -> SearchSearchItemTriggerABusCanIdentifierValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is data region A. The search number is specified by x. + - This command sets or queries CAN bus trigger identifier (address) value to be used + when searching on a CAN bus signal. The search number is specified by x. The search + condition must be set to IDANDDATA or DATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ```` is the identifier value. """ return self._value -class SearchSearchItemTriggerABusBPsifiveDataRegion(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion`` command tree. +class SearchSearchItemTriggerABusCanFrametype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. + + **Description:** + - This command sets or queries CAN bus trigger frame type to be used when searching on a CAN + bus signal. The search condition must be set to FRAMEtype. The search number is specified + by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype value`` command. - Properties: - - ``.a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A`` command tree. - - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B`` command tree. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype {DATa|ERRor|OVERLoad|REMote} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype? + + **Info:** + - ``DATa`` sets the frame type to data. + - ``ERRor`` sets the frame type to error. + - ``OVERLoad`` sets the frame type to overload. + - ``REMote`` sets the frame type to remote. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._a = SearchSearchItemTriggerABusBPsifiveDataRegionA(device, f"{self._cmd_syntax}:A") - self._b = SearchSearchItemTriggerABusBPsifiveDataRegionB(device, f"{self._cmd_syntax}:B") - @property - def a(self) -> SearchSearchItemTriggerABusBPsifiveDataRegionA: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A`` command tree. +class SearchSearchItemTriggerABusCanFdEsibit(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Description:** + - This command sets or queries the value of the error state indicator bit (ESI bit) for a + CAN bus to search on. The search number is specified by x. The search condition must be + set to FDBITS, and the CAN standard must be FDISO or FDNONISO. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue`` - command. - """ - return self._a + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit value`` command. - @property - def b(self) -> SearchSearchItemTriggerABusBPsifiveDataRegionB: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B?`` query and raise an - AssertionError if the returned value does not match ``value``. + :: - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue`` - command. - """ - return self._b + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit? + + **Info:** + - ``ONE`` filters CAN FD packets to only match those where the ESI bit has a value of 1 + (recessive). + - ``ZERo`` filters CAN FD packets to only match those where the ESI bit has a value of 0 + (dominant). + - ``NOCARE`` disables filtering of CAN FD packets on the ESI bit. + """ -class SearchSearchItemTriggerABusBPsifiveDataEcuSensorValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue`` command. +class SearchSearchItemTriggerABusCanFdBrsbit(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. **Description:** - - This command sets or queries the binary Data string used for PSI5 triggering if the - trigger condition is Data in ECU to Sensor communication mode. The search number is - specified by x. + - This command sets or queries the value of the bit rate switch bit (BRS bit) for a CAN bus + to search on. The search number is specified by x. The search condition must be set to + FDBITS, and the CAN standard must be FDISO or FDNONISO. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, and X - for values in binary format; and A-F, 0-9, and X for values in hexadecimal format. + - ``ONE`` filters CAN FD packets to only match those where the BRS bit has a value of 1 + (fast data enabled). + - ``ZERo`` filters CAN FD packets to only match those where the BRS bit has a value of 0 + (fast data disabled). + - ``NOCARE`` disables filtering of CAN FD packets on the BRS bit. """ - _WRAP_ARG_WITH_QUOTES = True - -class SearchSearchItemTriggerABusBPsifiveDataEcuSensor(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor`` command tree. +class SearchSearchItemTriggerABusCanFd(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor?`` query. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` + query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` query and raise an AssertionError if the + returned value does not match ``value``. Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue`` - command. + - ``.brsbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. + - ``.esibit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveDataEcuSensorValue( - device, f"{self._cmd_syntax}:VALue" - ) + self._brsbit = SearchSearchItemTriggerABusCanFdBrsbit(device, f"{self._cmd_syntax}:BRSBit") + self._esibit = SearchSearchItemTriggerABusCanFdEsibit(device, f"{self._cmd_syntax}:ESIBit") @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveDataEcuSensorValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue`` command. + def brsbit(self) -> SearchSearchItemTriggerABusCanFdBrsbit: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. **Description:** - - This command sets or queries the binary Data string used for PSI5 triggering if the - trigger condition is Data in ECU to Sensor communication mode. The search number is - specified by x. + - This command sets or queries the value of the bit rate switch bit (BRS bit) for a CAN + bus to search on. The search number is specified by x. The search condition must be + set to FDBITS, and the CAN standard must be FDISO or FDNONISO. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ``ONE`` filters CAN FD packets to only match those where the BRS bit has a value of 1 + (fast data enabled). + - ``ZERo`` filters CAN FD packets to only match those where the BRS bit has a value of 0 + (fast data disabled). + - ``NOCARE`` disables filtering of CAN FD packets on the BRS bit. """ - return self._value - - -class SearchSearchItemTriggerABusBPsifiveDataEcu(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Properties: - - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor`` command - tree. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._sensor = SearchSearchItemTriggerABusBPsifiveDataEcuSensor( - device, f"{self._cmd_syntax}:SENSor" - ) + return self._brsbit @property - def sensor(self) -> SearchSearchItemTriggerABusBPsifiveDataEcuSensor: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor`` command tree. + def esibit(self) -> SearchSearchItemTriggerABusCanFdEsibit: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. + + **Description:** + - This command sets or queries the value of the error state indicator bit (ESI bit) for + a CAN bus to search on. The search number is specified by x. The search condition must + be set to FDBITS, and the CAN standard must be FDISO or FDNONISO. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit value`` command. - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue`` - command. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit {ONE|ZERo|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit? + + **Info:** + - ``ONE`` filters CAN FD packets to only match those where the ESI bit has a value of 1 + (recessive). + - ``ZERo`` filters CAN FD packets to only match those where the ESI bit has a value of 0 + (dominant). + - ``NOCARE`` disables filtering of CAN FD packets on the ESI bit. """ - return self._sensor + return self._esibit -class SearchSearchItemTriggerABusBPsifiveData(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa`` command tree. +class SearchSearchItemTriggerABusCanErrtype(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. + + **Description:** + - This command sets or queries the type of error condition for a CAN bus to search on. The + search number is specified by x. The search condition must be set to ERRor. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType value`` command. - Properties: - - ``.ecu``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU`` command tree. - - ``.region``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion`` command tree. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType {ACKMISS|BITSTUFFing|FORMERRor |ANYERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType? + + **Info:** + - ``ACKMISS`` specifies a search based on a missing ACK field. + - ``BITSTUFFing`` specifies a search based on a bit stuffing error. + - ``FORMERRor`` specifies a search based on a CAN FD form error. To use this option, the CAN + standard must be set to FDISO or FDNONISO. + - ``ANYERRor`` specifies a search based on any error type. """ - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._ecu = SearchSearchItemTriggerABusBPsifiveDataEcu(device, f"{self._cmd_syntax}:ECU") - self._region = SearchSearchItemTriggerABusBPsifiveDataRegion( - device, f"{self._cmd_syntax}:REGion" - ) - @property - def ecu(self) -> SearchSearchItemTriggerABusBPsifiveDataEcu: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU`` command tree. +class SearchSearchItemTriggerABusCanDataValue(SCPICmdWrite): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU?`` query and raise an - AssertionError if the returned value does not match ``value``. + **Description:** + - This command sets or queries the binary data value to be used when searching on a CAN bus + signal. The search condition must be set to IDANDDATA OR DATA. - Sub-properties: - - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor`` command - tree. - """ - return self._ecu + **Usage:** + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. - @property - def region(self) -> SearchSearchItemTriggerABusBPsifiveDataRegion: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion`` command tree. + **SCPI Syntax:** - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion?`` query and raise an - AssertionError if the returned value does not match ``value``. + :: - Sub-properties: - - ``.a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A`` command tree. - - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B`` command tree. - """ - return self._region + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue + + **Info:** + - ```` + """ + + _WRAP_ARG_WITH_QUOTES = True -class SearchSearchItemTriggerABusBPsifiveDatabits(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs`` command. +class SearchSearchItemTriggerABusCanDataSize(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. **Description:** - - This command sets or queries the binary register address string used for PSI5 triggering - if the trigger condition is Data in ECU to Sensor communication mode. The search number is - specified by x. + - This command sets or queries the length of the data string, in bytes, to be used when + searching on a CAN bus signal. The search condition must be set to IDANDDATA or DATA. The + search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe? **Info:** - - ``FOURBIT`` specifies the data bit value as 4 bit. - - ``EIGHTBIT`` specifies the data bit value as 8 bit. - - ``TWENTYBIT`` specifies the data bit value as 20 bit. + - ```` specifies the data size. """ -class SearchSearchItemTriggerABusBPsifiveCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition`` command. +class SearchSearchItemTriggerABusCanDataQualifier(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. **Description:** - - This command sets or queries the trigger condition for an PSI5 bus. The search number is - specified by x. + - This command sets or queries the CAN bus trigger data qualifier to be used when searching + on a CAN bus signal. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier value`` command. **SCPI Syntax:** - :: - - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition? - - **Info:** - - ``STARt`` specifies the search condition as Start. This is the default trigger. - - ``STATus`` specifies the search condition as Status. - - ``DATa`` specifies the search condition as Data. - - ``BLOCkid`` specifies the search condition as Block ID. - - ``ERRors`` specifies the search condition as Errors. - - ``STARTBIT`` specifies the search condition as Start Bit. - - ``FUNCTIONCODe`` specifies the search condition as Function Code. - - ``ECUDATa`` specifies the search condition as ECU Data. - - ``SENSORADDRess`` specifies the search condition as Sensor Address. - - ``REGISTERADDRess`` specifies the search condition as Register Address. - - ``SENSORSTATus`` specifies the search condition as Sensor Status. - - ``CRCERRor`` specifies the search condition as CRC Error. + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier {EQUal|LESSEQual|MOREEQua|UNEQual|LESSthan|MOREthan} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier? + + **Info:** + - ``EQUal`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQua`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. """ # noqa: E501 -class SearchSearchItemTriggerABusBPsifiveBlockdataValue(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue`` command. +class SearchSearchItemTriggerABusCanDataOffset(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. **Description:** - - This command sets or queries the binary block data string used for PSI5 triggering if the - trigger condition is block id. + - This command sets or queries the data offset value, in bytes, to use when searching on the + CAN data field. The search number is specified by x. The search condition must be set to + DATA or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet? **Info:** - - ```` specifies the binary block data string. + - ```` is an integer whose minimum and default values are -1 (don't care) and maximum + is up to 7 (for CAN 2.0) or up to 63 (for ISO CAN FD and Non-ISO CAN FD). The maximum is + dependent on the number of bytes being matched and the CAN standard selected. Its value is + calculated as [Absolute Maximum] - [Data Match Size]. For CAN 2.0, the absolute maximum is + 8 bytes. For ISO CAN FD and Non-ISO CAN FD, the absolute maximum is 64 bytes. The minimum + data match size is 1 byte, which produces the ranges listed above. Increasing the data + match size above 1 byte will adjust the range of valid data offset values accordingly. """ - _WRAP_ARG_WITH_QUOTES = True +class SearchSearchItemTriggerABusCanDataDirection(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. -class SearchSearchItemTriggerABusBPsifiveBlockdata(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa`` command tree. + **Description:** + - This command specifies the CAN search type to be valid on a Read, Write, or Either + condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa?`` query and raise an AssertionError + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query and raise an AssertionError if the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection value`` command. - Properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue`` command. - """ - - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._value = SearchSearchItemTriggerABusBPsifiveBlockdataValue( - device, f"{self._cmd_syntax}:VALue" - ) - - @property - def value(self) -> SearchSearchItemTriggerABusBPsifiveBlockdataValue: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue`` command. - - **Description:** - - This command sets or queries the binary block data string used for PSI5 triggering if - the trigger condition is block id. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue value`` command. - - **SCPI Syntax:** + **SCPI Syntax:** - :: + :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection {READ|WRITE|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection? - **Info:** - - ```` specifies the binary block data string. - """ - return self._value + **Info:** + - ``READ`` specifies the read direction. + - ``WRITE`` specifies the write direction. + - ``NOCARE`` specifies either data direction. + """ -# pylint: disable=too-many-instance-attributes -class SearchSearchItemTriggerABusBPsifive(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe`` command tree. +class SearchSearchItemTriggerABusCanData(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.blockdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa`` command tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition`` command. - - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa`` command tree. - - ``.errortype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe`` command. - - ``.functioncodetype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe`` - command. - - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess`` - command. - - ``.register``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister`` command tree. - - ``.sensorstatus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus`` command - tree. - - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor`` command tree. - - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus`` command tree. + - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._blockdata = SearchSearchItemTriggerABusBPsifiveBlockdata( - device, f"{self._cmd_syntax}:BLOCKDATa" - ) - self._condition = SearchSearchItemTriggerABusBPsifiveCondition( - device, f"{self._cmd_syntax}:CONDition" - ) - self._databits = SearchSearchItemTriggerABusBPsifiveDatabits( - device, f"{self._cmd_syntax}:DATABITs" - ) - self._data = SearchSearchItemTriggerABusBPsifiveData(device, f"{self._cmd_syntax}:DATa") - self._errortype = SearchSearchItemTriggerABusBPsifiveErrortype( - device, f"{self._cmd_syntax}:ERRORTYPe" - ) - self._functioncodetype = SearchSearchItemTriggerABusBPsifiveFunctioncodetype( - device, f"{self._cmd_syntax}:FUNCTIONCODETYPe" - ) - self._registeraddress = SearchSearchItemTriggerABusBPsifiveRegisteraddress( - device, f"{self._cmd_syntax}:REGISTERADDRess" - ) - self._register = SearchSearchItemTriggerABusBPsifiveRegister( - device, f"{self._cmd_syntax}:REGister" - ) - self._sensorstatus = SearchSearchItemTriggerABusBPsifiveSensorstatus( - device, f"{self._cmd_syntax}:SENSORSTATus" + self._direction = SearchSearchItemTriggerABusCanDataDirection( + device, f"{self._cmd_syntax}:DIRection" ) - self._sensor = SearchSearchItemTriggerABusBPsifiveSensor( - device, f"{self._cmd_syntax}:SENSor" + self._offset = SearchSearchItemTriggerABusCanDataOffset( + device, f"{self._cmd_syntax}:OFFSet" ) - self._status = SearchSearchItemTriggerABusBPsifiveStatus( - device, f"{self._cmd_syntax}:STATus" + self._qualifier = SearchSearchItemTriggerABusCanDataQualifier( + device, f"{self._cmd_syntax}:QUALifier" ) + self._size = SearchSearchItemTriggerABusCanDataSize(device, f"{self._cmd_syntax}:SIZe") + self._value = SearchSearchItemTriggerABusCanDataValue(device, f"{self._cmd_syntax}:VALue") @property - def blockdata(self) -> SearchSearchItemTriggerABusBPsifiveBlockdata: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue`` command. - """ - return self._blockdata - - @property - def condition(self) -> SearchSearchItemTriggerABusBPsifiveCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition`` command. + def direction(self) -> SearchSearchItemTriggerABusCanDataDirection: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. **Description:** - - This command sets or queries the trigger condition for an PSI5 bus. The search number - is specified by x. + - This command specifies the CAN search type to be valid on a Read, Write, or Either + condition. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition {STARt| STATus| DATa| BLOCkid| ERRors| STARTBIT| FUNCTIONCODe| ECUDATa| SENSORADDRess| REGISTERADDRess| SENSORSTATus|CRCERRor} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection {READ|WRITE|NOCARE} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection? **Info:** - - ``STARt`` specifies the search condition as Start. This is the default trigger. - - ``STATus`` specifies the search condition as Status. - - ``DATa`` specifies the search condition as Data. - - ``BLOCkid`` specifies the search condition as Block ID. - - ``ERRors`` specifies the search condition as Errors. - - ``STARTBIT`` specifies the search condition as Start Bit. - - ``FUNCTIONCODe`` specifies the search condition as Function Code. - - ``ECUDATa`` specifies the search condition as ECU Data. - - ``SENSORADDRess`` specifies the search condition as Sensor Address. - - ``REGISTERADDRess`` specifies the search condition as Register Address. - - ``SENSORSTATus`` specifies the search condition as Sensor Status. - - ``CRCERRor`` specifies the search condition as CRC Error. - """ # noqa: E501 - return self._condition + - ``READ`` specifies the read direction. + - ``WRITE`` specifies the write direction. + - ``NOCARE`` specifies either data direction. + """ + return self._direction @property - def databits(self) -> SearchSearchItemTriggerABusBPsifiveDatabits: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs`` command. + def offset(self) -> SearchSearchItemTriggerABusCanDataOffset: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. **Description:** - - This command sets or queries the binary register address string used for PSI5 - triggering if the trigger condition is Data in ECU to Sensor communication mode. The - search number is specified by x. + - This command sets or queries the data offset value, in bytes, to use when searching on + the CAN data field. The search number is specified by x. The search condition must be + set to DATA or IDANDDATA. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet?`` query and raise an AssertionError + if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs {FOURBIT|EIGHTBIT|TWENTYBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet? **Info:** - - ``FOURBIT`` specifies the data bit value as 4 bit. - - ``EIGHTBIT`` specifies the data bit value as 8 bit. - - ``TWENTYBIT`` specifies the data bit value as 20 bit. - """ - return self._databits - - @property - def data(self) -> SearchSearchItemTriggerABusBPsifiveData: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.ecu``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU`` command tree. - - ``.region``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion`` command - tree. + - ```` is an integer whose minimum and default values are -1 (don't care) and + maximum is up to 7 (for CAN 2.0) or up to 63 (for ISO CAN FD and Non-ISO CAN FD). The + maximum is dependent on the number of bytes being matched and the CAN standard + selected. Its value is calculated as [Absolute Maximum] - [Data Match Size]. For CAN + 2.0, the absolute maximum is 8 bytes. For ISO CAN FD and Non-ISO CAN FD, the absolute + maximum is 64 bytes. The minimum data match size is 1 byte, which produces the ranges + listed above. Increasing the data match size above 1 byte will adjust the range of + valid data offset values accordingly. """ - return self._data + return self._offset @property - def errortype(self) -> SearchSearchItemTriggerABusBPsifiveErrortype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe`` command. + def qualifier(self) -> SearchSearchItemTriggerABusCanDataQualifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. **Description:** - - This command sets or queries the error type for an PSI5 bus. The search number is - specified by x. + - This command sets or queries the CAN bus trigger data qualifier to be used when + searching on a CAN bus signal. The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe?`` query and raise an + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier?`` query and raise an AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe {ANY|PARity|CRC|RESPONSECODe} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier {EQUal|LESSEQual|MOREEQua|UNEQual|LESSthan|MOREthan} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier? **Info:** - - ``ANY`` specifies the error type value as any. This is the default value. - - ``PARity`` specifies the error type value as parity. - - ``CRC`` specifies the error type value as CRC. - - ``RESPONSECODe`` specifies the error type value as response code. - """ - return self._errortype + - ``EQUal`` sets the data qualifier to equal. + - ``LESSEQual`` sets the data qualifier to less equal. + - ``MOREEQua`` sets the data qualifier to more equal. + - ``UNEQual`` sets the data qualifier to unequal. + - ``LESSthan`` sets the data qualifier to less than. + - ``MOREthan`` sets the data qualifier to more than. + """ # noqa: E501 + return self._qualifier @property - def functioncodetype(self) -> SearchSearchItemTriggerABusBPsifiveFunctioncodetype: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe`` command. + def size(self) -> SearchSearchItemTriggerABusCanDataSize: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. **Description:** - - This command sets or queries the binary data string used for PSI5 triggering if the - trigger condition is a Function Code. The search number is specified by x. + - This command sets or queries the length of the data string, in bytes, to be used when + searching on a CAN bus signal. The search condition must be set to IDANDDATA or DATA. + The search number is specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe?`` query and raise an - AssertionError if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe? **Info:** - - ```` specifies the value of the data string. The valid characters are 0, 1, - and X for values in binary format; and A-F, 0-9, and X for values in hexadecimal - format. + - ```` specifies the data size. """ - return self._functioncodetype + return self._size @property - def registeraddress(self) -> SearchSearchItemTriggerABusBPsifiveRegisteraddress: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess`` command. + def value(self) -> SearchSearchItemTriggerABusCanDataValue: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. **Description:** - - This command sets or queries the register address for PSI5 bus. The search number is - specified by x. + - This command sets or queries the binary data value to be used when searching on a CAN + bus signal. The search condition must be set to IDANDDATA OR DATA. **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess?`` query and raise an - AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess {TWOBIT|SIXBIT|EIGHTBIT} - - SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue **Info:** - - ``TWOBIT`` specifies the register address value as 2 bit. This is the default value. - - ``SIXBIT`` specifies the register address value as 6 bit. - - ``EIGHTBIT`` specifies the register address value as 8 bit. - """ - return self._registeraddress - - @property - def register(self) -> SearchSearchItemTriggerABusBPsifiveRegister: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess`` - command tree. - """ - return self._register - - @property - def sensorstatus(self) -> SearchSearchItemTriggerABusBPsifiveSensorstatus: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.type``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe`` command. - """ - return self._sensorstatus - - @property - def sensor(self) -> SearchSearchItemTriggerABusBPsifiveSensor: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.address``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess`` command - tree. - """ - return self._sensor - - @property - def status(self) -> SearchSearchItemTriggerABusBPsifiveStatus: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus?`` query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus?`` query and raise an AssertionError - if the returned value does not match ``value``. - - Sub-properties: - - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue`` command. + - ```` """ - return self._status + return self._value -class SearchSearchItemTriggerABusBNrzCondition(SCPICmdWrite, SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition`` command. +class SearchSearchItemTriggerABusCanCondition(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. **Description:** - - This command specifies a field or condition for an NRZ bus to search on. The search number - is specified by x. + - This command sets or queries the search condition for a CAN bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition?`` query and raise an AssertionError if - the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query and raise an AssertionError if the + returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition {DATa} - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition {SOF| FRAMEtype| IDentifier| DATa| IDANDDATA| EOF| ERRor| FDBITS} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition? **Info:** - - ``Search`` is the number of the search. - - ``DATa`` specifies the search condition as Data Characters. - """ + - ``SOF`` specifies the search condition for a CAN bus as start of frame. + - ``FRAMEtype`` specifies the search condition for a CAN bus as frame type. + - ``IDentifier`` specifies the search condition for a CAN bus as identifier. + - ``IDANDDATA`` specifies the search condition for a CAN bus as ID and data. + - ``EOF`` specifies the search condition for a CAN bus as end of frame. + - ``ERRor`` specifies the search condition for a CAN bus as error. + - ``FDBITS`` specifies the search condition for a CAN bus as FD bits. + """ # noqa: E501 -class SearchSearchItemTriggerABusBNrz(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ`` command tree. +class SearchSearchItemTriggerABusCan(SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ?`` query and raise an AssertionError if the - returned value does not match ``value``. + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN?`` query. + - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN?`` + query and raise an AssertionError if the returned value does not match ``value``. Properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition`` command. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. + - ``.errtype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. + - ``.fd``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. + - ``.frametype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. + - ``.identifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. """ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: super().__init__(device, cmd_syntax) - self._condition = SearchSearchItemTriggerABusBNrzCondition( + self._condition = SearchSearchItemTriggerABusCanCondition( device, f"{self._cmd_syntax}:CONDition" ) + self._data = SearchSearchItemTriggerABusCanData(device, f"{self._cmd_syntax}:DATa") + self._errtype = SearchSearchItemTriggerABusCanErrtype(device, f"{self._cmd_syntax}:ERRType") + self._fd = SearchSearchItemTriggerABusCanFd(device, f"{self._cmd_syntax}:FD") + self._frametype = SearchSearchItemTriggerABusCanFrametype( + device, f"{self._cmd_syntax}:FRAMEtype" + ) + self._identifier = SearchSearchItemTriggerABusCanIdentifier( + device, f"{self._cmd_syntax}:IDentifier" + ) @property - def condition(self) -> SearchSearchItemTriggerABusBNrzCondition: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition`` command. + def condition(self) -> SearchSearchItemTriggerABusCanCondition: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition`` command. **Description:** - - This command specifies a field or condition for an NRZ bus to search on. The search - number is specified by x. + - This command sets or queries the search condition for a CAN bus. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition?`` query and raise an AssertionError - if the returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition?`` query and raise an AssertionError if + the returned value does not match ``value``. - Using the ``.write(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition value`` command. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition value`` command. **SCPI Syntax:** :: - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition {DATa} - - SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition? + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition {SOF| FRAMEtype| IDentifier| DATa| IDANDDATA| EOF| ERRor| FDBITS} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:CONDition? **Info:** - - ``Search`` is the number of the search. - - ``DATa`` specifies the search condition as Data Characters. - """ + - ``SOF`` specifies the search condition for a CAN bus as start of frame. + - ``FRAMEtype`` specifies the search condition for a CAN bus as frame type. + - ``IDentifier`` specifies the search condition for a CAN bus as identifier. + - ``IDANDDATA`` specifies the search condition for a CAN bus as ID and data. + - ``EOF`` specifies the search condition for a CAN bus as end of frame. + - ``ERRor`` specifies the search condition for a CAN bus as error. + - ``FDBITS`` specifies the search condition for a CAN bus as FD bits. + """ # noqa: E501 return self._condition + @property + def data(self) -> SearchSearchItemTriggerABusCanData: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.direction``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:DIRection`` command. + - ``.offset``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:OFFSet`` command. + - ``.qualifier``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:QUALifier`` command. + - ``.size``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:SIZe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:DATa:VALue`` command. + """ + return self._data -class SearchSearchItemTriggerABusB(SCPICmdRead): - """The ``SEARCH:SEARCH:TRIGger:A:BUS:B`` command tree. + @property + def errtype(self) -> SearchSearchItemTriggerABusCanErrtype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType`` command. - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B?`` query. - - Using the ``.verify(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B?`` - query and raise an AssertionError if the returned value does not match ``value``. + **Description:** + - This command sets or queries the type of error condition for a CAN bus to search on. + The search number is specified by x. The search condition must be set to ERRor. - Properties: - - ``.nrz``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ`` command tree. - - ``.psifive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe`` command tree. - - ``.s8b10b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B`` command tree. - """ + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType value`` command. - def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._nrz = SearchSearchItemTriggerABusBNrz(device, f"{self._cmd_syntax}:NRZ") - self._psifive = SearchSearchItemTriggerABusBPsifive(device, f"{self._cmd_syntax}:PSIFIVe") - self._s8b10b = SearchSearchItemTriggerABusBS8b10b(device, f"{self._cmd_syntax}:S8B10B") + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType {ACKMISS|BITSTUFFing|FORMERRor |ANYERRor} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:ERRType? + + **Info:** + - ``ACKMISS`` specifies a search based on a missing ACK field. + - ``BITSTUFFing`` specifies a search based on a bit stuffing error. + - ``FORMERRor`` specifies a search based on a CAN FD form error. To use this option, the + CAN standard must be set to FDISO or FDNONISO. + - ``ANYERRor`` specifies a search based on any error type. + """ + return self._errtype @property - def nrz(self) -> SearchSearchItemTriggerABusBNrz: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ`` command tree. + def fd(self) -> SearchSearchItemTriggerABusCanFd: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD`` command tree. **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ?`` + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ?`` query and raise an AssertionError if the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD?`` query and raise an AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition`` command. + - ``.brsbit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:BRSBit`` command. + - ``.esibit``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FD:ESIBit`` command. """ - return self._nrz + return self._fd @property - def psifive(self) -> SearchSearchItemTriggerABusBPsifive: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe`` command tree. + def frametype(self) -> SearchSearchItemTriggerABusCanFrametype: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype`` command. + + **Description:** + - This command sets or queries CAN bus trigger frame type to be used when searching on a + CAN bus signal. The search condition must be set to FRAMEtype. The search number is + specified by x. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype value`` command. - Sub-properties: - - ``.blockdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa`` command - tree. - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition`` command. - - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs`` command. - - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa`` command tree. - - ``.errortype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe`` command. - - ``.functioncodetype``: The - ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe`` command. - - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess`` - command. - - ``.register``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister`` command tree. - - ``.sensorstatus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus`` - command tree. - - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor`` command tree. - - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus`` command tree. + **SCPI Syntax:** + + :: + + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype {DATa|ERRor|OVERLoad|REMote} + - SEARCH:SEARCH:TRIGger:A:BUS:CAN:FRAMEtype? + + **Info:** + - ``DATa`` sets the frame type to data. + - ``ERRor`` sets the frame type to error. + - ``OVERLoad`` sets the frame type to overload. + - ``REMote`` sets the frame type to remote. """ - return self._psifive + return self._frametype @property - def s8b10b(self) -> SearchSearchItemTriggerABusBS8b10b: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B`` command tree. + def identifier(self) -> SearchSearchItemTriggerABusCanIdentifier: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier`` command tree. **Usage:** - Using the ``.query()`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B?`` query. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query. - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B?`` query and raise an AssertionError if the - returned value does not match ``value``. + ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier?`` query and raise an AssertionError + if the returned value does not match ``value``. Sub-properties: - - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition`` command. + - ``.mode``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:MODe`` command. + - ``.value``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN:IDentifier:VALue`` command. """ - return self._s8b10b + return self._identifier class SearchSearchItemTriggerABusAutoethernetTcpheaderSourceportValue(SCPICmdWrite, SCPICmdRead): @@ -53039,7 +52944,7 @@ def value(self) -> SearchSearchItemTriggerABusArinc429aSdiValue: return self._value -class SearchSearchItemTriggerABusArinc429aLabelValue(SCPICmdWrite): +class SearchSearchItemTriggerABusArinc429aLabelValue(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue`` command. **Description:** @@ -53048,6 +52953,11 @@ class SearchSearchItemTriggerABusArinc429aLabelValue(SCPICmdWrite): LABELANDDATA. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue value`` command. @@ -53056,6 +52966,7 @@ class SearchSearchItemTriggerABusArinc429aLabelValue(SCPICmdWrite): :: - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue? **Info:** - ```` is the label value. @@ -53236,6 +53147,11 @@ def value(self) -> SearchSearchItemTriggerABusArinc429aLabelValue: LABELANDDATA. **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue?`` query and raise an + AssertionError if the returned value does not match ``value``. - Using the ``.write(value)`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue value`` command. @@ -53244,6 +53160,7 @@ def value(self) -> SearchSearchItemTriggerABusArinc429aLabelValue: :: - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue + - SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A:LABel:VALue? **Info:** - ```` is the label value. @@ -53728,7 +53645,6 @@ class SearchSearchItemTriggerABus(SCPICmdRead): - ``.arinc429a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A`` command tree. - ``.audio``: The ``SEARCH:SEARCH:TRIGger:A:BUS:AUDio`` command tree. - ``.autoethernet``: The ``SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet`` command tree. - - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B`` command tree. - ``.can``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN`` command tree. - ``.cphy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY`` command tree. - ``.cxpi``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI`` command tree. @@ -53747,6 +53663,7 @@ class SearchSearchItemTriggerABus(SCPICmdRead): - ``.nrz``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ`` command tree. - ``.onewire``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe`` command tree. - ``.parallel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel`` command tree. + - ``.psifive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe`` command tree. - ``.rs232c``: The ``SEARCH:SEARCH:TRIGger:A:BUS:RS232C`` command tree. - ``.s8b10b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B`` command tree. - ``.sdlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:SDLC`` command tree. @@ -53769,7 +53686,6 @@ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: self._autoethernet = SearchSearchItemTriggerABusAutoethernet( device, f"{self._cmd_syntax}:AUTOETHERnet" ) - self._b = SearchSearchItemTriggerABusB(device, f"{self._cmd_syntax}:B") self._can = SearchSearchItemTriggerABusCan(device, f"{self._cmd_syntax}:CAN") self._cphy = SearchSearchItemTriggerABusCphy(device, f"{self._cmd_syntax}:CPHY") self._cxpi = SearchSearchItemTriggerABusCxpi(device, f"{self._cmd_syntax}:CXPI") @@ -53790,6 +53706,7 @@ def __init__(self, device: Optional["PIDevice"], cmd_syntax: str) -> None: self._nrz = SearchSearchItemTriggerABusNrz(device, f"{self._cmd_syntax}:NRZ") self._onewire = SearchSearchItemTriggerABusOnewire(device, f"{self._cmd_syntax}:ONEWIRe") self._parallel = SearchSearchItemTriggerABusParallel(device, f"{self._cmd_syntax}:PARallel") + self._psifive = SearchSearchItemTriggerABusPsifive(device, f"{self._cmd_syntax}:PSIFIVe") self._rs232c = SearchSearchItemTriggerABusRs232c(device, f"{self._cmd_syntax}:RS232C") self._s8b10b = SearchSearchItemTriggerABusS8b10b(device, f"{self._cmd_syntax}:S8B10B") self._sdlc = SearchSearchItemTriggerABusSdlc(device, f"{self._cmd_syntax}:SDLC") @@ -53866,24 +53783,6 @@ def autoethernet(self) -> SearchSearchItemTriggerABusAutoethernet: """ return self._autoethernet - @property - def b(self) -> SearchSearchItemTriggerABusB: - """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:B`` command tree. - - **Usage:** - - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:BUS:B?`` - query. - - Using the ``.verify(value)`` method will send the - ``SEARCH:SEARCH:TRIGger:A:BUS:B?`` query and raise an AssertionError if the - returned value does not match ``value``. - - Sub-properties: - - ``.nrz``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ`` command tree. - - ``.psifive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe`` command tree. - - ``.s8b10b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B`` command tree. - """ - return self._b - @property def can(self) -> SearchSearchItemTriggerABusCan: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:CAN`` command tree. @@ -54314,6 +54213,7 @@ def nrz(self) -> SearchSearchItemTriggerABusNrz: returned value does not match ``value``. Sub-properties: + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition`` command. - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa`` command tree. """ return self._nrz @@ -54356,6 +54256,35 @@ def parallel(self) -> SearchSearchItemTriggerABusParallel: """ return self._parallel + @property + def psifive(self) -> SearchSearchItemTriggerABusPsifive: + """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe?`` query and raise an AssertionError if the + returned value does not match ``value``. + + Sub-properties: + - ``.blockdata``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa`` command tree. + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition`` command. + - ``.databits``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs`` command. + - ``.data``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa`` command tree. + - ``.errortype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe`` command. + - ``.functioncodetype``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe`` + command. + - ``.registeraddress``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess`` + command. + - ``.register``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister`` command tree. + - ``.sensorstatus``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus`` command + tree. + - ``.sensor``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor`` command tree. + - ``.status``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus`` command tree. + """ + return self._psifive + @property def rs232c(self) -> SearchSearchItemTriggerABusRs232c: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:RS232C`` command tree. @@ -54385,6 +54314,7 @@ def s8b10b(self) -> SearchSearchItemTriggerABusS8b10b: returned value does not match ``value``. Sub-properties: + - ``.condition``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:CONDition`` command. - ``.disparity``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:DISParity`` command. - ``.error``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:ERRor`` command. - ``.symbol``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B:SYMbol`` command tree. @@ -54664,7 +54594,6 @@ def bus(self) -> SearchSearchItemTriggerABus: - ``.arinc429a``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ARINC429A`` command tree. - ``.audio``: The ``SEARCH:SEARCH:TRIGger:A:BUS:AUDio`` command tree. - ``.autoethernet``: The ``SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet`` command tree. - - ``.b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:B`` command tree. - ``.can``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CAN`` command tree. - ``.cphy``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CPHY`` command tree. - ``.cxpi``: The ``SEARCH:SEARCH:TRIGger:A:BUS:CXPI`` command tree. @@ -54683,6 +54612,7 @@ def bus(self) -> SearchSearchItemTriggerABus: - ``.nrz``: The ``SEARCH:SEARCH:TRIGger:A:BUS:NRZ`` command tree. - ``.onewire``: The ``SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe`` command tree. - ``.parallel``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PARallel`` command tree. + - ``.psifive``: The ``SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe`` command tree. - ``.rs232c``: The ``SEARCH:SEARCH:TRIGger:A:BUS:RS232C`` command tree. - ``.s8b10b``: The ``SEARCH:SEARCH:TRIGger:A:BUS:S8B10B`` command tree. - ``.sdlc``: The ``SEARCH:SEARCH:TRIGger:A:BUS:SDLC`` command tree. diff --git a/src/tm_devices/commands/_e3e9uu_lpdmso/trigger.py b/src/tm_devices/commands/_e3e9uu_lpdmso/trigger.py index 59daf187..b1261cb7 100644 --- a/src/tm_devices/commands/_e3e9uu_lpdmso/trigger.py +++ b/src/tm_devices/commands/_e3e9uu_lpdmso/trigger.py @@ -961,6 +961,7 @@ - TRIGger:HYSTeresis:USER:VALue - TRIGger:HYSTeresis:USER:VALue? - TRIGger:STATE? + - TRIGger:STATUs? - TRIGger? """ # noqa: E501 from typing import Dict, Optional, TYPE_CHECKING @@ -977,6 +978,25 @@ from tm_devices.drivers.pi.pi_device import PIDevice +class TriggerStatus(SCPICmdRead): + """The ``TRIGger:STATUs`` command. + + **Description:** + - This query-only command returns the current status of the triggering system. + + **Usage:** + - Using the ``.query()`` method will send the ``TRIGger:STATUs?`` query. + - Using the ``.verify(value)`` method will send the ``TRIGger:STATUs?`` query and raise an + AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - TRIGger:STATUs? + """ + + class TriggerState(SCPICmdRead): """The ``TRIGger:STATE`` command. @@ -39792,6 +39812,7 @@ class Trigger(SCPICmdWrite, SCPICmdRead): - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "TRIGger") -> None: @@ -39799,6 +39820,7 @@ def __init__(self, device: Optional["PIDevice"] = None, cmd_syntax: str = "TRIGg self._auxlevel = TriggerAuxlevel(device, f"{self._cmd_syntax}:AUXLevel") self._hysteresis = TriggerHysteresis(device, f"{self._cmd_syntax}:HYSTeresis") self._state = TriggerState(device, f"{self._cmd_syntax}:STATE") + self._status = TriggerStatus(device, f"{self._cmd_syntax}:STATUs") self._a = TriggerA(device, f"{self._cmd_syntax}:A") self._b = TriggerB(device, f"{self._cmd_syntax}:B") @@ -39864,6 +39886,26 @@ def state(self) -> TriggerState: """ return self._state + @property + def status(self) -> TriggerStatus: + """Return the ``TRIGger:STATUs`` command. + + **Description:** + - This query-only command returns the current status of the triggering system. + + **Usage:** + - Using the ``.query()`` method will send the ``TRIGger:STATUs?`` query. + - Using the ``.verify(value)`` method will send the ``TRIGger:STATUs?`` query and raise + an AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - TRIGger:STATUs? + """ + return self._status + @property def a(self) -> TriggerA: """Return the ``TRIGger:A`` command tree. diff --git a/src/tm_devices/commands/_e3h2zs_lpdmso/customtable.py b/src/tm_devices/commands/_e3h2zs_lpdmso/customtable.py new file mode 100644 index 00000000..353f4728 --- /dev/null +++ b/src/tm_devices/commands/_e3h2zs_lpdmso/customtable.py @@ -0,0 +1,175 @@ +"""The customtable commands module. + +These commands are used in the following models: +LPD6, MSO2, MSO4, MSO4B, MSO5, MSO5B, MSO5LP, MSO6, MSO6B + +THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. + +Please report an issue if one is found. + +Commands and Queries: + +:: + + - CUSTOMTABle:ADDNew + - CUSTOMTABle:DELete + - CUSTOMTABle:LIST? +""" +from typing import Optional, TYPE_CHECKING + +from .._helpers import SCPICmdRead, SCPICmdReadWithArguments, SCPICmdWrite + +if TYPE_CHECKING: + from tm_devices.drivers.pi.pi_device import PIDevice + + +class CustomtableList(SCPICmdReadWithArguments): + """The ``CUSTOMTABle:LIST`` command. + + **Description:** + - This command queries the list of custom result tables has been added. + + **Usage:** + - Using the ``.query(argument)`` method will send the ``CUSTOMTABle:LIST? argument`` query. + - Using the ``.verify(argument, value)`` method will send the ``CUSTOMTABle:LIST? argument`` + query and raise an AssertionError if the returned value does not match ``value``. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:LIST? + + **Info:** + - ```` specifies the custom results table name. + """ + + +class CustomtableDelete(SCPICmdWrite): + """The ``CUSTOMTABle:DELete`` command. + + **Description:** + - This command deletes the custom result(s) table that was added. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CUSTOMTABle:DELete value`` command. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:DELete + + **Info:** + - ```` specifies the custom results table name. + """ + + +class CustomtableAddnew(SCPICmdWrite): + """The ``CUSTOMTABle:ADDNew`` command. + + **Description:** + - This command adds new custom results table. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CUSTOMTABle:ADDNew value`` command. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:ADDNew + + **Info:** + - ```` specifies the custom results table name. + """ + + +class Customtable(SCPICmdRead): + """The ``CUSTOMTABle`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``CUSTOMTABle?`` query. + - Using the ``.verify(value)`` method will send the ``CUSTOMTABle?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Properties: + - ``.addnew``: The ``CUSTOMTABle:ADDNew`` command. + - ``.delete``: The ``CUSTOMTABle:DELete`` command. + - ``.list``: The ``CUSTOMTABle:LIST`` command. + """ + + def __init__( + self, device: Optional["PIDevice"] = None, cmd_syntax: str = "CUSTOMTABle" + ) -> None: + super().__init__(device, cmd_syntax) + self._addnew = CustomtableAddnew(device, f"{self._cmd_syntax}:ADDNew") + self._delete = CustomtableDelete(device, f"{self._cmd_syntax}:DELete") + self._list = CustomtableList(device, f"{self._cmd_syntax}:LIST") + + @property + def addnew(self) -> CustomtableAddnew: + """Return the ``CUSTOMTABle:ADDNew`` command. + + **Description:** + - This command adds new custom results table. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CUSTOMTABle:ADDNew value`` command. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:ADDNew + + **Info:** + - ```` specifies the custom results table name. + """ + return self._addnew + + @property + def delete(self) -> CustomtableDelete: + """Return the ``CUSTOMTABle:DELete`` command. + + **Description:** + - This command deletes the custom result(s) table that was added. + + **Usage:** + - Using the ``.write(value)`` method will send the ``CUSTOMTABle:DELete value`` command. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:DELete + + **Info:** + - ```` specifies the custom results table name. + """ + return self._delete + + @property + def list(self) -> CustomtableList: + """Return the ``CUSTOMTABle:LIST`` command. + + **Description:** + - This command queries the list of custom result tables has been added. + + **Usage:** + - Using the ``.query(argument)`` method will send the ``CUSTOMTABle:LIST? argument`` + query. + - Using the ``.verify(argument, value)`` method will send the + ``CUSTOMTABle:LIST? argument`` query and raise an AssertionError if the returned value + does not match ``value``. + + **SCPI Syntax:** + + :: + + - CUSTOMTABle:LIST? + + **Info:** + - ```` specifies the custom results table name. + """ + return self._list diff --git a/src/tm_devices/commands/_fk3z56_dpodsamso/ch.py b/src/tm_devices/commands/_fk3z56_dpodsamso/ch.py index b21e546e..371f9100 100644 --- a/src/tm_devices/commands/_fk3z56_dpodsamso/ch.py +++ b/src/tm_devices/commands/_fk3z56_dpodsamso/ch.py @@ -384,12 +384,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): """The ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is the - channel number. This setting controls the vertical size of the acquisition window as well - as the display scale. The range and resolution of scale values depends on the probe - attached and any other external factors you have specified. For a signal with constant - amplitude, increasing the scale causes the waveform to be displayed smaller. Decreasing - the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -405,8 +401,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ @@ -3605,12 +3601,8 @@ def scale(self) -> ChannelScale: """Return the ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is - the channel number. This setting controls the vertical size of the acquisition window - as well as the display scale. The range and resolution of scale values depends on the - probe attached and any other external factors you have specified. For a signal with - constant amplitude, increasing the scale causes the waveform to be displayed smaller. - Decreasing the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -3626,8 +3618,8 @@ def scale(self) -> ChannelScale: - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ return self._scale diff --git a/src/tm_devices/commands/_fk3z56_dpodsamso/data.py b/src/tm_devices/commands/_fk3z56_dpodsamso/data.py index 32b14681..29d393f7 100644 --- a/src/tm_devices/commands/_fk3z56_dpodsamso/data.py +++ b/src/tm_devices/commands/_fk3z56_dpodsamso/data.py @@ -170,7 +170,7 @@ class DataSource(SCPICmdWrite, SCPICmdRead): - ``DIGITALALL`` selects digital waveforms as the source. The Digital data is transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data. - - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAXHold``, ``CH_SV_MINHold`` + - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAX_Hold``, ``CH_SV_MIN_Hold`` selects the specified Spectrum View waveform. - ``CH_MAG_VS_TIME`` , ``CH_FREQ_VS_TIME``, ``CH_PHASE_VS_TIME`` selects the specified RF vs. Time waveform. @@ -545,8 +545,8 @@ def source(self) -> DataSource: transferred as 16-bit data, with the least-significant bit representing D0, and the most-significant bit representing D15. The LSB always contains D0-D7 and MSB always contains D8-D15 data. - - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAXHold``, ``CH_SV_MINHold`` - selects the specified Spectrum View waveform. + - ``CH_SV_NORMal`` , ``CH_SV_AVErage``, ``CH_SV_MAX_Hold``, + ``CH_SV_MIN_Hold`` selects the specified Spectrum View waveform. - ``CH_MAG_VS_TIME`` , ``CH_FREQ_VS_TIME``, ``CH_PHASE_VS_TIME`` selects the specified RF vs. Time waveform. - ``CH_SV_BASEBAND_IQ`` selects the specified RF baseband IQ data. diff --git a/src/tm_devices/commands/_fk3z56_dpodsamso/horizontal.py b/src/tm_devices/commands/_fk3z56_dpodsamso/horizontal.py index 18b76a09..8fb02e06 100644 --- a/src/tm_devices/commands/_fk3z56_dpodsamso/horizontal.py +++ b/src/tm_devices/commands/_fk3z56_dpodsamso/horizontal.py @@ -3011,10 +3011,11 @@ class HorizontalFastframeSumframe(SCPICmdWrite, SCPICmdRead): """The ``HORizontal:FASTframe:SUMFrame`` command. **Description:** - - This command sets or returns the summary frame type. Turning on Summary Frame does not - adjust the numberFrames value as long as there is room for an additional frame. If there - is not enough room then numberFrames will be reduced by 1. The numberFrames value is - always the number of frames to acquire. + - This command sets or queries the summary frame mode. When ENVelope is selected, the last + frame in a FastFrame acquisition is an envelope of all the prior frames in the + acquisition. When AVErage is selected, the last frame is replaced with a frame that is the + computed average of all the prior frames in the acquisition. For the summary frame control + to be active, the number of frames must be two or greater. **Usage:** - Using the ``.query()`` method will send the ``HORizontal:FASTframe:SUMFrame?`` query. @@ -3031,9 +3032,11 @@ class HorizontalFastframeSumframe(SCPICmdWrite, SCPICmdRead): - HORizontal:FASTframe:SUMFrame? **Info:** - - ``NONe`` sets the Summary frame to off. - - ``AVErage`` sets the Summary frame to average of all acquired frames. - - ``ENVelope`` sets the Summary frame to envelope of all acquired frames. + - ``NONE`` turns off the summary mode for FastFrame. This is the default setting. + - ``AVErage`` argument displays the last frame in a FastFrame acquisition as a frame that is + the computed average of all the prior frames in the acquisition. + - ``ENVelope`` argument displays the last frame in a FastFrame acquisition as an envelope of + all the prior frames in the acquisition. """ @@ -4704,10 +4707,11 @@ def sumframe(self) -> HorizontalFastframeSumframe: """Return the ``HORizontal:FASTframe:SUMFrame`` command. **Description:** - - This command sets or returns the summary frame type. Turning on Summary Frame does not - adjust the numberFrames value as long as there is room for an additional frame. If - there is not enough room then numberFrames will be reduced by 1. The numberFrames - value is always the number of frames to acquire. + - This command sets or queries the summary frame mode. When ENVelope is selected, the + last frame in a FastFrame acquisition is an envelope of all the prior frames in the + acquisition. When AVErage is selected, the last frame is replaced with a frame that is + the computed average of all the prior frames in the acquisition. For the summary frame + control to be active, the number of frames must be two or greater. **Usage:** - Using the ``.query()`` method will send the ``HORizontal:FASTframe:SUMFrame?`` query. @@ -4724,9 +4728,11 @@ def sumframe(self) -> HorizontalFastframeSumframe: - HORizontal:FASTframe:SUMFrame? **Info:** - - ``NONe`` sets the Summary frame to off. - - ``AVErage`` sets the Summary frame to average of all acquired frames. - - ``ENVelope`` sets the Summary frame to envelope of all acquired frames. + - ``NONE`` turns off the summary mode for FastFrame. This is the default setting. + - ``AVErage`` argument displays the last frame in a FastFrame acquisition as a frame + that is the computed average of all the prior frames in the acquisition. + - ``ENVelope`` argument displays the last frame in a FastFrame acquisition as an + envelope of all the prior frames in the acquisition. """ return self._sumframe diff --git a/src/tm_devices/commands/_lpd6_commands.py b/src/tm_devices/commands/_lpd6_commands.py index 24092066..7e69e4b0 100644 --- a/src/tm_devices/commands/_lpd6_commands.py +++ b/src/tm_devices/commands/_lpd6_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mdo3_commands.py b/src/tm_devices/commands/_mdo3_commands.py index 1802ed67..2c986b91 100644 --- a/src/tm_devices/commands/_mdo3_commands.py +++ b/src/tm_devices/commands/_mdo3_commands.py @@ -46,6 +46,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1nmc1o_msodpomdo.clearmenu import Clearmenu from ._1nmc1o_msodpomdo.errlog import Errlog from ._1nmc1o_msodpomdo.header import Header @@ -57,7 +58,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mdo3k_commands.py b/src/tm_devices/commands/_mdo3k_commands.py index 746d783e..fe5ce15f 100644 --- a/src/tm_devices/commands/_mdo3k_commands.py +++ b/src/tm_devices/commands/_mdo3k_commands.py @@ -50,6 +50,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration from ._1mlt9u_mdomsodpo.deskew import Deskew @@ -67,7 +68,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mdo4k_commands.py b/src/tm_devices/commands/_mdo4k_commands.py index 014631ce..418ace2e 100644 --- a/src/tm_devices/commands/_mdo4k_commands.py +++ b/src/tm_devices/commands/_mdo4k_commands.py @@ -51,6 +51,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1lxxm9_msomdodpo.cursor import Cursor from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration @@ -70,7 +71,6 @@ from ._163n04_mdo.search import Search from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mdo4kb_commands.py b/src/tm_devices/commands/_mdo4kb_commands.py index 84f5e966..d18cd9b2 100644 --- a/src/tm_devices/commands/_mdo4kb_commands.py +++ b/src/tm_devices/commands/_mdo4kb_commands.py @@ -52,6 +52,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration from ._1mlt9u_mdomsodpo.deskew import Deskew @@ -70,7 +71,6 @@ from ._16x4xq_mdo.search import Search from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mdo4kc_commands.py b/src/tm_devices/commands/_mdo4kc_commands.py index 8cd4abc4..f6f3d0cf 100644 --- a/src/tm_devices/commands/_mdo4kc_commands.py +++ b/src/tm_devices/commands/_mdo4kc_commands.py @@ -53,6 +53,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration from ._1mlt9u_mdomsodpo.deskew import Deskew @@ -70,7 +71,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mso2_commands.py b/src/tm_devices/commands/_mso2_commands.py index 297000b8..edfe6793 100644 --- a/src/tm_devices/commands/_mso2_commands.py +++ b/src/tm_devices/commands/_mso2_commands.py @@ -9,6 +9,7 @@ from tm_devices.drivers.pi.pi_device import PIDevice +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1zn03_mso.acquire import Acquire from ._1zn03_mso.actonevent import Actonevent from ._1zn03_mso.auxout import Auxout @@ -29,6 +30,7 @@ from ._1zn03_mso.measurement import Measurement from ._1zn03_mso.pg import Pg from ._1zn03_mso.plot import Plot +from ._1zn03_mso.power import Power from ._1zn03_mso.ref import Ref from ._1zn03_mso.save import Save from ._1zn03_mso.saveon import Saveon @@ -47,6 +49,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -62,7 +65,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -146,6 +148,7 @@ class MSO2CommandConstants: CHECKSUM = "CHECKSUM" # CHecksum CLEAR = "CLEAR" CLOCK = "CLOCK" + CONSTANT = "CONSTANT" # CONSTant CONTINUOUS = "CONTINUOUS" # CONTinuous CR = "CR" CRC = "CRC" @@ -193,7 +196,8 @@ class MSO2CommandConstants: FDISO = "FDISO" FDNONISO = "FDNONISO" FFT = "FFT" - FIFTY = "FIFTY" # FIFty + FIFTY = "FIFTY" # FIFTy + # FIFTY = "FIFty" FILE = "FILE" FIRST = "FIRST" FIXED = "FIXED" @@ -331,6 +335,7 @@ class MSO2CommandConstants: POSITIVE = "POSITIVE" # POSitive POST = "POST" POVERSHOOT = "POVERSHOOT" + PROFILE = "PROFILE" # PROFile PULSEWIDTH = "PULSEWIDTH" # PULSEWidth PWIDTH = "PWIDTH" READ = "READ" @@ -437,7 +442,6 @@ class MSO2CommandConstants: WAKEUP = "WAKEUP" # WAKEup WAVEFORM = "WAVEFORM" # WAVEFORM = "WAVEform" - WAVEVIEW1 = "WAVEVIEW1" WIDTH = "WIDTH" # WIDth WITHIN = "WITHIN" # WIThin WRITE = "WRITE" @@ -478,6 +482,7 @@ class MSO2Commands: - ``.connected``: The ``CONNected`` command tree. - ``.curve``: The ``CURVe`` command. - ``.curvestream``: The ``CURVEStream`` command. + - ``.customtable``: The ``CUSTOMTABle`` command tree. - ``.data``: The ``DATa`` command. - ``.date``: The ``DATE`` command. - ``.dch``: The ``DCH`` command tree. @@ -514,6 +519,7 @@ class MSO2Commands: - ``.pause``: The ``PAUSe`` command. - ``.pg``: The ``PG`` command tree. - ``.plot``: The ``PLOT`` command tree. + - ``.power``: The ``POWer`` command tree. - ``.psc``: The ``*PSC`` command. - ``.pud``: The ``*PUD`` command. - ``.recall``: The ``RECAll`` command tree. @@ -574,6 +580,7 @@ def __init__(self, device: Optional[PIDevice] = None) -> None: # noqa: PLR0915 self._connected = Connected(device) self._curve = Curve(device) self._curvestream = Curvestream(device) + self._customtable = Customtable(device) self._data = Data(device) self._date = Date(device) self._dch: Dict[int, DchItem] = DefaultDictPassKeyToFactory( @@ -612,6 +619,7 @@ def __init__(self, device: Optional[PIDevice] = None) -> None: # noqa: PLR0915 self._pause = Pause(device) self._pg = Pg(device) self._plot = Plot(device) + self._power = Power(device) self._psc = Psc(device) self._pud = Pud(device) self._recall = Recall(device) @@ -1001,7 +1009,9 @@ def callouts(self) -> Callouts: AssertionError if the returned value does not match ``value``. Sub-properties: - - ``.callout``: The ``CALLOUTS:CALLOUT`` command. + - ``.addnew``: The ``CALLOUTS:ADDNew`` command. + - ``.callout``: The ``CALLOUTS:CALLOUT`` command tree. + - ``.delete``: The ``CALLOUTS:DELete`` command. """ return self._callouts @@ -1209,6 +1219,22 @@ def curvestream(self) -> Curvestream: """ return self._curvestream + @property + def customtable(self) -> Customtable: + """Return the ``CUSTOMTABle`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``CUSTOMTABle?`` query. + - Using the ``.verify(value)`` method will send the ``CUSTOMTABle?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.addnew``: The ``CUSTOMTABle:ADDNew`` command. + - ``.delete``: The ``CUSTOMTABle:DELete`` command. + - ``.list``: The ``CUSTOMTABle:LIST`` command. + """ + return self._customtable + @property def data(self) -> Data: """Return the ``DATa`` command. @@ -1392,13 +1418,12 @@ def display(self) -> Display: - ``.intensity``: The ``DISplay:INTENSITy`` command. - ``.mathfftview1``: The ``DISplay:MATHFFTView1`` command tree. - ``.persistence``: The ``DISplay:PERSistence`` command. - - ``.plotview``: The ``DISplay:PLOTVIEW`` command tree. - ``.plotview1``: The ``DISplay:PLOTView1`` command tree. - ``.reffftview``: The ``DISplay:REFFFTView`` command tree. - ``.select``: The ``DISplay:SELect`` command tree. - ``.varpersist``: The ``DISplay:VARpersist`` command. - - ``.waveview1``: The ``DISplay:WAVEView1`` command tree. - ``.waveview``: The ``DISplay:WAVEView`` command tree. + - ``.waveview1``: The ``DISplay:WAVEView1`` command tree. - ``.waveform``: The ``DISplay:WAVEform`` command. - ``.ch``: The ``DISplay:CH`` command tree. - ``.math``: The ``DISplay:Math`` command tree. @@ -2101,6 +2126,22 @@ def plot(self) -> Plot: """ return self._plot + @property + def power(self) -> Power: + """Return the ``POWer`` command tree. + + **Usage:** + - Using the ``.query()`` method will send the ``POWer?`` query. + - Using the ``.verify(value)`` method will send the ``POWer?`` query and raise an + AssertionError if the returned value does not match ``value``. + + Sub-properties: + - ``.addnew``: The ``POWer:ADDNew`` command. + - ``.delete``: The ``POWer:DELete`` command. + - ``.power``: The ``POWer:POWer`` command tree. + """ + return self._power + @property def psc(self) -> Psc: """Return the ``*PSC`` command. @@ -2360,6 +2401,7 @@ def select(self) -> Select: AssertionError if the returned value does not match ``value``. Sub-properties: + - ``.ch``: The ``SELect:CH`` command. - ``.dch``: The ``SELect:DCH`` command tree. """ return self._select @@ -2859,6 +2901,7 @@ def commands(self) -> MSO2Commands: - ``.connected``: The ``CONNected`` command tree. - ``.curve``: The ``CURVe`` command. - ``.curvestream``: The ``CURVEStream`` command. + - ``.customtable``: The ``CUSTOMTABle`` command tree. - ``.data``: The ``DATa`` command. - ``.date``: The ``DATE`` command. - ``.dch``: The ``DCH`` command tree. @@ -2895,6 +2938,7 @@ def commands(self) -> MSO2Commands: - ``.pause``: The ``PAUSe`` command. - ``.pg``: The ``PG`` command tree. - ``.plot``: The ``PLOT`` command tree. + - ``.power``: The ``POWer`` command tree. - ``.psc``: The ``*PSC`` command. - ``.pud``: The ``*PUD`` command. - ``.recall``: The ``RECAll`` command tree. diff --git a/src/tm_devices/commands/_mso4_commands.py b/src/tm_devices/commands/_mso4_commands.py index aa530101..6c5b4755 100644 --- a/src/tm_devices/commands/_mso4_commands.py +++ b/src/tm_devices/commands/_mso4_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso4b_commands.py b/src/tm_devices/commands/_mso4b_commands.py index e742da5a..00c0bb4e 100644 --- a/src/tm_devices/commands/_mso4b_commands.py +++ b/src/tm_devices/commands/_mso4b_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso4k_commands.py b/src/tm_devices/commands/_mso4k_commands.py index 444260d9..ccf78467 100644 --- a/src/tm_devices/commands/_mso4k_commands.py +++ b/src/tm_devices/commands/_mso4k_commands.py @@ -51,6 +51,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1lxxm9_msomdodpo.cursor import Cursor from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration @@ -70,7 +71,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mso4kb_commands.py b/src/tm_devices/commands/_mso4kb_commands.py index 9d258c72..be457828 100644 --- a/src/tm_devices/commands/_mso4kb_commands.py +++ b/src/tm_devices/commands/_mso4kb_commands.py @@ -52,6 +52,7 @@ from ._1ltpwt_mdomsodpo.wfminpre import Wfminpre from ._1ltpwt_mdomsodpo.wfmoutpre import Wfmoutpre from ._1ltpwt_mdomsodpo.zoom import Zoom +from ._1lwj1r_msomdodpo.rosc import Rosc from ._1mlt9u_mdomsodpo.acquire import Acquire from ._1mlt9u_mdomsodpo.configuration import Configuration from ._1mlt9u_mdomsodpo.deskew import Deskew @@ -70,7 +71,6 @@ from ._1nmc1o_msodpomdo.verbose import Verbose from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._fhrp27_msodpomdodsa.curve import Curve from ._fhrp27_msodpomdodsa.date import Date from ._fhrp27_msodpomdodsa.mathvar import Mathvar diff --git a/src/tm_devices/commands/_mso5_commands.py b/src/tm_devices/commands/_mso5_commands.py index 16a3dd39..1e38226c 100644 --- a/src/tm_devices/commands/_mso5_commands.py +++ b/src/tm_devices/commands/_mso5_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso5b_commands.py b/src/tm_devices/commands/_mso5b_commands.py index f8a588f7..d8967ee0 100644 --- a/src/tm_devices/commands/_mso5b_commands.py +++ b/src/tm_devices/commands/_mso5b_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso5lp_commands.py b/src/tm_devices/commands/_mso5lp_commands.py index dcacb044..008ca9a2 100644 --- a/src/tm_devices/commands/_mso5lp_commands.py +++ b/src/tm_devices/commands/_mso5lp_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso6_commands.py b/src/tm_devices/commands/_mso6_commands.py index fa67e6cd..986d25db 100644 --- a/src/tm_devices/commands/_mso6_commands.py +++ b/src/tm_devices/commands/_mso6_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_mso6b_commands.py b/src/tm_devices/commands/_mso6b_commands.py index 87eedd42..d1442a53 100644 --- a/src/tm_devices/commands/_mso6b_commands.py +++ b/src/tm_devices/commands/_mso6b_commands.py @@ -16,7 +16,6 @@ from ._e3e9uu_lpdmso.bus import Bus from ._e3e9uu_lpdmso.callouts import Callouts from ._e3e9uu_lpdmso.ch import Channel -from ._e3e9uu_lpdmso.customtable import Customtable from ._e3e9uu_lpdmso.data import Data from ._e3e9uu_lpdmso.diag import Diag from ._e3e9uu_lpdmso.diggrp import DiggrpItem @@ -36,6 +35,7 @@ from ._e3e9uu_lpdmso.plot import Plot from ._e3e9uu_lpdmso.power import Power from ._e3e9uu_lpdmso.ref import Ref, RefItem +from ._e3e9uu_lpdmso.rosc import Rosc from ._e3e9uu_lpdmso.save import Save from ._e3e9uu_lpdmso.saveon import Saveon from ._e3e9uu_lpdmso.saveonevent import Saveonevent @@ -57,6 +57,7 @@ from ._e3h2zs_lpdmso.connected import Connected from ._e3h2zs_lpdmso.curve import Curve from ._e3h2zs_lpdmso.curvestream import Curvestream +from ._e3h2zs_lpdmso.customtable import Customtable from ._e3h2zs_lpdmso.date import Date from ._e3h2zs_lpdmso.ethernet import Ethernet from ._e3h2zs_lpdmso.filesystem import Filesystem @@ -72,7 +73,6 @@ from ._e4de2d_lpdmsomdo.clear import Clear from ._e6lgg1_lpdmsodpomdo.totaluptime import Totaluptime from ._e6606z_lpdmsomdodpo.pause import Pause -from ._e6606z_lpdmsomdodpo.rosc import Rosc from ._ft5uww_lpdmsodpomdoafgawgdsa.calibration import Cal from ._ft5uww_lpdmsodpomdoafgawgdsa.miscellaneous import Idn, Trg, Tst from ._ft5uww_lpdmsodpomdoafgawgdsa.status_and_error import Cls, Esr, Opc, Rst, Stb, Wai @@ -3609,6 +3609,7 @@ def trigger(self) -> Trigger: - ``.b``: The ``TRIGger:B`` command tree. - ``.hysteresis``: The ``TRIGger:HYSTeresis`` command tree. - ``.state``: The ``TRIGger:STATE`` command. + - ``.status``: The ``TRIGger:STATUs`` command. """ return self._trigger diff --git a/src/tm_devices/commands/_smu2601b_commands.py b/src/tm_devices/commands/_smu2601b_commands.py index e8347660..4f64fd42 100644 --- a/src/tm_devices/commands/_smu2601b_commands.py +++ b/src/tm_devices/commands/_smu2601b_commands.py @@ -1260,6 +1260,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2601b_pulse_commands.py b/src/tm_devices/commands/_smu2601b_pulse_commands.py index ac9f20d8..bd38a038 100644 --- a/src/tm_devices/commands/_smu2601b_pulse_commands.py +++ b/src/tm_devices/commands/_smu2601b_pulse_commands.py @@ -1043,6 +1043,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.pulser``: The ``smuX.pulser`` command tree. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. diff --git a/src/tm_devices/commands/_smu2602b_commands.py b/src/tm_devices/commands/_smu2602b_commands.py index 0d343883..459584c6 100644 --- a/src/tm_devices/commands/_smu2602b_commands.py +++ b/src/tm_devices/commands/_smu2602b_commands.py @@ -1366,6 +1366,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2604b_commands.py b/src/tm_devices/commands/_smu2604b_commands.py index 1a579638..18b853d8 100644 --- a/src/tm_devices/commands/_smu2604b_commands.py +++ b/src/tm_devices/commands/_smu2604b_commands.py @@ -1174,6 +1174,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2606b_commands.py b/src/tm_devices/commands/_smu2606b_commands.py index dae7bbe6..de43c2e7 100644 --- a/src/tm_devices/commands/_smu2606b_commands.py +++ b/src/tm_devices/commands/_smu2606b_commands.py @@ -1333,6 +1333,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2611b_commands.py b/src/tm_devices/commands/_smu2611b_commands.py index e46568ce..ad16fddb 100644 --- a/src/tm_devices/commands/_smu2611b_commands.py +++ b/src/tm_devices/commands/_smu2611b_commands.py @@ -1257,6 +1257,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2612b_commands.py b/src/tm_devices/commands/_smu2612b_commands.py index 707f597f..3faa5119 100644 --- a/src/tm_devices/commands/_smu2612b_commands.py +++ b/src/tm_devices/commands/_smu2612b_commands.py @@ -1363,6 +1363,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2614b_commands.py b/src/tm_devices/commands/_smu2614b_commands.py index f324749c..9cf0488b 100644 --- a/src/tm_devices/commands/_smu2614b_commands.py +++ b/src/tm_devices/commands/_smu2614b_commands.py @@ -1171,6 +1171,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2634b_commands.py b/src/tm_devices/commands/_smu2634b_commands.py index f6db9a5a..7556c43b 100644 --- a/src/tm_devices/commands/_smu2634b_commands.py +++ b/src/tm_devices/commands/_smu2634b_commands.py @@ -1173,6 +1173,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2635b_commands.py b/src/tm_devices/commands/_smu2635b_commands.py index 408c2684..a1ea2647 100644 --- a/src/tm_devices/commands/_smu2635b_commands.py +++ b/src/tm_devices/commands/_smu2635b_commands.py @@ -1259,6 +1259,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2636b_commands.py b/src/tm_devices/commands/_smu2636b_commands.py index 58ebe667..56cddb8b 100644 --- a/src/tm_devices/commands/_smu2636b_commands.py +++ b/src/tm_devices/commands/_smu2636b_commands.py @@ -1365,6 +1365,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2651a_commands.py b/src/tm_devices/commands/_smu2651a_commands.py index 672955a5..f3805a62 100644 --- a/src/tm_devices/commands/_smu2651a_commands.py +++ b/src/tm_devices/commands/_smu2651a_commands.py @@ -1326,6 +1326,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_smu2657a_commands.py b/src/tm_devices/commands/_smu2657a_commands.py index 9c20749e..33f658a1 100644 --- a/src/tm_devices/commands/_smu2657a_commands.py +++ b/src/tm_devices/commands/_smu2657a_commands.py @@ -1325,6 +1325,8 @@ def smu(self) -> Dict[str, SmuxItem]: - ``.measurepandstep()``: The ``smuX.measurepandstep()`` function. - ``.measurerandstep()``: The ``smuX.measurerandstep()`` function. - ``.measurevandstep()``: The ``smuX.measurevandstep()`` function. + - ``.nvbuffer1``: The ``smuX.nvbuffer1`` attribute. + - ``.nvbuffer2``: The ``smuX.nvbuffer2`` attribute. - ``.reset()``: The ``smuX.reset()`` function. - ``.savebuffer()``: The ``smuX.savebuffer()`` function. - ``.sense``: The ``smuX.sense`` attribute. diff --git a/src/tm_devices/commands/_u301s_msodpo/ch.py b/src/tm_devices/commands/_u301s_msodpo/ch.py index f52727b3..a14f6b30 100644 --- a/src/tm_devices/commands/_u301s_msodpo/ch.py +++ b/src/tm_devices/commands/_u301s_msodpo/ch.py @@ -152,12 +152,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): """The ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is the - channel number. This setting controls the vertical size of the acquisition window as well - as the display scale. The range and resolution of scale values depends on the probe - attached and any other external factors you have specified. For a signal with constant - amplitude, increasing the scale causes the waveform to be displayed smaller. Decreasing - the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -173,8 +169,8 @@ class ChannelScale(SCPICmdWrite, SCPICmdRead): - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ @@ -1340,12 +1336,8 @@ def scale(self) -> ChannelScale: """Return the ``CH:SCAle`` command. **Description:** - - This command specifies the vertical scale for the channel specified by , where x is - the channel number. This setting controls the vertical size of the acquisition window - as well as the display scale. The range and resolution of scale values depends on the - probe attached and any other external factors you have specified. For a signal with - constant amplitude, increasing the scale causes the waveform to be displayed smaller. - Decreasing the scale causes the waveform to be displayed larger. + - This command sets or returns the vertical scale for the specified analog channel. The + channel is specified by x. **Usage:** - Using the ``.query()`` method will send the ``CH:SCAle?`` query. @@ -1361,8 +1353,8 @@ def scale(self) -> ChannelScale: - CH:SCAle? **Info:** - - ```` is a floating point number that specifies the vertical channel scale in - units-per-division. The value entered here is truncated to three significant digits. + - ``CH`` is the channel number. + - ```` is the vertical scale for the specified analog channel. """ return self._scale diff --git a/tests/auto_gen_cmds_list.json b/tests/auto_gen_cmds_list.json index 25d6d700..b829de79 100644 --- a/tests/auto_gen_cmds_list.json +++ b/tests/auto_gen_cmds_list.json @@ -514,6 +514,8 @@ "BUS:B:PARallel:CLOCk:ISCLOCKED", "BUS:B:PARallel:CLOCk:ISCLOCKed", "BUS:B:PARallel:CLOCk:SOUrce", + "BUS:B:PARallel:CLOCkSOUrce", + "BUS:B:PARallel:CLOCkSOUrce:THReshold", "BUS:B:PARallel:ISCLOCKED", "BUS:B:PARallel:SOURCES", "BUS:B:PARallel:WIDth", @@ -687,7 +689,6 @@ "BWAVeform:RESet", "BWAVeform:SRATe", "CALLOUTS:ADDNew", - "CALLOUTS:CALLOUT", "CALLOUTS:CALLOUT:BOOKMark:SOURCE", "CALLOUTS:CALLOUT:BOOKMark:XPOS", "CALLOUTS:CALLOUT:COLOR", @@ -700,6 +701,7 @@ "CALLOUTS:CALLOUT:FONT:UNDERLine", "CALLOUTS:CALLOUT:TEXT", "CALLOUTS:CALLOUT:TYPE", + "CALLOUTS:DELete", "CALibrate", "CALibrate:CALProbe:CH", "CALibrate:FACtory", @@ -1240,8 +1242,6 @@ "DISplay:MATHFFTView:ZOOM:YAXIS:TO", "DISplay:PERSistence", "DISplay:PERSistence:RESET", - "DISplay:PLOTVIEW:XAXIS:SCALE", - "DISplay:PLOTVIEW:YAXIS:SCALE", "DISplay:PLOTView:AUTOScale", "DISplay:PLOTView:CURSor:ASOUrce", "DISplay:PLOTView:CURSor:BSOUrce", @@ -1357,7 +1357,6 @@ "DISplay:TRIGFrequency", "DISplay:TRIGT", "DISplay:VARpersist", - "DISplay:WAVEView1:DCH_DALL:DIGORDER", "DISplay:WAVEView:CURSor:CURSOR1:ROLOCATION", "DISplay:WAVEView:GRIDTYPE", "DISplay:WAVEView:BUS:B:STATE", @@ -1397,6 +1396,7 @@ "DISplay:WAVEView:CURSor:CURSOR:WAVEform:APOSition", "DISplay:WAVEView:CURSor:CURSOR:WAVEform:BPOSition", "DISplay:WAVEView:DCH_D:STATE", + "DISplay:WAVEView:DCH_DALL:DIGORDER", "DISplay:WAVEView:DCH_DALL:VERTical:POSition", "DISplay:WAVEView:FILTer", "DISplay:WAVEView:GRAticule", @@ -4011,21 +4011,6 @@ "SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:DESTinationport:VALue", "SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:SEQnum:VALue", "SEARCH:SEARCH:TRIGger:A:BUS:AUTOETHERnet:TCPHeader:SOUrceport:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:NRZ:CONDition", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:BLOCKDATa:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:CONDition", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATABITs", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:ECU:SENSor:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:A:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:DATa:REGion:B:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:ERRORTYPe", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:FUNCTIONCODETYPe", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGISTERADDRess", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:REGister:ADDRess:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSORSTATus:TYPe", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:SENSor:ADDRess:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:PSIFIVe:STATus:VALue", - "SEARCH:SEARCH:TRIGger:A:BUS:B:S8B10B:CONDition", "SEARCH:SEARCH:TRIGger:A:BUS:B:ARINC429A:CONDition", "SEARCH:SEARCH:TRIGger:A:BUS:B:ARINC429A:DATA:HIVALue", "SEARCH:SEARCH:TRIGger:A:BUS:B:ARINC429A:DATA:QUALifier", @@ -4556,6 +4541,7 @@ "SEARCH:SEARCH:TRIGger:A:BUS:MIPIDSIOne:YCBCR:CR:VALue", "SEARCH:SEARCH:TRIGger:A:BUS:MIPIDSIOne:YCBCR:Y:QUAlifier", "SEARCH:SEARCH:TRIGger:A:BUS:MIPIDSIOne:YCBCR:Y:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:NRZ:CONDition", "SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:SIZe", "SEARCH:SEARCH:TRIGger:A:BUS:NRZ:DATa:VALue", "SEARCH:SEARCH:TRIGger:A:BUS:ONEWIRe:COMMand:VALue", @@ -4586,6 +4572,19 @@ "SEARCH:SEARCH:TRIGger:A:BUS:PCIE:PATtern:ORDERedset", "SEARCH:SEARCH:TRIGger:A:BUS:PCIE:PATtern:SYMbol:MINus", "SEARCH:SEARCH:TRIGger:A:BUS:PCIE:PATtern:SYMbol:PLUS", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:BLOCKDATa:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:CONDition", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATABITs", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:ECU:SENSor:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:A:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:DATa:REGion:B:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:ERRORTYPe", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:FUNCTIONCODETYPe", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGISTERADDRess", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:REGister:ADDRess:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSORSTATus:TYPe", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:SENSor:ADDRess:VALue", + "SEARCH:SEARCH:TRIGger:A:BUS:PSIFIVe:STATus:VALue", "SEARCH:SEARCH:TRIGger:A:BUS:RS232C:CONDition", "SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:FORMat", "SEARCH:SEARCH:TRIGger:A:BUS:RS232C:DATa:SIZe", @@ -4944,6 +4943,7 @@ "SEARCH:SEARCH:TRIGger:A:SETHold:LEVel:REF", "SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH", "SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:CH_D", + "SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:DCH_D", "SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:MATH", "SEARCH:SEARCH:TRIGger:A:SETHold:LOGICPattern:REF", "SEARCH:SEARCH:TRIGger:A:SETHold:SETTime", @@ -5864,6 +5864,7 @@ "TRIGger:SLOPe", "TRIGger:SOURce", "TRIGger:STATE", + "TRIGger:STATUs", "TRIGger:WVALue", "TRIGger:{A|B|B:RESET}", "TRIGger:{A|B}:BUS:B:ARINC429A:CONDition", @@ -8088,6 +8089,7 @@ "smuX.measure.rel.enableY", "smuX.measure.rel.levelY", "smuX.measureYandstep()", + "smuX.nvbufferY", "smuX.pulser.enable", "smuX.pulser.measure.aperture", "smuX.pulser.measure.calibrateY()",