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, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> enums.CanXlFrameState:
"""
``BUS<*>:CANXl:FRAMe<*>:FLD<*>:STATe`` \n
Snippet: ``value: enums.CanXlFrameState = driver.bus.canXl.frame.fld.state.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Returns the state of the specified field in the specified frame.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
:return: state: OK | EOFD | ACKD | NOACk | CRCD | CRC | SERRror | FORM | BTST | UNKNown | INComplete \n
- OK: The field has no error, it is valid.
- EOFD: Wrong end of field
- ACKD: Acknowledgment delimiter error
- NOACk: Field acknowledgment is missing
- CRCD: Checksum delimiter error
- CRC: Checksum error, cyclic redundancy check failed
- SERRror: Stuff count error (CAN-FD ISO only)
- FORM: Fixed-bit form error
- BTST: Bit stuffing error
- UNKNown: State unknown
- INComplete: Field not completely contained in the acquisition.
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:CANXl:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.CanXlFrameState)