Microchip Technology SA5 Series, User Manual

Page: 37 / 63

Command Line Interface

2019 Microchip Technology Inc. DS50002938A-page 37
4.5 COMMANDS
The Microchip SA5X provides access to all device features, status, and measurements
through the C3 command set.
In addition to these standard commands, backwards compatibility with the
MAC-SA.3Xm line of Rubidium Oscillators is provided through a set of compatibility
commands (See
Appendix B. “Legacy Command Set (SA.3Xm)” ). Only a subset of
the device’s functionality is available through the compatibility command interface; it is
included to ease the design transition from the SA.3X devices to the newer C3 protocol.
4.5.1 Command Index
The following table contains the available C3 commands. Refer to the next section for
detailed command usage.
TABLE 4-12: COMMAND DESCRIPTIONS
Command Arguments Description
Device Identification Commands
app?
0
Returns a short string identifying the firmware application
type.
device?
0 Returns a short string identifying the device type.
platform?
0
Returns a short string identifying the firmware platform of the
device.
describe?
0 Returns a readable English description of the device.
swrev?
0 Returns the software revision.
hwrev?
0 Returns the hardware revision.
serial?
0 Returns the serial number of the unit.
help
0 Returns a list of available commands.
Parameter Commands
get
1 Returns the current value of a parameter.
set
2 Sets the value of a parameter.
add
2 Adds to the current value of a parameter.
browse
1-2 Returns information about one or more parameters.
upd
0
Returns a list of all parameter values that changed since the
last upd.
Alarms Command
ackalm
1
Acknowledges an alarm, preventing it from contributing to the
ALARM pin state.
Configuration Management Commands
store
0 Stores the current configuration to flash memory.
latch
0
Latches the current frequency and clears the digital tuning
parameter.
load
0 Loads the most recent configuration from flash memory.
Miscellaneous Commands
extremes?
1
Returns the minimum and maximum measurements for cer-
tain parameters over the life of the unit.
health?
1 Returns health estimates of certain components.
reset
0 Resets the CPU.