Waveform

SCPI Commands :

IPM:WAVeform:BASE
IPM:WAVeform:COUNt
IPM:WAVeform:OFFSet
IPM:WAVeform:PERiod
IPM:WAVeform:PHASe
IPM:WAVeform:PKPK
IPM:WAVeform:TYPE

class WaveformCls

Waveform commands group definition. 7 total commands, 0 Subgroups, 7 group commands

get_base() → BaseDomain

# SCPI: IPM:WAVeform:BASE
value: enums.BaseDomain = driver.ipm.waveform.get_base()

Defines how the waveform period is defined, as a time duration or as a number of pulses.

return:

base: PULSe| TIME

get_count() → float

# SCPI: IPM:WAVeform:COUNt
value: float = driver.ipm.waveform.get_count()

Sets the waveform period as number of pulses.

return:

count: integer Range: 1 to 1e+09

get_offset() → float

# SCPI: IPM:WAVeform:OFFSet
value: float = driver.ipm.waveform.get_offset()

Shifts the profile by the selected offset.

return:

offset: float Range: -1e+09 to 1e+09

get_period() → float

# SCPI: IPM:WAVeform:PERiod
value: float = driver.ipm.waveform.get_period()

Sets the waveform period.

return:

period: float Range: 1e-09 to 1e+09, Unit: sec

get_phase() → float

# SCPI: IPM:WAVeform:PHASe
value: float = driver.ipm.waveform.get_phase()

Enables a phase offset to change the start phase of the sine wave.

return:

phase: float Range: -1e+09 to 1e+09, Unit: sec

get_pkpk() → float

# SCPI: IPM:WAVeform:PKPK
value: float = driver.ipm.waveform.get_pkpk()

Sets the value range of the linear ramp profile or the period of the sine profile.

return:

pkpk: float Range: 1e-09 to 1e+09, Unit: sec

get_type_py() → WaveformShape

# SCPI: IPM:WAVeform:TYPE
value: enums.WaveformShape = driver.ipm.waveform.get_type_py()

Sets the profile shape.

return:

type_py: RAMP| SINE| TRIangular

set_base(base: BaseDomain) → None

# SCPI: IPM:WAVeform:BASE
driver.ipm.waveform.set_base(base = enums.BaseDomain.PULSe)

Defines how the waveform period is defined, as a time duration or as a number of pulses.

param base:

PULSe| TIME

set_count(count: float) → None

# SCPI: IPM:WAVeform:COUNt
driver.ipm.waveform.set_count(count = 1.0)

Sets the waveform period as number of pulses.

param count:

integer Range: 1 to 1e+09

set_offset(offset: float) → None

# SCPI: IPM:WAVeform:OFFSet
driver.ipm.waveform.set_offset(offset = 1.0)

Shifts the profile by the selected offset.

param offset:

float Range: -1e+09 to 1e+09

set_period(period: float) → None

# SCPI: IPM:WAVeform:PERiod
driver.ipm.waveform.set_period(period = 1.0)

Sets the waveform period.

param period:

float Range: 1e-09 to 1e+09, Unit: sec

set_phase(phase: float) → None

# SCPI: IPM:WAVeform:PHASe
driver.ipm.waveform.set_phase(phase = 1.0)

Enables a phase offset to change the start phase of the sine wave.

param phase:

float Range: -1e+09 to 1e+09, Unit: sec

set_pkpk(pkpk: float) → None

# SCPI: IPM:WAVeform:PKPK
driver.ipm.waveform.set_pkpk(pkpk = 1.0)

Sets the value range of the linear ramp profile or the period of the sine profile.

param pkpk:

float Range: 1e-09 to 1e+09, Unit: sec

set_type_py(type_py: WaveformShape) → None

# SCPI: IPM:WAVeform:TYPE
driver.ipm.waveform.set_type_py(type_py = enums.WaveformShape.RAMP)

Sets the profile shape.

param type_py:

RAMP| SINE| TRIangular