Skip to content

Commit 2fe9dec

Browse files
committed
Updated documentation
1 parent 8f8da08 commit 2fe9dec

File tree

5 files changed

+42
-40
lines changed

5 files changed

+42
-40
lines changed

docs/Reticulum Manual.pdf

44 Bytes
Binary file not shown.

docs/manual/_sources/hardware.rst.txt

+14-13
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ starting from scratch.
2424
This chapter will outline a few different sensible starting paths to get
2525
real-world functional wireless communications up and running with minimal cost
2626
and effort. Two fundamental devices categories will be covered, *RNodes* and
27-
*WiFi-based radios*. While there are many other device categories that are
28-
useful in building Reticulum networks, knowing how to just employ these two
29-
will make it possible to build a wide range of useful networks with little
30-
effort.
27+
*WiFi-based radios*.
28+
29+
While there are many other device categories that are useful in building Reticulum
30+
networks, knowing how to employ just these two will make it possible to build
31+
a wide range of useful networks with little effort.
3132

3233
.. _rnode-main:
3334

@@ -39,30 +40,30 @@ commonly either very expensive, difficult to set up and operate, hard to source,
3940
power-hungry, or all of the above at the same time. In an attempt to alleviate
4041
this situation, the transceiver system *RNode* was designed. It is important to
4142
note that RNode is not one specific device, from one particular vendor, but
42-
*an open plaform* that anyone can use to build digital transceivers suited to
43-
their needs and particular situations.
43+
*an open plaform* that anyone can use to build interoperable digital transceivers
44+
suited to their needs and particular situations.
4445

4546
An RNode is a general purpose, interoperable, low-power and long-range, reliable,
4647
open and flexible radio communications device. Depending on its components, it can
4748
operate on many different frequency bands, and use many different modulation
4849
schemes, but most commonly, and for the purposes of this chapter, we will limit
4950
the discussion to RNodes using *LoRa* modulation in common ISM bands.
5051

51-
**Avoid Confusion!** An RNode can use LoRa as a *physical-layer modulation*, but it
52+
**Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it
5253
does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly
53-
used for IoT devices. RNodes use *raw LoRa modulation*, without any additional
54-
protocol overhead. All high-level protocol funcionality is handled directly by
55-
Reticulum.
54+
used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without
55+
any additional protocol overhead. All high-level protocol funcionality is handled
56+
directly by Reticulum.
5657

5758
.. _rnode-creating:
5859

5960
Creating RNodes
6061
^^^^^^^^^^^^^^^
6162
RNode has been designed as a system that is easy to replicate across time and
6263
space. You can put together a functioning transceiver using commonly available
63-
components, and a few software tools. While you can design and build RNodes
64+
components, and a few open source software tools. While you can design and build RNodes
6465
completely from scratch, to your exact desired specifications, this chapter
65-
will explain the easiest possible approach to creating RNodes, which is using common
66+
will explain the easiest possible approach to creating RNodes: Using common
6667
LoRa development boards. This approach can be boiled down to two simple steps:
6768

6869
1. Obtain one or more supported development boards
@@ -237,7 +238,7 @@ networks running concurrently on such devices.
237238
Combining Hardware Types
238239
========================
239240

240-
It is a useful tool to combine different link and hardware types when designing and
241+
It is useful to combine different link and hardware types when designing and
241242
building a network. One useful design pattern is to employ high-capacity point-to-point
242243
links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
243244
for the network backbone, and using LoRa-based RNodes for covering large areas with

docs/manual/hardware.html

