System Commands

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.

System Display Language

This command sets and queries the system's displayed language

Basic GPS Information

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.

Full GPS Information + Satellite System Information

This command returns the fix timestamp, latitude, longitude, altitude and information on the satellites used for the last fix and the GNSS systems they are from. The response is in JSON format in the one of the following forms: {"fix":"GPS OFF"}

or {"fix":"GOOD FIX","timestamp":<timestamp>,"latitude":<latitude>,"longitude":<longitude>,"altitude":<altitude>, "satellitesUsed":<satellitesUsed>,"satellites":[ {"name":"GPS","count":x}, {"name":"Galileo","count":x}, {"name":"GLONASS","count":x}, {"name":"BeiDou","count":x}]} {"name":"SBAS","count":x}]} <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\.

All satellite systems will be present with a count of 0 if they are not used in the fix.

Full GPS Information

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.

<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.

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.

<latitude> and <longitude> are specified in decimal degrees.

<altitude> specifies the current altitude relative to mean sea level, in meters.

Activate or Deactivate Application

This command turns the specified application ON or OFF one at a time. 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. Please expect some delay in the application response to a command right after being turned on. The delay will vary depending on the application type and the options being installed. 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).

Attempting to turn on a different application (not the currently active application) requires turning the current application OFF. Otherwise, it will result in an execution error. To turn off an application uses the :INSTrument:APPLication:STATe command.

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 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 the only active application.

<SPA|HIPM|CAA>,<0 | 1 | ON | OFF>

List Active Applications

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.

Query Available Applications with all information

This query returns a JSON list of avaialble applications with metadata including active status, appId modes and SCPI API version. [ {"name":"SPA", "active":"true", "appId":"1","modes":["SPEC","NRAD"], "version": 1}, {"name":"VNA", "active":"false", "appId":"26","modes":["VNA"], "version": 1}, {"name":"SYSTEM", "version":1 } ]

The list will always contain at least one item since the System application will always be included.

Query Available Applications

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.

Select Application by Number

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?

Selecting a different application (not the currently active application) requires turning the current application OFF. Otherwise, it will result in an execution error. To turn off an application uses the :INSTrument:APPLication:STATe command.

If no applications are active, the query version of this command will return 0.

Select Application by Name

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.

NONE|SPA|VNA|SG|HIPM|CAAUSB|CWSG|VVM|CAA|VSG

Memory Catalog Directory

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).

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>

MMemory Catalog Directory Size

This command is query-only and returns the size of a given directory. It has two parameters. Both are case sensitive.

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).

MMEMory:CATalog:DIRectory:SIZE? "/", "USB1-1"

The response is a single ASCII string of the size of the given directory.

Memory Catalog Msuss

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?

Default Mass Storage Directory

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.

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.

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).

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.

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)

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)

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.

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.

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.

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.

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.

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.

MMEMory:EJECT "USB1-1"

This command recalls the specified setup. The file location is resolved using the MSUS and file path parameters. These parameters are case sensitive.

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.

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.

<numeric_value>,<string>,<string>

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.

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.

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.\

Default Mass Storage Device

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

MMEMory:MSIS "Internal"

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.

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.

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.

<numeric_value>,<string>,<string>

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.

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.

10MHz Reference Output State

This command enables or disables the 10MHz reference output. The query returns 1 if 10MHz reference output is enabled; otherwise, returns 0. Not available on the MS2080A or MS2070A.

External Bias Current

This command queries the actual bias current in A.

External Bias On/Off

This command enables or disables the external bias. The query returns 1 if external bias is enabled; otherwise, returns 0.

This command queries whether the external bias is tripped. The query returns 1 for tripped; otherwise, returns 0.

Clear External Bias Fault

This command clears the external bias tripped status. See command [:SENSe]:BIAS:EXTernal:TRIPped[:STATe] for retrieving the current tripped status.

External Bias Voltage

This command sets the desired voltage for the external bias. The query returns the actual bias voltage in V.

Frequency Reference Source

Returns the current frequency reference source used by the instrument, as specified in the following table:

Return value: Description

GPS: GPS High Accuracy

ACQ: Acquiring GPS Reference

INT: Internal Standard Accuracy

HI: Internal High Accuracy

EXT: External (10 MHz) Reference

