MeshCore/Regions - Revision history

Admin: Add hig (Highlands) region

2026-11-03T17:58:52Z

Add hig (Highlands) region

← Older revision		Revision as of 17:58, 3 November 2026
Line 125:		Line 125:
	\| <code>per</code>		\| <code>per</code>
	\| Perth area		\| Perth area
			\|-
			\| <code>hig</code>
			\| Highlands (Inverness area)
	\|-		\|-
	\| <code>ioi</code>		\| <code>ioi</code>
Line 177:		Line 180:
	dun		dun
	per		per
			hig
	sco-admin		sco-admin
	ioi		ioi
Line 184:		Line 188:

	* <code>sco</code> is for Scotland-wide traffic, and <code>sco-admin</code> is a Scotland-only root for bots and utilities.		* <code>sco</code> is for Scotland-wide traffic, and <code>sco-admin</code> is a Scotland-only root for bots and utilities.
	* <code>cen</code>, <code>tay</code>, and <code>~~fif~~</code> are Scottish sub regions.		* <code>cen</code>, <code>tay</code>, <code>fif</code> and <code>hig</code> are Scottish sub regions.
	* <code>edi</code>, <code>gla</code>, <code>fal</code>, <code>sti</code>, <code>dun</code> and <code>per</code> are local areas.		* <code>edi</code>, <code>gla</code>, <code>fal</code>, <code>sti</code>, <code>dun</code> and <code>per</code> are local areas.
	* <code>ioi</code> (Island of Ireland), <code>wls</code> (Wales) and <code>eng-ne</code> (North East England) are peering roots beside <code>sco</code>.		* <code>ioi</code> (Island of Ireland), <code>wls</code> (Wales) and <code>eng-ne</code> (North East England) are peering roots beside <code>sco</code>.

Admin: Tidy callout spacing (remove empty paragraph)

2026-11-03T17:37:36Z

Tidy callout spacing (remove empty paragraph)

← Older revision		Revision as of 17:37, 3 November 2026
Line 9:		Line 9:

	'''NOTE - A Regional Framework was impelemented in the ScotMesh Meshcore Mesh at the beginning of April 2026. This was out of sheer necessity as our mesh was dying under the flood traffic from England (24,000 flood packets & 600+ messages daily). This saved our mesh from descending into a chaotic, unusable mess of incoherent rambles and frustrated messaging failures. This is why an understaning of regions is imperative to understanding where we are today.'''		'''NOTE - A Regional Framework was impelemented in the ScotMesh Meshcore Mesh at the beginning of April 2026. This was out of sheer necessity as our mesh was dying under the flood traffic from England (24,000 flood packets & 600+ messages daily). This saved our mesh from descending into a chaotic, unusable mess of incoherent rambles and frustrated messaging failures. This is why an understaning of regions is imperative to understanding where we are today.'''

	</div>		</div>

Line 64:		Line 63:

	In other words, <code>region put sco </code> is correct, but must be preceeded by <code>region denyf </code> .		In other words, <code>region put sco </code> is correct, but must be preceeded by <code>region denyf </code> .


	</div>		</div>
	The Scottish MeshCore setup does not allow wildcard forwarding. Repeater owners must deny wildcard forwarding with:		The Scottish MeshCore setup does not allow wildcard forwarding. Repeater owners must deny wildcard forwarding with:
Line 207:		Line 204:

	In command line interface (CLI) examples, this means using <code>region denyf *</code>		In command line interface (CLI) examples, this means using <code>region denyf *</code>


	</div>		</div>
	<span id="falkirk-central-scotland-repeater"></span>		<span id="falkirk-central-scotland-repeater"></span>
