Online documentation, manuals and tutorials
< All Topics
Print

12. SCPI commands summary

 

Common command

Description

*CLS

Clears all status data structures

*ESE {<value>}

Programs the Standard Event Status Enable register bits

*ESR?

Reads the Standard Event Status Register

*IDN?

Returns the UNIQUE identification of the BB3

*OPC

Operation Complete Command used for program synchronization

*RCL {<profile>}

Recalls the BB3 state stored in the specified storage location

*RST

Reset BB3 to the initial state

*SAV {<profile>}

Stores the current BB3 state in the specified storage location

*STB?

Reads the Status Byte register

*TRG

Generates a software trigger

*TST?

Returns Self-Test results

*WAI

Waits until all pending commands are completed

 

SCPI Command

Description

ABORt

Resets the trigger system to the Idle state

:DLOG

Stops the internal data logging session

CALibrate[:MODE] {<bool>, <password>}

Enables/disables calibration mode

:CLEar {<password>}

Clears all calibration parameters

:CURRent

 

[:DATA] {<new value>}

Enters the calibration value

:LEVel {<level>}

Calibrates the output current programming

:MEASure?

Initiates current calibration measurement

:RANGe {<range>}

Sets current range for multiple current range model

:PASSword

 

:NEW {<old>, <new>}

Changes calibration password

:REMark {<string>}

Saves calibration information

:SAVE

Saves the new cal constants in non-volatile memory

:STATe {<bool>, <password>}

Enables calibration parameters

:VOLTage

 

[:DATA] {<new value>}

Enters the calibration value

:LEVel {<level>}

Calibrates the output voltage programming

:MEASure?

Initiates voltage calibration measurement

DIAGnostic

 

[:INFOrmation]

 

:ADC?

Returns the latest values acquired by ADC

:CALibration?

Returns a list of the calibration parameters

:FAN?

Returns status of the cooling fan.

:PROTection?

Returns the information about all protections.

:TEST?

Returns results of the most recent self-test

DISPlay

 

:BRIGhtness {<value>}

Sets the intensity of the front panel TFT display

:DATA?

Reads screen image data

:VIEW {<mode>}

Sets the front panel TFT display main page appearance

[:WINdow]

 

[:STATe] {<bool>}

Sets the front panel TFT display state

:DLOG

Opens DLOG viewer

[:OPEN] {<filename>}

Displays content of the resource file

:ACTIon? [<timeout>]

Returns information about selected item

:CLOSe

Closes last opened dialog window

:DATA {<name>}, {<type>}, [{<unit>}], {<value>}

Sets the value of the dialog data item

:DLOG [<filename>]

Opens DLOG viewer

:ERRor {<message>}

Displays message box and generates error beep tone

:INPUt? {<label>}, {<type>} [, <min>, <max>, <value>]

Displays entry form and wait for input on the front panel TFT display

