UserDefined

SCPI Command:

SOURce:AFRF:GENerator<Instance>:UDEFined:ENABle
SOURce:AFRF:GENerator<Instance>:UDEFined:IMODulation
SOURce:AFRF:GENerator<Instance>:UDEFined:REPetition
SOURce:AFRF:GENerator<Instance>:UDEFined:PAUSe
SOURce:AFRF:GENerator<Instance>:UDEFined:BANDwidth
SOURce:AFRF:GENerator<Instance>:UDEFined:ILENgth
SOURce:AFRF:GENerator<Instance>:UDEFined:ROFactor
SOURce:AFRF:GENerator<Instance>:UDEFined:FILTer
SOURce:AFRF:GENerator<Instance>:UDEFined:SLENgth
SOURce:AFRF:GENerator<Instance>:UDEFined:DRATe
SOURce:AFRF:GENerator<Instance>:UDEFined:SVALue
SOURce:AFRF:GENerator<Instance>:UDEFined:PATTern
SOURce:AFRF:GENerator<Instance>:UDEFined:SDEViation
SOURce:AFRF:GENerator<Instance>:UDEFined:MODE

class UserDefinedCls

UserDefined commands group definition. 14 total commands, 0 Subgroups, 14 group commands

get_bandwidth() → float

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:BANDwidth
value: float = driver.source.afRf.generator.userDefined.get_bandwidth()

Selects the bandwidth of the ‘Gauss’ filter for pulse shaping for the user-defined standard.

return:

bandwidth: Range: 1000 Hz to 100000 Hz

get_drate() → int

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:DRATe
value: int = driver.source.afRf.generator.userDefined.get_drate()

Specifies the data rate for the user-defined standard.

return:

drate: Range: 200 bit/s to 115200 bit/s, Unit: bit/s

get_enable() → bool

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

Enables or disables FSK modulation of user-defined data on the RF carrier.

return:

undefined_enable: No help available

get_filter_py() → GeneratorFilter

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:FILTer
value: enums.GeneratorFilter = driver.source.afRf.generator.userDefined.get_filter_py()

Selects the filter type for pulse shaping for the user-defined standard.

return:

filter_py: GAUSs | RRC | RC | COS | SINC GAUSs Gauss filter RRC Root-raised-cosine filter RC Raised-cosine filter COS Cosine filter SINC Sinc filter

get_ilength() → ImpulseLength

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:ILENgth
value: enums.ImpulseLength = driver.source.afRf.generator.userDefined.get_ilength()

Selects the impulse length of the filter used for pulse shaping for the user-defined standard.

return:

impulse_length: T | T2 | T4 | T6 | T8

get_imodulation() → bool

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:IMODulation
value: bool = driver.source.afRf.generator.userDefined.get_imodulation()

Inverts the frequency deviation of the symbols for the frequency-shift keying modulation.

return:

imod: OFF | ON

get_mode() → FskMode

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:MODE
value: enums.FskMode = driver.source.afRf.generator.userDefined.get_mode()

Sets the frequency-shift keying modulation type for the user-defined generator setting.

return:

mode: FSK2 | FSK4

get_pattern() → UserDefPattern

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:PATTern
value: enums.UserDefPattern = driver.source.afRf.generator.userDefined.get_pattern()

Selects the bit pattern to be transmitted as payload for the user-defined standard.

return:

pattern: PRBS6 | PRBS9

get_pause() → float

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:PAUSe
value: float = driver.source.afRf.generator.userDefined.get_pause()

Defines the duration of a pause between two repetitions of a bit sequence for the user-defined standard.

return:

pause: Range: 0 ms to 10E+3 ms, Unit: s

get_repetition() → RepeatMode

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:REPetition
value: enums.RepeatMode = driver.source.afRf.generator.userDefined.get_repetition()

Specifies how often the bit sequence is processed for the user-defined standard.

return:

repetition: CONTinuous | SINGle SINGle: Single transmission of the bit sequence CONTinuous: Continuous repetition of the bit sequence

get_ro_factor() → float

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:ROFactor
value: float = driver.source.afRf.generator.userDefined.get_ro_factor()

Specifies the roll-off factor of the filter used for pulse shaping for the user-defined standard.

return:

ro_factor: Range: 0 to 1

get_slength() → int

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SLENgth
value: int = driver.source.afRf.generator.userDefined.get_slength()

Specifies the length of a single bit sequence for the user-defined standard.

return:

slength: Range: 0 bits to 16320 bits, Unit: bits

get_standard_dev() → List[float]

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SDEViation
value: List[float] = driver.source.afRf.generator.userDefined.get_standard_dev()

Defines the frequency deviations for the frequency-shift keying modulation (2FSK, 4FSK) of the user-defined standard. A setting command defines the deviation for symbol 01. The deviations for the other symbols are calculated from the setting. A query returns a comma-separated list of four deviations, for symbol 01, 00, 10, 11.

