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, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> enums.BusHbtoResultState:
"""
``BUS<*>:HBTO:RESult:FRAMe<*>:STATe`` \n
Snippet: ``value: enums.BusHbtoResultState = driver.bus.hbto.result.frame.state.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the state of the 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 | ERR_PREAMBLE | ERR_SFD | ERR_LENGTH | ERR_CRC | UNCorrelated | INComplete \n
- OK: Valid frame.
- ERR_PREAMBLE: Erroneous frame due to preamble error.
- ERR_SFD: Erroneous frame due to SFD error.
- ERR_LENGTH: Erroneous frame due to length / type error.
- ERR_CRC: Erroneous frame due to CRC error.
"""
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}:HBTO:RESult:FRAMe{busFrameNull_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.BusHbtoResultState)