Voip

SCPI Command:

SOURce:AFRF:GENerator<Instance>:VOIP:ENABle
SOURce:AFRF:GENerator<Instance>:VOIP:PCODec
SOURce:AFRF:GENerator<Instance>:VOIP:LEVel
SOURce:AFRF:GENerator<Instance>:VOIP:AUDio
SOURce:AFRF:GENerator<Instance>:VOIP:FID
SOURce:AFRF:GENerator<Instance>:VOIP:FREQuency
SOURce:AFRF:GENerator<Instance>:VOIP

class VoipCls[source]

Voip commands group definition. 20 total commands, 4 Subgroups, 7 group commands

class FrequencyStruct[source]

Structure for reading output parameters. Fields:

Freq: float: RF carrier center frequency Unit: Hz
Chanspac: int: Channel spacing Unit: Hz

get_audio() → bool[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:AUDio
value: bool = driver.source.afRf.generator.voip.get_audio()

Enables or disables feeding an audio signal into the VoIP path.

return:

af_2_vo_ip_enable: OFF | ON

get_enable() → bool[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:ENABle
value: bool = driver.source.afRf.generator.voip.get_enable()

Enables or disables VoIP.

return:

vo_ip_enable: OFF | ON

get_fid() → float[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:FID
value: float = driver.source.afRf.generator.voip.get_fid()

Specifies the frequency ID (FID) configured at the DUT.

INTRO_CMD_HELP: Allowed values are, with n = 0 to 39995:

0.100 + n * 0.025
0.105 + n * 0.025
0.110 + n * 0.025
0.115 + n * 0.025

Resulting in: 0.100, 0.105, 0.110, 0.115, 0.125, 0.130, 0.135, 0.140, …, 999.975, 999.980, 999.985, 999.990

return:

freq_id: Frequency ID Not allowed values are rounded to the closest allowed value. Range: 0.1 to 999.99

get_frequency() → FrequencyStruct[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:FREQuency
value: FrequencyStruct = driver.source.afRf.generator.voip.get_frequency()

Queries the RF carrier center frequency and the channel spacing resulting from the configured frequency ID.

return:

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

get_level() → float[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:LEVel
value: float = driver.source.afRf.generator.voip.get_level()

Specifies the audio output level for the VoIP path. For noise signals provided by an internal generator, the maximum allowed level is reduced by the factor 1/sqrt(2) .

return:

level: Range: 0.01 % to 100 %, Unit: %

get_pcodec() → VoIpCodec[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:PCODec
value: enums.VoIpCodec = driver.source.afRf.generator.voip.get_pcodec()

Queries the type of the pulse code modulation (PCM) codec.

return:

vo_ip_codec: ALAW

get_value() → VoIpSource[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP
value: enums.VoIpSource = driver.source.afRf.generator.voip.get_value()

Selects an audio signal source for the VoIP path.

return:

vo_ip_source: GEN4 | AFI1 | AFI2 GEN4 Audio generator 4

set_audio(af_2_vo_ip_enable: bool) → None[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:AUDio
driver.source.afRf.generator.voip.set_audio(af_2_vo_ip_enable = False)

Enables or disables feeding an audio signal into the VoIP path.

param af_2_vo_ip_enable:

OFF | ON

set_enable(vo_ip_enable: bool) → None[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:ENABle
driver.source.afRf.generator.voip.set_enable(vo_ip_enable = False)

Enables or disables VoIP.

param vo_ip_enable:

OFF | ON

set_fid(freq_id: float) → None[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:FID
driver.source.afRf.generator.voip.set_fid(freq_id = 1.0)

Specifies the frequency ID (FID) configured at the DUT.

INTRO_CMD_HELP: Allowed values are, with n = 0 to 39995:

0.100 + n * 0.025
0.105 + n * 0.025
0.110 + n * 0.025
0.115 + n * 0.025

Resulting in: 0.100, 0.105, 0.110, 0.115, 0.125, 0.130, 0.135, 0.140, …, 999.975, 999.980, 999.985, 999.990

param freq_id:

Frequency ID Not allowed values are rounded to the closest allowed value. Range: 0.1 to 999.99

set_level(level: float) → None[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP:LEVel
driver.source.afRf.generator.voip.set_level(level = 1.0)

Specifies the audio output level for the VoIP path. For noise signals provided by an internal generator, the maximum allowed level is reduced by the factor 1/sqrt(2) .

param level:

Range: 0.01 % to 100 %, Unit: %

set_value(vo_ip_source: VoIpSource) → None[source]

# SCPI: SOURce:AFRF:GENerator<Instance>:VOIP
driver.source.afRf.generator.voip.set_value(vo_ip_source = enums.VoIpSource.AFI1)

Selects an audio signal source for the VoIP path.

param vo_ip_source:

GEN4 | AFI1 | AFI2 GEN4 Audio generator 4

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.source.afRf.generator.voip.clone()

Subgroups