This command enable or disable RF safe mode state

Time Reference Source

Returns the current time reference used by the instrument, as specified in the following table:

Return value Description

GPS GPS High Accuracy

INT Internal Standard Accuracy

HI Internal High Accuracy

Static LAN Configuration

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.

For a subnet mask of 255.255.255.0(/24), you only have a valid host IP range of x.x.x.1-x.x.x.254. The first IP in the subnet (x.x.x.0) is reserved for the network ID and the last one (x.x.x.255) is reserved as the broadcast ID. You can have a different range of valid host addresses if you change the subnet mask to a different number. For example, if a subnet mask of 255.255.254.0 is used, the gateway can be set to 192.168.101.0 since the valid host IP range is 192.168.100.1-192.168.101.254.

More information on subnetting can be found here:

https://docs.microsoft.com/en-us/troubleshoot/windows-client\networking/tcpip-addressing-and-subnetting

A calculator for finding valid host IP addresses in a subnet can be found here:

https://www.calculator.net/ip-subnet-calculator.html

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.

<string>,[<string>],[<string>]

Current LAN Configuration

This command queries the current ethernet configuration of the device.

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.

Dynamic DNS Configuration

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.

Domain Name System Server Append

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", "8.8.4.4"

<string>, {<string>}, ...

Domain Name System Server Delete

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", "8.8.4.4"

<string>, {<string>}, ...

Domain Name System Server List

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", "8.8.4.4"

This query version of this command returns a comma delimited list of strings. For example: 8.8.8.8, 8.8.4.4

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.

<string>, {<string>}, ...

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.

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.

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. Bypassing the HTTPS port will prevent use of remote software file transfer.

Secure Communication Custom Certificate Key Pair

Loads a custom certificate and key pair into the instrument to be used with secure connections.

The command takes 3 parameters:

1. Certificate contents (in PEM format).

2. Private key contents (in PEM format).

3. Key type. Currently, only RSA is supported.

The command is only available if the Secure Communication option is installed.

On a secure connection, the command is only accessible after command :SYSTem:PASSword:CENable has been received with a valid password.

Secure Communication Certificate Information

Returns the information about the SSL certificate being used in the secure connection. The information is returned in JSON format and consists of the following fields:

1. Start Date("notBefore"): When the certificate was generated (in GMT).

2. End Date("notAfter"): When the certificate will expire (in GMT).

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. Common Name("CN"): Associated host name.

All fields will be populated into a JSON array. The resulting response will be similar to the following: [{"C":"<country>", "ST":"<state>", "L":"<city>", "O":"<organization>", "CN":"<host_name>", "notAfter":"<notAfter_date>", "notBefore":"<notBefore_date>"}]

The command is only available if the Secure Communication option is installed.

Current WLAN Configuration

This command queries the device wireless LAN configuration.

