Source code for rsrtx.Implementations.Bus.Lin.Frame.Status

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, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> enums.BusLinFrameState: """ ``BUS<*>:LIN:FRAMe<*>:STATus`` \n Snippet: ``value: enums.BusLinFrameState = driver.bus.lin.frame.status.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the overall state of the selected 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') :return: state: UART: at least one UART error occured. LIN uses UART words without parity bit. CHCKsum: checksum error VERS: the version of the LIN standard is not valid LENer: unexpected length SPERror: stop error PRERror: parity error in identifier SYERror: synchronization error WAKeup: the frame is a wakeup frame CPERror: parity error and checksum error INSufficient: the frame is not completely contained in the acquisition. The decoded part of the frame is valid. INComplete: the frame is missing some parts """ 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) response = self._core.io.query_str(f'BUS{bus_cmd_val}:LIN:FRAMe{busFrameNull_cmd_val}:STATus?') return Conversions.str_to_scalar_enum(response, enums.BusLinFrameState)