from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import enums
from .... import repcap
# 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, usb_token_type: enums.BusUsbTokenType, trigger=repcap.Trigger.Default) -> None:
"""
``TRIGger<*>:USB:TOKen`` \n
Snippet: ``driver.trigger.usb.token.set(usb_token_type = enums.BusUsbTokenType.ANY, trigger = repcap.Trigger.Default)`` \n
Sets the trigger to one out of four different token types: OUT, IN, SOF, or SETup.
:param usb_token_type: OUT | IN | SOF | SETup \n
- OUT: Sets the trigger to the OUT token (OUT packet from host to device) .
- IN: Sets the trigger to the IN token (IN packet from device to host) .
- SOF: Sets the trigger to the SOF token (start of frame marker and frame number) .
- SETup: Sets the trigger to the SETUP token (address and endpoint number in OUT transaction for setup to a control pipe) .
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
"""
param = Conversions.enum_scalar_to_str(usb_token_type, enums.BusUsbTokenType)
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
self._core.io.write(f'TRIGger{trigger_cmd_val}:USB:TOKen {param}')
# noinspection PyTypeChecker
[docs]
def get(self, trigger=repcap.Trigger.Default) -> enums.BusUsbTokenType:
"""
``TRIGger<*>:USB:TOKen`` \n
Snippet: ``value: enums.BusUsbTokenType = driver.trigger.usb.token.get(trigger = repcap.Trigger.Default)`` \n
Sets the trigger to one out of four different token types: OUT, IN, SOF, or SETup.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:return: usb_token_type: OUT | IN | SOF | SETup \n
- OUT: Sets the trigger to the OUT token (OUT packet from host to device) .
- IN: Sets the trigger to the IN token (IN packet from device to host) .
- SOF: Sets the trigger to the SOF token (start of frame marker and frame number) .
- SETup: Sets the trigger to the SETUP token (address and endpoint number in OUT transaction for setup to a control pipe) .
"""
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
response = self._core.io.query_str(f'TRIGger{trigger_cmd_val}:USB:TOKen?')
return Conversions.str_to_scalar_enum(response, enums.BusUsbTokenType)