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 StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default) -> enums.SbusSwireFrameState:
"""
``SBUS<*>:SWIRe:FRAMe<*>:STATe`` \n
Snippet: ``value: enums.SbusSwireFrameState = driver.sbus.swire.frame.state.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)`` \n
Returns the overall state of the specified frame.
: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: frame_state: OK | PARity | LENGth | AMBiguous | INComplete \n
- OK: The frame is valid.
- PARity: Parity is not as expected, indicating an error
- LENGth: Length of the frame is not as expected, indicating an error
- AMBiguous: The frame is ambiguous.
- INComplete: 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}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.SbusSwireFrameState)