Ws

SCPI Commands :

[SOURce<HW>]:BB:NR5G:TCW:WS:CBW
[SOURce<HW>]:BB:NR5G:TCW:WS:CELLid
[SOURce<HW>]:BB:NR5G:TCW:WS:DUPLex
[SOURce<HW>]:BB:NR5G:TCW:WS:FMTHroughput
[SOURce<HW>]:BB:NR5G:TCW:WS:FROFfset
[SOURce<HW>]:BB:NR5G:TCW:WS:MAPType
[SOURce<HW>]:BB:NR5G:TCW:WS:MODE
[SOURce<HW>]:BB:NR5G:TCW:WS:PLEVel
[SOURce<HW>]:BB:NR5G:TCW:WS:PROCondition
[SOURce<HW>]:BB:NR5G:TCW:WS:RBOFfset
[SOURce<HW>]:BB:NR5G:TCW:WS:RFFRequency
[SOURce<HW>]:BB:NR5G:TCW:WS:RSET
[SOURce<HW>]:BB:NR5G:TCW:WS:SCSPacing
[SOURce<HW>]:BB:NR5G:TCW:WS:SYMNumber
[SOURce<HW>]:BB:NR5G:TCW:WS:TAPos
[SOURce<HW>]:BB:NR5G:TCW:WS:TIOBase
[SOURce<HW>]:BB:NR5G:TCW:WS:TREQuire
[SOURce<HW>]:BB:NR5G:TCW:WS:TSETup
[SOURce<HW>]:BB:NR5G:TCW:WS:UEID
[SOURce<HW>]:BB:NR5G:TCW:WS:VDRF

class WsCls[source]

Ws commands group definition. 30 total commands, 5 Subgroups, 20 group commands

