Command Syntax

V1 firmware commands are ASCII tokens followed by optional arguments. A command can read a value, write a value, or perform an action.

Read commands

A read command is sent without arguments:

>> rtset
10000.000

The exact number of decimals depends on the command implementation.

Write commands

A write command is sent with one or more arguments:

>> rtset 12000
12000.000

Most read/write commands return the resulting value after the write. If the argument is invalid or the current access mode does not allow the write, the command sets an error and typically leaves the value unchanged.

Action commands

Action commands perform an operation rather than representing a physical value. For example:

>> save
config saved
>> errclr
ffffffff

Some action commands are intentionally hidden from help or require an advanced access mode.

Command lookup

Use the full command names documented in the product command table. Internally, the firmware dispatcher uses the command token and fixed command slots. Do not rely on undocumented abbreviations in user applications.

Argument separators

Arguments may be separated by spaces, tabs or commas. Use spaces in examples and scripts:

>> ntccal 1.0 2.0 3.0
1.000000 2.000000 3.000000

Comma-separated arguments are also accepted by the common argument parser.

Argument types

The command metadata uses compact format characters:

• f: floating-point value.
• u: unsigned decimal integer.
• x: hexadecimal integer.
• s: text string.
• b: raw binary payload or raw binary reply.

Product command tables show the command type and unit when this information is available.

Floating-point values

Floating-point arguments support normal decimal notation and optional exponent notation:

>> rtset 12000
12000.000
>> rtset 1.2e4
12000.000

Invalid floating-point arguments set a command error.

Decimal integers

Decimal integer commands are used for enable flags, mode selection, IDs and baud rates:

>> lason 0
0
>> bdid 2
2

Hexadecimal values

Hexadecimal arguments are used by commands such as err, errmsk, errclr, memr, memw, regs and sequencer lines. For user memory pages, both forms are accepted:

>> memr 0
<32 raw bytes>
>> memr 0x00
<32 raw bytes>

For sequencer page targets and register values, use the format shown on the Sequencer page.

Access modes

Some commands can always be read but require a higher access mode to write. For example, identification commands are readable, while commands such as memw, brate, muxon, bdid, regs writes and sequencer configuration require advanced access.

When a write is not allowed, the firmware sets an invalid-argument error. See User Modes.

Hidden commands

The help command lists only non-hidden commands. Hidden commands may still exist for binary polling, production, calibration, diagnostics or software integration. Do not use hidden commands in normal customer scripts unless they are documented for that purpose.