Source code for RsSmcv.Implementations.Source.Bb.J83B.InputPy

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection


[docs]
class InputPyCls:
	"""InputPy commands group definition. 4 total commands, 0 Subgroups, 4 group commands"""

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

	# noinspection PyTypeChecker


[docs]
	def get_format_py(self) -> enums.CodingInputFormat:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut:FORMat \n
		Snippet: value: enums.CodingInputFormat = driver.source.bb.j83B.inputPy.get_format_py() \n
		Sets the format of the input signal. \n
			:return: inp_sig_format: ASI| SMPTE
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:J83B:INPut:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.CodingInputFormat)





[docs]
	def set_format_py(self, inp_sig_format: enums.CodingInputFormat) -> None:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut:FORMat \n
		Snippet: driver.source.bb.j83B.inputPy.set_format_py(inp_sig_format = enums.CodingInputFormat.ASI) \n
		Sets the format of the input signal. \n
			:param inp_sig_format: ASI| SMPTE
		"""
		param = Conversions.enum_scalar_to_str(inp_sig_format, enums.CodingInputFormat)
		self._core.io.write(f'SOURce<HwInstance>:BB:J83B:INPut:FORMat {param}')



	# noinspection PyTypeChecker


[docs]
	def get_ts_channel(self) -> enums.NumberA:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut:TSCHannel \n
		Snippet: value: enums.NumberA = driver.source.bb.j83B.inputPy.get_ts_channel() \n
		Selects the IP-based transport stream (TS) channel. You can select 1 out of 4 IP TS channels as input at the 'IP Data'
		interface. To configure a particular channel, see 'IP channel x settings'. \n
			:return: inp_sig_ts_channel: 1| 2| 3| 4
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:J83B:INPut:TSCHannel?')
		return Conversions.str_to_scalar_enum(response, enums.NumberA)





[docs]
	def set_ts_channel(self, inp_sig_ts_channel: enums.NumberA) -> None:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut:TSCHannel \n
		Snippet: driver.source.bb.j83B.inputPy.set_ts_channel(inp_sig_ts_channel = enums.NumberA._1) \n
		Selects the IP-based transport stream (TS) channel. You can select 1 out of 4 IP TS channels as input at the 'IP Data'
		interface. To configure a particular channel, see 'IP channel x settings'. \n
			:param inp_sig_ts_channel: 1| 2| 3| 4
		"""
		param = Conversions.enum_scalar_to_str(inp_sig_ts_channel, enums.NumberA)
		self._core.io.write(f'SOURce<HwInstance>:BB:J83B:INPut:TSCHannel {param}')





[docs]
	def get_data_rate(self) -> float:
		"""SCPI: [SOURce<HW>]:BB:J83B:[INPut]:DATarate \n
		Snippet: value: float = driver.source.bb.j83B.inputPy.get_data_rate() \n
		Queries the measured value of the data rate of one of the following: External transport stream including null packets
		input at 'User 1' connector External transport stream including null packets input at 'IP Data/LAN' connector (TSoverIP)
		The value equals the sum of useful data rate rmeas and the rate of null packets r0: rmeas = rmeas + r0 \n
			:return: inp_sig_datarate: float Range: 0 to 999999999
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:J83B:INPut:DATarate?')
		return Conversions.str_to_float(response)



	# noinspection PyTypeChecker


[docs]
	def get_value(self) -> enums.CodingInputSignalInputA:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut \n
		Snippet: value: enums.CodingInputSignalInputA = driver.source.bb.j83B.inputPy.get_value() \n
		Sets the external input interface. \n
			:return: inp_sig_input: TS| IP TS Input for serial transport stream data. The signal is input at the 'User 1/2' connectors. IP Supported for high priority path (HP) only, i.e. setting requires non-hierarchical coding. Input for IP transport stream data. The signal is input at the 'IP Data' connector.
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:BB:J83B:INPut?')
		return Conversions.str_to_scalar_enum(response, enums.CodingInputSignalInputA)





[docs]
	def set_value(self, inp_sig_input: enums.CodingInputSignalInputA) -> None:
		"""SCPI: [SOURce<HW>]:BB:J83B:INPut \n
		Snippet: driver.source.bb.j83B.inputPy.set_value(inp_sig_input = enums.CodingInputSignalInputA.ASI1) \n
		Sets the external input interface. \n
			:param inp_sig_input: TS| IP TS Input for serial transport stream data. The signal is input at the 'User 1/2' connectors. IP Supported for high priority path (HP) only, i.e. setting requires non-hierarchical coding. Input for IP transport stream data. The signal is input at the 'IP Data' connector.
		"""
		param = Conversions.enum_scalar_to_str(inp_sig_input, enums.CodingInputSignalInputA)
		self._core.io.write(f'SOURce<HwInstance>:BB:J83B:INPut {param}')