from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Utilities import trim_str_response
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class WlnnCls:
"""Wlnn commands group definition. 319 total commands, 9 Subgroups, 8 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("wlnn", core, parent)
@property
def antenna(self):
"""antenna commands group. 1 Sub-classes, 2 commands."""
if not hasattr(self, '_antenna'):
from .Antenna import AntennaCls
self._antenna = AntennaCls(self._core, self._cmd_group)
return self._antenna
@property
def clipping(self):
"""clipping commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_clipping'):
from .Clipping import ClippingCls
self._clipping = ClippingCls(self._core, self._cmd_group)
return self._clipping
@property
def clock(self):
"""clock commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_clock'):
from .Clock import ClockCls
self._clock = ClockCls(self._core, self._cmd_group)
return self._clock
@property
def fblock(self):
"""fblock commands group. 68 Sub-classes, 2 commands."""
if not hasattr(self, '_fblock'):
from .Fblock import FblockCls
self._fblock = FblockCls(self._core, self._cmd_group)
return self._fblock
@property
def filterPy(self):
"""filterPy commands group. 4 Sub-classes, 2 commands."""
if not hasattr(self, '_filterPy'):
from .FilterPy import FilterPyCls
self._filterPy = FilterPyCls(self._core, self._cmd_group)
return self._filterPy
@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 symbolRate(self):
"""symbolRate commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_symbolRate'):
from .SymbolRate import SymbolRateCls
self._symbolRate = SymbolRateCls(self._core, self._cmd_group)
return self._symbolRate
@property
def trigger(self):
"""trigger commands group. 5 Sub-classes, 5 commands."""
if not hasattr(self, '_trigger'):
from .Trigger import TriggerCls
self._trigger = TriggerCls(self._core, self._cmd_group)
return self._trigger
@property
def waveform(self):
"""waveform commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_waveform'):
from .Waveform import WaveformCls
self._waveform = WaveformCls(self._core, self._cmd_group)
return self._waveform
# noinspection PyTypeChecker
[docs] def get_bandwidth(self) -> enums.WlannTxBw:
"""SCPI: [SOURce<HW>]:BB:WLNN:BWidth \n
Snippet: value: enums.WlannTxBw = driver.source.bb.wlnn.get_bandwidth() \n
The command selects the transmission bandwidth. Whenever the bandwidth changes from a higher to a lower one, the frame
blocks are validated because some of them could be invalid in the lower bandwidth (invalid TX Mode) . \n
:return: bwidth: BW20| BW40| BW80| BW160| BW320 Unit: MHz
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:BWidth?')
return Conversions.str_to_scalar_enum(response, enums.WlannTxBw)
[docs] def set_bandwidth(self, bwidth: enums.WlannTxBw) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:BWidth \n
Snippet: driver.source.bb.wlnn.set_bandwidth(bwidth = enums.WlannTxBw.BW160) \n
The command selects the transmission bandwidth. Whenever the bandwidth changes from a higher to a lower one, the frame
blocks are validated because some of them could be invalid in the lower bandwidth (invalid TX Mode) . \n
:param bwidth: BW20| BW40| BW80| BW160| BW320 Unit: MHz
"""
param = Conversions.enum_scalar_to_str(bwidth, enums.WlannTxBw)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:BWidth {param}')
[docs] def set_cf_block(self, cf_block: int) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:CFBLock \n
Snippet: driver.source.bb.wlnn.set_cf_block(cf_block = 1) \n
Copies the selected frame block. \n
:param cf_block: integer Range: 1 to 100
"""
param = Conversions.decimal_value_to_str(cf_block)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:CFBLock {param}')
[docs] def set_df_block(self, df_block: int) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:DFBLock \n
Snippet: driver.source.bb.wlnn.set_df_block(df_block = 1) \n
Deletes the selected frame block. \n
:param df_block: integer Range: 1 to 100
"""
param = Conversions.decimal_value_to_str(df_block)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:DFBLock {param}')
[docs] def set_if_block(self, if_block: int) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:IFBLock \n
Snippet: driver.source.bb.wlnn.set_if_block(if_block = 1) \n
The command adds a default frame block before the selected frame block. \n
:param if_block: No help available
"""
param = Conversions.decimal_value_to_str(if_block)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:IFBLock {param}')
[docs] def set_pf_block(self, pf_block: int) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:PFBLock \n
Snippet: driver.source.bb.wlnn.set_pf_block(pf_block = 1) \n
Pastes the selected frame block. \n
:param pf_block: integer Range: 1 to 99
"""
param = Conversions.decimal_value_to_str(pf_block)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:PFBLock {param}')
[docs] def preset(self) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:PRESet \n
Snippet: driver.source.bb.wlnn.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:WLNN:STATe. \n
"""
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:PRESet')
[docs] def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:PRESet \n
Snippet: driver.source.bb.wlnn.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:WLNN:STATe. \n
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmbv.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:WLNN:PRESet', opc_timeout_ms)
[docs] def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:WLNN:STATe \n
Snippet: value: bool = driver.source.bb.wlnn.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:WLNN:STATe?')
return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:WLNN:STATe \n
Snippet: driver.source.bb.wlnn.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:WLNN:STATe {param}')
[docs] def get_version(self) -> str:
"""SCPI: [SOURce<HW>]:BB:WLNN:VERSion \n
Snippet: value: str = driver.source.bb.wlnn.get_version() \n
Queries the version of the IEEE 802.11 WLAN standard underlying the definitions. \n
:return: version: string
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:VERSion?')
return trim_str_response(response)
def clone(self) -> 'WlnnCls':
"""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 = WlnnCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group