Source code for rsmxo.Implementations.Sbus.FormatPy

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 FormatPyCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

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



	def set(self, data_format: enums.BitPattern, serialBus=repcap.SerialBus.Default) -> None:
		"""
		``SBUS<*>:FORMat`` \n
		Snippet: ``driver.sbus.formatPy.set(data_format = enums.BitPattern.ASCII, serialBus = repcap.SerialBus.Default)`` \n
		Sets the number format for decoded data values of the indicated serial bus. It defines the format in the decode table,
		and in the combs of the decoded signal on the screen.

		:param data_format: HEX | OCT | BIN | ASCII | ASCii | SIGN | USIG \n
			- HEX: Hexadecimal
			- OCT: Octal
			- BIN: Binary
			- ASCII = ASCii: American standard code for information interchange
			- SIGN: Signed, e.g. 8 bits signed ranges from -128 to +127 decimal
			- USIG: Unsigned, e.g. 8 bits unsigned ranges from 0 to 255 decimal

		:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
		"""
		param = Conversions.enum_scalar_to_str(data_format, enums.BitPattern)
		serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
		self._core.io.write(f'SBUS{serialBus_cmd_val}:FORMat {param}')


	# noinspection PyTypeChecker


	def get(self, serialBus=repcap.SerialBus.Default) -> enums.BitPattern:
		"""
		``SBUS<*>:FORMat`` \n
		Snippet: ``value: enums.BitPattern = driver.sbus.formatPy.get(serialBus = repcap.SerialBus.Default)`` \n
		Sets the number format for decoded data values of the indicated serial bus. It defines the format in the decode table,
		and in the combs of the decoded signal on the screen.

		:param serialBus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Sbus')
		:return: data_format: HEX | OCT | BIN | ASCII | ASCii | SIGN | USIG \n
			- HEX: Hexadecimal
			- OCT: Octal
			- BIN: Binary
			- ASCII = ASCii: American standard code for information interchange
			- SIGN: Signed, e.g. 8 bits signed ranges from -128 to +127 decimal
			- USIG: Unsigned, e.g. 8 bits unsigned ranges from 0 to 255 decimal

		"""
		serialBus_cmd_val = self._cmd_group.get_repcap_cmd_value(serialBus, repcap.SerialBus)
		response = self._core.io.query_str(f'SBUS{serialBus_cmd_val}:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.BitPattern)