return:

sdeviation: Frequency deviation Range: 0 Hz to 100 kHz, Unit: Hz

get_svalue() → str

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SVALue
value: str = driver.source.afRf.generator.userDefined.get_svalue()

Specifies the seed value for the PRBS generator, for the user-defined standard.

return:

svalue: Range: #H0 to #H1FF (for PRBS 6 max. #H3F)

set_bandwidth(bandwidth: float) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:BANDwidth
driver.source.afRf.generator.userDefined.set_bandwidth(bandwidth = 1.0)

Selects the bandwidth of the ‘Gauss’ filter for pulse shaping for the user-defined standard.

param bandwidth:

Range: 1000 Hz to 100000 Hz

set_drate(drate: int) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:DRATe
driver.source.afRf.generator.userDefined.set_drate(drate = 1)

Specifies the data rate for the user-defined standard.

param drate:

Range: 200 bit/s to 115200 bit/s, Unit: bit/s

set_enable(undefined_enable: bool) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:ENABle
driver.source.afRf.generator.userDefined.set_enable(undefined_enable = False)

Enables or disables FSK modulation of user-defined data on the RF carrier.

param undefined_enable:

OFF | ON

set_filter_py(filter_py: GeneratorFilter) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:FILTer
driver.source.afRf.generator.userDefined.set_filter_py(filter_py = enums.GeneratorFilter.COS)

Selects the filter type for pulse shaping for the user-defined standard.

param filter_py:

GAUSs | RRC | RC | COS | SINC GAUSs Gauss filter RRC Root-raised-cosine filter RC Raised-cosine filter COS Cosine filter SINC Sinc filter

set_ilength(impulse_length: ImpulseLength) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:ILENgth
driver.source.afRf.generator.userDefined.set_ilength(impulse_length = enums.ImpulseLength.T)

Selects the impulse length of the filter used for pulse shaping for the user-defined standard.

param impulse_length:

T | T2 | T4 | T6 | T8

set_imodulation(imod: bool) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:IMODulation
driver.source.afRf.generator.userDefined.set_imodulation(imod = False)

Inverts the frequency deviation of the symbols for the frequency-shift keying modulation.

param imod:

OFF | ON

set_mode(mode: FskMode) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:MODE
driver.source.afRf.generator.userDefined.set_mode(mode = enums.FskMode.FSK2)

Sets the frequency-shift keying modulation type for the user-defined generator setting.

param mode:

FSK2 | FSK4

set_pattern(pattern: UserDefPattern) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:PATTern
driver.source.afRf.generator.userDefined.set_pattern(pattern = enums.UserDefPattern.PRBS6)

Selects the bit pattern to be transmitted as payload for the user-defined standard.

param pattern:

PRBS6 | PRBS9

set_pause(pause: float) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:PAUSe
driver.source.afRf.generator.userDefined.set_pause(pause = 1.0)

Defines the duration of a pause between two repetitions of a bit sequence for the user-defined standard.

param pause:

Range: 0 ms to 10E+3 ms, Unit: s

set_repetition(repetition: RepeatMode) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:REPetition
driver.source.afRf.generator.userDefined.set_repetition(repetition = enums.RepeatMode.CONTinuous)

Specifies how often the bit sequence is processed for the user-defined standard.

param repetition:

CONTinuous | SINGle SINGle: Single transmission of the bit sequence CONTinuous: Continuous repetition of the bit sequence

set_ro_factor(ro_factor: float) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:ROFactor
driver.source.afRf.generator.userDefined.set_ro_factor(ro_factor = 1.0)

Specifies the roll-off factor of the filter used for pulse shaping for the user-defined standard.

param ro_factor:

Range: 0 to 1

set_slength(slength: int) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SLENgth
driver.source.afRf.generator.userDefined.set_slength(slength = 1)

Specifies the length of a single bit sequence for the user-defined standard.

param slength:

Range: 0 bits to 16320 bits, Unit: bits

set_standard_dev(sdeviation: List[float]) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SDEViation
driver.source.afRf.generator.userDefined.set_standard_dev(sdeviation = [1.1, 2.2, 3.3])

Defines the frequency deviations for the frequency-shift keying modulation (2FSK, 4FSK) of the user-defined standard. A setting command defines the deviation for symbol 01. The deviations for the other symbols are calculated from the setting. A query returns a comma-separated list of four deviations, for symbol 01, 00, 10, 11.

param sdeviation:

Frequency deviation Range: 0 Hz to 100 kHz, Unit: Hz

set_svalue(svalue: str) → None

# SCPI: SOURce:AFRF:GENerator<Instance>:UDEFined:SVALue
driver.source.afRf.generator.userDefined.set_svalue(svalue = r1)

Specifies the seed value for the PRBS generator, for the user-defined standard.

param svalue:

Range: #H0 to #H1FF (for PRBS 6 max. #H3F)