Source code for RsSmw.Implementations.Source.Bb.LrWpan.Oqpsk

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class OqpskCls:
	"""
	| Commands in total: 67
	| Subgroups: 6
	| Direct child commands: 7
	"""

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

	@property
	def dr(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_dr'):
			from .Dr import DrCls
			self._dr = DrCls(self._core, self._cmd_group)
		return self._dr

	@property
	def fconfig(self):
		"""
		| Commands in total: 23
		| Subgroups: 4
		| Direct child commands: 17
		"""
		if not hasattr(self, '_fconfig'):
			from .Fconfig import FconfigCls
			self._fconfig = FconfigCls(self._core, self._cmd_group)
		return self._fconfig

	@property
	def macHeader(self):
		"""
		| Commands in total: 31
		| Subgroups: 0
		| Direct child commands: 31
		"""
		if not hasattr(self, '_macHeader'):
			from .MacHeader import MacHeaderCls
			self._macHeader = MacHeaderCls(self._core, self._cmd_group)
		return self._macHeader

	@property
	def phr(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_phr'):
			from .Phr import PhrCls
			self._phr = PhrCls(self._core, self._cmd_group)
		return self._phr

	@property
	def setting(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_setting'):
			from .Setting import SettingCls
			self._setting = SettingCls(self._core, self._cmd_group)
		return self._setting

	@property
	def sfd(self):
		"""
		| Commands in total: 2
		| Subgroups: 0
		| Direct child commands: 2
		"""
		if not hasattr(self, '_sfd'):
			from .Sfd import SfdCls
			self._sfd = SfdCls(self._core, self._cmd_group)
		return self._sfd

	# noinspection PyTypeChecker
[docs] def get_cindex(self) -> enums.HrpUwbCfgIndex: """ ``[SOURce<HW>]:BB:LRWPan:OQPSk:CINDex`` \n Snippet: ``value: enums.HrpUwbCfgIndex = driver.source.bb.lrWpan.oqpsk.get_cindex()`` \n Requires [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk:OBANd OB5800 | OB6200. Sets the configuration index, which determines for example the SYNC length and SFD length for symbol-to-chip mapping in the selected operating band. :return: config_index: CI1 | CI2 | CI3 | CI4 | CI5 | CI6 | CI7 | CI8 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:CINDex?') return Conversions.str_to_scalar_enum(response, enums.HrpUwbCfgIndex)
[docs] def set_cindex(self, config_index: enums.HrpUwbCfgIndex) -> None: """ ``[SOURce<HW>]:BB:LRWPan:OQPSk:CINDex`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_cindex(config_index = enums.HrpUwbCfgIndex.CI1)`` \n Requires [:SOURce<hw>]:BB[:LRWPan]:HUWB | OQPSk:OBANd OB5800 | OB6200. Sets the configuration index, which determines for example the SYNC length and SFD length for symbol-to-chip mapping in the selected operating band. :param config_index: CI1 | CI2 | CI3 | CI4 | CI5 | CI6 | CI7 | CI8 """ param = Conversions.enum_scalar_to_str(config_index, enums.HrpUwbCfgIndex) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:CINDex {param}')
[docs] def get_bandwidth(self) -> float: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:BWIDth`` \n Snippet: ``value: float = driver.source.bb.lrWpan.oqpsk.get_bandwidth()`` \n Queries the channel bandwidth. The bandwidth depends on the channel number. """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:BWIDth?') return Conversions.str_to_float(response)
# noinspection PyTypeChecker
[docs] def get_cccl(self) -> enums.HrpUwbConvConsLen: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:CCCL`` \n Snippet: ``value: enums.HrpUwbConvConsLen = driver.source.bb.lrWpan.oqpsk.get_cccl()`` \n Sets the constraint length of the convolutional code. :return: cccl: CL3 | CL7 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:CCCL?') return Conversions.str_to_scalar_enum(response, enums.HrpUwbConvConsLen)
[docs] def set_cccl(self, cccl: enums.HrpUwbConvConsLen) -> None: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:CCCL`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_cccl(cccl = enums.HrpUwbConvConsLen.CL3)`` \n Sets the constraint length of the convolutional code. :param cccl: CL3 | CL7 """ param = Conversions.enum_scalar_to_str(cccl, enums.HrpUwbConvConsLen) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:CCCL {param}')
[docs] def get_cnumber(self) -> int: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:CNUMber`` \n Snippet: ``value: int = driver.source.bb.lrWpan.oqpsk.get_cnumber()`` \n Sets the channel number that is a 4-bit value in decimal representation. The channel number determines the bandwidth and the code index. :return: channel_number: integer Range: 0 to 15 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:CNUMber?') return Conversions.str_to_int(response)
[docs] def set_cnumber(self, channel_number: int) -> None: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:CNUMber`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_cnumber(channel_number = 1)`` \n Sets the channel number that is a 4-bit value in decimal representation. The channel number determines the bandwidth and the code index. :param channel_number: integer Range: 0 to 15 """ param = Conversions.decimal_value_to_str(channel_number) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:CNUMber {param}')
[docs] def get_f_2_ms(self) -> bool: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:F2MS`` \n Snippet: ``value: bool = driver.source.bb.lrWpan.oqpsk.get_f_2_ms()`` \n Sets the frame length of a generated waveform shorter than 2 ms to a fixed value of 2 ms. If activated, the idle interval is set to 0.0 us by default. Generated waveforms longer than 2 ms remain unaffected. :return: fixed_2_ms_frame: 1 | ON | 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:F2MS?') return Conversions.str_to_bool(response)
[docs] def set_f_2_ms(self, fixed_2_ms_frame: bool) -> None: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:F2MS`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_f_2_ms(fixed_2_ms_frame = False)`` \n Sets the frame length of a generated waveform shorter than 2 ms to a fixed value of 2 ms. If activated, the idle interval is set to 0.0 us by default. Generated waveforms longer than 2 ms remain unaffected. :param fixed_2_ms_frame: 1 | ON | 0| OFF """ param = Conversions.bool_to_str(fixed_2_ms_frame) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:F2MS {param}')
[docs] def get_iinterval(self) -> float: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:IINTerval`` \n Snippet: ``value: float = driver.source.bb.lrWpan.oqpsk.get_iinterval()`` \n Sets the time of the interval separating two frames. :return: iinterval: float Range: 0 to 1000000, Unit: us """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:IINTerval?') return Conversions.str_to_float(response)
[docs] def set_iinterval(self, iinterval: float) -> None: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:IINTerval`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_iinterval(iinterval = 1.0)`` \n Sets the time of the interval separating two frames. :param iinterval: float Range: 0 to 1000000, Unit: us """ param = Conversions.decimal_value_to_str(iinterval) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:IINTerval {param}')
# noinspection PyTypeChecker
[docs] def get_oband(self) -> enums.ZigbeeOperatingBand: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:OBANd`` \n Snippet: ``value: enums.ZigbeeOperatingBand = driver.source.bb.lrWpan.oqpsk.get_oband()`` \n Requires R&S SMW-K180. Sets the operating band for 802.15.4 with O-QPSK modulation. :return: oper_band: OB780 | OB868 | OB915 | OB2380 | OB2450 | OB5800 | OB6200 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:LRWPan:OQPSk:OBANd?') return Conversions.str_to_scalar_enum(response, enums.ZigbeeOperatingBand)
[docs] def set_oband(self, oper_band: enums.ZigbeeOperatingBand) -> None: """ ``[SOURce<HW>]:BB:[LRWPan]:OQPSk:OBANd`` \n Snippet: ``driver.source.bb.lrWpan.oqpsk.set_oband(oper_band = enums.ZigbeeOperatingBand.OB2380)`` \n Requires R&S SMW-K180. Sets the operating band for 802.15.4 with O-QPSK modulation. :param oper_band: OB780 | OB868 | OB915 | OB2380 | OB2450 | OB5800 | OB6200 """ param = Conversions.enum_scalar_to_str(oper_band, enums.ZigbeeOperatingBand) self._core.io.write(f'SOURce<HwInstance>:BB:LRWPan:OQPSk:OBANd {param}')
def clone(self) -> 'OqpskCls': """ Clones the group by creating new object from it and its whole existing subgroups. Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group. """ new_group = OqpskCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group