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, busUsbPacket=repcap.BusUsbPacket.Default) -> enums.BusPcieResultState:
"""
``BUS<*>:PCIE:RESult:PACKet<*>:STATe`` \n
Snippet: ``value: enums.BusPcieResultState = driver.bus.pcie.result.packet.state.get(bus = repcap.Bus.Default, busUsbPacket = repcap.BusUsbPacket.Default)`` \n
Returns the state of the specified packet.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param busUsbPacket: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Packet')
:return: state: OK | MALF | CRC16 | ECRC | LCRC | LEN | POE | MEE | UNCorrelated | FCRC | FPERror | UNKNown | OUTRange | INComplete | SYNCerror \n
- MALF: Mal formated packet
- CRC16: CRC16 error
- ECRC: ECRC error
- LCRC: LCRC error
- LEN: Length error
- POE: TLP prefix error
- MEE: Max end-end TLP prefix error
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
busUsbPacket_cmd_val = self._cmd_group.get_repcap_cmd_value(busUsbPacket, repcap.BusUsbPacket)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:PCIE:RESult:PACKet{busUsbPacket_cmd_val}:STATe?')
return Conversions.str_to_scalar_enum(response, enums.BusPcieResultState)