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.SbusI2cFrameState:
"""
``SBUS<*>:I2C:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.SbusI2cFrameState = driver.sbus.i2C.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 | ADDifferent | NOSTop | UNKNown | INComplete \n
- OK: The frame is valid.
- ADDifferent: 10-bit read address different. For a read access on a 10-bit address, the first address byte is sent twice, first as write, the second as read. The first 7 bits of the byte must be identical. If they are not identical, the ADDiffernt error is indicated.
- NOSTop: The stop bit is missing.
- UNKNown: Unknown frame type detected.
- 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}:I2C:FRAMe{frame_cmd_val}:STATus?')
return Conversions.str_to_scalar_enum(response, enums.SbusI2cFrameState)