SCPI - OXYGEN Remote Control

Technical Reference Manual

Contents

• Introduction
  • Scope
  • Conventions and Structure
  • Related Documents
• Document History
• Syntax Conventions
  • SCPI Message Structure
  • Parameter And Response Types
• SCPI with OXYGEN
  • Setup OXYGEN Measurement Software for SCPI use
• Common Commands
  • *IDN?
  • *VER?
  • *CLS
  • *ESE
  • *ESE?
  • *ESR?
  • *OPC
  • *OPC?
  • *RST
  • *SRE
  • *SRE?
  • *STB?
  • *TST?
  • *WAI
• Application Control
  • Setup
    • :SETup:LOAD
    • :SETup:APPLY “XML-String”
    • :SETup:SAVE “Path”
    • :SETup:READ?
    • : SETup:NAMe?
    • :SETup:ASync:LOAD “Path”
    • :SETup:ASync:STATe?
  • UI Control
    • :SYSTem:DATE?
    • :SYSTem:KLOCK {ON|OFF}
    • :SYSTem:KLOCK?
    • :SYSTem:TIME?
    • :SYSTem:TZONE?
    • :COMMunicate:HEADer {ON|OFF}
    • :COMMunicate:HEADer?
    • :COMMunicate:VERBose {ON|OFF}
    • :COMMunicate:VERBose?
• Acquisition Control
  • :ACQUisition:STARt
  • :ACQUisition:STOP
  • :ACQUisition:RESTARt
  • :ACQUisition:STATe?
• Recording Control
  • :STORe:FILE:NAME “PATH”
  • :STORe:FILE:NAME?
  • :STORe:STARt
  • :STORe:PAUSE
  • :STORe:STOP
  • :STORe:STATe?
  • WAVEform access
  • :STORe:WAVEform:MODE?
  • :STORe:WAVEform:MODE {Continuous | Eventbased | Disabled}
  • :STORe:WAVEform:CONTinuous
  • :STORe:WAVEform:EVENtbased
  • STORe:WAVEform:DISabled
  • :STORe:WAVEform:PREtime?
  • :STORe:WAVEform:PREtime {ON|OFF|<Nrf>} | {{ON|OFF},<Nrf>}
  • :STORe:WAVEform:PAFTer?
  • :STORe:WAVE:PAFTer {ON|OFF|<Nrf>} | {{ON|OFF},<Nrf>}
  • :STORe:WAVEform:POSTtime?
  • :STORe:WAVEform:POSTtime {ON|OFF|<Nrf>} | {{ON|OFF},<Nrf>}
  • :STORe:STATIstics?
  • :STORe:STATIstics {ON|OFF|<Nrf>} | {{ON|OFF},<Nrf>}
  • :STORe:AUTOStart?
  • :STORe:AUTOStart <Boolean>
  • :STORe:RACQuisition?
  • :STORe:RACQuisition <Boolean>
  • :STORe:SAFTer?
  • :STORe:SAFTer {ON|OFF|<Nrf>} | {{ON|OFF},<Nrf>}
  • :STORe:ADVanced?
  • :STORe:ADVanced <Boolean>
• Channel List Access
  • :CHANNELlist:NAMes?
  • :CHANNELlist:IDs?
  • :CHANNELlist:ITEM<ChannelID> subsystem
  • :CHANNELlist:ITEM<ChannelID>:ATTR
  • :CHANNELlist:ITEM<ChannelID>:ATTR:NAMes?
  • :CHANNELlist:ITEM<ChannelID>:ATTR:VAL?
  • :CHANNELlist:ITEM<ChannelID>:STATe:GET?
  • :CHANNELlist:ITEM<ChannelID>:STATe:DETAils?
  • :CHANNELlist:ITEM<ChannelID>:REMove
  • :CHANNELlist:ADDchannel?
  • :CHANNELlist:PROPerty?
  • :CHANNELlist:PROPerty
  • :CHANNELlist:CONSTRaint?
  • :CHANNELlist:TIMing:HIGHest?
  • :CHANNELlist:TIMing:LOWest?
  • :CHANNELlist:SATuration:VALue?
  • :CHANNELlist:SATuration:RESet
  • :CHANNELlist:FIResponse
  • Channel Actions
  • :CHANNELlist:ITEM<ChannelID>:ACTion:<action>:AVAil?
  • :CHANNELlist:ITEM<ChannelID>:ACTion:<action>:EXEc
  • CHANNELlist:ACTion:<action>:AVAil? <channelname_or_id>[,<channelname_or_id>[,..]]
  • CHANNELlist:ACTion:<action>:EXEc <channelname_or_id>[,<channelname_or_id>[,…]]
• Measurement Values
  • :RATE {<num>[<unit>]|NONE}
  • :RATE?
  • :NUMeric:NORMal:ITEMS <channel>[,<channel>[,…]]
  • :NUMeric:NORMal:ITEMS?
  • :NUMeric:NORMAL:ITEM<x> <channel>
  • :NUMeric:NORMal:ITEM<x>?
  • :NUMeric:NORMal:CLEar {ALL|<NUM>[,<NUM>]}
  • :NUMeric:NORMal:DELete <NUM>[,<NUM>]
  • :NUMeric:NORMal:NUMber {<num>|ALL}
  • :NUMeric:NORMal:NUMber?
  • :NUMeric:NORMal:DIM<x> { <i_max> | <i_list> | MAX }
  • :NUMeric:NORMal:DIM<x>?
  • :NUMeric:NORMal:DIMS?
  • :NUMeric:NORMal:FORMat {ASCII|BIN_INTEL|BIN_MOTOROLA}
  • :NUMeric:NORMal:FORMat?
  • :NUMeric:NORMal:VALue? [<NUM>]
• External Data Logging (ELOG)
  • :ELOG:ITEMs <channel>[,<channel>[,…]]
  • :ELOG:ITEMs?
  • :ELOG:PERiod <Duration>
  • :ELOG:PERiod?
  • :ELOG:CALCulations {AVG|MIN|MAX|RMS}
  • :ELOG:CALCulations?
  • :ELOG:PERiod?
  • :ELOG:FORMat {ASCII|BIN_INTEL|BIN_MOTOROLA}
  • :ELOG:FORMat?
  • :ELOG:TIMestamp {OFF|REL|ABS|ELOG}
  • :ELOG:TIMestamp?
  • :ELOG:STARt
  • :ELOG:FETCh? [<NUM>]
  • :ELOG:STOP
  • :ELOG:RESet
  • :ELOG:STATe?
• Data Streaming (DSTREAM)
  • :DSTream:ITEMs[<GRP>] <channel>[,<channel>[,…]]
  • :DSTream:ITEMs[<GRP>]?
  • :DSTream:PORT[<GRP>] <PORT>
  • :DSTream:PORT[<GRP>]?
  • :DSTream:INIT [<GRP> | ALL]
  • :DSTream:STARt [<GRP> | ALL]
  • :DSTream:STOP [<GRP> | ALL]
  • :DSTream:DELete [<GRP> | ALL]
  • : DSTream:RESet
  • : DSTream:STATe[<GRP>]?
  • : DSTream:TRIG[<GRP>] {ON|OFF}
  • : DSTream:TRIG[<GRP>]?
  • :DSTream:REPLAY[<GRP>] {LIVE | BULK}
  • : DSTream:REPLAY[<GRP>]?
  • :DSTream:INTERVAL[<GRP>] <INTV>
  • : DSTream:INTERVAL[<GRP>]?
  • : DSTream:STARTTIME <TIME>
  • : DSTream:STARTTIME?
• EXPORT Commands
  • :EXPort:DIRectory
  • :EXPort:DIRectory “path”
  • :EXPort:AUTO?
  • :EXPort:AUTO {ON|OFF}
  • :EXPort:ITEMS Commands and Queries
  • :EXPort:ITEMS[:LIST]?
  • :EXPort:ITEMS[:LIST] <channel>[,<channel>[,…]]
  • :EXPort:ITEMS:AVAil?
  • :EXPort:ITEMS:CLEar
  • :EXPort:ITEMS:ADD <channel>[,<channel>[,…]]
  • :EXPort:ITEMS:DELete <channel>[,<channel>[,…]]
• Marker Commands
  • :MARKer:ADD <label>[,<description>|<time>|,<description>,<time>]]
• Synchronisation Queries
  • :SYNC:STATe?
  • :SYNC:ENCLOSURES[:LIST]?
  • :SYNC:ENClosure[<ENR>]:NAME?
  • :SYNC:ENClosure[<ENR>]:SERIal?
  • :SYNC:ENClosure[<ENR>]:NODEName?
  • :SYNC:ENClosure[<GRP>]:IN[<INR>]:MODE?
  • :SYNC:ENClosure[<GRP>]:OUTPUTS[:LIST]?
  • :SYNC:ENClosure[<GRP>]:OUT[<ONR>]:NAME?
  • :SYNC:ENClosure[<GRP>]:OUT[<ONR>]:CONNector?
  • :SYNC:ENClosure[<GRP>]:OUT[<ONR>]:MODE?