:SELect? {<defaultSelection>, {<optionText>}[, …]

Displays pop-up display with multiple radio buttons

:TEXT {<message>}

Displays a message on the front panel TFT display

:CLEar

Clear a message on the front panel TFT display

INITiate

 

[:IMMediate]

Completes one full trigger cycle

:DLOG {<filename>}

Initiates internal data loggging

:TRACe {<filename>}

Initiates internal data logging

:CONTinuous {<bool>}

Enables/disables continuous transient triggers

INSTrument

 

[:SELect] {<channel>}

Selects the output to be programmed

:CATalog?

Returns a quoted string of the list of valid choices for the instrument channels

:FULL?

Returns a list of string – number pairs

:COUPle

 

:TRACking {<type>}

Selects independent, parallel-tracking, or series-tracking mode

:DISPlay

 

:TRACe[<n>] {<value>}

Selects output value on the specified display trace

:SWAP

Swaps positions of selected output values

:YT

 

:RATE {<duration>}

Selects YT view sample duration

:NSELect {<channel>}

Selects the output to be programmed

MEASure

 

:DIGital[:BYTE]? [<channel>]

Takes a measurement; returns digital logic state

[:SCALar]

 

:CURRent

 

[:DC]? [<channel>]

Takes a measurement; returns the average current

:POWer

 

[:DC]? [<channel>]

Takes a measurement; returns the average power

[:VOLTage]

 

[:DC]? [<channel>]

Takes a measurement; returns the average voltage

:TEMPerature

 

[:THERmistor][:DC]? {<chanlist>}

Takes a measurement; returns the average temperature

MEMory

 

:NSTates?

Returns total number of state storage memory locations

:STATe

 

:CATalog?

Lists the names associated with all ten state storage locations

:DELete {<profile>}

Deletes the contents of a state storage location

:ALL

Deletes the contents of all state storage locations

:NAME {<profile>, <name>}

Assigns a custom name to a state storage locations

:RECall

 

:AUTO {<bool>}

Specifies whether the power-down state is recalled from location 0 on power-on

:SELect {<profile>}

Specifies which BB3 state will be used at power on

:VALid? {<profile>}

Determines whether a storage location contains a valid state

MMEMory

 

:CATalog [<directory>]

Returns a list of items in the specified directory (folder)

:LENgth [<directory>]

Returns the number of items in the specified directory

:CDIRectory {<directory>}

Changes the current directory

:COPY {<source>}, {<destination>}

Copies <source> to <destination>

:DATE? {<filename>}

Returns date that the specified file was last saved

:DELete {<filename>}

Deletes an existing file

:DOWNload

 

:ABORt

Aborts current download session

:DATA :DATA {#<length>,<encoding>,<block>}

Downloads data from the host computer

:FNAMe {<filename>}

Creates or opens the specified filename for download data

:SIZE {<filesize>}

Sets information about file size used for progress bar

:LOAD

 

:LIST[<n>] {<filename>}

Loads stored LIST to the specified channel

:PROFile {<filename>}

Loads stored user profile

:STATe {<filename>}

Loads the instrument setup

:LOCK {<password>}

Sets write protection

:MDIRectory {<directory>}

Makes a new directory

:MOVE {<source>}, {<destination>}

Moves or renames <source> to <destination>

:RDIRectory {<directory>}

Removes the specified directory

:STORe

 

:LIST[<n>] {<filename>}

Saves specified channel LIST

:PROFile {<filename>}

Saves specified user profile

:STATe {<filename>}

Saves the instrument setup

:TIME? {<filename>}

Returns time that the specified file was last saved

:UNLock {<password>}

Clears write protection

:UPLoad? {<filename>}

Uploads data to the host computer

OUTPut

 

[:STATe] {<bool>}

Enables the specified output channel(s)

TRIGgered {<bool>} [, <channel>]

Controls channel output state with trigger

:DELay

 

:DURation {<duration>} [, <channel>]

Sets the output start delay duration

:MODE?

Returns the channel mode of operation

:PROTection

 

:CLEar

Resets latched protection

:COUPle {<bool>}

Enables channel coupling for protection faults

:TRACk[:STATe] {<chanlist>}

Defines channels to operate in the tracking mode

ROUTe

 

:CHANnel

 

:LABel {<label>},{<chanlist>}

Sets labels for relay matrix channels

:CLOSe {<chanlist>}

Closes (turns on) specified relay matrix channels

:OPEN {<chanlist>}

Opens (turns off) specified relay matrix channels

SIMUlator

 

:EXIT

Closes simulator

:GUI

Starts simulator’s GUI

:LOAD {<value>}

Sets value of the virtual load

:STATe {<bool>}

“Connects” virtual load to the channel output

:PIN1 {<bool>}

Sets value of the PIN1 input

:PWRGood {<bool>}

Sets the PWRGOOD signal state

:RPOL {<bool>}

Sets the RPOL signal state

:TEMP {<value>}

Sets the temperature sensor value

:VOLT:PROG:EXT {<voltage>}

Sets the output voltage when channel is in external programming mode

SCRipt

 

:RECall {<filename>}

Sets the script to run on the startup

:CONFirmation {<bool>}

Enables/disables startup script confirmation

:RUN {<filename>}

Sets a script to be executed immediately

:STOP

Forcibly stops the currently active script

SENSe

 

:APERture {<period>}

Sets the integration time

:CURRent

 

[:DC]

 

RANGe {<range>} [, <channel>]

Selects a DC current measurement range

:DIGital

 

:RANGe {<pin>}, {<range>}

Set the range of the digital input

:SPEed {<pin>}, {<speed>}

Set the speed of the digital input

:DLOG

 

:CLEar

Resets DLOG settings

:FUNCtion

 

:CURRent {<bool>}, {<channel>}

Enables/disables output current internal data logging

:DIGital

 

[:INPut] {<pin>}, {<enable>}, {<channel>}

Enables/disables digital input internal data logging

:POWer {<bool>}, {<channel>}

Enables/disables output power internal data logging

:VOLTage {<bool>}, {<channel>}

Enables/disables output voltage internal data logging

:PERiod {<time>}

Sets the sample period for internal data logging

:TIME {<time>}

Sets the sample duration for internal data logging

:TRACe

 

[:DATA] {<value>}[, …]

Adds new data into log file

:BOOKmark {<bookmark>}

Adds a bookmark into the active DLOG

:REMark {<user remark>}

Adds user description to the log file

:X

 

:UNIT {<unit>}

Sets DLOG viewer X-axis units

:STEP {<step>}

Sets DLOG viewer X-axis step value

:LABel {<label>}

Sets DLOG viewer X-axis label

[:RANGe]:MIN {<min>}

Sets DLOG viewer X-axis min. value

[:RANGe]:MAX {<max>}

Sets DLOG viewer X-axis max. value

:Y<n>

 

:UNIT {<unit>}

Sets DLOG viewer Y-axis units

:LABel {<label>}

Sets DLOG viewer Y-axis label

[:RANGe]:MIN {<min>}

Sets DLOG viewer Y-axis min. value

[:RANGe]:MAX {<max>}

Sets DLOG viewer Y-axis max. value

:FUNCtion

 

[:ON] {<function>}[, <channel>]

Sets the MIO160 module analog outputs mode

:NPLCycles {<cycles>}

Sets the number of power line cycles (NPLC)

:VOLTage

 

[:DC]

 

:RANGe {<range>} [, <channel>]

Selects a DC voltage measurement range

[SOURce[<n>]]

 

:CURRent

 

[:LEVel]

 

[:IMMediate][:AMPLitude] {<current>}

Sets the output current

:STEP[:INCRement] {<step>}

Sets the step of the current change

:TRIGgered [:AMPLitude] {<current>}

Sets the triggered output current

:FUNCtion

 

:AMPLitude {<amplitude>}

Sets the output current waveform amplitude

:DUTY {<duty>}

Sets the output current waveform duty cycle

:FREQuency {<frequency>}

Sets the output current waveform frequency

:OFFSet {<offset>}

Sets the output current waveform offset

:PHASeshift {<phase>}

Sets the output current waveform phase shift

:SHAPe {<waveform>}

Sets the output current waveform type

:LIMit

 

[:POSitive][:IMMediate][:AMPLitude] {<current>}

Sets the output current limit

:MODE {<mode>}

Sets the current trigger mode

:PROTection

 

:DELay

 

[:TIME] {<time>}

Sets the over-current protection (OCP) programming delay

:STATe {<bool>}

Enables/disables over-current protection on the selected channel

:TRIPped?

Returns status of over-current protection activation

:RAMP:DURation {<duration>}

Sets the output current ramp duration

[:DC]

 

:RANGe {<range>} [, <channel>]

Selects a DC output current range

:DIGital

 

:DATA[:BYTE] {<value>}

Set output states of the digital output channel

:FUNCtion

 

:DUTY {<pin>}, {<duty>}

Sets the digital output waveform duty cycle

:FREQuency {<pin>}, {<frequency>}

Sets the digital output waveform frequency

:PHASeshift {<pin>}, {<phase>}

Sets the digital output waveform phase shift

:SHAPe {<pin>}, {<waveform>}

Sets the digital output waveform type

:MODE {<pin>}, {<mode>}

Sets the digital output trigger mode

:LIST

 

:COUNt

Sets the number of times that the list is executed

:CURRent[:LEVel]

Specifies the current setting for each list step

:DWELl

Specifies the dwell time for each list step

:VOLTage[:LEVel]

Specifies the voltage setting for each list step

:POWer

 

:LIMit {<power>}

Sets the output power limit

:PROTection[:LEVel]

Sets the over-power protection (OPP) level

:DELay

 

[:TIME] {<time>}

Sets the over-power protection programming delay

:STATe {<bool>}

Enables/disables over-power protection on the selected channel

:TRIPped?

Returns status of over-power protection activation

:PWM

 

:DUTY {<duty>}

Sets the duty cycle of the output

:FREQuency {<frequency>}

Sets the frequency of the output

:STATe {<bool>}

Enables/disables PWM

:VOLTage

 

[:LEVel]

 

[:IMMediate][:AMPLitude] {<voltage>}

Sets the output voltage

:STEP[:INCRement] {<step>}

Sets the step of the voltage change

:TRIGgered [:AMPLitude] {<voltage>}

Sets the triggered output voltage

:FUNCtion

 

:AMPLitude {<amplitude>}

Sets the output voltage waveform amplitude

:DUTY {<duty>}

Sets the output voltage waveform duty cycle

:FREQuency {<frequency>}

Sets the output voltage waveform frequency

:OFFSet {<offset>}

Sets the output voltage waveform offset

:PHASeshift {<phase>}

Sets the output voltage waveform phase shift

:SHAPe {<waveform>}

Sets the output voltage waveform type

:LIMit

 

[:POSitive][:IMMediate][:AMPLitude] {<voltage>}

Sets the output voltage limit

:PROGram[:SOURce] {<source>}

Sets voltage programming source

:PROTection[:LEVel]

Sets the over-voltage protection (OVP) level

:DELay

 

[:TIME] {<time>}

Sets the over-voltage protection (OVP) programming delay

:STATe {<bool>}

Enables/disables over-voltage protection on the selected channel

:TRIPped?

Returns status of over-voltage protection activation

:TYPE {<type>}

Selects the over-voltage protection (OVP) type

:RAMP:DURation {<duration>}

Sets the output voltage ramp duration

[:DC]

 

:RANGe {<range>} [, <channel>]

Selects a DC output voltage range

:SENSe[:SOURce] {<source>}

Sets voltage sense inputs source

STATus

 

:OPERation

 

[:EVENt]?

Returns the value of the Operation Event register

:CONDition?

Returns the value of the Operation Instrument Condition register

:ENABle {<value>}

Enables specific bits in the Operation Event register

:INSTrument[<n>]

 

[:EVENt]?

Returns the value of the Operation Instrument Event register

:CONDition?

Returns the value of the Operation Instrument Condition register

:ENABle {<value>}

Enables specific bits in the Operation Instrument Event register

:ISUMmary<n>

 

[:EVENt]?

Returns the value of the Operation Instrument Isummary Event register

:CONDition?

Returns the value of the Operation Instrument Isummary Condition register

:ENABle {<value>}

Enables specific bits in the Operation Instrument Isummary Event register

:PREset

Presets all enable registers to power-on state

:QUEStionable

 

[:EVENt]?

Returns the value of the Questionable Event register

:CONDition?

Returns the value of the Questionable Condition register

:ENABle {<value>}

Enables specific bits in the Questionable Event register

:INSTrument[<n>]

 

[:EVENt]?

Returns the value of the Questionable Instrument Event register

:CONDition?

Returns the value of the Questionable Instrument Condition register

:ENABle {<value>}

Enables specific bits in the Questionable Instrument Event register

:ISUMmary<n>

 

[:EVENt]?

Returns the value of the Questionable Instrument Isummary Event register

:CONDition?

Returns the value of the Questionable Instrument Isummary Condition register

:ENABle {<value>}

Enables specific bits in the Questionable Instrument Isummary Event register

SYSTem

 

:BEEPer[:IMMediate]

Issues a single beep immediately

:STATe {<bool>}

Enables beeper function

:KEY

 

:STATe {<bool>}

Enables click tone for local control

:CAPability?

Returns an <instrument_specifier>

:CHANnel

 

[:COUNt]?

Returns the number of output channels

:INFOrmation

 

:AHOur

 

TOTal?

Returns channel’s total delivered energy in Ah

:CURRent?

Returns output current capability

:ONtime

 

LAST?

Returns time passed after last output enable

TOTal?

Returns channel’s total active time

:POWer?

Returns output power capability

:VOLTage?

Returns output voltage capability

:WHOur

 

TOTal?

Returns channel’s total delivered energy in Wh

:MODel?

Returns the channel model and version name

:SLOT?

Returns the channel slot number

:SNO?

Returns the channel serial number

:VERSion?

Returns the channel version number

:COMMunicate

 

:ENABle {<bool>, <interface>}

Enables the remote interface

:ETHernet

 

:ADDRess {<ip_address>}

Sets the static LAN (IP) address

:DHCP {<bool>}

Enables the use of the Dynamic Host Configuration Protocol (DHCP)

:DNS <ip_address>

Sets the IP address of the DNS server.

:GATEway {<ip_address>}

Sets the IP address of the default gateway

:MAC?

Returns the MAC address

:PORT {<number>}

Sets the port number

:SMASk {<mask>}

Sets the static subnet mask

:NTP {<server>}

Set s NTP service server address

:FREQuency

Sets the frequency of connection to the NTP service

:MQTT

 

:SETTings {<address>, <port>, <user>, <password>, <period>}

Sets MQTT connection parameters

:STATe?

Returns MQTT connection status

:UART

 

:BAUD {<baud>}

Sets UART speed in bits per second

:DATA {<data>}

Sets UART data size in bits

:MODE {<mode>}

Sets UART operation mode

:PARIty {<parity>}

Sets UART partity check

:RECeive?

Receive string via UART

:STOP {<stop>}

Sets UART number of stop bits

:TRANsmit {<string>}

Sends string via UART

:USB

 

:CLAss {<usb_class>}

Sets USB class

:MODE {<usb_mode>}

Sets USB mode

:RLSTate {<state>}

Places the instrument in remote or local mode

:CPU

 

:FIRMware?

Returns BB3 firmware version

:INFOrmation

 

:ONtime

 

LAST?

Returns time passed after last power on

TOTal?

Returns BB3’s total active time

:TYPE?

Returns the type of CPU

:MODel?

Returns the control board model name

:SNO?

Returns the BB3 serial number

:VERSion?

Returns the channel version number

:DATE {<yyyy>,<mm>,<dd>}

Sets the date of the system clock

:DIGital

 

:INPut:DATA? [<pin>]

Reads the state of the digital port pins

:OUTPut

 

:DATA {<pin>}, {<state>}

Sets the state of the digital port pins

:PWM

 

:DUTY {<pin>}, {<duty>}

Sets square wave generator duty cycle

:FREQuency {<pin>}, {<duty>}

Sets square wave generator frequency

:PIN<n>

 

:FUNCtion {<function>}

Sets the selected pin’s function

:POLarity {<polarity>}

Sets the selected pin’s polarity

:ERRor

 

[:NEXT]?

Queries and clears errors from the error queue

:COUNt?

Queries the error/event queue for the number of unread items

:FAN

 

:SPEed

Returns speed of the cooling fan

:STATus

Returns status of the cooling fan

:FORMat

 

:DATE

Sets format for displaying date

:TIME

Sets 12h or 24h clock format

:INHibit?

Queries system inhibit state

:KEY

 

:DEFine {<key>, <block>}

Sets the definition of the key

:DELete {<key>}

Removes the definition of the key

:KLOCk

Disables front panel [lock/unlock] icon

:LFRequency {<frequency>}

Sets the AC mains frequency

:LOCal

Places the BB3 in the local mode

:MEASure

 

[:SCALar]

 

:TEMPerature

 

[:DC]? {<sensor>}

Takes a measurement; returns the average temperature

[:VOLTage]

 

[:DC]? {<device>}

Takes a voltage measurement of the RTC battery

:PASSword

 

:CALibration

 

:RESet

Resets the calibration password to initial value

:FPANel

 

:RESet

Resets the front panel lock password to initial value

:NEW {<old>, <new>}

Changes system password

:PON:OUTPut:DISable {<bool>}

Sets output state on power up

:POWer {<bool>}

Enters the BB3 into the standby mode

:PROTection:TRIP {<bool>}

Enters the BB3 into the standby mode in case of protection trip

:RELay:CYCLes? {<chanlist>}

Returns the cycle count on the specified channels

:REMote

Places the BB3 in the remote mode

:RWLock

Places the BB3 in the remote mode and disables front panel [lock/unlock] icon

:SLOT

 

[:COUNt]?

Returns the number of available slots

:COLor {<slot>}, {<color>}

Sets module color

:FIRMware? {<slot>}

Returns module firmware version

:LABel {<slot>}, {<label>}

Sets module label name

:MODel? {<slot>}

Returns the module model name

:SNO? {<slot>}, {<sno>}

Returns the module serial number

:STATe {<slot>}, {<bool>}

Enables/disables module on selected slot

:VERSion? {<slot>}

Returns module version number

:TEMPerature

 

:PROTection

 

[:HIGH]

 

[:LEVel] {<temperature>[, <sensor>]}

Sets the OTP value

:CLEar [, {<sensor>}]

Clears the latched protection status of the over-temperature protection (OTP)

:DELay

Sets time-out period

[:TIME] {<delay>[, <sensor>]}

Sets the OTP programming delay

:STATe {<bool>[, <sensor>]}

Enables/disables OTP on the selected temperature sensor

:TRIPped? [<sensor>]

Returns status of OTP activation

:TIME {<hh>,<mm>,<ss>}

Sets the time of the system clock

:DTS {rules}

Defines daylight saving time (DST) rules

:ZONE {zone}

Defines time zone

:VERSion?

Returns the SCPI version number

TRIGger

 

[:SEQuence]

 

[:IMMediate]

 

:DELay {<delay>}

Sets the time delay between the detection of a trigger event and the start of any corresponding trigger action

:EXIT

 

:CONDition {<condition}

Sets channel’s condition when LIST execution stopped

:SOURce {<source>}

Sets the trigger source

:DLOG

 

[:IMMediate]

 

:SOURce {<source>}

Sets the internal data logger trigger source

 

 

Page content