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 PacketsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("packets", core, parent)
[docs]
def set(self, packets: enums.BusUartPackets, bus=repcap.Bus.Default) -> None:
"""
``BUS<*>:UART:PACKets`` \n
Snippet: ``driver.bus.uart.packets.set(packets = enums.BusUartPackets.EWORd, bus = repcap.Bus.Default)`` \n
Defines the method of packet separation. A packet is a number of subsequent words in a date stream.
:param packets: NONE | EWORd | TOUT \n
- NONE: Packets are not considered.
- EWORd: End word, the end condition of a packet is a pattern. To define the end word, use BUSb:UART:EWORd
- TOUT: Defines a timeout between the packets. To set the timeout, use BUSb:UART:TOUT
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
"""
param = Conversions.enum_scalar_to_str(packets, enums.BusUartPackets)
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
self._core.io.write(f'BUS{bus_cmd_val}:UART:PACKets {param}')
# noinspection PyTypeChecker
[docs]
def get(self, bus=repcap.Bus.Default) -> enums.BusUartPackets:
"""
``BUS<*>:UART:PACKets`` \n
Snippet: ``value: enums.BusUartPackets = driver.bus.uart.packets.get(bus = repcap.Bus.Default)`` \n
Defines the method of packet separation. A packet is a number of subsequent words in a date stream.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:return: packets: NONE | EWORd | TOUT \n
- NONE: Packets are not considered.
- EWORd: End word, the end condition of a packet is a pattern. To define the end word, use BUSb:UART:EWORd
- TOUT: Defines a timeout between the packets. To set the timeout, use BUSb:UART:TOUT
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:UART:PACKets?')
return Conversions.str_to_scalar_enum(response, enums.BusUartPackets)