Source code for rsrtx.Implementations.Bus.Spi.Frame.Word.Mosi

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


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

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

[docs] def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, word=repcap.Word.Default) -> int: """ ``BUS<*>:SPI:FRAMe<*>:WORD<*>:MOSI`` \n Snippet: ``value: int = driver.bus.spi.frame.word.mosi.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, word = repcap.Word.Default)`` \n Returns the data value of the specified word on the MOSI line. :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 word: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Word') :return: mosi_value: To set the value format, use method ``RsRtx.formatPy.bpattern()``. The values below – range, increment and reset – are decimal values. """ 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) word_cmd_val = self._cmd_group.get_repcap_cmd_value(word, repcap.Word) response = self._core.io.query_str(f'BUS{bus_cmd_val}:SPI:FRAMe{busFrameNull_cmd_val}:WORD{word_cmd_val}:MOSI?') return Conversions.str_to_int(response)