from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Types import DataType
from .....Internal.ArgSingleList import ArgSingleList
from .....Internal.ArgSingle import ArgSingle
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class TokenCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("token", core, parent)
[docs]
def set(self, search: str, usb_token_type: enums.BusUsbTokenType) -> None:
"""
``SEARch:TRIGger:USB:TOKen`` \n
Snippet: ``driver.search.trigger.usb.token.set(search = 'abc', usb_token_type = enums.BusUsbTokenType.ANY)`` \n
Defines, which token packet type is searched for: OUT, IN, SOF, SETUP, or Any token packet.
:param usb_token_type: ANY | OUT | IN | SOF | SETup \n
- ANY: Searches for any of the token packet types listed below.
- OUT: Searches for an OUT token.
- IN: Searches for an IN token.
- SOF: Searches for a start of frame (SOF) token.
- SETup: Searches for a SETup token.
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('usb_token_type', usb_token_type, DataType.Enum, enums.BusUsbTokenType))
self._core.io.write(f'SEARch:TRIGger:USB:TOKen {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
def get(self, search: str) -> enums.BusUsbTokenType:
"""
``SEARch:TRIGger:USB:TOKen`` \n
Snippet: ``value: enums.BusUsbTokenType = driver.search.trigger.usb.token.get(search = 'abc')`` \n
Defines, which token packet type is searched for: OUT, IN, SOF, SETUP, or Any token packet.
:return: usb_token_type: ANY | OUT | IN | SOF | SETup \n
- ANY: Searches for any of the token packet types listed below.
- OUT: Searches for an OUT token.
- IN: Searches for an IN token.
- SOF: Searches for a start of frame (SOF) token.
- SETup: Searches for a SETup token.
"""
param = Conversions.value_to_quoted_str(search)
response = self._core.io.query_str(f'SEARch:TRIGger:USB:TOKen? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusUsbTokenType)