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, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default) -> enums.SbusUsbFrameState:
"""
``SBUS<*>:USBone:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.SbusUsbFrameState = driver.sbus.usbOne.frame.status.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default)`` \n
Returns the overall state of the frame.
:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
:param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame')
:return: frame_state: OK | PID | CRC | LENGth | BTST | INComplete \n
- OK: The frame is valid.
- PID: A packet identifier error signifies that the integrity check has failed, see 'Packet structure' PID in 'USB protocol basics'. The 8-bit PID is invalid, if its 4 least significant bits (LSB) are not the complement of its 4 most significant bits (MSB) .
- CRC: Cyclic redundancy check failed.
- LENGth: Wrong length of frame.
- BTST: Bit stuffing error occurred.
- INComplete: The frame is not completely contained in the acquisition. The acquired part of the frame is usually valid, but cannot always be trusted.
"""
serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame)
response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:USBone:FRAMe{frame_cmd_val}:STATus?')
return Conversions.str_to_scalar_enum(response, enums.SbusUsbFrameState)