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.TnosFrameState:
"""
``BUS<*>:TNOS:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.TnosFrameState = driver.bus.tnos.frame.status.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 | EPRMble | ESFD | EESD | ECRC | ELEN | INComplete \n
- OK: The frame has no error, it is valid.
- EPRMble: Preamble error, the hex value of the preamble field is different from 0x55555555555555 (56 alternating 0's and 1's) .
- ESFD: SFD error, the hex value of the SFD field is different from 0xD5.
- EESD: ESD error, the value of the ESD field does not correspond to the symbol pair 'ESD, ESDOK'
- ECRC: CRC error, the value of the FCS field does not match the calculated CRC.
- ELEN: Length error, the number of bits in the specified frame is higher or lower than expected.
- INComplete: The frame is incomplete.
"""
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}:TNOS:FRAMe{busFrameNull_cmd_val}:STATus?')
return Conversions.str_to_scalar_enum(response, enums.TnosFrameState)