mirror of
https://github.com/mikecarper/MeshCore.git
synced 2026-09-16 13:32:35 +00:00
9975 lines
349 KiB
HTML
9975 lines
349 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="Documentation for the open source MeshCore firmware">
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://mikecarper.github.io/MeshCore/cli_commands/">
|
|
|
|
|
|
<link rel="prev" href="../cli_command_availability/">
|
|
|
|
|
|
<link rel="next" href="../companion_contact_cache/">
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="icon" href="../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.7">
|
|
|
|
|
|
|
|
<title>CLI Commands - MeshCore Docs</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.ec1eaa64.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_stylesheets/extra.css">
|
|
|
|
<link rel="stylesheet" href="../_stylesheets/firmware_picker.css">
|
|
|
|
<link rel="stylesheet" href="../_stylesheets/telemetry_decoder.css">
|
|
|
|
<link rel="stylesheet" href="../_stylesheets/filter_tool.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body dir="ltr">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#cli-commands" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<header class="md-header md-header--shadow" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href=".." title="MeshCore Docs" class="md-header__button md-logo" aria-label="MeshCore Docs" data-md-component="logo">
|
|
|
|
<img src="../_assets/meshcore.svg" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
MeshCore Docs
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
CLI Commands
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/mikecarper/MeshCore/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
mikecarper/MeshCore
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href=".." title="MeshCore Docs" class="md-nav__button md-logo" aria-label="MeshCore Docs" data-md-component="logo">
|
|
|
|
<img src="../_assets/meshcore.svg" alt="logo">
|
|
|
|
</a>
|
|
MeshCore Docs
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/mikecarper/MeshCore/" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
mikecarper/MeshCore
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Introduction
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../WiFi/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
WiFi and MQTT by Firmware Type
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cli_build_matrix/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
CLI Availability by Firmware Build
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cli_command_availability/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
CLI Command Availability Matrix
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
CLI Commands
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
CLI Commands
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#navigation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Navigation
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#operational" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Operational
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Operational">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reboot-the-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Reboot the node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#power-off-the-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Power-off the node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enter-the-uf2-bootloader-nrf52-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enter the UF2 bootloader (nRF52 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reset-the-clock-and-reboot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Reset the clock and reboot
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sync-the-clock-with-the-remote-device" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sync the clock with the remote device
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#display-current-time-in-utc" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Display current time in UTC
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-the-time-to-a-specific-timestamp" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set the time to a specific timestamp
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-flood-advert" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a flood advert
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-zero-hop-advert" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a zero-hop advert
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ask-a-usb-connected-host-service-over-lora-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Ask a USB-connected host service over LoRa (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#start-or-stop-an-over-the-air-ota-firmware-update" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Start or stop an Over-The-Air (OTA) firmware update
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#browser-configuration-portal-esp32-repeater-and-room-server" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Browser configuration portal (ESP32 repeater and room server)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Browser configuration portal (ESP32 repeater and room server)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-primary-esp-nowwifi-channel" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the primary ESP-NOW/WiFi channel
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#erasefactory-reset" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Erase/Factory Reset
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#neighbors-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Neighbors (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Neighbors (Repeater Only)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-nearby-neighbors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
List nearby neighbors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove-a-neighbor" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Remove a neighbor
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Discover zero hop neighbors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discover-neighbor-scopes-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Discover neighbor scopes (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#statistics" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Statistics
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Statistics">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-rate-limited-flood-adverts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
List Rate-Limited Flood Adverts
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#clear-automatic-flood-advert-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Clear Automatic Flood Advert History
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#clear-stats" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Clear Stats
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system-stats-battery-uptime-queue-length-and-debug-flags" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
System Stats - Battery, Uptime, Queue Length and Debug Flags
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#radio-stats-noise-floor-last-rssisnr-airtime-receive-errors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#packet-stats-packet-counters-received-sent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Packet stats - Packet counters: Received, Sent
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#read-repeater-and-room-server-telemetry-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Read repeater and room-server telemetry history
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-companion-display-rotation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set Companion display rotation
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-touchscreen-touch-areas" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show touchscreen touch areas
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-display-modes-and-timeouts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set display modes and timeouts
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-companion-inbox-behavior" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set Companion inbox behavior
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-mqtt-observer-display-flip" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set MQTT observer display flip
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#logging" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Logging
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Logging">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#control-live-usb-logging" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Control live USB logging
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#begin-capture-of-rx-log-to-node-storage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Begin capture of rx log to node storage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#end-capture-of-rx-log-to-node-storage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
End capture of rx log to node storage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#erase-captured-log" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Erase captured log
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#print-the-captured-log-to-the-requesting-terminal" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Print the captured log to the requesting terminal
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#info" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Info
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Info">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-the-version" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Get the Version
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-the-hardware-name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show the hardware name
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-the-storage-layout" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show the storage layout
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configuration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Configuration
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Configuration">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#radio" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Radio
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Radio">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-radio-parameters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's radio parameters
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-transmit-power" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's transmit power
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#change-the-radio-parameters-for-a-set-duration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Change the radio parameters for a set duration
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#schedule-radio-parameter-changes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Schedule radio parameter changes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-frequency" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's frequency
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-rx-duty-cycle-power-saving" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change RX duty-cycle power saving
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the LoRa FEM receive-path gain state on supported boards
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-lora-fem-transmit-path-gain-state-on-supported-boards" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the LoRa FEM transmit-path gain state on supported boards
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
System
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="System">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's name
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-independent-bluetooth-name-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the independent Bluetooth name (Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-bluetooth-address-ble-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the Bluetooth address (BLE Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-bluetooth-stealth-ble-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change Bluetooth stealth (BLE Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-latitude" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's latitude
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-longitude" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's longitude
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-identity-private-key" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's identity (Private Key)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-admin-password" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's admin password
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-guest-password" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's guest password
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-owner-info" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's owner info
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fine-tune-the-battery-reading" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Fine-tune the battery reading
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-repeater-flood-text" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a repeater flood text
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-battery-alert-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change battery alert state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-battery-alert-thresholds" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change battery alert thresholds
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-the-rx-inactivity-watchdog-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable the RX inactivity watchdog (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-the-nrf52-system-watchdog" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable the nRF52 system watchdog
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#estimate-and-correct-infrastructure-node-time-after-startup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Estimate and correct infrastructure-node time after startup
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-public-key" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's public key
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-firmware-version" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's firmware version
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-configured-role" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's configured role
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-power-saving-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's power saving flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-set-the-reboot-interval-repeater-and-room-server" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or set the reboot interval (Repeater and room server)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#control-an-exposed-gpio" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Control an exposed GPIO
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#routing" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Routing
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Routing">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-set-the-direct-path-override-for-the-current-remote-client" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or set the direct path override for the current remote client
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-repeat-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's repeat flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-advert-path-hash-size" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's advert path hash size
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-loop-detection" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's loop detection
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-retransmit-delay-factor-for-flood-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the retransmit delay factor for flood traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-retransmit-delay-factor-for-direct-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the retransmit delay factor for direct traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#experimental-view-or-change-the-processing-delay-for-received-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
[Experimental] View or change the processing delay for received traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the duty cycle limit
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-airtime-factor-duty-cycle-limit" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the airtime factor (duty cycle limit)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-local-interference-threshold" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the local interference threshold
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-hardware-channel-activity-detection-cad" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable hardware Channel Activity Detection (CAD)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-agc-reset-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the AGC Reset Interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-radio-watchdog-interval-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the radio watchdog interval (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-multi-acks-support" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable Multi-Acks support
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-flood-advert-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the flood advert interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-zero-hop-advert-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the zero-hop advert interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-a-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for a flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-an-unscoped-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for an unscoped flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-an-advert-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for an advert flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#forward-flood-group-data-packets-on-repeaters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Forward flood group data packets on repeaters
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#block-selected-flood-channels-with-fpf7" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Block selected flood channels with FPF7
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#force-a-transport-scope-onto-floods" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Force a transport scope onto floods
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#require-valid-incoming-scopes-only-on-selected-channels" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Require valid incoming scopes only on selected channels
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#change-persistent-flood-rules-in-the-field" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Change persistent flood rules in the field
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#moderate-flood-group-text-by-channel-sender-and-source-path" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Moderate flood group text by channel, sender, and source path
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#acl" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
ACL
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ACL">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#add-update-or-remove-permissions-for-a-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Add, update or remove permissions for a companion
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-current-acl" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the current ACL
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#recover-a-repeaters-future-dated-replay-timestamp" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Recover a repeater's future-dated replay timestamp
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-room-servers-read-only-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this room server's 'read-only' flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#region-management-v110" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Region Management (v1.10.+)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Region Management (v1.10.+)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bulk-load-region-lists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Bulk-load region lists
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#save-any-changes-to-regions-made-since-reboot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Save any changes to regions made since reboot
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#allow-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Allow a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#block-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Block a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-information-for-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show information for a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-home-region-for-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the home region for this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the default scope region for this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-a-new-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Create a new region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#define-region-hierarchy-single-line" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Define region hierarchy (single line)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Remove a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-all-regions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View all regions
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#dump-all-defined-regions-and-flood-permissions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Dump all defined regions and flood permissions
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#region-examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Region Examples
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#direct-retry" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Direct Retry
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Direct Retry">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-heard-table-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry heard-table gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-apply-a-retry-preset" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or apply a retry preset
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#flood-retry" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Flood Retry
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Flood Retry">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#hop-zero-flood-retry-coding-rate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Hop-zero flood retry coding rate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-count" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry count
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-path-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry path gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-group-data-flood-retry-path-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the group-data flood retry path gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-advert-handling" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry advert handling
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-target-prefixes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry target prefixes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-ignored-prefixes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry ignored prefixes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-bridge-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry bridge mode
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-bridge-buckets" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry bridge buckets
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-count" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry count
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-base-delay" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry base delay
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-step-delay" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry step delay
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-snr-margin" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry SNR margin
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-adaptive-direct-retry-coding-rate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change adaptive direct retry coding rate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-seed-or-clear-the-recent-repeater-table" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View, seed, or clear the recent repeater table
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gps-when-gps-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
GPS (When GPS support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GPS (When GPS support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-gps-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change GPS state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sync-this-nodes-clock-with-gps-time" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sync this node's clock with GPS time
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-this-nodes-location-based-on-the-gps-coordinates" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set this node's location based on the GPS coordinates
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-gps-advert-policy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the GPS advert policy
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sensors-when-sensor-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sensors (When sensor support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Sensors (When sensor support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-telemetry-access-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change telemetry access mode
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-list-of-sensors-on-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the list of sensors on this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-value-of-a-sensor" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the value of a sensor
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bridge-when-bridge-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Bridge (When bridge support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Bridge (When bridge support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-compiled-bridge-type" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the compiled bridge type
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-bridge-enabled-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the bridge enabled flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#add-a-delay-to-packets-routed-through-this-bridge" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Add a delay to packets routed through this bridge
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-source-of-packets-bridged-to-the-external-interface" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the source of packets bridged to the external interface
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-mqtt-master-switch" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the MQTT master switch
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-mqtt-rx-packet-uplinking" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change MQTT RX packet uplinking
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-mqtt-tx-packet-uplinking" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change MQTT TX packet uplinking
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-periodic-neighbors-publishing-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change periodic neighbors publishing (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-neighbors-publish-interval-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the neighbors publish interval (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-ntp-server-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the NTP server (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#diagnose-ntp-server-connectivity-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Diagnose NTP server connectivity (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-speed-of-the-bridge-rs-232-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the speed of the bridge (RS-232 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-uart-used-by-the-bridge-rs-232-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the UART used by the bridge (RS-232 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-channel-used-for-bridging-espnow-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the channel used for bridging (ESPNow only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-esp-now-bridge-wire-format" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the ESP-NOW bridge wire format
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-the-esp-now-secret" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set the ESP-Now secret
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-bootloader-version-nrf52-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the bootloader version (nRF52 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-power-management-support" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View power management support
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-current-power-source" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the current power source
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-boot-reset-and-shutdown-reasons" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the boot reset and shutdown reasons
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-boot-voltage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the boot voltage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ethernet-when-ethernet-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Ethernet (when Ethernet support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Ethernet (when Ethernet support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-ethernet-connection-status" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View Ethernet connection status
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../companion_contact_cache/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Full Companion contact caches
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../companion_contact_cache_results/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Contact-cache and NimBLE RAM qualification
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../companion_offline_queue/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Companion Offline Message Queue
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../companion_protocol/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Companion Protocol
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../companion_radio_full/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Full Companion
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../docs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Local Documentation
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../esp32_memory_budget/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Classic ESP32 image memory budget
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../espnow_bridge_setup/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
ESP-NOW bridge: simple setup
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../faq/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Frequently Asked Questions
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../filter_tool/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Filter policy playground
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../firmware_memory_budget/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Firmware memory checks
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../firmware_picker/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Firmware picker
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../flood_filtering/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Flood Filtering and Moderation
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../full_companion_features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Full Companion: turn features on and off
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../full_companion_usb_switcher/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Full Companion USB CLI and binary switcher
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../gps_tracking/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
GPS Tracking
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../halo_keymind_settings/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Halo and Keymind Branch Settings
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hardware_validation_bluetooth_stealth_2026-09-07/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
XIAO Bluetooth stealth hardware validation - 2026-09-07
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../hardware_validation_checklist/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Hardware validation checklist
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../home_text_spacing/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Home-screen text spacing
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../host_cli_service/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
LoRa CLI Host Service
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../kiss_modem_protocol/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
MeshCore KISS Modem Protocol
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../lora_ota_automation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Scripted LoRa OTA from start to finish
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../mbedtls-tls-footprint/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Shrinking the per-connection TLS footprint on non-PSRAM observers
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../nimble_companion_trial/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
ESP32-S3 NimBLE Full Companion trial
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../nimble_companion_trial_results/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
ESP32-S3 NimBLE trial results, 2026-09-08
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../nrf52-usb-ready-fix/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
nRF52 USB READY hang
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../nrf52_companion_storage_recovery/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
nRF52 Companion automatic ExtraFS recovery
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../nrf52_power_management/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
nRF52 Power Management
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../number_allocations/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Number Allocations
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_easy/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Easy firmware updates over LoRa
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_meshtower_v2_sdcard/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
MeshTower V2 microSD LoRa OTA
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_nrf52_bootloader_update/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
nRF52 bootloader updates over LoRa
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_nrf52_qspi/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
nRF52 repeater LoRa OTA with external QSPI
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_protocol/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
MeshCore OTA - .mota container & LoRa protocol
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../ota_user_guide/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Updating your node over the air (OTA) - user guide
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../packet_format/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Packet Format
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../payloads/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Payload Format
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../pr7_review_validation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
PR #7 review and validation
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../qr_codes/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
QR Codes
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../radio_receive_calibration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Radio receive calibration and recovery
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../rak3401_mota_chain/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
RAK3401 1W repeater compact LoRa update chain
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../role_feature_switches/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Feature switches by role — 1.17.1.5 USA Cascade
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../spiffs_regular_file_reads/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
SPIFFS regular-file reads and login replay state
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../stats_binary_frames/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Stats Binary Frame Structures
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../telemetry_decoder/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Telemetry decoder
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../terminal_chat_cli/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Terminal Chat CLI
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../usb_serial_backpressure/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Native USB backpressure and radio liveness
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../v4_pixel5_font_trial/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Small-screen message fonts
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_55" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_55" id="__nav_55_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Releases
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_55_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_55">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
|
|
|
|
Releases
|
|
|
|
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../releases/1.17.1.5-doc-audit/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
Markdown audit — 1.17.1.5 USA Cascade
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../releases/1.17.1.5/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
|
|
|
|
MeshCore 1.17.1.5 Dev - USA Cascade
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#navigation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Navigation
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#operational" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Operational
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Operational">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reboot-the-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Reboot the node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#power-off-the-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Power-off the node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enter-the-uf2-bootloader-nrf52-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enter the UF2 bootloader (nRF52 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#reset-the-clock-and-reboot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Reset the clock and reboot
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sync-the-clock-with-the-remote-device" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sync the clock with the remote device
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#display-current-time-in-utc" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Display current time in UTC
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-the-time-to-a-specific-timestamp" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set the time to a specific timestamp
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-flood-advert" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a flood advert
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-zero-hop-advert" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a zero-hop advert
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ask-a-usb-connected-host-service-over-lora-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Ask a USB-connected host service over LoRa (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#start-or-stop-an-over-the-air-ota-firmware-update" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Start or stop an Over-The-Air (OTA) firmware update
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#browser-configuration-portal-esp32-repeater-and-room-server" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Browser configuration portal (ESP32 repeater and room server)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Browser configuration portal (ESP32 repeater and room server)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-primary-esp-nowwifi-channel" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the primary ESP-NOW/WiFi channel
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#erasefactory-reset" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Erase/Factory Reset
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#neighbors-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Neighbors (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Neighbors (Repeater Only)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-nearby-neighbors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
List nearby neighbors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove-a-neighbor" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Remove a neighbor
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discover-zero-hop-neighbors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Discover zero hop neighbors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#discover-neighbor-scopes-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Discover neighbor scopes (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#statistics" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Statistics
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Statistics">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#list-rate-limited-flood-adverts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
List Rate-Limited Flood Adverts
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#clear-automatic-flood-advert-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Clear Automatic Flood Advert History
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#clear-stats" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Clear Stats
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system-stats-battery-uptime-queue-length-and-debug-flags" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
System Stats - Battery, Uptime, Queue Length and Debug Flags
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#radio-stats-noise-floor-last-rssisnr-airtime-receive-errors" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#packet-stats-packet-counters-received-sent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Packet stats - Packet counters: Received, Sent
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#read-repeater-and-room-server-telemetry-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Read repeater and room-server telemetry history
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-companion-display-rotation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set Companion display rotation
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-touchscreen-touch-areas" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show touchscreen touch areas
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-display-modes-and-timeouts" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set display modes and timeouts
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-companion-inbox-behavior" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set Companion inbox behavior
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-mqtt-observer-display-flip" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set MQTT observer display flip
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#logging" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Logging
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Logging">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#control-live-usb-logging" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Control live USB logging
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#begin-capture-of-rx-log-to-node-storage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Begin capture of rx log to node storage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#end-capture-of-rx-log-to-node-storage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
End capture of rx log to node storage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#erase-captured-log" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Erase captured log
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#print-the-captured-log-to-the-requesting-terminal" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Print the captured log to the requesting terminal
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#info" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Info
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Info">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#get-the-version" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Get the Version
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-the-hardware-name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show the hardware name
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-the-storage-layout" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show the storage layout
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configuration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Configuration
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Configuration">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#radio" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Radio
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Radio">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-radio-parameters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's radio parameters
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-transmit-power" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's transmit power
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#change-the-radio-parameters-for-a-set-duration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Change the radio parameters for a set duration
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#schedule-radio-parameter-changes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Schedule radio parameter changes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-frequency" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's frequency
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-rx-duty-cycle-power-saving" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change RX duty-cycle power saving
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the LoRa FEM receive-path gain state on supported boards
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-lora-fem-transmit-path-gain-state-on-supported-boards" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the LoRa FEM transmit-path gain state on supported boards
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#system" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
System
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="System">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-name" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's name
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-independent-bluetooth-name-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the independent Bluetooth name (Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-bluetooth-address-ble-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the Bluetooth address (BLE Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-bluetooth-stealth-ble-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change Bluetooth stealth (BLE Companion)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-latitude" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's latitude
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-longitude" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's longitude
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-identity-private-key" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's identity (Private Key)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-admin-password" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's admin password
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-guest-password" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's guest password
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-owner-info" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's owner info
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fine-tune-the-battery-reading" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Fine-tune the battery reading
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#send-a-repeater-flood-text" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Send a repeater flood text
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-battery-alert-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change battery alert state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-battery-alert-thresholds" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change battery alert thresholds
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-the-rx-inactivity-watchdog-repeater-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable the RX inactivity watchdog (Repeater Only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-the-nrf52-system-watchdog" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable the nRF52 system watchdog
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#estimate-and-correct-infrastructure-node-time-after-startup" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Estimate and correct infrastructure-node time after startup
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-public-key" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's public key
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-firmware-version" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's firmware version
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-this-nodes-configured-role" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View this node's configured role
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-power-saving-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's power saving flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-set-the-reboot-interval-repeater-and-room-server" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or set the reboot interval (Repeater and room server)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#control-an-exposed-gpio" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Control an exposed GPIO
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#routing" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Routing
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Routing">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-set-the-direct-path-override-for-the-current-remote-client" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or set the direct path override for the current remote client
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-repeat-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's repeat flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-advert-path-hash-size" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's advert path hash size
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-nodes-loop-detection" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this node's loop detection
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-retransmit-delay-factor-for-flood-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the retransmit delay factor for flood traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-retransmit-delay-factor-for-direct-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the retransmit delay factor for direct traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#experimental-view-or-change-the-processing-delay-for-received-traffic" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
[Experimental] View or change the processing delay for received traffic
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-duty-cycle-limit" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the duty cycle limit
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-airtime-factor-duty-cycle-limit" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the airtime factor (duty cycle limit)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-local-interference-threshold" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the local interference threshold
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-hardware-channel-activity-detection-cad" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable hardware Channel Activity Detection (CAD)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-agc-reset-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the AGC Reset Interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-radio-watchdog-interval-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the radio watchdog interval (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#enable-or-disable-multi-acks-support" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Enable or disable Multi-Acks support
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-flood-advert-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the flood advert interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-zero-hop-advert-interval" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the zero-hop advert interval
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-a-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for a flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-an-unscoped-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for an unscoped flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#limit-the-number-of-hops-for-an-advert-flood-message" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Limit the number of hops for an advert flood message
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#forward-flood-group-data-packets-on-repeaters" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Forward flood group data packets on repeaters
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#block-selected-flood-channels-with-fpf7" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Block selected flood channels with FPF7
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#force-a-transport-scope-onto-floods" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Force a transport scope onto floods
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#require-valid-incoming-scopes-only-on-selected-channels" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Require valid incoming scopes only on selected channels
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#change-persistent-flood-rules-in-the-field" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Change persistent flood rules in the field
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#moderate-flood-group-text-by-channel-sender-and-source-path" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Moderate flood group text by channel, sender, and source path
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#acl" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
ACL
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="ACL">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#add-update-or-remove-permissions-for-a-companion" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Add, update or remove permissions for a companion
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-current-acl" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the current ACL
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#recover-a-repeaters-future-dated-replay-timestamp" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Recover a repeater's future-dated replay timestamp
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-this-room-servers-read-only-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change this room server's 'read-only' flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#region-management-v110" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Region Management (v1.10.+)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Region Management (v1.10.+)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bulk-load-region-lists" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Bulk-load region lists
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#save-any-changes-to-regions-made-since-reboot" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Save any changes to regions made since reboot
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#allow-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Allow a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#block-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Block a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#show-information-for-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Show information for a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-home-region-for-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the home region for this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-default-scope-region-for-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the default scope region for this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#create-a-new-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Create a new region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#define-region-hierarchy-single-line" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Define region hierarchy (single line)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remove-a-region" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Remove a region
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-all-regions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View all regions
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#dump-all-defined-regions-and-flood-permissions" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Dump all defined regions and flood permissions
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#region-examples" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Region Examples
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#direct-retry" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Direct Retry
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Direct Retry">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-heard-table-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry heard-table gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-apply-a-retry-preset" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or apply a retry preset
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#flood-retry" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Flood Retry
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Flood Retry">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#hop-zero-flood-retry-coding-rate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Hop-zero flood retry coding rate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-count" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry count
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-path-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry path gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-group-data-flood-retry-path-gate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the group-data flood retry path gate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-advert-handling" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry advert handling
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-target-prefixes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry target prefixes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-ignored-prefixes" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry ignored prefixes
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-bridge-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry bridge mode
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-flood-retry-bridge-buckets" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change flood retry bridge buckets
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-count" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry count
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-base-delay" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry base delay
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-step-delay" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry step delay
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-direct-retry-snr-margin" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change direct retry SNR margin
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-adaptive-direct-retry-coding-rate" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change adaptive direct retry coding rate
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-seed-or-clear-the-recent-repeater-table" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View, seed, or clear the recent repeater table
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#gps-when-gps-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
GPS (When GPS support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GPS (When GPS support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-gps-state" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change GPS state
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sync-this-nodes-clock-with-gps-time" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sync this node's clock with GPS time
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-this-nodes-location-based-on-the-gps-coordinates" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set this node's location based on the GPS coordinates
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-gps-advert-policy" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the GPS advert policy
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sensors-when-sensor-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Sensors (When sensor support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Sensors (When sensor support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-telemetry-access-mode" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change telemetry access mode
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-list-of-sensors-on-this-node" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the list of sensors on this node
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-value-of-a-sensor" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the value of a sensor
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#bridge-when-bridge-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Bridge (When bridge support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Bridge (When bridge support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-compiled-bridge-type" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the compiled bridge type
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-bridge-enabled-flag" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the bridge enabled flag
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#add-a-delay-to-packets-routed-through-this-bridge" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Add a delay to packets routed through this bridge
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-source-of-packets-bridged-to-the-external-interface" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the source of packets bridged to the external interface
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-mqtt-master-switch" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the MQTT master switch
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-mqtt-rx-packet-uplinking" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change MQTT RX packet uplinking
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-mqtt-tx-packet-uplinking" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change MQTT TX packet uplinking
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-periodic-neighbors-publishing-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change periodic neighbors publishing (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-neighbors-publish-interval-mqtt-observer-neighbors-feature" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the neighbors publish interval (MQTT observer, neighbors feature)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-ntp-server-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the NTP server (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#diagnose-ntp-server-connectivity-mqtt-observer-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Diagnose NTP server connectivity (MQTT observer only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-speed-of-the-bridge-rs-232-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the speed of the bridge (RS-232 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-uart-used-by-the-bridge-rs-232-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the UART used by the bridge (RS-232 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-channel-used-for-bridging-espnow-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the channel used for bridging (ESPNow only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-or-change-the-esp-now-bridge-wire-format" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View or change the ESP-NOW bridge wire format
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#set-the-esp-now-secret" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Set the ESP-Now secret
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-bootloader-version-nrf52-only" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the bootloader version (nRF52 only)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-power-management-support" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View power management support
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-current-power-source" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the current power source
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-boot-reset-and-shutdown-reasons" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the boot reset and shutdown reasons
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-the-boot-voltage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View the boot voltage
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ethernet-when-ethernet-support-is-compiled-in" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
Ethernet (when Ethernet support is compiled in)
|
|
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Ethernet (when Ethernet support is compiled in)">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#view-ethernet-connection-status" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
|
|
View Ethernet connection status
|
|
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/mikecarper/MeshCore/edit/keymindCascade/docs/cli_commands.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<h1 id="cli-commands">CLI Commands</h1>
|
|
<p>For copy/paste on/off recipes and the differences from Full Companion, see
|
|
<a href="../role_feature_switches/">feature switches by role</a>. The
|
|
<a href="https://flasher.meshcore.io/console">USB web console</a> opens the default ASCII
|
|
terminal at 115200 baud; it does not require on-device WebConfig or WiFi.</p>
|
|
<p>This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.</p>
|
|
<p>See <a href="../cli_build_matrix/">CLI Availability by Firmware Build</a> for the role and
|
|
profile matrix. Commands depend on compiled features; some portable builds
|
|
omit WebConfig while retaining the complete role CLI and compact WiFi updater.</p>
|
|
<p>See <a href="../cli_command_availability/">CLI Command Availability Matrix</a> for the
|
|
command-by-command nRF52 and ESP32 build tables.</p>
|
|
<p>The first word of a command is case-insensitive, so <code>set</code>, <code>Set</code>, and <code>SET</code>
|
|
are equivalent, as are <code>get</code>, <code>Get</code>, and the other command verbs. The case of
|
|
arguments such as node names, passwords, and keys is left unchanged.</p>
|
|
<p>Use the site search or your browser's Find command with everyday wording such
|
|
as <strong>tx retries</strong>, <strong>retry attempts</strong>, <strong>serial logging</strong>, or <strong>tx power</strong>.
|
|
<strong>Search terms</strong> below are alternative wording to help find a command, not
|
|
additional CLI aliases. Enter the syntax shown under <strong>Usage</strong>; supported
|
|
command aliases are listed there explicitly.</p>
|
|
<h2 id="navigation">Navigation</h2>
|
|
<ul>
|
|
<li><a href="#operational">Operational</a></li>
|
|
<li><a href="#neighbors-repeater-only">Neighbors</a></li>
|
|
<li><a href="#statistics">Statistics</a></li>
|
|
<li><a href="#logging">Logging</a></li>
|
|
<li><a href="#info">Information</a></li>
|
|
<li><a href="#configuration">Configuration</a></li>
|
|
<li><a href="#radio">Radio</a></li>
|
|
<li><a href="#system">System</a><ul>
|
|
<li><a href="#control-an-exposed-gpio">GPIO</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#routing">Routing</a></li>
|
|
<li><a href="#change-persistent-flood-rules-in-the-field">Flood Rules</a></li>
|
|
<li><a href="#moderate-flood-group-text-by-channel-sender-and-source-path">Group Text Moderation</a></li>
|
|
<li><a href="#acl">ACL</a></li>
|
|
<li><a href="#region-management-v110">Region Management</a><ul>
|
|
<li><a href="#region-examples">Region Examples</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#gps-when-gps-support-is-compiled-in">GPS</a></li>
|
|
<li><a href="#sensors-when-sensor-support-is-compiled-in">Sensors</a></li>
|
|
<li><a href="#bridge-when-bridge-support-is-compiled-in">Bridge</a></li>
|
|
<li><a href="#ethernet-when-ethernet-support-is-compiled-in">Ethernet</a></li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="operational">Operational</h2>
|
|
<h3 id="reboot-the-node">Reboot the node</h3>
|
|
<p><strong>Search terms:</strong> restart, restart node, reboot device.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>reboot</code></p>
|
|
<p><strong>Note:</strong> No reply is sent.</p>
|
|
<hr />
|
|
<h3 id="power-off-the-node">Power-off the node</h3>
|
|
<p><strong>Search terms:</strong> turn off device, shut down, power off.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>poweroff</code>, or
|
|
- <code>shutdown</code></p>
|
|
<p><strong>Note:</strong> No reply is sent.</p>
|
|
<hr />
|
|
<h3 id="enter-the-uf2-bootloader-nrf52-only">Enter the UF2 bootloader (nRF52 only)</h3>
|
|
<p><strong>Search terms:</strong> bootloader mode, USB firmware update, UF2 mode.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>uf2reset</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<p><strong>Note:</strong> Reboots directly into the UF2 bootloader on supported nRF52 boards.
|
|
This includes the Repeater, Room Server, Sensor, Companion, and Terminal Chat
|
|
local serial command surfaces. It is never accepted as a remote mesh command.</p>
|
|
<hr />
|
|
<h3 id="reset-the-clock-and-reboot">Reset the clock and reboot</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>clkreboot</code></p>
|
|
<p><strong>Note:</strong> No reply is sent.</p>
|
|
<hr />
|
|
<h3 id="sync-the-clock-with-the-remote-device">Sync the clock with the remote device</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>clock sync</code></p>
|
|
<hr />
|
|
<h3 id="display-current-time-in-utc">Display current time in UTC</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>clock</code></p>
|
|
<hr />
|
|
<h3 id="set-the-time-to-a-specific-timestamp">Set the time to a specific timestamp</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>time <epoch_seconds></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>epoch_seconds</code>: Unix epoch time</p>
|
|
<hr />
|
|
<h3 id="send-a-flood-advert">Send a flood advert</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>advert</code></p>
|
|
<hr />
|
|
<h3 id="send-a-zero-hop-advert">Send a zero-hop advert</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>advert.zerohop</code></p>
|
|
<hr />
|
|
<h3 id="ask-a-usb-connected-host-service-over-lora-repeater-only">Ask a USB-connected host service over LoRa (Repeater Only)</h3>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>host <text></code> - authenticated remote administrator only</li>
|
|
<li><code>get host</code> - show bridge state and byte limits</li>
|
|
</ul>
|
|
<p><code>host</code> hands one remote LoRa CLI request to a service on the repeater's USB
|
|
host and returns that service's reply over LoRa. It does not execute the text
|
|
inside the firmware. The service has 4 seconds to prove the exact request is
|
|
still pending, then 6 seconds to execute and reply. A second remote command
|
|
receives busy while either phase is pending.</p>
|
|
<p>Request text is limited to 155 UTF-8 bytes, or 152 bytes when a companion uses
|
|
its legacy three-byte correlation prefix. The complete LoRa reply is limited to
|
|
162 bytes. USB records use Base64URL text, a random 64-bit nonce, and the
|
|
repeater identity's Ed25519 signature. Before executing anything, the service
|
|
must return a random one-time challenge and receive the repeater's signed live
|
|
proof. This avoids any dependency on repeater/Pi clock agreement. Every
|
|
<code>host.reply</code> USB command must carry the matching request ID and nonce; it is not
|
|
accepted from LoRa or the Ethernet CLI.</p>
|
|
<p>The included Raspberry Pi endpoint supports exact commands for <code>help</code>,
|
|
<code>cpu-temp</code>, <code>hostname</code>, <code>uptime</code>, <code>load</code>, <code>memory</code>, <code>disk-free</code>, and
|
|
<code>clock status</code>. It also provides strictly validated <code>clock sync</code> and
|
|
<code>clock set <unix_epoch></code> recovery actions, opt-in <code>network restart</code> and
|
|
<code>reboot</code> actions, <code>action status <operation_id></code>, and
|
|
<code>run <alias> [arguments]</code> for locally allowlisted executables with typed
|
|
arguments. Clock changes and host recovery actions are disabled by default,
|
|
arbitrary executables are never accepted, and no action uses a shell. Clock set
|
|
accepts only canonical unsigned decimal epochs from 2020 through 2099; a root-owned
|
|
Unix-socket service revalidates the request and authenticates the local service
|
|
account with <code>SO_PEERCRED</code> before changing system time. Network restart and
|
|
reboot use a separate root-owned Unix-socket broker with fixed systemd units;
|
|
installing clock control does not grant those actions. The endpoint never uses
|
|
<code>sudo</code> for privileged host actions.
|
|
See <a href="../host_cli_service/">LoRa CLI host service</a> for the complete
|
|
<code>meshcoretomqtt</code> setup and security model.</p>
|
|
<hr />
|
|
<h3 id="start-or-stop-an-over-the-air-ota-firmware-update">Start or stop an Over-The-Air (OTA) firmware update</h3>
|
|
<p><strong>Search terms:</strong> WiFi OTA, wireless firmware update, OTA uploader, update firmware.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>start ota</code>
|
|
- <code>start ota ap</code>
|
|
- <code>stop ota</code></p>
|
|
<p>On nRF52, <code>start ota</code> invokes Bluetooth DFU with the matching bootloader and
|
|
application DFU ZIP. The WiFi/AP instructions below apply to ESP32.</p>
|
|
<p>On ESP32, <code>start ota</code> serves the web upload page on the station IP when connected to WiFi;
|
|
otherwise it raises the <code>MeshCore-OTA</code> access point. <code>start ota ap</code> always raises
|
|
the access point, which is useful when the normal network uses client isolation.</p>
|
|
<p>On an ESP32 build with WebConfig, the manual OTA uploader and WebConfig both use HTTP
|
|
port 80 and cannot run together. Stop WebConfig before <code>start ota</code>, or stop OTA
|
|
before <code>start webconfig</code>.</p>
|
|
<p>FULL ESP32 builds also expose the <code>.mota</code> folder seeder on TCP port 5001
|
|
whenever WiFi is usable. This listener is independent of port 80, so a host can
|
|
run <code>motatool serve --dir ./motas --tcp <node-ip>:5001</code> while WebConfig is
|
|
active. The TCP connection auto-attaches and detaches the folder; do not run
|
|
<code>ota folder on</code> at the same time because that command selects the USB-serial
|
|
folder transport.</p>
|
|
<hr />
|
|
<h3 id="browser-configuration-portal-esp32-repeater-and-room-server">Browser configuration portal (ESP32 repeater and room server)</h3>
|
|
<p><strong>Search terms:</strong> web UI, web interface, WiFi settings page, configuration website, WebConfig.</p>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>start webconfig</code></li>
|
|
<li><code>start webconfig ap</code></li>
|
|
<li><code>stop webconfig</code></li>
|
|
<li><code>set webui on</code></li>
|
|
<li><code>set webui off</code></li>
|
|
<li><code>get webui</code></li>
|
|
<li><code>get wifi.ssid</code></li>
|
|
<li><code>get wifi.pwd</code></li>
|
|
<li><code>get wifi.status</code></li>
|
|
<li><code>get wifi.powersave</code></li>
|
|
<li><code>get wifi.cli</code></li>
|
|
<li><code>set wifi.ssid <network name></code></li>
|
|
<li><code>set wifi.pwd [password]</code></li>
|
|
<li><code>set wifi.powersave <none|min|max></code></li>
|
|
<li><code>set wifi.cli <on|off></code></li>
|
|
</ul>
|
|
<p><code>set webui on</code> is the persistent master switch. It starts the portal now and
|
|
again after future reboots; <code>set webui off</code> closes it and disables that boot
|
|
start. <code>get webui</code> reports the saved on/off state plus whether the portal is
|
|
inactive, joining WiFi, serving a setup AP, or serving a LAN URL. The default is
|
|
<code>off</code> on repeater and room-server builds. On display-equipped repeaters, an
|
|
otherwise-unused triple click toggles the same saved setting.
|
|
Consequently, <code>> off, http://192.168.1.130/</code> means the saved boot setting is
|
|
off while a temporary WebConfig session is currently active at that URL.</p>
|
|
<p><code>start webconfig</code> is a temporary start that does not change the saved switch.
|
|
It serves the shared WiFi, radio, flood, loop, and status page and reports its
|
|
URL. MQTT builds also show the MQTT tab and wizard step; non-MQTT builds remove
|
|
them entirely. Sign in with the node's admin password. If the node has no saved
|
|
WiFi SSID, the command starts the open <code>MeshCore-Setup-XXXX</code> captive AP at
|
|
<a href="http://192.168.4.1/">http://192.168.4.1/</a> instead.</p>
|
|
<p><code>start webconfig ap</code> forces captive-AP mode. It will not interrupt an active
|
|
MQTT bridge, so run <code>set mqtt.enabled off</code> first. Use <code>stop webconfig</code> to
|
|
close either mode for the current boot. (<code>stop webconfig</code> does not change a
|
|
saved <code>webui on</code>.)
|
|
LAN mode otherwise remains active until reboot. On expanded FULL builds, an
|
|
unconfigured automatic setup AP receives one absolute 30-minute window per
|
|
boot, then powers WiFi off even if a client remains attached; rebooting starts
|
|
a new automatic window. An administrator can explicitly run <code>start webconfig</code>
|
|
again without rebooting. Once an SSID is saved, the cutoff no longer applies
|
|
and the selected WiFi/MQTT mode keeps reconnecting. Other setup sessions retain
|
|
their profile's idle timeout.</p>
|
|
<p>Every ESP32 build with WebConfig supports the browser command terminal,
|
|
including WiFi Companion and Full Companion. Companions use their complete
|
|
USB/TCP terminal on the trusted LAN, including contact import, chat, recipient
|
|
selection, and delayed replies. Repeater and Room Server use their local CLI
|
|
after admin authentication.</p>
|
|
<p>To add a Companion contact, run <code>import meshcore://<full-contact-card-data></code>,
|
|
then <code>list</code> to confirm it appears. Get the complete card with <code>card</code> on the
|
|
other Companion. A public key alone is insufficient. See the
|
|
<a href="../terminal_chat_cli/#companion-wifi-browser-terminal">terminal command guide</a>
|
|
for <code>to</code>, <code>send</code>, <code>login</code>, and <code>cmd</code> examples and session ownership.</p>
|
|
<p>The saved <code>wifi.cli</code> setting defaults to <code>on</code>. Use <code>set wifi.cli off</code> to disable
|
|
the <strong>CLI</strong> tab.
|
|
<code>get wifi.cli</code> reports <code>off</code>, <code>on, waiting for WiFi client</code>, or <code>on, active</code>.
|
|
The saved setting becomes active only in station/LAN mode while the WiFi client
|
|
is connected. It is deliberately unavailable on the open setup access point.
|
|
The tab displays each reply in the browser, including local diagnostics,
|
|
<code>get password</code>, private-key and WiFi/MQTT credential reads, and <code>erase</code>.
|
|
Infrastructure <code>get acl</code> and raw <code>log</code> stream to the requesting browser, with
|
|
backpressure for slow clients. These maintenance commands retain their LoRa
|
|
restrictions. <code>set freq</code> works both here and through authorized LoRa CLI.
|
|
The bounded <code>/api/cli</code> endpoint accepts local maintenance commands; use
|
|
<code>/api/terminal</code> for complete ACL and log listings.
|
|
Select <strong>Command block</strong> to paste up to 100 commands with one command per line.
|
|
Blank lines are ignored, and every nonblank line must fit the normal 159-byte
|
|
CLI command limit. The browser sends the lines sequentially and waits for each
|
|
reply before sending the next line. The queue exists only in that browser page;
|
|
closing it stops any commands that have not yet been sent. A lost connection
|
|
also stops the remaining block.</p>
|
|
<p>Up/down arrow keys recall commands from the current browser session in
|
|
single-command mode. A command that stops WebConfig, changes its WiFi
|
|
connection, disables <code>wifi.cli</code>, or reboots the node stops the remaining block
|
|
and can close the page before its reply is collected.</p>
|
|
<p>On unified FULL USB + WiFi and FULL logging-fallback ESP32
|
|
repeater/room-server builds,
|
|
<code>get wifi.ssid</code> reports the saved standalone WebConfig network and
|
|
<code>get wifi.status</code> reports whether WiFi is unconfigured, off, connecting,
|
|
running the setup AP, failed, or connected. A connected result includes the
|
|
SSID, LAN IP, and RSSI. When the shared OTA seeder is running, the reply appends
|
|
<code>OTA TCP 5001: listening</code> or <code>OTA TCP 5001: client connected</code>. WiFi being off
|
|
is normal while WebConfig is inactive; run <code>start webconfig</code> when a temporary
|
|
connection is wanted. <code>get wifi.powersave</code> reports the saved standalone setting
|
|
as <code>none</code>, <code>min</code>, or <code>max</code>. Fresh Cascade-profile builds default to <code>min</code>;
|
|
target-default builds use <code>none</code>. A saved setting takes precedence after an
|
|
upgrade.</p>
|
|
<p>The WiFi <code>set</code> commands work on MQTT observers and on FULL standalone
|
|
ESP32 repeater/room-server builds. On a standalone build, changing the SSID or
|
|
password stops an active WebConfig session; run <code>start webconfig</code> again to use
|
|
the new credentials. <code>set wifi.pwd</code> with no value selects an open network.
|
|
Standalone WiFi also accepts an exact 64-character hexadecimal WPA/WPA2 PSK;
|
|
ordinary passphrases remain limited to 63 characters. Other 64-character values
|
|
and all longer values are rejected. MQTT observer WiFi passwords retain their
|
|
fixed 63-character limit.
|
|
Power-save changes are applied immediately when WiFi is running and otherwise
|
|
take effect on the next connection. <code>get wifi.pwd</code> returns the saved password
|
|
on a local connection. It remains unavailable or masked over LoRa, and the
|
|
configuration form continues to mask stored secrets.</p>
|
|
<p>ESP32 WiFi Companion WebConfig exposes the same <code>wifi.powersave</code> values in its
|
|
WiFi card. Every ESP32 WiFi Companion with WebConfig exposes the standalone
|
|
<code>wifi.ssid</code>, <code>wifi.status</code>, <code>wifi.powersave</code>, <code>wifi.cli</code>, and WebConfig command
|
|
families through its USB text terminal. Full Companion exposes the same
|
|
role-specific terminal on TCP port 5002. Credential writes reply before
|
|
restarting the WiFi station, so a TCP client should expect to reconnect at the
|
|
new address; USB password input is masked. Binary Companion clients can use
|
|
USB, BLE, or TCP port 5000 without the terminal-start token: send command
|
|
<code>0x42</code> (<code>CMD_RUN_CLI_COMMAND</code>) followed by the same CLI text, such as
|
|
<code>get wifi.powersave</code>, <code>get wifi.pwd</code>, <code>stats-core</code>, or <code>set wifi.powersave min</code>.
|
|
See <a href="../terminal_chat_cli/#local-maintenance-commands">local maintenance commands</a>
|
|
for the complete access rules. WiFi-only Companions accept
|
|
all three modes. A Full Companion that runs BLE and infrastructure WiFi
|
|
simultaneously rejects <code>none</code> because coexistence requires modem sleep.
|
|
Companion device power saving and LoRa <code>radio.rxps</code> remain independent. On an
|
|
ESP32 Full Companion whose primary mesh radio is ESP-NOW, <code>max</code> is also
|
|
unavailable: a station using maximum modem sleep can miss ESP-NOW broadcasts,
|
|
which the access point does not buffer for it. A previously saved conflicting
|
|
value is capped to and reported as <code>min</code>, and a new conflicting selection is
|
|
rejected. The primary mesh radio also holds the ESP-IDF WiFi wake reference
|
|
continuously so unsolicited ESP-NOW frames remain receivable; selecting <code>min</code>
|
|
does not put that primary receiver to sleep.</p>
|
|
<p>SenseCAP Indicator Full is the exclusive-secondary exception. On a
|
|
WiFi-selected boot, LoRa accepts <code>none|min|max</code> and ESP-NOW accepts <code>none|min</code>.
|
|
On a BLE-selected boot infrastructure WiFi is not started; LoRa accepts
|
|
<code>min|max</code> for the saved WiFi setting, while ESP-NOW + BLE requires <code>min</code>. USB
|
|
and the primary LoRa or ESP-NOW radio remain available in every mode.</p>
|
|
<h4 id="view-or-change-the-primary-esp-nowwifi-channel">View or change the primary ESP-NOW/WiFi channel</h4>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get espnow.channel</code></li>
|
|
<li><code>set espnow.channel <channel></code></li>
|
|
</ul>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li><code>channel</code>: Shared 2.4 GHz WiFi channel from <code>1</code> through <code>13</code>; choose one
|
|
permitted in your region and supported by the router.</li>
|
|
</ul>
|
|
<p><strong>Default:</strong> <code>1</code></p>
|
|
<p>This command is available when ESP-NOW is the node's primary mesh radio. The
|
|
setting is persisted. A <code>set</code> reply reports that reboot is required; until
|
|
reboot, the running ESP-NOW radio remains on its previous channel. On builds
|
|
that also provide ordinary WiFi, its station and setup AP share that channel.</p>
|
|
<p>After reboot, ESP-NOW, the setup AP, and the infrastructure-WiFi station use
|
|
the selected channel. Every primary ESP-NOW node that must communicate with
|
|
this node, plus the configured router's 2.4 GHz radio, must use the same fixed
|
|
channel. WiFi power saving does not allow the transports to use different
|
|
channels. On an ESP32 Full build with primary ESP-NOW, <code>wifi.powersave max</code> is
|
|
unavailable because maximum modem sleep can miss ESP-NOW broadcasts; use <code>min</code>
|
|
for coexistence. The firmware keeps the primary ESP-NOW receiver awake while
|
|
still using the <code>min</code> WiFi/Bluetooth coexistence policy.</p>
|
|
<p><code>espnow.channel</code> is the channel of the primary ESP-NOW mesh transport. It is
|
|
separate from <code>bridge.channel</code>, which configures only an ESP-NOW bridge on a
|
|
firmware role whose primary mesh radio is LoRa.</p>
|
|
<p>The browser portal is not compiled into the two 4 MB
|
|
<code>LilyGo_TLora_V2_1_1_6_*_observer_mqtt</code> targets because it does not fit while
|
|
retaining the two app slots required for LoRa OTA. Their normal CLI settings
|
|
remain available.</p>
|
|
<hr />
|
|
<h3 id="erasefactory-reset">Erase/Factory Reset</h3>
|
|
<p><strong>Search terms:</strong> factory defaults, reset settings, erase configuration.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>erase</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<p><strong>Warning:</strong> <em><strong>This is destructive!</strong></em></p>
|
|
<hr />
|
|
<h2 id="neighbors-repeater-only">Neighbors (Repeater Only)</h2>
|
|
<h3 id="list-nearby-neighbors">List nearby neighbors</h3>
|
|
<p><strong>Search terms:</strong> nearby nodes, neighbor list, neighbour list.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>neighbors</code></p>
|
|
<p><strong>Note:</strong> The output of this command is limited to the 8 most recent adverts.</p>
|
|
<p><strong>Note:</strong> Each line is encoded as <code>{pubkey-prefix}:{timestamp}:{snr*4}</code></p>
|
|
<hr />
|
|
<h3 id="remove-a-neighbor">Remove a neighbor</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>neighbor.remove <pubkey_prefix></code>
|
|
- <code>neighbor.remove</code> — remove all neighbors</p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>pubkey_prefix</code>: An even-length hexadecimal prefix (up to the full 64-character
|
|
public key). All neighbors matching it are removed. Invalid keys are rejected.</p>
|
|
<p>Omitting the prefix clears the table. An empty or whitespace-only prefix is
|
|
also accepted for compatibility with the mobile app's <strong>Remove All Neighbors</strong>
|
|
action. Newly heard zero-hop adverts can populate the table again.</p>
|
|
<hr />
|
|
<h3 id="discover-zero-hop-neighbors">Discover zero hop neighbors</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>discover.neighbors</code></p>
|
|
<p>This command is available in every repeater build profile, including portable
|
|
MQTT, standard, logging, OTA, unified FULL, and FULL logging-fallback artifacts. It does not
|
|
require MQTT or PSRAM.</p>
|
|
<hr />
|
|
<h3 id="discover-neighbor-scopes-mqtt-observer-neighbors-feature">Discover neighbor scopes (MQTT observer, neighbors feature)</h3>
|
|
<p>Refreshes the zero-hop neighbor table, then queries each neighbor for its region
|
|
scopes and publishes the assembled table to the MQTT <code>neighbors</code> topic once.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>discover.scopes</code></p>
|
|
<p><strong>Note:</strong> Requires an MQTT observer build with the neighbors feature compiled in
|
|
(all PSRAM boards, plus non-PSRAM boards built with <code>MQTT_NEIGHBORS_WITHOUT_PSRAM</code>).
|
|
Elsewhere it replies <code>Err - neighbors not enabled in this build</code>. If a
|
|
<code>discover.neighbors</code> refresh is already in flight, the scope pass is queued behind it.</p>
|
|
<hr />
|
|
<h2 id="statistics">Statistics</h2>
|
|
<h3 id="list-rate-limited-flood-adverts">List Rate-Limited Flood Adverts</h3>
|
|
<p><strong>Usage:</strong> <code>get flood.advert [page]</code> or <code>get flood.advert key <index></code></p>
|
|
<p>Lists tracked advert origins currently subject to a forwarding limit. Page 1
|
|
is the default, with three entries per page so replies fit both USB and admin
|
|
LoRa CLI. Each row shows its index, the first 12 public-key hex characters,
|
|
the limit reason, and the minimum wait before another new advert can pass
|
|
the automatic limiter. Ordinary forwarding filters still apply.</p>
|
|
<pre><code class="language-text">get flood.advert
|
|
get flood.advert 2
|
|
get flood.advert key 1
|
|
</code></pre>
|
|
<p>Reasons are <code>quota</code> (the prefix's three-hour forwarding allowance is spent),
|
|
<code>history</code> (distinct receive history is full), and <code>bad</code> (the full key is under
|
|
the stricter one-advert-per-12-hours rule). A <code>bad</code> key remains listed when
|
|
<code>wait=0s</code>: one forward is eligible, but its seven-day recovery is not complete.
|
|
If several limits apply, <code>bad</code> takes precedence over <code>history</code>, then <code>quota</code>;
|
|
the displayed wait accounts for all applicable limits.</p>
|
|
<p>The <code>key</code> form returns the complete 64-hex public key, reason, wait, shared
|
|
prefix forwarding count/quota, shortest received hop count, and remaining
|
|
bad-list recovery time. Different full keys with the same 12-hex prefix remain
|
|
separate entries. Indices refer to the current live list and can change as
|
|
history expires; read the full key before using a targeted clear.</p>
|
|
<p>Queries do not clear history, spend quota, or refresh abuse/recovery timers.
|
|
Elapsed history expires normally. Origins rejected only because every table
|
|
slot protects abuse history are not retained and cannot be enumerated.
|
|
Available on repeaters, room servers, and forwarding sensors through their
|
|
ordinary local/admin CLI. Companions do not have this table.</p>
|
|
<h3 id="clear-automatic-flood-advert-history">Clear Automatic Flood Advert History</h3>
|
|
<p><strong>Usage:</strong> <code>clear flood.advert all</code> or <code>clear flood.advert <64-hex-full-public-key></code></p>
|
|
<p>Clears automatic advert forwarding quotas, first strikes, and seven-day bad-list
|
|
history for all keys or one exact full key. Available on repeaters, room servers,
|
|
and forwarding sensors through their ordinary local/admin CLI (including admin
|
|
LoRa CLI). A missing selector, a key prefix, or a malformed key is rejected.
|
|
It does not change saved settings or manual flood rules. Reboot also clears this
|
|
RAM-only history. See <a href="../flood_filtering/#automatic-flood-advert-limits">automatic advert limits</a>.</p>
|
|
<h3 id="clear-stats">Clear Stats</h3>
|
|
<p><strong>Usage:</strong> <code>clear stats</code></p>
|
|
<hr />
|
|
<p><a id="stats-core"></a></p>
|
|
<h3 id="system-stats-battery-uptime-queue-length-and-debug-flags">System Stats - Battery, Uptime, Queue Length and Debug Flags</h3>
|
|
<p><strong>Usage:</strong>
|
|
- <code>stats-core</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<hr />
|
|
<p><a id="stats-radio"></a></p>
|
|
<h3 id="radio-stats-noise-floor-last-rssisnr-airtime-receive-errors">Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors</h3>
|
|
<p><strong>Search terms:</strong> signal strength, signal quality, RSSI, SNR, radio noise.</p>
|
|
<p><strong>Usage:</strong> <code>stats-radio</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<hr />
|
|
<p><a id="stats-packets"></a></p>
|
|
<h3 id="packet-stats-packet-counters-received-sent">Packet stats - Packet counters: Received, Sent</h3>
|
|
<p><strong>Usage:</strong> <code>stats-packets</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<hr />
|
|
<p><a id="read-repeater-telemetry-history"></a></p>
|
|
<h3 id="read-repeater-and-room-server-telemetry-history">Read repeater and room-server telemetry history</h3>
|
|
<p>Repeater and room-server firmware record one UTC-aligned sample every 30
|
|
minutes. Temperature and battery voltage retain 336 samples (seven rolling
|
|
days). Each detected INA219, INA226, INA260, or INA3221 voltage channel retains
|
|
192 samples (four rolling days). GPS-capable builds retain three GPS days by
|
|
default; repeaters request a seven-day default at startup. Builds without a GPS
|
|
provider omit the GPS history commands to conserve flash. All history and any
|
|
runtime retention change are held in RAM and reset after a reboot.</p>
|
|
<p>The feature is omitted from flash-constrained STM32 repeater and room images.</p>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get telemetry.temp [page]</code></li>
|
|
<li><code>get telemetry.volt [page]</code></li>
|
|
<li><code>get telemetry.volt.i2c [channel [page]]</code></li>
|
|
<li><code>get telemetry.gps [page]</code></li>
|
|
<li><code>set telemetry.gps <days></code></li>
|
|
<li><code>get telemetry.tx</code></li>
|
|
<li><code>set telemetry.tx <off|direct|path></code></li>
|
|
<li><code>set telemetry.tx schedule <off|1-30d></code></li>
|
|
<li><code>send telemetry.tx now</code></li>
|
|
</ul>
|
|
<p><strong>Parameters:</strong></p>
|
|
<ul>
|
|
<li><code>page</code>: Page <code>1</code> is always newest. Temperature and voltage pages each hold
|
|
24 hours and accept <code>1</code>-<code>7</code>. GPS pages each hold 12 hours and accept <code>1</code>
|
|
through twice the current GPS retention in days. Omitting the page selects
|
|
page <code>1</code>.</li>
|
|
<li><code>channel</code>: Cayenne LPP channel assigned to an external voltage monitor.
|
|
<code>get telemetry.volt.i2c</code> lists channels that have at least one non-zero
|
|
sample. Supplying a channel returns 48 points (24 hours) per page; pages
|
|
<code>1</code>-<code>4</code> cover all four days. A detected input whose complete retained history
|
|
is zero is treated as disconnected and is omitted until it reports a
|
|
non-zero voltage. An INA3221 contributes three consecutive entries, in
|
|
hardware-input order. If it is the only detected external sensor these are
|
|
normally LPP channels <code>2</code>, <code>3</code>, and <code>4</code>; always use the no-argument command
|
|
as the authoritative list because earlier detected sensors shift the LPP
|
|
numbers.</li>
|
|
<li><code>days</code>: Requested GPS retention from <code>1</code> through <code>30</code> days. Retention above
|
|
three days uses heap memory. The allocator reduces the requested value as
|
|
needed to leave at least 2048 bytes free and replies with the days and pages
|
|
actually available. For example, a request can return
|
|
<code>OK - telemetry.gps days=18 pages=36 requested=30</code>.</li>
|
|
<li><code>direct</code>: Send the binary temperature and voltage snapshots zero-hop to a
|
|
neighboring MQTT observer.</li>
|
|
<li><code>path</code>: A comma-separated direct route using the same one-, two-, or
|
|
three-byte hop hashes accepted by <code>set outpath</code>.</li>
|
|
<li><code>schedule</code>: Automatic interval in whole days. The default is <code>2d</code>; <code>off</code>
|
|
retains the configured direct path for manual test sends.</li>
|
|
</ul>
|
|
<p>Local serial and remote administrator CLI sessions can read the history on
|
|
both roles. Collection uses the MCU temperature, battery voltage, external I2C
|
|
voltage monitors, and an already-valid onboard GPS fix. It does not wake GPS,
|
|
so an off, sleeping, or unfixed GPS produces a missing location sample without
|
|
changing its power-saving schedule.</p>
|
|
<p>External voltage history allocates 360 bytes for each detected monitor channel
|
|
(1,080 bytes for all three INA3221 inputs). The allocation reserves all
|
|
detected inputs so a sensor connected later can start recording, but all-zero
|
|
inputs are omitted from command replies and LoRa transmission.</p>
|
|
<p>Replies contain <code>></code> followed by standard padded Base64. After decoding, all
|
|
multi-byte integers are little-endian. Packed fields are written most
|
|
significant bit first, oldest sample first.</p>
|
|
<p>Use the browser-based <a href="../telemetry_decoder/">Telemetry history decoder</a> to
|
|
turn a reply into a timestamped table or downloadable CSV without uploading
|
|
the data.</p>
|
|
<p><code>telemetry.tx</code> is disabled by default. Its schedule and direct path are stored
|
|
across reboots. Configuring <code>direct</code> or a routed path enables the default <code>2d</code>
|
|
schedule; <code>set telemetry.tx schedule</code> changes it from one through 30 days or
|
|
turns it off. An automatic run waits until 165 half-hour positions are
|
|
available, then sends one maximum-size temperature packet, one maximum-size
|
|
battery-voltage packet, and up to three <code>IVB1</code> packets for every populated I2C
|
|
voltage channel. GPS is never included in this raw transmission. The history
|
|
remains boot-local, so the first scheduled run after a reboot needs about 82.5
|
|
hours to fill. On the default two-day interval, each 82.5-hour temperature or
|
|
battery packet overlaps its predecessor by 34.5 hours. Packets are paced two
|
|
seconds apart. A queue failure is retried after 30 minutes only for the packet
|
|
that did not queue; successfully queued packets are not duplicated.</p>
|
|
<p><code>send telemetry.tx now</code> is an administrator-only test action. It queues
|
|
temperature and battery-voltage snapshots plus the available I2C voltage
|
|
chunks over the configured path. It uses all currently available base
|
|
positions up to 165 and all available I2C positions up to 192 per populated
|
|
channel. It works while the schedule is off and does not move the next
|
|
scheduled send time. RAW_CUSTOM direct packets do not enter the normal
|
|
encrypted direct-message retry mechanism.</p>
|
|
<p>Full snapshots are 184-byte RAW_CUSTOM payloads. Manual tests can be shorter
|
|
while history fills. Both formats are binary, not Base64 and not encrypted:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code>-<code>3</code></td>
|
|
<td>ASCII magic <code>TTB1</code> for temperature or <code>TVB1</code> for voltage</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>4</code>-<code>11</code></td>
|
|
<td>First eight bytes of the repeater public key</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>12</code>-<code>15</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit little-endian</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>16</code>-<code>17</code></td>
|
|
<td>Sample interval in minutes, unsigned 16-bit little-endian (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>18</code></td>
|
|
<td>Sample count (<code>1</code>-<code>165</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>19</code> onward</td>
|
|
<td>Oldest-to-newest encoded samples for the selected series</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Temperature codes reserve <code>0</code> for no reading, <code>1</code> for below <code>-50 C</code>, and <code>2</code>
|
|
for above <code>+77 C</code>. Codes <code>3</code> through <code>130</code> represent exact whole degrees from
|
|
<code>-50 C</code> through <code>+77 C</code>; decode them as <code>code - 53</code>. Voltage codes use the
|
|
same encoding as the paged voltage payload documented below.</p>
|
|
<p>External voltage snapshots use a separate packed layout. A full four-day
|
|
channel takes three 140-byte <code>IVB1</code> payloads of 64 points each:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code>-<code>3</code></td>
|
|
<td>ASCII magic <code>IVB1</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>4</code>-<code>11</code></td>
|
|
<td>First eight bytes of the source public key</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>12</code>-<code>15</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit little-endian</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>16</code>-<code>17</code></td>
|
|
<td>Sample interval in minutes, unsigned 16-bit little-endian (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>18</code></td>
|
|
<td>Cayenne LPP voltage channel</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>19</code></td>
|
|
<td>Sample count (<code>1</code>-<code>64</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>20</code> onward</td>
|
|
<td>Oldest-to-newest packed 15-bit voltage codes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Code <code>0</code> means missing or disconnected. Codes <code>1</code>-<code>32767</code> represent <code>0.02 V</code>
|
|
through <code>655.34 V</code> in <code>0.02 V</code> steps; decode millivolts as <code>code * 20</code>.</p>
|
|
<p>Match bytes <code>4</code>-<code>11</code> to the first 16 hex characters of the repeater public key
|
|
shown by its advert or <code>get public.key</code>. This compact identifier is useful for
|
|
association but is not authenticated and can be spoofed. An MQTT observer can
|
|
upload the received raw packet to LetsMesh Analyzer <code>/packets</code>; its packet hex
|
|
contains the direct-route header and path followed by this payload.</p>
|
|
<p>Temperature payload (<code>0x11</code>, 61 bytes):</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code></td>
|
|
<td>Format/type <code>0x11</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>1</code>-<code>4</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>5</code></td>
|
|
<td>Sample interval in minutes (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>6</code></td>
|
|
<td>Sample count (<code>48</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>7</code>-<code>18</code></td>
|
|
<td>48 packed 2-bit temperature statuses</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>19</code>-<code>60</code></td>
|
|
<td>48 packed 7-bit temperatures</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Temperature status codes are <code>0</code> none, <code>1</code> value, <code>2</code> below range, and <code>3</code>
|
|
above range. For status <code>1</code>, the 7-bit temperature is an exact whole-degree
|
|
integer from <code>-50 C</code> through <code>+77 C</code>; decode it as <code>code - 50</code>. Low values use
|
|
code <code>0</code>, and high values use code <code>127</code>. The separate status map is required
|
|
because 7 bits contain exactly 128 codes, leaving no spare code for none, low,
|
|
or high when the complete range is represented at 1 C resolution. No
|
|
fractional temperature is stored or transmitted.</p>
|
|
<p>Voltage payload (<code>0x12</code>, 55 bytes):</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code></td>
|
|
<td>Format/type <code>0x12</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>1</code>-<code>4</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>5</code></td>
|
|
<td>Sample interval in minutes (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>6</code></td>
|
|
<td>Sample count (<code>48</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>7</code>-<code>54</code></td>
|
|
<td>48 8-bit voltage codes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Voltage codes reserve <code>0</code> for no reading, <code>1</code> for below <code>1.88 V</code>, and <code>255</code>
|
|
for above <code>4.40 V</code>. Codes <code>2</code>-<code>254</code> represent <code>1.88 V</code> through <code>4.40 V</code> in
|
|
<code>0.01 V</code> steps; decode millivolts as <code>1880 + (code - 2) * 10</code>.</p>
|
|
<p>External I2C voltage payload (<code>0x14</code>, 98 bytes):</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code></td>
|
|
<td>Format/type <code>0x14</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>1</code>-<code>4</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>5</code></td>
|
|
<td>Sample interval in minutes (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>6</code></td>
|
|
<td>Sample count (<code>48</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>7</code></td>
|
|
<td>Cayenne LPP voltage channel</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>8</code>-<code>97</code></td>
|
|
<td>48 packed 15-bit voltage codes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The codes have the same <code>0.02 V</code> through <code>655.34 V</code> meaning as <code>IVB1</code>.</p>
|
|
<p>GPS payload (<code>0x13</code>, 101 bytes):</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Bytes</th>
|
|
<th>Meaning</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0</code></td>
|
|
<td>Format/type <code>0x13</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>1</code>-<code>4</code></td>
|
|
<td>First sample UTC epoch, unsigned 32-bit</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>5</code></td>
|
|
<td>Sample interval in minutes (<code>30</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>6</code></td>
|
|
<td>Sample count (<code>24</code>)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>7</code>-<code>10</code></td>
|
|
<td>Page origin latitude in signed degrees times <code>10^7</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>11</code>-<code>14</code></td>
|
|
<td>Page origin longitude in signed degrees times <code>10^7</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>15</code></td>
|
|
<td>Origin sample index, or <code>255</code> when the page has no GPS fix</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>16</code></td>
|
|
<td>Flags; bit 0 means at least one differential was clipped</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>17</code>-<code>100</code></td>
|
|
<td>24 records: signed 14-bit north then signed 14-bit east</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>GPS differentials use signed 14-bit two's-complement values at 10-meter
|
|
resolution and are applied to the preceding decoded valid point. The origin
|
|
sample begins at the header coordinates. A no-fix slot encodes <code>0,0</code> and does
|
|
not advance the reference; a stationary valid fix also quantizes to <code>0,0</code>.
|
|
When a page has no fixes, its origin is <code>0,0</code>, origin index is <code>255</code>, and all
|
|
differentials are <code>0,0</code>. Values outside <code>-8192</code> through <code>8191</code> are clipped and
|
|
set flag bit 0.</p>
|
|
<hr />
|
|
<h2 id="set-companion-display-rotation">Set Companion display rotation</h2>
|
|
<p>SSD1306 Full Companion builds support a persisted runtime orientation:</p>
|
|
<pre><code class="language-text">get display.rotation
|
|
set display.rotation 0
|
|
set display.rotation 90
|
|
set display.rotation 180
|
|
set display.rotation 270
|
|
</code></pre>
|
|
<p>The values are clockwise degrees. <code>0</code> clears the override and restores the
|
|
board's compiled default. Unsupported display drivers return an error.</p>
|
|
<hr />
|
|
<h2 id="show-touchscreen-touch-areas">Show touchscreen touch areas</h2>
|
|
<p>All touchscreen Companion builds using the shared touch UI support temporary
|
|
diagnostic outlines, including both SenseCAP Indicator rendering sizes:</p>
|
|
<pre><code class="language-text">get display.touch
|
|
set display.touch on
|
|
set display.touch off
|
|
</code></pre>
|
|
<p>The default is <strong>off at every boot</strong>. Enabling wakes the display without
|
|
selecting anything. Dotted yellow borders mark the actual scaled tap targets;
|
|
the area under a held finger turns green and returns to yellow on release.
|
|
Disabling removes the borders on the next redraw. Pairing screens suppress the
|
|
overlay while they consume navigation. This option does not change the font,
|
|
touch calibration, navigation actions, or saved settings, and is not persisted.</p>
|
|
<p>Use the text terminal or Companion framed CLI (<code>0x42</code>) through an available
|
|
USB, BLE, or TCP connection. Non-touchscreen, missing-display, and legacy UI
|
|
builds report <code>Error: touchscreen diagnostics unsupported</code>. No Indicator-only
|
|
build flag is needed.</p>
|
|
<hr />
|
|
<h2 id="set-display-modes-and-timeouts">Set display modes and timeouts</h2>
|
|
<p>Display-equipped Companions, repeaters, room servers, and sensors have four
|
|
saved settings. The WebConfig <strong>Display</strong> card exposes the same controls:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Setting</th>
|
|
<th>CLI</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Battery mode</td>
|
|
<td><code>get/set display.mode</code></td>
|
|
<td><code>button-pairing</code> on BLE Companions; <code>button</code> elsewhere</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Battery timeout, seconds</td>
|
|
<td><code>get/set display.timeout</code></td>
|
|
<td><code>15</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>USB mode</td>
|
|
<td><code>get/set display.usb.mode</code></td>
|
|
<td>Same as battery mode</td>
|
|
</tr>
|
|
<tr>
|
|
<td>USB timeout, seconds</td>
|
|
<td><code>get/set display.usb.timeout</code></td>
|
|
<td><code>15</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Modes are <code>off</code>, <code>on</code>, <code>button</code>, <code>pairing</code>, <code>button-pairing</code>, and <code>automatic</code>.
|
|
Pairing modes are available only on builds supporting BLE pairing.</p>
|
|
<ul>
|
|
<li><code>off</code>: stays dark, including boot and pairing.</li>
|
|
<li><code>on</code>: stays on while the device is awake.</li>
|
|
<li><code>button</code>: a physical button, keyboard/navigation input, or supported touch
|
|
wakes the display and restarts the timeout.</li>
|
|
<li><code>pairing</code>: wakes only for an actual BLE PIN request, until pairing ends or
|
|
expires. The inactivity timeout does not shorten the pairing prompt.</li>
|
|
<li><code>button-pairing</code>: combines the button and pairing behaviors.</li>
|
|
<li><code>automatic</code>: shows startup briefly (at most four seconds), and wakes for
|
|
messages while the app is disconnected. An app connection blanks the screen;
|
|
buttons and pairing requests can still wake it. Disconnecting alone does not
|
|
wake it. Network traffic and screen redraws do not extend the timeout.</li>
|
|
</ul>
|
|
<p>Timeouts are whole seconds from <code>1</code> to <code>3600</code>. Use mode <code>on</code> for a permanent
|
|
display rather than timeout <code>0</code>. The timeout is retained but unused in <code>off</code>,
|
|
<code>on</code>, and <code>pairing</code> modes. Settings apply immediately, including while blanked;
|
|
changing power source applies the other profile without carrying over a wake
|
|
from the previous profile. Settings survive reboot and filesystem-preserving
|
|
updates in <code>/display_prefs</code>; erasing the filesystem restores the defaults.
|
|
An existing observer timeout that differs from its old 60-second default is
|
|
migrated once to both power profiles; an old zero timeout becomes mode <code>on</code>.</p>
|
|
<pre><code class="language-text">set display.mode button-pairing
|
|
set display.timeout 15
|
|
set display.usb.mode on
|
|
set display.usb.timeout 60
|
|
</code></pre>
|
|
<p>USB profile selection uses the board's external-power detector, with USB-host
|
|
detection as a fallback. VBUS-capable boards detect chargers without a data
|
|
connection. Heltec V4 R8 uses either a detected USB host or a calibrated battery
|
|
voltage above 4.21 V. The voltage estimate is checked every five seconds and
|
|
clears at 4.20 V or below; host detection takes effect immediately. This estimate
|
|
can miss a charger while the battery is low, depends on ADC calibration, and
|
|
cannot distinguish USB from solar charging. Other boards without a power
|
|
detector may require a USB host to recognize USB power. Wi-Fi/MQTT connection or
|
|
BLE pairing is not evidence of USB power. E-paper panels can retain their last
|
|
image when powered off.</p>
|
|
<h2 id="set-companion-inbox-behavior">Set Companion inbox behavior</h2>
|
|
<p>The shared Companion UI (including T114 and R8) defaults to <strong>History</strong>: the
|
|
last 32 received text previews remain available on the radio after an app
|
|
downloads them. <strong>Pending</strong> separately counts frames waiting for the app,
|
|
including non-text frames. Downloading a frame clears it from Pending; it does
|
|
not mean someone read it. The phone's delivery queue is independent of the
|
|
32-entry preview history and is never drained by reading on the radio.</p>
|
|
<pre><code class="language-text">get display.inbox
|
|
set display.inbox history
|
|
set display.inbox pending
|
|
set display.inbox unread
|
|
</code></pre>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Mode</th>
|
|
<th>Display behavior</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>history</code> (default)</td>
|
|
<td>Shows <strong>HISTORY</strong> with the retained preview count, plus <strong>Pending</strong>. Downloaded previews remain browseable.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>pending</code></td>
|
|
<td>Shows <strong>INBOX</strong> with the app queue count and limits the reader to previews still waiting for the app. Non-text frames count toward Pending but have no text preview.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>unread</code></td>
|
|
<td>Shows <strong>UNREAD</strong> with the number of retained previews not yet displayed on the radio, plus <strong>Pending</strong>. Opening a preview on a lit display marks it read; app downloads do not. Read previews remain browseable.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>All modes retain up to 32 previews internally; switching from <code>pending</code> back to
|
|
<code>history</code> makes retained downloaded previews visible again. Evicted or rejected
|
|
queue entries are not shown as pending. Previews and local read state are in RAM
|
|
and reset on reboot. The mode applies immediately and survives reboot in
|
|
<code>/display_prefs</code>; existing version-1 display settings load with <code>history</code> as the
|
|
default. Legacy and tiny Companion UIs report <code>Error: inbox modes unsupported</code>.</p>
|
|
<p>Incoming messages automatically open their preview only when no client is
|
|
connected. While connected, new messages neither select another page nor move
|
|
the preview being read; history stays accessible by button or touch. The home
|
|
screen identifies connected USB and Bluetooth clients (or both), and TCP,
|
|
Ethernet, or serial clients where supported. Actual BLE pairing prompts retain
|
|
priority over connection status.</p>
|
|
<h2 id="set-mqtt-observer-display-flip">Set MQTT observer display flip</h2>
|
|
<p>Supported observer displays, including the R8 OLED and ST7789 panels, can also
|
|
be turned 180 degrees relative to their compiled orientation:</p>
|
|
<pre><code class="language-text">get display.flip
|
|
set display.flip off
|
|
set display.flip on
|
|
</code></pre>
|
|
<p><code>0</code> and <code>1</code> are accepted aliases for <code>off</code> and <code>on</code>. This is intentionally
|
|
different from Full Companion <code>display.rotation</code>: observer <code>display.flip</code> is a
|
|
relative 180-degree mounting choice and cannot switch between portrait and
|
|
landscape. The value is harmless on an observer display driver that does not
|
|
support flipping.</p>
|
|
<p>Flip survives reboot and firmware updates that preserve the filesystem;
|
|
erasing flash restores the <code>off</code> default. The boot log reports the saved
|
|
flip state on display-enabled observer builds.</p>
|
|
<hr />
|
|
<h2 id="logging">Logging</h2>
|
|
<p>Builds compiled with <code>MESH_PACKET_LOGGING</code> emit one <code>RAW:</code> line for every
|
|
received radio frame. Serial output uses backpressure: if a connected host
|
|
temporarily stops reading, packet processing waits for USB transmit space
|
|
instead of silently omitting the record. A disconnected host cannot retain an
|
|
unbounded capture, so logging deployments should keep the reader attached and
|
|
draining the serial port.</p>
|
|
<p>Every valid received frame also emits the decoded RX summary, including signal,
|
|
timing, hash, type, route, and payload information. Frames that cannot be
|
|
decoded still emit their <code>RAW:</code> line. Transmitted packets emit the decoded TX
|
|
summary.</p>
|
|
<p>Ordinary non-OTA artifacts compile packet logging into the canonical image and
|
|
control its live USB output at runtime; no separate <code>-logging-</code> artifact is
|
|
emitted. Use the separately named <code>-ota-</code> artifact when LoRa OTA is required. A
|
|
<code>-full-usb-wifi-ota-</code> artifact combines USB packet logging, direct WiFi MQTT,
|
|
LoRa OTA, and the expanded FULL feature set. A <code>-full-logging-ota-</code> artifact is
|
|
emitted only when that hardware/role has no matching WiFi MQTT environment.</p>
|
|
<h3 id="control-live-usb-logging">Control live USB logging</h3>
|
|
<p><strong>Search terms:</strong> serial logging, USB debug log, enable logging, disable logging, debug output.</p>
|
|
<p><strong>Usage:</strong></p>
|
|
<pre><code class="language-text">get usb.logging
|
|
set usb.logging on
|
|
set usb.logging off
|
|
set usb.logging on reboot
|
|
set usb.logging off reboot
|
|
</code></pre>
|
|
<p><strong>ESP32 1.17.1.5 USB logging procedure:</strong> disable device sleep before enabling
|
|
the log stream, using separate text commands:</p>
|
|
<pre><code class="language-text">set powersaving off
|
|
set usb.logging on
|
|
</code></pre>
|
|
<p>Verify with <code>get powersaving</code> (expect <code>off</code>) and <code>get usb.logging</code> (expect <code>on</code>).
|
|
Both settings are saved; disabling logging later does not restore power
|
|
saving. This works around the <a href="../releases/1.17.1.5/#g3-usb-disappearance-with-power-saving-enabled">released USB sleep bug</a>.
|
|
nRF52 does not need this ESP32 workaround.</p>
|
|
<p>These commands are compiled into ordinary USB-loggable artifacts and every
|
|
Full Companion. They control live USB debug and packet output. CommonCLI roles
|
|
save the setting in <code>/com_prefs</code>, so it survives reboot; their first boot
|
|
defaults to on. Full Companion and ordinary USB Companion start off on a fresh
|
|
installation so diagnostics cannot corrupt framed traffic.</p>
|
|
<p>On Full Companion these lines belong to its text terminal, not <code>meshcli</code>'s
|
|
Binary <code>get/set</code> parameter namespace. Open interface <code>00</code>, send
|
|
<code>+++MESHCORE-TERM-START</code>, and then issue the command. Running
|
|
<code>meshcli ... get usb.logging</code> directly can instead return
|
|
<code>Unknown var usb.logging</code> because that is a different protocol operation.</p>
|
|
<p>nRF52 Full Companion defaults logging to off and enumerates only USB interface
|
|
<code>00</code>, which carries Companion, terminal, and serial mOTA traffic. Enabling
|
|
logging adds interface <code>02</code>, its dedicated plaintext logging port, on the next
|
|
boot. Disabling it removes interface <code>02</code> on the next boot. A command without
|
|
the optional <code>reboot</code> argument saves the choice and reports that a reboot is
|
|
required when the USB interface count must change. The exact
|
|
<code>set usb.logging on reboot</code> and <code>set usb.logging off reboot</code> forms save the
|
|
choice, send their reply, and reboot one second later only when needed.</p>
|
|
<p>On every ESP32 Full Companion, enter the USB text terminal and use
|
|
<code>set usb.logging on</code> (preceded by <code>set powersaving off</code> on 1.17.1.5) to turn that TTY into a logging-repeater-style plaintext
|
|
stream. Framed Binary Companion is unavailable on USB while logging is on. The
|
|
TTY remains an input-capable CLI, so <code>set usb.logging off</code> works on the same
|
|
TTY. After its reply, logging stops and the TTY remains in the normal ASCII
|
|
terminal, just as it does after a fresh Full installation. Send
|
|
<code>+++MESHCORE-TERM-STOP</code>, or let a Companion app send a valid framed probe, to
|
|
switch it to Binary Companion. No reboot is needed because the USB interface
|
|
count does not change.</p>
|
|
<p>Turning USB logging off does not disable CLI replies. nRF52 keeps Companion
|
|
frames active on interface <code>00</code>; ESP32 resumes the ordinary ASCII/Binary
|
|
switcher after the logging terminal turns logging off. This setting does not
|
|
change the node-storage capture controlled by <code>log start</code> and <code>log stop</code>.</p>
|
|
<p>Companion, Repeater, Room Server, and Sensor builds with both MQTT and USB
|
|
logging provide the same saved selector for both output paths:</p>
|
|
<pre><code class="language-text">get logging.output
|
|
set logging.output off
|
|
set logging.output usb
|
|
set logging.output wifi
|
|
set logging.output both
|
|
</code></pre>
|
|
<p><code>usb</code> emits <code>RAW:</code> packets for a USB-connected service such as
|
|
meshcoretomqtt. <code>wifi</code> enables the direct MQTT bridge configured by the
|
|
<code>wifi.*</code> and <code>mqtt.*</code> commands. <code>both</code> intentionally duplicates the radio
|
|
stream to both consumers; do not point both consumers at the same broker unless
|
|
the downstream setup deduplicates messages. Fresh unified Full infrastructure installs start
|
|
in <code>both</code> mode; Full Companion starts with USB logging off. To change only
|
|
MQTT, use <code>set mqtt.enabled on|off</code>; <code>get mqtt.enabled</code> checks the saved
|
|
switch and <code>get mqtt.running</code> checks whether the MQTT service is running.
|
|
Turning MQTT off preserves all broker slots and credentials.</p>
|
|
<p>On <strong>1.17.1.5 ESP32</strong>, run <code>set powersaving off</code> before selecting
|
|
<code>set logging.output usb</code> or <code>set logging.output both</code>, since those modes
|
|
enable USB logging. <strong>WiFi/MQTT-only logging does not need this workaround
|
|
while the Repeater/Room Server MQTT bridge is running</strong>; the released code
|
|
already blocks device sleep in that state. Check <code>get mqtt.running</code>, not
|
|
only <code>get mqtt.enabled</code>. WiFi modem power saving is a separate setting.</p>
|
|
<h3 id="begin-capture-of-rx-log-to-node-storage">Begin capture of rx log to node storage</h3>
|
|
<p><strong>Search terms:</strong> save logs, record received packets, RX logging, stored packet log.</p>
|
|
<p><strong>Usage:</strong> <code>log start</code></p>
|
|
<hr />
|
|
<h3 id="end-capture-of-rx-log-to-node-storage">End capture of rx log to node storage</h3>
|
|
<p><strong>Usage:</strong> <code>log stop</code></p>
|
|
<hr />
|
|
<h3 id="erase-captured-log">Erase captured log</h3>
|
|
<p><strong>Usage:</strong> <code>log erase</code></p>
|
|
<hr />
|
|
<p><a id="print-the-captured-log-to-the-serial-terminal"></a></p>
|
|
<h3 id="print-the-captured-log-to-the-requesting-terminal">Print the captured log to the requesting terminal</h3>
|
|
<p><strong>Usage:</strong> <code>log</code></p>
|
|
<p><strong>Local connection only:</strong> USB, direct network CLI, or Companion binary
|
|
command <code>0x42</code> where the role supports the command; unavailable over LoRa.</p>
|
|
<hr />
|
|
<h2 id="info">Info</h2>
|
|
<h3 id="get-the-version">Get the Version</h3>
|
|
<p><strong>Usage:</strong> <code>ver</code></p>
|
|
<p>On Full Companion, the Binary device-info frame retains its legacy fixed-width
|
|
version field. Use <code>version</code> in the text terminal, or send <code>version</code> through
|
|
Binary protocol command <code>0x42</code> (<code>CMD_RUN_CLI_COMMAND</code>), to read the complete
|
|
untruncated firmware string together with protocol and build date.</p>
|
|
<hr />
|
|
<h3 id="show-the-hardware-name">Show the hardware name</h3>
|
|
<p><strong>Usage:</strong> <code>board</code></p>
|
|
<hr />
|
|
<h3 id="show-the-storage-layout">Show the storage layout</h3>
|
|
<p><strong>Usage:</strong> <code>get storage.layout</code></p>
|
|
<p>Reports a compact, read-only summary of the storage compiled into the running
|
|
firmware:</p>
|
|
<ul>
|
|
<li>ESP32 reports the detected internal flash size and the live partition table.
|
|
Partition addresses after <code>@</code> are hexadecimal, sizes after <code>+</code> are KiB, and
|
|
<code>*</code> marks the running application. <code>...</code> means later entries did not fit in
|
|
the CLI reply.</li>
|
|
<li>nRF52 reports the physical internal flash size, linked application range,
|
|
InternalFS range, and any configured external store. Raw QSPI OTA storage
|
|
includes its detected size and JEDEC ID; SD storage includes total, used, and
|
|
free space.</li>
|
|
<li>RP2040 and STM32 report their fixed internal flash and filesystem geometry.</li>
|
|
</ul>
|
|
<p>The command does not write, format, or resize storage. A raw-QSPI or SD build
|
|
may briefly probe, wake, or mount its configured external storage to read its
|
|
capacity. Remote use follows the existing administrator-command permissions.</p>
|
|
<hr />
|
|
<h2 id="configuration">Configuration</h2>
|
|
<h3 id="radio">Radio</h3>
|
|
<h4 id="view-or-change-this-nodes-radio-parameters">View or change this node's radio parameters</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio</code>
|
|
- <code>set radio <freq>,<bw>,<sf>,<cr></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>freq</code>: Frequency in MHz
|
|
- <code>bw</code>: Bandwidth in kHz. Most targets allow <code>7.8</code>, <code>10.4</code>, <code>15.6</code>, <code>20.8</code>, <code>31.25</code>, <code>41.7</code>, <code>62.5</code>, <code>125</code>, <code>250</code>, <code>500</code>. LR1110 targets allow <code>62.5</code>, <code>125</code>, <code>250</code>, <code>500</code>.
|
|
- <code>sf</code>: Spreading factor (5-12)
|
|
- <code>cr</code>: Coding rate (5-8)</p>
|
|
<p><strong>Set by build flag:</strong> <code>LORA_FREQ</code>, <code>LORA_BW</code>, <code>LORA_SF</code>, <code>LORA_CR</code></p>
|
|
<p><strong>Default:</strong> <code>869.525,250,11,5</code></p>
|
|
<p><strong>Note:</strong> Requires reboot to apply. If RXPS is enabled and the saved minimum
|
|
level/preamble cannot safely cover the new radio timing, the command reply
|
|
reports the effective level and preamble, or <code>RXPS continuous-fast</code> when no
|
|
level through 10 is safe. Slower settings recalculate from the saved RXPS
|
|
minimum and return to it exactly when it is safe.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-transmit-power">View or change this node's transmit power</h4>
|
|
<p><strong>Search terms:</strong> tx power, transmit strength, radio output power, dBm.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get tx</code>
|
|
- <code>set tx <dbm></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>dbm</code>: Requested radio-chip power in dBm. The valid range depends on the
|
|
radio family, selected PA path, and any board-specific external-PA limit.</p>
|
|
<p><strong>Set by build flag:</strong> <code>LORA_TX_POWER</code></p>
|
|
<p><strong>Default:</strong> Varies by board</p>
|
|
<p><strong>Notes:</strong> This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Refer to the node's manual for the correct setting to use. <strong>Setting a value too high may violate the laws in your country.</strong></p>
|
|
<p>The command strictly rejects malformed values and saves the new preference
|
|
only after the active radio driver accepts it. On LR2021, the chip range is
|
|
<code>-9</code> to <code>22</code> dBm below 1500 MHz and <code>-19</code> to <code>12</code> dBm above 1500 MHz. A lower
|
|
board-specific external-PA limit still takes precedence. A saved profile is
|
|
clamped to the applicable limit when its frequency changes; temporary radio
|
|
settings use a safe effective power without replacing the saved preference.</p>
|
|
<hr />
|
|
<h4 id="change-the-radio-parameters-for-a-set-duration">Change the radio parameters for a set duration</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins></code>
|
|
- <code>normalradio</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>freq</code>: Frequency in MHz (150-2500)
|
|
- <code>bw</code>: Bandwidth in kHz (same allowed values as <code>set radio</code>)
|
|
- <code>sf</code>: Spreading factor (5-12)
|
|
- <code>cr</code>: Coding rate (5-8)
|
|
- <code>timeout_mins</code>: Duration in minutes (must be > 0)</p>
|
|
<p><strong>Notes:</strong>
|
|
- <code>tempradio</code> is not saved to preferences and clears on reboot.
|
|
- <code>normalradio</code> cancels pending and active temporary-radio windows, then
|
|
restores the saved radio tuple after its CLI reply has drained on the
|
|
current channel. Permanent <code>radioat</code> entries are not removed.
|
|
- On repeaters, the reply includes total minutes plus <code>NdNhNm</code> (days, hours,
|
|
minutes) and the watchdog policy for that session. For example:</p>
|
|
<pre><code class="language-text">OK - temp params for 1440 mins (1d0h0m); rx.watchdog=12hours
|
|
OK - temp params for 3075 mins (2d3h15m); rx.watchdog=12hours
|
|
OK - temp params for 180 mins (0d3h0m); rx.watchdog=off (temp<12hours)
|
|
</code></pre>
|
|
<p>Repeater timing overrides apply only while a temporary window is running:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Temporary duration</th>
|
|
<th>No-RX reboot watchdog</th>
|
|
<th>Flood advert interval</th>
|
|
<th>Direct/local advert interval</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Up to and including 3 hours</td>
|
|
<td>Off</td>
|
|
<td>Saved normal interval</td>
|
|
<td>1 hour</td>
|
|
</tr>
|
|
<tr>
|
|
<td>More than 3, less than 12 hours</td>
|
|
<td>Off</td>
|
|
<td>3 hours</td>
|
|
<td>1 hour</td>
|
|
</tr>
|
|
<tr>
|
|
<td>12 hours or longer</td>
|
|
<td>12 hours</td>
|
|
<td>3 hours</td>
|
|
<td>1 hour</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The duration is the requested window length, not the decreasing time remaining.
|
|
The first temporary adverts are scheduled from successful radio activation;
|
|
hourly local adverts still run when a flood advert is also due. <code>get
|
|
advert.interval</code> and <code>get flood.advert.interval</code> report the effective intervals.
|
|
The web configuration form continues to show and edit the saved normal advert
|
|
settings. These include any changes made during a temporary session.
|
|
Expiry, cancellation, reboot, or power
|
|
loss removes the temporary overrides. Normal mode uses the saved advert
|
|
intervals and the 24-hour watchdog policy. An explicitly saved normal-mode
|
|
<code>rx.watchdog off</code> remains off outside temporary sessions.</p>
|
|
<hr />
|
|
<h4 id="schedule-radio-parameter-changes">Schedule radio parameter changes</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>set radioat <freq>,<bw>,<sf>,<cr>,<start_time></code>
|
|
- <code>get radioat [n|all]</code>
|
|
- <code>del radioat [n|all]</code>
|
|
- <code>set tempradioat <freq>,<bw>,<sf>,<cr>,<start_time>,<end_time></code>
|
|
- <code>get tempradioat [n|all]</code>
|
|
- <code>del tempradioat [n|all]</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>freq</code>: Frequency in MHz (150-2500)
|
|
- <code>bw</code>: Bandwidth in kHz (same allowed values as <code>set radio</code>)
|
|
- <code>sf</code>: Spreading factor (5-12)
|
|
- <code>cr</code>: Coding rate (5-8)
|
|
- <code>start_time</code>: Unix epoch time when the setting starts
|
|
- <code>end_time</code>: Unix epoch time when a temporary setting reverts
|
|
- <code>n</code>: Scheduled entry number from <code>get radioat</code> or <code>get tempradioat</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- <code>get radioat</code> and <code>get tempradioat</code> list all entries when <code>n</code> is omitted.
|
|
- <code>del radioat</code> and <code>del tempradioat</code> delete all entries when <code>n</code> is omitted.
|
|
- Each queue supports 3 entries. Scheduled entries are not saved across reboot.
|
|
- <code>radioat</code> saves the new radio preferences when it fires. <code>tempradioat</code> applies temporarily, then reverts to the saved radio preferences.
|
|
- <code>tempradioat</code> uses the repeater timing table above, with duration calculated
|
|
from <code>end_time - start_time</code>. Its acceptance reply includes total minutes, <code>NdNhNm</code>,
|
|
and the planned <code>rx.watchdog</code> setting. Queuing a future entry does not change
|
|
the running watchdog or advert intervals; the overrides start only after
|
|
the temporary radio parameters are successfully applied. If restoration
|
|
needs retries after expiry, the timing overrides still end with the window.
|
|
- A successful scheduling reply notes any RXPS effective-level/preamble change
|
|
required by the scheduled tuple. <code>RXPS continuous-fast</code> means the tuple is
|
|
accepted but will use continuous receive because no safe duty-cycle level is
|
|
available. Returning to slower settings recalculates from the saved RXPS
|
|
minimum.</p>
|
|
<p>With the measured RXPS model and the default 1600 us TCXO startup delay
|
|
(2600 us total transition), a requested minimum level 1 gives:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: right;">SF</th>
|
|
<th style="text-align: right;">BW (kHz)</th>
|
|
<th style="text-align: right;">Wire preamble</th>
|
|
<th style="text-align: right;">Effective timing preamble</th>
|
|
<th style="text-align: right;">Effective RXPS level</th>
|
|
<th style="text-align: right;">RX / sleep</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: right;">7</td>
|
|
<td style="text-align: right;">500</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">2</td>
|
|
<td style="text-align: right;">5594 / 3022 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">6</td>
|
|
<td style="text-align: right;">250</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">2</td>
|
|
<td style="text-align: right;">5844 / 3022 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">5</td>
|
|
<td style="text-align: right;">125</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">2</td>
|
|
<td style="text-align: right;">5844 / 3022 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">5</td>
|
|
<td style="text-align: right;">250</td>
|
|
<td style="text-align: right;">64</td>
|
|
<td style="text-align: right;">64</td>
|
|
<td style="text-align: right;">1</td>
|
|
<td style="text-align: right;">3829 / 5100 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">6</td>
|
|
<td style="text-align: right;">500</td>
|
|
<td style="text-align: right;">64</td>
|
|
<td style="text-align: right;">64</td>
|
|
<td style="text-align: right;">1</td>
|
|
<td style="text-align: right;">3829 / 5100 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">5</td>
|
|
<td style="text-align: right;">500</td>
|
|
<td style="text-align: right;">128</td>
|
|
<td style="text-align: right;">128</td>
|
|
<td style="text-align: right;">1</td>
|
|
<td style="text-align: right;">2563 / 6647 us</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: right;">5</td>
|
|
<td style="text-align: right;">62.5</td>
|
|
<td style="text-align: right;">32</td>
|
|
<td style="text-align: right;">16</td>
|
|
<td style="text-align: right;">6</td>
|
|
<td style="text-align: right;">11922 / 2975 us</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>These values include the actual transmitted preamble, explicit header, and a
|
|
one-symbol timer margin. SF5/SF6 need two more sync symbols than SF7, so their
|
|
receive windows differ even when symbol duration and sleep time match.</p>
|
|
<p>The wire preamble remains compatible with the existing Cascade convention:
|
|
32 symbols at SF5-SF8, extended to 64 for SF5/BW250 and SF6/BW500, or 128 for
|
|
SF5/BW500; SF9-SF12 use 16. Local RXPS settings and oscillator delays never
|
|
change the sender's preamble choice. The receiver may use a shorter catch
|
|
assumption, but its header timeout covers the full transmitted preamble.</p>
|
|
<p>Automatic adjustment stops at guarded level 8. If no guarded timing fits,
|
|
the radio receives continuously until the tuple changes. For example, a board
|
|
configured with the previous 5000 us TCXO delay uses continuous RX at SF7/BW500;
|
|
it cannot fit the new guard within that tuple's 32-symbol wire preamble.
|
|
Experimental levels 9 and 10 require an explicit selection.</p>
|
|
<p>Earlier firmware passed 16/16 packets in each direction between Heltec V4 and
|
|
WisMesh Tag at SF5/BW250/64 and SF5/BW500/128, CR5, 909.950 MHz. That result
|
|
established the existing wire-preamble convention; it does not validate the
|
|
new timing model. All senders to an RXPS receiver must use a compatible wire
|
|
preamble. LoRa OTA treats v1.17.1.5 as that capability boundary.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-frequency">View or change this node's frequency</h4>
|
|
<p><strong>Search terms:</strong> radio frequency, LoRa frequency, MHz.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get freq</code>
|
|
- <code>set freq <frequency></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>frequency</code>: Frequency in MHz</p>
|
|
<p><strong>Default:</strong> <code>869.525</code></p>
|
|
<p><strong>Note:</strong> Requires reboot to apply</p>
|
|
<p><strong>Connections:</strong> USB, browser/TCP/Ethernet CLI, Companion binary command
|
|
<code>0x42</code> (USB/BLE/TCP), and authorized LoRa CLI. <code>set freq</code> saves the frequency;
|
|
bandwidth, spreading factor, and coding rate stay as configured. Infrastructure
|
|
roles also clamp transmit power to the board's limit for that frequency. Like
|
|
<code>set radio</code>, it requires permission to configure the destination node.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-rx-boosted-gain-mode-sx12xx-and-lr1110-v1141">View or change this node's rx boosted gain mode (SX12xx and LR1110, v1.14.1+)</h4>
|
|
<p><strong>Search terms:</strong> RX boost, receive gain, receiver sensitivity, boosted reception.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio.rxgain</code>
|
|
- <code>set radio.rxgain <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Default:</strong> Target-specific. Most SX1262 and LR1110 targets default to <code>on</code>;
|
|
Station G2/G3 targets default to <code>off</code>.</p>
|
|
<p><strong>Notes:</strong>
|
|
- The saved setting is applied immediately and persists across reboots.
|
|
- Periodic AGC resets restore the saved runtime setting; they do not replace it
|
|
with the target's compile-time default.
|
|
- Existing installations retain their previously saved value after an upgrade.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-rx-duty-cycle-power-saving">View or change RX duty-cycle power saving</h4>
|
|
<p><strong>Search terms:</strong> RX power saving, receiver sleep, radio power saving, RXPS.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio.rxps</code>
|
|
- <code>get radio.rxps.config</code>
|
|
- <code>get radio.rxps.rfrx_disabled</code>
|
|
- <code>get rxps.wd</code>
|
|
- <code>set radio.rxps.rfrx_disabled <state></code>
|
|
- <code>set radio.rxps off</code>
|
|
- <code>set radio.rxps on</code>
|
|
- <code>set radio.rxps conservative</code>
|
|
- <code>set radio.rxps balanced</code>
|
|
- <code>set radio.rxps max</code>
|
|
- <code>set radio.rxps max preamble <16|32></code>
|
|
- <code>set radio.rxps overdrive</code>
|
|
- <code>set radio.rxps overdrive preamble <16|32></code>
|
|
- <code>set radio.rxps riskyWorkingMax</code>
|
|
- <code>set radio.rxps riskyWorkingMax preamble <16|32></code>
|
|
- <code>set radio.rxps <1-10></code>
|
|
- <code>set radio.rxps level <1-10></code>
|
|
- <code>set radio.rxps level <1-10> preamble <16|32></code>
|
|
- <code>set radio.rxps <rx_us> <sleep_us></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>rx_us</code>, <code>sleep_us</code>: Receive and sleep durations in microseconds (<code>1000</code>-<code>30000000</code>).
|
|
- <code>level</code>: Guarded levels <code>1</code>-<code>8</code>, followed by experimental levels <code>9</code> and <code>10</code>. Higher guarded levels allow more sleep.
|
|
- <code>preamble</code>: RXPS timing assumption in symbols; <code>16</code> or <code>32</code>. This does not
|
|
change the radio's actual transmitted preamble.
|
|
- <code>state</code>: <code>on</code> or <code>off</code>.</p>
|
|
<p><strong>Notes:</strong>
|
|
- <code>get rxps.wd</code> reports the radio watchdogs' soft and hard recovery counts.
|
|
See <a href="../radio_receive_calibration/">receive calibration and recovery</a> for
|
|
noise sampling, CAD handling, and the continuous-RX mode check.
|
|
- <code>get radio.rxps.config</code> adds the persisted level and preamble assumption to
|
|
the on/off and timing values. Deployment tools use it to restore a
|
|
level-based preference without converting it to fixed manual timings.
|
|
- <code>radio.rxps.rfrx_disabled</code> is a runtime-only diagnostic setting and resets to <code>off</code> after reboot.
|
|
- Its default <code>off</code> state keeps the host-controlled SX1262 receive path enabled during RX duty-cycle mode. Setting it to <code>on</code> reproduces the old missing-RF_RX behavior and can significantly reduce receive sensitivity, making remote commands harder to receive.
|
|
- <code>radio.rxps.rfrx_disabled</code> is supported only on SX1262 targets with a host-controlled RX enable pin.
|
|
- <code>on</code> and <code>conservative</code> select level <code>3</code>, <code>balanced</code> selects level <code>6</code>, and
|
|
<code>max</code> selects level <code>8</code>; each named profile assumes a 16-symbol preamble.
|
|
- The guarded catch ladders for levels 1-8 are <code>15,14,13,12,11,10,9,8</code> symbols
|
|
for preamble 16 and <code>24,20,16,14,12,10,9,8</code> for preamble 32 or longer.
|
|
Generated sleep leaves another 0.2 symbols of margin. The receive timer covers
|
|
the actual wire preamble, sync, explicit header, and one extra symbol.
|
|
- <code>overdrive</code> selects level <code>9</code>; <code>riskyWorkingMax</code> selects level <code>10</code>. Both
|
|
operate outside the guarded timer condition. Upstream bench measurements
|
|
found packet loss at level 10; neither profile is a general guarantee of
|
|
reliable delivery. They are never selected by automatic level adjustment.
|
|
- Named experimental profiles accept <code>preamble 32</code>; numeric levels keep the
|
|
existing automatic-preamble selection. Manual timings bypass the level model.
|
|
- <code>MC_TCXO_DELAY_US</code> defaults to 1600 us. Initialization applies it and checks
|
|
TCXO/calibration errors. A board can override it for its oscillator.
|
|
- Fresh Cascade-profile builds start with RXPS on at level <code>8</code> and a 16-symbol preamble. Saved operator settings still take precedence after an upgrade.
|
|
- Level-based settings automatically recalculate their timings when the spreading factor or bandwidth changes. Custom <code><rx_us> <sleep_us></code> timings remain fixed.
|
|
- <code>get radio.rxps</code> keeps the legacy on/off, RX, and sleep reply. The new
|
|
<code>get radio.rxps.config</code> reply adds the saved level and preamble assumption.
|
|
Radio-change replies and the Full Companion terminal status report any
|
|
effective level/preamble adjustment. Effective preamble 64 or 128 appears
|
|
only when the active tuple's physical wire preamble has that length.
|
|
- The selected mode is applied immediately, persisted, and restored after reboot.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-lora-fem-receive-path-gain-state-on-supported-boards">View or change the LoRa FEM receive-path gain state on supported boards</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio.fem.rxgain</code>
|
|
- <code>set radio.fem.rxgain <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- This controls the external LoRa FEM receive-path LNA where the board supports it.
|
|
- This is separate from <code>radio.rxgain</code>, which controls the radio chip receive gain mode.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-lora-fem-transmit-path-gain-state-on-supported-boards">View or change the LoRa FEM transmit-path gain state on supported boards</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio.fem.txgain</code>
|
|
- <code>set radio.fem.txgain <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- This controls a software-selectable external LoRa FEM transmit gain where the board supports it.
|
|
- On Station G3, remove the PA PL1 jumper to allow software control. <code>on</code> selects PA PL1 high/short and <code>off</code> selects PA PL1 low/open. The PA PL2 hardware jumper determines whether this switches between power levels 1/3 or 2/4.
|
|
- Select an operating level and SX1262 transmit power that comply with local RF limits and the Station G3 power-supply requirements.
|
|
- The setting is saved immediately, but on Station G3 the level is applied to the hardware at the start of the next transmit, so that the PA supply rail is never re-targeted while the PA is being driven. <code>get</code> reports the configured state, which may lead the hardware until the node next transmits.</p>
|
|
<hr />
|
|
<h3 id="system">System</h3>
|
|
<h4 id="view-or-change-this-nodes-name">View or change this node's name</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get name</code>
|
|
- <code>set name <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Node name</p>
|
|
<p><strong>Set by build flag:</strong> <code>ADVERT_NAME</code></p>
|
|
<p><strong>Default:</strong> Varies by board</p>
|
|
<p><strong>Note:</strong> Advertised names can use up to 23 bytes when location is included and 31 bytes otherwise. Emoji and Unicode characters may take more than one byte. Names that exceed the available advert space are truncated at a valid UTF-8 code point boundary.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-independent-bluetooth-name-companion">View or change the independent Bluetooth name (Companion)</h4>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get bluetooth.name</code></li>
|
|
<li><code>set bluetooth.name <name|default></code></li>
|
|
</ul>
|
|
<p><code>get ble.name</code> and <code>set ble.name ...</code> are accepted aliases. This command is
|
|
specific to Companion firmware. The default is <code>MeshCore-<advert name></code>;
|
|
<code>default</code> (or <code>clear</code>) removes a custom override. Names are limited to 31 valid
|
|
UTF-8 bytes without control characters and take effect after reboot.</p>
|
|
<p>A binary Companion client should carry the same text in command <code>0x42</code>
|
|
(<code>CMD_RUN_CLI_COMMAND</code>), which works over USB, BLE, or TCP without entering USB
|
|
terminal mode. See <a href="../companion_protocol/">Companion radio binary protocol</a> for
|
|
the frame and reply format.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-bluetooth-address-ble-companion">View or change the Bluetooth address (BLE Companion)</h4>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get bluetooth.mac</code></li>
|
|
<li><code>set bluetooth.mac <address|random|random-every-boot|random-after-connect|default></code></li>
|
|
</ul>
|
|
<p><code>get ble.mac</code> and <code>set ble.mac ...</code> are accepted aliases. The setting is
|
|
available on every Companion build that includes Bluetooth.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Value</th>
|
|
<th>Result after reboot</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>C2:11:22:33:44:55</code></td>
|
|
<td>Save and use that custom address.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>random</code></td>
|
|
<td>Generate one random address now, save it, and reuse it on later boots.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>random-every-boot</code></td>
|
|
<td>Generate a new address once at each boot. <code>random everyboot</code> is also accepted.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>random-after-connect</code></td>
|
|
<td>Keep one random address through unused boots. After an authenticated connection, arm a new address for the next boot.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>default</code> or <code>clear</code></td>
|
|
<td>Remove the override and use the chipset's factory Bluetooth address.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>A custom value must be a valid BLE random-static address in
|
|
<code>XX:XX:XX:XX:XX:XX</code> form. Its first byte must be from <code>C0</code> through <code>FF</code>, and
|
|
you are responsible for keeping addresses unique. Hyphens are also accepted
|
|
on input; status output uses uppercase colons.</p>
|
|
<p>Every change requires a reboot and invalidates the phone's previous view of
|
|
the device. Forget the old device entry and pair again. <code>random-every-boot</code>
|
|
also clears the Companion's saved peer bonds during each startup, so pairing
|
|
and PIN entry are expected again after every reboot.</p>
|
|
<p><code>random-after-connect</code> keeps the same address across any number of reboots when
|
|
nobody successfully authenticated. As soon as an authenticated BLE connection
|
|
succeeds, the next boot rotates the address and clears stale bonds. The marker
|
|
is saved while connected, so a normal reboot, power switch, or battery pull
|
|
after that connection all produce the same next-boot rotation.</p>
|
|
<p>The address setting does not enable or disable stealth. Use the separate
|
|
<code>bluetooth.stealth</code> flag below. <code>default</code> changes only the address policy.</p>
|
|
<h4 id="view-or-change-bluetooth-stealth-ble-companion">View or change Bluetooth stealth (BLE Companion)</h4>
|
|
<pre><code class="language-text">get bluetooth.stealth
|
|
set bluetooth.stealth on
|
|
set bluetooth.stealth off
|
|
</code></pre>
|
|
<p><code>get ble.stealth</code> and <code>set ble.stealth on|off</code> are short aliases. This flag
|
|
defaults to <code>off</code> and is independent of the Bluetooth address policy. Enabling
|
|
or disabling it keeps the configured custom/random/factory address policy
|
|
unchanged and requires a reboot. Repeating <code>on</code> keeps an existing stealth
|
|
pairing; repeating <code>off</code> does not alter address settings.</p>
|
|
<p>For a custom address with stealth:</p>
|
|
<pre><code class="language-text">set bluetooth.mac C2:11:22:33:44:55
|
|
set bluetooth.stealth on
|
|
reboot
|
|
</code></pre>
|
|
<p>Use <code>set bluetooth.mac random</code> instead of the first line for one saved random
|
|
address. Both combinations keep their address and bond across later boots.
|
|
Rotating policies still rotate: <code>random-every-boot</code> reopens pairing at every
|
|
boot, while <code>random-after-connect</code> reopens it on the first boot after an
|
|
authenticated connection. Stealth stays enabled; each new address begins
|
|
with a fresh pairing window so it cannot get hidden behind an unusable bond.</p>
|
|
<p>With stealth on, the node is normally discoverable until the first authenticated pairing.
|
|
After that, nRF52 uses directed advertising to the saved peer. ESP32 uses a
|
|
minimal unnamed advertisement and a controller allowlist because its common
|
|
Arduino BLE API does not expose the directed-advertising peer field. Both
|
|
reject connection and scan requests from other peers. BLE cannot be completely
|
|
radio silent and still accept a connection, so a passive radio sniffer may
|
|
still observe packets. To deliberately clear the saved stealth peer, send
|
|
<code>set bluetooth.stealth off</code>, then <code>set bluetooth.stealth on</code>, then reboot over
|
|
USB or an existing authenticated connection. To leave stealth, set it <code>off</code>
|
|
and reboot. If the saved node-side bond is lost, recovery reopens pairing.
|
|
The former <code>set bluetooth.mac stealth</code> command is no longer accepted.</p>
|
|
<p>This changes only the running MeshCore Companion application. On nRF52, the
|
|
OTAFIX bootloader still uses its own address, which is visible only while the
|
|
board is in BLE DFU/recovery mode. USB and LoRa updates are unaffected.
|
|
Bluetooth update tools must follow that separate bootloader address after the
|
|
handoff; they must not assume that a custom application address remains the
|
|
DFU address. See the <a href="../hardware_validation_bluetooth_stealth_2026-09-07/">hardware observations</a>
|
|
for the tested XIAO handoff and host-cache caveats.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-latitude">View or change this node's latitude</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get lat</code>
|
|
- <code>set lat <degrees></code></p>
|
|
<p><strong>Set by build flag:</strong> <code>ADVERT_LAT</code></p>
|
|
<p><strong>Default:</strong> <code>0</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>degrees</code>: Latitude in degrees</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-longitude">View or change this node's longitude</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get lon</code>
|
|
- <code>set lon <degrees></code></p>
|
|
<p><strong>Set by build flag:</strong> <code>ADVERT_LON</code></p>
|
|
<p><strong>Default:</strong> <code>0</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>degrees</code>: Longitude in degrees</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-identity-private-key">View or change this node's identity (Private Key)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get prv.key</code>
|
|
- <code>set prv.key <private_key></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>private_key</code>: Private key in hex format (64 hex characters)</p>
|
|
<p><strong>Local connection only:</strong> <code>get prv.key</code>. Companion also requires
|
|
<code>ENABLE_PRIVATE_KEY_EXPORT=1</code>; use binary command <code>0x42</code> or the text terminal.
|
|
Infrastructure <code>set prv.key</code> retains its administrator access rules.</p>
|
|
<p><strong>Note:</strong> Requires reboot to take effect after setting</p>
|
|
<hr />
|
|
<p><a id="change-this-nodes-admin-password"></a></p>
|
|
<h4 id="view-or-change-this-nodes-admin-password">View or change this node's admin password</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get password</code>
|
|
- <code>password <new_password></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>new_password</code>: New admin password</p>
|
|
<p><strong>Set by build flag:</strong> <code>ADMIN_PASSWORD</code></p>
|
|
<p><strong>Default:</strong> <code>password</code></p>
|
|
<p><code>get password</code> returns the current admin password only on a local connection:
|
|
USB, Ethernet, or the authenticated LAN browser CLI. It is rejected over LoRa.
|
|
Companion has no local admin password and reports that explicitly, including
|
|
through binary command <code>0x42</code>; this command does not report the Bluetooth PIN.</p>
|
|
<p><strong>Note:</strong> The password setter replies with confirmation.</p>
|
|
<p><strong>Note:</strong> Any node using this password will be added to the admin ACL list.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-guest-password">View or change this node's guest password</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get guest.password</code>
|
|
- <code>set guest.password <password></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>password</code>: Guest password</p>
|
|
<p><strong>Set by build flag:</strong> <code>ROOM_PASSWORD</code> (Room Server only)</p>
|
|
<p><strong>Default:</strong> <code><blank></code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-owner-info">View or change this node's owner info</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get owner.info</code>
|
|
- <code>set owner.info <text></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>text</code>: Owner information text</p>
|
|
<p><strong>Default:</strong> <code><blank></code></p>
|
|
<p><strong>Note:</strong> <code>|</code> characters are translated to newlines</p>
|
|
<p><strong>Note:</strong> Requires firmware 1.12+</p>
|
|
<hr />
|
|
<h4 id="fine-tune-the-battery-reading">Fine-tune the battery reading</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get adc.multiplier</code>
|
|
- <code>set adc.multiplier <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: ADC multiplier (0.0-10.0)</p>
|
|
<p><strong>Default:</strong> <code>0.0</code> (value defined by board)</p>
|
|
<p><strong>Note:</strong> Returns "Error: unsupported by this board" if hardware doesn't support it</p>
|
|
<hr />
|
|
<h4 id="send-a-repeater-flood-text">Send a repeater flood text</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>send text.flood <message></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>message</code>: Text to send to the shared <code>#repeaters</code> flood channel, prefixed with this node's name. Any <code>:</code> in the node name is sent as <code>;</code> so the prefix delimiter stays unambiguous.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code>send text.flood checking ridge link
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-battery-alert-state">View or change battery alert state</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get battery.alert</code>
|
|
- <code>get battery.alert.region</code>
|
|
- <code>set battery.alert on [region]</code>
|
|
- <code>set battery.alert off</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>region</code>: Optional named region scope. When omitted, the repeater selects the single deepest (most narrow) named region in the configured hierarchy. If multiple regions tie for deepest, specify one explicitly.</p>
|
|
<p><strong>Defaults:</strong>
|
|
- <code>battery.alert</code>: <code>off</code>
|
|
- <code>battery.alert.region</code>: <code><unset></code></p>
|
|
<p><strong>Notes:</strong>
|
|
- Enabling fails until at least one usable named region is defined. Alerts are never sent as unscoped floods. If the selected region is later removed, alerts stop until battery alerts are enabled again with a valid region.
|
|
- Region hierarchy edits are not persistent until <code>region save</code> is run. After <code>region def west pnw wa w-wa sea</code>, run <code>region save</code> before enabling the alert if the hierarchy must survive a reboot.
|
|
- A region must have a usable transport key. Public named regions derive one automatically; a private region without an available key is rejected.
|
|
- The first alert is suppressed until the repeater has been up for at least 30 minutes. After that, the repeater checks every 30 minutes and sends low-battery warnings to the <code>#repeaters</code> channel in the selected region.
|
|
- Once an alert finishes transmitting, another battery alert is suppressed for at least 12 hours. A queue rejection, stale-queue drop, or radio send failure does not start the cooldown. Battery recovery or toggling alerts off and back on does not bypass a completed alert's cooldown during the same boot.
|
|
- With <code>region def west pnw wa w-wa sea</code>, <code>set battery.alert on</code> selects <code>sea</code>; <code>set battery.alert on w-wa</code> overrides that default.
|
|
- <code>get battery.alert.region</code> returns the selected scope, for example <code>> sea</code>.
|
|
- The battery check never requests a wake earlier than its 30-minute deadline. If the normal loop is already awake when that deadline has elapsed, the check is effectively free of an additional wake. Time in light/event sleep counts toward the startup delay, and a pending alert keeps the repeater awake until the packet is handled.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-battery-alert-thresholds">View or change battery alert thresholds</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get battery.alert.low</code>
|
|
- <code>set battery.alert.low <1-100></code>
|
|
- <code>get battery.alert.critical</code>
|
|
- <code>set battery.alert.critical <0-99></code></p>
|
|
<p><strong>Defaults:</strong>
|
|
- <code>battery.alert.low</code>: <code>20</code>
|
|
- <code>battery.alert.critical</code>: <code>10</code></p>
|
|
<p><strong>Note:</strong> The low threshold must be greater than the critical threshold. Alerts at or below the critical threshold use <code>CRITICAL BATTERY</code> in the message; both severities use the same 12-hour resend cooldown.</p>
|
|
<hr />
|
|
<h4 id="enable-or-disable-the-rx-inactivity-watchdog-repeater-only">Enable or disable the RX inactivity watchdog (Repeater Only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get rx.watchdog</code>
|
|
- <code>set rx.watchdog on</code>
|
|
- <code>set rx.watchdog off</code></p>
|
|
<p><strong>Default:</strong> <code>on</code>, with a 24-hour no-RX timeout in normal mode.</p>
|
|
<p><strong>Notes:</strong>
|
|
- In normal mode, the repeater reboots after 24 hours without a received packet passing MeshCore parsing. Each such reception restarts this timeout; checks use a sliding deadline rather than waiting for another 24-hour checkpoint.
|
|
- While <code>tempradio</code> or <code>tempradioat</code> is running, windows of at least 12 hours use a 12-hour no-RX timeout. Shorter windows disable this reboot watchdog for the duration of the session. This temporary policy also overrides a saved normal-mode <code>off</code> setting.
|
|
- Startup, a successful temporary-radio activation/replacement, expiry, cancellation, or manually changing this setting starts a fresh observation window. Expiry is processed before the watchdog, so a temporary window ending exactly at its watchdog deadline restores normal timing first.
|
|
- <code>get rx.watchdog</code> reports both the effective on/off state and timeout or short-session disabled reason. <code>set rx.watchdog on|off</code> saves the normal-mode preference; temporary-session rules remain active until that session ends. Existing saved preferences are retained when upgrading; the new default applies to fresh settings or older preference files without this field.
|
|
- The check uses the last successful MeshCore parse time, recorded before receive delays and routing filters. It does not require the packet to be addressed to this repeater or its encrypted payload to be decrypted; duplicate receptions also count. This checks MeshCore packet structure, not sender authentication.
|
|
- It does not poll, sample, or wake the radio or CPU. A due check waits for the next normal loop/wake. With RX power saving enabled, qualifying packets received during normal listening windows count as activity; the watchdog does not alter the RX/sleep timing.
|
|
- Transmitting, radio interrupts, and raw LoRa packets rejected by the MeshCore parser do not reset the timer. Packets dropped before parsing because the packet pool is full do not count either. This whole-board reboot setting is separate from the automatic radio-only recovery watchdog, which still measures successful raw radio reads.</p>
|
|
<hr />
|
|
<h4 id="enable-or-disable-the-nrf52-system-watchdog">Enable or disable the nRF52 system watchdog</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get system.watchdog</code>
|
|
- <code>set system.watchdog on</code>
|
|
- <code>set system.watchdog off</code></p>
|
|
<p><strong>Default:</strong> <code>on</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- This nRF52-only hardware watchdog resets the device if the application loop stops for 60 seconds, including an indefinite SoftDevice flash-write wait.
|
|
- Enabling takes effect without a reboot.
|
|
- The nRF52 hardware cannot stop a watchdog after it has started. Disabling is persisted immediately, then the current firmware stops feeding it so the board performs one watchdog restart within 60 seconds. It remains off after that restart.
|
|
- This setting is nRF52-only. The SoftDevice flash deadlock does not apply to ESP32, whose existing watchdog behavior is unchanged.</p>
|
|
<hr />
|
|
<h4 id="estimate-and-correct-infrastructure-node-time-after-startup">Estimate and correct infrastructure-node time after startup</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get clock.sync</code>
|
|
- <code>get clock.sync.status</code>
|
|
- <code>get clock.sync.status.table</code>
|
|
- <code>get clock.sync.status.<1-16></code>
|
|
- <code>get clock.sync.mesh</code>
|
|
- <code>set clock.sync.mesh <on|off></code>
|
|
- <code>get clock.sync.mesh.edge</code>
|
|
- <code>set clock.sync.mesh.edge <on|off></code>
|
|
- <code>clock.sync.mesh now</code>
|
|
- <code>get clock.sync.internet</code>
|
|
- <code>set clock.sync.internet <on|off></code>
|
|
- <code>get clock.sync.drift</code>
|
|
- <code>set clock.sync.drift <30-86400></code>
|
|
- <code>get clock.sync.samples</code>
|
|
- <code>set clock.sync.samples <3-16></code></p>
|
|
<p><strong>Defaults:</strong>
|
|
- <code>clock.sync.mesh</code>: <code>on</code> for all repeater, sensor, and room-server builds
|
|
- <code>clock.sync.mesh.edge</code>: <code>on</code>
|
|
- <code>clock.sync.internet</code>: <code>off</code>
|
|
- <code>clock.sync.drift</code>: <code>600</code> seconds (10 minutes)
|
|
- <code>clock.sync.samples</code>: <code>9</code></p>
|
|
<p>When either source is enabled, the node makes its first clock-bootstrap
|
|
attempt after 30 minutes of uptime, or immediately when the configured number
|
|
of fresh evidence sources has been collected, whichever comes first. A
|
|
successful estimate changes the RTC only when the absolute difference is
|
|
<strong>greater than</strong> <code>clock.sync.drift</code>; correction can move the clock forward or
|
|
backward. A valid estimate within the threshold counts as a successful sync
|
|
without changing the clock. Seven days after each successful estimate, the
|
|
node evaluates time again; the seven-day deadline therefore starts from the
|
|
last successful estimate rather than from boot. This is a lazy uptime deadline:
|
|
the check runs on the first normal loop/wake after it becomes due and does not
|
|
wake the device by itself. If no source or consensus is available, the node
|
|
retries every 30 minutes, and newly collected evidence triggers another
|
|
immediate evaluation once the configured source count is present. Every reboot
|
|
starts with the initial bootstrap attempt. An existing saved setting always
|
|
overrides the platform default.</p>
|
|
<p><code>clock.sync.mesh now</code> bypasses the startup/seven-day deadline and queues a
|
|
LoRa-only consensus evaluation on the next normal loop, even when the internet
|
|
source is also enabled. It uses any currently fresh samples without clearing the
|
|
16-slot table. If there is not yet enough evidence, mesh collection remains open
|
|
and the next attempt follows the normal 30-minute retry. The command requires
|
|
<code>clock.sync.mesh</code> to be on and does not bypass CLI, GPS, or NTP suppression; it
|
|
also retains the normal quorum, timestamp-validity, and drift checks.
|
|
The separate <code>clock</code> command only displays the current RTC and does not request
|
|
a synchronization attempt.</p>
|
|
<p><code>clock.sync.mesh</code> collects signature-verified advert timestamps and MAC-valid,
|
|
decrypted Public-channel plain-text timestamps. In normal path mode, collection
|
|
occurs only after the packet passes every forwarding filter. Sources are
|
|
deduplicated by advert public key or case-insensitive Public-channel display
|
|
name. Every fresh sample must also have a different full received path; all
|
|
direct, zero-hop receptions count as the same empty path. This prevents repeated
|
|
packets or multiple names arriving over one route from increasing the vote
|
|
count.</p>
|
|
<p>For a node at the edge of the network where every packet arrives through one
|
|
relay path, <code>set clock.sync.mesh.edge on</code> changes the evidence requirement from
|
|
distinct receive paths to distinct sources. Signature-verified adverts are
|
|
deduplicated by public key, and Public-channel timestamps are deduplicated by
|
|
case-insensitive display name. Repeated packets from one source still count
|
|
once. Edge mode observes this verified evidence on the receive path, independently
|
|
of the forwarding decision, so <code>repeat off</code> and forwarding filters do not prevent
|
|
clock collection. Other packet types are observed normally but cannot be clock
|
|
evidence because they do not provide a suitable authenticated Unix timestamp.
|
|
Changing edge mode clears the in-memory sample table so evidence collected under
|
|
the other policy is not reused. The setting is persistent and defaults on.</p>
|
|
<p>At least the configured number of distinct fresh evidence sources (nine by
|
|
default) and a strict majority of all fresh samples must fall within ten minutes
|
|
of the median. In normal mode each source must use a distinct receive path. In
|
|
edge mode signed adverts are distinct by public key and Public-channel messages
|
|
are distinct by display name, but all may use the same receive path. The
|
|
effective quorum is therefore the larger of
|
|
<code>clock.sync.samples</code> and half the fresh sample count plus one. For example, a
|
|
9-vs-7 split can succeed but an 8-vs-8 split cannot. The median is used.
|
|
<code>clock.sync.samples</code> accepts <code>3</code> through <code>16</code>; samples older than two hours are
|
|
ignored. Status reports <code>mode=paths</code> or <code>mode=edge</code> and labels the collected
|
|
evidence as <code>paths</code> or <code>sources</code>. It reports <code>reason=need-more-paths</code> or
|
|
<code>reason=need-more-sources</code> when fewer than the configured number exist, and
|
|
<code>reason=no-consensus</code> when enough evidence exists but the effective quorum does
|
|
not agree. Mesh collection begins immediately after boot. Following a
|
|
successful estimate, it resumes two hours before the next seven-day deadline so
|
|
only evidence that can still be fresh at evaluation time is processed.</p>
|
|
<p><code>get clock.sync.status</code> reports whether the clock was set and a <code>reason</code> when it
|
|
was not. Common reasons include <code>waiting-deadline</code>, <code>need-more-sources</code>,
|
|
<code>need-more-paths</code>, <code>no-consensus</code>, <code>within-drift</code>, <code>mesh-off</code>, and suppression
|
|
by CLI, GPS, or internet time. It also reports whether collection is active, the
|
|
fresh evidence count, the number of occupied table slots, and the next
|
|
evaluation deadline.</p>
|
|
<p><code>get clock.sync.status.table</code> shows the active sample table in compact form.
|
|
Each item is <code>slot:type:id-prefix:age</code>, where type <code>A</code> is a signed advert and
|
|
type <code>P</code> is a Public-channel message. A trailing <code>!</code> marks a stale sample. If
|
|
the compact reply is truncated, query any slot with
|
|
<code>get clock.sync.status.<1-16></code>. The detail view reports the full source and path
|
|
hashes, age-adjusted epoch, difference from the local clock, and freshness.</p>
|
|
<p>A timestamp is eligible for a clock-sync sample only when it falls between the
|
|
UTC build epoch embedded by <code>build.sh</code> and that time plus ten calendar years.
|
|
Direct developer builds that bypass <code>build.sh</code> fall back to the compiler
|
|
timestamp. Validation happens before a slot is selected or written, so an
|
|
advert or Public-channel timestamp outside that window is not recorded as a
|
|
clock sample.</p>
|
|
<p>Before voting, the node advances each packet timestamp by an estimated transit
|
|
time. The estimate sums the radio airtime at the original packet length and at
|
|
each progressively longer relay length, plus the expected midpoint of the
|
|
random flood-forward delay at every prior hop. The normal elapsed time since
|
|
the radio recorded local receipt is then added when consensus is evaluated, so
|
|
local signature/decryption/filter processing time is included too. This is
|
|
better than using hop count alone because LoRa airtime changes with packet
|
|
length and radio settings. Transit compensation is capped at the ten-minute
|
|
consensus window. It cannot know sender queueing, channel contention, or a
|
|
remote relay's non-matching <code>txdelay</code>, so the consensus window and median still
|
|
absorb residual error.</p>
|
|
<p>If a <code>clock sync</code> or <code>time <epoch></code> CLI command successfully sets the clock, or
|
|
a GPS provider writes a valid GPS time, LoRa-derived clock collection and
|
|
correction are suppressed for the rest of that boot. Turning
|
|
<code>clock.sync.mesh</code> off and back on does not clear this safety latch; only a
|
|
reboot does. <code>get clock.sync.mesh</code> and <code>get clock.sync.status</code> report whether
|
|
CLI or GPS time caused the suppression. On a WiFi MQTT build, a successful NTP
|
|
sync is authoritative and also suppresses LoRa correction for the rest of that
|
|
boot. Source selection starts fresh after a reboot, so LoRa remains the fallback
|
|
when NTP cannot obtain internet time during that boot.</p>
|
|
<p>Public-channel display names are not authenticated and can be spoofed. Received
|
|
path hashes are also truncated, unauthenticated routing hints; requiring unique
|
|
paths prevents ordinary duplicate-route inflation but is not a cryptographic
|
|
identity check. Signed adverts authenticate the advert contents but do not
|
|
prove that the advertising node's own clock is correct. Mesh time is therefore
|
|
a consensus estimate, not an authoritative time service. Edge mode intentionally
|
|
gives up receive-path diversity. Public-channel display names can be spoofed, so
|
|
one sender can claim multiple names and inflate the edge-mode vote count.</p>
|
|
<p><code>clock.sync.internet</code> is available on WiFi MQTT repeater-observer builds. Its
|
|
initial and seven-day queries run on the MQTT/WiFi task and are read-only until
|
|
the repeater applies the configured drift test. Failed queries retry after 30
|
|
minutes. On other infrastructure-node builds, the preference can be stored but
|
|
status reports that internet time is unavailable. MQTT builds retain their
|
|
existing startup NTP behavior required for MQTT/TLS/JWT operation; this setting
|
|
controls the additional delayed drift checks. Startup NTP is always preferred when it
|
|
succeeds, regardless of this setting.</p>
|
|
<p>Sensor and room-server builds support mesh clock consensus and report
|
|
<code>clock.sync.internet</code> as unavailable. Changing any <code>clock.sync.*</code> setting starts
|
|
a new attempt for the current boot.
|
|
Settings are persistent in <code>/clock_sync</code>; samples and schedule state are not.</p>
|
|
<p>A backward correction is intentionally allowed, but peers that already recorded
|
|
a later timestamp from this node may temporarily reject its lower timestamps as
|
|
replays until corrected time passes the previously observed value.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code class="language-text">set clock.sync.drift 600
|
|
set clock.sync.samples 3
|
|
set clock.sync.mesh on
|
|
set clock.sync.mesh.edge on
|
|
clock.sync.mesh now
|
|
get clock.sync.status
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-this-nodes-public-key">View this node's public key</h4>
|
|
<p><strong>Usage:</strong> <code>get public.key</code></p>
|
|
<hr />
|
|
<h4 id="view-this-nodes-firmware-version">View this node's firmware version</h4>
|
|
<p><strong>Usage:</strong> <code>ver</code></p>
|
|
<hr />
|
|
<h4 id="view-this-nodes-configured-role">View this node's configured role</h4>
|
|
<p><strong>Usage:</strong> <code>get role</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-power-saving-flag">View or change this node's power saving flag</h4>
|
|
<p><strong>Search terms:</strong> battery saver, device power saving, low power mode.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get powersaving</code>
|
|
- <code>set powersaving on</code>
|
|
- <code>set powersaving off</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: enable power saving
|
|
- <code>off</code>: disable power saving</p>
|
|
<p><strong>Default:</strong> <code>on</code> for fresh Cascade-profile builds and Companion firmware; <code>off</code> for other infrastructure profiles</p>
|
|
<p><strong>Note:</strong> <code>get powersaving</code>, <code>set powersaving on</code>, and <code>set powersaving off</code>
|
|
are shared by Companion and infrastructure. The saved preference controls
|
|
whether power saving is allowed; active USB, logging and network services may
|
|
keep the hardware awake. Actual sleep depends on the board.</p>
|
|
<p>For the <strong>1.17.1.5 G3 USB-disconnect report</strong>, use <code>set powersaving off</code> as the
|
|
workaround. The released ESP32 sleep code can lose native USB after two
|
|
minutes when the terminal is closed, even with a computer attached. The
|
|
source fix blocks ESP32 light sleep while a native USB host is attached or
|
|
live USB logging is enabled; ordinary CPU idle/yield remains available.
|
|
The G3 button also wakes the device for at least two minutes. See the
|
|
<a href="../releases/1.17.1.5/#g3-usb-disappearance-with-power-saving-enabled">G3 release note</a>
|
|
for verification steps and the distinction between the fix and the published
|
|
binaries.</p>
|
|
<p>Companion firmware defaults this setting to <code>on</code>. Full Companion accepts the command from its local USB terminal and exposes the same setting in WebConfig. On ESP32, it lowers the CPU clock to 80 MHz, enables idle yielding, and enables the configured GPS duty cycle. USB and each active wireless transport remain available; SenseCAP Indicator Full keeps only its selected BLE or infrastructure-WiFi secondary transport active. <code>set powersaving off</code> restores the board's normal CPU clock and disables the GPS duty cycle. This device setting is separate from LoRa RXPS (<code>radio.rxps</code>) and WiFi modem power save (<code>wifi.powersave</code>). Infrastructure uses the same commands; its hardware and active-service sleep guards determine when the node can sleep.</p>
|
|
<hr />
|
|
<h4 id="view-or-set-the-reboot-interval-repeater-and-room-server">View or set the reboot interval (Repeater and room server)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get reboot.interval</code>
|
|
- <code>set reboot.interval <hours></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>hours</code>: <code>0-255</code>; <code>0</code> disables scheduled reboots.</p>
|
|
<p><strong>Default:</strong> <code>0</code> (disabled)</p>
|
|
<hr />
|
|
<h4 id="control-an-exposed-gpio">Control an exposed GPIO</h4>
|
|
<p><strong>Availability:</strong> ESP32 Repeater, Room Server, Bridge, and Sensor firmware. Companion firmware does not expose these commands. On nRF52, the commands are enabled only for Sensor builds on the Heltec T096, ProMicro, RAK3401, and RAK4631. GPIO expanders are not supported.</p>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get gpio</code> - list the Arduino pin numbers this firmware build permits</li>
|
|
<li><code>get gpio state</code>, <code>get gpio states</code>, or <code>get gpio status</code> - list every available pin currently controlled by the user (anything not in <code>reset</code>)</li>
|
|
<li><code>get gpio state <pin></code> - show one pin's state; <code>states</code> and <code>status</code> are accepted here too</li>
|
|
<li><code>get gpio <pin></code> - show <code>on</code>, <code>off</code>, or <code>reset</code>, plus any pending timed transition</li>
|
|
<li><code>set gpio <pin> on</code></li>
|
|
<li><code>set gpio <pin> off</code></li>
|
|
<li><code>set gpio <pin> reset</code></li>
|
|
<li><code>set gpio <pin> <on|off> <duration> <on|off|reset></code></li>
|
|
</ul>
|
|
<p><strong>Examples:</strong></p>
|
|
<ul>
|
|
<li><code>set gpio 16 on 30 off</code> - drive GPIO16 high for 30 seconds, then drive it low</li>
|
|
<li><code>set gpio 16 on 5ms off</code> - drive GPIO16 high for 5 milliseconds, then drive it low</li>
|
|
<li><code>set gpio 16 off 5 reset</code> - drive GPIO16 low for 5 seconds, then return it to high impedance</li>
|
|
</ul>
|
|
<p>An integer duration has seconds as its default unit, so <code>5</code> means 5 seconds. Add <code>ms</code> for milliseconds (<code>5ms</code>); an explicit <code>s</code> suffix is also accepted (<code>5s</code>). The maximum duration is 24 hours (86,400 seconds or 86,400,000 milliseconds). <code>on</code> or <code>off</code> without a duration remains in that state until another command, reset, or reboot.</p>
|
|
<p><code>reset</code> changes the pin to an input with no pull resistor (high impedance). It does not reboot the node. It also cancels any pending timer for that pin. A new timed command for the same pin cancels and replaces the previous timer. GPIOs begin in <code>reset</code>; states and timers are not saved and are lost on reboot.</p>
|
|
<p>The immediate reply confirms the applied state and any pending transition. When a timed transition finishes, a command issued over the authenticated remote CLI receives a second report such as <code>> GPIO 16 timer complete: off</code>. Retries of the same authenticated timed command are recognized and do not restart its countdown.</p>
|
|
<p>The pin number is the Arduino pin number used by that target (the normal GPIO number on ESP32 and the board's <code>D</code>/pin index on nRF52). The available-pin list is build-specific. Radio, flash/PSRAM, USB, serial console, display, GPS, I2C, buttons, LEDs, battery measurement, power control, bridge, Ethernet, watchdog, and other pins claimed by the firmware are rejected. A pin must also be physically broken out on your board; <code>get gpio</code> cannot detect wiring or an attached peripheral that is not represented by the firmware configuration.</p>
|
|
<p><strong>Electrical warning:</strong> GPIOs use 3.3 V logic and have limited drive current. Do not power a relay, motor, solenoid, or other load directly from a GPIO. Use a suitable transistor, MOSFET, optocoupler, or driver with the required protection components.</p>
|
|
<hr />
|
|
<h3 id="routing">Routing</h3>
|
|
<h4 id="view-or-set-the-direct-path-override-for-the-current-remote-client">View or set the direct path override for the current remote client</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get outpath</code>
|
|
- <code>get outpath path</code>
|
|
- <code>set outpath <hop1_hex,hop2_hex,...></code>
|
|
- <code>set outpath path</code>
|
|
- <code>set outpath direct</code>
|
|
- <code>set outpath clear</code>
|
|
- <code>set outpath flood</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>hopN_hex</code>: Hop hash with <code>2</code>, <code>4</code>, or <code>6</code> hexadecimal characters. Every hop must use the same width.</p>
|
|
<p><strong>Notes:</strong>
|
|
- These commands require remote client context and update the caller's ACL entry.
|
|
- <code>get outpath path</code> reports the reciprocal <code>PAYLOAD_TYPE_PATH</code> received after
|
|
the caller's latest flood login without changing the selected output route.
|
|
Because that packet is asynchronous, an immediate query can report
|
|
<code>> path pending</code>; retry shortly. The observation window expires after one
|
|
minute, and the captured login path is not automatically selected.
|
|
- <code>set outpath path</code> copies that observed route to <code>outpath</code> and saves it. It
|
|
returns an error without changing <code>outpath</code> if no route was received.
|
|
- <code>direct</code> selects a zero-hop route for a directly reachable caller.
|
|
- <code>clear</code> forgets the override, replies <code>> outpath cleared</code>, and allows normal
|
|
path discovery to repopulate it.
|
|
- <code>flood</code> forces replies to use flood packets until the client logs in again.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-repeat-flag">View or change this node's repeat flag</h4>
|
|
<p><strong>Search terms:</strong> enable repeating, disable repeating, packet forwarding, stop relaying.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get repeat</code>
|
|
- <code>set repeat <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Default:</strong> <code>flood.channel.data on</code>; <code>flood.channel.data.hops h=all</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-advert-path-hash-size">View or change this node's advert path hash size</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get path.hash.mode</code>
|
|
- <code>set path.hash.mode <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Path hash size (0-2)
|
|
- <code>0</code>: 1 Byte hash size (256 unique ids)[64 max flood]
|
|
- <code>1</code>: 2 Byte hash size (65,536 unique ids)[32 max flood]
|
|
- <code>2</code>: 3 Byte hash size (16,777,216 unique ids)[21 max flood]
|
|
- <code>3</code>: DO NOT USE (Reserved) </p>
|
|
<p><strong>Default:</strong> <code>0</code></p>
|
|
<p><strong>Note:</strong> the 'path.hash.mode' sets the low-level ID/hash encoding size used when the repeater adverts. This setting has no impact on what packet ID/hash size this repeater forwards, all sizes should be forwarded on firmware >= 1.14. This feature was added in firmware 1.14</p>
|
|
<p><strong>Temporary Note:</strong> adverts with ID/hash sizes of 2 or 3 bytes may have limited flood propagation in your network while this feature is new as v1.13.0 firmware and older will drop packets with multibyte path ID/hashes as only 1-byte hashes are supported. Consider your install base of firmware >=1.14 has reached a criticality for effective network flooding before implementing higher ID/hash sizes. </p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-nodes-loop-detection">View or change this node's loop detection</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get loop.detect</code>
|
|
- <code>set loop.detect <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>:
|
|
- <code>off</code>: no loop detection is performed
|
|
- <code>minimal</code>: packets are dropped if repeater's ID/hash appears 4 or more times (1-byte), 2 or more (2-byte), 1 or more (3-byte)
|
|
- <code>moderate</code>: packets are dropped if repeater's ID/hash appears 2 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)
|
|
- <code>strict</code>: packets are dropped if repeater's ID/hash appears 1 or more times (1-byte), 1 or more (2-byte), 1 or more (3-byte)</p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<p><strong>Note:</strong> When it is enabled, repeaters will now reject flood packets which look like they are in a loop. This has been happening recently in some meshes when there is just a single 'bad' repeater firmware out there (probably some forked or custom firmware). If the payload is messed with, then forwarded, the same packet ends up causing a packet storm, repeated up to the max 64 hops. This feature was added in firmware 1.14</p>
|
|
<p><strong>Example:</strong> If preference is <code>loop.detect minimal</code>, and a 1-byte path size packet is received, the repeater will see if its own ID/hash is already in the path. If it's already encoded 4 times, it will reject the packet. If the packet uses 2-byte path size, and repeater's own ID/hash is already encoded 2 times, it rejects. If the packet uses 3-byte path size, and the repeater's own ID/hash is already encoded 1 time, it rejects. </p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-retransmit-delay-factor-for-flood-traffic">View or change the retransmit delay factor for flood traffic</h4>
|
|
<p><strong>Search terms:</strong> flood forwarding delay, flood retransmit delay, flood TX delay.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get txdelay</code>
|
|
- <code>set txdelay <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Transmit delay factor (0-2)</p>
|
|
<p><strong>Default:</strong> <code>0.5</code></p>
|
|
<p><strong>Note:</strong> When multiple nearby repeaters all hear the same flood packet, each waits a random amount of time before retransmitting to avoid simultaneous collisions. This factor scales the size of that random window. Higher values reduce collision risk at the cost of added latency. <code>0</code> disables the window entirely.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-retransmit-delay-factor-for-direct-traffic">View or change the retransmit delay factor for direct traffic</h4>
|
|
<p><strong>Search terms:</strong> direct forwarding delay, direct retransmit delay, direct TX delay.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.txdelay</code>
|
|
- <code>set direct.txdelay <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Direct transmit delay factor (0-2)</p>
|
|
<p><strong>Default:</strong> <code>0.2</code></p>
|
|
<p><strong>Note:</strong> Same collision-avoidance random window as <code>txdelay</code>, but applied to direct (non-flood, routed) traffic. The default is lower because direct packets are addressed to a specific next hop, so far fewer nodes compete to retransmit them.</p>
|
|
<hr />
|
|
<h4 id="experimental-view-or-change-the-processing-delay-for-received-traffic">[Experimental] View or change the processing delay for received traffic</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get rxdelay</code>
|
|
- <code>set rxdelay <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Receive delay base (0-20)</p>
|
|
<p><strong>Default:</strong> <code>0.0</code></p>
|
|
<p><strong>Note:</strong> When enabled, repeaters that received a flood packet with a weak signal are held in a delay queue before processing, while those that received it with a strong signal process it immediately. This gives strong-signal paths forwarding priority. By the time weak-signal nodes process their copy, the packet may have already propagated and will be suppressed as a duplicate, reducing redundant retransmissions.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-duty-cycle-limit">View or change the duty cycle limit</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get dutycycle</code>
|
|
- <code>set dutycycle <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Duty cycle percentage (1-100)</p>
|
|
<p><strong>Default:</strong> <code>50%</code> (equivalent to airtime factor 1.0)</p>
|
|
<p><strong>Examples:</strong>
|
|
- <code>set dutycycle 100</code> - no duty cycle limit
|
|
- <code>set dutycycle 50</code> - 50% duty cycle (default)
|
|
- <code>set dutycycle 10</code> - 10% duty cycle
|
|
- <code>set dutycycle 1</code> - 1% duty cycle (strictest EU requirement)</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> Added in firmware v1.15.0</p>
|
|
</blockquote>
|
|
<hr />
|
|
<h4 id="view-or-change-the-airtime-factor-duty-cycle-limit">View or change the airtime factor (duty cycle limit)</h4>
|
|
<blockquote>
|
|
<p><strong>Deprecated</strong> as of firmware v1.15.0. Use <a href="#view-or-change-the-duty-cycle-limit"><code>get/set dutycycle</code></a> instead.</p>
|
|
</blockquote>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get af</code>
|
|
- <code>set af <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Airtime factor (0-9). After each transmission, the repeater enforces a silent period of approximately the on-air transmission time multiplied by the value. This results in a long-term duty cycle of roughly 1 divided by (1 plus the value). For example:
|
|
- <code>af = 1</code> -> ~50% duty
|
|
- <code>af = 2</code> -> ~33% duty
|
|
- <code>af = 3</code> -> ~25% duty
|
|
- <code>af = 9</code> -> ~10% duty
|
|
You are responsible for choosing a value that is appropriate for your jurisdiction and channel plan (for example EU 868 Mhz 10% duty cycle regulation).</p>
|
|
<p><strong>Default:</strong> <code>1.0</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-local-interference-threshold">View or change the local interference threshold</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get int.thresh</code>
|
|
- <code>set int.thresh <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Interference threshold value</p>
|
|
<p><strong>Default:</strong> <code>0.0</code></p>
|
|
<hr />
|
|
<h4 id="enable-or-disable-hardware-channel-activity-detection-cad">Enable or disable hardware Channel Activity Detection (CAD)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get cad</code>
|
|
- <code>set cad <on|off></code></p>
|
|
<p><strong>Description:</strong> When enabled, the radio performs a hardware Channel Activity Detection scan before transmitting and defers if the channel is busy. Runs independently of <code>int.thresh</code> - either, both, or none may be active.</p>
|
|
<p>Fresh Cascade-profile builds default CAD to <code>off</code> across all roles, including
|
|
Companion. Saved CAD settings take precedence after an upgrade. Use <code>set cad off</code>
|
|
to disable it on an existing node or <code>set cad on</code> to enable it explicitly.
|
|
The repeater applies the saved toggle to the radio during its periodic
|
|
noise-floor service. With one runnable packet, a busy result uses the normal
|
|
CAD retry delay and allows roughly four seconds of continuous busy results.
|
|
As the runnable transmit queue grows, both delays are divided by its depth:
|
|
retry spacing will not fall below 50 ms and the busy ceiling will not fall
|
|
below 500 ms. Reaching the busy ceiling records a CAD-timeout error and
|
|
attempts the next queued transmission rather than waiting indefinitely.
|
|
Future-scheduled packets do not accelerate CAD. <code>get cad</code> includes the
|
|
hardware busy-result count.</p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on|off</code>: Enable or disable hardware CAD</p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-agc-reset-interval">View or change the AGC Reset Interval</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get agc.reset.interval</code>
|
|
- <code>set agc.reset.interval <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Interval in seconds rounded down to a multiple of 4 (17 becomes 16). 0 to disable.</p>
|
|
<p><strong>Default:</strong> <code>0.0</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-radio-watchdog-interval-mqtt-observer-only">View or change the radio watchdog interval (MQTT observer only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get radio.watchdog</code>
|
|
- <code>set radio.watchdog <minutes></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>minutes</code>: <code>0</code> to use the standard 30-minute soft recovery interval, or <code>1-120</code> minutes to override it</p>
|
|
<p><strong>Default:</strong> <code>5</code></p>
|
|
<p><strong>Note:</strong> This setting belongs to the MQTT observer runtime and is not
|
|
available on a standalone FULL repeater. It sets the interval without a
|
|
successfully received packet before soft radio recovery. Transmissions and
|
|
interrupts alone do not restart the timer. Setting it to <code>0</code> removes the
|
|
observer override; automatic radio recovery remains active. The normal hard
|
|
recovery threshold is 12 hours, where the radio supports it, and recovery does
|
|
not reboot the whole board. On quiet meshes, increasing the soft interval can
|
|
reduce unnecessary recoveries when no traffic is expected.</p>
|
|
<hr />
|
|
<h4 id="enable-or-disable-multi-acks-support">Enable or disable Multi-Acks support</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get multi.acks</code>
|
|
- <code>set multi.acks <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>0</code> (disable) or <code>1</code> (enable)</p>
|
|
<p><strong>Default:</strong> <code>0</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-flood-advert-interval">View or change the flood advert interval</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.advert.interval</code>
|
|
- <code>set flood.advert.interval <hours></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>hours</code>: Interval in hours (3-168)</p>
|
|
<p><strong>Default:</strong> <code>12</code> (Repeater) - <code>0</code> (Sensor)</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-zero-hop-advert-interval">View or change the zero-hop advert interval</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get advert.interval</code>
|
|
- <code>set advert.interval <minutes></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>minutes</code>: Interval in minutes rounded down to the nearest multiple of 2 (61 becomes 60) (60-240)</p>
|
|
<p><strong>Default:</strong> <code>0</code></p>
|
|
<hr />
|
|
<h4 id="limit-the-number-of-hops-for-a-flood-message">Limit the number of hops for a flood message</h4>
|
|
<p><strong>Search terms:</strong> hop limit, maximum hops, max hops, flood distance.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.max</code>
|
|
- <code>set flood.max <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Maximum flood hop count (0-64)</p>
|
|
<p><strong>Default:</strong> <code>64</code></p>
|
|
<hr />
|
|
<h4 id="limit-the-number-of-hops-for-an-unscoped-flood-message">Limit the number of hops for an unscoped flood message</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.max.unscoped</code>
|
|
- <code>set flood.max.unscoped <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Maximum flood hop count (0-64) for a packet without a scope (no region set)</p>
|
|
<p><strong>Default:</strong> <code>0xFF</code> - indicates it hasn't been set, will track flood.max until it is.</p>
|
|
<p><strong>Note:</strong> An alternative to <code>region denyf *</code>, setting <code>flood.max.unscoped</code> to a lower value such as <code>3</code> would allow for local unscoped messages to propagate, while preventing noisy neighbors from flooding a local region.</p>
|
|
<hr />
|
|
<h4 id="limit-the-number-of-hops-for-an-advert-flood-message">Limit the number of hops for an advert flood message</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.max.advert</code>
|
|
- <code>set flood.max.advert <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>value</code>: Maximum flood hop count (0-64) for an advert packet</p>
|
|
<p><strong>Default:</strong> <code>8</code></p>
|
|
<hr />
|
|
<h4 id="forward-flood-group-data-packets-on-repeaters">Forward flood group data packets on repeaters</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.channel.data</code>
|
|
- <code>get flood.channel.data.hops</code>
|
|
- <code>set flood.channel.data <on|off></code>
|
|
- <code>set flood.channel.data.hops <all|1-7></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: Retransmit received flood <code>GRP_DATA</code> channel packets.
|
|
- <code>off</code>: Do not retransmit received flood <code>GRP_DATA</code> channel packets.
|
|
- <code>all</code>: When <code>flood.channel.data</code> is <code>off</code>, block <code>GRP_DATA</code> at any received flood hop count.
|
|
- <code>1-7</code>: When <code>flood.channel.data</code> is <code>off</code>, repeat <code>GRP_DATA</code> at this hop count or lower and block longer paths.</p>
|
|
<p><strong>Default:</strong> <code>flood.channel.data on</code>; <code>flood.channel.data.hops h=all</code></p>
|
|
<p><strong>Forwarding behavior:</strong> Repeater firmware only. The repeater still receives and
|
|
logs the packet when logging is enabled; this only blocks retransmission.
|
|
On generalized repeaters these commands manage an ordinary visible FPF7
|
|
<code>type=grp_data</code> drop row. <code>off</code> with <code>all</code> maps to <code>hops=all</code>; <code>off</code> with <code>N</code>
|
|
maps to <code>hops=N+1+</code>. The 240 KB compact FPF6 profiles retain the legacy hard
|
|
gate. Because it is an ordinary FPF7 row, a matching higher-priority <code>stop</code>
|
|
rule can exempt traffic from it. The compact <code>get flood.filter</code> list marks the
|
|
managed row with <code>~data</code>. Flood group text (<code>GRP_TXT</code>) is unaffected by this
|
|
setting.</p>
|
|
<p><code>get flood.channel.data</code> includes the active hop gate as <code>h=all</code> or <code>h>N</code>.</p>
|
|
<hr />
|
|
<h4 id="block-selected-flood-channels-with-fpf7">Block selected flood channels with FPF7</h4>
|
|
<p>The separate <code>flood.channel.block</code> command and 15-row table have been retired.
|
|
Generalized repeaters use the 63-row FPF7 forward phase for authenticated channel
|
|
blocks:</p>
|
|
<pre><code class="language-text">set flood.rule type=any channel=#test hops=all drop
|
|
set flood.rule.2 type=any channel=#wardriving hops=5+ drop
|
|
set flood.rule type=any channel=9cd8fcf22a47333b591d96a2b848b73f hops=4+ drop
|
|
get flood.rule
|
|
del flood.rule.2
|
|
</code></pre>
|
|
<p><code>type=any</code> with a channel condition can authenticate only <code>GRP_TXT</code> and
|
|
<code>GRP_DATA</code>, so it does not match other payload types. Use <code>hops=all</code> to block
|
|
at every received hop count. To preserve the old <code>h=N</code> meaning of repeating
|
|
through <code>N</code> hops and blocking longer paths, use <code>hops=N+1+</code>; old <code>h=4</code> is
|
|
therefore <code>hops=5+</code>.</p>
|
|
<p>New generalized repeater tables seed slot 2 with the second example. Existing
|
|
FCB2 rows are imported once into free FPF7 slots and the retired file is then
|
|
removed. The fixed-size STM32WL FPF6 build cannot match authenticated channels.</p>
|
|
<hr />
|
|
<h4 id="force-a-transport-scope-onto-floods">Force a transport scope onto floods</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.channel.scope</code>
|
|
- <code>get flood.channel.scope.<n></code>
|
|
- <code>set flood.channel.scope <channel|txt:*|login:*|other:*> <region|scope=name> [path=blacklist|path=bucket:1-6] [tx=slow]</code>
|
|
- <code>set flood.channel.scope.<n> <channel|txt:*|login:*|other:*> <region|scope=name> [path=blacklist|path=bucket:1-6] [tx=slow]</code>
|
|
- <code>del flood.channel.scope.<n></code>
|
|
- <code>del flood.channel.scope all</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>n</code>: Slot number within the table compiled for the target. Roomy ESP32 builds
|
|
provide <code>1-255</code>; classic ESP32 repeaters and nRF52/other
|
|
normal constrained builds provide <code>1-31</code>; very-tight STM32WL repeaters provide
|
|
<code>1-15</code>; the no-PSRAM LilyGo T-LoRa V2.1 repeater/observer provides <code>1-4</code>.
|
|
- <code>channel</code>: <code>public</code>, a public <code>#channel</code>, or a 128/256-bit channel key in hex.
|
|
- <code>txt:*</code>: Unauthenticated fallback for otherwise-unmatched <code>GRP_TXT</code> and
|
|
<code>GRP_DATA</code>. Plain <code>*</code> is an alias for <code>txt:*</code>.
|
|
- <code>login:*</code>: Type-based wildcard for the remote-login/admin family: <code>REQ</code>,
|
|
<code>RESPONSE</code>, <code>TXT_MSG</code>, <code>ANON_REQ</code>, and <code>PATH</code> (<code>0x00</code>, <code>0x01</code>, <code>0x02</code>,
|
|
<code>0x07</code>, and <code>0x08</code>). It classifies the outer type; a transit repeater cannot
|
|
authenticate whether a packet is actually part of a login session.
|
|
- <code>other:*</code>: Type-based wildcard for every remaining flood payload type,
|
|
including flood-form TRACE, ACK, advert, multipart, control, OTA, reserved
|
|
types, and raw custom.
|
|
- <code>region</code>: Existing named region with a usable transport key. A unique region
|
|
name prefix is accepted; wildcard region <code>*</code> is not a scope target.
|
|
- <code>scope=<name></code>: Regionless alternative to <code>region</code>. The public name is
|
|
normalized with a leading <code>#</code>, and its 128-bit transport key is derived
|
|
directly from that hashtag exactly as for <code>flood.filter scope=<name></code>. It
|
|
does not need to exist in the region list. Public names up to 30 characters
|
|
are accepted; private <code>$</code> scopes are not.
|
|
- <code>path=blacklist</code>: Optional. Require the received path to match the passive
|
|
<code>flood.filter.blacklist</code> ID table. No <code>flood.filter</code> drop row needs to be
|
|
enabled. One exact listed ID qualifies a 3-byte path. A 2-byte path requires
|
|
two matching received path entries, while a 1-byte path never qualifies.
|
|
- <code>path=bucket:<1-6></code>: Optional alternative to <code>path=blacklist</code>. Match IDs in
|
|
the selected persistent <code>flood.retry.bucket</code>. Each bucket holds up to 17
|
|
three-byte IDs and remains usable when <code>flood.retry.bridge</code> is off. It uses
|
|
the same 3-byte, 2-byte, and 1-byte thresholds as <code>path=blacklist</code>.
|
|
<code>recent.repeater</code> freshness and <code>flood.retry.ignore</code> do not affect this
|
|
passive match.
|
|
- <code>tx=slow</code>: Optional. Use an effective inbound <code>rxdelay</code> base of
|
|
<code>max(2, configured rxdelay * 2)</code>, keep normal outbound queue priority, and
|
|
schedule retransmission with the maximum supported <code>txdelay</code> factor of
|
|
<code>2.0</code> after changing the scope. The default is fast; <code>tx=fast</code> may be
|
|
supplied explicitly when replacing a slow row.</p>
|
|
<p><strong>Default:</strong> No forced scopes.</p>
|
|
<p>Remote ACL permission <code>4</code> (region/scope manager) can use all <code>get</code>, <code>set</code>, and
|
|
<code>del flood.channel.scope</code> forms. Filter managers and other non-admin roles
|
|
cannot change this table.</p>
|
|
<p>Without <code>.n</code>, <code>set</code> updates the row for the same exact channel key or wildcard
|
|
class with the same path selector, otherwise it uses the first empty slot.
|
|
This permits an ordinary fallback and separate blacklist or bridge-bucket
|
|
rows for the same channel. With <code>.n</code>, it replaces that slot. The three
|
|
wildcard classes are independent and consume one slot each.
|
|
<code>get flood.channel.scope</code> reports active/total slot counts; use the numbered
|
|
form for row detail. Keyed rows are displayed by the first four bytes of their
|
|
derived channel hash because channel secrets are never returned. Regionless
|
|
targets are displayed with their normalized leading <code>#</code>.</p>
|
|
<p>This acts on received <code>ROUTE_TYPE_FLOOD</code> and
|
|
<code>ROUTE_TYPE_TRANSPORT_FLOOD</code> packets. An unscoped packet gains the configured
|
|
scope; an already-scoped packet has its existing transport codes replaced. For
|
|
<code>GRP_TXT</code> and <code>GRP_DATA</code>, all exact channel-key rows are tried first and must
|
|
validate the packet MAC/decryption. Matching path-qualified exact rows are
|
|
tried before ordinary exact fallback rows. A region-backed row whose target
|
|
is missing or unusable is skipped; later exact rows and then <code>txt:*</code> are tried.
|
|
Exact keyed rows with a usable target therefore beat <code>txt:*</code> regardless of
|
|
slot number. Within each wildcard class, path-qualified rows similarly precede
|
|
ordinary fallback rows. <code>login:*</code> and <code>other:*</code> select their non-overlapping
|
|
outer-type families without decrypting the payload. The lowest usable slot
|
|
wins within each priority tier.</p>
|
|
<p>Standard traceroute is direct-routed and is therefore outside this flood-only
|
|
table. A custom flood-form <code>TRACE</code> is treated like every other flood: an
|
|
applicable wildcard may rewrite it and region/unknown-code gates still apply.</p>
|
|
<p>On a match, the repeater sets the route to <code>ROUTE_TYPE_TRANSPORT_FLOOD</code>,
|
|
computes transport code 0 from the selected region or direct hashtag key and
|
|
packet payload, and sets transport code 1 to zero. This occurs before region
|
|
enforcement, forwarding filters, and the seen-packet lookup. For an
|
|
already-scoped packet, the selected code replaces both incoming transport-code
|
|
fields. Direct routes are never rewritten. A packet converted from unscoped is
|
|
no longer subject to <code>flood.max.unscoped</code>; all rewritten packets remain subject
|
|
to normal payload handling, <code>flood.max</code>, <code>flood.filter</code>,
|
|
loop detection, and moderation. Assigning a scope does
|
|
not make a packet type forwardable if the core would otherwise reject it. By
|
|
default, if the selected scope differs and the rewritten packet is accepted
|
|
for forwarding, its initial retransmission uses zero <code>txdelay</code> and the highest
|
|
outbound queue priority so the newly scoped copy can win at the next hop.
|
|
Adding <code>tx=slow</code> uses an effective inbound <code>rxdelay</code> base of
|
|
<code>max(2, configured rxdelay * 2)</code>, keeps the ordinary queue priority, and uses
|
|
the maximum <code>txdelay</code> factor of <code>2.0</code> for the retransmission. As with ordinary
|
|
<code>txdelay</code>, the actual transmit delay is randomized from zero through the
|
|
resulting window; factor <code>2.0</code> gives a maximum of ten packet airtimes.
|
|
Neither mode preempts an active radio transmission or bypasses CAD and
|
|
airtime-budget limits. Selecting the scope already carried by the packet is a
|
|
no-op and does not grant special transmit treatment.</p>
|
|
<p>A region-backed target must be locally flood-allowed and remains subject to
|
|
the normal region gate. A <code>scope=<name></code> target is trusted for this matched
|
|
receive pass even though it has no region-list entry, matching the behavior of
|
|
<code>flood.filter scope=<name></code>. It does not create a region, consume a region
|
|
slot, or change the allow/deny state for unrelated packets carrying the same
|
|
transport code.</p>
|
|
<p>If a region-backed row's target has been removed or has no usable key, the repeater
|
|
tries the next applicable row. For group packets this means later authenticated
|
|
exact rows followed by <code>txt:*</code>; wildcard duplicates likewise fall through to
|
|
the next usable slot. When no usable mapping exists, the packet retains its
|
|
original unscoped or scoped route.</p>
|
|
<p>LoRa OTA remains functional when <code>other:*</code> is configured. OTA packets are
|
|
given that target's transport code, replacing an existing code when necessary,
|
|
but the OTA handler still accepts and re-floods them during the temporary-radio
|
|
window. A region target must allow flooding; a direct target follows the
|
|
regionless trust behavior above. The OTA core itself is dormant outside that
|
|
window; no default flood filter row is needed for that behavior. Forced scope
|
|
does not make OTA operate outside the window.</p>
|
|
<p><strong>Capacity cost:</strong> Each rule slot retains its 36-byte runtime and persistent
|
|
record. A separate 32-byte-name table holds up to the smaller of the rule count
|
|
or 32 distinct regionless targets; very-tight STM32WL builds hold one reusable
|
|
direct target. Region-backed targets do not consume this table.
|
|
The four-slot minimum uses 272 bytes RAM and a 278-byte file; it has room for
|
|
the three wildcard classes plus one exact channel mapping. Very-tight 15-slot
|
|
builds use 572 bytes RAM and a 578-byte file. The 31-slot table uses 2,108
|
|
bytes RAM and a 2,114-byte file. Roomy ESP32 builds use 255 rule slots and 32
|
|
direct-target slots: 10,204 bytes RAM and a 10,210-byte file. Classic ESP32
|
|
LoRa-OTA builds that cannot afford the 255-rule table use 31 slots instead.
|
|
Both configured regions and regionless targets can be reused by any number of
|
|
rules.</p>
|
|
<p><strong>Duplicate behavior:</strong> Mesh dedup hashes payload type and payload bytes; it
|
|
does not hash route type, transport codes, or the ordinary flood path. Adding
|
|
a transport scope therefore does not create a new duplicate identity. If the
|
|
same payload later arrives scoped, unscoped, or through a different region, it
|
|
is still the same seen packet. <code>TRACE</code> is the exception only in that its
|
|
encoded <code>path_len</code> byte is also hashed.</p>
|
|
<p>While equivalent non-TRACE flood copies are waiting in <code>rxdelay</code>, the normal
|
|
receive-quality timing still selects the packet to process, but that winner
|
|
receives a scope from the queued scoped copies with the same dedupe identity. If the copies
|
|
carry different locally allowed scopes, the scope from the shortest received
|
|
path wins. Unknown and denied transport codes are not candidates and therefore
|
|
cannot overwrite an unscoped winner. With equal path lengths, the deeper child
|
|
region wins because it is narrower. A remaining tie keeps queue order. The
|
|
winner's own path, SNR reading, and scheduled time are not changed, and an
|
|
already-scoped winner may have its code replaced by the better queued scope.</p>
|
|
<p>The comparison is deferred until dequeue so each copy retains its original
|
|
scope and path for arbitration. It can only use copies still present in
|
|
<code>rxdelay</code>; it cannot replace a packet that already won the dedupe race.
|
|
Flood-form TRACE participates in this arbitration; direct traceroute does not
|
|
enter the flood queue.</p>
|
|
<p>A packet that matches a fast <code>flood.channel.scope</code> or <code>flood.filter scope=</code>
|
|
action and needs its scope changed bypasses the inbound <code>rxdelay</code> queue. A
|
|
<code>tx=slow</code> row remains in that queue with twice the configured base, floored at
|
|
<code>2.0</code>, and participates in normal queued-copy scope arbitration.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code class="language-text">region put west
|
|
region save
|
|
set flood.channel.scope #local west
|
|
set flood.channel.scope.2 txt:* west tx=slow
|
|
set flood.channel.scope.3 login:* west
|
|
set flood.channel.scope.4 other:* west
|
|
get flood.channel.scope
|
|
get flood.channel.scope.1
|
|
del flood.channel.scope.2
|
|
</code></pre>
|
|
<p>A regionless exact mapping needs no <code>region</code> command:</p>
|
|
<pre><code class="language-text">set flood.channel.scope #rgdata scope=BlackHole86
|
|
get flood.channel.scope
|
|
get flood.channel.scope.1
|
|
</code></pre>
|
|
<p>For example, if an authenticated <code>#rgdata</code> packet arrives carrying scope
|
|
<code>#usa</code>, that rule replaces <code>#usa</code> with <code>#BlackHole86</code> before forwarding. The
|
|
rule also assigns <code>#BlackHole86</code> when the packet is unscoped or carries any
|
|
other scope; it is a channel-to-target mapping, not an incoming-scope filter.</p>
|
|
<p>To use bridge bucket 1 to assign <code>east</code> to <code>public</code> packets whose received
|
|
3-byte path contains <code>7576FB</code>, while assigning <code>west</code> to every other
|
|
authenticated <code>public</code> packet:</p>
|
|
<pre><code class="language-text">set flood.retry.bucket 1 7576FB
|
|
set flood.channel.scope public west
|
|
set flood.channel.scope public east path=bucket:1
|
|
</code></pre>
|
|
<p>Additional 3-byte IDs may be added to bucket 1 later; any one exact hit
|
|
qualifies the <code>east</code> row. This use is passive and does not require
|
|
<code>flood.retry.bridge</code> to be enabled. The separate blacklist selector remains
|
|
available for tables shared with <code>flood.filter path=blacklist</code> rules.</p>
|
|
<hr />
|
|
<h4 id="require-valid-incoming-scopes-only-on-selected-channels">Require valid incoming scopes only on selected channels</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.channel.scope.require</code>
|
|
- <code>get flood.channel.scope.require.<n></code>
|
|
- <code>set flood.channel.scope.require <public|#channel|128/256-bit-key></code>
|
|
- <code>set flood.channel.scope.require.<n> <public|#channel|128/256-bit-key></code>
|
|
- <code>del flood.channel.scope.require.<n></code>
|
|
- <code>del flood.channel.scope.require all</code></p>
|
|
<p><strong>Default:</strong> Empty; normal global region enforcement remains active.</p>
|
|
<p>Once this table contains a row, received flood <code>GRP_TXT</code> and <code>GRP_DATA</code>
|
|
packets use selective region enforcement. A packet authenticating against a
|
|
listed channel key must already carry a transport scope matching a locally
|
|
flood-allowed region. Listed channels arriving unscoped, with an unknown code,
|
|
or with a denied region are not retransmitted. This tests the original
|
|
incoming scope before any <code>flood.channel.scope</code> or <code>flood.filter scope=</code>
|
|
rewrite. Those rewrite actions are skipped for a rejected listed channel, so
|
|
they cannot rescue it or grant special receive/transmit timing.</p>
|
|
<p>Other group channels bypass the region/unknown-code gate while the table is
|
|
active. They remain subject to every other forwarding control, including
|
|
<code>repeat</code>, <code>flood.max*</code>, packet filters, loop detection, payload
|
|
validation, and moderation. Non-channel flood payload types retain normal
|
|
global region enforcement.</p>
|
|
<p>Channel matching validates the packet MAC/decryption with the configured key;
|
|
the visible one-byte channel hash is only a prefilter. Public hashtag channels
|
|
use their derived public key. Without <code>.n</code>, setting an existing key updates it
|
|
and a new key uses the first empty slot. Numbered <code>set</code> replaces that slot.
|
|
<code>get ...<n></code> reports a four-byte derived prefix and key size without exposing
|
|
the key. The table uses the same build-dependent slot count as
|
|
<code>flood.channel.scope</code>.</p>
|
|
<p>Remote ACL permission <code>4</code> can manage this table. Deleting its final row
|
|
restores normal global region enforcement for group channels.</p>
|
|
<p><strong>Example:</strong></p>
|
|
<pre><code class="language-text">set flood.channel.scope.require #bot
|
|
get flood.channel.scope.require
|
|
get flood.channel.scope.require.1
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="change-persistent-flood-rules-in-the-field">Change persistent flood rules in the field</h4>
|
|
<p>For setup guidance, interactions with the existing forwarding controls, and
|
|
worked moderation examples, see <a href="../flood_filtering/">Flood Filtering and Moderation</a>.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.rule</code>
|
|
- <code>get flood.rule.<n></code>
|
|
- <code>set flood.rule[.<n>] type=<type> [hops=<range>] [channel=<channel>] [prefix=<path-prefix>] [in=<input-scope>] <drop|scope=<name>|region=<name>|rate=<N>/min|retry|stop> [priority=<0-255>] [tx=slow] [suspend=tempradio]</code>
|
|
- <code>del flood.rule.<n></code>
|
|
- <code>del flood.rule all</code>
|
|
- <code>get flood.filter</code>
|
|
- <code>get flood.filter.<n></code>
|
|
- <code>get flood.filter.blacklist</code>
|
|
- <code>get flood.filter.blacklist.<n></code>
|
|
- <code>set flood.filter.blacklist <ID[,ID...]></code>
|
|
- <code>set flood.filter.blacklist.<n> <ID[,ID...]></code>
|
|
- <code>del flood.filter.blacklist</code>
|
|
- <code>del flood.filter.blacklist.<n></code>
|
|
- <code>set flood.filter <type> [hops] [path=blacklist] [scope=<name>] [require=region] [tx=slow] [suspend=tempradio]</code>
|
|
- <code>set flood.filter.<n> <type> [hops] [path=blacklist] [scope=<name>] [require=region] [tx=slow] [suspend=tempradio]</code>
|
|
- <code>del flood.filter.<n></code>
|
|
- <code>del flood.filter all</code></p>
|
|
<p>The extended table is available on repeaters with the rule engine enabled and
|
|
on FULL-profile ESP32 room servers. A FULL room server exposes both
|
|
<code>flood.rule</code> and <code>flood.filter</code>, has 31 slots, and requires an administrator
|
|
for remote changes. It does not have the repeater's passive path blacklist, so
|
|
<code>flood.filter.blacklist*</code> and <code>path=blacklist</code> are repeater-only; use the
|
|
ordered <code>prefix=</code> match on a room server. Standard room-server profiles do not
|
|
compile this table.</p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>n</code>: Forward-rule slot in the build's compiled table (<code>1-63</code> on generalized
|
|
repeaters and <code>1-31</code> on FULL room servers; compact profiles may use fewer).
|
|
- <code>type</code>: Payload type name, full <code>PAYLOAD_TYPE_*</code> name, decimal value <code>0-15</code>,
|
|
hexadecimal value <code>0x00-0x0F</code>, or <code>any</code>.
|
|
- <code>hops</code>: Optional; omitted means <code>all</code>.
|
|
- <code>N</code>: Match only at received hop count <code>N</code>.
|
|
- <code>N+</code>: Match at received hop count <code>N</code> and higher.
|
|
- <code>N-M</code>: Match the inclusive received-hop range.
|
|
- <code>all</code>: Match every received hop count (<code>0-63</code>).
|
|
- <code>0+</code>, <code>all</code>, and an omitted hop expression are equivalent. The CLI displays
|
|
the saved range as <code>all</code>.
|
|
- <code>channel=*|public|#name|hash:XX|128-bit-key|256-bit-key</code>: Optional channel match.
|
|
<code>channel=*</code> means no channel condition at all, so the row matches everything
|
|
selected by <code>type=</code> (including all flood payload types with <code>type=any</code>). It
|
|
does not authenticate a packet. <code>public</code>, <code>#name</code>, and raw keys authenticate
|
|
one channel and therefore narrow the row to <code>GRP_TXT</code>/<code>GRP_DATA</code>.
|
|
<code>hash:XX</code> matches only the visible one-byte group-channel hash; <code>short:XX</code>
|
|
and a bare two-digit byte are accepted aliases and are displayed as
|
|
<code>hash:XX</code>. This form is deliberately unauthenticated. It can collide with
|
|
another channel once in 256 hash values, and a sender can choose the byte,
|
|
so use an exact channel name or key whenever it is available. In particular,
|
|
<code>channel=hash:11</code> does not mean Public: it matches Public plus every collision
|
|
or deliberately selected <code>0x11</code> value. <code>channel=public</code> performs the deeper
|
|
MAC/decrypt check with the Public channel key. That distinguishes an ordinary
|
|
<code>0x11</code> collision, but it is channel authentication rather than sender
|
|
authentication: the group MAC is two bytes and the Public key is shared.
|
|
- <code>prefix=<ID[,ID...]></code>: Optional ordered source-path prefix of one to three
|
|
pbyte IDs. IDs must all be 2, 4, or 6 hex characters, matching a packet's
|
|
1-, 2-, or 3-byte pbyte width. <code>path=<prefix></code> is an alias.
|
|
- <code>in=any|none|scoped|allowed|unknown|scope:<name>|region:<name></code>: Optional
|
|
condition on the original incoming scope, before any rule rewrites it.
|
|
<code>none</code> is an unscoped flood. <code>scope:name</code> is the exact public
|
|
hashtag-derived scope. <code>region:name</code> is an exact allowed region match.
|
|
- <code>drop</code>: Explicit drop action. The <code>flood.rule</code> form requires an explicit
|
|
action. For compatibility, a legacy <code>flood.filter</code> row with no rewrite,
|
|
rate, or stop action is treated as drop.
|
|
- <code>scope=<name></code>: Direct public-name scope rewrite. It derives a transport key
|
|
from the name and does not require a configured region. For example,
|
|
<code>scope=BlackHole86</code> is a regionless sink scope; <code>region=BlackHole86</code> would
|
|
instead require a real configured, flood-allowed region with that name.
|
|
- <code>region=<name></code>: Rewrite using an existing locally allowed region and one of
|
|
that region's transport keys.
|
|
- <code>rate=N/min</code>: Per-node, per-row fixed one-minute forwarding limit. It can be
|
|
the only action or accompany <code>scope=</code>/<code>region=</code>. Counters are charged only
|
|
for packets that pass all forwarding gates.
|
|
- <code>retry</code>, <code>retry=on</code>, <code>retry=allow</code>, or <code>action=retry</code>: Allow a matching
|
|
received flood packet to enter the configured flood-retry sequence. With no
|
|
active <code>retry</code> rows, retry eligibility remains backward compatible and is
|
|
controlled by the global retry settings. Once any active <code>retry</code> row exists,
|
|
the matching rows become a retry allow-list: a received flood must match at
|
|
least one surviving <code>retry</code> row. <code>flood.retry.bridge</code> still selects ordinary
|
|
or bridge-bucket completion for the allowed packet. This action can accompany
|
|
rewrite, rate, or stop, but not <code>drop</code>; compact syntax uses <code>f=r</code>.
|
|
- <code>priority=0-255</code>: Optional primary processing order. Higher values run first.
|
|
At the same numeric priority, authenticated channel matches run before raw
|
|
<code>hash:XX</code> matches, which run before <code>channel=*</code>; lower slot number breaks the
|
|
remaining tie. The default is <code>0</code>; <code>pri=</code> is an alias. An explicitly higher
|
|
numeric priority still overrides this automatic specificity ordering.
|
|
- <code>stop</code> or <code>action=stop</code>: Apply this matching row, then stop lower-order FPF7
|
|
rows from processing. It can stand alone or accompany drop, rewrite, or
|
|
rate. A stop-only row acts as an exception to lower-priority FPF7 rules.
|
|
If the same row uses <code>region=</code> and that configured region is missing, denied,
|
|
wildcard, or has no usable transport key, both the rewrite and its <code>stop</code>
|
|
are inert so lower-order safety rows still run. A direct <code>scope=</code> target does
|
|
not depend on region configuration.
|
|
- <code>suspend=tempradio</code>: Optional. Skip this row only while the temporary radio
|
|
is actually active.
|
|
- <code>require=region</code>: Legacy alias for <code>in=allowed</code>. Apply the row only if the
|
|
original incoming packet already passes this repeater's
|
|
region gate. An incoming transport scope must resolve to a locally allowed
|
|
region; an unscoped flood must be allowed by the wildcard region. The check
|
|
occurs before any scope rewrite during this receive pass.
|
|
- <code>tx=slow</code>: Optional and valid with <code>scope=</code> or <code>region=</code>. Use an effective inbound
|
|
<code>rxdelay</code> base of <code>max(2, configured rxdelay * 2)</code>, keep normal outbound
|
|
queue priority, and retransmit with the maximum supported <code>txdelay</code> factor
|
|
of <code>2.0</code>. Scope rows default to fast; <code>tx=fast</code> explicitly restores that
|
|
default when replacing a slow row.
|
|
- <code>path=blacklist</code>: Optional unordered path condition. The persistent blacklist
|
|
is repeater-only. It contains up to 255 unique 3-byte repeater IDs on ESP32
|
|
builds and 18 on other builds, each written as six hexadecimal digits. A
|
|
packet with 3-byte path hashes matches after one exact ID hit. A packet with
|
|
2-byte path hashes matches after two path entries match the first two bytes
|
|
of listed IDs. Packets with 1-byte path hashes never match this condition.
|
|
Each received path entry is counted at most once.</p>
|
|
<p>The payload names follow the <a href="https://docs.meshcore.io/packet_format/">MeshCore packet-format allocation</a>:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Value</th>
|
|
<th>Short name</th>
|
|
<th>Full name</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>0x00</code></td>
|
|
<td><code>req</code></td>
|
|
<td><code>PAYLOAD_TYPE_REQ</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x01</code></td>
|
|
<td><code>response</code></td>
|
|
<td><code>PAYLOAD_TYPE_RESPONSE</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x02</code></td>
|
|
<td><code>txt_msg</code></td>
|
|
<td><code>PAYLOAD_TYPE_TXT_MSG</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x03</code></td>
|
|
<td><code>ack</code></td>
|
|
<td><code>PAYLOAD_TYPE_ACK</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x04</code></td>
|
|
<td><code>advert</code></td>
|
|
<td><code>PAYLOAD_TYPE_ADVERT</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x05</code></td>
|
|
<td><code>grp_txt</code></td>
|
|
<td><code>PAYLOAD_TYPE_GRP_TXT</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x06</code></td>
|
|
<td><code>grp_data</code></td>
|
|
<td><code>PAYLOAD_TYPE_GRP_DATA</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x07</code></td>
|
|
<td><code>anon_req</code></td>
|
|
<td><code>PAYLOAD_TYPE_ANON_REQ</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x08</code></td>
|
|
<td><code>path</code></td>
|
|
<td><code>PAYLOAD_TYPE_PATH</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x09</code></td>
|
|
<td><code>trace</code></td>
|
|
<td><code>PAYLOAD_TYPE_TRACE</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0A</code></td>
|
|
<td><code>multipart</code></td>
|
|
<td><code>PAYLOAD_TYPE_MULTIPART</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0B</code></td>
|
|
<td><code>control</code></td>
|
|
<td><code>PAYLOAD_TYPE_CONTROL</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0C</code></td>
|
|
<td><code>ota</code></td>
|
|
<td><code>PAYLOAD_TYPE_OTA</code> (this fork's LoRa OTA extension; reserved upstream)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0D</code></td>
|
|
<td><code>13</code></td>
|
|
<td>reserved</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0E</code></td>
|
|
<td><code>14</code></td>
|
|
<td>reserved</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>0x0F</code></td>
|
|
<td><code>raw_custom</code></td>
|
|
<td><code>PAYLOAD_TYPE_RAW_CUSTOM</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Route scope:</strong> Rules are evaluated only for the two flood route values:
|
|
<code>ROUTE_TYPE_TRANSPORT_FLOOD</code> (<code>0x00</code>, flood plus transport codes) and
|
|
<code>ROUTE_TYPE_FLOOD</code> (<code>0x01</code>, unscoped flood). Direct routes <code>0x02</code> and <code>0x03</code>
|
|
are never affected.</p>
|
|
<p><strong>Behavior:</strong> Match fields within one row are ANDed. Every FPF7 row is matched
|
|
against the same immutable receive-time packet, before any rule changes its
|
|
scope. Matching rows are processed in descending <code>priority</code>. At equal numeric
|
|
priority, authenticated channel matches precede raw hashes, which precede an
|
|
unrestricted channel matcher; lower slot wins after that. The first matching
|
|
<code>stop</code> row is included and all lower-order FPF7 matches are discarded. A stop
|
|
cannot undo an earlier drop or
|
|
bypass hard forwarding gates or the other policy phases. A row with
|
|
<code>path=blacklist</code> must meet the path condition as well as its other conditions;
|
|
blacklist IDs can occur anywhere in the received path and their configured
|
|
order is irrelevant. In contrast, <code>prefix=</code> begins at the first received path
|
|
entry and preserves order. A matching drop row prevents retransmission. The
|
|
highest-order remaining matching scope/region row wins; matching drop and rate
|
|
rows remain independent and can still block the rewritten packet. Scope rewriting
|
|
happens before region enforcement and is trusted even
|
|
when its name is absent from the local region list. It does not bypass
|
|
<code>repeat</code>, <code>flood.max</code>, other drop rows, loop detection, or
|
|
moderation.</p>
|
|
<p>Retry selection uses that same ordered, stop-truncated match set. With at least
|
|
one active <code>retry</code> row, a received flood starts a retry sequence only when one
|
|
of those matching rows includes <code>retry</code>. This selector cannot override
|
|
<code>flood.retry.count</code>, path/type attempt caps, <code>flood.retry.advert</code>, disabled
|
|
forwarding, a drop decision, or any other hard forwarding gate. Locally
|
|
originated floods retain the normal global retry behavior.</p>
|
|
<p>With <code>require=region</code>, a failed check makes that scope row ineligible. It leaves
|
|
the packet unchanged and does not set the filter-scope trust bypass, so an
|
|
unknown or denied incoming region is rejected normally unless another
|
|
independent scope rule rewrites it. Later eligible filter scope rows may still
|
|
match.</p>
|
|
<p>By default, when a scope row will change the packet's transport codes, the
|
|
packet bypasses inbound <code>rxdelay</code>; its retransmission then uses zero <code>txdelay</code>
|
|
and the highest outbound queue priority. With <code>tx=slow</code>, the rewrite instead
|
|
uses an effective inbound <code>rxdelay</code> base of
|
|
<code>max(2, configured rxdelay * 2)</code>, normal queue priority, and the maximum
|
|
<code>txdelay</code> factor of <code>2.0</code>. The actual randomized transmit wait ranges from zero
|
|
to ten packet airtimes. Selecting the scope already carried is a no-op and
|
|
does not grant special treatment. An active radio transmission is not
|
|
preempted, and CAD and airtime-budget limits still apply.</p>
|
|
<p>The packet is still received and can still be logged. Rules are persistent
|
|
data and can be changed over serial or authenticated remote CLI without an OTA
|
|
or reboot. <code>flood.rule</code> and <code>flood.filter</code> address the same table on extended
|
|
builds; FPF6 files are migrated in memory and the next save writes FPF7.
|
|
FPF1-FPF5 files are rejected and filtering fails open. FPF7 stores canonical
|
|
region names rather than transient numeric region
|
|
IDs. Removing, reordering, or reusing a region ID therefore cannot silently
|
|
retarget a rule. If a saved input or target region name is absent, that input
|
|
match or rewrite is inert; restoring the same region name reactivates it.
|
|
While the temporary radio is active, only rows explicitly marked
|
|
<code>suspend=tempradio</code> are skipped. <code>tempradio</code> is a radio state, not an OTA mode;
|
|
normal payload types can also use the temporary channel. Other rows remain in
|
|
force. A malformed persisted table fails open (no general rules are applied).</p>
|
|
<p>Within one receive evaluation, rows that use the same channel key share one
|
|
authentication result. The cache is discarded after that packet and stores
|
|
neither plaintext nor passwords; different keys are authenticated separately.
|
|
Raw <code>hash:XX</code> rows skip this authentication and compare only the one visible
|
|
byte.</p>
|
|
<p><strong>Per-channel retry examples:</strong></p>
|
|
<pre><code class="language-text"># Use bridge-bucket retry only for authenticated Public and #hamradio traffic.
|
|
set flood.retry.bridge on
|
|
set flood.rule.2 type=any channel=public retry
|
|
set flood.rule.3 type=any channel=#hamradio retry
|
|
|
|
# If the channel key/name is unavailable, select visible channel hash A7.
|
|
# This is an unauthenticated 1-byte hint, not a channel identity.
|
|
set flood.rule.4 type=any channel=hash:A7 retry
|
|
</code></pre>
|
|
<p>Because Public's visible hash is <code>0x11</code>, a bare <code>hash:11 drop</code> row also matches
|
|
Public. To exempt authenticated Public while dropping other packets that carry
|
|
the same visible byte, put the exact Public rule first and stop lower-priority
|
|
rules after it:</p>
|
|
<pre><code class="language-text"># Retry and preserve authenticated Public; drop other channel-hash 11 packets.
|
|
set flood.rule.2 type=any channel=public retry stop
|
|
set flood.rule.3 type=any channel=hash:11 drop
|
|
</code></pre>
|
|
<p>The Public row matches only after its MAC/decrypt check succeeds. A colliding
|
|
channel therefore misses that <code>stop</code> and reaches the raw-hash drop row. Both
|
|
rows use the default numeric priority, but authenticated-channel specificity
|
|
automatically orders Public first even if its slot number is higher. Without
|
|
<code>stop</code>, both rows match Public and the sticky <code>drop</code> action wins. Omit <code>retry</code>
|
|
from the Public row when only the forwarding exemption is wanted. An operator
|
|
can deliberately reverse this order by assigning the hash row a higher numeric
|
|
<code>priority</code>.</p>
|
|
<p>Deleting or replacing the last active <code>retry</code> row restores the legacy global
|
|
retry eligibility. Firmware that predates the <code>retry</code>/<code>hash:XX</code> FPF7 extension
|
|
cannot preserve tables containing those rows; remove them before downgrading.</p>
|
|
<p><strong>Default row:</strong> Repeater firmware and FULL ESP32 room-server firmware seed a
|
|
new flood-filter table with
|
|
<code>ota all suspend=tempradio</code> in slot 1. This blocks repeated LoRa OTA (<code>0x0C</code>)
|
|
floods at every received hop unless temporary radio is actually active. The OTA
|
|
core independently refuses OTA receive, relay, and transmit outside temporary
|
|
radio. The row is editable and deletable; once the table is saved, deletion is
|
|
persistent. Restore the exact seeded row with:</p>
|
|
<pre><code class="language-text">set flood.filter.1 0x0C all suspend=tempradio
|
|
</code></pre>
|
|
<p>Omitting <code>all</code> is equivalent. Omit <code>.1</code> as well to reuse an identical rule or
|
|
the first empty slot instead of replacing slot 1.</p>
|
|
<p><strong>Remote-admin lockout warning:</strong> There are no hidden payload-type or short-hop
|
|
exceptions. FPF7 drop and rate rows may block <code>req</code>, <code>response</code>, <code>txt_msg</code>,
|
|
<code>anon_req</code>, <code>path</code>, ACK, and multipart traffic beginning at hop <code>0</code> when their
|
|
match fields say so. Transit repeaters cannot decrypt these outer types to
|
|
distinguish an admin exchange from ordinary peer traffic. Keep a serial or
|
|
other recovery path and stage broad deny/rate rules carefully.</p>
|
|
<p>Without <code>.n</code>, <code>set</code> reuses an identical rule or uses the first empty slot. With
|
|
<code>.n</code>, it replaces that slot, which is the intended way to change a row's match
|
|
or action.
|
|
<code>get flood.filter</code> or <code>get flood.rule</code> gives a compact list. Use the numbered
|
|
form for full details, including channel, prefix, original-scope condition,
|
|
action, timing, rate, and temporary-radio suspension.</p>
|
|
<p>If all of those fields plus long names would exceed one CLI reply, the
|
|
numbered form automatically switches to a non-truncating compact spelling.
|
|
The compact aliases are also accepted by <code>set</code>: <code>c=</code> means <code>channel=</code>, <code>p=</code>
|
|
means <code>prefix=</code>, <code>i=*|n|s|a|u|s:<scope>|r:<region></code> means the corresponding
|
|
<code>in=</code> condition, <code>q=N</code> means <code>rate=N/min</code>, <code>pri=N</code> means priority, and <code>f=str</code>
|
|
combines slow timing (<code>s</code>), temporary-radio suspension (<code>t</code>), and retry
|
|
allowance (<code>r</code>). Packet type is shown numerically
|
|
in that fallback. Normal-sized rows keep the descriptive spelling above.</p>
|
|
<p>On generalized repeaters, filter rows, scope-rewrite rows, the shared
|
|
blacklist, and <code>flood.channel.data</code> compatibility state are committed in one
|
|
atomic FPF7 image. Compact FPF6 profiles retain separate files. Replacing or deleting
|
|
the blacklist does not delete rows containing <code>path=blacklist</code>; such rows
|
|
remain dormant while the list is empty. Path hashes are truncated routing
|
|
identifiers, not authenticated identities, so this is a forwarding signal
|
|
rather than proof that a particular repeater handled a packet.</p>
|
|
<p>A common use is containment of bulk internet-to-mesh dumping: list the path
|
|
IDs associated with the offending gateways, then add a broad
|
|
<code>type=any hops=all path=blacklist drop</code> row. This prevents this repeater from
|
|
retransmitting matching floods; it does not delete them from local logs or
|
|
prove who originated them.</p>
|
|
<p>The unnumbered blacklist <code>set</code> replaces the whole list and accepts up to 18 IDs
|
|
so it fits every CLI transport. Numbered <code>set</code> writes up to 18 consecutive
|
|
entries beginning at an existing slot or exactly the next slot, allowing an
|
|
ESP32 list to grow to 255 entries in batches. Numbered deletion compacts
|
|
subsequent slots. The unnumbered <code>get</code> reports the total and as many leading
|
|
IDs as fit in one reply; use numbered <code>get</code> to inspect entries beyond that
|
|
reply.</p>
|
|
<p>Standard traceroute is direct-routed and therefore outside <code>flood.filter</code>
|
|
entirely. A custom flood-form trace participates normally: <code>type=any</code>, explicit
|
|
<code>trace</code>, rewrite, rate, drop, and stop rows can all apply.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code class="language-text">set flood.rule.2 type=grp_data hops=4+ channel=#rgdata in=none scope=BlackHole86
|
|
set flood.rule.3 type=grp_data channel=#rgdata in=scope:usa scope=BlackHole86
|
|
set flood.rule.4 type=any prefix=860C rate=10/min
|
|
set flood.rule.5 type=grp_data hops=0-2 channel=#rgdata priority=200 stop
|
|
get flood.rule.2
|
|
set flood.filter grp_data 4+
|
|
set flood.filter.2 PAYLOAD_TYPE_ADVERT 6+
|
|
set flood.filter ota 2-4
|
|
set flood.filter.1 0x0C all suspend=tempradio
|
|
set flood.filter grp_data all suspend=tempradio
|
|
set flood.filter grp_txt all scope=local
|
|
set flood.filter grp_data all scope=local require=region
|
|
set flood.filter grp_data all path=blacklist scope=local tx=slow
|
|
set flood.filter.blacklist A1B2C3,D4E5F6,112233
|
|
set flood.filter.blacklist.4 445566
|
|
set flood.filter.blacklist.19 778899,AABBCC,DDEEFF
|
|
set flood.filter any all path=blacklist
|
|
get flood.filter.blacklist
|
|
get flood.filter.blacklist.4
|
|
set flood.filter any 12+
|
|
get flood.filter
|
|
get flood.filter.2
|
|
del flood.filter.2
|
|
</code></pre>
|
|
<p>The first rule authenticates <code>#rgdata</code>, requires more than three received hops,
|
|
and adds <code>#BlackHole86</code> only when no scope was present. The second rewrites the
|
|
exact incoming <code>#usa</code> scope. The third demonstrates a two-byte pbyte source
|
|
prefix and a global per-row rate cap. The fourth authenticates <code>#rgdata</code> at
|
|
zero through two hops, applies no FPF7 action of its own, and stops lower-order
|
|
FPF7 forward rows; hard gates and the rewrite/moderation phases still apply.</p>
|
|
<p>The fixed 240 KB STM32WL profiles leave
|
|
<code>MESH_ENABLE_FLOOD_RULE_ENGINE=0</code> and retain the compact, persistent FPF6
|
|
<code>flood.filter</code> and blacklist commands. They still filter floods, but do not
|
|
expose the <code>flood.rule</code> alias or its extended channel, prefix, input-scope,
|
|
region-action, or rate fields. No partition size changes are required.</p>
|
|
<hr />
|
|
<h4 id="moderate-flood-group-text-by-channel-sender-and-source-path">Moderate flood group text by channel, sender, and source path</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.moderation</code>
|
|
- <code>get flood.moderation.<n></code>
|
|
- <code>set flood.moderation <channel> <sender> <action> [action...]</code>
|
|
- <code>set flood.moderation.<n> <channel> <sender> <action> [action...]</code>
|
|
- <code>del flood.moderation.<n></code>
|
|
- <code>del flood.moderation all</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>n</code>: Moderation slot from <code>1</code> to <code>16</code>.
|
|
- <code>channel</code>:
|
|
- <code>public</code>: Built-in Public channel.
|
|
- <code>#channel</code>: Derive the well-known hashtag-channel key.
|
|
- A 128-bit or 256-bit channel key in hex, for any other/private channel.
|
|
- <code>sender</code>: Exact group-text display name. Matching is ASCII case-insensitive.
|
|
Quote names containing spaces, for example <code>"Field User"</code>.
|
|
- <code>drop</code>: Do not forward matching messages. Equivalent to <code>rate=0/min</code>.
|
|
- <code>rate=X/min</code>: Forward at most <code>X</code> matching messages per 60-second local
|
|
window. This option requires an exact sender rather than <code>*</code>.
|
|
- <code>hops=N</code>: Do not forward a matching message whose received flood path count
|
|
is <code>N</code> or higher. <code>hops=all</code> removes this constraint.
|
|
- <code>path=H1[,H2,H3]</code>: Match the start of the flood path. One to three hashes are
|
|
accepted; every hash must have the same 1-, 2-, or 3-byte width.
|
|
- <code>path=*</code>: Match any source path (the default).</p>
|
|
<p>At least one of <code>drop</code>, <code>rate=X/min</code>, or <code>hops=N</code> is required. Rate and hop
|
|
limits can be combined. Rate counters are local to this repeater and rule, use a
|
|
60-second window beginning with the first matching message, and reset on reboot.</p>
|
|
<p><strong>Decode and identity behavior:</strong> Moderation applies only to flood
|
|
<code>PAYLOAD_TYPE_GRP_TXT</code>. The repeater first checks the packet's channel-hash byte,
|
|
then validates and decrypts with the configured key. It extracts the text before
|
|
the first <code>:</code> from the standard <code><sender>: <message></code> plaintext. The channel key
|
|
is stored locally but is never printed by <code>get</code>.</p>
|
|
<p>The group-text sender is an <strong>unverified display name</strong>, not a public key. It can
|
|
be spoofed. Combining it with the first one to three path hashes makes a more
|
|
useful moderation signal, but path hashes are truncated and are not proof of the
|
|
originating user. A path-qualified rule begins matching only after the packet
|
|
contains all configured starting hops; it cannot identify a first hop on a
|
|
zero-hop packet.</p>
|
|
<p>As with general filtering, matching messages are still received/logged; only
|
|
retransmission is denied. There are no moderation rules by default.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code class="language-text">set flood.moderation public "Noisy User" rate=5/min
|
|
set flood.moderation #local bot drop path=A1B2C3,D4E5F6
|
|
set flood.moderation.3 00112233445566778899AABBCCDDEEFF alice rate=10/min hops=4 path=71CE82
|
|
get flood.moderation
|
|
get flood.moderation.3
|
|
del flood.moderation.3
|
|
</code></pre>
|
|
<hr />
|
|
<h3 id="acl">ACL</h3>
|
|
<h4 id="add-update-or-remove-permissions-for-a-companion">Add, update or remove permissions for a companion</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>setperm <pubkey> <permissions></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>pubkey</code>: Companion public key
|
|
- <code>permissions</code>:
|
|
- <code>0</code>: Guest
|
|
- <code>1</code>: Read-only
|
|
- <code>2</code>: Read-write
|
|
- <code>3</code>: Admin
|
|
- <code>4</code>: Region/scope manager (repeater delegated region and forced-scope management)
|
|
- <code>5</code>: Filter manager (repeater delegated forwarding-filter management)</p>
|
|
<p><strong>Filter manager scope:</strong> Permission <code>5</code> can use an explicit allowlist of
|
|
non-secret operational/filter status commands and can change the forwarding
|
|
controls <code>repeat</code>, <code>loop.detect</code>, <code>flood.max*</code>, <code>flood.channel.data*</code>,
|
|
<code>flood.filter*</code>, <code>flood.rule*</code>, and
|
|
<code>flood.moderation*</code>. It cannot read
|
|
guest, WiFi, MQTT, bridge, or other credentials, and it cannot change regions,
|
|
ACL entries, radio settings, or other admin configuration. Permission <code>4</code>
|
|
is limited to region commands, <code>flood.channel.scope*</code>, and the same non-secret
|
|
status allowlist.
|
|
Both delegated manager roles are protected from least-recently-active ACL
|
|
eviction like administrators.</p>
|
|
<p><strong>Note:</strong> Removes the entry when <code>permissions</code> is omitted</p>
|
|
<hr />
|
|
<h4 id="view-the-current-acl">View the current ACL</h4>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get acl</code> - full listing locally; first page over LoRa</li>
|
|
<li><code>get acl <page></code> - a numbered page, starting at 1, locally or over LoRa</li>
|
|
</ul>
|
|
<p>Available on repeaters, room servers, and sensors. Over LoRa, an authenticated
|
|
admin session is required; guests, read-only/read-write clients, and delegated
|
|
region/filter managers cannot read the ACL.</p>
|
|
<p>Each page starts with <code>ACL <page>/<pages></code> and contains up to two entries.
|
|
Each entry is a two-digit hexadecimal permission byte followed by the full
|
|
64-character public key. For example, use <code>get acl 2</code> for the second page.
|
|
An empty list returns <code>ACL: empty</code>. Deleted/guest entries with permission byte
|
|
<code>00</code> are omitted, matching the local listing. Pages reflect the current live
|
|
ACL, so entries can move between pages if permissions or clients change.</p>
|
|
<p>Bare <code>get acl</code> keeps the full streamed listing on USB and direct network CLI,
|
|
or via Companion binary command <code>0x42</code> where the role supports the command.
|
|
The listing contains public keys and permissions, not passwords or shared
|
|
secrets, and does not change the ACL.</p>
|
|
<hr />
|
|
<h4 id="recover-a-repeaters-future-dated-replay-timestamp">Recover a repeater's future-dated replay timestamp</h4>
|
|
<p>This is an explicit recovery operation after correcting a bad clock, not a
|
|
contact deletion. It lowers selected replay timestamps to the repeater's
|
|
current UTC epoch only when they are later than that epoch. Earlier values,
|
|
public keys, permissions, stored paths, and historical identity records remain.
|
|
The replay file is committed before the live table changes. No extra 60-second
|
|
login reservation is added by this command.</p>
|
|
<p>First set/synchronize and verify the repeater's clock (<code>clock</code>); a build-default
|
|
clock without a manual or observed synchronization is not accepted. Also fix
|
|
the companion's clock before its next login.</p>
|
|
<p>USB console:</p>
|
|
<pre><code class="language-text">replay reset <full-64-hex-public-key>
|
|
replay reset all CONFIRM
|
|
</code></pre>
|
|
<p>Authenticated LoRa admin, including a resumed admin session:</p>
|
|
<pre><code class="language-text">replay reset <full-64-hex-public-key>
|
|
</code></pre>
|
|
<p>The reply shows <code>now=<epoch></code>, <code>ttl=<remaining-seconds>s</code>, and a confirmation command containing the same
|
|
full key and a one-use 32-hex-character token. Verify the displayed time and send
|
|
that command before the original 300-second deadline. During the first 120
|
|
seconds, repeated requests for the same key by the same admin return the same
|
|
token without restarting either timer. From 120 through 300 seconds, the token
|
|
is retained for confirmation only: requests do not resend or replace it. This
|
|
leaves at least 180 seconds to deliver a confirmation after the last permitted
|
|
token response is generated (radio transit time still counts toward expiry).
|
|
At 300 seconds it expires and a new request can receive a new token. Confirmation
|
|
can succeed immediately; there is no requirement to wait for the resend window
|
|
to close. The displayed TTL decreases on retries and is measured when the reply
|
|
is generated, not when it reaches the companion.</p>
|
|
<p>It can target the caller's own key or another
|
|
exact key; prefixes, <code>self</code>, wildcards, and <code>all</code> are not allowed over LoRa.
|
|
Tokens are bound to both the requesting admin and target, expire on reboot,
|
|
and are invalid after use or a clock correction outside the five-second
|
|
confirmation tolerance. A failed write requires a new confirmation. Challenge
|
|
requests consult live token state instead of replaying cached challenge text;
|
|
completed confirmation results remain cacheable without executing the reset
|
|
again. Normal packet freshness checks still apply to retries.</p>
|
|
<p>Only the physical serial console grants <code>all</code> access. Ethernet, browser and
|
|
internal command callbacks do not count as USB. Guest, read-only, region-manager
|
|
and filter-manager roles cannot reset replay state. This command is implemented
|
|
in repeater firmware; room-server and sensor CLI are unchanged.</p>
|
|
<p>Normal login and command admission checks remain in force: a fully locked-out
|
|
caller that cannot send an accepted admin command needs another working admin
|
|
or USB access. A corrupt/unreadable replay file fails closed and is not erased
|
|
or formatted by this operation. Unknown keys do not create records.</p>
|
|
<p>Security trade-off: lowering a replay boundary can admit previously captured
|
|
future-dated login/command packets above the new boundary, including packets
|
|
that could raise it again. The one-use token prevents the recovery command
|
|
itself from being repeatedly executed; it does not replace the protocol's
|
|
timestamp-based replay protection. Use recovery only after verifying clocks.
|
|
Setting a clock alone never automatically resets this table.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-this-room-servers-read-only-flag">View or change this room server's 'read-only' flag</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get allow.read.only</code>
|
|
- <code>set allow.read.only <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code> (enable) or <code>off</code> (disable)</p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<hr />
|
|
<h3 id="region-management-v110">Region Management (v1.10.+)</h3>
|
|
<h4 id="bulk-load-region-lists">Bulk-load region lists</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region load</code>
|
|
- <code>region load <name> [flood_flag]</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: A name of a region. <code>*</code> represents the wildcard region</p>
|
|
<p><strong>Note:</strong> <code>flood_flag</code>: Optional <code>F</code> to allow flooding</p>
|
|
<p><strong>Note:</strong> Indentation creates parent-child relationships (max 8 levels)</p>
|
|
<p><strong>Note:</strong> <code>region load</code> with an empty name will not work remotely (it's interactive)</p>
|
|
<hr />
|
|
<h4 id="save-any-changes-to-regions-made-since-reboot">Save any changes to regions made since reboot</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region save</code></p>
|
|
<hr />
|
|
<h4 id="allow-a-region">Allow a region</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region allowf <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name (or <code>*</code> for wildcard)</p>
|
|
<p><strong>Note:</strong> Setting on wildcard <code>*</code> allows packets without region transport codes</p>
|
|
<hr />
|
|
<h4 id="block-a-region">Block a region</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region denyf <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name (or <code>*</code> for wildcard)</p>
|
|
<p><strong>Note:</strong> Setting on wildcard <code>*</code> drops packets without region transport codes</p>
|
|
<hr />
|
|
<h4 id="show-information-for-a-region">Show information for a region</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region get <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name (or <code>*</code> for wildcard)</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-home-region-for-this-node">View or change the home region for this node</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region home</code>
|
|
- <code>region home <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-default-scope-region-for-this-node">View or change the default scope region for this node</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region default</code>
|
|
- <code>region default {name|<null>}</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name, or <null> to reset/clear</p>
|
|
<hr />
|
|
<h4 id="create-a-new-region">Create a new region</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region put <name> [parent_name]</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name
|
|
- <code>parent_name</code>: Parent region name (optional, defaults to wildcard)</p>
|
|
<p><strong>Note:</strong> In firmware <strong>v1.15.0</strong> and later, <code>region put</code> enables flooding for that region by default (you do not need a separate <code>region allowf <name></code> after each <code>put</code>). On <strong>v1.14.0</strong> and earlier, new regions may still require <code>region allowf</code> for flooding-see <a href="#allow-a-region"><code>region allowf</code></a>.</p>
|
|
<hr />
|
|
<h4 id="define-region-hierarchy-single-line">Define region hierarchy (single line)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region def <token> [<token> ...]</code></p>
|
|
<p><strong>Parameters (tokens):</strong> Space-separated. A logical <strong>cursor</strong> starts at the wildcard <code>*</code>.</p>
|
|
<ul>
|
|
<li><strong><code>name</code></strong> - Create <code>name</code> as a child of the current cursor (equivalent to <code>region put name</code> with the cursor as parent). Cursor moves to <code>name</code>.</li>
|
|
<li><strong><code>name|jump</code></strong> <em>(or <code>name,jump</code>)</em> - Create <code>name</code> as a child of the current cursor, then move the cursor to <code>jump</code> (must already exist on the node, or have been created earlier in this command). <code>jump</code> is <strong>not</strong> the parent of <code>name</code>; use this form to pop back up and start another branch.</li>
|
|
</ul>
|
|
<p><strong>Behavior:</strong> Each created region defaults to flood-allowed (same as <code>region put</code>). The reply is the resulting region tree (same format as bare <code>region</code>); review it before running <code>region save</code> to persist. The command is transactional: invalid names, unknown or ambiguous jumps, table overflow, and hierarchy cycles return <code>Err - ...</code> without changing the existing tree.</p>
|
|
<p><strong>Existing regions:</strong> <code>region def</code> does not clear the existing tree - if a name already exists, its parent is updated to the current cursor; otherwise a new region is created. To start from scratch, <code>region remove</code> the unwanted regions first.</p>
|
|
<p><strong>Limits:</strong> Repeater serial accepts one line up to <strong>160 characters</strong>. For larger trees, split across multiple <code>region def</code> commands; the cursor resets to <code>*</code> between commands, so lead the next command with <code>child|ancestor</code> to reposition. Each token splits at most once on <code>|</code> - <code>region def a|b|c|d</code> is not a flat-list shorthand; see the flat-list example below.</p>
|
|
<p><strong>Example - linear chain</strong> (each token becomes a child of the previous):</p>
|
|
<pre><code>region def a b c d e
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Example - branched tree</strong> (equivalent to <code>region put a</code>, <code>region put b a</code>, <code>region put c b</code>, <code>region put d c</code>, <code>region put e b</code>, <code>region put f e</code>):</p>
|
|
<pre><code>region def a b c d|b e f
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Example - transactional error:</strong></p>
|
|
<pre><code>region def a b c|nope d
|
|
</code></pre>
|
|
<p>The reply is <code>Err - unknown or ambiguous jump: nope</code>. The existing tree is unchanged; re-run with a corrected jump.</p>
|
|
<p><strong>Example - flat list</strong> (each region a child of <code>*</code>). Use <code>|*</code> after each token to pop the cursor back to the root before the next token:</p>
|
|
<pre><code>region def a|* b|* c|* d|* e|* f
|
|
region save
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="remove-a-region">Remove a region</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region remove <name></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>name</code>: Region name</p>
|
|
<p><strong>Note:</strong> Must remove all child regions before the region can be removed </p>
|
|
<hr />
|
|
<h4 id="view-all-regions">View all regions</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region list <filter></code></p>
|
|
<p><strong>Serial Only:</strong> Yes</p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>filter</code>: <code>allowed</code>|<code>denied</code></p>
|
|
<p><strong>Note:</strong> Requires firmware 1.12+</p>
|
|
<hr />
|
|
<h4 id="dump-all-defined-regions-and-flood-permissions">Dump all defined regions and flood permissions</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>region</code></p>
|
|
<p><strong>Serial Only:</strong> For firmware older than 1.12.0</p>
|
|
<hr />
|
|
<h3 id="region-examples">Region Examples</h3>
|
|
<p><strong>Example 1: Using F Flag with Named Public Region</strong></p>
|
|
<pre><code>region load
|
|
#Europe F
|
|
<blank line to end region load>
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Explanation:</strong>
|
|
- Creates a region named <code>#Europe</code> with flooding enabled
|
|
- Packets from this region will be flooded to other nodes</p>
|
|
<hr />
|
|
<p><strong>Example 2: Using Wildcard with F Flag</strong></p>
|
|
<pre><code>region load
|
|
* F
|
|
<blank line to end region load>
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Explanation:</strong>
|
|
- Creates a wildcard region <code>*</code> with flooding enabled
|
|
- Enables flooding for all regions automatically
|
|
- Applies only to packets without transport codes</p>
|
|
<hr />
|
|
<p><strong>Example 3: Using Wildcard Without F Flag</strong></p>
|
|
<pre><code>region load
|
|
*
|
|
<blank line to end region load>
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Explanation:</strong>
|
|
- Creates a wildcard region <code>*</code> without flooding
|
|
- This region exists but doesn't affect packet distribution
|
|
- Used as a default/empty region</p>
|
|
<hr />
|
|
<p><strong>Example 4: Nested Public Region with F Flag</strong></p>
|
|
<pre><code>region load
|
|
#Europe F
|
|
#UK
|
|
#London
|
|
#Manchester
|
|
#France
|
|
#Paris
|
|
#Lyon
|
|
<blank line to end region load>
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Explanation:</strong>
|
|
- Creates <code>#Europe</code> region with flooding enabled
|
|
- Adds nested child regions (<code>#UK</code>, <code>#France</code>)
|
|
- All nested regions inherit the flooding flag from parent</p>
|
|
<hr />
|
|
<p><strong>Example 5: Wildcard with Nested Public Regions</strong></p>
|
|
<pre><code>region load
|
|
* F
|
|
#NorthAmerica
|
|
#USA
|
|
#NewYork
|
|
#California
|
|
#Canada
|
|
#Ontario
|
|
#Quebec
|
|
<blank line to end region load>
|
|
region save
|
|
</code></pre>
|
|
<p><strong>Explanation:</strong>
|
|
- Creates wildcard region <code>*</code> with flooding enabled
|
|
- Adds nested <code>#NorthAmerica</code> hierarchy
|
|
- Enables flooding for all child regions automatically
|
|
- Useful for global networks with specific regional rules</p>
|
|
<hr />
|
|
<h3 id="direct-retry">Direct Retry</h3>
|
|
<p>Direct retry resends direct-routed packets when the downstream echo is not heard. It applies to direct messages, ACK packets, multipart packets carrying ACK payloads, and TRACE packets.</p>
|
|
<p>The shared state, count, base, and step controls work on repeater, room-server,
|
|
and sensor firmware. Recent-repeater/SNR controls are repeater-only because the
|
|
other roles do not keep the repeater reachability table they require.</p>
|
|
<h4 id="view-or-change-direct-retry-state">View or change direct retry state</h4>
|
|
<p><strong>Search terms:</strong> enable tx retries, disable tx retries, stop direct retries, turn off retransmissions.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry</code>
|
|
- <code>set direct.retry <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Default:</strong> <code>on</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- New installs and older preference files without direct retry settings default to <code>on</code> with the <code>rooftop</code> preset.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry
|
|
set direct.retry on
|
|
set direct.retry off
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-direct-retry-heard-table-gate">View or change direct retry heard-table gate</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.heard</code>
|
|
- <code>set direct.retry.heard <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Default:</strong> <code>on</code></p>
|
|
<p><strong>Note:</strong> This command is repeater-only. When enabled, the recent repeater table is the direct retry eligibility
|
|
gate. Prefixes missing from the table are assumed reachable; prefixes in the
|
|
table below the active SNR gate are blocked.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.heard
|
|
set direct.retry.heard on
|
|
set direct.retry.heard off
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-apply-a-retry-preset">View or apply a retry preset</h4>
|
|
<p><strong>Search terms:</strong> retry profile, retry defaults, rooftop retries, mobile retries, infrastructure retries.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get retry.preset</code>
|
|
- <code>set retry.preset <preset></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>preset</code>: <code>infra</code>|<code>rooftop</code>|<code>mobile</code></p>
|
|
<p><strong>Notes:</strong>
|
|
- Applies shared direct retry and flood retry defaults.
|
|
- <code>infra</code>: fewer, slower retries for stable fixed infrastructure.
|
|
- <code>rooftop</code>: default long retry window for weak rooftop links.
|
|
- <code>mobile</code>: long retry count with shorter spacing for moving or changing links; flood retry count is <code>15</code>.
|
|
- Changing <code>direct.retry.count</code>, <code>direct.retry.base</code>, <code>direct.retry.step</code>, <code>direct.retry.margin</code>, <code>flood.retry.count</code>, <code>flood.retry.path</code>, or <code>flood.retry.group.path</code> makes the preset report as <code>custom</code>.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get retry.preset
|
|
set retry.preset infra
|
|
set retry.preset rooftop
|
|
set retry.preset mobile
|
|
</code></pre>
|
|
<hr />
|
|
<h3 id="flood-retry">Flood Retry</h3>
|
|
<p>Flood retry resends flood-routed packets when the same packet is not heard from
|
|
another qualifying repeater.</p>
|
|
<p>The count, path, group-data path, and advert controls work on repeater, room-server, and sensor
|
|
firmware. Flood forwarding must also be enabled for retries to run. Prefix,
|
|
ignore, bridge, and bucket controls are repeater-only.</p>
|
|
<h4 id="hop-zero-flood-retry-coding-rate">Hop-zero flood retry coding rate</h4>
|
|
<p>Flood packets with no path hops recorded yet use the same CR escalation ladder
|
|
as direct retries. The starting point is the active radio CR, since a flood has
|
|
no single next-hop repeater whose SNR can select a starting CR. Each retry uses
|
|
its attempt number and the active radio setting; it does not restart the ladder
|
|
from the previous retry's override. Forwarded packets with one or more recorded
|
|
hops use the active radio CR on every retry, including bridge retries whose
|
|
effective path length discounts ignored hops.</p>
|
|
<p>The initial transmission uses the active radio CR. This table lists retries
|
|
after that initial transmission; any later retries remain at CR8:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Starting CR</th>
|
|
<th>Retry 1</th>
|
|
<th>Retry 2</th>
|
|
<th>Retry 3</th>
|
|
<th>Retry 4</th>
|
|
<th>Retry 5+</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>CR4</td>
|
|
<td>CR4</td>
|
|
<td>CR5</td>
|
|
<td>CR7</td>
|
|
<td>CR7</td>
|
|
<td>CR8</td>
|
|
</tr>
|
|
<tr>
|
|
<td>CR5</td>
|
|
<td>CR5</td>
|
|
<td>CR7</td>
|
|
<td>CR7</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
</tr>
|
|
<tr>
|
|
<td>CR6</td>
|
|
<td>CR6</td>
|
|
<td>CR7</td>
|
|
<td>CR7</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
</tr>
|
|
<tr>
|
|
<td>CR7</td>
|
|
<td>CR7</td>
|
|
<td>CR7</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
</tr>
|
|
<tr>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
<td>CR8</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>The ladder is shared across presets. Presets change the retry budget, not the
|
|
CR steps. At CR5, the maximum hop-zero schedules are:</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Preset</th>
|
|
<th style="text-align: right;">Configured flood count</th>
|
|
<th style="text-align: right;">Hop-zero retries</th>
|
|
<th>CR schedule after the initial send</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>infra</code></td>
|
|
<td style="text-align: right;">1</td>
|
|
<td style="text-align: right;">2</td>
|
|
<td>CR5, CR7</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>rooftop</code></td>
|
|
<td style="text-align: right;">3</td>
|
|
<td style="text-align: right;">6</td>
|
|
<td>CR5, CR7, CR7, CR8, CR8, CR8</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mobile</code></td>
|
|
<td style="text-align: right;">15</td>
|
|
<td style="text-align: right;">15</td>
|
|
<td>CR5, CR7, CR7, then CR8 for retries 4-15</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>These budgets apply to group text and the origin login/message family
|
|
(<code>RESPONSE</code>, <code>TXT_MSG</code>, <code>ANON_REQ</code>, <code>PATH</code>). Existing payload caps, echo
|
|
cancellation, and retry eligibility still apply: <code>REQ</code> and OTA do not use
|
|
generic flood retries; other payloads allow at most one retry. An eligible
|
|
advert at CR5 therefore gets only its first CR5 retry.</p>
|
|
<p><code>set flood.retry.count 0</code> continues to disable all automatic flood retries,
|
|
including hop zero. It leaves the initial transmission and all direct-retry
|
|
settings and CR schedules unchanged. Direct retry's <code>direct.retry.cr</code> switch
|
|
and SNR thresholds continue to control direct retries only. Per-packet CR
|
|
overrides are restored after transmission and do not change the saved radio
|
|
setting or physical preamble.</p>
|
|
<h4 id="view-or-change-flood-retry-count">View or change flood retry count</h4>
|
|
<p><strong>Search terms:</strong> flood tx retries, flood retry attempts, flood retransmissions, broadcast retries.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.count</code>
|
|
- <code>set flood.retry.count <count></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>count</code>: Base retry attempts after the original send, from <code>0</code> to <code>15</code>. <code>0</code> disables flood retry.</p>
|
|
<p><strong>Note:</strong> The role first calculates its retry count: path count 0 uses <code>count * 2</code>, path count 1 uses <code>count * 1.5</code> rounded up, and path count 2 and higher uses the configured base count, with a hard cap of <code>15</code>. A shared payload policy then applies to every build: <code>REQ</code> never retries; <code>GRP_TXT</code> keeps the role-calculated count; remote-login-critical <code>RESPONSE</code>, <code>TXT_MSG</code>, <code>ANON_REQ</code>, and <code>PATH</code> packets keep up to <code>15</code> at the originating node (path count 0) and cap at <code>2</code> after entering the path; all other flood payload types cap at <code>1</code>. These caps never raise a lower role-calculated count. Setting <code>count</code> to <code>0</code> immediately removes queued and future flood retries; a packet already transmitting is allowed to finish.</p>
|
|
<p>Forwarded neighbor adverts have an additional loop guard independent of the advert retry setting. After this node completes an advert transmission and hears a downstream copy with a longer path, it does not forward that same advert again while the advert's signed timestamp is less than six hours old. Self-originated adverts, adverts without a heard echo, and adverts six hours old or older are unaffected.</p>
|
|
<p>An enabled self-originated advert retry waits at least one additional minute beyond the normal airtime-aware retry delay. Once a newer self advert has successfully entered the outbound queue, its retry sequence replaces queued or future retries for older self adverts; an older advert already transmitting is allowed to finish. Companion firmware permits this single slow retry for its own adverts while continuing to block retry attempts for neighbor adverts it forwards.</p>
|
|
<p><strong>Defaults:</strong>
|
|
- <code>infra</code>: <code>1</code>
|
|
- <code>rooftop</code>: <code>3</code>
|
|
- <code>mobile</code>: <code>15</code></p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.count
|
|
set flood.retry.count 0
|
|
set flood.retry.count 15
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-path-gate">View or change flood retry path gate</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.path</code>
|
|
- <code>set flood.retry.path <count|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>count</code>: Maximum flood path hash count eligible for retry, from <code>0</code> to <code>63</code>.
|
|
- <code>off</code>: Disable the path-length gate.</p>
|
|
<p><strong>Defaults:</strong>
|
|
- <code>infra</code>: <code>1</code>
|
|
- <code>rooftop</code>: <code>2</code>
|
|
- <code>mobile</code>: <code>1</code></p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.path
|
|
set flood.retry.path 1
|
|
set flood.retry.path off
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-the-group-data-flood-retry-path-gate">View or change the group-data flood retry path gate</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.group.path</code>
|
|
- <code>set flood.retry.group.path <count|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>count</code>: Maximum flood path hash count eligible for retry for group data packets (<code>PAYLOAD_TYPE_GRP_DATA</code>/type 6), from <code>0</code> to <code>63</code>.
|
|
- <code>off</code>: Disable only the group-data-specific gate. The general <code>flood.retry.path</code> gate still applies.</p>
|
|
<p><strong>Default:</strong> <code>1</code> for <code>infra</code>, <code>rooftop</code>, and <code>mobile</code> presets.</p>
|
|
<p><strong>Note:</strong> The stricter of <code>flood.retry.path</code> and <code>flood.retry.group.path</code> is used. A value of <code>1</code> allows retry sequences at path counts <code>0</code> and <code>1</code>; group data at path count <code>2</code> or higher is still forwarded normally but does not start a flood retry sequence. A value of <code>0</code> allows retries only at the originating sender.</p>
|
|
<p>Setting <code>flood.retry.path</code> to <code>0</code> also sets <code>flood.retry.group.path</code> to <code>off</code> because the general zero-hop gate is already stricter. While the general gate remains <code>0</code>, attempts to set the group-data gate keep it <code>off</code>. Applying a named retry preset restores the group-data default of <code>1</code>.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.group.path
|
|
set flood.retry.group.path 1
|
|
set flood.retry.group.path off
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-advert-handling">View or change flood retry advert handling</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.advert</code>
|
|
- <code>set flood.retry.advert <on|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: Retry node advert floods.
|
|
- <code>off</code>: Do not retry node advert floods.</p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.advert
|
|
set flood.retry.advert off
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-target-prefixes">View or change flood retry target prefixes</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.prefixes</code>
|
|
- <code>set flood.retry.prefixes <prefixes|none|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>prefixes</code>: Comma-separated 3-byte path hash prefixes, up to 8 entries.
|
|
- <code>none</code> or <code>off</code>: Clear the list.</p>
|
|
<p><strong>Note:</strong> When set, non-bridge flood retry only accepts same-packet echoes whose
|
|
last hop matches one of these prefixes. When unset, any non-ignored last hop can
|
|
cancel the retry.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.prefixes
|
|
set flood.retry.prefixes A58296,860CCA,425E5C
|
|
set flood.retry.prefixes none
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-ignored-prefixes">View or change flood retry ignored prefixes</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.ignore</code>
|
|
- <code>set flood.retry.ignore <prefixes|none|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>prefixes</code>: Comma-separated 3-byte path hash prefixes, up to 8 entries.
|
|
- <code>none</code> or <code>off</code>: Clear the list.</p>
|
|
<p><strong>Note:</strong> Non-bridge flood retry does not cancel on same-packet echoes whose
|
|
last hop matches this list. Bridge mode also excludes these prefixes from bucket
|
|
and <code>other</code> hits.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.ignore
|
|
set flood.retry.ignore 71CE82,C7618C
|
|
set flood.retry.ignore none
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-bridge-mode">View or change flood retry bridge mode</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.bridge</code>
|
|
- <code>set flood.retry.bridge <on|off></code></p>
|
|
<p><strong>Note:</strong> Bridge mode retries until each configured fresh bucket, plus the non-source <code>other</code> bucket, has been heard or the retry count is exhausted. If prefixes in different buckets share their first byte, configuration commands return a warning because a 1-byte path cannot distinguish those buckets. The configuration remains valid: an ambiguous source is treated as belonging to every matching source bucket, and an ambiguous echo credits every matching target bucket so it cannot force retry exhaustion.</p>
|
|
<p>Flood retry timing retains its fixed maximum-frame plus 20 packet-airtime wait, then adds a random <code>0-200%</code> of one additional packet airtime on every attempt. This de-synchronizes repeaters that may have missed the same echo while capping the added wait at two frames.</p>
|
|
<p>Only one active retry sequence is kept for a given logical flood packet. An identical flood can still transmit normally, but it does not create a second sequence of extra attempts. Retry state is released if a queued packet is evicted, and the final echo window retains metadata without reserving a packet-pool entry.</p>
|
|
<p>Bridge reachability learned from earlier hops in a successful echo is cached separately from <code>recent.repeater</code>. Only the final RF hop updates <code>recent.repeater</code> and its SNR, so indirect path entries cannot affect direct-retry SNR gating or coding-rate selection.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.bridge
|
|
set flood.retry.bridge on
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-flood-retry-bridge-buckets">View or change flood retry bridge buckets</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get flood.retry.bucket.<n></code>
|
|
- <code>set flood.retry.bucket <n> <prefixes|none|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>n</code>: Bucket number from <code>1</code> to <code>6</code>.
|
|
- <code>prefixes</code>: Comma-separated 3-byte path hash prefixes, up to 17 entries per bucket.
|
|
- <code>none</code> or <code>off</code>: Clear the bucket.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get flood.retry.bucket.1
|
|
set flood.retry.bucket 1 71CE82,C7618C
|
|
set flood.retry.bucket 2 none
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-direct-retry-count">View or change direct retry count</h4>
|
|
<p><strong>Search terms:</strong> tx retries, transmit retries, direct retries, retry count, retry attempts, retransmission count, message retries, DM retries.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.count</code>
|
|
- <code>set direct.retry.count <count></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>count</code>: Maximum retry attempts after the original send, from <code>1</code> to <code>15</code>.</p>
|
|
<p><strong>Default:</strong> <code>15</code> with the <code>rooftop</code> preset</p>
|
|
<p><strong>Note:</strong> This setting limits retries for eligible direct-routed packets such as
|
|
traces, requests, responses, and ACKs. Direct-routed <strong>text messages (type 2)</strong>
|
|
are an exception: they allow <strong>up to 21 retries after the original send</strong>,
|
|
regardless of <code>direct.retry.count</code> or the repeater short-path cap. For example,
|
|
<code>set direct.retry.count 1</code> limits eligible non-text packets to one retry, but
|
|
does not reduce the text-message limit.</p>
|
|
<p>These are maximums, not a fixed number of transmissions. Retries stop early
|
|
when the node hears the next hop forward the packet. The special final-hop
|
|
retry sends only one duplicate because the destination does not forward the
|
|
packet. Repeater non-text retries are also capped at 8 for a retry path of up
|
|
to 3 hops, 12 for 4 hops, and 15 for longer paths; these caps never increase a
|
|
lower configured count.</p>
|
|
<p>Use <code>set direct.retry off</code> to disable this node's direct retries, including
|
|
text-message retries, and <code>set direct.retry on</code> to enable them again. A count
|
|
of <code>0</code> is not supported. Sending apps and other nodes may have their own retry
|
|
behavior; this setting does not change it.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.count
|
|
set direct.retry.count 1
|
|
set direct.retry.count 4
|
|
set direct.retry.count 15
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-direct-retry-base-delay">View or change direct retry base delay</h4>
|
|
<p><strong>Search terms:</strong> retry delay, retry timeout, retransmission timeout, wait between retries.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.base</code>
|
|
- <code>set direct.retry.base <ms></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>ms</code>: First retry wait in milliseconds, from <code>10</code> to <code>5000</code>.</p>
|
|
<p><strong>Default:</strong> <code>175</code> with the <code>rooftop</code> preset</p>
|
|
<p><strong>Explanation:</strong>
|
|
- The first retry waits for <code>base + packet-length add-on + random forwarding jitter</code>
|
|
after the preceding transmission completes.
|
|
- TRACE and
|
|
ANON_REQ/type 7 packets use a 3x line-time add-on. TXT_MSG/type 2
|
|
packets use 7x. Other direct retry packets use 6x.
|
|
- Room-server and sensor firmware use this configured base with the same
|
|
packet-type add-ons.
|
|
- Larger values reduce channel pressure and give slow repeaters more time.
|
|
- Smaller values recover faster but create tighter retry bursts.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.base
|
|
set direct.retry.base 175
|
|
set direct.retry.base 275
|
|
set direct.retry.base 500
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-direct-retry-step-delay">View or change direct retry step delay</h4>
|
|
<p><strong>Search terms:</strong> retry backoff, increasing retry delay, retry interval step.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.step</code>
|
|
- <code>set direct.retry.step <ms></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>ms</code>: Extra milliseconds added for each subsequent retry, from <code>0</code> to <code>5000</code>.</p>
|
|
<p><strong>Default:</strong> <code>100</code> with the <code>rooftop</code> preset</p>
|
|
<p><strong>Explanation:</strong>
|
|
- Retry delay is <code>base + packet-length add-on + random forwarding jitter + attempt_index * step</code>.
|
|
- TRACE and ANON_REQ/type 7 packets
|
|
use a 3x packet-length add-on. TXT_MSG/type 2 packets use 7x.
|
|
Other direct retry packets use 6x.
|
|
- Room-server and sensor firmware use this configured step with the same
|
|
packet-type add-ons.
|
|
- With <code>base=175</code> and <code>step=100</code>, the fixed portion is <code>175</code>, <code>275</code>, <code>375</code>,
|
|
<code>475</code> ms, and so on, before the packet-length add-on and random jitter.
|
|
- <code>step=0</code> keeps every retry at the same delay.
|
|
- Larger steps spread retries over time and are safer on busy channels.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.step
|
|
set direct.retry.step 0
|
|
set direct.retry.step 50
|
|
set direct.retry.step 100
|
|
set direct.retry.step 250
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-direct-retry-snr-margin">View or change direct retry SNR margin</h4>
|
|
<p><strong>Search terms:</strong> retry signal threshold, retry SNR threshold, retry signal margin.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.margin</code>
|
|
- <code>set direct.retry.margin <snr_db></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>snr_db</code>: Extra SNR margin above the SF receive floor, from <code>0</code> to <code>40</code>.</p>
|
|
<p><strong>Default:</strong> <code>5.00</code> with the <code>rooftop</code> preset</p>
|
|
<p><strong>Notes:</strong>
|
|
- This command is repeater-only.
|
|
- Unknown repeaters are still retried.
|
|
- Known repeaters below the receive floor plus this margin are skipped.
|
|
- Failed attempts lower the recent repeater SNR estimate by <code>0.25 dB</code>.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.margin
|
|
set direct.retry.margin 0
|
|
set direct.retry.margin 2.5
|
|
set direct.retry.margin 5
|
|
set direct.retry.margin 10
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-or-change-adaptive-direct-retry-coding-rate">View or change adaptive direct retry coding rate</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get direct.retry.cr</code>
|
|
- <code>set direct.retry.cr off</code>
|
|
- <code>set direct.retry.cr on</code> (room-server and sensor)
|
|
- <code>set direct.retry.cr <cr4_min>,<cr5_min>,<cr7_min>,<cr8_max></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>cr4_min</code>: Minimum SNR in dB to retry at CR4.
|
|
- <code>cr5_min</code>: Minimum SNR in dB to retry at CR5.
|
|
- <code>cr7_min</code>: Minimum SNR in dB to retry at CR7.
|
|
- <code>cr8_max</code>: Maximum SNR in dB that forces CR8.</p>
|
|
<p><strong>Default:</strong> <code>10.00,7.50,2.50,2.50</code></p>
|
|
<p><strong>Explanation:</strong>
|
|
- Higher SNR uses faster coding rates.
|
|
- Lower SNR uses more robust coding rates.
|
|
- Repeater retry attempts escalate from the adaptive starting CR. CR4 starts as CR4, CR5, CR7, CR7, then CR8. CR5 starts as CR5, CR7, CR7, then CR8. CR7 gets two attempts, then CR8.
|
|
- Repeater adaptive CR selection intentionally skips CR6.
|
|
- Non-repeater retry packets start at the current radio CR and follow the same escalation pattern, clamped at CR8. With the normal CR5 radio setting this is CR5, CR7, CR7, then CR8.
|
|
- Room-server and sensor firmware accept <code>on</code> or <code>off</code>; numeric SNR thresholds
|
|
are repeater-only because those roles do not keep recent-repeater SNR data.
|
|
- <code>off</code> disables per-packet direct-retry CR overrides and uses the current radio CR.
|
|
- Retry packets may use a different coding rate, but they keep the radio's normal physical preamble.
|
|
- Unknown repeaters start at <code>+3.00 dB</code> for adaptive CR selection.
|
|
- A failed unknown repeater is seeded at <code>+2.75 dB</code>.
|
|
- Each later failure lowers the SNR estimate by <code>0.25 dB</code>.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get direct.retry.cr
|
|
set direct.retry.cr off
|
|
set direct.retry.cr on
|
|
set direct.retry.cr 10.0,7.5,2.5,2.5
|
|
set direct.retry.cr 12.0,8.0,4.0,1.0
|
|
set direct.retry.cr 8.0,5.0,1.5,0
|
|
set direct.retry.cr 6.0,3.0,0,-2.0
|
|
set direct.retry.cr 20.0,12.0,6.0,2.0
|
|
set direct.retry.cr 4.0,2.0,0,-4.0
|
|
</code></pre>
|
|
<p><strong>Example profiles:</strong>
|
|
- Conservative weak-link profile:</p>
|
|
<pre><code>set direct.retry.cr 12.0,8.0,4.0,1.0
|
|
</code></pre>
|
|
<ul>
|
|
<li>Balanced rooftop profile:</li>
|
|
</ul>
|
|
<pre><code>set direct.retry.cr 10.0,7.5,2.5,2.5
|
|
</code></pre>
|
|
<ul>
|
|
<li>Faster strong-link profile:</li>
|
|
</ul>
|
|
<pre><code>set direct.retry.cr 6.0,3.0,0,-2.0
|
|
</code></pre>
|
|
<ul>
|
|
<li>Very cautious noisy-link profile:</li>
|
|
</ul>
|
|
<pre><code>set direct.retry.cr 20.0,12.0,6.0,2.0
|
|
</code></pre>
|
|
<hr />
|
|
<h4 id="view-seed-or-clear-the-recent-repeater-table">View, seed, or clear the recent repeater table</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get recent.repeater</code>
|
|
- <code>get recent.repeater <page></code>
|
|
- <code>get recent.repeaters <page></code>
|
|
- <code>get recent.repeaters search <prefix> [page]</code>
|
|
- <code>set recent.repeater <prefix> [snr_db]</code>
|
|
- <code>clear recent.repeater</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>prefix</code>: Repeater path-hash prefix as 2, 4, or 6 hex characters.
|
|
- <code>snr_db</code>: Optional SNR in dB. If omitted or invalid, defaults to <code>3.0</code>.
|
|
- <code>page</code>: 1-based result page.</p>
|
|
<p><strong>Note:</strong> These commands are repeater-only.</p>
|
|
<p>The default capacity is 256 entries on classic ESP32, 2,048 on other ESP32
|
|
chips, 512 on nRF52, and 64 on other platforms. Builds can override it with
|
|
<code>MAX_RECENT_REPEATERS</code>. Classic ESP32's history uses 3,072 bytes of startup
|
|
heap instead of 24,576 bytes, leaving more memory for the packet pool and Wi-Fi.</p>
|
|
<p><strong>Output order:</strong>
|
|
- <code>get recent.repeater</code> lists 3-byte prefixes first, then 2-byte prefixes, then 1-byte prefixes.
|
|
- Within each prefix length, entries are sorted from highest SNR to lowest SNR.
|
|
- <code>search</code> returns every overlapping path-hash entry. For example, searching
|
|
<code>860C</code> can return <code>86</code>, <code>860C</code>, and <code>860CCA</code>; it does not return a different
|
|
branch such as <code>86D0</code>.
|
|
- Search rows include the monotonic age of the entry's most recent recording,
|
|
compacted to a whole <code>s</code>, <code>m</code>, or <code>h</code> field. Search pages contain up to six
|
|
rows so the result remains within the remote CLI reply limit.</p>
|
|
<p><strong>SNR details:</strong>
|
|
- Recent repeater SNR is stored internally in quarter-dB units.
|
|
- Heard repeater samples update an existing table entry with a weighted blend: <code>75%</code> existing SNR and <code>25%</code> new heard SNR, rounded up.
|
|
- Direct retry success also feeds the heard echo SNR back into the same weighted table.
|
|
- Direct retry failure is not weighted: each final echo-timeout failure lowers that repeater's SNR by <code>0.25 dB</code>.
|
|
- Unknown repeaters start at <code>+3.00 dB</code> for adaptive CR selection.
|
|
- If an unknown repeater fails, it is seeded into the table at <code>+2.75 dB</code>.
|
|
- <code>set recent.repeater <prefix> [snr_db]</code> seeds a missing prefix or adds another weighted sample for an existing prefix.
|
|
- Successful <code>set recent.repeater</code> replies include the stored prefix and SNR, for example <code>OK - set A1B2C3 at 3.0 SNR</code>.
|
|
- Entries strictly older than 24 hours are removed during a sweep every three hours, so an entry can remain for at most approximately 27 hours.</p>
|
|
<p><strong>Examples:</strong></p>
|
|
<pre><code>get recent.repeater
|
|
get recent.repeater 2
|
|
get recent.repeaters search 86
|
|
get recent.repeaters search 860C page 2
|
|
set recent.repeater A1B2C3 8.5
|
|
set recent.repeater 71CE82 -3.25
|
|
set recent.repeater A1B2C3
|
|
clear recent.repeater
|
|
</code></pre>
|
|
<hr />
|
|
<h3 id="gps-when-gps-support-is-compiled-in">GPS (When GPS support is compiled in)</h3>
|
|
<h4 id="view-or-change-gps-state">View or change GPS state</h4>
|
|
<p><strong>Search terms:</strong> enable GPS, disable GPS, turn GPS on, turn GPS off.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get gps</code>
|
|
- <code>set gps <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<p><strong>Note:</strong> These command names are shared with GPS-capable Companion builds.
|
|
Companion reports <code>on</code> or <code>off</code>; infrastructure includes receiver details:
|
|
- <code>off</code> when the GPS hardware is disabled
|
|
- <code>on, {active|deactivated}, {fix|no fix}, {sat count} sats</code> when the GPS hardware is enabled</p>
|
|
<hr />
|
|
<h4 id="sync-this-nodes-clock-with-gps-time">Sync this node's clock with GPS time</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>gps sync</code></p>
|
|
<p>The GPS must be enabled. When GPS power saving has put an enabled receiver to
|
|
sleep, this command schedules a sync and wakes it; after <code>set gps off</code>, it reports
|
|
<code>gps is off</code> without scheduling work.</p>
|
|
<hr />
|
|
<h4 id="set-this-nodes-location-based-on-the-gps-coordinates">Set this node's location based on the GPS coordinates</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>gps setloc</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-gps-advert-policy">View or change the GPS advert policy</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>gps advert</code>
|
|
- <code>gps advert <policy></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>policy</code>: <code>none</code>|<code>share</code>|<code>prefs</code>
|
|
- <code>none</code>: don't include location in adverts
|
|
- <code>share</code>: share gps location (from SensorManager)
|
|
- <code>prefs</code>: location stored in node's lat and lon settings</p>
|
|
<p><strong>Default:</strong> <code>prefs</code> on every repeater, room-server, and sensor build that uses
|
|
the common advert policy. A previously saved <code>none</code>, <code>share</code>, or <code>prefs</code> choice
|
|
still overrides the first-boot default after an update.</p>
|
|
<hr />
|
|
<h3 id="sensors-when-sensor-support-is-compiled-in">Sensors (When sensor support is compiled in)</h3>
|
|
<h4 id="view-or-change-telemetry-access-mode">View or change telemetry access mode</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get telemetry.access</code>
|
|
- <code>set telemetry.access <mode></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>mode</code>: <code>all</code>|<code>acl</code>
|
|
- <code>all</code>: allow telemetry requests using the requester-provided telemetry mask
|
|
- <code>acl</code>: require ACL read-only or higher for telemetry, including GPS</p>
|
|
<p><strong>Default:</strong> <code>all</code></p>
|
|
<p><strong>Note:</strong> <code>all</code> matches the previous sensor telemetry behavior.</p>
|
|
<hr />
|
|
<h4 id="view-the-list-of-sensors-on-this-node">View the list of sensors on this node</h4>
|
|
<p><strong>Usage:</strong> <code>sensor list [start]</code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>start</code>: Optional starting index (defaults to 0)</p>
|
|
<p><strong>Note:</strong> Output format: <code><var_name>=<value>\n</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-value-of-a-sensor">View or change the value of a sensor</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>sensor get <key></code>
|
|
- <code>sensor set <key> <value></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>key</code>: Sensor setting name
|
|
- <code>value</code>: The value to set the sensor to</p>
|
|
<hr />
|
|
<h3 id="bridge-when-bridge-support-is-compiled-in">Bridge (When bridge support is compiled in)</h3>
|
|
<p>For a complete two-repeater setup with each option explained, see the
|
|
<a href="../espnow_bridge_setup/">ESP-NOW bridge setup guide</a>.</p>
|
|
<h4 id="view-the-compiled-bridge-type">View the compiled bridge type</h4>
|
|
<p><strong>Usage:</strong> <code>get bridge.type</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-bridge-enabled-flag">View or change the bridge enabled flag</h4>
|
|
<p><strong>Search terms:</strong> enable bridge, disable bridge, serial bridge, RS232 bridge.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.enabled</code>
|
|
- <code>get bridge.running</code>
|
|
- <code>set bridge.enabled <state></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>state</code>: <code>on</code>|<code>off</code></p>
|
|
<p><code>bridge.enabled</code> is the saved intent. <code>bridge.running</code> reports whether the
|
|
bridge actually started in this boot; they can differ after a hardware conflict,
|
|
missing credentials, or a transient initialization failure. Normal merged
|
|
repeater images default to <code>off</code>; dedicated bridge images may default to <code>on</code>.</p>
|
|
<hr />
|
|
<h4 id="add-a-delay-to-packets-routed-through-this-bridge">Add a delay to packets routed through this bridge</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.delay</code>
|
|
- <code>set bridge.delay <ms></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>ms</code>: Delay in milliseconds (0-10000)</p>
|
|
<p><strong>Default:</strong> <code>500</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-source-of-packets-bridged-to-the-external-interface">View or change the source of packets bridged to the external interface</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.source</code>
|
|
- <code>set bridge.source <source></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>source</code>:
|
|
- <code>rx</code>: bridges received packets
|
|
- <code>tx</code>: bridges transmitted packets</p>
|
|
<p><strong>Default:</strong> <code>tx</code></p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> For MQTT, use <code>mqtt.rx</code> and <code>mqtt.tx</code> to control each direction independently. Both can be enabled together. Use <code>mqtt.enabled</code> as the MQTT master switch; <code>bridge.*</code> configures RS232 and ESP-NOW bridges.</p>
|
|
</blockquote>
|
|
<hr />
|
|
<h4 id="view-or-change-the-mqtt-master-switch">View or change the MQTT master switch</h4>
|
|
<p><strong>Search terms:</strong> enable MQTT, disable MQTT, MQTT on, MQTT off, WiFi logging.</p>
|
|
<p><strong>Usage:</strong></p>
|
|
<ul>
|
|
<li><code>get mqtt.enabled</code></li>
|
|
<li><code>set mqtt.enabled on</code></li>
|
|
<li><code>set mqtt.enabled off</code></li>
|
|
<li><code>get mqtt.running</code></li>
|
|
<li><code>get mqtt.status</code></li>
|
|
</ul>
|
|
<p>These commands are the same on MQTT-capable Companion, Repeater, Room Server,
|
|
and Sensor builds. The master switch is saved; turning it off disconnects
|
|
MQTT while keeping broker presets and credentials. Turning it on allows those
|
|
brokers to reconnect. <code>get mqtt.running</code> checks the service's runtime state;
|
|
<code>get mqtt.status</code> reports individual broker connections. Enabling MQTT does
|
|
not imply that a broker is connected.</p>
|
|
<p>USB logging remains independent. On images with both outputs,
|
|
<code>set logging.output off|usb|wifi|both</code> selects USB and MQTT together.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-mqtt-rx-packet-uplinking">View or change MQTT RX packet uplinking</h4>
|
|
<p><strong>Search terms:</strong> MQTT receive logging, MQTT RX capture, publish received packets.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.rx</code>
|
|
- <code>set mqtt.rx <on|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: uplink received (RX) packets to MQTT brokers
|
|
- <code>off</code>: disable RX packet uplinking</p>
|
|
<p><strong>Default:</strong> <code>on</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-mqtt-tx-packet-uplinking">View or change MQTT TX packet uplinking</h4>
|
|
<p><strong>Search terms:</strong> MQTT transmit logging, MQTT TX capture, publish sent packets.</p>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.tx</code>
|
|
- <code>set mqtt.tx <on|off|advert></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: uplink all transmitted (TX) packets to MQTT brokers
|
|
- <code>advert</code>: uplink only this node's own advert packets (self-originated advertisements only - forwarded adverts from other nodes are filtered out)
|
|
- <code>off</code>: disable TX packet uplinking</p>
|
|
<p><strong>Default:</strong> <code>advert</code></p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> <code>mqtt.rx</code> and <code>mqtt.tx</code> take effect immediately - no restart required. Both can be enabled simultaneously.</p>
|
|
</blockquote>
|
|
<hr />
|
|
<h4 id="view-or-change-periodic-neighbors-publishing-mqtt-observer-neighbors-feature">View or change periodic neighbors publishing (MQTT observer, neighbors feature)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.neighbors</code>
|
|
- <code>set mqtt.neighbors <on|off></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>on</code>: periodically discover neighbor scopes and publish the neighbor table to the <code>neighbors</code> topic
|
|
- <code>off</code>: disable periodic neighbors publishing</p>
|
|
<p><strong>Default:</strong> <code>off</code></p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> Requires a build with the neighbors feature compiled in (all PSRAM
|
|
boards, plus non-PSRAM boards built with <code>MQTT_NEIGHBORS_WITHOUT_PSRAM</code>);
|
|
elsewhere this replies <code>Err - neighbors not enabled in this build</code>. Non-PSRAM
|
|
builds publish at most 20 neighbours per pass to bound internal-DRAM use, and
|
|
set <code>truncated</code> with the true <code>total_neighbors</code> when the table is larger.
|
|
The setting is read live by the mesh
|
|
loop - no restart required; enabling it triggers a discovery on the next pass.
|
|
While enabled, <code>get mqtt.status</code> gains a trailing <code>nbr: <next>/<last></code> field
|
|
(time to next publish, and how the last publish went).</p>
|
|
</blockquote>
|
|
<hr />
|
|
<h4 id="view-or-change-the-neighbors-publish-interval-mqtt-observer-neighbors-feature">View or change the neighbors publish interval (MQTT observer, neighbors feature)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.neighbors.interval</code>
|
|
- <code>set mqtt.neighbors.interval <hours></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>hours</code>: how often to publish the neighbor table (12-336, default 24)</p>
|
|
<p><strong>Default:</strong> <code>24</code> (hours)</p>
|
|
<blockquote>
|
|
<p><strong>Note:</strong> Out-of-range values are rejected (not clamped). Requires a build
|
|
with <code>WITH_MQTT_NEIGHBORS</code>; PSRAM boards enable it automatically and selected
|
|
non-PSRAM variants opt in with <code>MQTT_NEIGHBORS_WITHOUT_PSRAM</code>.</p>
|
|
</blockquote>
|
|
<hr />
|
|
<h4 id="view-or-change-the-ntp-server-mqtt-observer-only">View or change the NTP server (MQTT observer only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.ntp</code>
|
|
- <code>set mqtt.ntp <hostname></code>
|
|
- <code>set mqtt.ntp none</code></p>
|
|
<p><strong>Description:</strong> Sets the primary NTP server used for clock sync (required for JWT MQTT auth). On <code>set</code>, the device attempts an immediate sync of the just-configured server (primary only, so a typo fails fast) when WiFi is connected and the MQTT bridge is running.</p>
|
|
<p><strong>Fallbacks:</strong> If the primary fails, the firmware tries <code>pool.ntp.org</code>, <code>time.google.com</code>, <code>time.cloudflare.com</code>, <code>time.aws.com</code>, and <code>time.nist.gov</code> in order (skipping duplicates).</p>
|
|
<p><strong>Default:</strong> <code>pool.ntp.org</code> (when unset or <code>none</code>)</p>
|
|
<hr />
|
|
<h4 id="diagnose-ntp-server-connectivity-mqtt-observer-only">Diagnose NTP server connectivity (MQTT observer only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get mqtt.ntp.diag</code></p>
|
|
<p><strong>Description:</strong> Probes every configured NTP server (the custom primary, if set, plus the built-in fallbacks) and reports whether each responds. This is a pure connectivity diagnostic - it does <strong>not</strong> change the system clock.</p>
|
|
<ul>
|
|
<li><strong>Serial console:</strong> prints a detailed table with each server's reported UTC time (or <code>FAIL</code>).</li>
|
|
<li><strong>Over LoRa:</strong> returns a compact <code><server> ok|fail</code> list, one per line.</li>
|
|
</ul>
|
|
<p>Requires WiFi connected and the MQTT bridge running.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-speed-of-the-bridge-rs-232-only">View or change the speed of the bridge (RS-232 only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.baud</code>
|
|
- <code>set bridge.baud <rate></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>rate</code>: Integer baud rate from <code>9600</code> through the board's compiled
|
|
<code>BRIDGE_MAX_BAUD</code> (commonly <code>500000</code>); for example <code>115200</code>. Stop the bridge
|
|
with <code>set bridge.enabled off</code> before changing it, then enable it again.</p>
|
|
<p><strong>Default:</strong> <code>115200</code></p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-uart-used-by-the-bridge-rs-232-only">View or change the UART used by the bridge (RS-232 only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.uart</code>
|
|
- <code>set bridge.uart <port></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>port</code>: Hardware UART number compiled for the board. Most boards expose one
|
|
fixed UART. RAK4631 accepts <code>1</code> or <code>2</code>; UART 2 is the default so UART 1 can
|
|
remain available to the RAK12501/L76K GPS. RAK12500 GPS uses I2C rather than
|
|
this UART, but the explicit legacy Serial1 bridge omits the combined GPS
|
|
provider and therefore does not expose either GPS path.</p>
|
|
<p>The setting is persistent and restarts an enabled bridge immediately. Normal
|
|
repeater artifacts start with <code>bridge.enabled off</code>; configure the UART and baud
|
|
rate before running <code>set bridge.enabled on</code>. On the canonical RAK4631 runtime
|
|
image, UART 1 is reserved even if the bounded boot probe hears no RAK12501.
|
|
Silence cannot prove that a cold L76K is physically absent, and that module
|
|
remains powered by the shared WB_IO2/3V3_S rail. Use UART 2. UART 1 requires an
|
|
explicit no-GPS/dedicated Serial1 bridge image. This fail-closed reservation
|
|
also applies when the detected GPS is an I2C RAK12500; that receiver does not
|
|
electrically use UART 1, but its presence cannot rule out another silent UART
|
|
module.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-channel-used-for-bridging-espnow-only">View or change the channel used for bridging (ESPNow only)</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.channel</code>
|
|
- <code>set bridge.channel <channel></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>channel</code>: Channel number from 1 through 13 in either format. This matches
|
|
the primary-ESP-NOW policy and the default regulatory range used by the
|
|
supported ESP32 targets.</p>
|
|
<p>This controls the optional ESP-NOW bridge transport; it does not change a
|
|
node's primary ESP-NOW mesh channel. Primary-ESP-NOW firmware uses
|
|
<code>get espnow.channel</code> and <code>set espnow.channel <1-13></code> instead.</p>
|
|
<hr />
|
|
<h4 id="view-or-change-the-esp-now-bridge-wire-format">View or change the ESP-NOW bridge wire format</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.format</code>
|
|
- <code>set bridge.format <format></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>format</code>:
|
|
- <code>wrapped</code>: the original ESP-NOW bridge framing (magic, checksum, and XOR
|
|
using <code>bridge.secret</code>)
|
|
- <code>raw</code>: the exact serialized MeshCore packet used by primary
|
|
<code>ESPNOWRadio</code> firmware</p>
|
|
<p><strong>Default:</strong> <code>wrapped</code></p>
|
|
<p>The setting is persistent and restarts an enabled bridge immediately. Receive
|
|
parsing is strict: <code>wrapped</code> accepts only wrapped frames and <code>raw</code> accepts only
|
|
raw MeshCore frames. Coordinate the format and channel on every ESP-NOW peer;
|
|
there is no automatic dual-format receive mode because it would permit
|
|
ambiguous, asymmetric bridge deployments.</p>
|
|
<p>Use <code>raw</code> to connect a LoRa-primary <code>*_repeater_bridge_espnow</code> node to
|
|
<code>Generic_ESPNOW</code>, <code>SenseCapIndicator-ESPNow</code>, or another primary-ESP-NOW node.
|
|
Raw mode enables the ESP-NOW LR PHY and sends at the same LR rate used by those
|
|
targets. All nodes must use the same 1-13 channel. On a primary-ESP-NOW node,
|
|
change that side with <code>set espnow.channel <1-13></code> and reboot; on the bridge,
|
|
use <code>set bridge.channel <1-13></code>.</p>
|
|
<p>Raw mode ignores <code>bridge.secret</code> and removes the bridge wrapper's lightweight
|
|
network isolation. MeshCore's own packet authentication/encryption still
|
|
applies where the packet type provides it, but public frames and routing
|
|
metadata remain visible. The wrapped format's XOR is isolation, not strong
|
|
cryptography. Bridge duplicate tracking remains active in both formats, but
|
|
deploying multiple gateways between the same LoRa and ESP-NOW coverage areas
|
|
can still increase duplicate traffic while their seen-packet tables converge.</p>
|
|
<p>One ESP-NOW frame carries at most 250 payload bytes. In raw mode, serialized
|
|
MeshCore packets up to that size remain byte-for-byte compatible with existing
|
|
raw endpoints. Updated raw endpoints split 251-255-byte transport units into
|
|
two versioned fragments and reassemble them by source MAC, length, and CRC;
|
|
both endpoints must include this support for those sizes. Current valid
|
|
MeshCore packet geometry reaches 254 bytes, while 255 is retained as transport
|
|
headroom. Wrapped mode retains its legacy 246-byte maximum after the four-byte
|
|
magic and checksum overhead, and drops larger packets instead of truncating
|
|
them.</p>
|
|
<hr />
|
|
<h4 id="set-the-esp-now-secret">Set the ESP-Now secret</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>get bridge.secret</code>
|
|
- <code>set bridge.secret <secret></code></p>
|
|
<p><strong>Parameters:</strong>
|
|
- <code>secret</code>: ESP-NOW bridge secret, 1-15 characters</p>
|
|
<p><strong>Default:</strong> Varies by board</p>
|
|
<p>This setting is used only by <code>bridge.format wrapped</code>; raw mode ignores it.</p>
|
|
<hr />
|
|
<h4 id="view-the-bootloader-version-nrf52-only">View the bootloader version (nRF52 only)</h4>
|
|
<p><strong>Usage:</strong> <code>get bootloader.ver</code></p>
|
|
<p>Applies to every nRF52 board/role that exposes this getter, including Companion,
|
|
repeater, and room-server firmware. It reads the installed bootloader region
|
|
selected by the MBR/UICR boot address and bounded by the chip's flash geometry;
|
|
it does not search application firmware or staged update files.</p>
|
|
<p>The reader preserves a complete Adafruit/UF2 version string, including OTAFIX,
|
|
preview, and vendor/build suffixes. If that string is absent or ambiguous, it
|
|
uses the existing whole-image CRC and unique BLMF/BLM2 validation to read the
|
|
embedded OTAFIX version (for example, <code>> OTAFIX2.4.6</code>). Some current release
|
|
images, including MeshTower V2 SD 2.4.6, omit the UF2 text entirely. As a last
|
|
fallback, the Adafruit core's startup-captured version is explicitly labelled
|
|
<code>(base)</code>; it cannot identify an OTAFIX/fork revision.</p>
|
|
<p><code>unknown</code> remains possible for a bootloader exposing none of these version
|
|
sources, invalid geometry/vectors, or unresolved ambiguity. There is no universal
|
|
version field shared by every third-party bootloader. This is diagnostic only:
|
|
displaying a version neither grants OTA capability nor bypasses install checks.
|
|
The fix is in MeshCore application firmware; installing another bootloader alone
|
|
does not update an older application's version reader.</p>
|
|
<hr />
|
|
<h4 id="view-power-management-support">View power management support</h4>
|
|
<p><strong>Usage:</strong> <code>get pwrmgt.support</code></p>
|
|
<hr />
|
|
<h4 id="view-the-current-power-source">View the current power source</h4>
|
|
<p><strong>Usage:</strong> <code>get pwrmgt.source</code></p>
|
|
<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
|
|
<hr />
|
|
<h4 id="view-the-boot-reset-and-shutdown-reasons">View the boot reset and shutdown reasons</h4>
|
|
<p><strong>Usage:</strong> <code>get pwrmgt.bootreason</code></p>
|
|
<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
|
|
<hr />
|
|
<h4 id="view-the-boot-voltage">View the boot voltage</h4>
|
|
<p><strong>Usage:</strong> <code>get pwrmgt.bootmv</code></p>
|
|
<p><strong>Note:</strong> Returns an error on boards without power management support.</p>
|
|
<hr />
|
|
<h3 id="ethernet-when-ethernet-support-is-compiled-in">Ethernet (when Ethernet support is compiled in)</h3>
|
|
<p>Ethernet support is available on RAK4631 boards with a RAK13800 (W5100S) Ethernet module. Use the <code>_ethernet</code> firmware variants (e.g. <code>RAK_4631_repeater_ethernet</code>) to enable this feature.</p>
|
|
<hr />
|
|
<h4 id="view-ethernet-connection-status">View Ethernet connection status</h4>
|
|
<p><strong>Usage:</strong>
|
|
- <code>eth.status</code></p>
|
|
<p><strong>Output:</strong>
|
|
- <code>ETH: <ip>:<port></code> when connected (e.g. <code>ETH: 192.168.1.50:23</code>)
|
|
- <code>ETH: not connected</code> when Ethernet is not active</p>
|
|
<p><strong>Notes:</strong>
|
|
- Available on repeater and room server firmware only. Companion radio ethernet firmware does not expose a CLI.
|
|
- The Ethernet interface obtains an IP address via DHCP automatically on boot.
|
|
- A TCP server listens on port 23 (default) for CLI connections.
|
|
- Connect with any TCP client (e.g. <code>nc</code>, PuTTY) to access the same CLI available over serial.</p>
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["content.action.edit", "content.code.copy", "search.highlight", "search.suggest"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.d7400e89.min.js"></script>
|
|
|
|
<script src="../_javascript/firmware_picker.js"></script>
|
|
|
|
<script src="../_javascript/telemetry_decoder.js"></script>
|
|
|
|
<script src="../_javascript/filter_tool.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |