EchoBridge Shell Commands

The device's command shell may be accessed via USB CDC virtual serial port if the enable_console option is set, or via telnet if enable_telnet is set. The shell uses ANSI control and color codes for formatting. A terminal emulator like PuTTY can be used for either method.

All shell commands can be abbreviated to just the number of characters required to be unique, e.g., STA for STATUS. Use the up and down arrow keys to scroll through the command history.

Warning

While the style of the shell should be familiar to Linux and DOS users, keep in mind that the shell is not directly related to any other common shell and similar-looking commands may not function exactly the same. Users should take particular care when using wildcards and moving or deleting files.

Shell Command Reference

System Commands

STATUS [on|off] : Enables or disables status bar in terminal. Shows TX/RX status and RX audio level.

IDENT : Flashes LEDs to identify device. Useful if you're connected via telnet and have multiple devices.

UPDATE : Starts the network update process. Downloads and installs new firmware, if available.

UPTIME : Displays the system uptime.

VERSION : Displays the firmware version.

EXIT : Exits shell. Only useful for telnet connections.

INFO : Show radio information.

Configuration Commands

SET <parameter> : Sets a configuration parameter. See parameter listing below.

SHOW <parameter> : Displays a configuration parameter. Use show * to list all parameters.

SAVE : Saves the current configuration to non-volatile memory.

Network Commands

NSLOOKUP <hostname> : Performs a DNS lookup and returns an IP address.

TELNET <hostname> [port] : Starts telnet client and connects to a remote system.

NETSTAT : Displays information about active network connections and listeners.

FETCH <url> [filename] : Retrieves a file from the network. Supports HTTP and HTTPS. If a filename is entered, the downloaded file is saved with that name, otherwise it keeps its original name.

File System Commands

CD <directory> : Change working directory.

DIR [path] : Lists directory contents.

COPY <src> <dest> : Copy a file.

DEL <file> : Deletes a file.

MKDIR <directory> : Creates a directory.

RMDIR <directory> : Removes a directory.

RENAME <old> <new> : Renames a file.

MOVE <file> <destination> : Moves a file to the specified directory.

TYPE <filename> : Displays contents of a text file.

WRITE <file> <text> : Writes a line of text to a file. Appends if file exists.

EDIT <filename> : Launches full-screen text editor. ++ctrl+s++ saves, ++ctrl+q++ quits.

TAR : Lists the contents of a TAR archive file.

REMOUNT : Forces a remount of the file system. This may be needed if files have been modified by a USB host.

MKFS : Format file system and erase all files.

Firmware and Execution Commands

LOADFW <filename> : Loads a firmware update.

RUN <filename> : Executes a batch file or BASIC program.

WAIT <milliseconds> : Pauses the shell for the specified duration.

ECHO <string> : Echoes text back to the command console.

REM : Comment, does nothing. Use for batch files.

PS : Displays information about running processes.

Reset Commands

RESET DEFAULT : Resets to default settings.

RESET SYSTEM : Resets the system after a 3-second pause.

RESET FLASH : Performs a mass erase on the flash memory.

Debug Commands

DEBUG ON : Starts output of debugging messages.

DEBUG OFF : Disables debug output.

DEBUG SAVE : Saves raw configuration data in binary to config.bin.

DEBUG LOAD : Loads raw configuration data from config.bin.

Non-Volatile Memory Commands

NVMREAD <record> : Displays the contents of the specified record in non-volatile memory.

NVMWRITE <record> <data> : Sets a non-volatile memory record.

NVMDEFRAG : Consolidates non-volatile storage.

NVMFORMAT : Erases contents of NVM.

NVMDUMP : Dumps contents of NVM.

NVMERASE <record> : Erases an NVM record.

Command Aliases

Unix-style aliases are available for common commands:

Alias	Command
LS	DIR
RM	DEL
MD	MKDIR
MAN	HELP
CAT	TYPE
CP	COPY
MV	MOVE

Configuration Parameters

These configuration parameters are set using the set command and viewed using the show command. Example: set cw_id on

cw_id_on [on|off] : Enables the automatic Morse code ID

cw_id [on|off] : Sets the identification string to send for the CW ID function. Maximum length is 15 characters.

cleanup [on|off] : If enabled, rather than sending a CW ID at a fixed interval while the system is inactive, a final CW ID is sent after a period of activity and then no ID is sent until after the next period of activity.

cw_time <seconds> : Sets the interval of the automatic CW ID in seconds.

cw_pitch <Hz> : Sets the pitch in Hz of the CW ID tone.

cw_speed <wpm> : Sets the Morse code speed in words per minute.

enable_telnet [on|off] : Enables the telnet server for remote access.

use_telnet_password [on|off] : If enabled, requires a password for telnet access.

use_http_password [on|off] : If enabled, requires a password for access to the web interface.

remote_password <password> : Sets the password used for remote access, if enabled.

use_dhcp [on|off] : Enables the use of DHCP for automatic network configuration.

privacy_mode [on|off] : If enabled, prevents unit from registering with the device location service or checking for firmware updates.

ntp_sync [on|off] : If enabled, the device will periodically synchronize its real-time clock from an NTP server.

ntp_server <hostname or IP address> : Sets the hostname of the NTP time server to use for sychronizing the real-time clock.

