Files
meshcore-open/documentation/regions.md
T
zjs81 aa00a863c3 Refresh documentation and update Dutch translation
Documentation:
- Correct web transport support: USB via Web Serial in Chrome only; no
  BLE or TCP in the browser.
- Fix region scope semantics, routing modes (Auto/Flood/Manual), the
  156-byte DM limit, repeater CLI framing, the guessed-location algorithm,
  radio stats contents and settings labels.
- Add regions, image messages, radio statistics and troubleshooting guides.
- Restore coding conventions, localization workflow, storage scoping and
  transport entry points to CLAUDE.md/AGENTS.md; align build/CI commands.
- Replace the obsolete docs/BLE_PROTOCOL.md with a pointer to the
  maintained protocol reference.

Dutch (nl):
- Translate the 79 missing strings and correct existing mistranslations,
  typos and grammar (e.g. "Uitzoomen", "Handmatig", "Slowaaks", frequency
  range 150-2500 MHz).
- Use consistent terminology and informal "je" throughout; keep mesh terms
  such as repeater, node, flood, hop and advert in English.

Fixes #538
2026-09-27 13:12:23 -07:00

4.1 KiB
Raw Blame History

Regions

Regions limit which configured repeaters forward a channel flood. They are routing scopes, not geographic fences or encryption keys. A region does not create a private channel: recipients still need the channel PSK, and forwarding depends on repeater configuration.

Add and select regions

  1. While connected, open Settings → Regions.
  2. Add a region name manually, or choose Fetch from repeaters and add names from the results. Discovery queries nearby responding repeaters already present in your contacts; an empty result does not prove that no regions exist on the wider mesh.
  3. Manual names accept lowercase letters, digits, and hyphens, up to 30 characters. Use the exact name configured by your local repeater operators.
  4. Choose a Default region to use for channels without their own override. None means the app sets no default scope.
  5. In channel chat, tap the title or landscape icon to select an override. The subtitle shows the effective region, with (default) when inherited.

Tapping the selected region again, or choosing Clear region, removes the channel override. If a default exists, clearing an override falls back to that default; it does not force an unscoped send. With no override and the default set to None, the app sets no scope: the companion's scope override stays cleared ([54, 0]). Since companion firmware v1.15.0, the radio then falls back to its own default flood scope if one is configured on the device. The app does not issue an explicitly unscoped send.

The saved region-name list is global to the app. Default and channel assignments are stored per connected radio identity. Removing a region from the list also clears matching assignments stored for the current radio; it does not change repeater configuration.

Regions displayed on messages

Channel text messages show a region label beside routing metadata when a region is known. The label appears in the message bubble only when the message has path data; message tracing does not otherwise need to be enabled. The message-path screen always shows the known region.

Outgoing messages retain the effective region used when they were sent. Changing a channel or default region does not relabel earlier messages. Region metadata persists with message history; older records may have no region.

Incoming region names are inferred from raw transport-flood packets by testing locally known names (saved regions, channel overrides, and the default). The name is not sent as plain text in the packet. Unknown names, ambiguous matches, and messages without suitable raw transport metadata do not get a region label. foo and #foo are treated as the same candidate for matching.

No label does not prove a message was unscoped. It can mean that its region could not be identified. A region label is routing metadata, not proof of the sender’s location or identity.

Reply using the original region

When you reply to a message with a non-empty known region, the reply banner selects that region by default. Tap its region chip to turn this off; the chip becomes crossed out. Sending then uses the channel’s effective region instead. Canceling the reply clears this temporary choice; it does not change the channel setting.

Example: a channel defaults to arizona, but you reply to a message labeled phoenix. The reply uses phoenix while the reply-region chip is selected. If you cross out the chip, it uses arizona.

If the original message has no known region, the reply uses the channel’s effective region. This behavior applies to channel text replies; it is not a region selector for direct messages or a claim that image messages expose the same region metadata.

Technical reference

Scoped sends temporarily set the companion’s flood scope, send the message, and then clear the scope override (buildSetFloodScopeFrame('')); they do not restore a previously set scope. Channel sends are serialized to prevent another channel from inheriting the temporary setting. Repeaters and companion firmware must support the relevant scope functionality.

See channels, routing paths, and protocol metadata.