From f94f6aa4005a0a83034f9cba5ebdd3c054282a05 Mon Sep 17 00:00:00 2001 From: GANESH V Date: Mon, 18 Nov 2024 10:50:23 +0530 Subject: [PATCH] feat: updated commands with latest doc changes. --- CHANGELOG.md | 2 +- src/tm_devices/commands/dpo4k_commands.py | 5 +- src/tm_devices/commands/dpo4kb_commands.py | 5 +- .../commands/gen_163n04_mdo/mark.py | 713 ---------------- .../commands/gen_163n04_mdo/search.py | 29 +- .../commands/gen_16opiv_mdomso/__init__.py | 0 .../commands/gen_16opiv_mdomso/mark.py | 713 ---------------- .../commands/gen_16x4xq_mdo/search.py | 29 +- .../commands/gen_1kdqwg_mdo/search.py | 29 +- .../commands/gen_1kozfv_dpo/search.py | 74 ++ .../commands/gen_1le9o2_mdo/__init__.py | 0 .../commands/gen_1le9o2_mdo/mark.py | 779 ------------------ .../commands/gen_1lh2st_msodpo/search.py | 74 ++ .../commands/gen_1ltpwt_mdomsodpo/afg.py | 51 +- .../commands/gen_1ltpwt_mdomsodpo/ch.py | 4 +- .../mark.py | 14 +- .../commands/gen_1ltpwt_mdomsodpo/math1.py | 6 +- .../commands/gen_1ltpwt_mdomsodpo/power.py | 5 +- .../commands/gen_1ltpwt_mdomsodpo/vidpic.py | 6 +- .../gen_1mlt9u_mdomsodpo/histogram.py | 6 +- .../commands/gen_1mlt9u_mdomsodpo/save.py | 4 +- .../commands/gen_1msu49_msodpo/__init__.py | 0 .../commands/gen_1msu49_msodpo/mark.py | 646 --------------- .../commands/gen_1zn03_mso/search.py | 12 +- .../commands/gen_2i1z2s_awg/diagnostic.py | 12 +- .../commands/gen_2i1z2s_awg/wlist.py | 4 +- .../commands/gen_32dszm_awg/diagnostic.py | 4 +- .../commands/gen_3rs8qy_awg/diagnostic.py | 12 +- .../commands/gen_3rs8qy_awg/wlist.py | 4 +- .../commands/gen_4jiykk_dpo/errordetector.py | 6 +- .../commands/gen_4jiykk_dpo/rosc.py | 6 +- .../gen_5xwdsk_dpodsamso/errordetector.py | 6 +- .../commands/gen_c3g61_tekscopepc/bus.py | 4 +- .../gen_c3g61_tekscopepc/measurement.py | 4 +- .../commands/gen_c3g61_tekscopepc/plot.py | 4 +- .../commands/gen_c3g61_tekscopepc/power.py | 14 +- .../commands/gen_c3g61_tekscopepc/search.py | 41 +- .../commands/gen_e3e9uu_lpdmso/bus.py | 4 +- .../commands/gen_e3e9uu_lpdmso/measurement.py | 4 +- .../commands/gen_e3e9uu_lpdmso/plot.py | 4 +- .../commands/gen_e3e9uu_lpdmso/power.py | 14 +- .../commands/gen_e3e9uu_lpdmso/search.py | 41 +- .../commands/gen_e4de2d_lpdmsomdo/clear.py | 2 +- .../commands/gen_fk3z56_dpodsamso/search.py | 8 +- .../gen_fn2qbf_msodpo/errordetector.py | 6 +- .../commands/gen_fpx9s1_dpodsamso/rosc.py | 6 +- .../commands/gen_u301s_msodpo/math1.py | 6 +- .../commands/gen_ujuvb_mdo/histogram.py | 6 +- .../commands/gen_ujuvb_mdo/measurement.py | 14 +- src/tm_devices/commands/gen_ujuvb_mdo/save.py | 4 +- .../commands/gen_ujuvb_mdo/search.py | 6 +- .../commands/gen_usaa3_mdo/search.py | 74 ++ .../commands/helpers/scpi_commands.py | 4 +- src/tm_devices/commands/lpd6_commands.py | 2 +- src/tm_devices/commands/mdo3_commands.py | 4 +- src/tm_devices/commands/mdo3k_commands.py | 3 +- src/tm_devices/commands/mdo4k_commands.py | 3 +- src/tm_devices/commands/mdo4kb_commands.py | 2 +- src/tm_devices/commands/mdo4kc_commands.py | 2 +- src/tm_devices/commands/mso2_commands.py | 2 +- src/tm_devices/commands/mso4_commands.py | 2 +- src/tm_devices/commands/mso4b_commands.py | 2 +- src/tm_devices/commands/mso4k_commands.py | 5 +- src/tm_devices/commands/mso4kb_commands.py | 3 +- src/tm_devices/commands/mso5_commands.py | 2 +- src/tm_devices/commands/mso5b_commands.py | 2 +- src/tm_devices/commands/mso5lp_commands.py | 2 +- src/tm_devices/commands/mso6_commands.py | 2 +- src/tm_devices/commands/mso6b_commands.py | 2 +- 69 files changed, 452 insertions(+), 3118 deletions(-) delete mode 100644 src/tm_devices/commands/gen_163n04_mdo/mark.py delete mode 100644 src/tm_devices/commands/gen_16opiv_mdomso/__init__.py delete mode 100644 src/tm_devices/commands/gen_16opiv_mdomso/mark.py delete mode 100644 src/tm_devices/commands/gen_1le9o2_mdo/__init__.py delete mode 100644 src/tm_devices/commands/gen_1le9o2_mdo/mark.py rename src/tm_devices/commands/{gen_ujuvb_mdo => gen_1ltpwt_mdomsodpo}/mark.py (96%) delete mode 100644 src/tm_devices/commands/gen_1msu49_msodpo/__init__.py delete mode 100644 src/tm_devices/commands/gen_1msu49_msodpo/mark.py diff --git a/CHANGELOG.md b/CHANGELOG.md index bb80ea43..762c8556 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,7 +32,7 @@ Things to be included in the next release go here. - A logfile is now created that contains each command sent to a VISA device. - This file is located next to the main log file and will start with the same name, but have the unique address of the device appended. - This file will only be created if file logging is enabled for the package (which is the default behavior). -- Full Python API support for MDO3 model. +- Full Python API support for the MDO3 model. ### Changed diff --git a/src/tm_devices/commands/dpo4k_commands.py b/src/tm_devices/commands/dpo4k_commands.py index 3c9ebdbe..4bfaddb2 100644 --- a/src/tm_devices/commands/dpo4k_commands.py +++ b/src/tm_devices/commands/dpo4k_commands.py @@ -35,6 +35,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -61,7 +62,6 @@ from .gen_1mlt9u_mdomsodpo.save import Save from .gen_1mlt9u_mdomsodpo.select import Select from .gen_1mq0z9_msodpo.rf import Rf -from .gen_1msu49_msodpo.mark import Mark from .gen_1nmc1o_msodpomdo.clearmenu import Clearmenu from .gen_1nmc1o_msodpomdo.errlog import Errlog from .gen_1nmc1o_msodpomdo.language import Language @@ -212,6 +212,7 @@ class DPO4KCommandConstants: CMOS_2_5V = "CMOS_2_5V" CMOS_3_3V = "CMOS_3_3V" CMOS_5_0V = "CMOS_5_0V" + COLUMN = "COLUMN" COMMAND = "COMMAND" COPYACTIVE = "COPYACTIVE" # COPYACTive CPU = "CPU" @@ -2084,6 +2085,8 @@ def mark(self) -> Mark: - ``PREVious`` moves to the next reference mark on the left. Sub-properties: + - ``.create``: The ``MARK:CREATE`` command. + - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. - ``.selected``: The ``MARK:SELected`` command tree. diff --git a/src/tm_devices/commands/dpo4kb_commands.py b/src/tm_devices/commands/dpo4kb_commands.py index 3881e271..caa7d6fe 100644 --- a/src/tm_devices/commands/dpo4kb_commands.py +++ b/src/tm_devices/commands/dpo4kb_commands.py @@ -35,6 +35,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -61,7 +62,6 @@ from .gen_1mlt9u_mdomsodpo.save import Save from .gen_1mlt9u_mdomsodpo.select import Select from .gen_1mq0z9_msodpo.rf import Rf -from .gen_1msu49_msodpo.mark import Mark from .gen_1nmc1o_msodpomdo.clearmenu import Clearmenu from .gen_1nmc1o_msodpomdo.errlog import Errlog from .gen_1nmc1o_msodpomdo.language import Language @@ -212,6 +212,7 @@ class DPO4KBCommandConstants: CMOS_2_5V = "CMOS_2_5V" CMOS_3_3V = "CMOS_3_3V" CMOS_5_0V = "CMOS_5_0V" + COLUMN = "COLUMN" COMMAND = "COMMAND" COPYACTIVE = "COPYACTIVE" # COPYACTive CPU = "CPU" @@ -2092,6 +2093,8 @@ def mark(self) -> Mark: - ``PREVious`` moves to the next reference mark on the left. Sub-properties: + - ``.create``: The ``MARK:CREATE`` command. + - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. - ``.selected``: The ``MARK:SELected`` command tree. diff --git a/src/tm_devices/commands/gen_163n04_mdo/mark.py b/src/tm_devices/commands/gen_163n04_mdo/mark.py deleted file mode 100644 index 2b8ca007..00000000 --- a/src/tm_devices/commands/gen_163n04_mdo/mark.py +++ /dev/null @@ -1,713 +0,0 @@ -# pylint: disable=line-too-long -"""The mark commands module. - -These commands are used in the following models: -MDO4K - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - ``` - - MARK {NEXT|PREVious} - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - - MARK:FREE? - - MARK:SAVEALL TOUSER - - MARK:SELected:END? - - MARK:SELected:FOCUS? - - MARK:SELected:MARKSINCOLumn? - - MARK:SELected:OWNer? - - MARK:SELected:SOURCe? - - MARK:SELected:STARt? - - MARK:SELected:STATE? - - MARK:SELected:ZOOm:POSition? - - MARK:TOTal? - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - - MARK? - ``` -""" # noqa: E501 - -from typing import Optional, TYPE_CHECKING - -from ..helpers import SCPICmdRead, SCPICmdWrite - -if TYPE_CHECKING: - from tm_devices.driver_mixins.device_control.pi_control import PIControl - - -class MarkUserlist(SCPICmdWrite, SCPICmdRead): - """The ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the command - form if any of the following conditions are true: The source waveform is not turned on. - The position of the mark is not on the waveform. The maximum number of marks would be - exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - - -class MarkTotal(SCPICmdRead): - """The ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - - -class MarkSelectedZoomPosition(SCPICmdRead): - """The ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - - -class MarkSelectedZoom(SCPICmdRead): - """The ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._position = MarkSelectedZoomPosition(device, f"{self._cmd_syntax}:POSition") - - @property - def position(self) -> MarkSelectedZoomPosition: - """Return the ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - return self._position - - -class MarkSelectedState(SCPICmdRead): - """The ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - - -class MarkSelectedStart(SCPICmdRead): - """The ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - - -class MarkSelectedSource(SCPICmdRead): - """The ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - - -class MarkSelectedOwner(SCPICmdRead): - """The ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - - -class MarkSelectedMarksincolumn(SCPICmdRead): - """The ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - - -class MarkSelectedFocus(SCPICmdRead): - """The ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - - -class MarkSelectedEnd(SCPICmdRead): - """The ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - - -# pylint: disable=too-many-instance-attributes -class MarkSelected(SCPICmdRead): - """The ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._end = MarkSelectedEnd(device, f"{self._cmd_syntax}:END") - self._focus = MarkSelectedFocus(device, f"{self._cmd_syntax}:FOCUS") - self._marksincolumn = MarkSelectedMarksincolumn(device, f"{self._cmd_syntax}:MARKSINCOLumn") - self._owner = MarkSelectedOwner(device, f"{self._cmd_syntax}:OWNer") - self._source = MarkSelectedSource(device, f"{self._cmd_syntax}:SOURCe") - self._start = MarkSelectedStart(device, f"{self._cmd_syntax}:STARt") - self._state = MarkSelectedState(device, f"{self._cmd_syntax}:STATE") - self._zoom = MarkSelectedZoom(device, f"{self._cmd_syntax}:ZOOm") - - @property - def end(self) -> MarkSelectedEnd: - """Return the ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - return self._end - - @property - def focus(self) -> MarkSelectedFocus: - """Return the ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - return self._focus - - @property - def marksincolumn(self) -> MarkSelectedMarksincolumn: - """Return the ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - return self._marksincolumn - - @property - def owner(self) -> MarkSelectedOwner: - """Return the ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - return self._owner - - @property - def source(self) -> MarkSelectedSource: - """Return the ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - return self._source - - @property - def start(self) -> MarkSelectedStart: - """Return the ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - return self._start - - @property - def state(self) -> MarkSelectedState: - """Return the ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - return self._state - - @property - def zoom(self) -> MarkSelectedZoom: - """Return the ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - return self._zoom - - -class MarkSaveall(SCPICmdWrite): - """The ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user search - mark list in internal memory. (This is equivalent to pressing the 'Save All Marks' button - in the Search button menu on the front panel.) In order to retrieve the information, use - the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - - -class MarkFree(SCPICmdRead): - """The ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - - -class MarkDelete(SCPICmdWrite): - """The ``MARK:DELEte`` command. - - Description: - - This command deletes a mark on a particular waveform, all waveforms in a column, the - selected mark, or all marks. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:DELEte value`` command. - - SCPI Syntax: - ``` - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` deletes the mark on a channel waveform, where is the channel number. - - ``MATH`` deletes the mark on the math waveform. - - ``B`` deletes the mark on a bus waveform, where . - - ``REF`` deletes the mark on a reference waveform, where is the reference waveform - number. - - ``DIGital`` deletes all marks on all digital channels. (MSO/MDO4000/B models only as well - as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``RF_AMPlitude`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_FREQuency`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_PHASe`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``COLUMN`` deletes marks on all waveforms in the current zoom pixel column. - """ # noqa: E501 - - -class Mark(SCPICmdWrite, SCPICmdRead): - """The ``MARK`` command. - - Description: - - Moves to the next or previous reference mark on the waveform. Returns the current mark - position. - - Usage: - - Using the ``.query()`` method will send the ``MARK?`` query. - - Using the ``.verify(value)`` method will send the ``MARK?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK value`` command. - - SCPI Syntax: - ``` - - MARK {NEXT|PREVious} - - MARK? - ``` - - Info: - - ``NEXT`` moves to the next reference mark on the right. - - ``PREVious`` moves to the next reference mark on the left. - - Properties: - - ``.delete``: The ``MARK:DELEte`` command. - - ``.free``: The ``MARK:FREE`` command. - - ``.saveall``: The ``MARK:SAVEALL`` command. - - ``.selected``: The ``MARK:SELected`` command tree. - - ``.total``: The ``MARK:TOTal`` command. - - ``.userlist``: The ``MARK:USERLIST`` command. - """ - - def __init__(self, device: Optional["PIControl"] = None, cmd_syntax: str = "MARK") -> None: - super().__init__(device, cmd_syntax) - self._delete = MarkDelete(device, f"{self._cmd_syntax}:DELEte") - self._free = MarkFree(device, f"{self._cmd_syntax}:FREE") - self._saveall = MarkSaveall(device, f"{self._cmd_syntax}:SAVEALL") - self._selected = MarkSelected(device, f"{self._cmd_syntax}:SELected") - self._total = MarkTotal(device, f"{self._cmd_syntax}:TOTal") - self._userlist = MarkUserlist(device, f"{self._cmd_syntax}:USERLIST") - - @property - def delete(self) -> MarkDelete: - """Return the ``MARK:DELEte`` command. - - Description: - - This command deletes a mark on a particular waveform, all waveforms in a column, the - selected mark, or all marks. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:DELEte value`` command. - - SCPI Syntax: - ``` - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` deletes the mark on a channel waveform, where is the channel number. - - ``MATH`` deletes the mark on the math waveform. - - ``B`` deletes the mark on a bus waveform, where . - - ``REF`` deletes the mark on a reference waveform, where is the reference - waveform number. - - ``DIGital`` deletes all marks on all digital channels. (MSO/MDO4000/B models only as - well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``RF_AMPlitude`` deletes the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` deletes the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_PHASe`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``COLUMN`` deletes marks on all waveforms in the current zoom pixel column. - """ # noqa: E501 - return self._delete - - @property - def free(self) -> MarkFree: - """Return the ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - return self._free - - @property - def saveall(self) -> MarkSaveall: - """Return the ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user - search mark list in internal memory. (This is equivalent to pressing the 'Save All - Marks' button in the Search button menu on the front panel.) In order to retrieve the - information, use the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - return self._saveall - - @property - def selected(self) -> MarkSelected: - """Return the ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - return self._selected - - @property - def total(self) -> MarkTotal: - """Return the ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - return self._total - - @property - def userlist(self) -> MarkUserlist: - """Return the ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the - command form if any of the following conditions are true: The source waveform is not - turned on. The position of the mark is not on the waveform. The maximum number of - marks would be exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - return self._userlist diff --git a/src/tm_devices/commands/gen_163n04_mdo/search.py b/src/tm_devices/commands/gen_163n04_mdo/search.py index 53314091..b32948fe 100644 --- a/src/tm_devices/commands/gen_163n04_mdo/search.py +++ b/src/tm_devices/commands/gen_163n04_mdo/search.py @@ -1309,19 +1309,12 @@ class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. - - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or - MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models only.). + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). """ # noqa: E501 @@ -1430,20 +1423,12 @@ def source(self) -> SearchSearchItemTriggerATimeoutSource: ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. + waveform. - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO - or MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). + (Requires option 3-MSO.). """ # noqa: E501 return self._source diff --git a/src/tm_devices/commands/gen_16opiv_mdomso/__init__.py b/src/tm_devices/commands/gen_16opiv_mdomso/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/src/tm_devices/commands/gen_16opiv_mdomso/mark.py b/src/tm_devices/commands/gen_16opiv_mdomso/mark.py deleted file mode 100644 index 300a3c65..00000000 --- a/src/tm_devices/commands/gen_16opiv_mdomso/mark.py +++ /dev/null @@ -1,713 +0,0 @@ -# pylint: disable=line-too-long -"""The mark commands module. - -These commands are used in the following models: -MDO3K, MSO4KB - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - ``` - - MARK {NEXT|PREVious} - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - - MARK:FREE? - - MARK:SAVEALL TOUSER - - MARK:SELected:END? - - MARK:SELected:FOCUS? - - MARK:SELected:MARKSINCOLumn? - - MARK:SELected:OWNer? - - MARK:SELected:SOURCe? - - MARK:SELected:STARt? - - MARK:SELected:STATE? - - MARK:SELected:ZOOm:POSition? - - MARK:TOTal? - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - - MARK? - ``` -""" # noqa: E501 - -from typing import Optional, TYPE_CHECKING - -from ..helpers import SCPICmdRead, SCPICmdWrite - -if TYPE_CHECKING: - from tm_devices.driver_mixins.device_control.pi_control import PIControl - - -class MarkUserlist(SCPICmdWrite, SCPICmdRead): - """The ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the command - form if any of the following conditions are true: The source waveform is not turned on. - The position of the mark is not on the waveform. The maximum number of marks would be - exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - - -class MarkTotal(SCPICmdRead): - """The ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - - -class MarkSelectedZoomPosition(SCPICmdRead): - """The ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - - -class MarkSelectedZoom(SCPICmdRead): - """The ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._position = MarkSelectedZoomPosition(device, f"{self._cmd_syntax}:POSition") - - @property - def position(self) -> MarkSelectedZoomPosition: - """Return the ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - return self._position - - -class MarkSelectedState(SCPICmdRead): - """The ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - - -class MarkSelectedStart(SCPICmdRead): - """The ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - - -class MarkSelectedSource(SCPICmdRead): - """The ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - - -class MarkSelectedOwner(SCPICmdRead): - """The ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - - -class MarkSelectedMarksincolumn(SCPICmdRead): - """The ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - - -class MarkSelectedFocus(SCPICmdRead): - """The ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - - -class MarkSelectedEnd(SCPICmdRead): - """The ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - - -# pylint: disable=too-many-instance-attributes -class MarkSelected(SCPICmdRead): - """The ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._end = MarkSelectedEnd(device, f"{self._cmd_syntax}:END") - self._focus = MarkSelectedFocus(device, f"{self._cmd_syntax}:FOCUS") - self._marksincolumn = MarkSelectedMarksincolumn(device, f"{self._cmd_syntax}:MARKSINCOLumn") - self._owner = MarkSelectedOwner(device, f"{self._cmd_syntax}:OWNer") - self._source = MarkSelectedSource(device, f"{self._cmd_syntax}:SOURCe") - self._start = MarkSelectedStart(device, f"{self._cmd_syntax}:STARt") - self._state = MarkSelectedState(device, f"{self._cmd_syntax}:STATE") - self._zoom = MarkSelectedZoom(device, f"{self._cmd_syntax}:ZOOm") - - @property - def end(self) -> MarkSelectedEnd: - """Return the ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - return self._end - - @property - def focus(self) -> MarkSelectedFocus: - """Return the ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - return self._focus - - @property - def marksincolumn(self) -> MarkSelectedMarksincolumn: - """Return the ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - return self._marksincolumn - - @property - def owner(self) -> MarkSelectedOwner: - """Return the ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - return self._owner - - @property - def source(self) -> MarkSelectedSource: - """Return the ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - return self._source - - @property - def start(self) -> MarkSelectedStart: - """Return the ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - return self._start - - @property - def state(self) -> MarkSelectedState: - """Return the ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - return self._state - - @property - def zoom(self) -> MarkSelectedZoom: - """Return the ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - return self._zoom - - -class MarkSaveall(SCPICmdWrite): - """The ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user search - mark list in internal memory. (This is equivalent to pressing the 'Save All Marks' button - in the Search button menu on the front panel.) In order to retrieve the information, use - the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - - -class MarkFree(SCPICmdRead): - """The ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - - -class MarkCreate(SCPICmdWrite): - """The ``MARK:CREATE`` command. - - Description: - - Creates a mark on a specified waveform or all waveforms in a column. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:CREATE value`` command. - - SCPI Syntax: - ``` - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` creates the mark on a channel waveform, where is the channel number. - - ``MATH`` creates the mark on the math waveform. - - ``B`` creates the mark on a bus waveform, where . - - ``REF`` creates the mark on a reference waveform, where is the reference waveform - number. - - ``DIGital`` creates the mark on a digital waveform. (An error will result if no digital - channel is turned on.) (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models - with option MDO3MSO or MDO4MSO installed.). - - ``COLUMN`` creates marks on all waveforms in the current zoom pixel column. - - ``RF_AMPlitude`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_FREQuency`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_PHASe`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - """ # noqa: E501 - - -class Mark(SCPICmdWrite, SCPICmdRead): - """The ``MARK`` command. - - Description: - - Moves to the next or previous reference mark on the waveform. Returns the current mark - position. - - Usage: - - Using the ``.query()`` method will send the ``MARK?`` query. - - Using the ``.verify(value)`` method will send the ``MARK?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK value`` command. - - SCPI Syntax: - ``` - - MARK {NEXT|PREVious} - - MARK? - ``` - - Info: - - ``NEXT`` moves to the next reference mark on the right. - - ``PREVious`` moves to the next reference mark on the left. - - Properties: - - ``.create``: The ``MARK:CREATE`` command. - - ``.free``: The ``MARK:FREE`` command. - - ``.saveall``: The ``MARK:SAVEALL`` command. - - ``.selected``: The ``MARK:SELected`` command tree. - - ``.total``: The ``MARK:TOTal`` command. - - ``.userlist``: The ``MARK:USERLIST`` command. - """ - - def __init__(self, device: Optional["PIControl"] = None, cmd_syntax: str = "MARK") -> None: - super().__init__(device, cmd_syntax) - self._create = MarkCreate(device, f"{self._cmd_syntax}:CREATE") - self._free = MarkFree(device, f"{self._cmd_syntax}:FREE") - self._saveall = MarkSaveall(device, f"{self._cmd_syntax}:SAVEALL") - self._selected = MarkSelected(device, f"{self._cmd_syntax}:SELected") - self._total = MarkTotal(device, f"{self._cmd_syntax}:TOTal") - self._userlist = MarkUserlist(device, f"{self._cmd_syntax}:USERLIST") - - @property - def create(self) -> MarkCreate: - """Return the ``MARK:CREATE`` command. - - Description: - - Creates a mark on a specified waveform or all waveforms in a column. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:CREATE value`` command. - - SCPI Syntax: - ``` - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` creates the mark on a channel waveform, where is the channel number. - - ``MATH`` creates the mark on the math waveform. - - ``B`` creates the mark on a bus waveform, where . - - ``REF`` creates the mark on a reference waveform, where is the reference - waveform number. - - ``DIGital`` creates the mark on a digital waveform. (An error will result if no - digital channel is turned on.) (MSO/MDO4000/B models only as well as MDO3000 and - MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``COLUMN`` creates marks on all waveforms in the current zoom pixel column. - - ``RF_AMPlitude`` creates the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` creates the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_PHASe`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - """ # noqa: E501 - return self._create - - @property - def free(self) -> MarkFree: - """Return the ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - return self._free - - @property - def saveall(self) -> MarkSaveall: - """Return the ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user - search mark list in internal memory. (This is equivalent to pressing the 'Save All - Marks' button in the Search button menu on the front panel.) In order to retrieve the - information, use the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - return self._saveall - - @property - def selected(self) -> MarkSelected: - """Return the ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - return self._selected - - @property - def total(self) -> MarkTotal: - """Return the ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - return self._total - - @property - def userlist(self) -> MarkUserlist: - """Return the ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the - command form if any of the following conditions are true: The source waveform is not - turned on. The position of the mark is not on the waveform. The maximum number of - marks would be exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - return self._userlist diff --git a/src/tm_devices/commands/gen_16x4xq_mdo/search.py b/src/tm_devices/commands/gen_16x4xq_mdo/search.py index 8aadac90..4585a3e3 100644 --- a/src/tm_devices/commands/gen_16x4xq_mdo/search.py +++ b/src/tm_devices/commands/gen_16x4xq_mdo/search.py @@ -1271,19 +1271,12 @@ class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. - - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or - MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models only.). + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). """ # noqa: E501 @@ -1392,20 +1385,12 @@ def source(self) -> SearchSearchItemTriggerATimeoutSource: ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. + waveform. - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO - or MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). + (Requires option 3-MSO.). """ # noqa: E501 return self._source diff --git a/src/tm_devices/commands/gen_1kdqwg_mdo/search.py b/src/tm_devices/commands/gen_1kdqwg_mdo/search.py index 66be7623..0776a14e 100644 --- a/src/tm_devices/commands/gen_1kdqwg_mdo/search.py +++ b/src/tm_devices/commands/gen_1kdqwg_mdo/search.py @@ -1315,19 +1315,12 @@ class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. - - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO or - MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models only.). + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). """ # noqa: E501 @@ -1436,20 +1429,12 @@ def source(self) -> SearchSearchItemTriggerATimeoutSource: ``` Info: - - ``CH`` specifies to use one of the analog channels as the source waveform. x has a - minimum of 1 and a maximum of 4. + - ``CH`` specifies to use one of the analog channels as the source waveform. - ``MATH`` specifies to use the math waveform as the as the source waveform. - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source - waveform. x has a minimum of 1 and a maximum of 4. + waveform. - ``D`` specifies to use one of the digital channels as the source waveform. - (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models with option MDO3MSO - or MDO4MSO installed.) x has a minimum of 0 and a maximum of 15. - - ``RF_AMPlitude`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). - - ``RF_PHASe`` specify an RF time domain trace as the source. (MDO4000/B/C models - only.). + (Requires option 3-MSO.). """ # noqa: E501 return self._source diff --git a/src/tm_devices/commands/gen_1kozfv_dpo/search.py b/src/tm_devices/commands/gen_1kozfv_dpo/search.py index 5297ad48..6cfe9a89 100644 --- a/src/tm_devices/commands/gen_1kozfv_dpo/search.py +++ b/src/tm_devices/commands/gen_1kozfv_dpo/search.py @@ -362,6 +362,8 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:THReshold:REF? - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity {STAYSHigh|STAYSLow|EITher} - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity? + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe? - SEARCH:SEARCH:TRIGger:A:TRANsition:DELTatime @@ -963,6 +965,40 @@ class SearchSearchItemTriggerATimeoutTime(SCPICmdWrite, SCPICmdRead): """ +class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). + """ # noqa: E501 + + class SearchSearchItemTriggerATimeoutPolarity(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. @@ -1001,6 +1037,7 @@ class SearchSearchItemTriggerATimeout(SCPICmdRead): Properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ @@ -1009,6 +1046,7 @@ def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: self._polarity = SearchSearchItemTriggerATimeoutPolarity( device, f"{self._cmd_syntax}:POLarity" ) + self._source = SearchSearchItemTriggerATimeoutSource(device, f"{self._cmd_syntax}:SOUrce") self._time = SearchSearchItemTriggerATimeoutTime(device, f"{self._cmd_syntax}:TIMe") @property @@ -1040,6 +1078,41 @@ def polarity(self) -> SearchSearchItemTriggerATimeoutPolarity: """ return self._polarity + @property + def source(self) -> SearchSearchItemTriggerATimeoutSource: + """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. + (Requires option 3-MSO.). + """ # noqa: E501 + return self._source + @property def time(self) -> SearchSearchItemTriggerATimeoutTime: """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. @@ -15252,6 +15325,7 @@ def timeout(self) -> SearchSearchItemTriggerATimeout: Sub-properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ return self._timeout diff --git a/src/tm_devices/commands/gen_1le9o2_mdo/__init__.py b/src/tm_devices/commands/gen_1le9o2_mdo/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/src/tm_devices/commands/gen_1le9o2_mdo/mark.py b/src/tm_devices/commands/gen_1le9o2_mdo/mark.py deleted file mode 100644 index 5c6838ee..00000000 --- a/src/tm_devices/commands/gen_1le9o2_mdo/mark.py +++ /dev/null @@ -1,779 +0,0 @@ -# pylint: disable=line-too-long -"""The mark commands module. - -These commands are used in the following models: -MDO4KB, MDO4KC - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - ``` - - MARK {NEXT|PREVious} - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - - MARK:FREE? - - MARK:SAVEALL TOUSER - - MARK:SELected:END? - - MARK:SELected:FOCUS? - - MARK:SELected:MARKSINCOLumn? - - MARK:SELected:OWNer? - - MARK:SELected:SOURCe? - - MARK:SELected:STARt? - - MARK:SELected:STATE? - - MARK:SELected:ZOOm:POSition? - - MARK:TOTal? - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - - MARK? - ``` -""" # noqa: E501 - -from typing import Optional, TYPE_CHECKING - -from ..helpers import SCPICmdRead, SCPICmdWrite - -if TYPE_CHECKING: - from tm_devices.driver_mixins.device_control.pi_control import PIControl - - -class MarkUserlist(SCPICmdWrite, SCPICmdRead): - """The ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the command - form if any of the following conditions are true: The source waveform is not turned on. - The position of the mark is not on the waveform. The maximum number of marks would be - exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - - -class MarkTotal(SCPICmdRead): - """The ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - - -class MarkSelectedZoomPosition(SCPICmdRead): - """The ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - - -class MarkSelectedZoom(SCPICmdRead): - """The ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._position = MarkSelectedZoomPosition(device, f"{self._cmd_syntax}:POSition") - - @property - def position(self) -> MarkSelectedZoomPosition: - """Return the ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - return self._position - - -class MarkSelectedState(SCPICmdRead): - """The ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - - -class MarkSelectedStart(SCPICmdRead): - """The ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - - -class MarkSelectedSource(SCPICmdRead): - """The ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - - -class MarkSelectedOwner(SCPICmdRead): - """The ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - - -class MarkSelectedMarksincolumn(SCPICmdRead): - """The ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - - -class MarkSelectedFocus(SCPICmdRead): - """The ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - - -class MarkSelectedEnd(SCPICmdRead): - """The ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - - -# pylint: disable=too-many-instance-attributes -class MarkSelected(SCPICmdRead): - """The ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._end = MarkSelectedEnd(device, f"{self._cmd_syntax}:END") - self._focus = MarkSelectedFocus(device, f"{self._cmd_syntax}:FOCUS") - self._marksincolumn = MarkSelectedMarksincolumn(device, f"{self._cmd_syntax}:MARKSINCOLumn") - self._owner = MarkSelectedOwner(device, f"{self._cmd_syntax}:OWNer") - self._source = MarkSelectedSource(device, f"{self._cmd_syntax}:SOURCe") - self._start = MarkSelectedStart(device, f"{self._cmd_syntax}:STARt") - self._state = MarkSelectedState(device, f"{self._cmd_syntax}:STATE") - self._zoom = MarkSelectedZoom(device, f"{self._cmd_syntax}:ZOOm") - - @property - def end(self) -> MarkSelectedEnd: - """Return the ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - return self._end - - @property - def focus(self) -> MarkSelectedFocus: - """Return the ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - return self._focus - - @property - def marksincolumn(self) -> MarkSelectedMarksincolumn: - """Return the ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - return self._marksincolumn - - @property - def owner(self) -> MarkSelectedOwner: - """Return the ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - return self._owner - - @property - def source(self) -> MarkSelectedSource: - """Return the ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - return self._source - - @property - def start(self) -> MarkSelectedStart: - """Return the ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - return self._start - - @property - def state(self) -> MarkSelectedState: - """Return the ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - return self._state - - @property - def zoom(self) -> MarkSelectedZoom: - """Return the ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - return self._zoom - - -class MarkSaveall(SCPICmdWrite): - """The ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user search - mark list in internal memory. (This is equivalent to pressing the 'Save All Marks' button - in the Search button menu on the front panel.) In order to retrieve the information, use - the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - - -class MarkFree(SCPICmdRead): - """The ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - - -class MarkDelete(SCPICmdWrite): - """The ``MARK:DELEte`` command. - - Description: - - This command deletes a mark on a particular waveform, all waveforms in a column, the - selected mark, or all marks. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:DELEte value`` command. - - SCPI Syntax: - ``` - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` deletes the mark on a channel waveform, where is the channel number. - - ``MATH`` deletes the mark on the math waveform. - - ``B`` deletes the mark on a bus waveform, where . - - ``REF`` deletes the mark on a reference waveform, where is the reference waveform - number. - - ``DIGital`` deletes all marks on all digital channels. (MSO/MDO4000/B models only as well - as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``RF_AMPlitude`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_FREQuency`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_PHASe`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``COLUMN`` deletes marks on all waveforms in the current zoom pixel column. - """ # noqa: E501 - - -class MarkCreate(SCPICmdWrite): - """The ``MARK:CREATE`` command. - - Description: - - Creates a mark on a specified waveform or all waveforms in a column. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:CREATE value`` command. - - SCPI Syntax: - ``` - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` creates the mark on a channel waveform, where is the channel number. - - ``MATH`` creates the mark on the math waveform. - - ``B`` creates the mark on a bus waveform, where . - - ``REF`` creates the mark on a reference waveform, where is the reference waveform - number. - - ``DIGital`` creates the mark on a digital waveform. (An error will result if no digital - channel is turned on.) (MSO/MDO4000/B models only as well as MDO3000 and MDO400C models - with option MDO3MSO or MDO4MSO installed.). - - ``COLUMN`` creates marks on all waveforms in the current zoom pixel column. - - ``RF_AMPlitude`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_FREQuency`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``RF_PHASe`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - """ # noqa: E501 - - -class Mark(SCPICmdWrite, SCPICmdRead): - """The ``MARK`` command. - - Description: - - Moves to the next or previous reference mark on the waveform. Returns the current mark - position. - - Usage: - - Using the ``.query()`` method will send the ``MARK?`` query. - - Using the ``.verify(value)`` method will send the ``MARK?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK value`` command. - - SCPI Syntax: - ``` - - MARK {NEXT|PREVious} - - MARK? - ``` - - Info: - - ``NEXT`` moves to the next reference mark on the right. - - ``PREVious`` moves to the next reference mark on the left. - - Properties: - - ``.create``: The ``MARK:CREATE`` command. - - ``.delete``: The ``MARK:DELEte`` command. - - ``.free``: The ``MARK:FREE`` command. - - ``.saveall``: The ``MARK:SAVEALL`` command. - - ``.selected``: The ``MARK:SELected`` command tree. - - ``.total``: The ``MARK:TOTal`` command. - - ``.userlist``: The ``MARK:USERLIST`` command. - """ - - def __init__(self, device: Optional["PIControl"] = None, cmd_syntax: str = "MARK") -> None: - super().__init__(device, cmd_syntax) - self._create = MarkCreate(device, f"{self._cmd_syntax}:CREATE") - self._delete = MarkDelete(device, f"{self._cmd_syntax}:DELEte") - self._free = MarkFree(device, f"{self._cmd_syntax}:FREE") - self._saveall = MarkSaveall(device, f"{self._cmd_syntax}:SAVEALL") - self._selected = MarkSelected(device, f"{self._cmd_syntax}:SELected") - self._total = MarkTotal(device, f"{self._cmd_syntax}:TOTal") - self._userlist = MarkUserlist(device, f"{self._cmd_syntax}:USERLIST") - - @property - def create(self) -> MarkCreate: - """Return the ``MARK:CREATE`` command. - - Description: - - Creates a mark on a specified waveform or all waveforms in a column. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:CREATE value`` command. - - SCPI Syntax: - ``` - - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` creates the mark on a channel waveform, where is the channel number. - - ``MATH`` creates the mark on the math waveform. - - ``B`` creates the mark on a bus waveform, where . - - ``REF`` creates the mark on a reference waveform, where is the reference - waveform number. - - ``DIGital`` creates the mark on a digital waveform. (An error will result if no - digital channel is turned on.) (MSO/MDO4000/B models only as well as MDO3000 and - MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``COLUMN`` creates marks on all waveforms in the current zoom pixel column. - - ``RF_AMPlitude`` creates the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` creates the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_PHASe`` creates the mark on an RF time domain trace. (MDO4000/B/C models only.). - """ # noqa: E501 - return self._create - - @property - def delete(self) -> MarkDelete: - """Return the ``MARK:DELEte`` command. - - Description: - - This command deletes a mark on a particular waveform, all waveforms in a column, the - selected mark, or all marks. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:DELEte value`` command. - - SCPI Syntax: - ``` - - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - ``` - - Info: - - ``CH`` deletes the mark on a channel waveform, where is the channel number. - - ``MATH`` deletes the mark on the math waveform. - - ``B`` deletes the mark on a bus waveform, where . - - ``REF`` deletes the mark on a reference waveform, where is the reference - waveform number. - - ``DIGital`` deletes all marks on all digital channels. (MSO/MDO4000/B models only as - well as MDO3000 and MDO400C models with option MDO3MSO or MDO4MSO installed.). - - ``RF_AMPlitude`` deletes the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_FREQuency`` deletes the mark on an RF time domain trace. (MDO4000/B/C models - only.). - - ``RF_PHASe`` deletes the mark on an RF time domain trace. (MDO4000/B/C models only.). - - ``COLUMN`` deletes marks on all waveforms in the current zoom pixel column. - """ # noqa: E501 - return self._delete - - @property - def free(self) -> MarkFree: - """Return the ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - return self._free - - @property - def saveall(self) -> MarkSaveall: - """Return the ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user - search mark list in internal memory. (This is equivalent to pressing the 'Save All - Marks' button in the Search button menu on the front panel.) In order to retrieve the - information, use the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - return self._saveall - - @property - def selected(self) -> MarkSelected: - """Return the ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - return self._selected - - @property - def total(self) -> MarkTotal: - """Return the ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - return self._total - - @property - def userlist(self) -> MarkUserlist: - """Return the ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the - command form if any of the following conditions are true: The source waveform is not - turned on. The position of the mark is not on the waveform. The maximum number of - marks would be exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - return self._userlist diff --git a/src/tm_devices/commands/gen_1lh2st_msodpo/search.py b/src/tm_devices/commands/gen_1lh2st_msodpo/search.py index 67c5f621..4fe10edd 100644 --- a/src/tm_devices/commands/gen_1lh2st_msodpo/search.py +++ b/src/tm_devices/commands/gen_1lh2st_msodpo/search.py @@ -400,6 +400,8 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:THReshold:REF? - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity {STAYSHigh|STAYSLow|EITher} - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity? + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe? - SEARCH:SEARCH:TRIGger:A:TRANsition:DELTatime @@ -1001,6 +1003,40 @@ class SearchSearchItemTriggerATimeoutTime(SCPICmdWrite, SCPICmdRead): """ +class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). + """ # noqa: E501 + + class SearchSearchItemTriggerATimeoutPolarity(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. @@ -1039,6 +1075,7 @@ class SearchSearchItemTriggerATimeout(SCPICmdRead): Properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ @@ -1047,6 +1084,7 @@ def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: self._polarity = SearchSearchItemTriggerATimeoutPolarity( device, f"{self._cmd_syntax}:POLarity" ) + self._source = SearchSearchItemTriggerATimeoutSource(device, f"{self._cmd_syntax}:SOUrce") self._time = SearchSearchItemTriggerATimeoutTime(device, f"{self._cmd_syntax}:TIMe") @property @@ -1078,6 +1116,41 @@ def polarity(self) -> SearchSearchItemTriggerATimeoutPolarity: """ return self._polarity + @property + def source(self) -> SearchSearchItemTriggerATimeoutSource: + """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. + (Requires option 3-MSO.). + """ # noqa: E501 + return self._source + @property def time(self) -> SearchSearchItemTriggerATimeoutTime: """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. @@ -16703,6 +16776,7 @@ def timeout(self) -> SearchSearchItemTriggerATimeout: Sub-properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ return self._timeout diff --git a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/afg.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/afg.py index 58ac4107..bc52c43c 100644 --- a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/afg.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/afg.py @@ -788,9 +788,9 @@ class AfgArbitraryEmemPointsByteorder(SCPICmdWrite, SCPICmdRead): Description: - ``:BYTEORDer This`` command specifies the byte order for the ``AFG:ARBITRARY:EMEM:POINTS?`` query when the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` is set - to BINary and when binary block data is sent for the ``AFG:ARBITRARY:EMEM:POINTS`` - command. LSB - Least significant byte first (little endian) MSB - Most significant byte - first (big endian) The default is LSB. This setting is non-volatile and is reset by + to BINary and when binary block data is sent for the ``AFG:ARBITRARY:EMEM:POINTS`` + command. LSB - Least significant byte first (little endian) MSB - Most significant byte + first (big endian) The default is LSB. This setting is non-volatile and is reset by default setup or TekSecure. Refer to the ``AFG:ARBITRARY:EMEM:POINTS`` command description for more information. @@ -819,20 +819,19 @@ class AfgArbitraryEmemPoints(SCPICmdWrite, SCPICmdRead): Description: - Specifies which points to load into the AFG arbitrary waveform edit memory. The point data - to be loaded may be specified as an IEEE488.2 binary block with 4-byte floating point - data values, or as a comma-separated list of NR2 or NR3 data values. The data values must - be in the range of -1.0 to 1.0. The ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command is - used when the data is binary block format. The minimum number of points is 2 and maximum - is 131072. Upon successful transfer of the data points, the - ``AFG:ARBITRARY:EMEM:NUMPOINTS`` query will return the number of points loaded into - arbitrary waveform edit memory and the ``AFG:ARBITRARY:EMEM:FUNCTION`` query will return - USER. Note that the output, if turned on, will not change unless or until the AFG function - is set to ARBitrary using the ``AFG:FUNCTION`` command. Point values may be coerced to the - nearest valid step size. The query form returns the points stored in the AFG arbitrary - waveform edit memory in the format specified by the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` - command and, for binary encoding, the byte order specified by the - ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command. Refer to the - ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` command description for more information. + to be loaded may be specified as an IEEE488.2 binary block with 4-byte floating point data + values, or as a comma-separated list of NR2 or NR3 data values. The data values must be in + the range of -1.0 to 1.0. The ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command is used when + the data is binary block format. The minimum number of points is 2 and maximum is 131072. + Upon successful transfer of the data points, the ``AFG:ARBITRARY:EMEM:NUMPOINTS`` query + will return the number of points loaded into arbitrary waveform edit memory and the + ``AFG:ARBITRARY:EMEM:FUNCTION`` query will return USER. Note that the output, if turned + on, will not change unless or until the AFG function is set to ARBitrary using the + ``AFG:FUNCTION`` command. Point values may be coerced to the nearest valid step size. The + query form returns the points stored in the AFG arbitrary waveform edit memory in the + format specified by the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` command and, for binary + encoding, the byte order specified by the ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command. + Refer to the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` command description for more information. Usage: - Using the ``.query()`` method will send the ``AFG:ARBitrary:EMEM:POINTS?`` query. @@ -868,11 +867,11 @@ def byteorder(self) -> AfgArbitraryEmemPointsByteorder: Description: - ``:BYTEORDer This`` command specifies the byte order for the ``AFG:ARBITRARY:EMEM:POINTS?`` query when the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` is - set to BINary and when binary block data is sent for the - ``AFG:ARBITRARY:EMEM:POINTS`` command. LSB - Least significant byte first (little - endian) MSB - Most significant byte first (big endian) The default is LSB. This - setting is non-volatile and is reset by default setup or TekSecure. Refer to the - ``AFG:ARBITRARY:EMEM:POINTS`` command description for more information. + set to BINary and when binary block data is sent for the ``AFG:ARBITRARY:EMEM:POINTS`` + command. LSB - Least significant byte first (little endian) MSB - Most significant + byte first (big endian) The default is LSB. This setting is non-volatile and is reset + by default setup or TekSecure. Refer to the ``AFG:ARBITRARY:EMEM:POINTS`` command + description for more information. Usage: - Using the ``.query()`` method will send the ``AFG:ARBitrary:EMEM:POINTS:BYTEORDer?`` @@ -1118,17 +1117,17 @@ def points(self) -> AfgArbitraryEmemPoints: Description: - Specifies which points to load into the AFG arbitrary waveform edit memory. The point - data to be loaded may be specified as an IEEE488.2 binary block with 4-byte floating - point data values, or as a comma-separated list of NR2 or NR3 data values. The data + data to be loaded may be specified as an IEEE488.2 binary block with 4-byte floating + point data values, or as a comma-separated list of NR2 or NR3 data values. The data values must be in the range of -1.0 to 1.0. The - ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command is used when the data is binary block + ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command is used when the data is binary block format. The minimum number of points is 2 and maximum is 131072. Upon successful transfer of the data points, the ``AFG:ARBITRARY:EMEM:NUMPOINTS`` query will return the number of points loaded into arbitrary waveform edit memory and the ``AFG:ARBITRARY:EMEM:FUNCTION`` query will return USER. Note that the output, if turned on, will not change unless or until the AFG function is set to ARBitrary using the ``AFG:FUNCTION`` command. Point values may be coerced to the nearest valid step - size. The query form returns the points stored in the AFG arbitrary waveform edit + size. The query form returns the points stored in the AFG arbitrary waveform edit memory in the format specified by the ``AFG:ARBITRARY:EMEM:POINTS:ENCDG`` command and, for binary encoding, the byte order specified by the ``AFG:ARBITRARY:EMEM:POINTS:BYTEORDER`` command. Refer to the diff --git a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/ch.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/ch.py index aa46e408..454b7115 100644 --- a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/ch.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/ch.py @@ -596,7 +596,7 @@ class ChannelProbeCalibrateCalibratable(SCPICmdRead): """The ``CH:PRObe:CALibrate:CALIBRATABLe`` command. Description: - - This query returns the state of the probe attached to channel 1-4, either 0 if the probe + - This query returns the state of the probe attached to channel 1-4, either 0 if the probe is not calibratable, or 1 if the probe is calibratable. The channel is specified by x, which can range from 1 through 4. @@ -650,7 +650,7 @@ def calibratable(self) -> ChannelProbeCalibrateCalibratable: """Return the ``CH:PRObe:CALibrate:CALIBRATABLe`` command. Description: - - This query returns the state of the probe attached to channel 1-4, either 0 if the + - This query returns the state of the probe attached to channel 1-4, either 0 if the probe is not calibratable, or 1 if the probe is calibratable. The channel is specified by x, which can range from 1 through 4. diff --git a/src/tm_devices/commands/gen_ujuvb_mdo/mark.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/mark.py similarity index 96% rename from src/tm_devices/commands/gen_ujuvb_mdo/mark.py rename to src/tm_devices/commands/gen_1ltpwt_mdomsodpo/mark.py index e9fb37fd..4dbc5bde 100644 --- a/src/tm_devices/commands/gen_ujuvb_mdo/mark.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/mark.py @@ -2,7 +2,7 @@ """The mark commands module. These commands are used in the following models: -MDO3 +DPO4K, DPO4KB, MDO3, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO4K, MSO4KB THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. @@ -11,8 +11,8 @@ Commands and Queries: ``` - MARK {NEXT|PREVious} - - MARK:CREATE {CH|MATH|REF|B|REF|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} - - MARK:DELEte {CH|MATH|REF|B|REF|DIGital|COLUMN|SELECTED|ALL|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} - MARK:FREE? - MARK:SAVEALL TOUSER - MARK:SELected:END? @@ -504,7 +504,7 @@ class MarkDelete(SCPICmdWrite): SCPI Syntax: ``` - - MARK:DELEte {CH|MATH|REF|B|REF|DIGital|COLUMN|SELECTED|ALL|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} ``` Info: @@ -530,7 +530,7 @@ class MarkCreate(SCPICmdWrite): SCPI Syntax: ``` - - MARK:CREATE {CH|MATH|REF|B|REF|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} ``` Info: @@ -600,7 +600,7 @@ def create(self) -> MarkCreate: SCPI Syntax: ``` - - MARK:CREATE {CH|MATH|REF|B|REF|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:CREATE {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|RF_AMPlitude|RF_FREQuency|RF_PHASe} ``` Info: @@ -628,7 +628,7 @@ def delete(self) -> MarkDelete: SCPI Syntax: ``` - - MARK:DELEte {CH|MATH|REF|B|REF|DIGital|COLUMN|SELECTED|ALL|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - MARK:DELEte {CH|MATH|REF1|REF2|REF3|REF4|B1|B2|B3|B4|REF1|REF2|REF3|REF4|DIGital|COLUMN|SELECTED|ALL||RF_AMPlitude|RF_FREQuency|RF_PHASe} ``` Info: diff --git a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/math1.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/math1.py index 004f1d08..1aad6aa5 100644 --- a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/math1.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/math1.py @@ -422,7 +422,7 @@ class Math1HorizontalScale(SCPICmdWrite, SCPICmdRead): Description: - This command specifies the math horizontal display scale for FFT or for dual math waveforms that have source waveforms that are reference waveforms. The horizontal scale of - a dual math waveform with a channel source waveform is set through the command. + a dual math waveform with a channel source waveform is set through the command. Usage: - Using the ``.query()`` method will send the ``MATH1:HORizontal:SCAle?`` query. @@ -578,7 +578,7 @@ class Math1Define(SCPICmdWrite, SCPICmdRead): advanced math functions, measurements, and operators. Spectrum math (MDO models) expressions are strings of the form , where the waveforms are any combination of live RF or reference traces in the frequency domain display, the - is either + or -, and type has been set to SPECTRUM. + is either + or -, and type has been set to SPECTRUM. Usage: - Using the ``.query()`` method will send the ``MATH1:DEFine?`` query. @@ -770,7 +770,7 @@ def define(self) -> Math1Define: combinations of advanced math functions, measurements, and operators. Spectrum math (MDO models) expressions are strings of the form , where the waveforms are any combination of live RF or reference traces in the frequency domain - display, the is either + or -, and type has been set to SPECTRUM. + display, the is either + or -, and type has been set to SPECTRUM. Usage: - Using the ``.query()`` method will send the ``MATH1:DEFine?`` query. diff --git a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/power.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/power.py index 0091c226..96388c8f 100644 --- a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/power.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/power.py @@ -6764,9 +6764,8 @@ class PowerHarmonicsResultsHarItemLimit(SCPICmdRead): Description: - The IEC and MIL standards specify a limit for each harmonic magnitude. Returns the limit - in absolute units, or as a percentage of the fundamental as specified by the standard. - IEC Class C (Table 2) and MIL standards specify the limit as a percentage of the - fundamental. + in absolute units, or as a percentage of the fundamental as specified by the standard. IEC + Class C (Table 2) and MIL standards specify the limit as a percentage of the fundamental. Usage: - Using the ``.query()`` method will send the ``POWer:HARMonics:RESults:HAR:LIMit?`` diff --git a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/vidpic.py b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/vidpic.py index 42e08593..15724927 100644 --- a/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/vidpic.py +++ b/src/tm_devices/commands/gen_1ltpwt_mdomsodpo/vidpic.py @@ -166,7 +166,7 @@ class VidpicLocationStartPixel(SCPICmdWrite, SCPICmdRead): nominally 63.5us duration (10.9us blanking + 52.6us active video) that can be sampled from 1MS/s to 100MS/s, giving from 52.6 to 5260 video samples or 'pixels' per output line. The start pixel is the starting sample in each line; it is limited to a single line at the - current sample rate, i.e. ranges between -10.9 to 52.6 and -1090 to +5260. + current sample rate, i.e. ranges between -10.9 to 52.6 and -1090 to +5260. Usage: - Using the ``.query()`` method will send the ``VIDPic:LOCation:STARt:PIXel?`` query. @@ -254,8 +254,8 @@ def pixel(self) -> VidpicLocationStartPixel: of nominally 63.5us duration (10.9us blanking + 52.6us active video) that can be sampled from 1MS/s to 100MS/s, giving from 52.6 to 5260 video samples or 'pixels' per output line. The start pixel is the starting sample in each line; it is limited to a - single line at the current sample rate, i.e. ranges between -10.9 to 52.6 and -1090 - to +5260. + single line at the current sample rate, i.e. ranges between -10.9 to 52.6 and -1090 to + +5260. Usage: - Using the ``.query()`` method will send the ``VIDPic:LOCation:STARt:PIXel?`` query. diff --git a/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/histogram.py b/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/histogram.py index fe45a85f..577339d4 100644 --- a/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/histogram.py +++ b/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/histogram.py @@ -43,7 +43,7 @@ class HistogramStart(SCPICmdRead): the histogram data starts. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of the - left bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units + left bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the top bin. The returned value is an . Usage: @@ -123,7 +123,7 @@ class HistogramEnd(SCPICmdRead): histogram data ends. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of the right bin. - If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of + If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an . Usage: @@ -474,7 +474,7 @@ def end(self) -> HistogramEnd: the histogram data ends. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of - the right bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the + the right bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an . Usage: diff --git a/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/save.py b/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/save.py index a9d672bd..6c00e5a7 100644 --- a/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/save.py +++ b/src/tm_devices/commands/gen_1mlt9u_mdomsodpo/save.py @@ -176,7 +176,7 @@ class SaveWaveform(SCPICmdWrite, SCPICmdRead): """The ``SAVe:WAVEform`` command. Description: - - This command saves the specified waveform to the specified destination reference memory, + - This command saves the specified waveform to the specified destination reference memory, or saves the specified waveform(s) to the specified destination file. Usage: @@ -897,7 +897,7 @@ def waveform(self) -> SaveWaveform: """Return the ``SAVe:WAVEform`` command. Description: - - This command saves the specified waveform to the specified destination reference + - This command saves the specified waveform to the specified destination reference memory, or saves the specified waveform(s) to the specified destination file. Usage: diff --git a/src/tm_devices/commands/gen_1msu49_msodpo/__init__.py b/src/tm_devices/commands/gen_1msu49_msodpo/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/src/tm_devices/commands/gen_1msu49_msodpo/mark.py b/src/tm_devices/commands/gen_1msu49_msodpo/mark.py deleted file mode 100644 index 033457c1..00000000 --- a/src/tm_devices/commands/gen_1msu49_msodpo/mark.py +++ /dev/null @@ -1,646 +0,0 @@ -"""The mark commands module. - -These commands are used in the following models: -DPO4K, DPO4KB, MSO4K - -THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED. - -Please report an issue if one is found. - -Commands and Queries: - ``` - - MARK {NEXT|PREVious} - - MARK:FREE? - - MARK:SAVEALL TOUSER - - MARK:SELected:END? - - MARK:SELected:FOCUS? - - MARK:SELected:MARKSINCOLumn? - - MARK:SELected:OWNer? - - MARK:SELected:SOURCe? - - MARK:SELected:STARt? - - MARK:SELected:STATE? - - MARK:SELected:ZOOm:POSition? - - MARK:TOTal? - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - - MARK? - ``` -""" - -from typing import Optional, TYPE_CHECKING - -from ..helpers import SCPICmdRead, SCPICmdWrite - -if TYPE_CHECKING: - from tm_devices.driver_mixins.device_control.pi_control import PIControl - - -class MarkUserlist(SCPICmdWrite, SCPICmdRead): - """The ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the command - form if any of the following conditions are true: The source waveform is not turned on. - The position of the mark is not on the waveform. The maximum number of marks would be - exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - - -class MarkTotal(SCPICmdRead): - """The ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - - -class MarkSelectedZoomPosition(SCPICmdRead): - """The ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - - -class MarkSelectedZoom(SCPICmdRead): - """The ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._position = MarkSelectedZoomPosition(device, f"{self._cmd_syntax}:POSition") - - @property - def position(self) -> MarkSelectedZoomPosition: - """Return the ``MARK:SELected:ZOOm:POSition`` command. - - Description: - - Returns the position of the selected mark, 0 to 100% of the zoom overview window. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm:POSition?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm:POSition?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:ZOOm:POSition? - ``` - """ - return self._position - - -class MarkSelectedState(SCPICmdRead): - """The ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - - -class MarkSelectedStart(SCPICmdRead): - """The ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - - -class MarkSelectedSource(SCPICmdRead): - """The ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - - -class MarkSelectedOwner(SCPICmdRead): - """The ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - - -class MarkSelectedMarksincolumn(SCPICmdRead): - """The ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query - and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - - -class MarkSelectedFocus(SCPICmdRead): - """The ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - - -class MarkSelectedEnd(SCPICmdRead): - """The ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and raise - an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - - -# pylint: disable=too-many-instance-attributes -class MarkSelected(SCPICmdRead): - """The ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - - def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: - super().__init__(device, cmd_syntax) - self._end = MarkSelectedEnd(device, f"{self._cmd_syntax}:END") - self._focus = MarkSelectedFocus(device, f"{self._cmd_syntax}:FOCUS") - self._marksincolumn = MarkSelectedMarksincolumn(device, f"{self._cmd_syntax}:MARKSINCOLumn") - self._owner = MarkSelectedOwner(device, f"{self._cmd_syntax}:OWNer") - self._source = MarkSelectedSource(device, f"{self._cmd_syntax}:SOURCe") - self._start = MarkSelectedStart(device, f"{self._cmd_syntax}:STARt") - self._state = MarkSelectedState(device, f"{self._cmd_syntax}:STATE") - self._zoom = MarkSelectedZoom(device, f"{self._cmd_syntax}:ZOOm") - - @property - def end(self) -> MarkSelectedEnd: - """Return the ``MARK:SELected:END`` command. - - Description: - - Returns the end of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:END?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:END?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:END? - ``` - """ - return self._end - - @property - def focus(self) -> MarkSelectedFocus: - """Return the ``MARK:SELected:FOCUS`` command. - - Description: - - Returns the focus of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:FOCUS?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:FOCUS?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:FOCUS? - ``` - """ - return self._focus - - @property - def marksincolumn(self) -> MarkSelectedMarksincolumn: - """Return the ``MARK:SELected:MARKSINCOLumn`` command. - - Description: - - Returns the number of marks in the current zoom pixel column. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:MARKSINCOLumn?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:MARKSINCOLumn?`` - query and raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:MARKSINCOLumn? - ``` - """ - return self._marksincolumn - - @property - def owner(self) -> MarkSelectedOwner: - """Return the ``MARK:SELected:OWNer`` command. - - Description: - - Returns the owner of the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:OWNer?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:OWNer?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:OWNer? - ``` - """ - return self._owner - - @property - def source(self) -> MarkSelectedSource: - """Return the ``MARK:SELected:SOURCe`` command. - - Description: - - Returns the source waveform for the selected mark. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:SOURCe?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:SOURCe?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:SOURCe? - ``` - """ - return self._source - - @property - def start(self) -> MarkSelectedStart: - """Return the ``MARK:SELected:STARt`` command. - - Description: - - Returns the starting point of the selected mark, 0 to 100% of the waveform. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STARt?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STARt?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STARt? - ``` - """ - return self._start - - @property - def state(self) -> MarkSelectedState: - """Return the ``MARK:SELected:STATE`` command. - - Description: - - Returns the on or off state of the selected mark. The selected mark is at or near the - center of the screen. If you press the front-panel Set/Clear button, this mark will - disappear. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:STATE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:STATE?`` query and - raise an AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:SELected:STATE? - ``` - """ - return self._state - - @property - def zoom(self) -> MarkSelectedZoom: - """Return the ``MARK:SELected:ZOOm`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected:ZOOm?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected:ZOOm?`` query and - raise an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.position``: The ``MARK:SELected:ZOOm:POSition`` command. - """ - return self._zoom - - -class MarkSaveall(SCPICmdWrite): - """The ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user search - mark list in internal memory. (This is equivalent to pressing the 'Save All Marks' button - in the Search button menu on the front panel.) In order to retrieve the information, use - the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - - -class MarkFree(SCPICmdRead): - """The ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - - -class Mark(SCPICmdWrite, SCPICmdRead): - """The ``MARK`` command. - - Description: - - Moves to the next or previous reference mark on the waveform. Returns the current mark - position. - - Usage: - - Using the ``.query()`` method will send the ``MARK?`` query. - - Using the ``.verify(value)`` method will send the ``MARK?`` query and raise an - AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK value`` command. - - SCPI Syntax: - ``` - - MARK {NEXT|PREVious} - - MARK? - ``` - - Info: - - ``NEXT`` moves to the next reference mark on the right. - - ``PREVious`` moves to the next reference mark on the left. - - Properties: - - ``.free``: The ``MARK:FREE`` command. - - ``.saveall``: The ``MARK:SAVEALL`` command. - - ``.selected``: The ``MARK:SELected`` command tree. - - ``.total``: The ``MARK:TOTal`` command. - - ``.userlist``: The ``MARK:USERLIST`` command. - """ - - def __init__(self, device: Optional["PIControl"] = None, cmd_syntax: str = "MARK") -> None: - super().__init__(device, cmd_syntax) - self._free = MarkFree(device, f"{self._cmd_syntax}:FREE") - self._saveall = MarkSaveall(device, f"{self._cmd_syntax}:SAVEALL") - self._selected = MarkSelected(device, f"{self._cmd_syntax}:SELected") - self._total = MarkTotal(device, f"{self._cmd_syntax}:TOTal") - self._userlist = MarkUserlist(device, f"{self._cmd_syntax}:USERLIST") - - @property - def free(self) -> MarkFree: - """Return the ``MARK:FREE`` command. - - Description: - - Returns how many marks are available for use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:FREE?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:FREE?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:FREE? - ``` - """ - return self._free - - @property - def saveall(self) -> MarkSaveall: - """Return the ``MARK:SAVEALL`` command. - - Description: - - This command saves all current marks on waveforms in the time domain to the user - search mark list in internal memory. (This is equivalent to pressing the 'Save All - Marks' button in the Search button menu on the front panel.) In order to retrieve the - information, use the query form of ``MARK:USERLIST``. - - Usage: - - Using the ``.write(value)`` method will send the ``MARK:SAVEALL value`` command. - - SCPI Syntax: - ``` - - MARK:SAVEALL TOUSER - ``` - """ - return self._saveall - - @property - def selected(self) -> MarkSelected: - """Return the ``MARK:SELected`` command tree. - - Usage: - - Using the ``.query()`` method will send the ``MARK:SELected?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:SELected?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Sub-properties: - - ``.end``: The ``MARK:SELected:END`` command. - - ``.focus``: The ``MARK:SELected:FOCUS`` command. - - ``.marksincolumn``: The ``MARK:SELected:MARKSINCOLumn`` command. - - ``.owner``: The ``MARK:SELected:OWNer`` command. - - ``.source``: The ``MARK:SELected:SOURCe`` command. - - ``.start``: The ``MARK:SELected:STARt`` command. - - ``.state``: The ``MARK:SELected:STATE`` command. - - ``.zoom``: The ``MARK:SELected:ZOOm`` command tree. - """ - return self._selected - - @property - def total(self) -> MarkTotal: - """Return the ``MARK:TOTal`` command. - - Description: - - Returns how many marks are currently in use. There can be a total of 1,024 marks - returned. - - Usage: - - Using the ``.query()`` method will send the ``MARK:TOTal?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:TOTal?`` query and raise an - AssertionError if the returned value does not match ``value``. - - SCPI Syntax: - ``` - - MARK:TOTal? - ``` - """ - return self._total - - @property - def userlist(self) -> MarkUserlist: - """Return the ``MARK:USERLIST`` command. - - Description: - - The command creates a single user mark on a waveform in the time domain. The arguments - consist of an enumeration specifying the source waveform, followed by 7 time mark - parameters. You can create up to 1,024 marks. To save all the marks to memory, use the - command ``MARK:SAVEALL TOUSER``. The query form retrieves a list of all user marks, - separated by a semicolon. To retrieve the list of all system generated marks, use the - command ``SEARCH:SEARCHX:LIST A`` 'Settings conflict' error event is set for the - command form if any of the following conditions are true: The source waveform is not - turned on. The position of the mark is not on the waveform. The maximum number of - marks would be exceeded. - - Usage: - - Using the ``.query()`` method will send the ``MARK:USERLIST?`` query. - - Using the ``.verify(value)`` method will send the ``MARK:USERLIST?`` query and raise - an AssertionError if the returned value does not match ``value``. - - Using the ``.write(value)`` method will send the ``MARK:USERLIST value`` command. - - SCPI Syntax: - ``` - - MARK:USERLIST ,,,,,,, - - MARK:USERLIST? - ``` - - Info: - - ``CH`` - analog channels 1-4. - - ``B`` - serial (if installed) or parallel bus 1-4. - - ``MATH`` - math waveform. - - ``REF`` - reference waveforms 1-4. - - ``D0 - D15`` - digital channels 0 - 15 (Requires installation of option 3-MSO.). - """ - return self._userlist diff --git a/src/tm_devices/commands/gen_1zn03_mso/search.py b/src/tm_devices/commands/gen_1zn03_mso/search.py index 9209b0e4..03558929 100644 --- a/src/tm_devices/commands/gen_1zn03_mso/search.py +++ b/src/tm_devices/commands/gen_1zn03_mso/search.py @@ -733,7 +733,7 @@ class SearchSearchItemTriggerASetholdLogicpatternRefItem( Description: - This command sets and returns the conditions used for generating an A logic pattern, with - respect to the defined input pattern, and identifies the time that the selected pattern + 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. Usage: @@ -1053,7 +1053,7 @@ def ref(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternRefItem]: Description: - This command sets and returns the conditions used for generating an A logic pattern, - with respect to the defined input pattern, and identifies the time that the selected + 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. @@ -6196,8 +6196,8 @@ class SearchSearchItemTriggerABusRs232cDataSize(SCPICmdWrite, SCPICmdRead): Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is Data. - The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. The + search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -6247,8 +6247,8 @@ def size(self) -> SearchSearchItemTriggerABusRs232cDataSize: Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is - Data. The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. + The search number is specified by x. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_2i1z2s_awg/diagnostic.py b/src/tm_devices/commands/gen_2i1z2s_awg/diagnostic.py index 7d501eb4..271cbd7b 100644 --- a/src/tm_devices/commands/gen_2i1z2s_awg/diagnostic.py +++ b/src/tm_devices/commands/gen_2i1z2s_awg/diagnostic.py @@ -218,8 +218,8 @@ class DiagnosticSelectVerify(SCPICmdReadWithArguments): Description: - This command returns selection status of one specific test. A specific test requires the - 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the type - as set with the command ``DIAGNOSTIC:TYPE``. + 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the type as + set with the command ``DIAGNOSTIC:TYPE``. Usage: - Using the ``.query(argument)`` method will send the ``DIAGnostic:SELect:VERify? argument`` @@ -269,8 +269,8 @@ def verify_(self) -> DiagnosticSelectVerify: Description: - This command returns selection status of one specific test. A specific test requires - the 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on - the type as set with the command ``DIAGNOSTIC:TYPE``. + the 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the + type as set with the command ``DIAGNOSTIC:TYPE``. Usage: - Using the ``.query(argument)`` method will send the @@ -602,7 +602,7 @@ class DiagnosticImmediate(SCPICmdWriteNoArguments, SCPICmdRead): Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of numeric of - values of 0 for no errors or -330 for one or more tests failed. This changes the active + values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. @@ -1217,7 +1217,7 @@ def immediate(self) -> DiagnosticImmediate: Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of - numeric of values of 0 for no errors or -330 for one or more tests failed. This + numeric of values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. diff --git a/src/tm_devices/commands/gen_2i1z2s_awg/wlist.py b/src/tm_devices/commands/gen_2i1z2s_awg/wlist.py index 3523b0cc..e4864024 100644 --- a/src/tm_devices/commands/gen_2i1z2s_awg/wlist.py +++ b/src/tm_devices/commands/gen_2i1z2s_awg/wlist.py @@ -3927,7 +3927,7 @@ class WlistLast(SCPICmdRead): """The ``WLISt:LAST`` command. Description: - - This command returns the name of the most recently added waveform in the waveform list. + - This command returns the name of the most recently added waveform in the waveform list. Usage: - Using the ``.query()`` method will send the ``WLISt:LAST?`` query. @@ -3972,7 +3972,7 @@ def last(self) -> WlistLast: """Return the ``WLISt:LAST`` command. Description: - - This command returns the name of the most recently added waveform in the waveform + - This command returns the name of the most recently added waveform in the waveform list. Usage: diff --git a/src/tm_devices/commands/gen_32dszm_awg/diagnostic.py b/src/tm_devices/commands/gen_32dszm_awg/diagnostic.py index ba1df850..a1a0f7c4 100644 --- a/src/tm_devices/commands/gen_32dszm_awg/diagnostic.py +++ b/src/tm_devices/commands/gen_32dszm_awg/diagnostic.py @@ -61,7 +61,7 @@ class DiagnosticImmediate(SCPICmdWriteNoArguments, SCPICmdRead): Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of numeric of - values of 0 for no errors or -330 for one or more tests failed. This changes the active + values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. @@ -181,7 +181,7 @@ def immediate(self) -> DiagnosticImmediate: Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of - numeric of values of 0 for no errors or -330 for one or more tests failed. This + numeric of values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. diff --git a/src/tm_devices/commands/gen_3rs8qy_awg/diagnostic.py b/src/tm_devices/commands/gen_3rs8qy_awg/diagnostic.py index 59f228f4..e4f80ba8 100644 --- a/src/tm_devices/commands/gen_3rs8qy_awg/diagnostic.py +++ b/src/tm_devices/commands/gen_3rs8qy_awg/diagnostic.py @@ -219,8 +219,8 @@ class DiagnosticSelectVerify(SCPICmdReadWithArguments): Description: - This command returns selection status of one specific test. A specific test requires the - 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the type - as set with the command ``DIAGNOSTIC:TYPE``. + 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the type as + set with the command ``DIAGNOSTIC:TYPE``. Usage: - Using the ``.query(argument)`` method will send the ``DIAGnostic:SELect:VERify? argument`` @@ -270,8 +270,8 @@ def verify_(self) -> DiagnosticSelectVerify: Description: - This command returns selection status of one specific test. A specific test requires - the 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on - the type as set with the command ``DIAGNOSTIC:TYPE``. + the 'subsystem', 'area', and 'test'. This is context sensitive and is dependent on the + type as set with the command ``DIAGNOSTIC:TYPE``. Usage: - Using the ``.query(argument)`` method will send the @@ -603,7 +603,7 @@ class DiagnosticImmediate(SCPICmdWriteNoArguments, SCPICmdRead): Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of numeric of - values of 0 for no errors or -330 for one or more tests failed. This changes the active + values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. @@ -1226,7 +1226,7 @@ def immediate(self) -> DiagnosticImmediate: Description: - This command executes all of the NORMal diagnostic tests. The query form of this command executes all of the NORMal diagnostics and returns the results in the form of - numeric of values of 0 for no errors or -330 for one or more tests failed. This + numeric of values of 0 for no errors or -330 for one or more tests failed. This changes the active mode to DIAGnostic, if necessary, and returns back to the original active mode when done. This makes a single pass of all of the NORMal diagnostics. diff --git a/src/tm_devices/commands/gen_3rs8qy_awg/wlist.py b/src/tm_devices/commands/gen_3rs8qy_awg/wlist.py index 8bdc813e..a44ef395 100644 --- a/src/tm_devices/commands/gen_3rs8qy_awg/wlist.py +++ b/src/tm_devices/commands/gen_3rs8qy_awg/wlist.py @@ -4102,7 +4102,7 @@ class WlistLast(SCPICmdRead): """The ``WLISt:LAST`` command. Description: - - This command returns the name of the most recently added waveform in the waveform list. + - This command returns the name of the most recently added waveform in the waveform list. Usage: - Using the ``.query()`` method will send the ``WLISt:LAST?`` query. @@ -4147,7 +4147,7 @@ def last(self) -> WlistLast: """Return the ``WLISt:LAST`` command. Description: - - This command returns the name of the most recently added waveform in the waveform + - This command returns the name of the most recently added waveform in the waveform list. Usage: diff --git a/src/tm_devices/commands/gen_4jiykk_dpo/errordetector.py b/src/tm_devices/commands/gen_4jiykk_dpo/errordetector.py index 832f1694..229c047c 100644 --- a/src/tm_devices/commands/gen_4jiykk_dpo/errordetector.py +++ b/src/tm_devices/commands/gen_4jiykk_dpo/errordetector.py @@ -124,7 +124,7 @@ - ERRORDetector:SCRAMBLED? - ERRORDetector:SENDEMAIL {OFF|ON} - ERRORDetector:SENDEMAIL? - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? - ERRORDetector:SSC {ON|OFF} - ERRORDetector:SSC? @@ -1393,7 +1393,7 @@ class ErrordetectorSignaltype(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` @@ -5736,7 +5736,7 @@ def signaltype(self) -> ErrordetectorSignaltype: SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` diff --git a/src/tm_devices/commands/gen_4jiykk_dpo/rosc.py b/src/tm_devices/commands/gen_4jiykk_dpo/rosc.py index 9cee9a09..8e52984a 100644 --- a/src/tm_devices/commands/gen_4jiykk_dpo/rosc.py +++ b/src/tm_devices/commands/gen_4jiykk_dpo/rosc.py @@ -13,7 +13,7 @@ - ROSc:OUT:FREQuency? - ROSc:OUT:ULTRAsync {OFF|ON} - ROSc:OUT:ULTRAsync? - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? - ROSc:STATE? - ROSc:TRACking {STABle|FAST} @@ -94,7 +94,7 @@ class RoscSource(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? ``` @@ -283,7 +283,7 @@ def source(self) -> RoscSource: SCPI Syntax: ``` - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? ``` diff --git a/src/tm_devices/commands/gen_5xwdsk_dpodsamso/errordetector.py b/src/tm_devices/commands/gen_5xwdsk_dpodsamso/errordetector.py index 87826b1c..25b75149 100644 --- a/src/tm_devices/commands/gen_5xwdsk_dpodsamso/errordetector.py +++ b/src/tm_devices/commands/gen_5xwdsk_dpodsamso/errordetector.py @@ -148,7 +148,7 @@ - ERRORDetector:SCRAMBLED? - ERRORDetector:SENDEMAIL {OFF|ON} - ERRORDetector:SENDEMAIL? - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? - ERRORDetector:SKIPSETPRIMitive:MINus? - ERRORDetector:SKIPSETPRIMitive:PLUS? @@ -1725,7 +1725,7 @@ class ErrordetectorSignaltype(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` @@ -7099,7 +7099,7 @@ def signaltype(self) -> ErrordetectorSignaltype: SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` diff --git a/src/tm_devices/commands/gen_c3g61_tekscopepc/bus.py b/src/tm_devices/commands/gen_c3g61_tekscopepc/bus.py index 1f840d9b..0155d915 100644 --- a/src/tm_devices/commands/gen_c3g61_tekscopepc/bus.py +++ b/src/tm_devices/commands/gen_c3g61_tekscopepc/bus.py @@ -14837,7 +14837,7 @@ class BusBItemEspiDatatwoPolarity(SCPICmdWrite, SCPICmdRead): """The ``BUS:B:ESPI:DATATWO:POLarity`` command. Description: - - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity + - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity for the specified bus. The bus is specified by x. Usage: @@ -14888,7 +14888,7 @@ def polarity(self) -> BusBItemEspiDatatwoPolarity: """Return the ``BUS:B:ESPI:DATATWO:POLarity`` command. Description: - - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) + - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity for the specified bus. The bus is specified by x. Usage: diff --git a/src/tm_devices/commands/gen_c3g61_tekscopepc/measurement.py b/src/tm_devices/commands/gen_c3g61_tekscopepc/measurement.py index a5f07b73..4cc57633 100644 --- a/src/tm_devices/commands/gen_c3g61_tekscopepc/measurement.py +++ b/src/tm_devices/commands/gen_c3g61_tekscopepc/measurement.py @@ -11204,7 +11204,7 @@ class MeasurementMeasItemHlevelOutputUglobal(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:HLEVel:OUTPut:UGLobal`` command. Description: - - This command turns on or off output global settings for measurement. Measurements are + - This command turns on or off output global settings for measurement. Measurements are specified by x. Usage: @@ -11251,7 +11251,7 @@ def uglobal(self) -> MeasurementMeasItemHlevelOutputUglobal: """Return the ``MEASUrement:MEAS:HLEVel:OUTPut:UGLobal`` command. Description: - - This command turns on or off output global settings for measurement. Measurements are + - This command turns on or off output global settings for measurement. Measurements are specified by x. Usage: diff --git a/src/tm_devices/commands/gen_c3g61_tekscopepc/plot.py b/src/tm_devices/commands/gen_c3g61_tekscopepc/plot.py index f8e37eb3..539cad06 100644 --- a/src/tm_devices/commands/gen_c3g61_tekscopepc/plot.py +++ b/src/tm_devices/commands/gen_c3g61_tekscopepc/plot.py @@ -1413,7 +1413,7 @@ class PlotPlotItemExportraw(SCPICmdRead): Description: - This command returns a binary stream of double values containing the x,y and hits value. Use this command along with ``MEASUREMENT:ADDMEAS TIE``, ``PLOT:PLOT1:TYPE EYEDIAGRAM``, - ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. + ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. Usage: - Using the ``.query()`` method will send the ``PLOT:PLOT:EXPORTRaw?`` query. @@ -1677,7 +1677,7 @@ def exportraw(self) -> PlotPlotItemExportraw: Description: - This command returns a binary stream of double values containing the x,y and hits value. Use this command along with ``MEASUREMENT:ADDMEAS TIE``, - ``PLOT:PLOT1:TYPE EYEDIAGRAM``, ``DISplay:SELect:VIEW`` plotview1 to export the eye + ``PLOT:PLOT1:TYPE EYEDIAGRAM``, ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. Usage: diff --git a/src/tm_devices/commands/gen_c3g61_tekscopepc/power.py b/src/tm_devices/commands/gen_c3g61_tekscopepc/power.py index 85fb7375..e7807966 100644 --- a/src/tm_devices/commands/gen_c3g61_tekscopepc/power.py +++ b/src/tm_devices/commands/gen_c3g61_tekscopepc/power.py @@ -4724,7 +4724,7 @@ class PowerPowerItemSoaRecallmaskFilename(SCPICmdWriteNoArguments, SCPICmdRead): """The ``POWer:POWer:SOA:RECAllmask:FILEName`` command. Description: - - This command sets or queries the file name for saving SOA mask file name in the specified + - This command sets or queries the file name for saving SOA mask file name in the specified power measurement number. The power measurement number is specified by x. Usage: @@ -4776,7 +4776,7 @@ def filename(self) -> PowerPowerItemSoaRecallmaskFilename: """Return the ``POWer:POWer:SOA:RECAllmask:FILEName`` command. Description: - - This command sets or queries the file name for saving SOA mask file name in the + - This command sets or queries the file name for saving SOA mask file name in the specified power measurement number. The power measurement number is specified by x. Usage: @@ -7174,8 +7174,8 @@ class PowerPowerItemReflevelsAbsoluteType(SCPICmdWrite, SCPICmdRead): """The ``POWer:POWer:REFLevels:ABSolute:TYPE`` command. Description: - - This command sets or queries the type of measurement levels when reference level is set - to absolute for the specified power measurement number. + - This command sets or queries the type of measurement levels when reference level is set to + absolute for the specified power measurement number. Usage: - Using the ``.query()`` method will send the ``POWer:POWer:REFLevels:ABSolute:TYPE?`` @@ -7663,7 +7663,7 @@ def type(self) -> PowerPowerItemReflevelsAbsoluteType: """Return the ``POWer:POWer:REFLevels:ABSolute:TYPE`` command. Description: - - This command sets or queries the type of measurement levels when reference level is + - This command sets or queries the type of measurement levels when reference level is set to absolute for the specified power measurement number. Usage: @@ -14344,7 +14344,7 @@ class PowerPowerItemImpedanceAnalysismethod(SCPICmdWrite, SCPICmdRead): """The ``POWer:POWer:IMPEDANCE:ANALYSISMethod`` command. Description: - - This command sets or queries the Analysis Method for Impedance measurements. + - This command sets or queries the Analysis Method for Impedance measurements. Usage: - Using the ``.query()`` method will send the ``POWer:POWer:IMPEDANCE:ANALYSISMethod?`` @@ -15145,7 +15145,7 @@ def analysismethod(self) -> PowerPowerItemImpedanceAnalysismethod: """Return the ``POWer:POWer:IMPEDANCE:ANALYSISMethod`` command. Description: - - This command sets or queries the Analysis Method for Impedance measurements. + - This command sets or queries the Analysis Method for Impedance measurements. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_c3g61_tekscopepc/search.py b/src/tm_devices/commands/gen_c3g61_tekscopepc/search.py index 5bcfbef9..aa2e945c 100644 --- a/src/tm_devices/commands/gen_c3g61_tekscopepc/search.py +++ b/src/tm_devices/commands/gen_c3g61_tekscopepc/search.py @@ -2812,7 +2812,7 @@ class SearchSearchItemTriggerASetholdLogicpatternRefItem( Description: - This command sets and returns the conditions used for generating an A logic pattern, with - respect to the defined input pattern, and identifies the time that the selected pattern + 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. Usage: @@ -3097,7 +3097,7 @@ def ref(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternRefItem]: Description: - This command sets and returns the conditions used for generating an A logic pattern, - with respect to the defined input pattern, and identifies the time that the selected + 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. @@ -20653,8 +20653,8 @@ class SearchSearchItemTriggerABusRs232cDataSize(SCPICmdWrite, SCPICmdRead): Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is Data. - The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. The + search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -20704,8 +20704,8 @@ def size(self) -> SearchSearchItemTriggerABusRs232cDataSize: Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is - Data. The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. + The search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -30953,7 +30953,7 @@ class SearchSearchItemTriggerABusEusbSyncbitsMinSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. Description: - - This command sets the number of sync bits, in bits, to be used when triggering on a eUSB + - 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. @@ -31003,7 +31003,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMinSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. Description: - - This command sets the number of sync bits, in bits, to be used when triggering on a + - 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. @@ -31033,7 +31033,7 @@ class SearchSearchItemTriggerABusEusbSyncbitsMaxSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. Description: - - This command sets the number of sync bits, to be used when triggering on a eUSB bus + - 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: @@ -31082,7 +31082,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMaxSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. Description: - - This command sets the number of sync bits, to be used when triggering on a eUSB bus + - 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. @@ -32253,7 +32253,7 @@ 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. + - 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: @@ -32302,7 +32302,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMinSize: """Return 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 + - 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: @@ -32331,7 +32331,7 @@ class SearchSearchItemTriggerABusEusbEopbitsMaxSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. Description: - - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. + - 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: @@ -32380,7 +32380,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMaxSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. Description: - - This command sets the number of EOP bits to be used when triggering on a eUSB bus + - 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: @@ -32496,7 +32496,7 @@ class SearchSearchItemTriggerABusEusbEopDatabitsSize(SCPICmdWrite, SCPICmdRead): """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 + - 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: @@ -32545,7 +32545,7 @@ 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 + - 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. @@ -33166,7 +33166,7 @@ class SearchSearchItemTriggerABusEusbDatabitsSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. Description: - - This command sets the number of Sync bits, in bytes, to be used when triggering on a eUSB + - 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. @@ -33214,7 +33214,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbDatabitsSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. Description: - - This command sets the number of Sync bits, in bytes, to be used when triggering on a + - 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. @@ -45226,7 +45226,7 @@ class SearchSearchItemTriggerABusCphyWordcountValue(SCPICmdWrite, SCPICmdRead): 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. + condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -45277,8 +45277,7 @@ def value(self) -> SearchSearchItemTriggerABusCphyWordcountValue: 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. + trigger condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_e3e9uu_lpdmso/bus.py b/src/tm_devices/commands/gen_e3e9uu_lpdmso/bus.py index e2fbf85b..919c3071 100644 --- a/src/tm_devices/commands/gen_e3e9uu_lpdmso/bus.py +++ b/src/tm_devices/commands/gen_e3e9uu_lpdmso/bus.py @@ -15827,7 +15827,7 @@ class BusBItemEspiDatatwoPolarity(SCPICmdWrite, SCPICmdRead): """The ``BUS:B:ESPI:DATATWO:POLarity`` command. Description: - - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity + - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity for the specified bus. The bus is specified by x. Usage: @@ -15878,7 +15878,7 @@ def polarity(self) -> BusBItemEspiDatatwoPolarity: """Return the ``BUS:B:ESPI:DATATWO:POLarity`` command. Description: - - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) + - This command sets or queries the ESPI response (single mode)/ IO[1] (dual mode) polarity for the specified bus. The bus is specified by x. Usage: diff --git a/src/tm_devices/commands/gen_e3e9uu_lpdmso/measurement.py b/src/tm_devices/commands/gen_e3e9uu_lpdmso/measurement.py index df3a1d7f..28d6cf1d 100644 --- a/src/tm_devices/commands/gen_e3e9uu_lpdmso/measurement.py +++ b/src/tm_devices/commands/gen_e3e9uu_lpdmso/measurement.py @@ -13268,7 +13268,7 @@ class MeasurementMeasItemHlevelOutputUglobal(SCPICmdWrite, SCPICmdRead): """The ``MEASUrement:MEAS:HLEVel:OUTPut:UGLobal`` command. Description: - - This command turns on or off output global settings for measurement. Measurements are + - This command turns on or off output global settings for measurement. Measurements are specified by x. Usage: @@ -13315,7 +13315,7 @@ def uglobal(self) -> MeasurementMeasItemHlevelOutputUglobal: """Return the ``MEASUrement:MEAS:HLEVel:OUTPut:UGLobal`` command. Description: - - This command turns on or off output global settings for measurement. Measurements are + - This command turns on or off output global settings for measurement. Measurements are specified by x. Usage: diff --git a/src/tm_devices/commands/gen_e3e9uu_lpdmso/plot.py b/src/tm_devices/commands/gen_e3e9uu_lpdmso/plot.py index 798726ae..056931ee 100644 --- a/src/tm_devices/commands/gen_e3e9uu_lpdmso/plot.py +++ b/src/tm_devices/commands/gen_e3e9uu_lpdmso/plot.py @@ -1552,7 +1552,7 @@ class PlotPlotItemExportraw(SCPICmdRead): Description: - This command returns a binary stream of double values containing the x,y and hits value. Use this command along with ``MEASUREMENT:ADDMEAS TIE``, ``PLOT:PLOT1:TYPE EYEDIAGRAM``, - ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. + ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. Usage: - Using the ``.query()`` method will send the ``PLOT:PLOT:EXPORTRaw?`` query. @@ -1879,7 +1879,7 @@ def exportraw(self) -> PlotPlotItemExportraw: Description: - This command returns a binary stream of double values containing the x,y and hits value. Use this command along with ``MEASUREMENT:ADDMEAS TIE``, - ``PLOT:PLOT1:TYPE EYEDIAGRAM``, ``DISplay:SELect:VIEW`` plotview1 to export the eye + ``PLOT:PLOT1:TYPE EYEDIAGRAM``, ``DISplay:SELect:VIEW`` plotview1 to export the eye diagram plot data. Usage: diff --git a/src/tm_devices/commands/gen_e3e9uu_lpdmso/power.py b/src/tm_devices/commands/gen_e3e9uu_lpdmso/power.py index c47b1e2f..c6ce84cd 100644 --- a/src/tm_devices/commands/gen_e3e9uu_lpdmso/power.py +++ b/src/tm_devices/commands/gen_e3e9uu_lpdmso/power.py @@ -4743,7 +4743,7 @@ class PowerPowerItemSoaRecallmaskFilename(SCPICmdWriteNoArguments, SCPICmdRead): """The ``POWer:POWer:SOA:RECAllmask:FILEName`` command. Description: - - This command sets or queries the file name for saving SOA mask file name in the specified + - This command sets or queries the file name for saving SOA mask file name in the specified power measurement number. The power measurement number is specified by x. Usage: @@ -4795,7 +4795,7 @@ def filename(self) -> PowerPowerItemSoaRecallmaskFilename: """Return the ``POWer:POWer:SOA:RECAllmask:FILEName`` command. Description: - - This command sets or queries the file name for saving SOA mask file name in the + - This command sets or queries the file name for saving SOA mask file name in the specified power measurement number. The power measurement number is specified by x. Usage: @@ -7193,8 +7193,8 @@ class PowerPowerItemReflevelsAbsoluteType(SCPICmdWrite, SCPICmdRead): """The ``POWer:POWer:REFLevels:ABSolute:TYPE`` command. Description: - - This command sets or queries the type of measurement levels when reference level is set - to absolute for the specified power measurement number. + - This command sets or queries the type of measurement levels when reference level is set to + absolute for the specified power measurement number. Usage: - Using the ``.query()`` method will send the ``POWer:POWer:REFLevels:ABSolute:TYPE?`` @@ -7682,7 +7682,7 @@ def type(self) -> PowerPowerItemReflevelsAbsoluteType: """Return the ``POWer:POWer:REFLevels:ABSolute:TYPE`` command. Description: - - This command sets or queries the type of measurement levels when reference level is + - This command sets or queries the type of measurement levels when reference level is set to absolute for the specified power measurement number. Usage: @@ -12822,7 +12822,7 @@ class PowerPowerItemImpedanceAnalysismethod(SCPICmdWrite, SCPICmdRead): """The ``POWer:POWer:IMPEDANCE:ANALYSISMethod`` command. Description: - - This command sets or queries the Analysis Method for Impedance measurements. + - This command sets or queries the Analysis Method for Impedance measurements. Usage: - Using the ``.query()`` method will send the ``POWer:POWer:IMPEDANCE:ANALYSISMethod?`` @@ -13040,7 +13040,7 @@ def analysismethod(self) -> PowerPowerItemImpedanceAnalysismethod: """Return the ``POWer:POWer:IMPEDANCE:ANALYSISMethod`` command. Description: - - This command sets or queries the Analysis Method for Impedance measurements. + - This command sets or queries the Analysis Method for Impedance measurements. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_e3e9uu_lpdmso/search.py b/src/tm_devices/commands/gen_e3e9uu_lpdmso/search.py index ae1a8b8a..0d107502 100644 --- a/src/tm_devices/commands/gen_e3e9uu_lpdmso/search.py +++ b/src/tm_devices/commands/gen_e3e9uu_lpdmso/search.py @@ -2827,7 +2827,7 @@ class SearchSearchItemTriggerASetholdLogicpatternRefItem( Description: - This command sets and returns the conditions used for generating an A logic pattern, with - respect to the defined input pattern, and identifies the time that the selected pattern + 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. Usage: @@ -3112,7 +3112,7 @@ def ref(self) -> Dict[int, SearchSearchItemTriggerASetholdLogicpatternRefItem]: Description: - This command sets and returns the conditions used for generating an A logic pattern, - with respect to the defined input pattern, and identifies the time that the selected + 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. @@ -20715,8 +20715,8 @@ class SearchSearchItemTriggerABusRs232cDataSize(SCPICmdWrite, SCPICmdRead): Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is Data. - The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. The + search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -20766,8 +20766,8 @@ def size(self) -> SearchSearchItemTriggerABusRs232cDataSize: Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is - Data. The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. + The search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -32213,7 +32213,7 @@ class SearchSearchItemTriggerABusEusbSyncbitsMinSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. Description: - - This command sets the number of sync bits, in bits, to be used when triggering on a eUSB + - 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. @@ -32263,7 +32263,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMinSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MIN:SIZe`` command. Description: - - This command sets the number of sync bits, in bits, to be used when triggering on a + - 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. @@ -32293,7 +32293,7 @@ class SearchSearchItemTriggerABusEusbSyncbitsMaxSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. Description: - - This command sets the number of sync bits, to be used when triggering on a eUSB bus + - 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: @@ -32342,7 +32342,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbSyncbitsMaxSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:SYNCBITS:MAX:SIZe`` command. Description: - - This command sets the number of sync bits, to be used when triggering on a eUSB bus + - 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. @@ -33513,7 +33513,7 @@ 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. + - 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: @@ -33562,7 +33562,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMinSize: """Return 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 + - 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: @@ -33591,7 +33591,7 @@ class SearchSearchItemTriggerABusEusbEopbitsMaxSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. Description: - - This command sets the number of EOP bits to be used when triggering on a eUSB bus signal. + - 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: @@ -33640,7 +33640,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbEopbitsMaxSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:EOPBITS:MAX:SIZe`` command. Description: - - This command sets the number of EOP bits to be used when triggering on a eUSB bus + - 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: @@ -33756,7 +33756,7 @@ class SearchSearchItemTriggerABusEusbEopDatabitsSize(SCPICmdWrite, SCPICmdRead): """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 + - 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: @@ -33805,7 +33805,7 @@ 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 + - 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. @@ -34426,7 +34426,7 @@ class SearchSearchItemTriggerABusEusbDatabitsSize(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. Description: - - This command sets the number of Sync bits, in bytes, to be used when triggering on a eUSB + - 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. @@ -34474,7 +34474,7 @@ def size(self) -> SearchSearchItemTriggerABusEusbDatabitsSize: """Return the ``SEARCH:SEARCH:TRIGger:A:BUS:EUSB:DATABITS:SIZe`` command. Description: - - This command sets the number of Sync bits, in bytes, to be used when triggering on a + - 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. @@ -46486,7 +46486,7 @@ class SearchSearchItemTriggerABusCphyWordcountValue(SCPICmdWrite, SCPICmdRead): 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. + condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -46537,8 +46537,7 @@ def value(self) -> SearchSearchItemTriggerABusCphyWordcountValue: 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. + trigger condition is on any rgb/ycbcr/yuv packet. The search number is specified by x. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_e4de2d_lpdmsomdo/clear.py b/src/tm_devices/commands/gen_e4de2d_lpdmsomdo/clear.py index 10d63128..b28774e5 100644 --- a/src/tm_devices/commands/gen_e4de2d_lpdmsomdo/clear.py +++ b/src/tm_devices/commands/gen_e4de2d_lpdmsomdo/clear.py @@ -25,7 +25,7 @@ class Clear(SCPICmdWriteNoArguments): """The ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/gen_fk3z56_dpodsamso/search.py b/src/tm_devices/commands/gen_fk3z56_dpodsamso/search.py index 17b17a3c..2bf8db0a 100644 --- a/src/tm_devices/commands/gen_fk3z56_dpodsamso/search.py +++ b/src/tm_devices/commands/gen_fk3z56_dpodsamso/search.py @@ -13497,8 +13497,8 @@ class SearchSearchItemTriggerABusRs232cDataSize(SCPICmdWrite, SCPICmdRead): Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is Data. - The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. The + search number is specified by x. Usage: - Using the ``.query()`` method will send the @@ -13609,8 +13609,8 @@ def size(self) -> SearchSearchItemTriggerABusRs232cDataSize: Description: - This command sets or queries the length of the data string in bytes to be used for an - RS232 bus search to determine where to place a mark when the search condition is - Data. The search number is specified by x. + RS232 bus search to determine where to place a mark when the search condition is Data. + The search number is specified by x. Usage: - Using the ``.query()`` method will send the diff --git a/src/tm_devices/commands/gen_fn2qbf_msodpo/errordetector.py b/src/tm_devices/commands/gen_fn2qbf_msodpo/errordetector.py index 8d2c8989..d1fe29de 100644 --- a/src/tm_devices/commands/gen_fn2qbf_msodpo/errordetector.py +++ b/src/tm_devices/commands/gen_fn2qbf_msodpo/errordetector.py @@ -122,7 +122,7 @@ - ERRORDetector:SCRAMBLED? - ERRORDetector:SENDEMAIL {OFF|ON} - ERRORDetector:SENDEMAIL? - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? - ERRORDetector:SSC {ON|OFF} - ERRORDetector:SSC? @@ -1391,7 +1391,7 @@ class ErrordetectorSignaltype(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` @@ -5654,7 +5654,7 @@ def signaltype(self) -> ErrordetectorSignaltype: SCPI Syntax: ``` - - ERRORDetector:SIGnaltype {PRBS9|PRBS23|PRBS7|PRBS11|PRBS16|USB3|ANY8B10B|SATAGEN|CUSTOM|PCIEGEN} + - ERRORDetector:SIGnaltype {PCIEGEN|PRBS11|CUSTOM|ANY8B10B|USB3|PRBS9|PRBS16|PRBS23|PRBS7|SATAGEN} - ERRORDetector:SIGnaltype? ``` diff --git a/src/tm_devices/commands/gen_fpx9s1_dpodsamso/rosc.py b/src/tm_devices/commands/gen_fpx9s1_dpodsamso/rosc.py index b086e891..6355f50a 100644 --- a/src/tm_devices/commands/gen_fpx9s1_dpodsamso/rosc.py +++ b/src/tm_devices/commands/gen_fpx9s1_dpodsamso/rosc.py @@ -12,7 +12,7 @@ ``` - ROSc:OUT:FREQuency {MHZ10|MHZ100} - ROSc:OUT:FREQuency? - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? - ROSc:STATE? - ROSc:TRACking {STABle|FAST} @@ -93,7 +93,7 @@ class RoscSource(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? ``` @@ -228,7 +228,7 @@ def source(self) -> RoscSource: SCPI Syntax: ``` - - ROSc:SOUrce {EXTernal|ULTRAsync|TEKLink|INTERnal} + - ROSc:SOUrce {ULTRAsync|TEKLink|INTERnal|EXTernal} - ROSc:SOUrce? ``` diff --git a/src/tm_devices/commands/gen_u301s_msodpo/math1.py b/src/tm_devices/commands/gen_u301s_msodpo/math1.py index c0cc7908..c4264af0 100644 --- a/src/tm_devices/commands/gen_u301s_msodpo/math1.py +++ b/src/tm_devices/commands/gen_u301s_msodpo/math1.py @@ -647,7 +647,7 @@ class Math1HorizontalScale(SCPICmdWrite, SCPICmdRead): Description: - This command specifies the math horizontal display scale for FFT or for dual math waveforms that have source waveforms that are reference waveforms. The horizontal scale of - a dual math waveform with a channel source waveform is set through the command. + a dual math waveform with a channel source waveform is set through the command. Usage: - Using the ``.query()`` method will send the ``MATH1:HORizontal:SCAle?`` query. @@ -803,7 +803,7 @@ class Math1Define(SCPICmdWrite, SCPICmdRead): advanced math functions, measurements, and operators. Spectrum math (MDO models) expressions are strings of the form , where the waveforms are any combination of live RF or reference traces in the frequency domain display, the - is either + or -, and type has been set to SPECTRUM. + is either + or -, and type has been set to SPECTRUM. Usage: - Using the ``.query()`` method will send the ``MATH1:DEFine?`` query. @@ -936,7 +936,7 @@ def define(self) -> Math1Define: combinations of advanced math functions, measurements, and operators. Spectrum math (MDO models) expressions are strings of the form , where the waveforms are any combination of live RF or reference traces in the frequency domain - display, the is either + or -, and type has been set to SPECTRUM. + display, the is either + or -, and type has been set to SPECTRUM. Usage: - Using the ``.query()`` method will send the ``MATH1:DEFine?`` query. diff --git a/src/tm_devices/commands/gen_ujuvb_mdo/histogram.py b/src/tm_devices/commands/gen_ujuvb_mdo/histogram.py index 4bc21d94..32ffda41 100644 --- a/src/tm_devices/commands/gen_ujuvb_mdo/histogram.py +++ b/src/tm_devices/commands/gen_ujuvb_mdo/histogram.py @@ -43,7 +43,7 @@ class HistogramStart(SCPICmdRead): the histogram data starts. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of the - left bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units + left bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the top bin. The returned value is an . Usage: @@ -122,7 +122,7 @@ class HistogramEnd(SCPICmdRead): histogram data ends. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of the right bin. - If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of + If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an . Usage: @@ -473,7 +473,7 @@ def end(self) -> HistogramEnd: the histogram data ends. The ``HISTOGRAM:MODE`` must be either HORizontal or VERTical for a value to be returned. If the mode is OFF, an error event is set and nothing is returned. If the ``HISTOGRAM:MODE`` is HORizontal, the value returned is the time of - the right bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the + the right bin. If the ``HISTOGRAM:MODE`` is VERTical the value returned is the vertical units value of the bottom bin. The returned value is an . Usage: diff --git a/src/tm_devices/commands/gen_ujuvb_mdo/measurement.py b/src/tm_devices/commands/gen_ujuvb_mdo/measurement.py index 6b7d92b8..9b8d5a34 100644 --- a/src/tm_devices/commands/gen_ujuvb_mdo/measurement.py +++ b/src/tm_devices/commands/gen_ujuvb_mdo/measurement.py @@ -2295,7 +2295,7 @@ class MeasurementMeasItemSource1(SCPICmdWrite, SCPICmdRead): Description: - For SOURce1: This command specifies the source for all single channel measurements. For delay or phase measurements, This command specifies the waveform to measure 'from'. This - is equivalent to setting the 'From:' waveform in the 'Measure Delay' side menu or the + is equivalent to setting the 'From:' waveform in the 'Measure Delay' side menu or the 'Measure Phase' side menu. SOUrce is equivalent to SOURCE1. For SOUrce2: This command specifies the waveform to measure 'to' when taking a delay measurement or phase measurement. This is equivalent to setting the 'To:' waveform in the 'Measure Delay' side @@ -2715,12 +2715,12 @@ def source1(self) -> MeasurementMeasItemSource1: Description: - For SOURce1: This command specifies the source for all single channel measurements. For delay or phase measurements, This command specifies the waveform to measure - 'from'. This is equivalent to setting the 'From:' waveform in the 'Measure Delay' - side menu or the 'Measure Phase' side menu. SOUrce is equivalent to SOURCE1. For - SOUrce2: This command specifies the waveform to measure 'to' when taking a delay - measurement or phase measurement. This is equivalent to setting the 'To:' waveform in - the 'Measure Delay' side menu or the 'Measure Phase' side menu. Measurements are - specified by , which ranges from 1 to 8. + 'from'. This is equivalent to setting the 'From:' waveform in the 'Measure Delay' side + menu or the 'Measure Phase' side menu. SOUrce is equivalent to SOURCE1. For SOUrce2: + This command specifies the waveform to measure 'to' when taking a delay measurement or + phase measurement. This is equivalent to setting the 'To:' waveform in the 'Measure + Delay' side menu or the 'Measure Phase' side menu. Measurements are specified by , + which ranges from 1 to 8. Usage: - Using the ``.query()`` method will send the ``MEASUrement:MEAS:SOUrce1?`` query. diff --git a/src/tm_devices/commands/gen_ujuvb_mdo/save.py b/src/tm_devices/commands/gen_ujuvb_mdo/save.py index 5faaa20d..196c45cd 100644 --- a/src/tm_devices/commands/gen_ujuvb_mdo/save.py +++ b/src/tm_devices/commands/gen_ujuvb_mdo/save.py @@ -175,7 +175,7 @@ class SaveWaveform(SCPICmdWrite, SCPICmdRead): """The ``SAVe:WAVEform`` command. Description: - - This command saves the specified waveform to the specified destination reference memory, + - This command saves the specified waveform to the specified destination reference memory, or saves the specified waveform(s) to the specified destination file. Usage: @@ -856,7 +856,7 @@ def waveform(self) -> SaveWaveform: """Return the ``SAVe:WAVEform`` command. Description: - - This command saves the specified waveform to the specified destination reference + - This command saves the specified waveform to the specified destination reference memory, or saves the specified waveform(s) to the specified destination file. Usage: diff --git a/src/tm_devices/commands/gen_ujuvb_mdo/search.py b/src/tm_devices/commands/gen_ujuvb_mdo/search.py index 1c098eeb..70079bc3 100644 --- a/src/tm_devices/commands/gen_ujuvb_mdo/search.py +++ b/src/tm_devices/commands/gen_ujuvb_mdo/search.py @@ -358,7 +358,7 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:THReshold:REF? - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity {STAYSHigh|STAYSLow|EITher} - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity? - - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe? @@ -980,7 +980,7 @@ class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): SCPI Syntax: ``` - - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? ``` @@ -1094,7 +1094,7 @@ def source(self) -> SearchSearchItemTriggerATimeoutSource: SCPI Syntax: ``` - - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? ``` diff --git a/src/tm_devices/commands/gen_usaa3_mdo/search.py b/src/tm_devices/commands/gen_usaa3_mdo/search.py index a726fea4..b57dc0fd 100644 --- a/src/tm_devices/commands/gen_usaa3_mdo/search.py +++ b/src/tm_devices/commands/gen_usaa3_mdo/search.py @@ -368,6 +368,8 @@ - SEARCH:SEARCH:TRIGger:A:SETHold:THReshold:REF? - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity {STAYSHigh|STAYSLow|EITher} - SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity? + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe - SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe? - SEARCH:SEARCH:TRIGger:A:TRANsition:DELTatime @@ -969,6 +971,40 @@ class SearchSearchItemTriggerATimeoutTime(SCPICmdWrite, SCPICmdRead): """ +class SearchSearchItemTriggerATimeoutSource(SCPICmdWrite, SCPICmdRead): + """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` + query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if the + returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. (Requires + option 3-MSO.). + """ # noqa: E501 + + class SearchSearchItemTriggerATimeoutPolarity(SCPICmdWrite, SCPICmdRead): """The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. @@ -1007,6 +1043,7 @@ class SearchSearchItemTriggerATimeout(SCPICmdRead): Properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ @@ -1015,6 +1052,7 @@ def __init__(self, device: Optional["PIControl"], cmd_syntax: str) -> None: self._polarity = SearchSearchItemTriggerATimeoutPolarity( device, f"{self._cmd_syntax}:POLarity" ) + self._source = SearchSearchItemTriggerATimeoutSource(device, f"{self._cmd_syntax}:SOUrce") self._time = SearchSearchItemTriggerATimeoutTime(device, f"{self._cmd_syntax}:TIMe") @property @@ -1046,6 +1084,41 @@ def polarity(self) -> SearchSearchItemTriggerATimeoutPolarity: """ return self._polarity + @property + def source(self) -> SearchSearchItemTriggerATimeoutSource: + """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. + + Description: + - When searching using the TIMEOut search type, this command specifies the source. The + available sources are live channels, reference waveforms, the math waveform, or the + digital channels. The default is channel 1. The timeout search type is selected using + ``SEARCH:SEARCHX:TRIGGER:A:TYPE``. SEARCH is the search number, which is always 1. + + Usage: + - Using the ``.query()`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query. + - Using the ``.verify(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce?`` query and raise an AssertionError if + the returned value does not match ``value``. + - Using the ``.write(value)`` method will send the + ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce value`` command. + + SCPI Syntax: + ``` + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce {CH|MATH|REF|D0|D1|D2|D3|D4|D5|D6|D7|D8|D9|D10|D11|D12|D13|D14|D15|RF_AMPlitude|RF_FREQuency|RF_PHASe} + - SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce? + ``` + + Info: + - ``CH`` specifies to use one of the analog channels as the source waveform. + - ``MATH`` specifies to use the math waveform as the as the source waveform. + - ``REF`` specifies to use one of the reference waveforms 1-4 as the as the source + waveform. + - ``D`` specifies to use one of the digital channels as the source waveform. + (Requires option 3-MSO.). + """ # noqa: E501 + return self._source + @property def time(self) -> SearchSearchItemTriggerATimeoutTime: """Return the ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. @@ -15500,6 +15573,7 @@ def timeout(self) -> SearchSearchItemTriggerATimeout: Sub-properties: - ``.polarity``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:POLarity`` command. + - ``.source``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:SOUrce`` command. - ``.time``: The ``SEARCH:SEARCH:TRIGger:A:TIMEOut:TIMe`` command. """ return self._timeout diff --git a/src/tm_devices/commands/helpers/scpi_commands.py b/src/tm_devices/commands/helpers/scpi_commands.py index 7980d004..99c73a68 100644 --- a/src/tm_devices/commands/helpers/scpi_commands.py +++ b/src/tm_devices/commands/helpers/scpi_commands.py @@ -76,7 +76,7 @@ def verify(self, value: Union[float, str]) -> Tuple[bool, str]: Returns: A tuple containing a boolean indicating if the values match and a string with the actual - return value from the device. + return value from the device. Raises: tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. @@ -136,7 +136,7 @@ def verify(self, argument: str, value: Union[float, str]) -> Tuple[bool, str]: Returns: A tuple containing a boolean indicating if the values match and a string with the actual - return value from the device. + return value from the device. Raises: tm_devices.commands.NoDeviceProvidedError: Indicates that no device connection exists. diff --git a/src/tm_devices/commands/lpd6_commands.py b/src/tm_devices/commands/lpd6_commands.py index faa32ec8..82db25ba 100644 --- a/src/tm_devices/commands/lpd6_commands.py +++ b/src/tm_devices/commands/lpd6_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mdo3_commands.py b/src/tm_devices/commands/mdo3_commands.py index d0aedf1d..bdaf53e0 100644 --- a/src/tm_devices/commands/mdo3_commands.py +++ b/src/tm_devices/commands/mdo3_commands.py @@ -31,6 +31,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -97,7 +98,6 @@ from .gen_ujuvb_mdo.header import Header from .gen_ujuvb_mdo.histogram import Histogram from .gen_ujuvb_mdo.lock import Lock -from .gen_ujuvb_mdo.mark import Mark from .gen_ujuvb_mdo.mask import Mask from .gen_ujuvb_mdo.measurement import Measurement from .gen_ujuvb_mdo.message import Message @@ -1172,7 +1172,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mdo3k_commands.py b/src/tm_devices/commands/mdo3k_commands.py index 55e04ac3..285641be 100644 --- a/src/tm_devices/commands/mdo3k_commands.py +++ b/src/tm_devices/commands/mdo3k_commands.py @@ -35,6 +35,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -64,7 +65,6 @@ from .gen_1nmc1o_msodpomdo.status_and_error import Psc from .gen_1nmc1o_msodpomdo.usbdevice import Usbdevice from .gen_1nmc1o_msodpomdo.usbtmc import Usbtmc -from .gen_16opiv_mdomso.mark import Mark from .gen_e6bmgw_lpdmsotekscopepcdpomdo.totaluptime import Totaluptime from .gen_e6wozn_lpdmsotekscopepcmdodpo.pause import Pause from .gen_fhrp27_msodpomdodsa.curve import Curve @@ -2087,6 +2087,7 @@ def mark(self) -> Mark: Sub-properties: - ``.create``: The ``MARK:CREATE`` command. + - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. - ``.selected``: The ``MARK:SELected`` command tree. diff --git a/src/tm_devices/commands/mdo4k_commands.py b/src/tm_devices/commands/mdo4k_commands.py index 8b29455e..6c42fe98 100644 --- a/src/tm_devices/commands/mdo4k_commands.py +++ b/src/tm_devices/commands/mdo4k_commands.py @@ -35,6 +35,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -66,7 +67,6 @@ from .gen_1nmc1o_msodpomdo.status_and_error import Psc from .gen_1nmc1o_msodpomdo.usbdevice import Usbdevice from .gen_1nmc1o_msodpomdo.usbtmc import Usbtmc -from .gen_163n04_mdo.mark import Mark from .gen_163n04_mdo.search import Search from .gen_e6bmgw_lpdmsotekscopepcdpomdo.totaluptime import Totaluptime from .gen_e6wozn_lpdmsotekscopepcmdodpo.pause import Pause @@ -2093,6 +2093,7 @@ def mark(self) -> Mark: - ``PREVious`` moves to the next reference mark on the left. Sub-properties: + - ``.create``: The ``MARK:CREATE`` command. - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. diff --git a/src/tm_devices/commands/mdo4kb_commands.py b/src/tm_devices/commands/mdo4kb_commands.py index 2689fe6d..25c6ca12 100644 --- a/src/tm_devices/commands/mdo4kb_commands.py +++ b/src/tm_devices/commands/mdo4kb_commands.py @@ -17,7 +17,6 @@ from .gen_1l4fot_mdomso.cursor import Cursor from .gen_1lcv3a_msodpomdo.message import Message from .gen_1lcv3a_msodpomdo.setup_1 import SetupItem -from .gen_1le9o2_mdo.mark import Mark from .gen_1ltpwt_mdomsodpo.actonevent import Actonevent from .gen_1ltpwt_mdomsodpo.afg import Afg from .gen_1ltpwt_mdomsodpo.alias import Alias @@ -38,6 +37,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge diff --git a/src/tm_devices/commands/mdo4kc_commands.py b/src/tm_devices/commands/mdo4kc_commands.py index 5dd7de1c..71112c86 100644 --- a/src/tm_devices/commands/mdo4kc_commands.py +++ b/src/tm_devices/commands/mdo4kc_commands.py @@ -18,7 +18,6 @@ from .gen_1l4fot_mdomso.cursor import Cursor from .gen_1lcv3a_msodpomdo.message import Message from .gen_1lcv3a_msodpomdo.setup_1 import SetupItem -from .gen_1le9o2_mdo.mark import Mark from .gen_1ltpwt_mdomsodpo.actonevent import Actonevent from .gen_1ltpwt_mdomsodpo.afg import Afg from .gen_1ltpwt_mdomsodpo.alias import Alias @@ -39,6 +38,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge diff --git a/src/tm_devices/commands/mso2_commands.py b/src/tm_devices/commands/mso2_commands.py index bf7fad0d..4d353a88 100644 --- a/src/tm_devices/commands/mso2_commands.py +++ b/src/tm_devices/commands/mso2_commands.py @@ -1057,7 +1057,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso4_commands.py b/src/tm_devices/commands/mso4_commands.py index 100bac0b..e27afaca 100644 --- a/src/tm_devices/commands/mso4_commands.py +++ b/src/tm_devices/commands/mso4_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso4b_commands.py b/src/tm_devices/commands/mso4b_commands.py index c2814f88..8f5f4055 100644 --- a/src/tm_devices/commands/mso4b_commands.py +++ b/src/tm_devices/commands/mso4b_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso4k_commands.py b/src/tm_devices/commands/mso4k_commands.py index fc8dcb7e..393248da 100644 --- a/src/tm_devices/commands/mso4k_commands.py +++ b/src/tm_devices/commands/mso4k_commands.py @@ -35,6 +35,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -61,7 +62,6 @@ from .gen_1mlt9u_mdomsodpo.save import Save from .gen_1mlt9u_mdomsodpo.select import Select from .gen_1mq0z9_msodpo.rf import Rf -from .gen_1msu49_msodpo.mark import Mark from .gen_1nmc1o_msodpomdo.clearmenu import Clearmenu from .gen_1nmc1o_msodpomdo.errlog import Errlog from .gen_1nmc1o_msodpomdo.language import Language @@ -212,6 +212,7 @@ class MSO4KCommandConstants: CMOS_2_5V = "CMOS_2_5V" CMOS_3_3V = "CMOS_3_3V" CMOS_5_0V = "CMOS_5_0V" + COLUMN = "COLUMN" COMMAND = "COMMAND" COPYACTIVE = "COPYACTIVE" # COPYACTive CPU = "CPU" @@ -2092,6 +2093,8 @@ def mark(self) -> Mark: - ``PREVious`` moves to the next reference mark on the left. Sub-properties: + - ``.create``: The ``MARK:CREATE`` command. + - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. - ``.selected``: The ``MARK:SELected`` command tree. diff --git a/src/tm_devices/commands/mso4kb_commands.py b/src/tm_devices/commands/mso4kb_commands.py index 54d83885..c4391e2a 100644 --- a/src/tm_devices/commands/mso4kb_commands.py +++ b/src/tm_devices/commands/mso4kb_commands.py @@ -37,6 +37,7 @@ from .gen_1ltpwt_mdomsodpo.gpibusb import Gpibusb from .gen_1ltpwt_mdomsodpo.hardcopy import Hardcopy from .gen_1ltpwt_mdomsodpo.horizontal import Horizontal +from .gen_1ltpwt_mdomsodpo.mark import Mark from .gen_1ltpwt_mdomsodpo.marker import Marker from .gen_1ltpwt_mdomsodpo.math1 import Math1 from .gen_1ltpwt_mdomsodpo.pictbridge import Pictbridge @@ -67,7 +68,6 @@ from .gen_1nmc1o_msodpomdo.status_and_error import Psc from .gen_1nmc1o_msodpomdo.usbdevice import Usbdevice from .gen_1nmc1o_msodpomdo.usbtmc import Usbtmc -from .gen_16opiv_mdomso.mark import Mark from .gen_e6bmgw_lpdmsotekscopepcdpomdo.totaluptime import Totaluptime from .gen_e6wozn_lpdmsotekscopepcmdodpo.pause import Pause from .gen_fhrp27_msodpomdodsa.curve import Curve @@ -2095,6 +2095,7 @@ def mark(self) -> Mark: Sub-properties: - ``.create``: The ``MARK:CREATE`` command. + - ``.delete``: The ``MARK:DELEte`` command. - ``.free``: The ``MARK:FREE`` command. - ``.saveall``: The ``MARK:SAVEALL`` command. - ``.selected``: The ``MARK:SELected`` command tree. diff --git a/src/tm_devices/commands/mso5_commands.py b/src/tm_devices/commands/mso5_commands.py index cf4f33c3..77a58cd9 100644 --- a/src/tm_devices/commands/mso5_commands.py +++ b/src/tm_devices/commands/mso5_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso5b_commands.py b/src/tm_devices/commands/mso5b_commands.py index a95411f4..d75953da 100644 --- a/src/tm_devices/commands/mso5b_commands.py +++ b/src/tm_devices/commands/mso5b_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso5lp_commands.py b/src/tm_devices/commands/mso5lp_commands.py index 79e202c9..8127cd22 100644 --- a/src/tm_devices/commands/mso5lp_commands.py +++ b/src/tm_devices/commands/mso5lp_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso6_commands.py b/src/tm_devices/commands/mso6_commands.py index 93304136..83919ebf 100644 --- a/src/tm_devices/commands/mso6_commands.py +++ b/src/tm_devices/commands/mso6_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command. diff --git a/src/tm_devices/commands/mso6b_commands.py b/src/tm_devices/commands/mso6b_commands.py index 1db722d2..ee9851b4 100644 --- a/src/tm_devices/commands/mso6b_commands.py +++ b/src/tm_devices/commands/mso6b_commands.py @@ -1880,7 +1880,7 @@ def clear(self) -> Clear: """Return the ``CLEAR`` command. Description: - - This command clears acquisitions, measurements, and waveforms. + - This command clears acquisitions, measurements, and waveforms. Usage: - Using the ``.write()`` method will send the ``CLEAR`` command.