Source code for RsCmwBluetoothSig.Implementations.RxQuality_.Search_.Ber_.Bedr

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal.StructBase import StructBase
from .....Internal.ArgStruct import ArgStruct


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class Bedr: """Bedr commands group definition. 6 total commands, 0 Sub-groups, 6 group commands""" def __init__(self, core: Core, parent): self._core = core self._base = CommandsGroup("bedr", core, parent)
[docs] def initiate(self) -> None: """SCPI: INITiate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.initiate() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n """ self._core.io.write(f'INITiate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
[docs] def initiate_with_opc(self) -> None: """SCPI: INITiate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.initiate_with_opc() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n Same as initiate, but waits for the operation to complete before continuing further. Use the RsCmwBluetoothSig.utilities.opc_timeout_set() to set the timeout value. \n """ self._core.io.write_with_opc(f'INITiate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
[docs] def abort(self) -> None: """SCPI: ABORt:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.abort() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n """ self._core.io.write(f'ABORt:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
[docs] def abort_with_opc(self) -> None: """SCPI: ABORt:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.abort_with_opc() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n Same as abort, but waits for the operation to complete before continuing further. Use the RsCmwBluetoothSig.utilities.opc_timeout_set() to set the timeout value. \n """ self._core.io.write_with_opc(f'ABORt:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
[docs] def stop(self) -> None: """SCPI: STOP:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.stop() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n """ self._core.io.write(f'STOP:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
[docs] def stop_with_opc(self) -> None: """SCPI: STOP:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: driver.rxQuality.search.ber.bedr.stop_with_opc() \n INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n - INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state. - STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement. - ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released. Use FETCh...STATe? to query the current measurement state. \n Same as stop, but waits for the operation to complete before continuing further. Use the RsCmwBluetoothSig.utilities.opc_timeout_set() to set the timeout value. \n """ self._core.io.write_with_opc(f'STOP:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR')
# noinspection PyTypeChecker
[docs] class ResultData(StructBase): """Response structure. Fields: \n - Ber: float: float Bit error rate Range: 0 % to 100 %, Unit: % - Per: float: float Packet error rate Unit: % - Bit_Errors: int: decimal Sum of received erroneous data bits Range: 0 to 18.4467440737096E+18 - Missing_Packets: float: float Difference between the number of packets sent and the number of packets received in percentage Unit: % - Nak: float: float Percentage of packets not acknowledged by the EUT positively Unit: % - Hec_Errors: float: float Percentage of packets with the bit errors in the header Unit: % - Crc_Errors: float: float Percentage of packets with the bit errors in the payload Unit: % - Wrong_Packet_Rate: float: No parameter help available - Wrong_Payload_Rat: float: No parameter help available - Packets_Received: int: No parameter help available - Search_Result: float: float TX level of the R&S CMW resulting in the configured BER search limit Range: -100 dBm to 0 dBm""" __meta_args_list = [ ArgStruct.scalar_float('Ber'), ArgStruct.scalar_float('Per'), ArgStruct.scalar_int('Bit_Errors'), ArgStruct.scalar_float('Missing_Packets'), ArgStruct.scalar_float('Nak'), ArgStruct.scalar_float('Hec_Errors'), ArgStruct.scalar_float('Crc_Errors'), ArgStruct.scalar_float('Wrong_Packet_Rate'), ArgStruct.scalar_float('Wrong_Payload_Rat'), ArgStruct.scalar_int('Packets_Received'), ArgStruct.scalar_float('Search_Result')] def __init__(self): StructBase.__init__(self, self) self.Ber: float = None self.Per: float = None self.Bit_Errors: int = None self.Missing_Packets: float = None self.Nak: float = None self.Hec_Errors: float = None self.Crc_Errors: float = None self.Wrong_Packet_Rate: float = None self.Wrong_Payload_Rat: float = None self.Packets_Received: int = None self.Search_Result: float = None
[docs] def read(self) -> ResultData: """SCPI: READ:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: value: ResultData = driver.rxQuality.search.ber.bedr.read() \n Return all results of the BR/EDR BER search measurement. The values described below are returned by FETCh and READ commands. CALCulate commands return limit check results instead, one value for each result listed below. \n Use RsCmwBluetoothSig.reliability.last_value to read the updated reliability indicator. \n :return: structure: for return value, see the help for ResultData structure arguments.""" return self._core.io.query_struct(f'READ:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR?', self.__class__.ResultData())
[docs] def fetch(self) -> ResultData: """SCPI: FETCh:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: value: ResultData = driver.rxQuality.search.ber.bedr.fetch() \n Return all results of the BR/EDR BER search measurement. The values described below are returned by FETCh and READ commands. CALCulate commands return limit check results instead, one value for each result listed below. \n Use RsCmwBluetoothSig.reliability.last_value to read the updated reliability indicator. \n :return: structure: for return value, see the help for ResultData structure arguments.""" return self._core.io.query_struct(f'FETCh:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR?', self.__class__.ResultData())
# noinspection PyTypeChecker
[docs] class CalculateStruct(StructBase): """Response structure. Fields: \n - Ber: float: float Bit error rate Range: 0 % to 100 %, Unit: % - Per: float: float Packet error rate Unit: % - Bit_Errors: float: decimal Sum of received erroneous data bits Range: 0 to 18.4467440737096E+18 - Missing_Packets: float: float Difference between the number of packets sent and the number of packets received in percentage Unit: % - Nak: float: float Percentage of packets not acknowledged by the EUT positively Unit: % - Hec_Errors: float: float Percentage of packets with the bit errors in the header Unit: % - Crc_Errors: float: float Percentage of packets with the bit errors in the payload Unit: % - Wrong_Packet_Rate: float: No parameter help available - Wrong_Payload_Rat: float: No parameter help available - Packets_Received: float: No parameter help available - Search_Result: float: float TX level of the R&S CMW resulting in the configured BER search limit Range: -100 dBm to 0 dBm""" __meta_args_list = [ ArgStruct.scalar_float('Ber'), ArgStruct.scalar_float('Per'), ArgStruct.scalar_float('Bit_Errors'), ArgStruct.scalar_float('Missing_Packets'), ArgStruct.scalar_float('Nak'), ArgStruct.scalar_float('Hec_Errors'), ArgStruct.scalar_float('Crc_Errors'), ArgStruct.scalar_float('Wrong_Packet_Rate'), ArgStruct.scalar_float('Wrong_Payload_Rat'), ArgStruct.scalar_float('Packets_Received'), ArgStruct.scalar_float('Search_Result')] def __init__(self): StructBase.__init__(self, self) self.Ber: float = None self.Per: float = None self.Bit_Errors: float = None self.Missing_Packets: float = None self.Nak: float = None self.Hec_Errors: float = None self.Crc_Errors: float = None self.Wrong_Packet_Rate: float = None self.Wrong_Payload_Rat: float = None self.Packets_Received: float = None self.Search_Result: float = None
[docs] def calculate(self) -> CalculateStruct: """SCPI: CALCulate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER[:BEDR] \n Snippet: value: CalculateStruct = driver.rxQuality.search.ber.bedr.calculate() \n Return all results of the BR/EDR BER search measurement. The values described below are returned by FETCh and READ commands. CALCulate commands return limit check results instead, one value for each result listed below. \n Use RsCmwBluetoothSig.reliability.last_value to read the updated reliability indicator. \n :return: structure: for return value, see the help for CalculateStruct structure arguments.""" return self._core.io.query_struct(f'CALCulate:BLUetooth:SIGNaling<Instance>:RXQuality:SEARch:BER:BEDR?', self.__class__.CalculateStruct())