Custom CLI Commands¶

This page covers the EastMesh-specific CLI commands added in this repository.

It does not try to repeat the full upstream MeshCore CLI surface.

Repeater MQTT Commands¶

These commands are available on *_repeater_mqtt firmware targets.

get mqtt.status: shows WiFi, NTP, IATA, endpoint status, status publishing state, and TX state.
get mqtt.statuscfg: shows whether periodic status messages are enabled as a simple on or off value. Most users can just use get mqtt.status.
get mqtt.client_version: shows the MQTT client_version string published by the repeater.
get mqtt.iata: shows the IATA/location code used in MQTT topics.
set mqtt.iata <code>: sets the IATA/location code, for example MEL.
set mqtt.iata UNSET: marks MQTT IATA as not configured yet. While it is UNSET, enabled MQTT brokers stay disconnected until a real code is saved.

get mqtt.owner: shows the configured owner public key.
set mqtt.owner <64-hex-char-public-key>: sets the owner public key used in JWT metadata.
mqtt.owner <64-hex-char-public-key>: shorthand for setting the owner public key.
get mqtt.email: shows the configured owner email.
set mqtt.email <email>: sets the owner email used in JWT metadata.
mqtt.email <email>: shorthand for setting the owner email.

Notes:

new repeater MQTT installs default mqtt.iata to UNSET
letsmesh-eu and letsmesh-us remain off by default unless already configured in saved prefs
if mqtt.iata is UNSET, eastmesh-au, letsmesh-eu, and letsmesh-us will not connect even if they are toggled on

Legacy dotted aliases are also accepted:

get wifi.status: shows SSID, connection state, raw WiFi status code, and IP when connected.
get wifi.ssid: shows the configured WiFi SSID.
set wifi.ssid <ssid>: sets the WiFi SSID.
set wifi.pwd <password>: sets the WiFi password.
get wifi.powersaving: shows the current WiFi power save mode.
set wifi.powersaving none|min|max: sets WiFi power saving mode.

get web
get web.status: shows whether the local HTTPS panel is available.
get web.stats.status: shows whether the dedicated stats page and history subsystem are enabled, whether recent history is active, whether PSRAM-backed history is available, and whether the SD-backed archive is mounted. When enabled, the history capture now covers supported environment telemetry too, not just the original battery/radio series. GPS-enabled boards also record per-minute satellites samples for the /stats history view.
set web on|off
set.web on|off: enables or disables the local HTTPS panel.
set web.stats on|off
set.web.stats on|off: enables or disables the dedicated /stats page and historical stats collection.

memory: shows current heap and PSRAM usage.
stats-core: shows battery, uptime, sticky error count, and outbound queue depth.
stats-radio: shows radio noise floor, last RSSI, last SNR, and TX/RX airtime.
stats-packets: shows packet receive/send totals, flood/direct breakdown, and receive errors.

If noise_floor reports 0, check get agc.reset.interval; if it is not 0, try set agc.reset.interval 0 and test again.

On repeater MQTT builds, background battery sampling used for MQTT/status history is rate-limited to about once per minute. Explicit status and telemetry requests still refresh the reading immediately.

These commands are only available on LilyGo_TBeam_1W_* repeater builds.

get fan: shows the current fan mode, current fan state, and the last NTC-based board temperature when available.
set fan auto: returns the fan to automatic control and persists that mode across reboot.
set fan on: forces the fan on and persists that mode across reboot.
set fan off: forces the fan off and persists that mode across reboot.
set fan timeout <Ns>: changes the automatic post-TX hold window in seconds and persists it across reboot, for example set fan timeout 45s.

Auto mode behavior:

forces the fan on during TX and keeps it on for the configured timeout afterward
otherwise turns the fan on at 48C
turns it back off at 42C
keeps the fan on if the NTC reading is unavailable

Notes:

When the repeater web panel is enabled and you are authenticated, the browser CLI panel can run the same CLI commands accepted by the repeater.

Notes:

the panel still uses the repeater admin password for access
commands run with the same care as if you typed them into the repeater CLI directly
this is intended for local admin use on a trusted network
start ota releases the local HTTP redirect listener on port 80 so the OTA HTTP listener can take over without stopping the rest of the repeater services, regardless of whether the command is run from the web panel, serial CLI, or a remote companion/app CLI session
the /app Regions shortcut runs the existing MeshCore region commands in sequence: region put au, region put au-STATE, region allowf au, region allowf au-STATE, then region save

These commands are available in the serial rescue CLI for *_companion_radio_wifi builds.

To enter CLI Rescue:

open a serial monitor at 115200 baud
reboot the device
long-press the user button within the first 8 seconds after boot
wait for ========= CLI Rescue =========
get wifi.status: shows configured SSID, connection status, raw WiFi status code, and IP when connected.
get wifi.ssid: shows the configured WiFi SSID.
get wifi.powersaving: shows the current WiFi power saving mode.
set wifi.ssid <ssid>: saves a WiFi SSID and immediately retries connection.
set wifi.pwd <password>: saves a WiFi password and immediately retries connection.
set wifi.powersaving none|min|max: changes the WiFi power save mode.

Companion WiFi builds also still support the existing rescue commands such as: