Mirrors
/
ARDEN-documentation
mirror of https://github.com/aredn/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add descriptions for new UI features 

Add descriptions for new UI features and make minor formatting changes 
to several pages for spacing around in-line images.
This commit is contained in:
Steve Lewis AB7PA 2022-03-13 09:44:06 -07:00 committed by WU2S
parent 60dcec5c5f
commit 6e633ed006
27 changed files with 131 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
appendix/freq_charts.rst
View File

@ -7,3 +7,5 @@ Example US frequencies and channels that are available for AREDN |trade| network
.. image:: ../_images/AREDN-bands.png
:alt: AREDN bands and channels
:align: center
|

BIN
arednGettingStarted/_images/advConfig-alerts.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 84 KiB

BIN
arednGettingStarted/_images/advConfig-downloads.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 294 KiB

After

Width:  |  Height:  |  Size: 275 KiB

BIN
arednGettingStarted/_images/advConfig-olsr-alerts.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
arednGettingStarted/_images/advConfig-olsr.png Executable file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

59
arednGettingStarted/advanced_config.rst
View File

@ -34,7 +34,7 @@ You have already configured many of the basic settings, but there are several ad
:alt: Setup Options
:align: center
----------
|
Mesh RF Column
^^^^^^^^^^^^^^
@ -69,7 +69,7 @@ Enable/Disable Mesh Radio
:alt: LAN AP Settings
:align: center
----------
|
LAN Column
^^^^^^^^^^
@ -132,13 +132,11 @@ Port Forwarding, DHCP, and Services
Click the **Port Forwarding, DHCP, and Services** link to navigate to these settings. This section provides a way for you to configure LAN network address reservations and service advertisements on your node. If your LAN network uses ``NAT`` mode, you may also need to define port forwarding rules.
----------
.. image:: _images/08-port-forward.png
:alt: Port Forwarding, DHCP, and Services
:align: center
----------
|
If your node is running its default DHCP server on the LAN network, it will automatically provide IP addresses to connected hosts. Look under the **Current DHCP Leases** heading to see the existing hosts and their assigned IP address.
@ -227,13 +225,11 @@ Tunnel Server Node Settings
The following diagram shows an overview of tunnel services between two nodes.
----------
.. image:: _images/10-tunneling-diagram.png
:alt: Tunneling Diagram
:align: center
----------
|
The tunnel network address ranges are automatically calculated, and it is not necessary to change these settings unless there is a specific reason why the defaults will not work for your situation.
@ -251,7 +247,7 @@ Contact Info/Comment (optional)
Once these settings are correct, click *Add* to add the new client to the list of authorized tunnel clients. On the right of each entry there is an envelope icon which will automatically open your computer's email program and copy the client settings into a new email which allows you to quickly and easily send credentials to the owners of the client nodes.
To allow a client to connect to your tunnel server, select the **Enabled?** checkbox and click the **Save Changes** button. When a tunnel connection becomes active, the cloud icon at the right of each row will change to indicate that the tunnel is active.
To allow a client to connect to your tunnel server, select the **Enabled?** checkbox and click the **Save Changes** button. When a tunnel connection becomes active, the cloud icon at the right of each row will change to indicate that the tunnel is active. Depending on the timing of the page refresh, you may need to press the **Refresh** button to see the active icon.
Tunnel Client
-------------
@ -260,13 +256,13 @@ Click the **Tunnel Client** link to navigate to these settings. In this section
Contact the amateur operator who controls the tunnel server and request client credentials by providing your specific node name. The tunnel server administrator will provide you with the public IP or :abbr:`DDNS (Dynamic Domain Name Service)` URL for the tunnel server, the password you are to use, and the network IP address for your client node. Enter these values into the appropriate fields on your node and click *Add* to create a client entry in the list.
----------
.. image:: _images/11-tunnel-client.png
:alt: Tunnel Client Settings
:align: center
To allow your client to connect to the tunnel server, select the **Enabled?** checkbox and click the **Save Changes** button. When a tunnel connection becomes active, the cloud icon at the right of each row will change to indicate that the tunnel is active.
|
To allow your client to connect to the tunnel server, select the **Enabled?** checkbox and click the **Save Changes** button. When a tunnel connection becomes active, the cloud icon at the right of each row will change to indicate that the tunnel is active. Depending on the timing of the page refresh, you may need to press the **Refresh** button to see the active icon.
.. warning:: The add-on tunnel package (vtun) has a character limitation on the client node name which could prevent a tunnel from connecting. Keep node names as short as possible in order to avoid this issue. More information and discussion can be found in `this Forum thread <https://www.arednmesh.org/comment/4174>`_.
@ -279,6 +275,8 @@ Click the **Administration** link to navigate to these settings. There are four
:alt: Upgrade and Packages
:align: center
|
.. important:: Files cannot be uploaded to a node while a tunnel server or client connection is enabled. Disable tunnel client or server connections before uploading firmware, packages, or ssh key files. The *Upload* buttons will be disabled until tunnels are disabled.
Firmware Update
@ -313,7 +311,7 @@ Map Tile and Script Paths
:alt: Advanced Configuration - map paths
:align: center
----------
|
Firmware and Package Download Paths
These fields contain the URLs used by the node for downloading firmware and package files during upgrades. By default they point to the AREDN |trade| downloads server available across the Internet. You can change these paths to point to a local mesh package server in order to upgrade nodes that do not have Internet access.
@ -324,7 +322,7 @@ Firmware and Package Download Paths
:alt: Advanced Configuration - downloads
:align: center
----------
|
PoE and USB Power Passthrough
These rows will only appear in the table if you have node hardware which supports PoE or USB power passthrough. One example is the *Mikrotik hAP ac lite* which provides one USB-A power jack, as well as PoE power passthrough on Ethernet port 5. You are allowed to enable or disable power passthrough on nodes with ports that support this feature. Move the slider to **ON** and click *Save Setting* to enable power passthrough.
@ -333,7 +331,7 @@ PoE and USB Power Passthrough
:alt: Advanced Configuration - passthrough
:align: center
----------
|
Tunnel Server *maxclients* and Tunnel Client *maxservers*
These rows will appear in the table only if the AREDN |trade| tunneling package is installed on your node. By default a node is allowed to host up to 10 clients in its *Tunnel Server* display and connect with up to 10 servers in its *Tunnel Client* display. The *maxclients* and *maxservers* settings provide a method for adjusting the defaults.
@ -342,7 +340,7 @@ Tunnel Server *maxclients* and Tunnel Client *maxservers*
:alt: Advanced Configuration - tunnel max values
:align: center
----------
|
.. important:: If you plan to change these settings, review **Changing Tunnel Max Settings** in the **How-To Guide** section.
@ -351,26 +349,32 @@ Tunnel Server *maxclients* and Tunnel Client *maxservers*
Low Memory Thresholds
As the number of nodes increases in a mesh network, the processing requirements also increase for displaying all of the mesh routes on your node's *Mesh Status* display. For older nodes with limited memory resources, the mesh status display may become very sluggish on large mesh networks. Recent firmware improvements have made the *Mesh Status* display much more responsive, and two new **Advanced Configuration** values are available for setting the *Low Memory Threshold* and maximum number of routes to be displayed. Currently the default low memory threshold is 10,000 KB, which if reached will limit the *Mesh Status* display to the 1,000 closest routes. These values can be adjusted to lower values if your node has limited memory.
.. image:: _images/advConfig-lowMem.png
:alt: Advanced Configuration - low memory thresholds
:align: center
.. image:: _images/advConfig-lowMem.png
:alt: Advanced Configuration - low memory thresholds
:align: center
----------
|
OLSR Restart
The `OLSR (Optimized Link State Routing) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ process can be restarted when you want your node to rebuild its mesh routing table but you do not want to do a full reboot. Click the *Execute* button to restart OLSR.
There is a known intermittent issue that may occur when a node boots. If OLSR fails to propagate information or does not receive all the network hostnames, a one-time restart of OLSR should resolve the issue. OLSR should be restarted on your node if other nodes' *Mesh Status* display have your node's IP address rather than hostname or if "dtdlink" or "mid" is shown in your node's hostname on their *Mesh Status* display. If your node's *Mesh Status* display shows the IP address rather than hostname for a remote node, then that remote node should restart OLSR.
.. image:: _images/advConfig-olsr-alerts.png
:alt: Advanced Configuration - OLSR and Alerts
.. image:: _images/advConfig-olsr.png
:alt: Advanced Configuration - OLSR
:align: center
----------
|
There is a known intermittent issue that may occur when a node boots. If OLSR fails to propagate information or does not receive all the network hostnames, a one-time restart of OLSR should resolve the issue. OLSR should be restarted on your node if other nodes' *Mesh Status* display have your node's IP address rather than hostname or if "dtdlink" or "mid" is shown in your node's hostname on their *Mesh Status* display. If your node's *Mesh Status* display shows the IP address rather than hostname for a remote node, then that remote node should restart OLSR.
AREDN Alert Message (AAM) Refresh
The AREDN |trade| development team may post messages which Internet-connected nodes can automatically download. You can execute the *aam.refresh* action if you want your node to retrieve any new messages without having to wait for the next auto-refresh window. Click the *Execute* button to trigger an immediate message retrieval. This will retrieve all alerts eligible for display on your node, whether they come from the AREDN |trade| server over the Internet or from a local message source on your mesh network.
.. image:: _images/advConfig-alerts.png
:alt: Advanced Configuration - Alerts
:align: center
|
AREDN Alerts Local Path
This field allows you to enter the URL for a local alert message repository. If you configure such a local repository then your nodes without Internet access can also receive alert messages pertinent to your local mesh. Enter the URL without a trailing backslash.
@ -383,10 +387,13 @@ AREDN Alerts Local Path
:alt: Local Alert Message Repository Content
:align: center
----------
|
It is possible to include HTML tags in your message text, such as using the ``<br />`` tag to display subsequent text on the next line. However, it is best practice to keep alert messages short in order to minimize the height of the alert banner displayed on node webpages.
AREDN Alert Pollrate
This field allows you to set the polling rate or interval in hours at which the node will check for message updates. The default polling rate is once every 12 hours, but you can make this value smaller if you want your node to check for updates more frequently.
AREDN Alert Message Purge
Use this purge setting if you want to immediately remove the AREDN |trade| Alert Message banner from your node. Click the *Execute* button to trigger an immediate message banner removal. This will remove all alert messages, whether they originated from the AREDN |trade| server over the Internet or from a local message source on your mesh network.

2
arednGettingStarted/node_status.rst
View File

@ -48,7 +48,7 @@ The :abbr:`OLSR (Optimized Link State Routing protocol)` **Entries** show the to
AREDN |trade| Alert Messages
----------------------------
The AREDN |trade| development team has the ability to post messages which Internet-connected nodes will automatically retrieve once every 12 hours. There are two types of messages: broadcast messages intended for all nodes, and directed messages which are only retrieved by individual nodes. Messages are displayed in a yellow banner on a node's webpages above the node name. Be aware that there is no guarantee of privacy for these messages, since anyone can view the message repository online.
The AREDN |trade| development team has the ability to post messages which Internet-connected nodes will automatically retrieve once every 12 hours by default. There are two types of messages: broadcast messages intended for all nodes, and directed messages which are only retrieved by individual nodes. Messages are displayed in a yellow banner on a node's webpages above the node name. Be aware that there is no guarantee of privacy for these messages, since anyone can view the message repository online.
.. image:: _images/aam-display.png
:alt: AAM Display

6
arednHow-toGuides/dish-aiming.rst
View File

@ -28,13 +28,11 @@ Distant fixed nodes can be aligned with the same tools you used in the previous
For example, Mikrotik LHG5 and Ubiquiti RocketDish5 antennas are very narrow, with beam widths between 5° and 7°. Mikrotik QRT panels and Ubiquiti Powerbeam antennas have beam widths between 10° and 12°. Mikrotik SXTsq5 panels and Ubiquiti AirGrid antennas have beam widths between 20° and 23°. Ubiquiti NanoStations and Mikrotik SXTsq2 panels have beam widths between 45° and 60°. Sector antennas have typical beam widths of 90° or 120°, while omnidirectional antennas cover 360° with various degrees of downtilt.
----------
.. image:: _images/beamwidth-comparison.png
:alt: Antenna beam width comparison
:align: center
----------
|
While it is helpful to know the antenna pattern for the nodes at both ends, the key is knowing the exact coordinates of the two locations so you can determine their topographical relationship to each other (horizontal and vertical azimuth). There are several computer tools for modeling radio links that were mentioned in the **Network Design Guide** under the *Network Modeling* section. One of the most useful is `VE2DBE's Radio Mobile <http://www.ve2dbe.com/rmonline.html>`_ which provides all of the required details for aiming directional antennas between two locations, including both true and magnetic bearings for both sides of the link.
@ -46,6 +44,8 @@ Studying the types of maps mentioned above may allow you to discover other sites
:alt: Antenna Aiming Details
:align: center
|
The chart above shows typical link details that are provided by `Radio Mobile <http://www.ve2dbe.com/rmonline.html>`_. It is very helpful to know these kinds of details and to have an accurate compass before you begin the antenna aiming process. If you use magnetic bearings you will need to know the declination for your location, and be sure your phone or compass is not influenced by nearby metal objects.
Some antennas are easier to aim than others. Large metal dishes are heavy and may require two people to aim, whereas lighter dishes like the Mikrotik LHG units are easier to manipulate. Often only a slight change in position can make a large difference in SNR and link quality. Be sure to avoid trees and be sure your link's first Fresnel Zone is clear of obstructions in order to achieve the best link quality. See the **Network Design Guide** on *Radio Spectrum Characteristics* for examples of ground clearance at different frequencies to ensure the Fresnel Zone is clear.

