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, word=repcap.Word.Default, field=repcap.Field.Default) -> enums.SbusUartWordState:
"""
``SBUS<*>:UART:WORD<*>:FLD<*>:STATe`` \n
Snippet: ``value: enums.SbusUartWordState = driver.sbus.uart.word.fld.state.get(serialBus = repcap.SerialBus.Default, word = repcap.Word.Default, field = repcap.Field.Default)`` \n
Returns the overall state of the specified field in the specified frame.
:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
:param word: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Word')
:param field: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Fld')
:return: state: OK: the frame is valid. BREak: stop bit error with 0x00 word STERror: start error, incorrect start bit SPERror: stop error, incorrect stop bit PRERror: parity error, incorrect parity bit. INComplete: The frame is not completely contained in the acquisition. The acquired part of the frame is valid.
"""
serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
word_cmd_val = self._cmd_group.get_repcap_cmd_value(word, repcap.Word)
field_cmd_val = self._cmd_group.get_repcap_cmd_value(field, repcap.Field)
response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:UART:WORD{word_cmd_val}:FLD{field_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.SbusUartWordState)