• Measurement Screen Commands
  • :SCReen:COUNt?
  • :SCReen:ADD
  • :SCReen:SELect?
  • :SCReen:ITEM<screen_number>:SELect
  • :SCReen:SAVE “PATH”
  • :SCReen:ITEM<screen_number>:SAVE “PATH”
    • Screen Instrument Subsystem
  • SCReen:ITEM<screen_nr>:INSTRuments:COUNt?
  • :SCReen:ITEM<screen_number>:INSTRuments:GET?
  • :SCReen:ITEM<screen_number>:INSTRuments:ITEM<instrument_number>:IDEntifier?
  • :SCReen:ITEM<screen_number>:INSTRuments:ADD [<type>[,<identification>[,<x-position>,<y-position>]]]
  • :SCReen:ITEM<screen_number>:INSTRuments:SELect?
  • :SCReen:ITEM<screen_nr>:INSTRuments:SELect [<integer> | <literal>]
    • Screen Output Instrument Subsystem
  • :SCReen:INSTRuments:OUTputchannel:STARt (deprecated)
  • :SCReen:INSTRuments:OUTputchannel:PAUSE (deprecated)
  • :SCReen:INSTRuments:OUTputchannel:STOP (deprecated)
  • :SCReen:INSTRuments:OUTputchannel:STATe? (deprecated)
• Instruments Commands and Queries
  • Identification of an instrument
    • Common Instrument Commands and Queries
  • :INSTRuments:IDEntifier <old_identifier>,<literal>,<new_identifier>
  • :INSTRuments:POSition? <instrument_identifier>
  • :INSTRuments:POSition <instrument_identifier>,<literal>,<x_position>,<y_position>
  • :INSTRuments:SIZe:WIDth? <instrument_identifier>
  • :INSTRuments:SIZe:WIDth <instrument_identifier>,<literal>,<width>
  • :INSTRuments:SIZe:HEIght? <instrument_identifier>
  • :INSTRuments:SIZe:HEIght <instrument_identifier>,<literal>,<height>
  • Subsystems of Oxygen instruments
    • Instrument Channels Subsystem
  • :INSTRuments:CHANnels:COUNt? <instrument_identifier>
  • :INSTRuments:CHANnels:IDs? <instrument_identifier>
  • :INSTRuments:CHANnels:IDs <instrument_identifier>,[<literal>],<String>[,<String>[,…]]
  • :INSTRuments:CHANnels:CLEar <instrument_identifier>
  • :INSTRuments:CHANnels:ADD <instrument_identifier>,[<literal>],<String>[,<String>[,…]]
  • :INSTRuments:CHANnels:REMove <instrument_identifier>,[<literal>],<String>[,<String>[,…]]
  • :INSTRuments:CHANnels:SELect? <instrument_identifier>
  • :INSTRuments:CHANnels:SELect <instrument_identifier>,<literal>,<literal>|<String>
  • :INSTRuments:CHANnels:RESet <instrument_identifier>
    • Instrument Axis Subsystem
  • :INSTRuments:X:DURation? <instrument_identifier>
  • :INSTRuments:X:DURation <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:X:STARt? <instrument_identifier>
  • :INSTRuments:X:STARt <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:X:FULL <instrument_identifier>
  • :INSTRuments:Y:AUTO? <instrument_identifier>
  • :INSTRuments:Y:AUTO <instrument_identifier>,<literal>,<literal>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:NAME? <instrument_identifier>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:MIN? <instrument_identifier>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:MIN <instrument_identifier>,<literal>,<nrf>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:MAX? <instrument_identifier>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:MAX <instrument_identifier>,<literal>,<nrf>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:DIVisions? <instrument_identifier>
  • :INSTRuments:Y:ITEM<y_axis_item_no>:DIVisions <instrument_identifier>,<literal>,<int>
    • Instrument Cursors Subsystem
  • :INSTRuments:CURSors:ENABle? <instrument_identifier>
  • :INSTRuments:CURSors:ENABle <instrument_identifier>,<literal>,<literal>
  • :INSTRuments:CURSors:A? <instrument_identifier>
  • :INSTRuments:CURsors:A <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:CURSors:B? <instrument_identifier>
  • :INSTRuments:CURsors:B <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:CURSors:<statistics>? <instrument_identifier>
  • :INSTRuments:CURSors:[AVG | FREQuency | INTEgral | MAX | MIN | PEAK | RMS | SLOPE] <instrument_identifier>,<literal>,<literal>
  • :INSTRuments:CURSors:AABB? <instrument_identifier>
  • :INSTRuments:CURSors:AABB <instrument_identifier>,<literal>,<literal>
  • :INSTRuments:CURSors:AA? <instrument_identifier>
  • :INSTRuments:CURsors:AA <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:CURSors:BB? <instrument_identifier>
  • :INSTRuments:CURsors:BB <instrument_identifier>,<literal>,<seconds>
  • :INSTRuments:CURSors:COLumns? <instrument_identifier>
  • :INSTRuments:CURSors:COLumns <instrument_identifier>,<literal>,<int>
  • :INSTRuments:CURSors:VALues<line_number>? <instrument_identifier>
    • Output Instrument Subsystem
  • :INSTRuments:OUTputchannel:STATe? <instrument_identifier>
  • :INSTRuments:OUTputchannel:STARt <instrument_identifier>
  • :INSTRuments:OUTputchannel:PAUSE <instrument_identifier>
  • :INSTRuments:OUTputchannel:STOP <instrument_identifier>
