Average

SCPI Commands :

READ:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
FETCh:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
CALCulate:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
class AverageCls[source]

Average commands group definition. 3 total commands, 0 Subgroups, 3 group commands

class CalculateStruct[source]

Response structure. Fields:

  • Reliability: int: decimal ‘Reliability indicator’

  • Out_Of_Tol: enums.ResultStatus2: float Out of tolerance result, i.e. percentage of measurement intervals of the statistic count for modulation measurements exceeding the specified modulation limits. Range: 0 % to 100 %, Unit: %

  • Mcs_Index: enums.ResultStatus2: decimal Modulation and coding scheme index Range: 0 to 76

  • Mod_Type: enums.ResultStatus2: No parameter help available

  • Payload_Sym: enums.ResultStatus2: decimal Number of OFDM symbols in the payload of the measured burst Range: 1 symbol to 1366 symbols, Unit: symbol

  • Measured_Sym: enums.ResultStatus2: decimal Number of measured payload OFDM symbols Range: 1 symbol to 1366 symbols, Unit: symbol

  • Payload_Bytes: enums.ResultStatus2: decimal Number of bytes in the payload of the measured burst. The results are only available for the standards up to Wi-Fi 4 (802.11n) , for Wi-Fi 5 standard (802.11ac) and later, NCAP is returned. Range: 1 byte to 4095 bytes, Unit: byte

  • Guard_Interval: enums.ResultStatus2: SHORt | LONG | GI08 | GI16 | GI32 SHORt, LONG: short or long guard interval (up to 802.11ac) GI08, GI16, GI32: 0.8 μs, 1.6 μs, and 3.2 μs guard interval durations (for 802.11ax)

  • Nof_Ss: enums.ResultStatus2: decimal Number of spatial streams Range: 1 to 8

  • No_Of_Sts: enums.ResultStatus2: decimal Number of space-time streams Range: 1 to 8

  • Burst_Rate: enums.ResultStatus2: float If a modulation filter is used, the burst rate indicates the share of bursts of the selected modulation type in the bursts received. Otherwise, it returns 1. See also [CMDLINKRESOLVED Configure.Isignal#Modfilter CMDLINKRESOLVED]. Unit: %

  • Power_Backoff: enums.ResultStatus2: float Minimum distance of signal power to reference level since the start of the measurement Range: -100 dB to 0 dB, Unit: dB

  • Burst_Power: enums.ResultStatus2: float RMS power of the measured burst Range: -100 dBm to 30 dBm, Unit: dBm

  • Peak_Power: enums.ResultStatus2: float Peak power of the measured burst Range: -100 dBm to 30 dBm, Unit: dBm

  • Crest_Factor: enums.ResultStatus2: float Range: 0 dB to 60 dB, Unit: dB

  • Evm_All_Carr: enums.ResultStatus2: float EVM for all carriers Range: -100 dB to 0 dB, Unit: dB

  • Evm_Data_Carr: enums.ResultStatus2: float EVM for data carriers Range: -100 dB to 0 dB, Unit: dB

  • Evm_Pilot_Carr: enums.ResultStatus2: float EVM for pilot carriers Range: -100 dB to 0 dB, Unit: dB

  • Freq_Error: enums.ResultStatus2: float Center frequency error Range: -150 MHz to 150 MHz, Unit: Hz

  • Clock_Error: enums.ResultStatus2: float Symbol clock error Range: -125 ppm to 125 ppm, Unit: ppm

  • Iq_Offset: enums.ResultStatus2: float Range: -100 dB to 0 dB, Unit: dB

  • Dc_Power: enums.ResultStatus2: float Power of the DC subcarriers Range: -100 dBm to 30 dBm, Unit: dBm

  • Gain_Imbalance: enums.ResultStatus2: float Gain imbalance cannot be calculated if the spectrum is not symmetrical, e.g. for HT_TB and HE_MU. Range: -100 dB to 100 dB, Unit: dB

  • Quad_Error: enums.ResultStatus2: float Quadrature error cannot be calculated if the spectrum is not symmetrical, e.g. for HT_TB and HE_MU. Range: -180 deg to 180 deg, Unit: deg

  • Ltf_Power: enums.ResultStatus2: float Power of long training fields (LTF) portion Unit: dBm

  • Data_Power: enums.ResultStatus2: float Power of data portion Unit: dBm

  • Preamble_Power: enums.ResultStatus2: No parameter help available

class ResultData[source]

Response structure. Fields:

  • Reliability: int: decimal ‘Reliability indicator’

  • Out_Of_Tol: float: float Out of tolerance result, i.e. percentage of measurement intervals of the statistic count for modulation measurements exceeding the specified modulation limits. Range: 0 % to 100 %, Unit: %

  • Mcs_Index: int: decimal Modulation and coding scheme index Range: 0 to 76

  • Mod_Type: enums.ModulationTypeD: No parameter help available

  • Payload_Sym: int: decimal Number of OFDM symbols in the payload of the measured burst Range: 1 symbol to 1366 symbols, Unit: symbol

  • Measured_Sym: int: decimal Number of measured payload OFDM symbols Range: 1 symbol to 1366 symbols, Unit: symbol

  • Payload_Bytes: int: decimal Number of bytes in the payload of the measured burst. The results are only available for the standards up to Wi-Fi 4 (802.11n) , for Wi-Fi 5 standard (802.11ac) and later, NCAP is returned. Range: 1 byte to 4095 bytes, Unit: byte

  • Guard_Interval: enums.GuardInterval: SHORt | LONG | GI08 | GI16 | GI32 SHORt, LONG: short or long guard interval (up to 802.11ac) GI08, GI16, GI32: 0.8 μs, 1.6 μs, and 3.2 μs guard interval durations (for 802.11ax)

  • Nof_Ss: int: decimal Number of spatial streams Range: 1 to 8

  • No_Of_Sts: int: decimal Number of space-time streams Range: 1 to 8

  • Burst_Rate: float: float If a modulation filter is used, the burst rate indicates the share of bursts of the selected modulation type in the bursts received. Otherwise, it returns 1. See also [CMDLINKRESOLVED Configure.Isignal#Modfilter CMDLINKRESOLVED]. Unit: %

  • Power_Backoff: float: float Minimum distance of signal power to reference level since the start of the measurement Range: -100 dB to 0 dB, Unit: dB

  • Burst_Power: float: float RMS power of the measured burst Range: -100 dBm to 30 dBm, Unit: dBm

  • Peak_Power: float: float Peak power of the measured burst Range: -100 dBm to 30 dBm, Unit: dBm

  • Crest_Factor: float: float Range: 0 dB to 60 dB, Unit: dB

  • Evm_All_Carr: float: float EVM for all carriers Range: -100 dB to 0 dB, Unit: dB

  • Evm_Data_Carr: float: float EVM for data carriers Range: -100 dB to 0 dB, Unit: dB

  • Evm_Pilot_Carr: float: float EVM for pilot carriers Range: -100 dB to 0 dB, Unit: dB

  • Freq_Error: float: float Center frequency error Range: -150 MHz to 150 MHz, Unit: Hz

  • Clock_Error: float: float Symbol clock error Range: -125 ppm to 125 ppm, Unit: ppm

  • Iq_Offset: float: float Range: -100 dB to 0 dB, Unit: dB

  • Dc_Power: float: float Power of the DC subcarriers Range: -100 dBm to 30 dBm, Unit: dBm

  • Gain_Imbalance: float: float Gain imbalance cannot be calculated if the spectrum is not symmetrical, e.g. for HT_TB and HE_MU. Range: -100 dB to 100 dB, Unit: dB

  • Quad_Error: float: float Quadrature error cannot be calculated if the spectrum is not symmetrical, e.g. for HT_TB and HE_MU. Range: -180 deg to 180 deg, Unit: deg

  • Ltf_Power: float: float Power of long training fields (LTF) portion Unit: dBm

  • Data_Power: float: float Power of data portion Unit: dBm

  • Preamble_Power: float: No parameter help available

calculate() CalculateStruct[source]
# SCPI: CALCulate:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
value: CalculateStruct = driver.multiEval.modulation.average.calculate()

Return the single value results for OFDM SISO measurements. For MIMO measurements, the stream/antenna-independent values are returned. For 80+80 MHz signals, the segment-independent values are returned. There are current, average, minimum, maximum and standard deviation results. 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.

return:

structure: for return value, see the help for CalculateStruct structure arguments.

fetch() ResultData[source]
# SCPI: FETCh:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
value: ResultData = driver.multiEval.modulation.average.fetch()

Return the single value results for OFDM SISO measurements. For MIMO measurements, the stream/antenna-independent values are returned. For 80+80 MHz signals, the segment-independent values are returned. There are current, average, minimum, maximum and standard deviation results. 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.

return:

structure: for return value, see the help for ResultData structure arguments.

read() ResultData[source]
# SCPI: READ:WLAN:MEASurement<Instance>:MEValuation:MODulation:AVERage
value: ResultData = driver.multiEval.modulation.average.read()

Return the single value results for OFDM SISO measurements. For MIMO measurements, the stream/antenna-independent values are returned. For 80+80 MHz signals, the segment-independent values are returned. There are current, average, minimum, maximum and standard deviation results. 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.

return:

structure: for return value, see the help for ResultData structure arguments.