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 StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, search: str, word=repcap.Word.Default) -> enums.BusMdioWordState:
"""
``SEARch:RESult:MDIO:WORD<*>:STATe`` \n
Snippet: ``value: enums.BusMdioWordState = driver.search.result.mdio.word.state.get(search = 'abc', word = repcap.Word.Default)`` \n
Returns the state of the frame from the selected word within the search result.
:param word: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Word')
:return: state: OK | UNSYN | UNSYncronized | OPCO | TA_ERROR | INComplete | SHORT | SHORt \n
- OK: No error detected
- UNSYN = UNSYncronized: UNSYncronized happens when bits are found, but they are not correlated with any synchronization sequence. We don't know what these bits are, but they are there. These bits receive a flag, but they are not decoded.
- OPCO: OPcode error
- TA_ERROR: turnaround time error
- INComplete: Incomplete Frame
- SHORT = SHORt: Length Error
"""
param = Conversions.value_to_quoted_str(search)
word_cmd_val = self._cmd_group.get_repcap_cmd_value(word, repcap.Word)
response = self._core.io.query_str(f'SEARch:RESult:MDIO:WORD{word_cmd_val}:STATe? {param}')
return Conversions.str_to_scalar_enum(response, enums.BusMdioWordState)