Waveform

SCPI Commands :

EXPort:WAVeform:SCOPe
EXPort:WAVeform:CURSorset
EXPort:WAVeform:GATE
EXPort:WAVeform:STARt
EXPort:WAVeform:STOP
EXPort:WAVeform:SAVE
EXPort:WAVeform:ABORt
EXPort:WAVeform:SOURce
EXPort:WAVeform:NAME

Commands in total: 13
Subgroups: 2
Direct child commands: 9

abort() → None[source]

# EXPort:WAVeform:ABORt
driver.export.waveform.abort()

Aborts a running waveform export, which was started with method RsMxo.export.waveform.save() .

abort_and_wait(opc_timeout_ms: int = -1) → None[source]

# EXPort:WAVeform:ABORt
driver.export.waveform.abort_and_wait()

Aborts a running waveform export, which was started with method RsMxo.export.waveform.save() .

Same as abort, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.

Parameters:: opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

get_cursor_set() → Cursor[source]

# EXPort:WAVeform:CURSorset
value: enums.Cursor = driver.export.waveform.get_cursor_set()

Sets the cursor set to be used for limited data export if method RsMxo.export.waveform.scope() is set to CURSor.

Returns:: cursor_set: CURSOR1 | CURSor1 | CURSOR2 | CURSor2 | CURSOR3 | CURSor3 | CURSOR4 | CURSor4

get_gate() → float[source]

# EXPort:WAVeform:GATE
value: float = driver.export.waveform.get_gate()

Selects the gate to be used for limited data export if method RsMxo.export.waveform.scope() is set to GATE.

get_name() → str[source]

# EXPort:WAVeform:NAME
value: str = driver.export.waveform.get_name()

Sets the path, the filename and the file format of the export file. The setting is used for save-as operations that do not use the autonaming settings.

Returns:: name: String with path and filename with extension .ref, .csv, .zip, or .h5. Extension .ref is provided for single waveform export only, while .zip is for export of multiple waveforms in REF format. CSV can be used for export of single waveforms, and multiple analog channels. For local storage, the path is always /home/storage/userData.

get_scope() → ExportScope[source]

# EXPort:WAVeform:SCOPe
value: enums.ExportScope = driver.export.waveform.get_scope()

Defines the part of the waveform record that has to be stored.

Returns:

scope: DISPlay | ALL | CURSor | GATE | MANual

DISPlay: Waveform data that is displayed in the diagram.
ALL: Complete waveform, which is usually longer than the displayed waveform.
CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.
GATE: Data included in the measurement gate if a gated measurement is defined for the source waveform.
MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.

get_source() → List[SignalSource][source]

# EXPort:WAVeform:SOURce
value: List[enums.SignalSource] = driver.export.waveform.get_source()

Selects the waveform or waveforms to be exported to file.

Returns:: sources: Possible waveform sources are: Analog signals: C1,C2,…,C8 Digital signals: D0,D1,D2,…,D15 Math waveforms: M1,M2,M3,M4,M5 Reference waveforms: R1,R2,R3,R4 Spectrum traces: SPECMAXH1,SPECMINH1,SPECNORM1,SPECAVER1,SPECMAXH2,SPECMINH2,SPECNORM2,SPECAVER2,SPECMAXH3,SPECMINH3,SPECNORM3,SPECAVER3,SPECMAXH4,SPECMINH4,SPECNORM4,SPECAVER4 Tracks: TRK1,TRK2,TRK3, …,TRK24 Analog channels of connected scopes (ScopeSync) : OnC1,OnC2, … ,OnC8 (n = 2 to 11) Power waveforms: PA1QPOWER | PA2QPOWER | … | PA6QPOWER | PA1HPOWER1 | PA2HPOWER1 | … | PA6HPOWER1| | PA1SPOWER | PA2SPOWER | … | PA6SPOWER | PA1IPOWER | PA2IPOWER | … | PA6IPOWER | PA1OPOWER1 | PA2OPOWER1 | … | PA6OPOWER1 | PA1OPOWER2 | PA2OPOWER2 | … | PA6OPOWER2 | PA1OPOWER3 | PA2OPOWER3 | … | PA6OPOWER3 | PA1TOPOWER | PA2TOPOWER | … | PA6TOPOWER | PA1SOA | PA2SOA | … | PA6SOA

get_start() → float[source]

# EXPort:WAVeform:STARt
value: float = driver.export.waveform.get_start()

Sets the start time value of the waveform section for export, if method RsMxo.export.waveform.scope() is set to Manual.

Returns:: start: -1E+26 to 1E+26

get_stop() → float[source]

# EXPort:WAVeform:STOP
value: float = driver.export.waveform.get_stop()

Sets the end time value of the waveform section for export, if method RsMxo.export.waveform.scope() is set to Manual.

Returns:: stop: -1E+26 to 1E+26

save() → None[source]

# EXPort:WAVeform:SAVE
driver.export.waveform.save()

