Introduction#

The command-line interface used to access the adapter is called the Admin Console. The Admin Console supports a range of commands to control or configure different parts of the adapter.

Each command includes one or more subcommands, which may accept arguments or options. These arguments can be optional or required. Some subcommands also include additional nested subcommands.

In some cases, entering the top-level command displays help text or general information about the related feature.

The general syntax for command usually follows one of the patterns listed below, where:

  • [] indicates optional elements

  • <> indicates required elements

Command Line Syntax

$ command
$ command subcommand
$ command subcommand subsubcommand
$ command subcommand [argument]/<argument>
$ command subcommand [argumentName <argumentValue>]
$ command subcommand [argumentName <argumentValue>] [--option]
$ command subcommand subsubcommand [argumentName <argumentValue>] [--option]

Command Line Examples

$ boardid
$ net mac
$ net ip conn
$ target power off
$ net ip addr 192.168.0.1
$ target voltage 3.3 --nocalibrate
$ serial vcom config handshake rts --nostore

Help Text#

In addition to this documentation, the Admin Console provides built-in help text that briefly explains the functionality and syntax of the commands. This help text can be shown by entering a command, a command with a subcommand, or a command with subcommands followed by h or help. Usually, the help text is also shown whenever a command is entered incorrectly.

Help Text Examples

$ help

Run any command followed by "help" to show subcommands.

*************** Root commands ****************
aem           AEM commands   [ calibrate, current, dump, ... ]
boardid       Commands for board ID probe.   [ list, probe ]
dbg           Debug interface status and control   [ info, mode,]
dch           Datachannel control and info commands   [ info, message ]
discovery     Discovery service commands.   [ key ]
net           Network commands.   [ dnslookup, ip, mac ]
pti           Packet trace interface status and control   [ config, disable, dump, ... ]
quit          Exit from shell
serial        Serial channel commands   [ vcom ]
sys           System commands   [ crashlog, nickname, reset, ... ]
target        Target commands.   [ button, go, halt, ... ]
time          Time Sync Service commands   [ client, disable, info, ... ]
user          User management functions   [ login,]

$ net help

net: Network commands.

*************** net commands ****************
dnslookup     Performs a DNS lookup for a named host
ip            Shows current IP configuration.    [ addr, config, conn, ... ]
mac           Show the Mac Address of the kit

net ip help

ip: Shows current IP configuration.

*************** ip commands ****************
addr          Set or show IP address. CIDR notation.
config        <IP/prefix> <gateway> [DNS server]
conn          Connection list
dhcp          "enable" enables the DHCP client. Set an IP manually to disable.
dns           Set or show DNS server address.
gw            Set or show gateway address.

net ip addr help

addr: Set or show IP address. CIDR notation.

*************** addr commands ****************
None

Command Categories#

Each top-level command has a dedicated page with the following structure:

  1. A title with icons indicating which kits support the command.

  2. A table listing each command and a brief description. If some subcommands are not supported by all kits, an additional column for supported kits is included.

  3. A detailed description of each command, including the supported command-line syntax and an example.