2
arednHow-toGuides/iperf.rst
View File

@ -20,6 +20,8 @@ After iperf and IperfSpeed are installed on your nodes, you can select the *Iper
:alt: iperfSpeed Display
:align: center
|
Once the test has completed you will see the collected data summarized by time interval, and at the bottom of the display is the overall average of the results from the perspective of the sender (client) and the receiver (server). IperfSpeed also tracks previous tests that have been run, and it allows you to rerun any of the previous tests by clicking the *Re-Test* button.
One of the many uses for IperfSpeed is to validate and optimize your node's *Distance* setting on the **Basic Setup** page. Try different *Distance* settings and note the network bandwidth using iperf, with the goal of choosing the *Distance* setting which yields the best network performance.

6
arednHow-toGuides/local-package-repo.rst
View File

@ -21,6 +21,8 @@ d.apache.org/docs/2.4/urlmapping.html>`_). Once the software has been made avail
:alt: View the local package repository
:align: center
|
These tasks are all that should be required on your local package host. Once the package tree is available via its web server, you can begin pointing the nodes to your local software repository.
Point Nodes to the New Server
@ -44,6 +46,8 @@ It is good practice to use the `fully qualified domain name (FQDN) <https://en.w
:alt: Advanced Configuration - set package URL
:align: center
|
After you have entered the new URL, click the **Save Setting** button to activate the new entry. To restore the default entry, click the **Set to Default** button.
Once the node has been pointed to the local package repository, you can navigate to **Setup > Administration**. In the *Package Management* section, you can click the **Refresh** button to get the list of available packages from the local package repository. Remember that retrieving this package list will use memory resources on your node.
@ -52,6 +56,8 @@ Once the node has been pointed to the local package repository, you can navigate
:alt: Administration - refresh package list
:align: center
|
The following example shows the type of information returned when you click the **Refresh** button:
::