+13-13
Original file line numberDiff line numberDiff line change
@@ -60,36 +60,36 @@ <h3>Navigation</h3>
6060
<p>This chapter will outline a few different sensible starting paths to get
6161
real-world functional wireless communications up and running with minimal cost
6262
and effort. Two fundamental devices categories will be covered, <em>RNodes</em> and
63-
<em>WiFi-based radios</em>. While there are many other device categories that are
64-
useful in building Reticulum networks, knowing how to just employ these two
65-
will make it possible to build a wide range of useful networks with little
66-
effort.</p>
63+
<em>WiFi-based radios</em>.</p>
64+
<p>While there are many other device categories that are useful in building Reticulum
65+
networks, knowing how to employ just these two will make it possible to build
66+
a wide range of useful networks with little effort.</p>
6767
<div class="section" id="rnode">
6868
<span id="rnode-main"></span><h2>RNode<a class="headerlink" href="#rnode" title="Permalink to this headline"></a></h2>
6969
<p>Reliable and general-purpose long-range digital radio transceiver systems are
7070
commonly either very expensive, difficult to set up and operate, hard to source,
7171
power-hungry, or all of the above at the same time. In an attempt to alleviate
7272
this situation, the transceiver system <em>RNode</em> was designed. It is important to
7373
note that RNode is not one specific device, from one particular vendor, but
74-
<em>an open plaform</em> that anyone can use to build digital transceivers suited to
75-
their needs and particular situations.</p>
74+
<em>an open plaform</em> that anyone can use to build interoperable digital transceivers
75+
suited to their needs and particular situations.</p>
7676
<p>An RNode is a general purpose, interoperable, low-power and long-range, reliable,
7777
open and flexible radio communications device. Depending on its components, it can
7878
operate on many different frequency bands, and use many different modulation
7979
schemes, but most commonly, and for the purposes of this chapter, we will limit
8080
the discussion to RNodes using <em>LoRa</em> modulation in common ISM bands.</p>
81-
<p><strong>Avoid Confusion!</strong> An RNode can use LoRa as a <em>physical-layer modulation</em>, but it
81+
<p><strong>Avoid Confusion!</strong> RNodes can use LoRa as a <em>physical-layer modulation</em>, but it
8282
does not use, and has nothing to do with the <em>LoRaWAN</em> protocol and standard, commonly
83-
used for IoT devices. RNodes use <em>raw LoRa modulation</em>, without any additional
84-
protocol overhead. All high-level protocol funcionality is handled directly by
85-
Reticulum.</p>
83+
used for centrally controlled IoT devices. RNodes use <em>raw LoRa modulation</em>, without
84+
any additional protocol overhead. All high-level protocol funcionality is handled
85+
directly by Reticulum.</p>
8686
<div class="section" id="creating-rnodes">
8787
<span id="rnode-creating"></span><h3>Creating RNodes<a class="headerlink" href="#creating-rnodes" title="Permalink to this headline"></a></h3>
8888
<p>RNode has been designed as a system that is easy to replicate across time and
8989
space. You can put together a functioning transceiver using commonly available
90-
components, and a few software tools. While you can design and build RNodes
90+
components, and a few open source software tools. While you can design and build RNodes
9191
completely from scratch, to your exact desired specifications, this chapter
92-
will explain the easiest possible approach to creating RNodes, which is using common
92+
will explain the easiest possible approach to creating RNodes: Using common
9393
LoRa development boards. This approach can be boiled down to two simple steps:</p>
9494
<ol class="arabic simple">
9595
<li><p>Obtain one or more supported development boards</p></li>
@@ -228,7 +228,7 @@ <h2>WiFi-based Hardware<a class="headerlink" href="#wifi-based-hardware" title="
228228
</div>
229229
<div class="section" id="combining-hardware-types">
230230
<h2>Combining Hardware Types<a class="headerlink" href="#combining-hardware-types" title="Permalink to this headline"></a></h2>
231-
<p>It is a useful tool to combine different link and hardware types when designing and
231+
<p>It is useful to combine different link and hardware types when designing and
232232
building a network. One useful design pattern is to employ high-capacity point-to-point
233233
links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
234234
for the network backbone, and using LoRa-based RNodes for covering large areas with

docs/manual/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/source/hardware.rst

+14-13
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,11 @@ starting from scratch.
2424
This chapter will outline a few different sensible starting paths to get
2525
real-world functional wireless communications up and running with minimal cost
2626
and effort. Two fundamental devices categories will be covered, *RNodes* and
27-
*WiFi-based radios*. While there are many other device categories that are
28-
useful in building Reticulum networks, knowing how to just employ these two
29-
will make it possible to build a wide range of useful networks with little
30-
effort.
27+
*WiFi-based radios*.
28+
29+
While there are many other device categories that are useful in building Reticulum
30+
networks, knowing how to employ just these two will make it possible to build
31+
a wide range of useful networks with little effort.
3132

3233
.. _rnode-main:
3334

@@ -39,30 +40,30 @@ commonly either very expensive, difficult to set up and operate, hard to source,
3940
power-hungry, or all of the above at the same time. In an attempt to alleviate
4041
this situation, the transceiver system *RNode* was designed. It is important to
4142
note that RNode is not one specific device, from one particular vendor, but
42-
*an open plaform* that anyone can use to build digital transceivers suited to
43-
their needs and particular situations.
43+
*an open plaform* that anyone can use to build interoperable digital transceivers
44+
suited to their needs and particular situations.
4445

4546
An RNode is a general purpose, interoperable, low-power and long-range, reliable,
4647
open and flexible radio communications device. Depending on its components, it can
4748
operate on many different frequency bands, and use many different modulation
4849
schemes, but most commonly, and for the purposes of this chapter, we will limit
4950
the discussion to RNodes using *LoRa* modulation in common ISM bands.
5051

51-
**Avoid Confusion!** An RNode can use LoRa as a *physical-layer modulation*, but it
52+
**Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it
5253
does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly
53-
used for IoT devices. RNodes use *raw LoRa modulation*, without any additional
54-
protocol overhead. All high-level protocol funcionality is handled directly by
55-
Reticulum.
54+
used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without
55+
any additional protocol overhead. All high-level protocol funcionality is handled
56+
directly by Reticulum.
5657

5758
.. _rnode-creating:
5859

5960
Creating RNodes
6061
^^^^^^^^^^^^^^^
6162
RNode has been designed as a system that is easy to replicate across time and
6263
space. You can put together a functioning transceiver using commonly available
63-
components, and a few software tools. While you can design and build RNodes
64+
components, and a few open source software tools. While you can design and build RNodes
6465
completely from scratch, to your exact desired specifications, this chapter
65-
will explain the easiest possible approach to creating RNodes, which is using common
66+
will explain the easiest possible approach to creating RNodes: Using common
6667
LoRa development boards. This approach can be boiled down to two simple steps:
6768

6869
1. Obtain one or more supported development boards
@@ -237,7 +238,7 @@ networks running concurrently on such devices.
237238
Combining Hardware Types
238239
========================
239240

240-
It is a useful tool to combine different link and hardware types when designing and
241+
It is useful to combine different link and hardware types when designing and
241242
building a network. One useful design pattern is to employ high-capacity point-to-point
242243
links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
243244
for the network backbone, and using LoRa-based RNodes for covering large areas with

0 commit comments

Comments
 (0)