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, search: str, busFrameNull=repcap.BusFrameNull.Default) -> enums.I3cFrameState:
"""
``SEARch:RESult:I3C:FRAMe<*>:STATus`` \n
Snippet: ``value: enums.I3cFrameState = driver.search.result.i3C.frame.status.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default)`` \n
Returns the overall state of the frame.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:return: state: OK | ACK | PAR | CRC | LENGth | UNKNown | INComplete \n
- OK: The frame is valid.
- ACK: Wrong acknowledgment (ACK) delimiter occurred.
- PAR: Wrong parity detected.
- CRC: Cyclic redundancy check failed.
- LENGth: Wrong length of frame.
- 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.
"""
param = Conversions.value_to_quoted_str(search)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
response = self._core.io.query_str(f'SEARch:RESult:I3C:FRAMe{busFrameNull_cmd_val}:STATus? {param}')
return Conversions.str_to_scalar_enum(response, enums.I3cFrameState)