2
arednHow-toGuides/max_tunnel_settings.rst
View File

@ -8,7 +8,7 @@ By default a node is allowed to host up to 10 clients in its *Tunnel Server* dis
:alt: Advanced Configuration - changing tunnel settings
:align: center
----------
|
.. warning:: Use caution when increasing the *maxclients* or *maxservers* values. Enter only *zero* or positive integers up to a maximum value for the number of active connections your node hardware can handle, since each active tunnel connection consumes system resources that the node may need for normal operation.

28
arednHow-toGuides/puttygen_ssh_keys.rst
View File

@ -18,7 +18,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Confirm SSH-2 RSA key
:align: center
----------
|
2. Select the *Generate key pair* menu item or click the *Generate* button and you will be asked to make some random mouse movements. After a short while you get a message asking you to wait while the keys are generated. Once it finishes you now have a new key pair.
@ -26,7 +26,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Label key pair and create pass phrase
:align: center
----------
|
Give the key pair a suitable comment so that you will remember what the keys are used for. Here we just entered testkey@wu2s.com for an example. Whatever you enter in the "Key Comment" field must look like an email address with no spaces and the "@" present. Normally this field is used to identify a specific *username@hostname*. You can also password protect the SSH login by providing a passphrase if you desire. Record this passphrase so you will remember it for future use.
@ -36,7 +36,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Save key files
:align: center
----------
|
4. In order for your new public key to be installed on an AREDN |trade| node you will need to verify that there are no extra characters which Windows typically adds to text files. You can accomplish this using a text editor which allows you to view and remove the unwanted characters. This example shows opening `Notepad++ <https://notepad-plus-plus.org/downloads/>`_ and navigating to *View > Show Symbol > Show End of Line*. Now you can see the line termination characters inserted by Windows.
@ -44,7 +44,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Notepad view EOL
:align: center
----------
|
If you saved your public key file by clicking the *Save Public Key* button in PuTTYGen you may notice that it contains a header, footer, and lots of end of line characters. Your AREDN |trade| node will not accept the file with these extra characters. The easiest way to resolve this is to go back to PuTTYGen and highlight/select the entire contents of the text area titled "Public key for pasting into OpenSSH authorized_keys file." Copy this text using the CTRL-C keys on your keyboard.
@ -52,7 +52,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Puttygen copy key text
:align: center
----------
|
Now go to Notepad++ and paste the copied text into a new window. You should see your public key text on a single line without any header/footer or line termination characters.
@ -60,7 +60,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Puttygen copy key text
:align: center
----------
|
Save this Notepad++ window to a suitable filename with the **.pub** file extension.
@ -68,7 +68,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Save the public key
:align: center
----------
|
5. In order to use your new SSH key pair, login to your AREDN |trade| node and go to the **Setup -> Administration** screen. At the bottom you will see the *Authorized SSH Keys* section where you can install the public keys to use on this node.
@ -76,7 +76,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Node Administration page
:align: center
----------
|
6. Press the *Choose File* button to locate the *public* SSH key you want to install. After choosing the desired *public* key file, click the *Upload* button to install the key on the AREDN |trade| node.
@ -84,7 +84,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Select key to install
:align: center
----------
|
7. You will see a message asking you to reboot your node. After rebooting you can confirm that the new key was installed by looking in the dropdown list under the *Remove Key* section. Your SSH key will appear in the list if it is installed. (You are verifying that the key was installed, but do not click the *Remove* button unless you want to remove it.)
@ -92,7 +92,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Upload and install key
:align: center
----------
|
8. To use your SSH keys, open a new PuTTY session. In the *Hostname* box enter *localnode* and in the *Port* box enter 2222. It may be helpful to save this session definition using a name that identifies the specific node you are connecting to. Enter your identifier and click the *Save* button.
@ -100,7 +100,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
:alt: Create new Putty session
:align: center
----------
|
9. Now, using the menu at the left, go to the SSH section and then select the *Auth* item. This shows a number of Options. The only one we need is the very last – the location of the Private key file for authentication. Browse for it and select the correct filename as before. Remember that the PRIVATE key files end in .ppk Go back to top of the menu on the left and select *Session*.
SAVE the session definition again.
@ -109,7 +109,7 @@ SAVE the session definition again.
:alt: Session definition, location of private key
:align: center
----------
|
10. Now you can use the session information you saved by clicking the *Load* or *Open* button in the main PuTTY session screen. This will open a terminal window as shown below. Login to the AREDN |trade| node as `root`. If you configured the PuTTY session correctly, it will find your private key file and ask you for the passphrase (if any). If PuTTY cannot find the private key file, it will revert to prompting you for the `root` password that you normally use to login on the node.
@ -117,10 +117,12 @@ SAVE the session definition again.
:alt: Enter passphrase to use SSH key
:align: center
----------
|
11. The correct passphrase was entered. The node’s banner appears in the terminal session window and you can now do any command line tasks on the node.
.. image:: _images/11-puttygen.png
:alt: Logged into node
:align: center
|

