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, byteNull=repcap.ByteNull.Default) -> enums.BusLinFrameErrorState:
"""
``BUS<*>:LIN:FRAMe<*>:BYTE<*>:STATe`` \n
Snippet: ``value: enums.BusLinFrameErrorState = driver.bus.lin.frame.byte.state.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, byteNull = repcap.ByteNull.Default)`` \n
Returns the state of the specified byte.
: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')
:param byteNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Byte')
:return: state: STERror: start error SPERror: stop error UVAL: unexpected value NOEXists: byte does not exist INSufficient: the frame is not completely contained in the acquisition. The decoded 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)
byteNull_cmd_val = self._cmd_group.get_repcap_cmd_value(byteNull, repcap.ByteNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:LIN:FRAMe{busFrameNull_cmd_val}:BYTE{byteNull_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.BusLinFrameErrorState)