1. Configure Node Name

View Node Name

get name

Displays the node's configured name.

Change Node Name

set name <name>

Sets the node's advertised name.

Parameter:

  • name — The name assigned to the node.

Build flag: ADVERT_NAME

Default: Varies by board.

Notes:

  • Advertised names can use up to 23 bytes when location is included and 31 bytes otherwise.
  • Emoji and Unicode characters may use multiple bytes.
  • Names exceeding the available advertisement space are truncated at a valid UTF-8 character boundary.

2. Configure Node Location

View or Set Latitude

View current latitude:

get lat

Set latitude:

set lat <degrees>

Sets the node's geographical latitude.

Parameters:

  • degrees — Latitude in degrees.

Build flag: ADVERT_LAT

Default: 0

View or Set Longitude

View current longitude:

get lon

Set longitude:

set lon <degrees>

Sets the node's geographical longitude.

Parameters:

  • degrees — Longitude in degrees.

Build flag: ADVERT_LON

Default: 0

3. Manage Node Identity

View Private Key

get prv.key

Displays the node's private key.

Availability: Serial connection only.

⚠️ Security warning: Your private key is sensitive. Never share it publicly or include it in screenshots or support requests.

Change Private Key

set prv.key <private_key>

Changes the node's private key.

Parameter:

  • private_key — Private key in hexadecimal format (64 hexadecimal characters).

Availability: Setting the private key is not serial-only.

Note: A reboot is required for the change to take effect.

View Public Key

get public.key

Displays the node's public key.

4. Manage Admin Password

password <new_password>

Changes the node's admin password.

Parameter:

  • new_password — The new admin password.

Build flag: ADMIN_PASSWORD

Default: password

Notes:

  • The command reply echoes the updated password for confirmation.
  • Any node using this password will be added to the admin access control list (ACL).

⚠️ Security warning: Change the default password and avoid sharing passwords in public messages or documentation.

5. Manage Guest Password

View Guest Password

get guest.password

Displays the configured guest password.

Change Guest Password

set guest.password <password>

Sets the guest password.

Parameter:

  • password — The guest password.

Build flag: ROOM_PASSWORD (Room Server only).

Default: Blank.

6. Configure Owner Information

View Owner Information

get owner.info

Displays the configured owner information.

Set Owner Information

set owner.info <text>

Sets the node's owner information.

Parameter:

  • text — The owner information text.

Default: Blank.

Requirements: Firmware v1.12 or later.

Note: Pipe (|) characters are translated into newlines.

7. Calibrate Battery Readings

View ADC Multiplier

get adc.multiplier

Displays the configured analogue-to-digital converter (ADC) multiplier.

Set ADC Multiplier

set adc.multiplier <value>

Adjusts the multiplier used for battery readings.

Parameter:

  • value — ADC multiplier between 0.0 and 10.0.

Default: 0.0 (the actual value is defined by the board).

Note: If the hardware does not support this setting, the command returns:

Error: unsupported by this board

8. View Firmware Version

ver

Displays the node's current firmware version.

9. View Node Role

get role

Displays the node's configured role.

10. Configure Power Saving

Availability: Repeaters only.

View Power-Saving Status

powersaving

Displays or reports the power-saving status.

Enable Power Saving

powersaving on

Enables power-saving mode.

Disable Power Saving

powersaving off

Disables power-saving mode.

Parameter:

  • on — Enables power saving.
  • off — Disables power saving.

Default: off

Note: When enabled, the device enters sleep mode between radio transmissions.