10
arednHow-toGuides/siso-mimo.rst
View File

@ -8,6 +8,8 @@ SISO (Single Input Single Output) device hardware has a single transceiver-anten
:alt: SISO and MIMO radio chains
:align: center
|
Both SISO and MIMO devices use `OFDM (Orthogonal Frequency Division Multiplexing) <https://en.wikipedia.org/wiki/Orthogonal_frequency-division_multiplexing>`_, which inherently handles poor RF conditions such as `multipath interference <https://en.wikipedia.org/wiki/Multipath_propagation#Interference>`_ or fading. The rate selection algorithm in the wireless driver adapts to changing RF conditions so that the optimal :abbr:`MCS (Modulation and Coding Scheme)` `rate <https://en.wikipedia.org/wiki/IEEE_802.11n-2009#Data_rates>`_ is always used. The selected :abbr:`MCS (Modulation and Coding Scheme)` includes the appropriate modulation, forward error correction, and number of data streams.
SISO Device Hardware
@ -38,7 +40,7 @@ SISO to SISO
:alt: SISO to SISO
:align: center
----------
|
SISO to MIMO
All transmit power is sent using a single polarization, and the MIMO receiver will enhance reception by combining multipath signals using `MRC <https://en.wikipedia.org/wiki/Maximal-ratio_combining>`_. Only one data stream at a time can be sent at a rate that is limited by the protocol.
@ -47,7 +49,7 @@ SISO to MIMO
:alt: SISO to MIMO
:align: center
----------
|
MIMO to SISO
The total transmit power is shared between MIMO chains, so the RF energy which is 90 degrees off-polarization from the receiving antenna may be lost. The SISO receiver cannot enhance multipath signals using `MRC <https://en.wikipedia.org/wiki/Maximal-ratio_combining>`_. Only one data stream at a time can be sent at a rate that is limited by the protocol.
@ -56,7 +58,7 @@ MIMO to SISO
:alt: MIMO to SISO
:align: center
----------
|
MIMO to MIMO
The total output power is shared between MIMO chains, but the full power from both polarizations can be processed by the receiver so that nothing is lost. The MIMO receiver can enhance reception by combining multipath signals using `MRC <https://en.wikipedia.org/wiki/Maximal-ratio_combining>`_. Simultaneous data streams can be sent using spatial multiplexing, effectively doubling data throughput.
@ -65,7 +67,7 @@ MIMO to MIMO
:alt: MIMO to MIMO
:align: center
----------
|
Troubleshooting Tips
--------------------

