From 44c7023878ff4bd2e29e97fb4fbccf7479881fcf Mon Sep 17 00:00:00 2001 From: Dale Ruane Date: Tue, 14 Apr 2026 10:30:19 +0100 Subject: [PATCH] docs: document region auto-tagging controls and home-region selection Adds CLI reference entries for the new region.autotag and region.autotag.max.hops settings, and expands the region home documentation with guidance on how to choose a home region so that auto-tagged flood packets are scoped correctly. Also notes the reserved TRANSPORT_CODE_ALL (0xFFFF) bypass behaviour. --- docs/cli_commands.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/cli_commands.md b/docs/cli_commands.md index aac54538..7869f028 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -712,6 +712,36 @@ This document provides an overview of CLI commands that can be sent to MeshCore **Parameters:** - `name`: Region name +**Note:** The home region is used by the auto-tag feature (see `region.autotag` below) to stamp a transport code onto untagged flood packets this repeater receives, converting them from `ROUTE_TYPE_FLOOD` to `ROUTE_TYPE_TRANSPORT_FLOOD`. When selecting a home region, choose the **most specific region in the local region hierarchy that includes all nodes this repeater can possibly hear** (including via hops you intend to cover — see `region.autotag.max.hops`). Choosing a home region that is too narrow will cause unscoped packets originating from neighbouring regions to be tagged incorrectly; choosing one that is too broad defeats the purpose of scoping. + +--- + +#### View or change whether this repeater auto-tags untagged flood packets +**Usage:** +- `get region.autotag` +- `set region.autotag ` + +**Parameters:** +- `state`: `on` (enable) or `off` (disable) + +**Default:** `off` + +**Note:** When enabled, the repeater stamps its home region's transport code onto untagged flood packets (`ROUTE_TYPE_FLOOD`) it receives, converting them to `ROUTE_TYPE_TRANSPORT_FLOOD` before re-broadcast. This provides VLAN-style scoping of legacy / un-scoped traffic, but requires a home region to be configured (see `region home`). Because mis-tagging is possible when the repeater can hear traffic originating outside its home region, this feature is opt-in. See also `region.autotag.max.hops` to limit how far a packet may have travelled before becoming eligible for auto-tagging. The reserved transport code `0xFFFF` (TRANSPORT_CODE_ALL) is always forwarded regardless of local region configuration, allowing explicit mesh-wide flooding when a sender requests it. + +--- + +#### View or change the max hop count for auto-tagging +**Usage:** +- `get region.autotag.max.hops` +- `set region.autotag.max.hops ` + +**Parameters:** +- `value`: Maximum path hash count (0-8). `0` means only auto-tag packets received directly (zero-hop); higher values also auto-tag packets that already traversed that many repeaters. + +**Default:** `1` + +**Note:** Only applies when `region.autotag` is `on`. Keep this small (0-2) unless you are certain no untagged / older-firmware repeaters exist within that many hops, otherwise distant-origin traffic forwarded through them may be tagged with the wrong region. + --- #### Create a new region