Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the commands to have uniform spacing of arguments. #234

Merged
merged 3 commits into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/tm_devices/commands/afg3k_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class AFG3KCommandConstants:
"""

EMEMORY = "EMEMORY" # EMEMory
EMEMORY1 = "EMEMORY1" # EMEMory1
EMEMORY2 = "EMEMORY2" # EMEMory2
EXTERNAL = "EXTERNAL" # EXTernal
NEGATIVE = "NEGATIVE" # NEGative
Expand Down
1 change: 0 additions & 1 deletion src/tm_devices/commands/afg3kb_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class AFG3KBCommandConstants:
"""

EMEMORY = "EMEMORY" # EMEMory
EMEMORY1 = "EMEMORY1" # EMEMory1
EMEMORY2 = "EMEMORY2" # EMEMory2
EXTERNAL = "EXTERNAL" # EXTernal
NEGATIVE = "NEGATIVE" # NEGative
Expand Down
1 change: 0 additions & 1 deletion src/tm_devices/commands/afg3kc_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class AFG3KCCommandConstants:
"""

EMEMORY = "EMEMORY" # EMEMory
EMEMORY1 = "EMEMORY1" # EMEMory1
EMEMORY2 = "EMEMORY2" # EMEMory2
EXTERNAL = "EXTERNAL" # EXTernal
NEGATIVE = "NEGATIVE" # NEGative
Expand Down
206 changes: 97 additions & 109 deletions src/tm_devices/commands/gen_163n04_mdo/search.py

Large diffs are not rendered by default.

194 changes: 91 additions & 103 deletions src/tm_devices/commands/gen_16x4xq_mdo/search.py

Large diffs are not rendered by default.

78 changes: 39 additions & 39 deletions src/tm_devices/commands/gen_1jzp7o_mdodpo/trigger.py

Large diffs are not rendered by default.

212 changes: 100 additions & 112 deletions src/tm_devices/commands/gen_1kdqwg_mdo/search.py

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions src/tm_devices/commands/gen_1kdqwg_mdo/trigger.py

Large diffs are not rendered by default.

21 changes: 16 additions & 5 deletions src/tm_devices/commands/gen_1kjd62_mdo/rf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -2323,7 +2324,7 @@ def state(self) -> RfProbeDegaussState:
return self._state


class RfProbeCommand(SCPICmdWrite):
class RfProbeCommand(SCPICmdWrite, SCPICmdReadWithArguments):
"""The ``RF:PRObe:COMMAND`` command.

Description:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
194 changes: 91 additions & 103 deletions src/tm_devices/commands/gen_1kozfv_dpo/search.py

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions src/tm_devices/commands/gen_1l4fot_mdomso/cursor.py
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down Expand Up @@ -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?
```

Expand Down Expand Up @@ -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?
```

Expand Down
Loading
Loading