from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class FmCls:
"""Fm commands group definition. 167 total commands, 8 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("fm", core, parent)
@property
def apLayer(self):
"""apLayer commands group. 1 Sub-classes, 2 commands."""
if not hasattr(self, '_apLayer'):
from .ApLayer import ApLayerCls
self._apLayer = ApLayerCls(self._core, self._cmd_group)
return self._apLayer
@property
def audGen(self):
"""audGen commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_audGen'):
from .AudGen import AudGenCls
self._audGen = AudGenCls(self._core, self._cmd_group)
return self._audGen
@property
def audio(self):
"""audio commands group. 0 Sub-classes, 7 commands."""
if not hasattr(self, '_audio'):
from .Audio import AudioCls
self._audio = AudioCls(self._core, self._cmd_group)
return self._audio
@property
def darc(self):
"""darc commands group. 1 Sub-classes, 3 commands."""
if not hasattr(self, '_darc'):
from .Darc import DarcCls
self._darc = DarcCls(self._core, self._cmd_group)
return self._darc
@property
def pilot(self):
"""pilot commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_pilot'):
from .Pilot import PilotCls
self._pilot = PilotCls(self._core, self._cmd_group)
return self._pilot
@property
def rds(self):
"""rds commands group. 7 Sub-classes, 11 commands."""
if not hasattr(self, '_rds'):
from .Rds import RdsCls
self._rds = RdsCls(self._core, self._cmd_group)
return self._rds
@property
def setting(self):
"""setting commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_setting'):
from .Setting import SettingCls
self._setting = SettingCls(self._core, self._cmd_group)
return self._setting
@property
def special(self):
"""special commands group. 3 Sub-classes, 0 commands."""
if not hasattr(self, '_special'):
from .Special import SpecialCls
self._special = SpecialCls(self._core, self._cmd_group)
return self._special
# noinspection PyTypeChecker
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.AudioBcFmModulationMode:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:MODE \n
Snippet: value: enums.AudioBcFmModulationMode = driver.source.bb.radio.fm.get_mode() \n
Sets the mode. \n
:return: mode: MONO| STEReo MONO Feeds a mono signal to the modulator with band limitation 15 kHz. STEReo Feeds a stereo signal to the modulator.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:RADio:FM:MODE?')
return Conversions.str_to_scalar_enum(response, enums.AudioBcFmModulationMode)
[docs]
def set_mode(self, mode: enums.AudioBcFmModulationMode) -> None:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:MODE \n
Snippet: driver.source.bb.radio.fm.set_mode(mode = enums.AudioBcFmModulationMode.MONO) \n
Sets the mode. \n
:param mode: MONO| STEReo MONO Feeds a mono signal to the modulator with band limitation 15 kHz. STEReo Feeds a stereo signal to the modulator.
"""
param = Conversions.enum_scalar_to_str(mode, enums.AudioBcFmModulationMode)
self._core.io.write(f'SOURce<HwInstance>:BB:RADio:FM:MODE {param}')
[docs]
def preset(self) -> None:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:PRESet \n
Snippet: driver.source.bb.radio.fm.preset() \n
Sets the parameters of the digital standard to their default values (*RST values specified for the commands) .
Not affected is the state set with the command SOURce<hw>:BB:AM|FM|FM:RDS:STATe. \n
"""
self._core.io.write(f'SOURce<HwInstance>:BB:RADio:FM:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:PRESet \n
Snippet: driver.source.bb.radio.fm.preset_with_opc() \n
Sets the parameters of the digital standard to their default values (*RST values specified for the commands) .
Not affected is the state set with the command SOURce<hw>:BB:AM|FM|FM:RDS:STATe. \n
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmcv.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:RADio:FM:PRESet', opc_timeout_ms)
[docs]
def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:STATe \n
Snippet: value: bool = driver.source.bb.radio.fm.get_state() \n
Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:RADio:FM:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:RADio:FM:STATe \n
Snippet: driver.source.bb.radio.fm.set_state(state = False) \n
Activates the standard and deactivates all the other digital standards and digital modulation modes in the same path. \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:RADio:FM:STATe {param}')
def clone(self) -> 'FmCls':
"""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 = FmCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group