dandri/MeshCore
1
0
Fork 0
mirror of https://github.com/meshcore-dev/MeshCore.git synced 2026-03-30 14:55:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 467959cc3b

Browse Source
This commit is contained in:
ripplebiz
2026-03-20 01:33:35 +00:00
parent b0a86d1cfc
commit d2aa912e1a
16 changed files with 132 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@@ -17,7 +17,7 @@
<link rel="icon" href="/meshcore/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

35
cli_commands/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
@@ -1330,17 +1330,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#view-the-bridge-source" class="md-nav__link">
<span class="md-ellipsis">
View the bridge source
</span>
</a>
</li>
<li class="md-nav__item">
@@ -2785,17 +2774,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#view-the-bridge-source" class="md-nav__link">
<span class="md-ellipsis">
View the bridge source
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3264,7 +3242,12 @@
- <code>get af</code>
- <code>set af &lt;value&gt;</code></p>
<p><strong>Parameters:</strong>
- <code>value</code>: Airtime factor (0-9)</p>
- <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<br />
Yyou 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>
@@ -3535,10 +3518,6 @@ region save
- <code>state</code>: <code>on</code>|<code>off</code></p>
<p><strong>Default:</strong> <code>off</code></p>
<hr />
<h4 id="view-the-bridge-source">View the bridge source</h4>
<p><strong>Usage:</strong>
- <code>get bridge.source</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>

2
companion_protocol/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
docs/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
faq/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
index.html
View File

@@ -21,7 +21,7 @@
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
kiss_modem_protocol/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
nrf52_power_management/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

107
packet_format/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
@@ -517,6 +517,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-length-encoding" class="md-nav__link">
<span class="md-ellipsis">
Path Length Encoding
</span>
</a>
</li>
<li class="md-nav__item">
@@ -731,6 +742,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#path-length-encoding" class="md-nav__link">
<span class="md-ellipsis">
Path Length Encoding
</span>
</a>
</li>
<li class="md-nav__item">
@@ -841,10 +863,21 @@
<li><code>transport_code_2</code> - 2 bytes - <code>uint16_t</code> - reserved</li>
</ul>
</li>
<li><code>path_length</code> - 1 byte - Length of the path field in bytes</li>
<li><code>path</code> - size provided by <code>path_length</code> - Path to use for Direct Routing<ul>
<li><code>path_length</code> - 1 byte - Encoded path metadata<ul>
<li>Bits 0-5 store path hash count / hop count (<code>0-63</code>)</li>
<li>Bits 6-7 store path hash size minus 1<ul>
<li><code>0b00</code>: 1-byte path hashes</li>
<li><code>0b01</code>: 2-byte path hashes</li>
<li><code>0b10</code>: 3-byte path hashes</li>
<li><code>0b11</code>: reserved / unsupported</li>
</ul>
</li>
</ul>
</li>
<li><code>path</code> - <code>hop_count * hash_size</code> bytes - Path to use for Direct Routing or flood path tracking<ul>
<li>Up to a maximum of 64 bytes, defined by <code>MAX_PATH_SIZE</code></li>
<li>v1.12.0 firmware and older drops packets with <code>path_length</code> <a href="https://github.com/meshcore-dev/MeshCore/blob/e812632235274ffd2382adf5354168aec765d416/src/Dispatcher.cpp#L144">larger than 64</a></li>
<li>Effective byte length is calculated from the encoded hop count and hash size, not taken directly from <code>path_length</code></li>
<li>v1.12.0 firmware and older only handled legacy 1-byte path hashes and dropped packets whose path bytes exceeded <a href="https://github.com/meshcore-dev/MeshCore/blob/e812632235274ffd2382adf5354168aec765d416/src/Dispatcher.cpp#L144">64 bytes</a></li>
</ul>
</li>
<li><code>payload</code> - variable length - Payload Data<ul>
@@ -878,12 +911,12 @@
<tr>
<td>path_length</td>
<td>1</td>
<td>Length of the path field in bytes</td>
<td>Encodes path hash size in bits 6-7 and hop count in bits 0-5</td>
</tr>
<tr>
<td>path</td>
<td>up to 64 (<code>MAX_PATH_SIZE</code>)</td>
<td>Stores the routing path if applicable</td>
<td>Stores <code>hop_count * hash_size</code> bytes of path data if applicable</td>
</tr>
<tr>
<td>payload</td>
@@ -959,6 +992,68 @@
</tr>
</tbody>
</table>
<h3 id="path-length-encoding">Path Length Encoding</h3>
<p><code>path_length</code> is not a raw byte count. It packs both hash size and hop count:</p>
<table>
<thead>
<tr>
<th>Bits</th>
<th>Field</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td>0-5</td>
<td>Hop Count</td>
<td>Number of path hashes (<code>0-63</code>)</td>
</tr>
<tr>
<td>6-7</td>
<td>Hash Size Code</td>
<td>Stored as <code>hash_size - 1</code></td>
</tr>
</tbody>
</table>
<p>Hash size codes:</p>
<table>
<thead>
<tr>
<th>Bits 6-7</th>
<th>Hash Size</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>0b00</code></td>
<td>1 byte</td>
<td>Legacy / default mode</td>
</tr>
<tr>
<td><code>0b01</code></td>
<td>2 bytes</td>
<td>Supported in current firmware</td>
</tr>
<tr>
<td><code>0b10</code></td>
<td>3 bytes</td>
<td>Supported in current firmware</td>
</tr>
<tr>
<td><code>0b11</code></td>
<td>4 bytes</td>
<td>Reserved / invalid</td>
</tr>
</tbody>
</table>
<p>Examples:</p>
<ul>
<li><code>0x00</code>: zero-hop packet, no path bytes</li>
<li><code>0x05</code>: 5 hops using 1-byte hashes, so path is 5 bytes</li>
<li><code>0x45</code>: 5 hops using 2-byte hashes, so path is 10 bytes</li>
<li><code>0x8A</code>: 10 hops using 3-byte hashes, so path is 30 bytes</li>
</ul>
<h3 id="payload-types">Payload Types</h3>
<table>
<thead>

2
payloads/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
qr_codes/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
search/search_index.json
View File

File diff suppressed because one or more lines are too long

24
sitemap.xml
View File

@@ -2,50 +2,50 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://meshcore-dev.github.io/meshcore/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/cli_commands/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/companion_protocol/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/docs/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/faq/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/kiss_modem_protocol/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/nrf52_power_management/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/packet_format/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/payloads/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/qr_codes/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/stats_binary_frames/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
<url>
<loc>https://meshcore-dev.github.io/meshcore/terminal_chat_cli/</loc>
<lastmod>2026-03-12</lastmod>
<lastmod>2026-03-20</lastmod>
</url>
</urlset>

BIN
sitemap.xml.gz
View File

Binary file not shown.

2
stats_binary_frames/index.html
View File

@@ -23,7 +23,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">

2
terminal_chat_cli/index.html
View File

@@ -21,7 +21,7 @@
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.5">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">