Remote Spectrum Monitor User Guide : SCPI Commands :
 
 
:DIAGnostic:MEMory?
Title:
Used Memory
Description:
This command returns the total memory available on the instrument, the free memory, and the memory used by the backend process in kB. If the instrument runs into an error while retrieving system memory data, "nan,nan,nan" will be returned as the response and a "-100" (SCPI command error) will be placed in the SCPI error queue.
:FETCh:GPS?
Title:
Basic GPS Information
Description:
This command returns the timestamp, latitude, and longitude of the device. The response is a comma-delimited ASCII response of one of the following forms:
NO FIX
or
GOOD FIX,<timestamp>,<latitude>,<longitude>
If no GPS fix is currently available, the first response form (NO FIX) is returned.
If the GPS does have a fix, the second response form (GOOD FIX) is returned.
<timestamp> is in ISO8601 format. The timestamp provides the 24-hour time, and will include the year/date and/or UTC offset if the hardware supports it. If no UTC offset is provided, the time is in UTC time.
<latitude> and <longitude> are specified in decimal degrees.
:FETCh:GPS:FULL?
Title:
Full GPS Information
Description:
This command returns the timestamp, latitude, longitude, altitude, and satellite count of the device. The response is a comma-delimited ASCII response of one of the following forms:
NO FIX
or
GOOD FIX,<timestamp>,<latitude>,<longitude>,<altitude>,<satellites>
If no GPS fix is currently available, the first response form (NO FIX) is returned.
If the GPS does have a fix, the second response form (GOOD FIX) is returned.
<timestamp> is in ISO8601 format. The timestamp provides the 24-hour time, and will include the year/date and/or UTC offset if the hardware supports it. If no UTC offset is provided, the time is in UTC time.
<latitude> and <longitude> are specified in decimal degrees.
<altitude> specifies the current altitude relative to mean sea level, in meters.
<satellites> specifies an integer count of the number of satellites currently used
in the fix.
:FETCh:GPS:LAST?
Title:
Last GPS Fix
Description:
This command returns the timestamp, latitude, longitude, and altitude of the last fixed GPS result. The response is a comma-delimited ASCII response of one of the following forms:
NO FIX
or
GOOD FIX,<timestamp>,<latitude>,<longitude>,<altitude>
If a GPS fix has never been acquired, the first response form (NO FIX) is returned.
If a GPS fix was previously acquired, the second response form (GOOD FIX) is returned.
<timestamp> is in ISO8601 format. The timestamp provides the 24-hour time, and will include the year/date and/or UTC offset if the hardware supports it. If no UTC offset is provided, the time is in UTC time.
<latitude> and <longitude> are specified in decimal degrees.
<altitude> specifies the current altitude relative to mean sea level, in meters.
:INSTrument:APPLication:STATe <SPA>,<0 | 1 | ON | OFF>
Title:
Activate or Deactivate Application
Description:
This command turns the specified application ON or OFF. When an application is turned ON (i.e. activated), it is loaded into memory and can be used to make measurements. An application must be activated before it will respond to commands. When an application is turned OFF (i.e. deactivated), any measurements it is making are stopped and it is unloaded from memory. Attempting to turn ON the same application twice or turn OFF an application that is not currently ON is not permitted and will result in an execution error (-200).
Unlike INSTrument:SELect, which selects a given application and makes it active if it is not already active, this command can be used to activate an application without selecting it.
If the requested application is the selected application (which can be queried with INSTrument:SELect?), turning it OFF will cause the current application selection to automatically change to whatever active application, of those remaining, was turned ON last. For example, consider an instrument with Spectrum Analyzer, VNA, and Power Meter applications available. After the following compound command sequence
INST:SEL "spa"; APPL:STAT "vna" ON; APPL:STAT "pm" ON; APPL:STAT "spa" OFF
the currently selected application will be "pm".
If the last active application is turned OFF, the current application selection will be reported as NONE via INSTrument:SELect?.
This command takes two parameters. The first parameter is a string value that specifies which application should be turned ON or OFF. The permitted values of this parameter are the same as those used by the INSTrument:SELect command. The second parameter is a Boolean value that specifies whether the application should be turned ON or OFF.
After a reset, the default selected application is always active, and all other applications are inactive.
Parameter(s):
<SPA>,<0 | 1 | ON | OFF>
:INSTrument:CATalog:ACTive?
Title:
List Active Applications
Description:
This command queries all active applications. The response is returned as a comma delimeted list of application names. The application names are the same as those returned by the INSTrument:CATalog:FULL? query or used as parameters to the INSTrument:SELect command.
If no applications are currently active, this query will return NONE.
:INSTrument:CATalog:FULL?
Title:
Query Available Modes
Description:
This query returns a list of string - number pairs. The string contains the name of the available application. The immediately following NR1-formatted number is its associated application number. All response data elements are comma separated. If no application is available, a null string followed by a zero is returned.
:INSTrument:NSELect <numeric_value>
:INSTrument:NSELect?
Title:
Select Mode by Number
Description:
Sets the selected application based on the value of <integer>. The query version returns the number associated with the current application. The list of valid integers and the applications they correspond to can be queried with INSTrument:CATalog:FULL?
If no applications are active, the query version of this command will return 0.
Parameter(s):
<numeric_value>
:INSTrument[:SELect] <SPA>
:INSTrument[:SELect]?
Title:
Select Mode by Name
Description:
Sets the selected application based on the application name specified by <identifier>. The <identifier> is a valid application name (character data). The list of valid application names can be queried with INSTrument:CATalog:FULL?
The query version returns the name of the current application.
If no applications are active, the query version of this command will return NONE.
Parameter(s):
<SPA>
:MMEMory:CATalog:DIRectory? <string>,<string>
Title:
Memory Catalog Directory
Description:
Returns the non-recursive contents of the memory specified by the MSUS and DIRECTORY parameters. Both parameters are case sensitive.
Parameter 1: Directory. Use "/" as a directory separator. Note that this parameter should NOT be an empty string. To access the root directory, pass in "/" as the first parameter.
Parameter 2: MSUS (Use :MMEMory:CATalog:MSUSs query command to retrieve the list of available storage devices).
The response is formated as follows:
<total space used on MSUS>,<total space available on MSUS>,{<file entry1>},..{<file entryN>}
where <file entry> is:
<file or directory name>,<file type>,<file size>
Parameter(s):
<string>,<string>
:MMEMory:CATalog:MSUSs?
Title:
Memory Catalog Msuss
Description:
Returns a list of all available mass storage devices present, formated as follows: <Device Name 1>,<Device Name 2>,...<Device Name N>
:MMEMory:CDIRectory <string>
:MMEMory:CDIRectory?
Title:
Default Mass Storage Directory
Description:
This command selects the default directory on the default mass storage device (see :MMEMory:MSIS) for use with MMEMory commands. The parameter is case sensitive. Use "/" as a directory separator. The set command will fail and an error is reported if the requested directory does not exist. Note that the query command returns the name of the default directory that was previously set and the device does not check whether the directory is still present.
Parameter(s):
<string>
Default Value:
/
:MMEMory:COPY <string>,<string>,<string>,<string>
Title:
Copy File
Description:
This command copies the specified source file into a new file located at the specified destination location. Four parameters are required for this command:
1. Source File Location: The file path to the file to be copied.
2. Source MSUS: The mass storage device the file is located in (i.e. Internal).
3. Destination File Location: The destination file path that the file should be copied to.
4. Destination MSUS: The mass storage device that the destination file should be written to (i.e. Internal).
Please note that if a file already exists at the destination location or if the source file does not exist, the command will fail to execute and add an execution error into the SCPI error queue. This command will only copy files. If a directory path is passed in as a parameter, the command will fail to execute.
Parameter(s):
<string>,<string>,<string>,<string>
:MMEMory:CREate:DIRectory <string>,<string>
Title:
Create Directory
Description:
Creates a directory at the specified mass storage device. Both parameters are case sensitive.
Parameter 1: Directory. Use "/" as a directory separator.
Parameter 2: MSUS (Use :MMEMory:CATalog:MSUSs query command to retrieve the list of available storage devices)
If the intermediate directories in the path don't exist, the command will automatically create them. Common causes of the command failure are:
- The MSUS device is not present (Use :MMEMory:CATalog:MSUSs query command to retrieve the list of available storage devices)
- The total space available on MSUS device is not big enough (Use :MMEMory:CATalog:DIRectory query command to retrieve the total space available on MSUS)
Parameter(s):
<string>,<string>
:MMEMory:DATA <string>,<string>,<block data>
:MMEMory:DATA? <string>,<string>
Title:
File Transfer
Description:
This command imports/exports a file to/from the instrument. Data is transferred to/from the instrument as an IEEE definite length arbitrary block response, which has the form <header><block>.
This set command takes three parameters.
1. File Path: The path of the file to be written
2. Msus: The mass storage device to write the file to
3. Block Data: The datato be written to the instrument in block data format
If any directories in the file path do not exist, the isntrument will automatically create the required directories. Please note that the maximum file transfer size to the instrument is 25 MB.
The ASCII header specifies the number of data bytes of the file. It looks like #AX, where A is the number of digits in X and X is the number of bytes in the <block>. The first character is the literal ascii hash '#' 043. The second character (A) is a single ascii digit '1' to '9' describing the number of bytes in the length section (X). This number is called nlength. The next nlength bytes make up an ascii string of digits '1' to '9' describing the length of the <block> data.
For example, if the first 6 bytes are #49999, then the nlength is 4. The 4 bytes of length are 9999. After that follows the <block>, which would be 9999 bytes in size.
The query command takes two parameters.
1. File Path: The path to the file to be retrieved.
2. Msus: The mass storage device to retrieve the file from.
The file is returned in block data format with an ASCII header The query command will return a #10 if the file cannot be found.
Set Command Parameter(s):
<string>,<string>,<block data>
Query Command Parameter(s):
<string>,<string>
:MMEMory:DELete:DIRectory <string>,<string>
Title:
Delete Directory
Description:
Deletes the specified directory and all its content at the specified mass storage device. The two paramters for this command are directory name and mass storage device. Both parameters are case sensitive. Use "/" as a directory separator. To delete the root folder in a specified mass storage device, enter "/" for directory name parameter. The available mass storage devices can be retrieved by using the :MMEMory:CATalog:MSUSs command. The command will fail if the directory doesn't exist or the mass storage device is not present.
Parameter(s):
<string>,<string>
:MMEMory:DELete:FILe <string>,<string>
Title:
Delete File
Description:
Deletes the specified file at the specified mass storage device. The two parameters for this command are file name with relative path and mass storage device. Both parameters are case sensitive. Use "/" as a directory separator. The available mass storage devices can be retrieved by the :MMEMory:CATalog:MSUSs command. The command will fail if the file doesn't exist or the mass storage device is not present.
Parameter(s):
<string>,<string>
:MMEMory:LOAD:STATe <numeric_value>,<string>,<string>
Title:
Load State
Description:
This command recalls the specified setup. The file location is resolved using the MSUS and file path parameters. These parameters are case sensitive. Parameters:
1. Numeric Value: currently unused. Send a 0.
2. File path: The file path (including file name) relative to the MSUS root directory. File extension is optional.
3. MSUS: Device to recall the file from. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices.
The model of the device that the setup was created in must match the model of the device to recall in; otherwise, the recall will be rejected. The options of the device that the setup was created in must be enabled in the device to recall in; otherwise, the recall will be rejected.
Parameter(s):
<numeric_value>,<string>,<string>
:MMEMory:LOAD:TRACe <string>,<string>,<string>
Title:
Load Trace
Description:
This command recalls the specified measurement. The file location is resolved using the MSUS and file path parameters. These parameters are case sensitive. Parameters:
1. Label: Used to specify which trace to recall. Currently, the label only supports recalling all traces. Send an empty string or "ALL" to load all traces.
2. File path: The file path (including file name) relative to the MSUS root directory. File extension is optional.
3. MSUS: Device to recall the file from. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices.
The model of the device that the measurement was saved in must match the model of the device to recall in; otherwise, the recall will be rejected. The options of the device that the measurement was saved in must be enabled in the device to recall in; otherwise, the recall will be rejected.
Parameter(s):
<string>,<string>,<string>
:MMEMory:LOAD:TRACe:EXIT <LOADprevious|KEEPcurrent>
Title:
Exit Recall State
Description:
This command exits recall state if the instrument currently has a measurement file recalled. An enumerable parameter is accepted to determine whether to revert back to the setup prior to recalling a measurement (LOADprevious) or to keep the setup from the measurement file (KEEPcurrent).
Parameter(s):
<LOADprevious|KEEPcurrent>
:MMEMory:LOAD:TRACe:STATus?
Title:
Get Recall State Status
Description:
This command retrieves the status of whether or not the instrument is in a state where a measurement file has been recalled. A return value of 0 means that the instrument is not in a state where a measurement file has been recalled. A return value of 1 means that the instrument has recalled a measurement file and is in a state where SCPI commands are restricted. To exit this state, use the :MMEMory:LOAD:TRACe:EXIT SCPI command.
:MMEMory:MSIS <string>
:MMEMory:MSIS?
Title:
Default Mass Storage Device
Description:
This command selects the default device for use with MMEMory commands. The mass storage device parameter is case sensitive and must match a device returned from the :MMEMory:CATalog:MSUSs? command
Parameter(s):
<string>
Default Value:
Internal
:MMEMory:STORe:STATe <numeric_value>,<string>,<string>
Title:
Store State
Description:
This command saves the current setup to the specified file location. The file location is resolved using the MSUS and file path parameters. These parameters are case sensitive. If a file with the resolved name already exists, it will be overwritten.
Parameters:
1. Numeric Value: currently unused. Send a 0.
2. File path: The file path (including file name) relative to the MSUS root directory. File extension should not be specified.
3. MSUS: Device to save the file on. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices.
A common cause of the command failure is not having enough space available on MSUS to save the setup. Use :MMEMory:CATalog:DIRectory query command to retrieve the total space available on MSUS.
Parameter(s):
<numeric_value>,<string>,<string>
:MMEMory:STORe:TRACe <string>,<string>,<string>
Title:
Store Trace
Description:
This command saves the current trace to the specified file location. The file location is resolved using the MSUS and file path parameters. These parameters are case sensitive. Parameters:
1. Label: Used to specify which trace to save. Currently, the label only supports saving all traces. Send an empty string or "ALL" to store all traces.
2. File path: The file path (including file name) relative to the MSUS root directory. File extension should not be specified.
3. MSUS: Device to save the file on. See MMEMory:CATalog:MSUSs? for information on obtaining the list of available devices.
A common cause of the command failure is not having enough space available on MSUS to save trace. Use :MMEMory:CATalog:DIRectory query command to retrieve the total space available on MSUS.
Parameter(s):
<string>,<string>,<string>
:SYSTem:COMMunicate:LAN:CONFig <string>,<string>,<string>
:SYSTem:COMMunicate:LAN:CONFig?
Title:
Static LAN Configuration
Description:
This command set and queries the static ethernet configuration of the device. The static configuration allows user to specify the ip, gateway, and subnet mask of the unit on a network. Parameters:
- Static IP Address: The desired IP address of the unit.
- Gateway: The network gateway.
- Subnet Mask: the subnet mask of the network the device is connected to.
A new valid configuration will automatically be applied to the device. The user will be required to access the unit through the new configuration.
CAUTION: Consult with your network administrator when configuring the network interface to avoid potential loss of access or discovery of the device.
Parameter(s):
<string>,<string>,<string>
:SYSTem:COMMunicate:LAN:CONFig:CURRent?
Title:
Current LAN Configuration
Description:
This command queries the current ethernet configuration of the device.
:SYSTem:COMMunicate:LAN:DHCP <ON|OFF>
:SYSTem:COMMunicate:LAN:DHCP?
Title:
DHCP Configuration
Description:
This command sets and queries the DHCP configuration of the device. If the DHCP configuration is set to OFF, the device is configured to the static ethernet configuration (See :SYSTem:COMMunicate:LAN:CONFig). If the DHCP configuration is set to ON, the device will obtain its IP address, gateway, and subnet mask from the DHCP server in the network.
This set command should be used to caution, as changing the ethernet configuration will result in temporary loss of communication with the device.
CAUTION: Consult with your network administrator when configuring the network interface to avoid potential loss of access or discovery of the device.
Parameter(s):
<ON|OFF>
Query Return:
ON|OFF
Default Value:
OFF
:SYSTem:COMMunicate:LAN:DNS <string>,<string>,<string>
:SYSTem:COMMunicate:LAN:DNS?
Title:
Dynamic DNS Configuration
Description:
This command sets and queries the Dynamic Domain Name Server (Dynamic DNS) configuration of the device. Currently, only http://www.noip.com (TM) is available for use. For support, please contact the vendor at http:/\noip.com.
Parameters:
- Dynamic DNS NoIp.com Host Name: Desired host name of the device.
- Dynamic DNS NoIp.com Username: noip.com username.
- Dynamic DNS NoIp.com Password: noip.com password.
Parameter(s):
<string>,<string>,<string>
:SYSTem:COMMunicate:LAN:DNSS1 <String>
:SYSTem:COMMunicate:LAN:DNSS1?
Title:
Default Domain Name System Server
Description:
The Default Domain Name System Server (DNS Server) 1 value is 8.8.8.8. Use this command to change the default value.
Parameter(s):
<string>
:SYSTem:COMMunicate:LAN:DNSS2 <String>
:SYSTem:COMMunicate:LAN:DNSS2?
Title:
Secondary Domain Name System Server
Description:
The Secondary Default Domain Name System Server (DNS Server) 2 value is 8.8.8.8. Use this command to change the secondary value.
Parameter(s):
<string>
:SYSTem:COMMunicate:LAN:DNSServer<n> <string>
:SYSTem:COMMunicate:LAN:DNSServer<n>?
Title:
Domain Name System Server
Description:
This command sets Domain Name System Server (DNS Server) 1 or 2. The DNS Server is used to resolve a Domain Name. This DNS Server will be contacted after any DNS Server assigned by DHCP Setting, if applicable, and will be contacted first (1) or second (2) if no DNS Name Server is assigned by DHCP Server or DHCP Feature is Disabled.
To remove a DNS Server, set its value to the empty string.
Parameter(s):
<string>
DNSServer Suffix Range:
1-2, Default = 1
:SYSTem:COMMunicate:LAN:FTP:STATe <0 | 1 | ON | OFF>
:SYSTem:COMMunicate:LAN:FTP:STATe?
Title:
FTP Server State
Description:
This command sets the system up to execute (ON) or bypass (OFF) the FTP server startup on the next instrument boot.
The query returns the state of the server based on the bypass flag. 0 for bypass FTP startup, 1 for start FTP. The actual state of the FTP server is not checked for the query.
Parameter(s):
<0 | 1 | ON | OFF>
:SYSTem:COMMunicate:LAN:HOSTname <string>
:SYSTem:COMMunicate:LAN:HOSTname?
Title:
Local Host Name
Description:
This command sets and retrieves the local host name of the instrument. A valid hostname may contain only the ASCII letters 'a' through 'z' (in a case-insensitive manner), the digits '0' through '9', and the hyphen ('-'). They cannot start/end with '-'. No other symbols, punctuation characters, or white space are permitted.
Parameter(s):
<string>
:SYSTem:COMMunicate:LAN:HTTP:SECure:STATe <0 | 1 | ON | OFF>
:SYSTem:COMMunicate:LAN:HTTP:SECure:STATe?
Title:
HTTPS Port State
Description:
This command sets the system up to allow (ON) or bypass (OFF) the HTTPS port setup on the next instrument boot.
The query returns the state of the port based on the bypass flag. 0 for bypass port setup, 1 for setup the port. The actual state of the HTTPS port is not checked for the query.
Parameter(s):
<0 | 1 | ON | OFF>
:SYSTem:COMMunicate:LAN:MTU <numeric_value> | DEFault | MINimum | MAXimum
:SYSTem:COMMunicate:LAN:MTU? [DEFault | MINimum | MAXimum]
Title:
MTU
Description:
This command sets the MTU for the ethernet connection to the given value.
Query Return:
Numeric
Set Command Parameter(s):
<numeric_value> | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
1400
Range:
1000 to 1500
:SYSTem:COMMunicate:LAN:NFS:MOUNt:LIST:REMHost?
Title:
NFS Mount Remote Host
Description:
This command retrieves the IP address of the remote host and the path to the remotely mounted folder, if NFS is mounted.
:SYSTem:DATe <numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:DATe?
Title:
System Date
Description:
This command sets and queries the system's internal calendar. Changing the system date does not affect the system time zone (if time zone is available). The three parameters for this command are <year>,<month> and <day>. The query response message shall consist of three fields separated by commas: <year>,<month>,<day>. The year shall be entered as a four-digit number, including century and millennium information. This shall not be affected by a *RST command.
Parameter(s):
<numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:DEFault:RESet:DATA <USER|SYSTem>
Title:
Reset System Files
Description:
This command deletes the instrument data files as specfied in the following table:
Parameter Value Description
USER Deletes all user files in the instrument's internal memory including measurements, setup files, and screen shots. User-customized system files will not be deleted.
SYSTem Deletes all user-customized system files including keyboard EZ names, cable lists, antenna lists, and log files.
Parameter(s):
<USER|SYSTem>
:SYSTem:DEFault:RESet:FACTory
Title:
Factory Default Reset
Description:
This command presets parameters in all applications as well as system settings with the exception of ethernet settings (DHCP On/Off, static IP, Static Gateway, Static Subnet) to their factory default values. Last saved settings will be deleted.
:SYSTem:DEFault:RESet:MASTer
Title:
Master Default Reset
Description:
This command presets parameters in all applications as well as system settings with the exception of ethernet settings (DHCP On/Off, static IP, Static Gateway, Static Subnet) to default values. Last saved settings, log files, and user files will all be deleted.
:SYSTem:ERRor[:NEXT]?
Title:
System Error Queue
Description:
If an error occurs, the error number and message are placed in the error queue, which can be read by this query command. Errors are cleared by reading them. Error code 0, is "No error". Error codes from -100 to -199 belongs to the Command error category and sets bit 5 of the standard ESR register. Error codes from -200 to -299 belongs to the Command error category and sets bit 4 of the standard ESR register. Error codes from -400 to -499 belongs to the Query error category and sets bit 2 of the standard ESR register. Error codes from -300 to -399 and 1 to 32767 belongs to the Device-specific error and sets bit 3 of the standard ESR register.
Negative error numbers (command error, execution error, device-dependent error,query error) are standard SCPI errors.
Positive error numbers are device specific errors, not standard SCPI errors. The error queue is also cleared by *CLS, *RST, and when power is turned on.
If more errors have occurred than can fit in the buffer, the last error stored in the queue (the most recent error) is replaced with -350, Queue overflow. No additional errors are stored until removing errors from the queue. If no errors have occurred when reading the error queue, the instrument responds with 0, No error.
:SYSTem:FIRMware:UPDate <string>,<string>
Title:
Firmware Update
Description:
Initiate a firmware update from the MSUS whose path is specified as parameters. If the requested firmware package is not recognized, an appropriate error will be added to the error queue. Otherwise, the instrument will verify that the package is safe to install, update to the new firmware. On MS2710XA models, the instrument will reboot disconnect all remote clients and reboot after the new firmware has been installed.
The two parameters for this command are file name with relative path and mass storage device. Both parameters are case sensitive. Use "/" as a directory separator. The available mass storage devices can be retrieved by the :MMEMory:CATalog:MSUSs command. The command will fail if the file doesn't exist or the mass storage device is not present.
Parameter(s):
<string>,<string>
:SYSTem:FIRMware:UPDate:REMote <string>
Title:
Remote Firmware Update
Description:
Initiate a remote firmware update to the package whose name is specified as a parameter. Use :SYSTem:FIRMware:UPDate:REMote:LIST? to inspect the packages that can be installed. If the requested firmware package is not recognized, an appropriate error will be added to the error. Otherwise, the instrument will download the specified firmware package, verify that the package is safe to install, update to the new firmware. On MS2710XA models, the instrument will reboot disconnect all remote clients and reboot after the new firmware has been installed.
If the <STRING DATA> argument begins with (case insensitive) any of
http://
https://
ftp://
Then the firmware update will be downloaded from that URL. The URL must be percent-encoded per RFC-2396 section 2.4.1.
Parameter(s):
<string>
:SYSTem:FIRMware:UPDate:REMote:LATest?
Title:
Check For Firmware Update
Description:
Check whether the instrument firmware is at the latest version. This command will access the package list specified by SYST:FIRM:UPD:REM:SOUR and return a response of the form
<string>,<number>
where <string> is the name of the latest firmware package, and <number> is 1 if the latest firmware package is newer than the version of firmware currently installed (a firmware update is available), or 0 if the current instrument firmware version matches the latest version (the instrument is up to date).
Clients can update the instrument to the latest firmware by passing the <string> component of the response as a parameter to the SYST:FIRM:UPD:REM command.
:SYSTem:FIRMware:UPDate:REMote:LIST?
Title:
Remote Firmware Package List
Description:
This command queries the instrument for a list of firmware packages that can be installed remotely. The package list will be populated from a resource file that is downloaded from a URL specified by the current value of :SYSTem:FIRMware:UPDate:REMote:SOURce.
The response is ASCII response consisting of one or more comma-delimited package names. For example:
2.0.0,1.0.0
These package names enumerate the valid parameter values to the :SYSTem:FIRMware:UPDate:REMote command.
:SYSTem:FIRMware:UPDate:REMote:SOURce <string>
:SYSTem:FIRMware:UPDate:REMote:SOURce?
Title:
Remote Firmware Package Source
Description:
This command sets or queries the instrument's remote firmware update package list source. This source must be an http URL that is accessible to the instrument over the current network interface.
The set version of this command takes a string that spells the URL to the package list file. The query version returns that string. The default value points to the repository on anritsu.com where official firmware packages for this instrument are distributed. Most users will never need to change this setting from the default.
The package list file must be a JSON file that has a minimum structure. The root object must contain a "version" string (which is reserved but currently unused), a "packages" array of zero or more package objects (each at minimum have a "name", "url", "version", and "model"), and a "default" string that matches one of the package names, or is "". The version and model attributes have semantic meaning, but the name and filename (url) can be anything. An example package list file is shown below:
{
"version" : "0.0.1",
"packages" : [
{
"name" : "2.0.0 (MS2710xA)",
"version" : "2.0.0",
"model" : "MS2710xA",
"url" : "http://files.us.anritsu.com/firmware/sh/MS2710xA_2.0.0.tar"
},
{
"name" : "1.0.0 (MS2710xA)",
"version" : "1.0.0",
"model" : "MS2710xA",
"url" : "http://files.us.anritsu.com/firmware/sh/MS2710xA_1.0.0.tar"
}
],
"default" : "1.0.0"
}
When the package source is set, the instrument will attempt to download the file and validate it according to the above rules before making the change permanent. If the file cannot be accessed or the file does not conform to the minimum criteria, a device specific error will be added to the error queue and the package source will remain unchanged.
Parameter(s):
<string>
:SYSTem:FIRMware:VERSion?
Title:
Firmware Version
Description:
This command queries the device firmware version.
:SYSTem:GPS:VOLTage <numeric_value> | DEFault | MINimum | MAXimum
:SYSTem:GPS:VOLTage? [DEFault | MINimum | MAXimum]
Title:
GPS Voltage
Description:
Supplies either 3.3V or 5V to power the attached GPS
Query Return:
Numeric
Set Command Parameter(s):
<numeric_value> | DEFault | MINimum | MAXimum
Query Command Parameter(s):
[DEFault | MINimum | MAXimum]
Default Value:
3.3
Range:
3.3 to 5
:SYSTem:LOG:ERRor?
Title:
System Error Log
Description:
This command retrieves the error log. The log is encrypted and can be saved to a file and sent to Anritsu Service if required.
:SYSTem:MACaddress?
Title:
MAC Address
Description:
This command accesses the mac address of the device.
:SYSTem:OPTions?
Title:
Query Options
Description:
This command retrieves the options that are currently set. The reponse is returned in "/" delimited form.
:SYSTem:OPTions:CONFig?
Title:
Option Configuration
Description:
This command returns a quoted string containing the configuration of currently enabled options on the instrument.
:SYSTem:OPTions:UPGRade <string>
Title:
Option Upgrade
Description:
This command upgrades the options of the device with a valid license key provided as a quoted string parameter. The device must be reboot immediatly after this command for the intallation of the new options to complete. The device must not be powered off while the command is executing. The recommended way to restart the device safely is sending the *RST command after this command. This command might report the following error code:
-200 : The command failed to complete. Detailed eror message will be provided in the response of :SYStem:ERRor[:NEXT]? command.
Parameter(s):
<string>
:SYSTem:PRESet
Title:
Preset
Description:
This command presets parameters in the current application to their factory default values.
:SYSTem:SSLCertificate?
Title:
SSL Certificate Information
Description:
This command reports information about the SSL certificate being used by the webserver to support HTTPS connections. The information will be returned in JSON format and will consist of the following fields:
1. Start Date("notBefore"): When the certificate was generated.
2. End Date("notAfter"): When the certificate will expire.
3. Country("C"): Country of origin.
4. State("ST"): State of origin.
5. Location("L"): City of origin.
6. Organization("O"): Organization of origin.
7. Organizational Unit("OU"): Department of origin.
8. Common Name("CN"): Associated host name.
All fields will be popualted into a JSON array. The resulting response will be similar to the following:
[{"C":"<country>", "ST":"<state>", "L":"<city>", "O":"<organization>",
"OU":"<unit>", "CN":"<host_name>, "notAfter":"<notAfter_date>", "notBefore":"<notBefore_date>"}]
For the default self-signed certificate that the instrument will automatically generate when no user certificate is available, the Organization field will be set to "Anritsu Default SSL Certificate". An example of the certificate data is shown below for the default self-signed certificate:
[{"C": "US","CN": "anritsu.com","L": "Morgan Hill","O": "Anritsu Default SSL Certificate","OU": "Engineering","ST": "California",
"notAfter": "Oct 26 19:05:26 2917 GMT","notBefore": "Jun 1 19:05:26 2018 GMT"}]
:SYSTem:TEMPerature?
Title:
Get System Temperature
Description:
This command returns the device temperature in Celcius.
:SYSTem:TIMe <numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:TIMe?
Title:
System Time
Description:
This command sets and queries the system's internal clock. Changing the system time does not affect the system time zone (if time zone is available). The three parameters for this command are <hour>,<minute> and <second>. The query response message shall consist of three fields separated by commas: <hour>,<minute>,<second>.
Parameter(s):
<numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:UNIT:NAMe <string>
:SYSTem:UNIT:NAMe?
Title:
System Unit Name
Description:
This command sets/queries the unit name of the current system.The name of the unit must not be greater than 45 ASCII characters
Parameter(s):
<string>
:TEST:SELFtest?
Title:
Self Test
Description:
Perform a self-test and return the results. The response is formatted as a JSON (http://json.org/) array of name,value pair result objects. Some result objects also include a 'status' property that will be either 'pass' or 'fail' based on whether the criteria for that test was met.
For tests of voltages, the test passes if the measured voltage is within 10% of the expected voltage.