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 StatusCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("status", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> enums.BusSpiFrameState:
"""
``BUS<*>:SPI:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.BusSpiFrameState = driver.bus.spi.frame.status.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the overall state of the specified frame.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:return: state: OK: the frame is valid. VOID: the frame is empty. INCFirst: INComplete First word. The first word does not have the expected word length. INCLast: INComplete Last word. The last word does not have the expected word length. INSufficient: The frame is not completely contained in the acquisition. The acquired part of the frame is valid.
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:SPI:FRAMe{busFrameNull_cmd_val}:STATus?')
return Conversions.str_to_scalar_enum(response, enums.BusSpiFrameState)