Remote Spectrum Monitor User Guide : SCPI System Commands : :SYSTem Subsystem
 
:SYSTem Subsystem
This subsystem contains commands that affect instrument functionality that does not directly relate to data collection, display or transfer.
: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.
Parameters
<string> static IP address: The desired IP address of the unit.
<string> gateway: The network gateway.
<string> 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.
 
:SYSTem:COMMunicate:LAN:CONFig:CURRent?
Title
Current LAN Configuration
Description
This command queries the current ethernet configuration of the device.
Parameters
none
: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.
Parameters
<ON|OFF>
:SYSTem:COMMunicate:LAN:DNS <string>
:SYSTem:COMMunicate:LAN:DNS?
Title
DNS Configuration
Description
This command sets and queries the DNS configuration of the device. Currently, only http://www.noip.com is available for use.
DNS Host Name: Desired host name of the device.
DNS Username: noip.com username.
DNS Password: noip.com password.
Parameters
<string>
:SYSTem:COMMunicate:LAN:DNSServer<n> <string>
:SYSTem:COMMunicate:LAN:DNSServer<n>?
Name
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.
Parameters
<string>
Suffix Range Description
DNSServer Suffix Range: 1-2, Default = 1
: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.
Parameters
<string>
 
: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.
Parameters
none
:SYSTem:DATe <numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:DATe?
Title
System Date
Description
This command sets and queries the system’s internal calendar. The three Parametersfor this command are <year>,<month> and <day>. The query response message will consist of three fields separated by commas: <year>,<month>,<day>. The year will be entered as a four-digit number, including century and millennium information. This will not be affected by a *RST command.
Parameters
<numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:DEFault:RESet:DATA <char>
Name
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.
Parameters
<char>
:SYSTem:DEFault:RESet:FACTory
Title
Reset System to Factory Default
Description
This command presets Parametersin all applications as well as system settings to their factory default values. Last saved settings will be deleted.
:SYSTem:DEFault:RESet:MASTer
Title
Master Reset System to Default
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, and finally reboot. Before rebooting all remote clients will be disconnected.
The two Parametersfor this command are file name with relative path and mass storage device. Both Parametersare 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.
Parameters
<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, and finally reboot. Before rebooting all remote clients will be disconnected.
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.
Parameters
<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.
Parameters
none
 
: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.
Parameters
none
: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" and a "url"), and a "default" string that matches one of the package names, or is "".
An example package list file is shown below:
{
"version" : "0.0.1",
"packages" : [
{
"name" : "2.0.0",
"url" : "http://files.us.anritsu.com/firmware/sh/2.0.0.tar"
}
{ "name" : "1.0.0",
"url" : "http://files.us.anritsu.com/firmware/sh/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.
Parameters
<string>
 
:SYSTem:FIRMware:VERSion?
Title
Firmware Version
Description
This command queries the device firmware version.
Parameters
none
 
:SYSTem:GPS:VOLTage? <number>
Title
GPS Voltage
Description
Supplies either 3.3V or 5V to power the attached GPS.
Parameters
<number>
Query Return
Numeric
Default Header
3.3
Range
3.3 to 5
 
:SYSTem:LOG:ERRor?
Title
System Log Error
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.
Parameters
none
:SYSTem:MACaddress?
Title
Configure MAC Address
Description
This command accesses the mac address of the device.
Parameters
none
:SYSTem:OPTions?
Title
Query Options
Description
This command retrieves the options that are currently set. The reponse is returned in "/" delimited form.
Parameters
none
 
:SYSTem:OPTions:CONFig?
Title
Option Configuration
Description
This command returns a quoted string containing the configuration of currently enabled options installed in the instrument.
Parameters
none
:SYSTem:OPTions:UPGRade <string>
Name
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.
Parameters
<string>
 
:SYSTem:PRESet
Title
System Preset
Description
This command presets Parametersin the current application to their factory default values.
:SYSTem:SSLCertificate?
Name
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"}]
Parameters
none
 
:SYSTem:TEMPerature?
Title
Get System Temperature
Description
This command retrieves the device temperature.
Parameters
none
: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 Parametersfor this command are <hour>,<minute> and <second>. The query response message shall consist of three fields separated by commas: <hour>,<minute>,<second>.
Parameters
<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.
Parameters
<text>
:SYSTem:OPTions:UPGRade <srtring>
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 immediately after this command for the installation 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 sendingthe *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.
Parameters
<string>