William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-26 15:30:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme and docs

Browse Source
This commit is contained in:
Mark Qvist 2022-07-02 18:41:57 +02:00
parent 8cff18f8ce
commit fdf0456cf0
7 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,7 +1,7 @@
Reticulum Network Stack β Reticulum Network Stack β
========== ==========
***Please Know!** Reticulum is transitioning to 128-bit address space. The code currently in the master branch is incompatible with the latest release, version 0.3.8. The next release of Reticulum, version 0.3.9, will bring the released version up to compatibility with the source code in this repository. Reticulum version 0.3.9 will not be compatible with any prior releases. Please transition your systems accordingly.* ***Please Know!** Reticulum is transitioning to 128-bit address space. The code currently in the master branch is incompatible with the latest release, version 0.3.8. The next release of Reticulum, version 0.3.9, will bring the released version up to compatibility with the source code in this repository. Reticulum version 0.3.9 will not be compatible with any prior releases. Please transition your systems accordingly. See [this post](https://github.com/markqvist/Reticulum/discussions/75) for more information.*
<p align="center"><img width="200" src="https://unsigned.io/wp-content/uploads/2022/03/reticulum_logo_512.png"></p> <p align="center"><img width="200" src="https://unsigned.io/wp-content/uploads/2022/03/reticulum_logo_512.png"></p>

BIN
docs/Reticulum Manual.pdf
View File

Binary file not shown.

18
docs/manual/_sources/understanding.rst.txt
View File

@ -493,10 +493,10 @@ terms of bandwidth, so it can be used just for a short exchange, and then recrea
also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is
more suitable to the application. The procedure also inserts the *link id* , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this *link id*. more suitable to the application. The procedure also inserts the *link id* , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this *link id*.
The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the The combined bandwidth cost of setting up a link is 3 packets totalling 265 bytes (more info in the
:ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping :ref:`Binary Packet Format<understanding-packetformat>` section). The amount of bandwidth used on keeping
a link open is practically negligible, at 0.62 bits per second. Even on a slow 1200 bits per second packet a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
radio channel, 100 concurrent links will still leave 95% channel capacity for actual data. radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.
Link Establishment in Detail Link Establishment in Detail
@ -795,12 +795,12 @@ Wire Format
wire size counting all fields including headers, wire size counting all fields including headers,
but excluding any interface access codes. but excluding any interface access codes.
- Path Request : 33 bytes - Path Request : 51 bytes
- Announce : 151 bytes - Announce : 157 bytes
- Link Request : 77 bytes - Link Request : 83 bytes
- Link Proof : 77 bytes - Link Proof : 83 bytes
- Link RTT packet : 83 bytes - Link RTT packet : 99 bytes
- Link keepalive : 14 bytes - Link keepalive : 20 bytes
.. _understanding-announcepropagation: .. _understanding-announcepropagation:

4
docs/manual/_sources/whatis.rst.txt
View File

@ -46,9 +46,9 @@ What does Reticulum Offer?
* Efficient link establishment * Efficient link establishment
* Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes * Total bandwidth cost of setting up a link is only 3 packets, totalling 265 bytes
* Low cost of keeping links open at only 0.62 bits per second * Low cost of keeping links open at only 0.44 bits per second
* Reliable and efficient transfer of arbitrary amounts of data * Reliable and efficient transfer of arbitrary amounts of data

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

18
docs/manual/understanding.html
View File

@ -546,10 +546,10 @@ At the same time we establish an efficient encrypted channel. The setup of this
terms of bandwidth, so it can be used just for a short exchange, and then recreated as needed, which will terms of bandwidth, so it can be used just for a short exchange, and then recreated as needed, which will
also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is also rotate encryption keys. The link can also be kept alive for longer periods of time, if this is
more suitable to the application. The procedure also inserts the <em>link id</em> , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this <em>link id</em>.</p> more suitable to the application. The procedure also inserts the <em>link id</em> , a hash calculated from the link request packet, into the memory of forwarding nodes, which means that the communicating nodes can thereafter reach each other simply by referring to this <em>link id</em>.</p>
<p>The combined bandwidth cost of setting up a link is 3 packets totalling 237 bytes (more info in the <p>The combined bandwidth cost of setting up a link is 3 packets totalling 265 bytes (more info in the
<a class="reference internal" href="#understanding-packetformat"><span class="std std-ref">Binary Packet Format</span></a> section). The amount of bandwidth used on keeping <a class="reference internal" href="#understanding-packetformat"><span class="std std-ref">Binary Packet Format</span></a> section). The amount of bandwidth used on keeping
a link open is practically negligible, at 0.62 bits per second. Even on a slow 1200 bits per second packet a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
radio channel, 100 concurrent links will still leave 95% channel capacity for actual data.</p> radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.</p>
<div class="section" id="link-establishment-in-detail"> <div class="section" id="link-establishment-in-detail">
<h4>Link Establishment in Detail<a class="headerlink" href="#link-establishment-in-detail" title="Permalink to this headline"></a></h4> <h4>Link Establishment in Detail<a class="headerlink" href="#link-establishment-in-detail" title="Permalink to this headline"></a></h4>
<p>After exploring the basics of the announce mechanism, finding a path through the network, and an overview <p>After exploring the basics of the announce mechanism, finding a path through the network, and an overview
@ -849,12 +849,12 @@ packet types. The size listed are the complete on-
wire size counting all fields including headers, wire size counting all fields including headers,
but excluding any interface access codes. but excluding any interface access codes.
- Path Request : 33 bytes - Path Request : 51 bytes
- Announce : 151 bytes - Announce : 157 bytes
- Link Request : 77 bytes - Link Request : 83 bytes
- Link Proof : 77 bytes - Link Proof : 83 bytes
- Link RTT packet : 83 bytes - Link RTT packet : 99 bytes
- Link keepalive : 14 bytes - Link keepalive : 20 bytes
</pre></div> </pre></div>
</div> </div>
</div> </div>

4
docs/manual/whatis.html
View File

@ -72,8 +72,8 @@
<li><p>An intuitive and developer-friendly API</p></li> <li><p>An intuitive and developer-friendly API</p></li>
<li><p>Efficient link establishment</p> <li><p>Efficient link establishment</p>
<ul> <ul>
<li><p>Total bandwidth cost of setting up a link is only 3 packets, totalling 237 bytes</p></li> <li><p>Total bandwidth cost of setting up a link is only 3 packets, totalling 265 bytes</p></li>
<li><p>Low cost of keeping links open at only 0.62 bits per second</p></li> <li><p>Low cost of keeping links open at only 0.44 bits per second</p></li>
</ul> </ul>
</li> </li>
<li><p>Reliable and efficient transfer of arbitrary amounts of data</p> <li><p>Reliable and efficient transfer of arbitrary amounts of data</p>