Command Line Interface Convention - Javad HPT435BT User Manual

Command Line Interface
The built-in user-friendly Command Line Interface (CLI) allows user to
perform a full configuration of the unit and read the statistics and alarm
status. It is the most powerful tool to configure the unit. It makes changes
to all possible settings that system will not be able to determine automat-
ically.
The CLI commands allow user to configure and reconfigure the unit's set-
tings. The user configuration parameters that could be changed through
the CLI are:
• Data Port Settings
• Baud Rate
• Data Bits (8, 7)
• Parity (Odd, Even, None)
• Flow control (None or RTS/CTS)
• Alarm Settings
• Radio Operation Modes
• Sleep modes
• On/Off
• Activate by internal real-time clock
• Activate through RTS/CTS lines
• Activate by external sense lines
• Activate by any combination of the parameters mentioned before
Note: The unit's configuration that is set or modified through the CLI will be lost after
unit's reboot, unless the saving operation is used to store a new setting in the unit's con-
figuration file.
The CLI commands also provide filing operations, which include:
• Downloading Unit's Configuration files
• Software Images
• Uploading Unit's Configuration files
• Saving into the configuration files the configuration parameters mod-
ified through the CLI.
www.javad.com

Command Line Interface Convention

The following convention is implemented in HPT435BT Command Line
Interface (CLI):
• The Carriage Return/Line Feed (CR/LF, 0x0D/0x0A) is a command
delimiter.
• The Carriage Return/Line Feed (CR/LF, 0x0D/0x0A) is a reply de-
limiter followed by the "CLI>" prompt if Echo option is On.
• The Carriage Return/Line Feed (CR/LF, 0x0D/0x0A) is a reply de-
limiter if Echo option is Off (default option).
• The 2-digit number followed by "@" in the unit's reply indicates the
error code (refer to Table 3 for description), if Echo Off is selected,
otherwise the error message is displayed.
• A successfully performed command is replied by @00 code, if Echo
Off is selected, otherwise the set value is replied.
• A command with the certain [Parameter Name] and blank [Parameter
List] displays the current settings for a given parameter.
• To set the mode ordered by CLI commands as permanent User Set-
ting (the setting automatically selected for the boot-up unit) the SAVE
command must be asserted.
• A command followed by "/F" option displays the Parameters in the
predefined frame format. The display frame format is unique for each
command supporting "/F" option.
Table 1. Command Line Interface Error Codes
Error Code Short Description
0x01 Command Syntax Error. A command followed by "/?" displays a command usage.
The parameter has a format error. A command with the certain [Parameter Name] followed
0x02
by "/?" displays the format and range of the variable.
The parameter is out of allowed range. A command with the certain [Parameter Name]
0x03
followed by "/?" displays the format and range of the variable.
17