10
arednNetworkDesign/channel_planning.rst
View File

@ -39,6 +39,8 @@ In any wireless network there will be nodes that are not within radio range of e
:alt: Hidden Node Problem
:align: center
|
`Request to Send / Clear to Send (RTS/CTS) <https://en.wikipedia.org/wiki/IEEE_802.11_RTS/CTS>`_ messages are used by AREDN |trade| nodes to minimize or eliminate this issue. For example, node **A** broadcasts a short RTS message with a proposed timeslot/duration for transmitting its complete data stream. Node **B** receives that request and broadcasts a CTS for that time slot. Node **C** could not hear the original RTS but will hear the CTS message and defer its transmissions during that time slot.
Two other approaches may also alleviate the hidden node issue. You may be able to make the hidden nodes visible to each other, for example by increasing their signal strength. The alternative is to isolate the nodes completely by placing them onto different bands or channels. Since nodes using directional antennas are nearly invisible to others not positioned in the antenna's beam, directional antennas should be used with care when sharing a channel. It may be more appropriate to create a separate link between the sites and to put the radios on a different band or channel.
@ -65,6 +67,8 @@ Depending on the frequency band you are using, there are varying options availab
:alt: Example Channel Reuse Plan
:align: center
|
The example coverage map shows that four different channels have been assigned to achieve broad coverage by segmenting specific areas into zones to reduce co-channel contention. It should be noted that even a channel reuse plan such as this may not eliminate all instances of contention. For example, if a node is at the outer edges of a coverage zone or is elevated well above ground level, its transmissions may propagate into a distant cell using the same channel. The radios in the other cell will defer if they hear the original node's transmissions, even though they originate in a different cell. Some degree of experimentation may be required in order to minimize contention and maximize network throughput.
Collocated Nodes
@ -76,6 +80,8 @@ At some sites there may be several devices mounted on the same building or struc
:alt: Collocated Nodes
:align: center
|
Network performance degradation can occur if these nodes share an RF band and channel. For example, when two sector antennas are collocated and share the same channel, the network throughput for that site will be reduced by half or more. If you have collocated nodes then it makes sense to allow the devices to pass traffic over their Ethernet interface (as described below) rather than forcing them to use their radio channel.
Device to Device (DtD) Linking
@ -97,7 +103,7 @@ If you want to partition traffic even further, you can configure VLANs on a mana
:alt: Traffic Isolation with VLANs
:align: center
----------
|
Antenna Polarization
++++++++++++++++++++
@ -113,7 +119,7 @@ The AREDN |trade| web interface provides information that is helpful when aligni
:alt: Aligning Nodes for Best SNR
:align: center
----------
|
Channel Planning Tips
---------------------