get_cbw() → Nr5Gcbw[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:CBW
value: enums.Nr5Gcbw = driver.source.bb.nr5G.tcw.ws.get_cbw()

Selects the channel bandwidth.

return:

ws_ch_bw: BW3 | BW5 | BW10 | BW15 | BW20 | BW25 | BW30 | BW35 | BW40 | BW45 | BW50 | BW60 | BW70 | BW80 | BW90 | BW100 | BW200 | BW400 | BW800 | BW1600 | BW2000 Bandwidth in MHz

get_cell_id() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:CELLid
value: int = driver.source.bb.nr5G.tcw.ws.get_cell_id()

Sets the cell ID.

return:

ws_cell_id: integer Range: 0 to 1007

get_duplex() → EutraDuplexMode[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:DUPLex
value: enums.EutraDuplexMode = driver.source.bb.nr5G.tcw.ws.get_duplex()

The duplexing mechanism used can be switched between FDD and TDD.

return:

duplexing: FDD| TDD

get_fm_throughput() → EutraTcwfRactMaxThroughput[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:FMTHroughput
value: enums.EutraTcwfRactMaxThroughput = driver.source.bb.nr5G.tcw.ws.get_fm_throughput()

The required throughput is expressed as a fraction of maximum throughput for the FRC. The performance requirements assume HARQ retransmissions. The throughput shall be equal to or larger than the fraction of maximum throughput for the FRCs at the given SNR.

return:

fmt: FMT70| FMT30

get_fr_offset() → FreqOffset[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:FROFfset
value: enums.FreqOffset = driver.source.bb.nr5G.tcw.ws.get_fr_offset()

Sets the frequency offset used for the PRACH.

return:

freq_offset: FO_0| FO_400| FO_4000| FO_625| FO_1340| FO_1740| FO_2334| FO_3334| FO_19444

get_map_type() → MappingType[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:MAPType
value: enums.MappingType = driver.source.bb.nr5G.tcw.ws.get_map_type()

Sets the mapping type A or B for the PUSCH.

return:

map_type: A| B

get_mode() → Mode[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:MODE
value: enums.Mode = driver.source.bb.nr5G.tcw.ws.get_mode()

Switches between the detection rate (Pd) and the false detection rate (Pfa) .

return:

mode: DRAT| FDR DRAT Pd is defined as the probability of detection of preamble. FDR Pfa is defined as the total probability of false detection of the preamble.

get_plevel() → float[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:PLEVel
value: float = driver.source.bb.nr5G.tcw.ws.get_plevel()

Specifies the power level of the wanted signal.

return:

ws_pow_lev: float Range: -145 to 20, Unit: dB

get_pro_condition() → PropagCond[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:PROCondition
value: enums.PropagCond = driver.source.bb.nr5G.tcw.ws.get_pro_condition()

The propagation conditions define the multipath fading environment. They indicated as a combination of channel model name and maximum Doppler frequency, i.e. TDLA<DS>-<Doppler> where <DS> indicates the desired delay spread and <Doppler> indicates the maximum Doppler frequency.

return:

propag_cond: TDLB100D400| TDLC300D100| TDLA30D10| AWGN| TDLA30D300| TDLA30D75| HST1NR350| HST3NR350| HST1NR500| HST3NR500| TDLC300D600| TDLC300D1200| MPX| MPY| MPZ

get_rb_offset() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RBOFfset
value: int = driver.source.bb.nr5G.tcw.ws.get_rb_offset()

Sets the resource block offset of the wanted signal.

return:

ws_rb_offset: integer Number of resource blocks. Range: 0 to 273

get_rf_frequency() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RFFRequency
value: int = driver.source.bb.nr5G.tcw.ws.get_rf_frequency()

Sets the RF frequency of the wanted signal.

return:

ws_rf_freq: integer Range: 100e+03 to 6e+09

get_rset() → RestrictedSet[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RSET
value: enums.RestrictedSet = driver.source.bb.nr5G.tcw.ws.get_rset()

Selects the restricted set type for the PRACH.

INTRO_CMD_HELP: Prerequisites for this command

Select high speed train mode ([:SOURce<hw>]:BB:NR5G:TCW:WS:TREQuire) .
Select preamble format 0 ([:SOURce<hw>]:BB:NR5G:TCW:WS:PRACh:FORMat) .

return:: restricted_set: ARES| BRES ARES Restricted set type A. BRES Restricted set type B.

get_sc_spacing() → Numerology[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:SCSPacing
value: enums.Numerology = driver.source.bb.nr5G.tcw.ws.get_sc_spacing()

Sets the subcarrier spacing.

return:

ws_subcar_spacing: N15| N30| N60| X60| N120| N240| N480| N960 N15, N30, N60, N120, N240, N480, N960 Normal cyclic prefix, value in kHz E60 Extended cyclic prefix, 60 kHz

get_sym_number() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:SYMNumber
value: int = driver.source.bb.nr5G.tcw.ws.get_sym_number()

Sets the number of used OFDM symbols. The starting symbol index is 13 for 1 OFDM symbol and 12 for 2 OFDM symbols.

return:

symbol_number: integer Range: 1 to 14

get_tapos() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TAPos
value: int = driver.source.bb.nr5G.tcw.ws.get_tapos()

Sets the position of first DM-RS symbol for PUSCH (and PDSCH) mapping type A (dmrs-TypeA-Position) .

return:

ws_typea_pos: integer Range: 2 to 3

get_tio_base() → float[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TIOBase
value: float = driver.source.bb.nr5G.tcw.ws.get_tio_base()

Queries the timing off base value.

return:

timing_offset_base: float Range: 0 to 6.2

get_trequire() → TestRequirment[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TREQuire
value: enums.TestRequirment = driver.source.bb.nr5G.tcw.ws.get_trequire()

Selects the test requirement for 3GPP test cases.

return:

test_requirement: NORM| HST

get_tsetup() → TestSetup[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TSETup
value: enums.TestSetup = driver.source.bb.nr5G.tcw.ws.get_tsetup()

With the test setup selector, the signal definitions can be switched.

return:

test_setup: TS_1| TS_2

get_ue_id() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:UEID
value: int = driver.source.bb.nr5G.tcw.ws.get_ue_id()

Sets the UE ID.

return:

ws_ueid: integer Range: 0 to 65535

get_vdrf() → int[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:VDRF
value: int = driver.source.bb.nr5G.tcw.ws.get_vdrf()

Sets the virtual downlink RF frequency

return:

virtual_dl_rf: integer Range: 100e+03 to 6e+09

set_cbw(ws_ch_bw: Nr5Gcbw) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:CBW
driver.source.bb.nr5G.tcw.ws.set_cbw(ws_ch_bw = enums.Nr5Gcbw.BW10)

Selects the channel bandwidth.

param ws_ch_bw:

BW3 | BW5 | BW10 | BW15 | BW20 | BW25 | BW30 | BW35 | BW40 | BW45 | BW50 | BW60 | BW70 | BW80 | BW90 | BW100 | BW200 | BW400 | BW800 | BW1600 | BW2000 Bandwidth in MHz

set_cell_id(ws_cell_id: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:CELLid
driver.source.bb.nr5G.tcw.ws.set_cell_id(ws_cell_id = 1)

Sets the cell ID.

param ws_cell_id:

integer Range: 0 to 1007

set_duplex(duplexing: EutraDuplexMode) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:DUPLex
driver.source.bb.nr5G.tcw.ws.set_duplex(duplexing = enums.EutraDuplexMode.FDD)

The duplexing mechanism used can be switched between FDD and TDD.

param duplexing:

FDD| TDD

set_fm_throughput(fmt: EutraTcwfRactMaxThroughput) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:FMTHroughput
driver.source.bb.nr5G.tcw.ws.set_fm_throughput(fmt = enums.EutraTcwfRactMaxThroughput.FMT30)

The required throughput is expressed as a fraction of maximum throughput for the FRC. The performance requirements assume HARQ retransmissions. The throughput shall be equal to or larger than the fraction of maximum throughput for the FRCs at the given SNR.

param fmt:

FMT70| FMT30

set_fr_offset(freq_offset: FreqOffset) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:FROFfset
driver.source.bb.nr5G.tcw.ws.set_fr_offset(freq_offset = enums.FreqOffset.FO_0)

Sets the frequency offset used for the PRACH.

param freq_offset:

FO_0| FO_400| FO_4000| FO_625| FO_1340| FO_1740| FO_2334| FO_3334| FO_19444

set_map_type(map_type: MappingType) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:MAPType
driver.source.bb.nr5G.tcw.ws.set_map_type(map_type = enums.MappingType.A)

Sets the mapping type A or B for the PUSCH.

param map_type:

A| B

set_mode(mode: Mode) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:MODE
driver.source.bb.nr5G.tcw.ws.set_mode(mode = enums.Mode.DRAT)

Switches between the detection rate (Pd) and the false detection rate (Pfa) .

param mode:

DRAT| FDR DRAT Pd is defined as the probability of detection of preamble. FDR Pfa is defined as the total probability of false detection of the preamble.

set_plevel(ws_pow_lev: float) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:PLEVel
driver.source.bb.nr5G.tcw.ws.set_plevel(ws_pow_lev = 1.0)

Specifies the power level of the wanted signal.

param ws_pow_lev:

float Range: -145 to 20, Unit: dB

set_pro_condition(propag_cond: PropagCond) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:PROCondition
driver.source.bb.nr5G.tcw.ws.set_pro_condition(propag_cond = enums.PropagCond.AWGN)

The propagation conditions define the multipath fading environment. They indicated as a combination of channel model name and maximum Doppler frequency, i.e. TDLA<DS>-<Doppler> where <DS> indicates the desired delay spread and <Doppler> indicates the maximum Doppler frequency.

param propag_cond:

TDLB100D400| TDLC300D100| TDLA30D10| AWGN| TDLA30D300| TDLA30D75| HST1NR350| HST3NR350| HST1NR500| HST3NR500| TDLC300D600| TDLC300D1200| MPX| MPY| MPZ

set_rb_offset(ws_rb_offset: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RBOFfset
driver.source.bb.nr5G.tcw.ws.set_rb_offset(ws_rb_offset = 1)

Sets the resource block offset of the wanted signal.

param ws_rb_offset:

integer Number of resource blocks. Range: 0 to 273

set_rf_frequency(ws_rf_freq: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RFFRequency
driver.source.bb.nr5G.tcw.ws.set_rf_frequency(ws_rf_freq = 1)

Sets the RF frequency of the wanted signal.

param ws_rf_freq:

integer Range: 100e+03 to 6e+09

set_rset(restricted_set: RestrictedSet) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:RSET
driver.source.bb.nr5G.tcw.ws.set_rset(restricted_set = enums.RestrictedSet.ARES)

Selects the restricted set type for the PRACH.

INTRO_CMD_HELP: Prerequisites for this command

Select high speed train mode ([:SOURce<hw>]:BB:NR5G:TCW:WS:TREQuire) .
Select preamble format 0 ([:SOURce<hw>]:BB:NR5G:TCW:WS:PRACh:FORMat) .

param restricted_set:: ARES| BRES ARES Restricted set type A. BRES Restricted set type B.

set_sc_spacing(ws_subcar_spacing: Numerology) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:SCSPacing
driver.source.bb.nr5G.tcw.ws.set_sc_spacing(ws_subcar_spacing = enums.Numerology.N120)

Sets the subcarrier spacing.

param ws_subcar_spacing:

N15| N30| N60| X60| N120| N240| N480| N960 N15, N30, N60, N120, N240, N480, N960 Normal cyclic prefix, value in kHz E60 Extended cyclic prefix, 60 kHz

set_sym_number(symbol_number: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:SYMNumber
driver.source.bb.nr5G.tcw.ws.set_sym_number(symbol_number = 1)

Sets the number of used OFDM symbols. The starting symbol index is 13 for 1 OFDM symbol and 12 for 2 OFDM symbols.

param symbol_number:

integer Range: 1 to 14

set_tapos(ws_typea_pos: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TAPos
driver.source.bb.nr5G.tcw.ws.set_tapos(ws_typea_pos = 1)

Sets the position of first DM-RS symbol for PUSCH (and PDSCH) mapping type A (dmrs-TypeA-Position) .

param ws_typea_pos:

integer Range: 2 to 3

set_trequire(test_requirement: TestRequirment) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TREQuire
driver.source.bb.nr5G.tcw.ws.set_trequire(test_requirement = enums.TestRequirment.HST)

Selects the test requirement for 3GPP test cases.

param test_requirement:

NORM| HST

set_tsetup(test_setup: TestSetup) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:TSETup
driver.source.bb.nr5G.tcw.ws.set_tsetup(test_setup = enums.TestSetup.TS_1)

With the test setup selector, the signal definitions can be switched.

param test_setup:

TS_1| TS_2

set_ue_id(ws_ueid: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:UEID
driver.source.bb.nr5G.tcw.ws.set_ue_id(ws_ueid = 1)

Sets the UE ID.

param ws_ueid:

integer Range: 0 to 65535

set_vdrf(virtual_dl_rf: int) → None[source]

# SCPI: [SOURce<HW>]:BB:NR5G:TCW:WS:VDRF
driver.source.bb.nr5G.tcw.ws.set_vdrf(virtual_dl_rf = 1)

Sets the virtual downlink RF frequency

param virtual_dl_rf:

integer Range: 100e+03 to 6e+09

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.bb.nr5G.tcw.ws.clone()

Subgroups