Source code for rsmxo.Implementations.Sbus.Manch.FormatPy.Frame.Fld.Enum.Label

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


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

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

[docs] def set(self, label: str, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default, field=repcap.Field.Default, valueIndex=repcap.ValueIndex.Default) -> None: """ ``SBUS<*>:MANCh:FORMat:FRAMe<*>:FLD<*>:ENUM<*>:LABel`` \n Snippet: ``driver.sbus.manch.formatPy.frame.fld.enum.label.set(label = 'abc', serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default, field = repcap.Field.Default, valueIndex = repcap.ValueIndex.Default)`` \n Sets the label to convert the corresponding hexagonal value to a labeled state. Available if method ``RsMxo.sbus.manch.formatPy.frame.fld.formatPy.set()`` = LIST. :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus') :param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame') :param field: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Fld') :param valueIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Enum') """ param = Conversions.value_to_quoted_str(label) serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus) frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame) field_cmd_val = self._cmd_group.get_repcap_cmd_value(field, repcap.Field) valueIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(valueIndex, repcap.ValueIndex) self._core.io.write(f'SBUS{serialBus_cmd_val}:MANCh:FORMat:FRAMe{frame_cmd_val}:FLD{field_cmd_val}:ENUM{valueIndex_cmd_val}:LABel {param}')
[docs] def get(self, serialBus=repcap.SerialBus.Default, frame=repcap.Frame.Default, field=repcap.Field.Default, valueIndex=repcap.ValueIndex.Default) -> str: """ ``SBUS<*>:MANCh:FORMat:FRAMe<*>:FLD<*>:ENUM<*>:LABel`` \n Snippet: ``value: str = driver.sbus.manch.formatPy.frame.fld.enum.label.get(serialBus = repcap.SerialBus.Default, frame = repcap.Frame.Default, field = repcap.Field.Default, valueIndex = repcap.ValueIndex.Default)`` \n Sets the label to convert the corresponding hexagonal value to a labeled state. Available if method ``RsMxo.sbus.manch.formatPy.frame.fld.formatPy.set()`` = LIST. :param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus') :param frame: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Frame') :param field: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Fld') :param valueIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Enum') """ serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus) frame_cmd_val = self._cmd_group.get_repcap_cmd_value(frame, repcap.Frame) field_cmd_val = self._cmd_group.get_repcap_cmd_value(field, repcap.Field) valueIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(valueIndex, repcap.ValueIndex) response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:MANCh:FORMat:FRAMe{frame_cmd_val}:FLD{field_cmd_val}:ENUM{valueIndex_cmd_val}:LABel?') return trim_str_response(response)