16
arednNetworkDesign/frequency_bands.rst
View File

@ -15,14 +15,14 @@ Channel Information
Some or all of the bands shown below are shared with other authorized users. For example, all of the upper channels on the 13 cm band are shared with standard FCC Part 15 :abbr:`WiFi (IEEE 802.11x)` users in the US. The following table shows examples of the amateur radio bands, frequency ranges, and number of channels that are available for AREDN |trade| networking in the US.
======= ================= ========
Band Frequency Range Channels
======= ================= ========
33 cm 902-928 MHz 4
13 cm 2390-2450 MHz 13
9 cm 3300-3445 MHz 14
5 cm 5650-5925 MHz 54
======= ================= ========
======= ================= ========
Band Frequency Range Channels
======= ================= ========
33 cm 902-928 MHz 4
13 cm 2390-2450 MHz 13
9 cm 3300-3445 MHz 14
5 cm 5650-5925 MHz 54
======= ================= ========
The choice of a frequency band for AREDN |trade| networking depends on several different factors, but you can "mix and match" bands in your network design as long as both sides of a radio link use the same band, channel, and channel width.

11
arednNetworkDesign/network_modeling.rst
View File

@ -32,7 +32,7 @@ The path profile is color coded to indicate whether the link quality is adequate
:alt: Ubiquiti AirLink Modeling
:align: center
----
|
VE2DBE's Radio Mobile Tool
++++++++++++++++++++++++++
@ -45,7 +45,7 @@ With *Radio Mobile* you must first create a *Site* for each of your endpoints. T
:alt: Radio Mobile Path Profile
:align: center
----
|
HeyWhatsThat Path Profiler
++++++++++++++++++++++++++
@ -58,7 +58,7 @@ Simply click on the map at the bottom of the webpage to add an endpoint for each
:alt: HeyWhatThat Path Profiler
:align: center
----
|
Radio Fresnel Tool
++++++++++++++++++
@ -71,8 +71,7 @@ Simply enter the required site information into the online form and click the *G
:alt: Radio Fresnel Tool
:align: center
----
|
Determining Node or Network Coverage
------------------------------------
@ -84,3 +83,5 @@ An example *Radio Mobile* coverage plot is shown below. After entering the site,
.. image:: _images/radioMobile-coverage.png
:alt: Radio Mobile Coverage Plot
:align: center
|

2
arednNetworkDesign/network_topology.rst
View File

@ -36,7 +36,7 @@ Tree Topology
:alt: Tree Topology
:align: center
----------
|
Types of Links
--------------

12
arednServicesGuide/chat_programs.rst
View File

@ -21,7 +21,7 @@ MeshChat *Action Scripts* also provide for functional extensions, such as sendin
:alt: MeshChat Web Interface
:align: center
----------
|
Internet Relay Chat
-------------------
@ -34,7 +34,7 @@ A wide variety of features and functions are available with these and similar ch
:alt: IRC in KiwiChat Web Interface
:align: center
----------
|
Jabber/XMPP
-----------
@ -47,7 +47,7 @@ Two of the most popular XMPP servers are eJabberd and Prosody, but there are man
:alt: Prosody XMPP Interface
:align: center
----------
|
Let's Chat
----------
@ -58,7 +58,7 @@ Let's Chat
:alt: Let's Chat Interface
:align: center
----------
|
Mattermost
----------
@ -71,7 +71,7 @@ Mattermost supports @mentions, and channels are available for organizing convers
:alt: Mattermost Interface
:align: center
----------
|
Matrix - Synapse
----------------
@ -84,7 +84,7 @@ Matrix services can provide one-to-one communication channels as well as group c
:alt: Matrix Chat Interface
:align: center
----------
|
Example Chat Service Comparison
-------------------------------