name <device name> : Sets the name of the device. Used for syslog reporting.

syslog_server <hostname:port> : Sets the hostname of the syslog server and optionally the port number for remote logging.

log_level <0-7> : Sets the severity threshold for syslog messages sent to the local console, ranging from 0 = emergency to 7 = debug.

remote_log_level <0-7> : Sets the severity threshold for syslog messages sent to the remote server.

echolink_name <username> : Sets the username used to log in to the EchoLink server.

echolink_qth <location> : Sets the location/QTH reported to the EchoLink server.

echolink_email <email> : Sets the user's email address reported to the EchoLink server.

echolink_password <password> : Sets the password used to log in to the EchoLink server.

echolink_validate [on|off] : If enabled, incoming EchoLink connections will only be accepted if the EchoLink server validates the connecting user as properly logged in.

conf_banner <text> : Sets the welcome banner text displayed to connecting EchoLink conference users.

rtp_rx_timeout <msec> : Sets the timeout in milliseconds for incoming RTP audio. No explicit PTT signal is sent by the remote system, so the EchoBridge determines when a transmission coming in from the network has ended based on a lack of new RTP audio. The default value is 250 milliseconds. Setting this value too low may cause PTT to drop prematurely in cases of network congestion. Setting it higher than needed will result in a longer PTT hang time after the remote user stops talking.

rtcp_timeout <seconds> : Active EchoLink conference participants send periodic RTCP status/control packets. Remote nodes that have shut down without notice will dropped from the conference after this time interval has expired without any RTCP status packets.

max_users <number> : Sets the maximum number of allowed users in the EchoLink conference.

enable_dtmf [on|off] : Enables or disables the use of DTMF codes for controlling EchoLink connections from RF.

enable_conf_beeps [on|off] : Enables or disables EchoLink conference status beeps when nodes connect or disconnect.

use_echolink [on|off] : If enabled, the device will attempt to log in to the EchoLink directory service. When EchoLink is not enabled, direct conference connections by IP address and point-to-point RTP connections are still possible.

voice_status [on|off] : Enables or disables voice status when nodes connect or disconnect.

say_callsigns [on|off] : If enabled, the voice status feature will spell out callsigns of connecting or disconnecting nodes.

defer_announcements [on|off] : If enabled, status announcements will be deferred until the end of the current transmission.

favorite<n> <node> : Favorite slots 1-20 set favorite node names, node numbers, or IP addresses that can be selected with a 2-digit number via DTMF. Example: set favorite1=*NEWSLINE*

favaddr<n> <ip address> : For favorite entries not using the EchoLink directory service, use this to set the IP address for the favorite entry.Example: set favaddr1=192.168.123.224

rx1_vox_threshold <0-99> : Sets the audio level threshold in percent (0 to 99) of the VOX trigger. Setting this number lower makes the VOX system more sensitive, higher values are less sensitive.

rx1_vox_delay <msec> : Sets the delay in milliseconds before an incoming signal above the VOX threshold is considered valid.

rx1_vox_timeout <msec> : Sets the VOX timeout in milliseconds. A higher value will result in a longer hang time at the end of incoming transmissions.

rx1_cor_mode [0|1|2] : Sets the carrier detect mode. 0 = VOX (triggered on audio above vox_threshold), 1 = COR active high, 2 = COR active low

rx1_tx_delay <msec> : Sets the transmit delay in milliseconds. This determines the interval between keying the transmitter and the start of transmitted audio.

tx1_ptt_timeout <seconds> : Sets the timeout period for the transmitter. This prevents excessively long transmissions from keeping the transmitter keyed continuously.

tx1_cooldown <seconds> : Sets the transmitter cooldown time in seconds. If the transmitter times out, no transmissions will be made until the cooldown timer expires.

tx1_hang_time <msec> : Sets the transmitter hang time in milliseconds. When an outgoing transmission ends, the transmitter will be kept keyed until this timer expires.

tx1_ht_ptt [on|off] : This option enables the HT style PTT signal where PTT is combined with the mic audio signal. Use this mode for most Yaesu, ICOM, and Alinco handheld radios.

conf_courtesy_tone <0-6> : Selects the courtesy tone used for transmissions originating from the network. 0 disables.

local_courtesy_tone <0-6> : Selects the courtesy tone used for transmissions originating from the EchoBridge itself.

tx1_level <0-3300> : Sets the transmitted audio level in mVp-p. Higher values are louder.

rx1_level <0-3300> : Sets the expected full-scale audio level in mVp-p. Higher values expect larger signals, thus lowering the number increases the loudness of the received signal.

rx1_independent [on|off] : Normally the transmitter and receiver are assumed to be the same half-duplex radio, and received audio is ignored while the transmitter is active. Setting rx1_independent=true separates the transmit and receive functions and allows full-duplex operation.

ip_address <ip> : Sets the network IP adddress, if DHCP is not used. Example: set ip_address=192.168.1.100

netmask <mask> : Sets the subnet mask, if DHCP is not used. Example: set netmask=255.255.255.0

gateway <ip> : Sets the network default gateway IP address, if DHCP is not used. Example: set gateway=192.168.1.1

dns_server <ip> : Sets the IP address of the DNS server, if DHCP is not used. Example: set dns_server=8.8.4.4