Part 1: Sensors

Available when sensor support is compiled into the firmware.

1. View the List of Sensors

Display the sensors available on the node and their current values.

Command:

sensor list [start]

Parameters:

ParameterDescription
startOptional starting index for the list. Defaults to 0.

Output format:

<var_name>=<value>

Each sensor is displayed on a separate line, with its variable name and current value.

Example:

sensor list
sensor list 5

The first command lists sensors from the beginning. The second starts listing from index 5.


2. View or Change a Sensor Value

Retrieve or modify a sensor setting.

Commands:

sensor get <key>
sensor set <key> <value>

Parameters:

ParameterDescription
keyName of the sensor or setting.
valueValue to assign to the sensor setting.

Examples:

sensor get <key>
sensor set <key> <value>

Note: Available sensor keys and supported values depend on the sensors and firmware configuration.


Part 2: Bridge

Available when bridge support is compiled into the firmware.

3. View the Compiled Bridge Type

Display the bridge type included in the firmware build.

Command:

get bridge.type

Note: The available bridge functionality depends on the board, firmware build, and supported external interface.


4. View or Change the Bridge Enabled State

Check whether the bridge is enabled or enable or disable it.

Commands:

get bridge.enabled
set bridge.enabled <state>

Parameters:

ParameterDescription
stateSet to on to enable the bridge or off to disable it.

Default: off

Examples:

Enable the bridge:

set bridge.enabled on

Disable the bridge:

set bridge.enabled off

5. Configure the Bridge Packet Delay

View or change the delay applied to packets routed through the bridge.

Commands:

get bridge.delay
set bridge.delay <ms>

Parameters:

ParameterDescription
msDelay in milliseconds, from 0 to 10000.

Default: 500 milliseconds.

Examples:

get bridge.delay
set bridge.delay 1000

The second command sets the bridge delay to one second.


6. Configure the Bridged Packet Source

Choose which packets are forwarded to the external interface.

Commands:

get bridge.source
set bridge.source <source>

Parameters:

SourceDescription
logRxBridge received packets.
logTxBridge transmitted packets.

Default: logTx

Examples:

Bridge received packets:

set bridge.source logRx

Bridge transmitted packets:

set bridge.source logTx

7. Configure the Bridge Baud Rate

RS-232 bridges only.

View or change the serial communication speed used by the bridge.

Commands:

get bridge.baud
set bridge.baud <rate>

Parameters:

ParameterDescription
rateBaud rate. Supported values are 9600, 19200, 38400, 57600, and 115200.

Default: 115200

Example:

set bridge.baud 9600

Note: The connected serial device must use the same baud rate.


8. Configure the Bridge Channel

ESP-NOW bridges only.

View or change the wireless channel used by the bridge.

Commands:

get bridge.channel
set bridge.channel <channel>

Parameters:

ParameterDescription
channelChannel number from 1 to 14.

Example:

set bridge.channel 6

Note: Ensure the connected ESP-NOW device uses a compatible channel.


9. View or Change the ESP-NOW Bridge Secret

Configure the secret used by the ESP-NOW bridge.

Commands:

get bridge.secret
set bridge.secret <secret>

Parameters:

ParameterDescription
secretESP-NOW bridge secret, up to 15 characters.

Default: Varies by board.

Example:

set bridge.secret <secret>

Security note: Treat the bridge secret as sensitive configuration information. Use a suitable secret and avoid sharing it publicly.


Part 3: Bootloader Information

10. View the Bootloader Version

nRF52 boards only.

Display the installed bootloader version.

Command:

get bootloader.ver

Note: This command is specific to supported nRF52 hardware.


Part 4: Power Management

11. View Power Management Support

Check whether the board supports power management features.

Command:

get pwrmgt.support

Note: The reported support depends on the board's hardware and firmware.


12. View the Current Power Source

Display the current power source reported by the device.

Command:

get pwrmgt.source

Note: Returns an error on boards without power management support.


13. View Boot Reset and Shutdown Reasons

Display the recorded reason for the device's boot, reset, or shutdown.

Command:

get pwrmgt.bootreason

Note: Returns an error on boards without power management support.


14. View the Boot Voltage

Display the voltage recorded at boot.

Command:

get pwrmgt.bootmv

Note: Returns an error on boards without power management support.


Important Notes

  • Firmware support: Sensor and bridge commands require the corresponding feature to be compiled into the firmware.
  • Hardware compatibility: Some commands are limited to specific hardware, including RS-232 bridges, ESP-NOW bridges, and nRF52 boards.
  • Configuration values: Use the documented parameter ranges and supported values when changing settings.
  • Power management: Power source, boot reason, and boot voltage commands may be unavailable on unsupported boards.
  • Security: Keep bridge secrets private and use appropriate credentials for your configuration.