For example: { "ipAddress" : "192.168.0.190",

"gateWay" : "192.168.0.1",

"subnetMask" : "255.255.255.0"

Connect to a WiFi Access Point

This command connects to a WiFi access point. The first string parameter is the ssid of the access point. The second string parameter, which is optional is the password of the access point.

WiFi Active Connection Information

This command returns properties of the current WLAN connection.

If SYSTem:COMMunicate:WLAN:CONNection:STATus is not CONNected, the response is an ASCII empty JSON object: {} Otherwise the response is an ASCII JSON object with the following property:

SSID (ssid): The Service Set Identifier identifying the access point connected to.

For example: { "ssid" : "ExampleAccessPoint",

Disconnect from a WiFi Access Point

This command disconnects from the currently connected WiFi access point. This will also turn off auto connecting to another wireless network until the device is rebooted or WiFi is toggled on and off.

Forget a WiFi Access Point

This command disconnects and forgets a WiFi access point.

The first string parameter is the ssid of the access point.

Forget All WiFi Access Points

This command disconnects and forgets all saved WiFi Access Points

Saved WiFi Access Points

This command returns all saved WiFi access points as JSON array

WiFi Connection Status

This command returns the connection status of the WLAN device. The response is ASCII character data of one of the following values:

Parameter value Description

CONNected A connection is established

DISConnected No connection currently exists

This command returns available WiFi access points.

If SYSTem:COMMunicate:WLAN:STATe is false, the response is an empty list [] Otherwise the response is ASCII of JSON object array with the following properties:

1. SSID (ssid): The Service Set Identifier identifying the access point connected to.

2. Frequency (frequency): The radio channel frequency in use by the access point, in MHz.

3. Max Bit Rate (rate): The maximum bitrate this access point is capable of.

4. Signal Strength (signal): The current signal quality of the access point, in percent.

5. BSSID (bssid): The hardware address of the access point.

6 Security Methods (security) : the security methods supported by the access point

"frequency" : "5220 MHz",

"rate" : "54 Mbit/s",

"bssid" : "00:13:1A:34:D8:52",

"security" : "WPA1","WPA2"

"ssid" : "AM-Employee",

"frequency" : "5 MHz",

"bssid" : "06:18:1A:31:4E:62"

"security" : "WPA1","WPA2"

Refresh WiFi Access Points

This command will force the wireless network card to rescan local access points. This command will not return any data. Scanning for access points can take between 10-40 seconds before updating. Network rescans are rate limited by the hardware, consecutive calls to this command will not result in multiple rescans by the hardware. Calling SYST:COMM:WLAN:NETW? too soon after calling this command can result in a return of non updated data, or an empty list.\

Enable or Disable WiFi

This command toggles the WLAN interface on or off.

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.

<numeric_value>,<numeric_value>,<numeric_value>

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.

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.

Factory Default Reset

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.

SCPI Error Message State

Sets or queries the state of SCPI error messages being displayed. By default, when a SCPI error enters the error queue it will be displayed on-screen. This command toggles whether those errors should be displayed. This command defaults to 0, meaning errors will NOT be displayed.

Usage: Suppress SCPI Error Messages: SYST:ERR:DISP 0 Show all SCPI Error Messages: SYST:ERR:DISP 1.

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 belong to the Command error category and set bit 5 of the standard ESR register.

Error codes from -200 to -299 belong to the Command error category and set bit 4 of the standard ESR register.

Error codes from -400 to -499 belong to the Query error category and set bit 2 of the standard ESR register.

Error codes from -300 to -399 and 1 to 32767 belong to the Device-specific error category and set 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.

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.

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.

Firmware Package List

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.

Remote Firmware Update

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

Then the firmware update will be downloaded from that URL. The URL must be percent-encoded per RFC-2396 section 2.4.1.

Remote Firmware Update Auto Check

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.

Check For Firmware Update

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.

Remote Firmware Package List

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.

Remote Firmware Package List Refresh

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.

Remote Firmware Package Source

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": "V2021.11.2 (MS209xA)",

"name": "V2021.11.2 (MS209xA)",

"version": "V2021.11.2",

"url": "http://softwareupdates.anritsu.com/en-us/MS208xA_V2021.11.2.raucb"

or, as with MS2710xA:

"default": "V1.0.0 (MS2710xA)",

"name": "V1.0.0 (MS2710xA)",

"version": "V1.0.0",

"model": "MS2710xA",

"url": "http://softwareupdates.anritsu.com/en-us/MS2710xA_V1.0.0.tar"

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.

This command queries the device firmware version.

GPS Satellite System Search Mode

Sets and queries the GPS Satellite system search option.

The satellite system search options can be:

GGLonass: GPS + GLONASS

GGALileo: GPS + GALILEO

GBEidou: GPS + BEIDOU

GGGalileo: GPS + GLONASS + GALILEO

<GGLonass|GGALileo|GBEidou|GGGalileo>

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.

Supplies either 3.3V or 5V to power the attached GPS

This command retrieves the error log. The log is encrypted and can be saved to a file and sent to Anritsu Service if required.

Query the MAC address of the instrument.

Setting the MAC address is only available to customer service.

This command retrieves the options that are currently set. The response is returned in "/" delimited form.

This command returns all installed options with their metadata in JSON format. The expiration date time is in UTC time and in a string format of the form yyyy-MM-ddTHH:mm:ss corresponding to the ISO 8601 specification.

[{"expirationDate":"","option":"0090", "state":"active", "description":"Gated Sweep"},

{"expirationDate":"2022-07-05T19:00:42Z","option":"9103", "state":"pendingReboot", "description":"50 MHz Analysis Bandwidth" },

{"expirationDate":"","option":"9431", "state":"available", "description":"Coverage Mapping"}]

Option Configuration

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.

Activate Timed Options

This command activates an existing Timed Option.

Option Update Remote

This command retrieves all available Licenses for given instrument and installs them.

This command upgrades the options of the device with a valid license key provided as a quoted string parameter. The device must be rebooted 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 by sending the *RST command after this command. This command might report the following error code: -200: The command failed to complete. A detailed error 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.

Enable Remote Password

Enable the remote password state.

All existing remote connections to the instrument on a raw socket will be closed.

Future remote connections to the instrument must be on a secure socket via port 9003 and must provide a matching password (using :SYSTem:PASSword:CENable command) in order to gain access to other SCPI commands on the instrument.

1. StringValue: The remote password encrypted using OpenSSL RSA encryption algorithm with Anritsu Remote Password public key and OAEP padding mode in a base64 string. Use :SYSTem:PASSword:SSLKey to get Anritsu Remote Password public key.

Sending an invalid password generates error -221 (setting conflict).

The command is only available if the Secure Communication option is installed.

Enable Password Protected Connection

Unlocks a particular connection to allow all SCPI commands to be sent via that connection when remote password state is ON.

Sending an invalid password generates error -221 (setting conflict).

Send an empty string as the password parameter if the remote password has not been set but the remote password state is ON.

The command is only available if the Secure Communication option is installed.

Disable Remote Password

Disable the remote password state.

Remote connections to the instrument on a secure socket via port 9003 will be disabled.

Remote connections to the instrument on a raw socket via port 9001 are enabled.

Sending an invalid password generates error -221 (setting conflict).

The command is only available if the Secure Communication option is installed.

Remote Password Connection State

Returns whether the particular connection the command is being sent from is locked behind a password.

The query will return 0 if the connection is still locked behind a password or 1 if SCPI commands can be sent.

To unlock the connection for all SCPI commands, use :SYSTem:PASSword:CENable.

The command is only available if the Secure Communication option is installed.

Remote Password Integrity

Returns whether the remote password checksum is good or bad. The query command

will return one of the two following values:

Good: The password integrity is good and can be used as normal.

Bad: The password has failed checksum and will possibly no longer match properly.

Commands that require the entry of the password (:SYSTem:PASSword:CENable, :SYSTem:PASSword:CENable:ALL, :SYSTem:PASSword:CDISable, and :SYSTem:PASSword:NEW)

may no longer function.

The remote password can be reset in one of two ways:

1. On instruments with a local GUI, a new password can be set WITHOUT triggering a master reset.

2. To reset the password remotely, the system override reset_remote_password command will have to be used.

The command can be sent through a connection to the 8001(normal socket)/8002(secure socket) port of the instrument

reset_remote_password,<system_override_specific_password>

Please read the user manual for more details about the system override password.

Note that resetting the password through system override will clear the password, set the remote password state to OFF,

and trigger a master reset (which clears all user files).

Set a new remote password.

1. StringValue: The current encrypted password in base64 string.

2. StringValue: The new encrypted password in base64 string.

The current and new passwords must be encrypted using OpenSSL RSA encryption algorithm with Anritsu Remote Password public key and OAEP padding mode. Use :SYSTem:PASSword:SSLKey to get Anritsu Remote Password public key.

Sending an invalid current password generates error -221 (setting conflict).

Sending a new password not meeting the password complexity rules generates error -232 (invalid format).

The command is only available if the Secure Communication option is installed.

On a secure socket connection, the command is only accessible after command :SYSTem:PASSword:CENable has been received with a valid password.

The remote password is empty by default.

A new password must pass the following checks to be accepted:

1. It must have 12 characters minimum and 64 characters maximum.

2. It must have letters and number(s).

3. It must have both lowercase and uppercase letters.

4. It must have at least one special character. Valid special characters are @#$_&-+=%*"':;!?() ,.`~/{}[]<>

5. It must not have 5 or more increasing sequential numbers (such as 12345).

6. It must not have 5 or more repeated characters (such as aaaaa).

Remote Password Public Key

Return Anritsu OpenSSL RSA public key (in PEM format). The key is used to encrypt the remote password parameter for password protected commands such as :SYSTem:PASSword:CENable.

The key is returned in IEEE definite length arbitrary block format:

<#AX><key> where A is a single ascii digit (1-9) describing the number of bytes in the length section (X).

X is ascii string of digits (0-9) describing the length of the <key>.

The command is only available if the Secure Communication option is installed.

Remote Password State

Returns whether the instrument is locked behind a remote password. While remote password is turned on, only

commands that are not password protected will be processed until either the connection itself is unlocked using

:SYSTem:PASSword:CENable or if the remote password state is turned off using :SYSTem:PASSword:CENable:ALL

This command presets parameters in the current application to their factory default values.

This command presets parameters in the current mode to their factory default values.

This command saves the current state of the instrument and reboots the instrument.

Remote Control State

This command restricts front panel activity on the instrument until remote control is turned off either through this SCPI command or through a button on the front panel.

The query will return 1 if the pop-up is active, or 0 if the pop-up is inactive.

Set System Footer Shortcuts

This command allows saving up to 5 setup files into shortcuts will display at the base of the user interface.

This will allows easy access to loading frequently used setups. The shortcuts are numbered 1-5 from left to right.

1. Numeric Value: The shortcut number that you would like to set

2. Name value: The name that will be displayed on the user interface screen.

3. File path: The file path (including the file name) relative to the MSUS. File extension can be specified, but is not required. Only .stp files will be accepted. If left blank, it will save the current setup and the file will be saved to a default file

Set shortcut #3 to file example_file.stp in your instrument file folder: SYST:SET:SHOR 1,"EMF Setup 1", "example_file.stp"

Set the current setup of Spectrum to shortcut #1: SYST:SET:SHOR 2,"SPEC 10 MHz"

SYST:SET:SHORT? will return as: [{"app":"SPA","file":"example_file.stp.stp","mode":"SPEC","name":"EMF Setup 1"},{"app":"SPA","file":"SPEC_10_MHz.stp","mode":"SPEC","name":"SPEC 10 MHz"},{"app":"N/A","file": "N/A","mode":"N/A","name":"SHORTCUT"}]

<numeric_value>,<string>,[<string>]

[{"app":"N/A","file":"N/A","mode":"N/A","name":"SHORTCUT","status":false,"lastLoaded":false}]

Load System Footer Shortcuts

This command will clear all of the System Setup shortcuts returned by SYST:SET:SHOR?

Delete a Single System Footer Shortcut

This command will delete a single System Setup shortcuts returned by SYST:SET:SHOR? at the given index

Load System Footer Shortcuts

This command will load the setup saved at the given shortcut number.

1. Numeric Value: The shortcut number that you would like to load

Usage: SYST:SET:SHOR:LOAD 2

Rename System Footer Shortcuts

This command allows renaming a shortcut display name.

1. Numeric Value: The shortcut number that you would like to set

2. Name value: The new name that will be displayed on the user interface screen for that given shortcut number.

Usage: SYST:SET:SHOR:LOAD 2, "Example Name"

SYST:SET:SHORT? will return as: [{"app":"SPA","file":"example_file.stp.stp","mode":"SPEC","name":"EMF Setup 1"},{"app":"SPA","file":"SPEC_10_MHz.stp","mode":"SPEC","name":"Example Name"},{"app":"N/A","file": "N/A","mode":"N/A","name":"SHORTCUT"}]

<numeric_value>,<string>

This command shuts down the instrument. The current instrument state and settings will be saved.

This command returns the CPU temperature in Celsius.

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.

<numeric_value>,<numeric_value>,<numeric_value>

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.

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.

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.

(UTC-08:00) America/Los_Angeles

System Time Zone Catalog

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

This command sets/queries the unit name of the current system.The name of the unit must not be greater than 45 ASCII characters

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.

Trigger Port Direction

This command configures the direction of the trigger ports, which can behave as either trigger in or trigger out. The command suffix selects which of the two trigger ports to configure. Note that port 1 doubles as a reference out port and cannot be a reference out and trigger port at the same time. To use port one as a trigger port the reference output state must be turned off (see the 10MHz Reference Output State) command. For port 2 when set to trigger out, the GPS PPS will be the pulse output. Command not available on the MS2080A or MS2070A, where the direction is always IN.


	Anritsu Company 1-800-ANRITSU 10450-00078, Rev. A