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, bus=repcap.Bus.Default, word=repcap.Word.Default) -> enums.BusEthernetWordState:
"""
``BUS<*>:ETHernet:WORD<*>:STATe`` \n
Snippet: ``value: enums.BusEthernetWordState = driver.bus.ethernet.word.state.get(bus = repcap.Bus.Default, word = repcap.Word.Default)`` \n
Returns the frame state of the selected word in the current acquisition.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param word: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Word')
:return: state: OK | ERR_PREAMBLE | ERR_LENGTH | UNCorrelated | INComplete \n
- OK: No error detected
- ERR_PREAMBLE: Error in the preamble of the selected word
- ERR_SFD: Error in the start frame delimiter (SFD) . The value of a correct SFD byte is 171. The SFD is transmitted LSB first.
- ERR_LENGTH: Error in the number of bits in the selected word
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
word_cmd_val = self._cmd_group.get_repcap_cmd_value(word, repcap.Word)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:ETHernet:WORD{word_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.BusEthernetWordState)