This programmer manual provides information on using the commands for
remotely controlling the Pulse plug-in application.
You can install the Pulse plug-in either in the SourceXpress software application
or in an AWG5200 Series Arbitrary Waveform Generator.
Using a single VISA or raw socket session, it is possible to communicate the
plug-in with both SourceXpress programmatic interface and AWG5200 Series
instruments.
For information on the Remote Control, GPIB Parameters, LAN Parameters,
Connecting to the Instrument using GPIB, and Setting up GPIB Communication,
refer to the AWG5200 Series Arbitrary Waveform Generators ProgrammerManual.
Pulse Plug-in Programmer Manual 1
Getting started
2Pulse Plug-in Programmer Manual
Syntax and commands
Command syntax
For information on the Syntax Overview, Command and Query Structure,
Clearing the Instrument, Command Entry, Parameter Types, SCPI Commands,
and Queries, refer to the AWG5200 Series Arbitrary Waveform GeneratorsProgrammer Manual.
Parameter types
Every parameter in the command and query descriptions is of a specified type.
The parameters are enclosed in brackets, such as <value>. The parameter type is
listed after the parameter and is enclosed in parentheses, for example, (boolean).
Some parameter types are defined specifically for the RSA Series command set
and some are defined by ANSI/IEEE 488.2-1987 as defined in the table below.
Parameter typeDescriptionExample
arbitrary block
booleanBoolean numbers or valuesON or 1; OFF or 0
binaryBinary numbers#B0110
octalOctal numbers#Q57, #Q3
hexadecimal
NR11 numericIntegers0, 1, 15, -1
1 2
NR2
numericDecimal numbers1.2, 3.141516, -6.5
NR31 numericFloating point numbers3.1415E-9, -16.1E5
NRf1 numericFlexible decimal number that
3
string
1
A specified length of arbitrary
data
#512234xxxxx . . . where
5 indicates that the following
5 digits (12234) specify the
length of the data in bytes;
xxxxx ... indicates the data
1
Hexadecimal numbers
#HAA, #H1
(0-9, A, B, C, D, E, F)
See NR1, NR2, and NR3
may be type NR1, NR2 or NR3
Alphanumeric characters (must
examples
"Testing 1, 2, 3"
be within quotation marks)
1
Defined in ANSI/IEEE 488.2 as "Definite Length Arbitrary Block Response Data."
2
Some commands and queries will accept an octal or hexadecimal value even though the parameter type is defined as NR1.
3
Defined in ANSI/IEEE 488.2 as "String Response Data."
Pulse Plug-in Programmer Manual 3
Syntax and commands
Command groups
Control commands
Table 1: Control commands and their descriptions
CommandDescription
WPLugin:ACTive on page 19Sets or queries the active waveform creation plug-in.
PULSe:RESet (No Query Form)
on page 18
Compile commands
Table 2: Compile commands and their descriptions
CommandDescription
PULSe:COMPile (No Query
Form) on page 6
PULSe:COMPile:CANCel (No
Query Form) on page 7
PULSe:COMPile:OVERwrite on
page 8
PULSe:COMPile:SEQuence on
page 9
PULSe:COMPile:CASSign on
page 7
PULSe:COMPile:PLAY on
page 8
PULSe:COMPile:SRATe on
page 9
PULSe:COMPile:OSAMpling on
page 7
PULSe:COMPile:SRATe:AUTO
on page 10
Resets the Pulse plug-in by setting all the controls to its default
value/state.
Compiles and generates waveforms/sequences based on the
Pulse setup.
Cancels the compilation.
Sets or queries the overwrite existing waveforms/sequences
state (enabled or disabled) while compiling.
Sets or queries the state (enabled or disabled) of create
sequence at the end of the compile. If the sequence status is off,
then each pulse train is created as one single waveform.
Sets or queries the type of compilation.
Sets or queries the play after assign state (enabled or disabled)
for the compile settings.
Sets or queries the sampling rate.
Sets and queries the oversampling rate which is used to
determine the sampling rate of the compiled signal.
Sets or queries the sampling rate auto calculation status.
4Pulse Plug-in Programmer Manual
Syntax and commands
Pulse train commands
Table 3: Pulse train commands and their descriptions
CommandDescription
PULSe:PTRain:ADD [No Query
Form] on page 16
PULSe:PTRain:DELete (No
Query Form) on page 17
PULSe:PTRain:COUNt on
page 17
PULSe:PTRain:SELect on
page 18
PULSe:PTRain:REName (NO
Query Form) on page 18
PULSe:PTRain:AMPLitude on
page 16
PULSe:PTRain:CHANnel on
page 17
Creates and adds the pulse train name to the pulse train list.
Deletes the specified pulse train from the pulse train list.
Returns the number of pulse train definitions in the pulse train
list.
Sets or queries the name of the currently selected pulse train.
Renames an existing pulse train name.
Sets or queries the peak to peak amplitude of the selected pulse
train.
Sets the channel number for the waveform/sequence of currently
selected pulse train.
Pulse setup commands
Table 4: Pulse setup commands and their descriptions
CommandDescription
PULSe:FRAMe:ADD on
page 10
PULSe:FRAMe:DELete on
page 11
PULSe:FRAMe:COUNt on
page 10
PULSe:FRAMe:SELect on
page 12
PULSe:FRAMe:DTIMe on
page 11
PULSe:FRAMe:NPULse on
page 11
PULSe:FRAMe:PSETup:SHAP
e on page 15
PULSe:FRAMe:PSETup:RTIMe
:VALue on page 14
PULSe:FRAMe:PSETup:RTIMe
:PERCentage on page 14
PULSe:FRAMe:PSETup:FTIMe
:VALue on page 12
PULSe:FRAMe:PSETup:FTIMe
:PERCentage on page 12
Adds a new frame to the current selected pulse train.
Deletes the pulse definition at index <n> of the current selected
pulse train.
Returns the number of pulse definition in the current selected
pulse train.
Sets or queries the index of the currently selected pulse definition
in the currently selected pulse train.
Sets or queries the dead time of the current selected frame
definition.
Sets or queries the number of pulses in the current selected
frame definition.
Sets or queries the shape of the pulse for the selected frame.
Sets or queries the rise time value of the pulse for the selected
frame.
Sets or queries the percentage at which the rise time is applied
for the pulse shape.
Sets or queries the fall time value of the pulse for the selected
frame.
Sets or queries the percentage at which the fall time is applied
for the pulse shape.
Pulse Plug-in Programmer Manual 5
Syntax and commands
CommandDescription
PULSe:FRAMe:PSETup:WIDTh
:VALue on page 16
PULSe:FRAMe:PSETup:WIDTh
:PERCentage on page 15
PULSe:FRAMe:PSETup:PRI on
page 14
PULSe:FRAMe:PSETup:PRF
on page 13
PULSe:FRAMe:PSETup:OTIMe
on page 13
Sets or queries the width of the pulse for the selected frame.
Sets or queries the percentage at which the pulse width value is
applied for the pulse shape.
Sets or queries the value of pulse repeat interval for the selected
frame.
Sets or queries the value of pulse repeat frequency for the
selected frame.
Sets or queries the off time value for the selected frame.
Commands in alphabetical order
This section contains all the available commands which are represented in
alphabetical order.
PULSe:COMPile (No Query
Form)
Use the Command Groups section to simplify navigating to specific groups of
commands.
This command compiles and generates waveforms\sequences based on the pulse
setup.
This is an overlapping command.
Syntax. PULSe:COMPile
Group. Pulse Compile
Arguments. NA
Returns. NA
Example. PULSe:COMPile, compiles the waveform\sequences based on the pulse
settings.
6Pulse Plug-in Programmer Manual
Syntax and commands
PULSe:COMPile:CANCel
(No Query Form)
PULSe:COMPile:CASSign
This command cancels the compilation.
Syntax. PULSe:COMPile:CANCel
Group. Pulse Compile
Arguments. NA
Returns. NA
Example. PULSe:COMPile:CANCel, cancels the current compilation which is in
progress.
This command sets or queries the type of compilation.
Syntax. PULSE:COMPile:CASSign {0 | 1 | OFF | ON}
PULSE:COMPile:CASSign?
Group. Pulse Compile
Arguments. 0 or OFF compile the waveform.
1 or ON compile and assign the waveform to a channel.
Returns. A single <Boolean> value.
PULSe:COMPile:OSAMplin
Example. PULSe:COMP:CASSign 1, compiles and assigns the function.
PULSe:COMP:CASSign? may return 0, which indicates the compilation of
waveform.
This command sets and queries the oversampling rate which is used to determine
the sampling rate of the compiled signal.
g
The query will return the current value.
Syntax. PULSe:COMPile:OSAMpling <oversampling>
PULSe:COMPile:OSAMpling?
Group. Pulse Compile
Arguments. <oversampling>::=<NR1> where the values of <NR1> varies 1 to
1000.
Returns. <NR1>
Example. PULSe:COMPile:OSAMpling 6, sets the oversampling rate to 6.
PULSe:COMPile:OSAMpling? might return 4, which indicates the oversampling
rate is 4.
Pulse Plug-in Programmer Manual 7
Syntax and commands
PULSe:COMPile:OVERwrit
PULSe:COMPile:PLAY
This command sets or queries the overwrite existing waveforms/sequences state
(enabled or disabled) while compiling. When enabled, new waveforms/sequences
e
overwrite existing waveforms and sequences of the same name. When disabled,
new waveforms are generated with an additional numeric suffix added at the end
of each name.
Syntax. PULSe:COMPile:OVERwrite {0 | 1 | OFF | ON}
PULSe:COMPile:OVERwrite?
Group. Pulse Compile
Arguments. ON or 1 enables waveforms/sequences state.
PULSe:COMP:OVERwrite? might return 0, which indicates the overwriting
waveforms/sequences state is disabled.
This command sets or queries the play after assign state (enabled or disabled) for
the compile settings.
Play after assign is active only when Compile and assign is enabled.
Syntax. PULSe:COMPile:PLAY {0 | 1 | OFF | ON}
PULSe:COMPile:PLAY?
Group. Pulse Compile
Arguments. OFF or 0 disables play after assign setting.
ON or 1 enables play after assign setting.
Returns. A single <Boolean> value.
Example. PULSe:COMP:PLAY 1, enables play after assign setting.
PULSe:COMP:PLAY? might return 0, which indicates the play after assign
setting is disabled.
8Pulse Plug-in Programmer Manual
Syntax and commands
PULSe:COMPile:SEQuenc
This command sets or queries the state (enabled or disabled) of create sequence at
the end of the compile. If the sequence status is off, then each pulse train is
e
created as one single waveform.
Conditions. The instrument must have sequencing available to enable creating
sequences.
Group. Pulse Compile
Syntax. Pulse:COMPile:SEQuence {0 | 1 | OFF | ON}
Pulse:COMPile:SEQuence?
Group. Pulse Compile
Arguments . ON or 1 enables create sequence state.
Arguments. <pulse_width> = {NRf} where the values of {NRf} varies from
200e-12 to 1.
Returns. {NRf}
Example. PULSe:FRAMe:PSETup:WIDTh:VALue 1e-6, sets the pulse width to
1 usec.
PULSe:FRAMe:PSETup:WIDTh:VALue? might return 2e-6, which indicates the
pulse width is 2 usec.
This command creates and adds the pulse train name to the pulse train list. The
pulse train is created by using the default settings and is added at the end of the
existing list of pulse trains. The pulse train list contains a maximum of 10 pulse
train definitions.
Syntax. PULSe:PTRain:ADD [<pulse_train_name>]
PULSe:PTRain:AMPLitude
Group. Pulse Train
Arguments. <pulse_train_name> := <string>
Returns. NA
Example. PULSe:PTRain:ADD Sim_1, adds a new pulse train name Sim_1 to the
pulse train list.
This command sets or queries the peak to peak amplitude of the selected pulse
train.