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 EscParityCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("escParity", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default) -> enums.SbusSwireFrameState:
"""
``SBUS<*>:SWIRe:FRAMe<*>:ESCParity`` \n
Snippet: ``value: enums.SbusSwireFrameState = driver.sbus.swire.frame.escParity.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)`` \n
If the frame has the ESC field, the command returns the parity state of this field, which can take values of OK or PARity.
See Figure 'SpaceWire control characters'. If the frame has no ESC field, the command can return the states LENGth,
AMBiguous or INComplete of the frame, as described below.
:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
:param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame')
:return: parity_escape: OK | PARity | LENGth | AMBiguous | INComplete \n
- OK: The parity check for the ESC field passes.
- PARity: The parity of the ESC field is not correct.
- LENGth: Regardless of the ESC field, the length of the frame is not as expected, indicating an error.
- AMBiguous: Regardless of the ESC field, the frame is ambiguous.
- INComplete: Regardless of the ESC field, the frame is incomplete.
"""
serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame)
response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:SWIRe:FRAMe{frame_cmd_val}:ESCParity?')
return Conversions.str_to_scalar_enum(response, enums.SbusSwireFrameState)