Line 281:		Line 276:

	Start with [[MeshCore/Repeater Quick Setup\|Repeater Quick Setup]], then come back here for the fuller detail.		Start with [[MeshCore/Repeater Quick Setup\|Repeater Quick Setup]], then come back here for the fuller detail.


	</div>		</div>
	On current firmware (1.16+) the whole region tree goes in one <code>region def</code> line, followed by <code>region denyf *</code> and the standard <code>set</code> commands. The easiest way to get the exact script for your area is the [https://meshcore.scotmesh.net/repeater/ ScotMesh repeater builder]; the examples below show what it produces.		On current firmware (1.16+) the whole region tree goes in one <code>region def</code> line, followed by <code>region denyf *</code> and the standard <code>set</code> commands. The easiest way to get the exact script for your area is the [https://meshcore.scotmesh.net/repeater/ ScotMesh repeater builder]; the examples below show what it produces.
Line 330:		Line 323:

	Without a default scope, adverts sent by your repeater go out unscoped. Because the Scottish network uses <code>region denyf *</code>, other repeaters will reject those unscoped adverts and will never learn your repeater exists. Setting the default scope to <code>sco</code> ensures your adverts are carried normally across the mesh.		Without a default scope, adverts sent by your repeater go out unscoped. Because the Scottish network uses <code>region denyf *</code>, other repeaters will reject those unscoped adverts and will never learn your repeater exists. Setting the default scope to <code>sco</code> ensures your adverts are carried normally across the mesh.


	</div>		</div>
	This is separate from flood forwarding permissions. For more detail, see [https://blog.meshcore.io/2026/04/17/default-scope Default Scope Region].		This is separate from flood forwarding permissions. For more detail, see [https://blog.meshcore.io/2026/04/17/default-scope Default Scope Region].

Admin: Improve rendering + apply freshness fixes (regions/scopes/CLI to current)

2026-11-03T17:21:48Z

Improve rendering + apply freshness fixes (regions/scopes/CLI to current)

Show changes

Admin: Import MeshCore content from scotmesh-wiki (faithful; freshness pass next)

2026-11-03T17:06:17Z

Import MeshCore content from scotmesh-wiki (faithful; freshness pass next)

New page

{{DISPLAYTITLE:Regions}}

== MeshCore Regions ==

-----

<blockquote><span id="note---a-regional-framework-was-impelemented-in-the-scotmesh-meshcore-mesh-at-the-beginning-of-april-2026.-this-was-out-of-sheer-necessity-as-our-mesh-was-dying-under-the-flood-traffic-from-england-24000-flood-packets-600-messages-daily.-this-saved-our-mesh-from-descending-into-a-chaotic-unusable-mess-of-incoherent-rambles-and-frustrated-messaging-failures.-this-is-why-an-understaning-of-regions-is-imperative-to-understanding-where-we-are-today">
==== NOTE - A Regional Framework was impelemented in the ScotMesh Meshcore Mesh at the beginning of April 2026. This was out of sheer necessity as our mesh was dying under the flood traffic from England (24,000 flood packets & 600+ messages daily). This saved our mesh from descending into a chaotic, unusable mess of incoherent rambles and frustrated messaging failures. This is why an understaning of regions is imperative to understanding where we are today ====
</blockquote>

-----

This guide is for '''repeater owners'''.

The aim is simple: keep the scheme readable, predictable, and usable as the network grows.


=== Why regions are needed ===

MeshCore messages travel through repeaters for onward routing. Whilst this is the core function, if every repeater carries every message everywhere, the network becomes noisy, inefficient and flooded with uneccessary traffic.

Regions help us:

# '''Keep local traffic local''' 
In the future, a message that only matters in one area wont always need to be repeated across every part of Scotland.
# '''Reduce unnecessary radio traffic''' 
LoRa is subject to a finite airtime cycle per hour (compared with Wi-Fi or mobile data), so every avoidable repeat uses valuable airtime.
# '''Improve reliability''' 
Less unnecessary repeating leaves more room for useful messages.
# '''Make planning clearer''' 
Regions make repeater deployment easier to map, identify needs, plan future expansion and ease of ongoing mesh maintenance.
# '''Support controlled peering''' 
Strategic repeaters can deliberately carry neighbouring traffic, such as the '''IOI peering agreement''' between Scotland and the Island of Ireland.


=== Regions and scopes ===

There are two related concepts: '''regions''' and '''scopes'''.

{| class="wikitable"
|-
! Term
! Meaning
! Example
|-
| '''Region'''
| A label configured on a repeater to describe the area it serves.
| An Edinburgh-area repeater includes <code>edi</code>.
|-
| '''Scope'''
| A label applied to messages or channels to describe which area (or region) the traffic is intended to travel.
| The <code>#glasgow</code> channel might use <code>gla</code> when traffic should stay in that area.
|}

In a densely populated mesh, a repeater should only carry scoped traffic for regions it genuinely serves. In new or embryonic meshes, this requirment will be a future need but best practise planning mandates introducing regions as early as is practical.


=== Wildcard forwarding is not allowed (see info box at top of this document for context). ===

The wildcard marker is:

<syntaxhighlight lang="text">*</syntaxhighlight>
<div class="sm-cx sm-cx-warning">

The important rule is: <code>*</code> will appear as a root parent in the region tree, but wildcard forwarding must be denied.

In other words, <code>region put sco *</code> is correct, but must be preceeded by <code>region denyf *</code> .

</div>
The Scottish MeshCore setup does not allow wildcard forwarding. Repeater owners must deny wildcard forwarding with:

<syntaxhighlight lang="text">region denyf *</syntaxhighlight>
You may still see <code>*</code> as the root parent when defining the region tree, for example <code>region put sco *</code>. That is different from allowing wildcard forwarding.

For channel names and suggested scopes, see [[MeshCore/Channels|Channels]].


=== Scottish region code approach ===

For Scotland, we use simple three-letter lowercase codes.

We are not part of any UK wide mesh (for context see comment box at the top of this documnet) Therefore, '''we are not using any long prefixed names'''

We use short codes such as:

<syntaxhighlight lang="text">sco
cen
fal</syntaxhighlight>
Other countries and communities may use ISO-style hierarchical codes. That is valid for them, but the Scottish convention is designed to be short and easy to read in apps, analyser tools, and community discussions.


=== Current (June 2026) Agreed region codes ===

{| class="wikitable"
|-
! Code
! Area
|-
| <code>sco</code>
| Scotland
|-
| <code>cen</code>
| Central Scotland
|-
| <code>fif</code>
| Fife
|-
| <code>tay</code>
| Tayside
|-
| <code>gla</code>
| Glasgow area
|-
| <code>edi</code>
| Edinburgh area
|-
| <code>fal</code>
| Falkirk area
|-
| <code>dun</code>
| Dundee area
|-
| <code>per</code>
| Perth area
|-
| <code>ang</code>
| Angus area
|-
| <code>ioi</code>
| Island of Ireland (<code>ioi</code>) — IOI peering
|}


=== IOI peering agreement ===

The Scottish and Irish MeshCore communities maintain a '''peering agreement''': scoped traffic is carried on the other network only where '''both''' sides configure for it.

Under that agreement, Scottish repeaters add the <code>ioi</code> region alongside <code>sco</code> where the Scottish baseline applies, and Island of Ireland repeaters add <code>sco</code> alongside their own region codes in the same spirit. Messages with matching '''scopes''' can then move between the two networks predictably, without relying on wildcard forwarding. For example channel names and typical scopes, see [[MeshCore/Channels|Channels]].

The <code>ioi</code> code is '''not''' a Scottish local region. It marks repeaters and traffic that deliberately participate in that peering.

Do not use:

<syntaxhighlight lang="text">ioi-sco</syntaxhighlight>
Use:

<syntaxhighlight lang="text">ioi</syntaxhighlight>

==== Peering with Scotland (other regions) ====

If another region wants to peer with Scotland in a similar way, they should already have the following in place:

# '''Wildcard flooding disallowed''' on their repeaters (the same principle as the Scottish setup: deny wildcard forwarding with <code>region denyf *</code>; see [[#wildcard-forwarding-is-not-allowed|Wildcard forwarding is not allowed]]).
# '''Appropriate regions on their repeaters''' so traffic is not forwarded wider than intended, and Scottish repeaters are not flooded with scoped traffic they did not agree to carry.
# '''Neighbouring Scotland in RF terms''' so equipment can '''directly''' peer, rather than assuming long unofficial relay chains.

When that fits your situation, contact the Scottish Mesh community on [https://discord.gg/ytxfyuDmSt Discord] so we can discuss scope names, boundaries, and a safe rollout.


=== Recommended hierarchy ===

Although the hierarchy is not written into the code itself, it can be thought of like this:

<syntaxhighlight lang="text">sco
cen
fal
edi
gla
fif
tay
dun
per
ang
ioi</syntaxhighlight>
In plain English:

* <code>sco</code> is for Scotland-wide traffic.
* <code>tay</code>, <code>cen</code>, and <code>fif</code> are Scottish sub regions.
* <code>fal</code>, <code>edi</code>, <code>gla</code>, <code>dun</code>, <code>per</code> and <code>ang</code> are local areas.
* <code>ioi</code> is for the Island of Ireland under the IOI peering agreement.


=== Suggested repeater configuration policy ===

A Scottish repeater should normally be configured with:

# The country code <code>sco</code>.
# The <code>ioi</code> code for IOI peering.
# The relevant regional code.
# The relevant local code, if appropriate.
# Any neighbouring codes that the repeater genuinely serves.

<div class="sm-cx sm-cx-warning">

Do not allow wildcard forwarding.

In command line interface (CLI) examples, this means using <code>region denyf *</code>

</div>

==== Falkirk / Central Scotland repeater ====

A repeater covering the Falkirk area would usually have:

<syntaxhighlight lang="text">sco
ioi
cen
fal</syntaxhighlight>

==== Edinburgh-facing Central Scotland repeater ====

A repeater that mainly serves Central Scotland but has strong coverage towards Edinburgh might use:

<syntaxhighlight lang="text">sco
ioi
cen
edi</syntaxhighlight>

==== Fife repeater ====

A Fife repeater would usually have:

<syntaxhighlight lang="text">sco
ioi
fif</syntaxhighlight>
If it genuinely provides useful Central Scotland coverage, it may also include:

<syntaxhighlight lang="text">cen</syntaxhighlight>

==== Scottish repeaters and <code>ioi</code> ====

Scottish repeaters should normally include <code>ioi</code> alongside <code>sco</code> as part of the [[#ioi-peering-agreement|IOI peering agreement]]:

<syntaxhighlight lang="text">sco
ioi</syntaxhighlight>
That keeps peering-capable forwarding available where the Scottish baseline is configured. It does not make <code>ioi</code> a Scottish local region.


=== Good practice for repeater owners ===

Use lowercase region codes. Do not use mixed case such as <code>SCO</code>, <code>Cen</code>, or <code>FAL</code>.

Use agreed codes. For example, use <code>edi</code> for the Edinburgh area, not <code>edn</code>, <code>edinburgh</code>, or <code>gb-edi</code>.

Add only the areas your repeater genuinely serves. A high-site repeater may reasonably serve several areas, but a repeater should not claim every region just because it can occasionally hear distant nodes.

Coordinate before adding new codes. If a new area needs a code, discuss it publicly before using it so that the community does not end up with competing names for the same place.


=== Suggested command examples ===

The exact method may vary depending on firmware version and whether you are using the app, web configurator, USB serial, or remote administration. The upstream reference is the MeshCore [https://docs.meshcore.io/cli_commands/ CLI Commands] documentation, especially the region management commands.

<div class="sm-cx sm-cx-info">

New to repeater setup?

Start with [[MeshCore/Repeater Quick Setup|Repeater Quick Setup]], then come back here for the fuller detail.

</div>
For a Central Scotland / Falkirk repeater, the setup may look conceptually like this:

<syntaxhighlight lang="text">region put sco *
region put ioi *
region put cen sco
region put fal cen

region allowf sco
region allowf ioi
region allowf cen
region allowf fal

region denyf *

region default sco

region save</syntaxhighlight>
Then check the result with:

<syntaxhighlight lang="text">region</syntaxhighlight>
For a Tayside / Dundee repeater:

<syntaxhighlight lang="text">region put sco *
region put ioi *
region put tay sco
region put dun tay

region allowf sco
region allowf ioi
region allowf tay
region allowf dun

region denyf *

region default sco

region save</syntaxhighlight>
For a Glasgow-area repeater:

<syntaxhighlight lang="text">region put sco *
region put ioi *
region put gla sco

region allowf sco
region allowf ioi
region allowf gla

region denyf *

region default sco

region save</syntaxhighlight>
For a repeater that serves Scotland, Central Scotland, Glasgow, Edinburgh, and IOI peering (<code>ioi</code>):

<syntaxhighlight lang="text">region put sco *
region put cen sco
region put gla cen
region put edi cen
region put ioi *

region allowf sco
region allowf cen
region allowf gla
region allowf edi
region allowf ioi

region denyf *

region default sco

region save</syntaxhighlight>
On firmware that supports default scope, repeater and room server administrators should also set the default scope for packets that originate from that node:

<syntaxhighlight lang="text">region default sco</syntaxhighlight>
<div class="sm-cx sm-cx-warning">

'''Set <code>region default sco</code> on your repeater.'''

Without a default scope, adverts sent by your repeater go out unscoped. Because the Scottish network uses <code>region denyf *</code>, other repeaters will reject those unscoped adverts and will never learn your repeater exists. Setting the default scope to <code>sco</code> ensures your adverts are carried normally across the mesh.

</div>
This is separate from flood forwarding permissions. For more detail, see [https://blog.meshcore.io/2026/04/17/default-scope Default Scope Region].

Always check for an <code>OK</code> response where applicable, and remember to save the configuration so it survives a reboot.


=== Firmware and app version notes ===

Region and scope support depends on MeshCore firmware and app support.

Use the latest stable MeshCore firmware and app available for your device. Older firmware may still pass some traffic, but region management and scope handling may not behave as expected.

MeshCore region filtering was introduced across firmware and app releases, and default scope support was added later. The MeshCore posts [https://blog.meshcore.io/2026/01/20/region-filtering Region Filtering] and [https://blog.meshcore.io/2026/04/17/default-scope Default Scope Region] are useful background when checking version behaviour.


=== Naming and publishing new region codes ===

When a new Scottish area needs a code, use these rules:

# Use three lowercase letters.
# Make the code obvious to local users.
# Avoid clashing with existing agreed codes.
# Avoid overly small areas unless there is a real need.
# Discuss the code with the local MeshCore community before publishing it.

Examples of possible future codes might include:

<syntaxhighlight lang="text">sti = Stirling
liv = Livingston
abe = Aberdeen
inv = Inverness
ayr = Ayrshire
bor = Borders</syntaxhighlight>
These are examples only and should not be treated as agreed until the community confirms them.


=== Common questions ===


==== Do regions replace normal MeshCore messaging? ====

No. Regions help control where scoped traffic is repeated.


==== Should every Scottish repeater have <code>sco</code> and <code>ioi</code>? ====

Yes, that is the recommended baseline for Scottish repeaters. Use <code>sco</code> for Scotland and add <code>ioi</code> alongside it for the IOI peering agreement.


==== Should every repeater have every Scottish region? ====

No. That would defeat the purpose of regions. Repeaters should only list the areas they genuinely serve.


==== Should we use <code>gb-sco</code> instead of <code>sco</code>? ====

Not for this Scottish scheme. Some wider UK or international guides use ISO-style codes, but the local Scottish agreement is to use short three-letter codes.


==== Can a repeater be in more than one region? ====

Yes. That is useful for high sites, border areas, or repeaters that genuinely link neighbouring areas.


==== Can we allow <code>*</code> for compatibility? ====

No. The Scottish MeshCore setup does not allow wildcard forwarding. Use the correct region scope instead.


=== Summary ===

Regions give the Scottish MeshCore community a simple way to organise the network as it grows.

Our agreed approach is:

* Use three-letter lowercase codes.
* Use <code>sco</code> for Scotland.
* Add <code>ioi</code> wherever the Scottish baseline <code>sco</code> is configured (IOI peering).
* Use <code>cen</code>, <code>tay</code>, <code>gla</code>, and <code>fif</code> for major regions where they match coverage.
* Use <code>fal</code>, <code>edi</code>, <code>gla</code>, <code>dun</code>, and <code>per</code> for local areas.
* Use <code>ioi</code> for Island of Ireland traffic under the IOI peering agreement.
* Deny wildcard forwarding with <code>region denyf *</code>.
* Do not use long prefixes such as <code>gb-sco</code> or <code>sco-fal</code> in this local scheme.

This gives us a clean, readable, and expandable foundation for building a coordinated Scottish MeshCore network.