Saves the waveform to the file specified with method RsMxo.export.waveform.name() .

save_and_wait(opc_timeout_ms: int = -1) → None[source]

# EXPort:WAVeform:SAVE
driver.export.waveform.save_and_wait()

Saves the waveform to the file specified with method RsMxo.export.waveform.name() .

Same as save, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.

Parameters:: opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

set_cursor_set(cursor_set: Cursor) → None[source]

# EXPort:WAVeform:CURSorset
driver.export.waveform.set_cursor_set(cursor_set = enums.Cursor.CURSOR1)

Sets the cursor set to be used for limited data export if method RsMxo.export.waveform.scope() is set to CURSor.

Parameters:: cursor_set – CURSOR1 | CURSor1 | CURSOR2 | CURSor2 | CURSOR3 | CURSor3 | CURSOR4 | CURSor4

set_gate(meas_gate: float) → None[source]

# EXPort:WAVeform:GATE
driver.export.waveform.set_gate(meas_gate = 1.0)

Selects the gate to be used for limited data export if method RsMxo.export.waveform.scope() is set to GATE.

Parameters:: meas_gate – Number of the gate to be applied to exported data.

set_name(name: str) → None[source]

# EXPort:WAVeform:NAME
driver.export.waveform.set_name(name = 'abc')

Sets the path, the filename and the file format of the export file. The setting is used for save-as operations that do not use the autonaming settings.

Parameters:: name – String with path and filename with extension .ref, .csv, .zip, or .h5. Extension .ref is provided for single waveform export only, while .zip is for export of multiple waveforms in REF format. CSV can be used for export of single waveforms, and multiple analog channels. For local storage, the path is always /home/storage/userData.

set_scope(scope: ExportScope) → None[source]

# EXPort:WAVeform:SCOPe
driver.export.waveform.set_scope(scope = enums.ExportScope.ALL)

Defines the part of the waveform record that has to be stored.

Parameters:

scope –

DISPlay | ALL | CURSor | GATE | MANual

DISPlay: Waveform data that is displayed in the diagram.
ALL: Complete waveform, which is usually longer than the displayed waveform.
CURSor: Data between the cursor lines if a cursor measurement is defined for the source waveform.
GATE: Data included in the measurement gate if a gated measurement is defined for the source waveform.
MANual: Saves the data between user-defined start and stop values to be set with EXPort:WAVeform:STARt and EXPort:WAVeform:STOP.

set_source(sources: List[SignalSource]) → None[source]

# EXPort:WAVeform:SOURce
driver.export.waveform.set_source(sources = [SignalSource.C1, SignalSource.XY4])

Selects the waveform or waveforms to be exported to file.

Parameters:: sources – Possible waveform sources are: Analog signals: C1,C2,…,C8 Digital signals: D0,D1,D2,…,D15 Math waveforms: M1,M2,M3,M4,M5 Reference waveforms: R1,R2,R3,R4 Spectrum traces: SPECMAXH1,SPECMINH1,SPECNORM1,SPECAVER1,SPECMAXH2,SPECMINH2,SPECNORM2,SPECAVER2,SPECMAXH3,SPECMINH3,SPECNORM3,SPECAVER3,SPECMAXH4,SPECMINH4,SPECNORM4,SPECAVER4 Tracks: TRK1,TRK2,TRK3, …,TRK24 Analog channels of connected scopes (ScopeSync) : OnC1,OnC2, … ,OnC8 (n = 2 to 11) Power waveforms: PA1QPOWER | PA2QPOWER | … | PA6QPOWER | PA1HPOWER1 | PA2HPOWER1 | … | PA6HPOWER1| | PA1SPOWER | PA2SPOWER | … | PA6SPOWER | PA1IPOWER | PA2IPOWER | … | PA6IPOWER | PA1OPOWER1 | PA2OPOWER1 | … | PA6OPOWER1 | PA1OPOWER2 | PA2OPOWER2 | … | PA6OPOWER2 | PA1OPOWER3 | PA2OPOWER3 | … | PA6OPOWER3 | PA1TOPOWER | PA2TOPOWER | … | PA6TOPOWER | PA1SOA | PA2SOA | … | PA6SOA

set_start(start: float) → None[source]

# EXPort:WAVeform:STARt
driver.export.waveform.set_start(start = 1.0)

Sets the start time value of the waveform section for export, if method RsMxo.export.waveform.scope() is set to Manual.

Parameters:: start – -1E+26 to 1E+26

set_stop(stop: float) → None[source]

# EXPort:WAVeform:STOP
driver.export.waveform.set_stop(stop = 1.0)

Sets the end time value of the waveform section for export, if method RsMxo.export.waveform.scope() is set to Manual.

Parameters:: stop – -1E+26 to 1E+26

Cloning the Group

# Create a copy of the original group, that exists independently
waveform_copy = driver.export.waveform.clone()

Subgroups