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, field=repcap.Field.Default) -> enums.SbusQspiFrameState:
"""
``SBUS<*>:QSPI:FRAMe<*>:FLD<*>:STATe`` \n
Snippet: ``value: enums.SbusQspiFrameState = driver.sbus.qspi.frame.fld.state.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default, field = repcap.Field.Default)`` \n
Returns the state of the selected field in 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')
:param field: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Fld')
:return: state: OK | LENGth | OPCode | INComplete \n
- OK: The field is valid.
- LENGth: The field does not have the expected length.
- OPCode: The opcode value is not found in your frame description list. See 'Format'.
- INComplete: The field is not completely contained in the acquisition. The acquired part of the field is usually valid, but cannot always be trusted.
"""
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)
field_cmd_val = self._cmd_group.get_repcap_cmd_value(field, repcap.Field)
response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:QSPI:FRAMe{frame_cmd_val}:FLD{field_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.SbusQspiFrameState)