• Measurement Report Commands
  • :REPort:SAVE[:ALL] “PATH”
  • :REPort:ITEM<PageNumber>:SAVE “PATH”
• Measurement Header Data
  • :HEADer:ADD <key>,<description>
  • :HEADer:GET? <key>
  • :HEADer:KEYs?
  • :HEADer:SET <key>,<description>
  • :HEADer:DELete <key>[,<key>[,…]]
  • :HEADer:VALues?
• Utility Commands
  • :SYSTem:VERSion?
  • :SYSTem:HELP:HEADers?
• Trigger Events
  • :TRIGger[:GET]?
  • :TRIGger:RESet
  • :TRIGger:ADDevent
  • :TRIGger:EVent<context> Commands and Queries
  • :TRIGger:EVent<event-number>[:SETup]?
  • :TRIGger:EVent<event-number>[:SETup] {<String>} | {{ON|OFF},<String>}
  • :TRIGger:EVent<event-number>:VALId?
  • :TRIGger:EVent<event-number>:DELete
  • :TRIGger:EVent<event-number>:ADDCondition
  • :TRIGger:EVent<event-number>:ADDAction
  • :TRIGger:EVent<event-number>:CONDition<condition-number>:GET?
  • :TRIGger:EVent<event-number>:CONDition<condition-number>:VALId?
  • :TRIGger:EVent<event-number>:CONDition<condition-number>:DELete
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :HIGHlevel:SETup<nrf>,<literal>|<nrf>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :LOWlevel:SETup<nrf>,<literal>|<nrf>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :INwindow:SETup<nrf>,<nrf>,<literal>|<nrf>,<literal>|<nrf>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :OUTwindow:SETup<nrf>,<nrf>,<literal>|<nrf>,<literal>|<nrf>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :KEYBoard:SETup
  • :TRIGger:EVent<event-number>:CONDition<condition-number> :TIME:SETup
  • :TRIGger:EVent<event-number>:ACTion<action-number>:GET?
  • :TRIGger:EVent<event-number>:ACTion<action-number>:VALId?
  • :TRIGger:EVent<event-number>:ACTion<action-number>:DELete
  • :TRIGger:EVent<event-number>:ACTion<action-number>:RECording :SETup<literal>
  • :TRIGger:EVent<event-number>:ACTion<action-number>:DIGOut :SETup<literal>|<nrf>,<literal|<nrf>,<literal>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:ACTion<action-number>:ALARm:SETup <literal>,<literal>|<nrf>,<literal|<nrf>,<literal>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:ACTion<action-number>:MARKer:SETup <String>,<literal>
  • :TRIGger:EVent<event-number>:ACTion<action-number>:SNAPshot:SETup <literal>,<nrf>,<String>[,<String>[,…]]
  • :TRIGger:EVent<event-number>:ACTion<action-number>:ARM:SETup <literal>
• Analysis Control
  • :ANAlysis:ACTIve?
  • :ANAlysis:OPEN <file_name>|<path>[,<file_name>|<path>[,…]]
  • :ANAlysis:CLOSe
  • :ANAlysis:FILES?
  • :ANAlysis:CURsor?
  • :ANAlysis:CURsor <literal>,<seconds>
• Error Handling
  • :SYSTem:ERRor[:NEXT]?
  • :SYSTem:ERRor:ALL?
  • :SYSTem:ERRor:CODE[:NEXT]?
  • :SYSTem:ERRor:CODE:ALL?
  • :SYSTem:ERRor:COUNt?
  • :SYSTem:ERRor:ENABle:ADD (<num>:<num>)
  • :SYSTem:ERRor:ENABle:DELete (<num>:<num>)
  • :SYSTem:ERRor:ENABle[:LIST]?
• Error Codes
• EXAMPLES
  • Fetch Online Measurement Data
  • Store Measurement Data on Device
  • Set Channel Properties
    • Set a bool Item example
    • Set a string Item example
    • Set a floating point Item example
    • Set an enum item example
    • Set scalar item example
    • Set range item example
    • Change sample rate with the sample rate divider example