Source code for rsrtx.Implementations.Bus.CanXl.Frame.DlcValue

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DlcValueCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("dlcValue", core, parent)

[docs] def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default) -> int: """ ``BUS<*>:CANXl:FRAMe<*>:DLCValue`` \n Snippet: ``value: int = driver.bus.canXl.frame.dlcValue.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the data length code of the selected frame - the number of data bytes in the 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: dlc_value: 0 to 2047 """ 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}:CANXl:FRAMe{busFrameNull_cmd_val}:DLCValue?') return Conversions.str_to_int(response)