2
arednServicesGuide/dispatch_programs.rst
View File

@ -36,7 +36,7 @@ A variety of built-in reports are available which can be viewed, printed, and do
:alt: Open ISES Tickets Display
:align: center
----------
|
Example Computer Aided Dispatch Comparison
------------------------------------------

6
arednServicesGuide/email_programs.rst
View File

@ -19,7 +19,7 @@ Since a variety of features are bundled into a single application suite, Citadel
:alt: Citadel Web Interface
:align: center
----------
|
Open Source Email Server
------------------------
@ -44,7 +44,7 @@ You will need to have detailed knowledge and skills when building your own open
:alt: Thunderbird IMAP Client
:align: center
----------
|
Using WinLink to Send Email
---------------------------
@ -55,7 +55,7 @@ Although it is not typically used as a TCP/IP network application, many operator
:alt: Winlink Interface
:align: center
----------
|
Example Email Service Comparison
--------------------------------

6
arednServicesGuide/file_sharing.rst
View File

@ -19,7 +19,7 @@ All of the most common web browsers allow content to be downloaded using FTP as
:alt: FTP Web Interface
:align: center
----------
|
Web Services
------------
@ -34,7 +34,7 @@ Users login to NextCloud to see available content, and file sharing permissions
:alt: NextCloud Web Interface
:align: center
----------
|
Collaborative Computing
-----------------------
@ -48,3 +48,5 @@ One example package that facilitates collaborative document creation is `Etherpa
.. image:: _images/etherpad.png
:alt: Etherpad Web Interface
:align: center
|

10
arednServicesGuide/other_programs.rst
View File

@ -14,7 +14,7 @@ For additional information about MeshMap, visit this link: `meshmap <https://git
:alt: MeshMap Display
:align: center
----------
|
weeWx Weather Service
---------------------
@ -27,7 +27,7 @@ a valuable overview of weather conditions across a wide area, for example, showi
:alt: weeWx Display
:align: center
----------
|
Network Time Services
---------------------
@ -40,6 +40,8 @@ Most NTP implementations depend on an Internet connection in order to synchroniz
:alt: OffGrid NTP Server
:align: center
|
In order for NTP to operate properly, each client device must have a fast and reliable connection to the NTP servers on the network. Be sure to locate your NTP servers on reliable high-speed segments of your mesh. For additional information about building an off-grid NTP server, visit this link: `G4WNC NTP post <https://photobyte.org/raspberry-pi-stretch-gps-dongle-as-a-time-source-with-chrony-timedatectl/#>`_.
GPS Tracking Services
@ -49,6 +51,8 @@ GPS Tracking Services
:alt: APRS Map Display
:align: right
|
Tracking deployed resources is an important task during any emergency. There are many options for monitoring and displaying the GPS locations of tracked resources, two of which are mentioned here.
Many amateur radios and portable locating beacons transmit `Automatic Packet Reporting System (APRS) <https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System>`_ information. It is possible to implement an APRS receiver using inexpensive, battery-powered, portable computers and USB `Software Defined Radios (SDR) <https://en.wikipedia.org/wiki/Software-defined_radio>`_. The details are widely available for building these receivers using Raspberry Pi computers with `Direwolf <https://github.com/wb2osz/direwolf/blob/master/README.md>`_ and `Xastir <https://sourceforge.net/projects/xastir/>`_ or `YAAC <https://sourceforge.net/p/yetanotheraprsc/wiki/Home/>`_ software.
@ -59,6 +63,6 @@ There may be situations when it would also be helpful to track the locations of
:alt: ADS-B Map Display
:align: center
----------
|
Depending on the requirements of your specific situation, almost any program that can operate across a peer-to-peer TCP/IP network could be deployed as a service on your mesh network. Check the `AREDN Forums <https://www.arednmesh.org/forum>`_ for additional information, ideas, and how-to posts about possible services for mesh networking.

2
arednServicesGuide/services_overview.rst
View File

@ -34,6 +34,8 @@ For mission-critical services on high speed data networks, *Disaster Recovery* d
:alt: Server Sync Diagram
:align: center
|
As a general rule for mesh networks, simpler is better. The more complicated and automated you make your service design, the more network and computing resources will be required to operate the system. It is always best to conserve mesh networking resources wherever possible.
----------

12
arednServicesGuide/video_streaming.rst
View File

@ -10,6 +10,8 @@ The photo below shows a Mobile Command Center (MCC) deployed to support a large
:alt: Emergency Operations Center Video
:align: center
|
More than a dozen high definition `IP cameras <https://en.wikipedia.org/wiki/IP_camera>`_ were collocated at portable AREDN |trade| node sites across the area, and the individual video streams were consolidated on several large displays in the MCC. Orange County Sheriff’s Administrator Sgt. Joseph Cope commented, “This mesh camera system provided by RACES members was a valuable tool for our command staff. The parade was the safest in years. As we were taking the calls, we could see the activity occurring in realtime. Incredibly, there was only one arrest for fighting, which just happened to take place in the camera's view.”
IP Video Cameras
@ -19,6 +21,8 @@ IP Video Cameras
:alt: Portable Node with Camera
:align: left
|
IP video cameras may have a fixed direction and focus, or they may be remote controlled `PTZ (Pan, Tilt, Zoom) <https://en.wikipedia.org/wiki/Pan%E2%80%93tilt%E2%80%93zoom_camera>`_ models. The cost and features for video cameras vary widely. On the low end is a very inexpensive Raspberry Pi Zero computer having an integrated camera, shown here next to the Ubiquiti Bullet radio. On the high end are the ruggedized commercial :abbr:`PTZ (Pan, Tilt, Zoom)` cameras which can cost hundreds of dollars, shown here with the bubble dome and infrared LEDs.
Many IP cameras stream video using `Real Time Streaming Protocol (RTSP) <https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol>`_ in which missing packets are simply skipped during video display. It can be challenging to determine the URL of an RTSP stream, but there is a handy utility at `ispyconnect <https://www.ispyconnect.com/sources.aspx>`_, as well as packet capture utilities such as `Wireshark <https://en.wikipedia.org/wiki/Wireshark>`_, which may help. Frequently a camera supports multiple RTSP URLs each with a different resolution, so you can advertise any of them as a service on an AREDN |trade| node as required. Recently more cameras support `ONVIF (Open Network Video Interface Forum) <https://en.wikipedia.org/wiki/ONVIF>`_, which is a set of protocols and standards that includes RTSP. It supports camera discovery and PTZ camera control.
@ -49,7 +53,7 @@ In the lower right video stream on the iSpy display below you can see the smoke
:alt: iSpy Display
:align: center
----------
|
MotionEye
+++++++++
@ -62,7 +66,7 @@ The backend `Motion <https://motion-project.github.io/index.html>`_ engine is bu
:alt: MotionEye Display
:align: center
----------
|
ZoneMinder
++++++++++
@ -77,7 +81,7 @@ This robust feature set comes at the cost of some administrative complexity, mak
:alt: ZoneMinder Display
:align: center
----------
|
Shinobi
+++++++
@ -92,7 +96,7 @@ Shinobi tends to conserve computing resources fairly well, so more cameras or hi
:alt: Shinobi Display
:align: center
----------
|
Example Video Service Comparison
--------------------------------

12
arednServicesGuide/voip_programs.rst
View File

@ -20,7 +20,7 @@ Asterisk Server
:alt: Asterisk Diagram
:align: center
----------
|
FreePBX Server
`FreePBX <https://en.wikipedia.org/wiki/FreePBX>`_ is a web-based graphical user interface (GUI) for managing Asterisk. However, it is most commonly deployed as part of the integrated `FreePBX Distro <https://en.wikipedia.org/wiki/FreePBX_Distro>`_, which installs a complete Linux operating system with Asterisk, FreePBX, and software dependencies included.
@ -31,7 +31,7 @@ FreePBX Server
:alt: FreePBX Diagram
:align: center
----------
|
VoIP Endpoints
--------------
@ -42,7 +42,7 @@ Once you have a VoIP PBX provisioned on your mesh network, you will need VoIP en
:alt: Linphone Softphone
:align: right
----------
|
Linphone Softphone
`Linphone <https://en.wikipedia.org/wiki/Linphone>`_ is a software phone that is supported on Windows, Linux, MacOS, Raspberry Pi, iPhone, and Android. It can be used to place voice and video direct calls as well as calls through a VoIP PBX like those mentioned above. Users can transfer calls to other numbers, send chat messages, share pictures or files, and merge calls into a group conference. The softphone has the ability to manage contact lists, and call history is available for future reference.
@ -56,7 +56,7 @@ Mumble
:alt: Mumble Group Conference
:align: center
----------
|
Video Conferencing Software
---------------------------
@ -70,7 +70,7 @@ FreeSWITCH Server
:alt: FreeSWITCH Video Conference
:align: center
----------
|
TeamTalk
`TeamTalk <https://en.wikipedia.org/wiki/TeamTalk>`_ is an audio-visual conferencing system which enables people to communicate and share information across the network. It is often classified as *freeware*, but the TeamTalk server is proprietary and its source code is not publicly available. During a conference users talk through their computer microphone, see others via their webcams, create instant messages, share files, and show desktop applications. The TeamTalk software package bundles the client and server programs, so any computer may play the role of client or server.
@ -81,7 +81,7 @@ TeamTalk
:alt: TeamTalk Video Conference
:align: center
----------
|
Example VoIP Service Comparison
-------------------------------

2
conf.py
View File

@ -33,7 +33,7 @@ release = u'3.22.1.0'
# If your documentation needs a minimal Sphinx version, state it here.
#
needs_sphinx = '4.2'
needs_sphinx = '4.4'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

2
requirements.txt
View File

@ -1 +1 @@
Sphinx~=4.2
Sphinx~=4.4