fix: Update the commands to have uniform spacing of arguments. (#234)

Co-authored-by: Nicholas Felt <[email protected]>
tektronix · Jun 10, 2024 · cfcb3fb · cfcb3fb
1 parent 9e6e016
commit cfcb3fb
Show file tree

Hide file tree

Showing 117 changed files with 4,106 additions and 3,243 deletions.
diff --git a/src/tm_devices/commands/afg3k_commands.py b/src/tm_devices/commands/afg3k_commands.py
@@ -44,7 +44,6 @@ class AFG3KCommandConstants:
     """
 
     EMEMORY = "EMEMORY"  # EMEMory
-    EMEMORY1 = "EMEMORY1"  # EMEMory1
     EMEMORY2 = "EMEMORY2"  # EMEMory2
     EXTERNAL = "EXTERNAL"  # EXTernal
     NEGATIVE = "NEGATIVE"  # NEGative

diff --git a/src/tm_devices/commands/afg3kb_commands.py b/src/tm_devices/commands/afg3kb_commands.py
@@ -44,7 +44,6 @@ class AFG3KBCommandConstants:
     """
 
     EMEMORY = "EMEMORY"  # EMEMory
-    EMEMORY1 = "EMEMORY1"  # EMEMory1
     EMEMORY2 = "EMEMORY2"  # EMEMory2
     EXTERNAL = "EXTERNAL"  # EXTernal
     NEGATIVE = "NEGATIVE"  # NEGative

diff --git a/src/tm_devices/commands/afg3kc_commands.py b/src/tm_devices/commands/afg3kc_commands.py
@@ -44,7 +44,6 @@ class AFG3KCCommandConstants:
     """
 
     EMEMORY = "EMEMORY"  # EMEMory
-    EMEMORY1 = "EMEMORY1"  # EMEMory1
     EMEMORY2 = "EMEMORY2"  # EMEMory2
     EXTERNAL = "EXTERNAL"  # EXTernal
     NEGATIVE = "NEGATIVE"  # NEGative

diff --git a/src/tm_devices/commands/gen_163n04_mdo/search.py b/src/tm_devices/commands/gen_163n04_mdo/search.py
diff --git a/src/tm_devices/commands/gen_16x4xq_mdo/search.py b/src/tm_devices/commands/gen_16x4xq_mdo/search.py
diff --git a/src/tm_devices/commands/gen_1jzp7o_mdodpo/trigger.py b/src/tm_devices/commands/gen_1jzp7o_mdodpo/trigger.py
diff --git a/src/tm_devices/commands/gen_1kdqwg_mdo/search.py b/src/tm_devices/commands/gen_1kdqwg_mdo/search.py
diff --git a/src/tm_devices/commands/gen_1kdqwg_mdo/trigger.py b/src/tm_devices/commands/gen_1kdqwg_mdo/trigger.py
diff --git a/src/tm_devices/commands/gen_1kjd62_mdo/rf.py b/src/tm_devices/commands/gen_1kjd62_mdo/rf.py
@@ -55,7 +55,8 @@
     - RF:PRObe:CALibrate {EXECute|INITialize}
     - RF:PRObe:CALibrate:CALIBRATABLe?
     - RF:PRObe:CALibrate:STATE?
-    - RF:PRObe:COMMAND <QString>, <QString>? <QString>
+    - RF:PRObe:COMMAND <QString>, <QString>
+    - RF:PRObe:COMMAND? <QString>
     - RF:PRObe:DEGAUss EXECute
     - RF:PRObe:DEGAUss:STATE?
     - RF:PRObe:FORCEDRange <NR3>
@@ -140,7 +141,7 @@
 
 from typing import Optional, TYPE_CHECKING
 
-from ..helpers import SCPICmdRead, SCPICmdWrite, SCPICmdWriteNoArguments
+from ..helpers import SCPICmdRead, SCPICmdReadWithArguments, SCPICmdWrite, SCPICmdWriteNoArguments
 
 if TYPE_CHECKING:
     from tm_devices.drivers.pi.pi_device import PIDevice
@@ -2323,7 +2324,7 @@ def state(self) -> RfProbeDegaussState:
         return self._state
 
 
-class RfProbeCommand(SCPICmdWrite):
+class RfProbeCommand(SCPICmdWrite, SCPICmdReadWithArguments):
     """The ``RF:PRObe:COMMAND`` command.
 
     Description:
@@ -2335,11 +2336,15 @@ class RfProbeCommand(SCPICmdWrite):
           specify the probe command enumeration for which the response data is requested.
 
     Usage:
+        - Using the ``.query(argument)`` method will send the ``RF:PRObe:COMMAND? argument`` query.
+        - Using the ``.verify(argument, value)`` method will send the ``RF:PRObe:COMMAND? argument``
+          query and raise an AssertionError if the returned value does not match ``value``.
         - Using the ``.write(value)`` method will send the ``RF:PRObe:COMMAND value`` command.
 
     SCPI Syntax:
         ```
-        - RF:PRObe:COMMAND <QString>, <QString>? <QString>
+        - RF:PRObe:COMMAND <QString>, <QString>
+        - RF:PRObe:COMMAND? <QString>
         ```
 
     Info:
@@ -2571,11 +2576,17 @@ def command(self) -> RfProbeCommand:
               is requested.
 
         Usage:
+            - Using the ``.query(argument)`` method will send the ``RF:PRObe:COMMAND? argument``
+              query.
+            - Using the ``.verify(argument, value)`` method will send the
+              ``RF:PRObe:COMMAND? argument`` query and raise an AssertionError if the returned value
+              does not match ``value``.
             - Using the ``.write(value)`` method will send the ``RF:PRObe:COMMAND value`` command.
 
         SCPI Syntax:
             ```
-            - RF:PRObe:COMMAND <QString>, <QString>? <QString>
+            - RF:PRObe:COMMAND <QString>, <QString>
+            - RF:PRObe:COMMAND? <QString>
             ```
 
         Info:

diff --git a/src/tm_devices/commands/gen_1kozfv_dpo/search.py b/src/tm_devices/commands/gen_1kozfv_dpo/search.py
diff --git a/src/tm_devices/commands/gen_1l4fot_mdomso/cursor.py b/src/tm_devices/commands/gen_1l4fot_mdomso/cursor.py
@@ -21,7 +21,7 @@
     - CURSor:HBArs?
     - CURSor:MODe {TRACk|INDependent}
     - CURSor:MODe?
-    - CURSor:SOUrce {CH<x>|REF<x>|MATH |BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
+    - CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
     - CURSor:SOUrce?
     - CURSor:VBArs:ALTERNATE<x>?
     - CURSor:VBArs:DELTa?
@@ -1557,7 +1557,7 @@ class CursorSource(SCPICmdWrite, SCPICmdRead):
 
     SCPI Syntax:
         ```
-        - CURSor:SOUrce {CH<x>|REF<x>|MATH |BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
+        - CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
         - CURSor:SOUrce?
         ```
 
@@ -2047,7 +2047,7 @@ def source(self) -> CursorSource:
 
         SCPI Syntax:
             ```
-            - CURSor:SOUrce {CH<x>|REF<x>|MATH |BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
+            - CURSor:SOUrce {CH<x>|REF<x>|MATH|BUS<x>|D<x>|RF_AMPlitude|RF_FREQuency|RF_PHASe|AUTO}
             - CURSor:SOUrce?
             ```