Remote Spectrum Monitorâ„¢ MS27201A Programming Manual : MS27201A Commands : System Commands
 
System 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:CATalog:ACTive?
Title:
List Active Applications
Description:
This command queries all active applications. The response is returned as a comma delimited 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:ALL?
Title:
Query Available Applications with all information
Description:
This query returns a JSON list of available applications with metadata including active status, appId and modes. [ {"name":"SPA", "active":"true", "appId":"1","modes":["SPEC","NRAD"]}, {"name":"VNA", "active":"false", "appId":"26","modes":["VNA"]}, ]
If no application is available an empty JSON list will be returned.
:INSTrument:CATalog:FULL?
Title:
Query Available Applications
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.
: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).
For example:
MMEMory:CATalog:DIRectory? "/", "USB1-1"
The response is formatted 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:DIRectory:SIZE? <string>,<string>
Title:
MMemory Catalog Directory Size
Description:
This command is query-only and returns the size of a given directory. It has two parameters. Both are case sensitive.
<directory>,<msus>
Parameter 1: The full path of a directory to query the size. 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).
For example:
MMEMory:CATalog:DIRectory:SIZE? "/", "USB1-1"
The response is a single ASCII string of the size of the given directory.
Parameter(s):
<string>,<string>
:MMEMory:CATalog:MSUSs?
Title:
Memory Catalog Msuss
Description:
Returns a list of all available mass storage devices present, formatted as follows: <Device Name 1>,<Device Name 2>,...<Device Name N>
For example, sending:
MMEMory:CATalog:MSUSs?
could return:
Internal,USB1-1
: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.
For example:
MMEMory:CDIRectory "/example_folder"
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).
For example:
MMEMory:COPY "/example_file.ext", "Internal", "/example_file.ext", "USB1-1"
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)
For example:
MMEMory:CREate:DIRectory "/example_folder", "USB1-1"
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 data to be written to the instrument in block data format
If any directories in the file path do not exist, the instrument 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 parameters 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.
For example:
MMEMory:DELete:DIRectory "/example_folder", "USB1-1"
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.
For example:
MMEMory:DELete:FILe "/example_folder/example_file.ext", "USB1-1"
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:EJECt <string>
Title:
Eject USB drive
Description:
This command safely ejects (unmounts) a USB drive from the instrument. Following this command, a USB drive can be safely removed from the instrument. See :MMEMory:CATalog:MSUSs for more information on obtaining the name of the USB drive(s) currently mounted on the instrument.
For example:
MMEMory:EJECT "USB1-1"
Parameter(s):
<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.
For example:
MMEMory:LOAD:STATe 0,"/example_setup_file", "Internal"
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 and setup. After recall all traces will have update state turned off, but sweeping will continue with the recalled setup. This means that traces will retain the recalled measurement data until the trace update state is turned on. 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.
For example:
MMEMory:LOAD:TRACe "ALL", "/example_measurement_file", "Internal"
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: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
For example:
MMEMory:MSIS "Internal"
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.
For example:
MMEMory:STORe:STATe 0,"/example_setup_file", "Internal"
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 measurement data along with 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. 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.
For example:
MMEMory:STORe:TRACe "ALL", "/example_measurement_file", "Internal"
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: (optional)The network gateway
- Subnet Mask: (optional) The subnet mask of the network the device is connected to.
The Gateway and Subnet Mask settings will remain no change if user has no input.
The dhcp will be turned off.
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://www.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:DNSServer:APPend <string>, {<string>}, ...
Title:
Domain Name System Server Append
Description:
This command will add one or more Domain Name System Servers to the end of the device's current list of DNS Servers.
To view the entire list of DNS Servers, see SYSTem:COMMunicate:LAN:DNSServer:LIST. To remove a DNS Server, see SYSTem:COMMunicate:LAN:DNSServer:DELete.
This command takes a list of one or more string values. For example: SYSTem:COMMunicate:LAN:DNSServer:APPend "8.8.8.8", "123.125.81.6"
Parameter(s):
<string>, {<string>}, ...
:SYSTem:COMMunicate:LAN:DNSServer:DELete <string>, {<string>}, ...
Title:
Domain Name System Server Delete
Description:
This command will delete the device's given Domain Name System Servers from the device's current list of DNS servers. To view the entire list of DNS Servers, see SYSTem:COMMunicate:LAN:DNSServer:LIST.
This command takes a list of one or more string values. For example: SYSTem:COMMunicate:LAN:DNSServer:DELete "8.8.8.8", "123.125.81.6"
Parameter(s):
<string>, {<string>}, ...
:SYSTem:COMMunicate:LAN:DNSServer:LIST <string>, {<string>}, ...
:SYSTem:COMMunicate:LAN:DNSServer:LIST?
Title:
Domain Name System Server List
Description:
This command sets and retrieves a list of the device's currently set Domain Name System Servers.
The DNS Server is used to resolve a Domain Name. The list of DNS Servers will be contacted after any DNS Server assigned by DHCP Setting, if applicable, and will be contacted in the order given in the list.
This command takes a list of one or more string values. Setting the DNS server list with this command will override the currently set DNS server list.
An example of using the command: SYSTem:COMMunicate:LAN:DNSServer:LIST "8.8.8.8", "123.125.81.6"
This query version of this command returns a comma delimited list of strings. For example: 123.125.81.6,8.8.8.8
To remove DNS Server, see SYSTem:COMMunicate:LAN:DNSServer:DELete.
To add to the end of the current list, see SYSTem:COMMunicate:LAN:DNSServer:APPend.
Parameter(s):
<string>, {<string>}, ...
: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 FTP server based on the bypass flag, 0 for bypass, 1 for start. The actual state of the FTP server is not check 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 HTTPS port based on the bypass flag, 0 for bypass, 1 for configure. The actual state of the HTTPS port is not check for the query.
Parameter(s):
<0 | 1 | ON | OFF>
: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. Note: Some products only support the query version of this 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 specified 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) and time zone setting to their factory default values, and restarts the instrument. Last saved settings will be deleted. If unit equips with WiFi, the previous access point connections will be clean up.
:SYSTem:DEFault:RESet:MASTer
Title:
Master Default Reset
Description:
This command performs a factory reset as well as deletes last saved settings, log files, and user files. The factory reset includes presetting parameters in all applications, presetting all system settings with the exception of ethernet settings (DHCP On/Off, static IP, Static Gateway, Static Subnet) and time zone settings, and cleaning up all previous access point connections if the instrument is equipped with WiFi.
: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.
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.
For example:
SYSTem:FIRMware:UPDate "V2019.01.1.raucb", "USB4-1"
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:LIST?
Title:
Firmware Package List
Description:
This command queries the instrument for a list of firmware packages that can be installed from mounted USB block devices. Please note that firmware packages are only detected on the top level of a USB block device. Any files located in subfolders will be ignored.
The response is in JSON format and consists of the path of the package relative to the root of the MSUS, the MSUS that the package is located in, and the version of the package.
The following is an example of the response: [{"msus":"USB1-1","path":"V2018.2.22.raucb","version":"V2018.2.22"}, {"msus":"USB2-1","path":"V2018.2.19.raucb","version":"V2018.2.19"}]
These package names enumerate the valid parameter values to the :SYSTem:FIRMware:UPDate command.
: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.
The instrument will 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:AUTO <0 | 1 | ON | OFF>
:SYSTem:FIRMware:UPDate:REMote:AUTO?
Title:
Remote Firmware Update Auto Check
Description:
This command sets and queries the state to enable automatically checking a remote server (see SYSTem:FIRMware:UPDate:REMote:SOURce?) for software updates. If this command is set to ON, The server will be checked for a newer version on bootup and every 24 hours thereafter. If this command is set to OFF, no automatic checking will take place, but a check can be initiated manually (see SYSTem:FIRMware:UPDate:REMote:LIST:REFResh command). If the check finds a newer version available, the SYSTem:FIRMware:UPDate:REMote:LATest? query will indicate the newer version. Use the SYSTem:FIRMware:UPDate:REMote command to initiate the download and install.
Parameter(s):
<0 | 1 | ON | OFF>
Query Return:
0 | 1
Default Value:
ON
: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:LIST:REFResh
Title:
Remote Firmware Package List Refresh
Description:
This command causes the list of firmware packages that can be installed remotely (:SYSTem:FIRMware:UPDate:REMote:LIST?) to be refreshed from the remote source server immediately. Normally the list is automatically updated on a timer interval to limit the amount of network requests. The exact timer interval varies by model and could be anywhere from one minute to one day. Use this command if you do not want to wait for the next automatic timer-based update to the remote firmware package list.
Note that this command only initiates the request to the server to get the updated list of packages. It does not wait until the list (as visible by :SYSTem:FIRMware:UPDate:REMote:LIST?) is actually updated as the request is made asynchronously.
: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.
For example, the url value either set or query returned may be:
http://softwareupdates.anritsu.com/en-us/ms209xa.txt
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:
{
"default": "V2.0.0 (MS27201A)",
"packages" : [
{
"name" : "2.0.0 (MS27201A)",
"version" : "2.0.0",
"model" : "MS27201A",
"url" : "http://files.us.anritsu.com/firmware/sh/MS27201A_2.0.0.raucb"
},
{
"name" : "1.0.0 (MS27201A)",
"version" : "1.0.0",
"model" : "MS27201A",
"url" : "http://files.us.anritsu.com/firmware/sh/MS27201A_1.0.0.raucb"
}
],
"version" : "1.0.0"
}
or, as with MS27201A:
{
"default": "V1.0.0 (MS27201A)",
"packages": [
{
"name": "V1.0.0 (MS27201A)",
"version": "V1.0.0",
"model": "MS2710xA",
"url": "http://softwareupdates.anritsu.com/en-us/MS27201A_V1.0.0.tar"
}
],
"version": "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:STATe <0 | 1 | ON | OFF>
:SYSTem:GPS:STATe?
Title:
GPS State
Description:
Enable or disable the GPS. When the GPS is OFF, the GPS module is placed into standby to save power, and features which depend on the GPS may be unusable.
Parameter(s):
<0 | 1 | ON | OFF>
Query Return:
0 | 1
Default Value:
OFF
:SYSTem:GPS:VOLTage <numeric_value>
:SYSTem:GPS:VOLTage?
Title:
GPS Voltage
Description:
Supplies either 3.3V or 5V to power the attached GPS
Parameter(s):
<numeric_value>
Query Return:
Numeric
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:
Query the MAC address of the instrument.
Setting the MAC address is only available to customer service.
:SYSTem:OPTions?
Title:
Query Options
Description:
This command retrieves the options that are currently set. The response is returned in "/" delimited form.
:SYSTem:OPTions:CONFig?
Title:
Option Configuration
Description:
This command returns a quoted string of characters readable only by Anritsu Customer Service. Only instrument configuration information is returned. No setup information is included.
: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 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. When the operation completes a success message will be shown and request to reboot the device. 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. -2: The command failed because the options provided in the option file are incompatible with this instrument.
Parameter(s):
<string>
:SYSTem:PRESet
Title:
Preset
Description:
This command presets parameters in the current application to their factory default values.
:SYSTem:REBoot
Title:
System Reboot
Description:
This command saves the current state of the instrument and reboots the instrument.
: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>. Note: Some products only support the query version of this command.
Parameter(s):
<numeric_value>,<numeric_value>,<numeric_value>
:SYSTem:TIME:SYNC <AUTO|MANual>
:SYSTem:TIME:SYNC?
Title:
Sync System Time
Description:
This command sets the system to either automatically synchronize with GPS/Internet server or manually adjust the time setting. Valid parameter values are AUTO|MANual. When AUTO is selected, GPS takes priority if it is present and turned on (see command :SYSTem:GPS:STATe to set GPS on or off). When the time setting is AUTO synchronized, the current time zone setting is not changed.
Parameter(s):
<AUTO|MANual>
Query Return:
AUTO|MAN
Default Value:
AUTO
:SYSTem:TIME:SYNC:STATus?
Title:
Sync Time Status
Description:
This command query the last system time synchronization status. The return value range are INT, GPS, NONE, or NA.
INT - the system time was successfully synchronized with internet server.
GPS - the system time was successfully synchronized with GPS device time.
NONE - the system time was set to automatically synchronize with GPS/internet. However, it was unable to synchronize with the time source. It may indicates the time source connection is not available or time source is not ready such as GPS is off.
NA - the system time was set to manually update, thus synchronization status is not available.
Query Return:
INT|GPS|NONE|NA
Default Value:
INTernet
:SYSTem:TIME:ZONE <string>
:SYSTem:TIME:ZONE?
Title:
System Time Zone
Description:
This command sets and queries the system time zone. The time zone parameter is in string format of "(UTC+/-offset) Area/Location" as returned from the :SYSTem:TIME:ZONE:CATalog command. Changing the system time zone affects the system date/time.
Parameter(s):
<string>
Default Value:
(UTC-08:00) America/Los_Angeles
:SYSTem:TIME:ZONE:CATalog?
Title:
System Time Zone Catalog
Description:
This command queries the available system time zone catalog. The query returns comma delimited description for time zone sorted by UTC offset. Each item is in the format of "(UTC+/-offset) Area/Location" where Area/Location is defined in the tz database
: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.