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.BusCanFrameState:
"""
``BUS<*>:CAN:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.BusCanFrameState = driver.bus.can.frame.status.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the overall state of the selected 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. FORM: Fixed-bit form error BTST: Bit stuffing error occured. CRC: Cyclic redundancy check failed. CRCD: Wrong CRC delimiter occured. NOACK: Acknowlegde is missing. ACKD: Wrong ACK delimiter occured. EOFD: Wrong end of frame. CAERror: CRC error followed by an acknowledgement error (missing acknowledge) FCERor: CRC error followed by a form error (wrong CRC delimiter or wrong ACK delimiter) INSufficient: The frame is not completely contained in the acquisition. The acquired part of the frame is valid. SERRror: Stuff count error (CAN-FD ISO only) SFER: Stuff count error and FORM error (CAN-FD ISO only) SCER: Stuff count error and CRC error (CAN-FD ISO only) SAER: Stuff count error and ACK error (CAN-FD ISO only) SCAE: Stuff count error and CRC error and ACK error (CAN-FD ISO only) SCFE: Stuff count error and CRC error and FORM error (CAN-FD ISO only)
"""
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}:CAN:FRAMe{busFrameNull_cmd_val}:STATus?')
return Conversions.str_to_scalar_enum(response, enums.BusCanFrameState)