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

newUI-31

This commit is contained in:
ab7pa 2024-07-17 08:03:01 -07:00
parent 44df313017
commit 9cb97a0acc
41 changed files with 252 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
appendix/freq_charts.rst
View File

@ -2,7 +2,7 @@
Frequencies and Channels
========================
Example US frequencies and channels that are available for AREDN |trade| networking are shown in the diagram below.
Example US frequencies and channels that are available for AREDN® networking are shown in the diagram below.
.. image:: ../_images/AREDN-bands.png
:alt: AREDN bands and channels

20
appendix/more_info.rst
View File

@ -2,27 +2,27 @@
Additional Information
======================
Additional information about the AREDN |trade| project can be found at the links below.
Additional information about the AREDN® project can be found at the links below.
- `AREDN homepage <https://www.arednmesh.org/>`_
- `AREDN forums <https://www.arednmesh.org/forum>`_
Contributing AREDN |trade| Documentation
Contributing AREDN® Documentation
----------------------------------------
If you are interested in contributing to the rapidly growing set of AREDN |trade| documentation you can easily do so on GitHub. To contribute to the AREDN |trade| project you first must create your own GitHub account. This is free and easy to do by following these steps:
If you are interested in contributing to the rapidly growing set of AREDN® documentation you can easily do so on GitHub. To contribute to the AREDN® project you first must create your own GitHub account. This is free and easy to do by following these steps:
1. Open your web browser and navigate to the `GitHub URL <https://github.com>`_.
2. Click the ``Sign Up`` button and enter the required information. We suggest using your callsign as the username.
3. On the GitHub website, click the ``Sign In`` button and authenticate to GitHub with the credentials you created.
4. Navigate on GitHub to the AREDN |trade| documentation repository: https://github.com/aredn/documentation.
5. Click the ``Fork`` button at the upper right corner of the page. After this process completes, you will have your own copy of the AREDN |trade| documentation files on your GitHub account.
6. Go to your local computer and clone your fork of the AREDN |trade| documentation: ``git clone https://github.com/YOUR-GITHUB-ID/documentation``
7. Navigate on your local computer to the folder where your cloned copy of the repository is located: ``cd documentation`` This directory contains your local copy of the AREDN |trade| documentation, and all of your document editing should be done while you are in this directory or its subdirectories.
4. Navigate on GitHub to the AREDN® documentation repository: https://github.com/aredn/documentation.
5. Click the ``Fork`` button at the upper right corner of the page. After this process completes, you will have your own copy of the AREDN® documentation files on your GitHub account.
6. Go to your local computer and clone your fork of the AREDN® documentation: ``git clone https://github.com/YOUR-GITHUB-ID/documentation``
7. Navigate on your local computer to the folder where your cloned copy of the repository is located: ``cd documentation`` This directory contains your local copy of the AREDN® documentation, and all of your document editing should be done while you are in this directory or its subdirectories.
The workflow for contributing documentation is described in the file titled `How to Use GitHub for AREDN <https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md>`_, a copy of which you will have in your new local repository. Refer to that document for additional information about contributing AREDN |trade| documentation.
The workflow for contributing documentation is described in the file titled `How to Use GitHub for AREDN <https://github.com/aredn/documentation/blob/master/How%20to%20Use%20GitHub%20for%20AREDN.md>`_, a copy of which you will have in your new local repository. Refer to that document for additional information about contributing AREDN® documentation.
Your local editing branch name can be anything that makes sense to you as you add topics to the documentation. AREDN |trade| documentation is written using the `reStructuredText <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`_ markup language and your text is saved in "rst" files. Before committing your changes, be sure to test your rst files locally using `Sphinx <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ to ensure they will render correctly.
Your local editing branch name can be anything that makes sense to you as you add topics to the documentation. AREDN® documentation is written using the `reStructuredText <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`_ markup language and your text is saved in "rst" files. Before committing your changes, be sure to test your rst files locally using `Sphinx <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ to ensure they will render correctly.
After you create a Pull Request on GitHub, the AREDN |trade| team will review your changes. Once your documentation contributions are committed to the AREDN |trade| GitHub repository, a webhook automatically updates and builds the latest docs for viewing and exporting on ReadTheDocs.org. All contributions that are included by the AREDN |trade| team in the documentation set will be covered by the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International license held by *Amateur Radio Emergency Data Network, Inc.*
After you create a Pull Request on GitHub, the AREDN® team will review your changes. Once your documentation contributions are committed to the AREDN® GitHub repository, a webhook automatically updates and builds the latest docs for viewing and exporting on ReadTheDocs.org. All contributions that are included by the AREDN® team in the documentation set will be covered by the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International license held by *Amateur Radio Emergency Data Network, Inc.*

4
appendix/responsible_disclosure.rst
View File

@ -2,6 +2,6 @@
Responsible Disclosure Policy
=============================
The members of the AREDN |trade| team believe in the responsible disclosure of security vulnerabilities that may be discovered in the software. To further the goal of responsible disclosure, we request those persons who believe they may have discovered a security vulnerability to contact the *Security Team* via email at: **securityteam@arednmesh.org** The *Security Team* will work with you to ensure that the vulnerabilities are patched prior to public disclosure.
The members of the AREDN® team believe in the responsible disclosure of security vulnerabilities that may be discovered in the software. To further the goal of responsible disclosure, we request those persons who believe they may have discovered a security vulnerability to contact the *Security Team* via email at: **securityteam@arednmesh.org** The *Security Team* will work with you to ensure that the vulnerabilities are patched prior to public disclosure.
Furthermore we understand that other organizations may be developing firmware based on the solutions we have published. To that end the AREDN |trade| group has created a security program for such organizations to be informed of discovered vulnerabilities so they can secure their offerings prior to the public disclosure of such vulnerabilities. To apply to our security program please contact **securityteam@arednmesh.org**
Furthermore we understand that other organizations may be developing firmware based on the solutions we have published. To that end the AREDN® group has created a security program for such organizations to be informed of discovered vulnerabilities so they can secure their offerings prior to the public disclosure of such vulnerabilities. To apply to our security program please contact **securityteam@arednmesh.org**

BIN
arednGettingStarted/_images/admin-dhcp-2.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 32 KiB

12
arednGettingStarted/downloading_firmware.rst
View File

@ -1,5 +1,5 @@
==================================
Downloading AREDN |trade| Firmware
Downloading AREDN® Firmware
==================================
Types of Firmware
@ -7,12 +7,12 @@ Types of Firmware
**Stable Release** firmware has been tested and shown work on the devices that were supported at the time of the release. This firmware is considered to be stable and suitable for production devices deployed in the field. Stable Release firmware is identified by numbers such as ``3.23.4.0``. In this example ``23.4`` indicates the year (2023) and month (April) of the Stable Release.
**Nightly Build** firmware contains the latest bug fixes, features, and support for new devices. It allows the wider mesh community to test new code before it is included in a Stable Release. The Nightly Build is considered more experimental or cutting-edge and may not be suitable for production nodes. However, it might make sense to install the Nightly Build if you are having a specific issue that has been addressed in newly developed code or if you are loading AREDN |trade| firmware onto a device that is newly supported. The Nightly Build filename shows the build date and the software commit identifier for that specific firmware build.
**Nightly Build** firmware contains the latest bug fixes, features, and support for new devices. It allows the wider mesh community to test new code before it is included in a Stable Release. The Nightly Build is considered more experimental or cutting-edge and may not be suitable for production nodes. However, it might make sense to install the Nightly Build if you are having a specific issue that has been addressed in newly developed code or if you are loading AREDN® firmware onto a device that is newly supported. The Nightly Build filename shows the build date and the software commit identifier for that specific firmware build.
Choosing Firmware to Download
-----------------------------
The first step is to choose the AREDN |trade| firmware image for your specific hardware. You can find the available firmware images for your device by using the `AREDN Firmware Selector (AFS) <http://downloads.arednmesh.org/afs/www/>`_.
The first step is to choose the AREDN® firmware image for your specific hardware. You can find the available firmware images for your device by using the `AREDN Firmware Selector (AFS) <http://downloads.arednmesh.org/afs/www/>`_.
.. image:: _images/afs-1.png
:alt: AREDN Firmware Selector
@ -28,7 +28,7 @@ Enter the first few characters of the hardware manufacturer in the *Model* searc
|
There are usually two types of firmware images shown for each device: one for the first-time replacement of the manufacturer's firmware, and the other for upgrades of nodes that are already running AREDN |trade| firmware.
There are usually two types of firmware images shown for each device: one for the first-time replacement of the manufacturer's firmware, and the other for upgrades of nodes that are already running AREDN® firmware.
TP-LINK or Ubiquiti
If you are loading firmware on TP-LINK or Ubuquiti devices for the first time you must download the *FACTORY* firmware. Otherwise download the *SYSUPGRADE* firmware image.
@ -39,10 +39,10 @@ Mikrotik
GL.iNET
For GL.iNet devices you will only see the *SYSUPGRADE* image for both first-time installs or firmware upgrades.
Click the appropriate button to download the image file to your local computer. Make a note of the download location on your computer, since you will use the downloaded image(s) to install the AREDN |trade| firmware on your device.
Click the appropriate button to download the image file to your local computer. Make a note of the download location on your computer, since you will use the downloaded image(s) to install the AREDN® firmware on your device.
Features Inherited from OpenWRT for New Architectures
The latest AREDN |trade| firmware contains features which are inherited from the newest OpenWRT upstream releases. The `OpenWRT *Release Notes* <https://openwrt.org/>`_ describe these new features. One important change is the inclusion of new *target* architectures for the firmware. The legacy "ar71xx" target has been retired and is replaced by the "ath79" and "ipq40xx" targets.
The latest AREDN® firmware contains features which are inherited from the newest OpenWRT upstream releases. The `OpenWRT *Release Notes* <https://openwrt.org/>`_ describe these new features. One important change is the inclusion of new *target* architectures for the firmware. The legacy "ar71xx" target has been retired and is replaced by the "ath79" and "ipq40xx" targets.
All supported devices have been migrated to the new targets. **You should select the latest recommended target image based on the type of hardware on which it will be installed.** Refer to the latest `Supported Devices <http://downloads.arednmesh.org/snapshots/SUPPORTED_DEVICES.md>`_ in order to ensure you have the correct firmware image for your specific device.

4
arednGettingStarted/firstboot_setup.rst
View File

@ -2,7 +2,7 @@
Firstboot Node Setup
====================
After you have installed the AREDN |trade| firmware and rebooted the device, the node will have a default IP address of 192.168.1.1. Make sure your computer has an IP address on the 192.168.1.x network. After connecting your computer to a LAN port on the node or the :abbr:`PoE (Power over Ethernet)` unit, you should be able to ping the node at 192.168.1.1. Navigate to your node's web interface at ``http://192.168.1.1`` or ``http://localnode.local.mesh``. Some computers may have DNS search paths configured that require you to use the `fully qualified domain name (FQDN) <https://en.wikipedia.org/wiki/Fully_qualified_domain_name>`_ to resolve *localnode* to the mesh node's IP address. Each node will serve its web interface on ports 80 and 8080.
After you have installed the AREDN® firmware and rebooted the device, the node will have a default IP address of 192.168.1.1. Make sure your computer has an IP address on the 192.168.1.x network. After connecting your computer to a LAN port on the node or the :abbr:`PoE (Power over Ethernet)` unit, you should be able to ping the node at 192.168.1.1. Navigate to your node's web interface at ``http://192.168.1.1`` or ``http://localnode.local.mesh``. Some computers may have DNS search paths configured that require you to use the `fully qualified domain name (FQDN) <https://en.wikipedia.org/wiki/Fully_qualified_domain_name>`_ to resolve *localnode* to the mesh node's IP address. Each node will serve its web interface on ports 80 and 8080.
The firstboot status page will be displayed, instructing you to configure your node by entering a node name and password for administrative access to your node.
@ -11,7 +11,7 @@ The firstboot status page will be displayed, instructing you to configure your n
:align: center
Node Name
Begin the node name with your callsign, followed by unique identifying information of your choice. Node names may contain up to 63 letters, numbers, and dashes, but cannot begin or end with a dash. Underscores, spaces, or any other characters are not allowed. Node names are not case sensitive, but the case will be preserved on the node status display. Amateur radio operators are required to identify all transmitting stations. The AREDN |trade| node name is beaconed automatically by the node every five minutes, so the node name must contain your callsign. Recommended names follow the (callsign)-(label) format, such as AD5BC-MOBILE or AD5BC-120SE. As a general rule node names should be kept as short as possible, while clearly and uniquely identifying the node.
Begin the node name with your callsign, followed by unique identifying information of your choice. Node names may contain up to 63 letters, numbers, and dashes, but cannot begin or end with a dash. Underscores, spaces, or any other characters are not allowed. Node names are not case sensitive, but the case will be preserved on the node status display. Amateur radio operators are required to identify all transmitting stations. The AREDN® node name is beaconed automatically by the node every five minutes, so the node name must contain your callsign. Recommended names follow the (callsign)-(label) format, such as AD5BC-MOBILE or AD5BC-120SE. As a general rule node names should be kept as short as possible, while clearly and uniquely identifying the node.
Password
Set a new administration password for the node with username 'root'. Typically passwords may contain the characters ``a-z``, ``A-Z``, ``0-9``, period ``.``, dash ``-``, underscore ``_``, exclamation ``!``, and tilde ``~``. Avoid linux-reserved characters, including but not limited to ``#``, ``$``, ``&``, ``*``, ``<``, ``>``. Enter your new password again in the *Retype Password* box to verify it is correct. You can click the *eye* icon at the right of the password fields to toggle between hidden and visible text. The first time a node is configured it will require you to change the password. Be sure to remember or record the new password so you can use it for any future administrative tasks on the node.

66
arednGettingStarted/installing_firmware.rst
View File

@ -1,14 +1,14 @@
=================================
Installing AREDN |trade| Firmware
Installing AREDN® Firmware
=================================
The diagram below shows your computer with the downloaded firmware image connected to the node using Ethernet cables in order to install the AREDN |trade| image. It is highly recommended that you connect the computer and node through a simple (dumb) Ethernet switch so that the switch can maintain the computer's network link even when the node is rebooting. Do *not* use a network router for this purpose -- only a dumb switch. This is not for the sake of the radio, but it allows your computer to maintain its Ethernet interface link even when the node reboots.
The diagram below shows your computer with the downloaded firmware image connected to the node using Ethernet cables in order to install the AREDN® image. It is highly recommended that you connect the computer and node through a simple (dumb) Ethernet switch so that the switch can maintain the computer's network link even when the node is rebooting. Do *not* use a network router for this purpose -- only a dumb switch. This is not for the sake of the radio, but it allows your computer to maintain its Ethernet interface link even when the node reboots.
.. image:: _images/firmware-install.png
:alt: Firmware Install Connections
:align: center
Different radio hardware will require different methods for installing the AREDN |trade| firmware.
Different radio hardware will require different methods for installing the AREDN® firmware.
- For **Ubiquiti** 802.11n devices, your computer's `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ *client* will connect to the node's TFTP *server* in order to upload the firmware image. For Ubiquiti 802.11ac devices you will follow a separate procedure explained below.
@ -24,7 +24,7 @@ Preparing Your Computer
Setting a Static IP Address on your Computer
For all of the device models discussed below you will be asked to set a static IP address on your computer as part of the install process. Various computer operating systems have different ways of accomplishing this, and there is a wealth of information in computer manuals, publications, and online resources to walk you through the steps for your specific computer.
As mentioned above, AREDN |trade| recommends that you connect your computer to the node through an intermediary network switch. This allows your computer to activate its Ethernet interface with the static IP address even when the node is not powered on. Since node hardware needs to be powered on/off or rebooted during the install process, the network switch will keep your computer's network interface active on its static IP address.
As mentioned above, AREDN® recommends that you connect your computer to the node through an intermediary network switch. This allows your computer to activate its Ethernet interface with the static IP address even when the node is not powered on. Since node hardware needs to be powered on/off or rebooted during the install process, the network switch will keep your computer's network interface active on its static IP address.
If you choose not to use an intermediary network switch, then you will be responsible for making sure your computer maintains an active interface with the static IP address. You may need to power on the node temporarily in order for your computer to bring up its interface, but then immediately power off the node in order to follow the installation instructions for your model. Having an intermediary network switch eliminates these steps.
@ -55,7 +55,7 @@ For Mikrotik and TP-LINK Installs
Firmware First Install Checklists
---------------------------------
The recommended method for installing AREDN |trade| firmware is to download and follow the appropriate *Install Checklist* below which matches your device hardware. Additional descriptions are also provided in the sections that follow.
The recommended method for installing AREDN® firmware is to download and follow the appropriate *Install Checklist* below which matches your device hardware. Additional descriptions are also provided in the sections that follow.
:download:`GL.iNet First Install Checklist (PDF) <_images/GL.iNet_First_Install_Checklist.pdf>`
@ -68,7 +68,7 @@ The recommended method for installing AREDN |trade| firmware is to download and
Ubiquiti 802.11n First Install Process
--------------------------------------
Download the *Install Checklist* for Ubiquiti 802.11n devices. These devices have a built-in `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ *server* to which you can upload the AREDN |trade| *factory* image. Your computer must have TFTP *client* software available. For more information, see the **Preparing Your Computer** section above.
Download the *Install Checklist* for Ubiquiti 802.11n devices. These devices have a built-in `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ *server* to which you can upload the AREDN® *factory* image. Your computer must have TFTP *client* software available. For more information, see the **Preparing Your Computer** section above.
Different TFTP client programs may have different command line options or flags that must be used, so be sure to study the command syntax for your TFTP client software. The example shown below may not include the specific options required by your client program.
@ -80,7 +80,7 @@ Download the appropriate *factory* file for your device by following the instruc
3. Put the Ubiquiti device into TFTP mode by holding the reset button while plugging your node's Ethernet cable into the *POE* port on the PoE adapter. Continue holding the device's reset button for approximately 30 to 45 seconds until you see the LEDs on the node alternating in a 1-3, 2-4, 1-3, 2-4 pattern, then release the reset button.
4. Open a command window on your computer and execute a file transfer command to send the AREDN |trade| firmware to your device. Target the default IP address of your Ubiquiti node, such as 192.168.1.20 (or 192.168.1.1 for AirRouters). The TFTP client should indicate that data is being transferred and eventually completes. The following is one example of TFTP commands that transfer the firmware image to a node:
4. Open a command window on your computer and execute a file transfer command to send the AREDN® firmware to your device. Target the default IP address of your Ubiquiti node, such as 192.168.1.20 (or 192.168.1.1 for AirRouters). The TFTP client should indicate that data is being transferred and eventually completes. The following is one example of TFTP commands that transfer the firmware image to a node:
::
@ -94,7 +94,7 @@ Download the appropriate *factory* file for your device by following the instruc
[Windows with command on a single line]
> tftp.exe -i 192.168.1.20 put C:\temp\aredn-<release>-factory.bin
5. The node will now automatically reboot with the new AREDN |trade| firmware image.
5. The node will now automatically reboot with the new AREDN® firmware image.
Ubiquiti 802.11ac First Install Process
---------------------------------------
@ -105,7 +105,7 @@ Prerequisites
The installing computer must be capable of connecting to the command line of the target device. This will require that the computer support both the *ssh* and *scp* protocols. *SSH* and *scp* are native to both Linux and MacOS. The OpenSSH package (which contains both commands) can be enabled on Windows computers. For more information, see the **Preparing Your Computer** section above.
Step 1: Preparing the device
Before you install AREDN |trade| firmware on a Ubiquiti 802.11ac device, you must first make sure it is running a specific version of the standard Ubiquiti AirOS software. This procedure will not work if the device is running any other version. Fortunately you can upgrade or downgrade the standard Ubiquiti software.
Before you install AREDN® firmware on a Ubiquiti 802.11ac device, you must first make sure it is running a specific version of the standard Ubiquiti AirOS software. This procedure will not work if the device is running any other version. Fortunately you can upgrade or downgrade the standard Ubiquiti software.
As described in the first paragraphs of this document, it is best to connect your computer to the device using a simple Ethernet switch so that your computer's network interface remains unaffected by reboots on the radio. The IP address for a new Ubiquiti device is 192.168.1.20. Set the IP address of your computer to 192.168.1.10 and, when the device is powered up, enter 192.168.1.20 in a web browser. For a brand new device you’ll be asked to select your country and agree to the EULA. Then click *Continue*. Next you will be prompted to create a user account and password on the radio. You can enter the username ``admin`` and the password ``admin!23`` (for example) and then click *Save*. Make a note of this username and password because you will use it in the following steps.
@ -129,8 +129,8 @@ Step 1: Preparing the device
The rest of the process remains unchanged, so once the downgrade is successful you can move to **Step 2**.
Step 2: Copy the AREDN |trade| firmware to the device
Before you can install AREDN |trade| firmware on the device, you first need to put the AREDN |trade| image in the device’s ``/tmp`` directory. Note that each 802.11ac model will have a *different* AREDN |trade| image name, as opposed to past releases where one AREDN |trade| image supported multiple models. Be sure to download the correct firmware image from the AREDN |trade| download site. On your computer, open a terminal session (“CMD” in windows). Copy the firmware to the device using the scp command with the username and password you created in **Step 1**. The example command below shows the placeholder ``<aredn-image-factory.bin>`` for the firmware filename, but be sure to replace this with the actual filename of the firmware you are installing.
Step 2: Copy the AREDN® firmware to the device
Before you can install AREDN® firmware on the device, you first need to put the AREDN® image in the device’s ``/tmp`` directory. Note that each 802.11ac model will have a *different* AREDN® image name, as opposed to past releases where one AREDN® image supported multiple models. Be sure to download the correct firmware image from the AREDN® download site. On your computer, open a terminal session (“CMD” in windows). Copy the firmware to the device using the scp command with the username and password you created in **Step 1**. The example command below shows the placeholder ``<aredn-image-factory.bin>`` for the firmware filename, but be sure to replace this with the actual filename of the firmware you are installing.
::
@ -154,7 +154,7 @@ Step 2: Copy the AREDN |trade| firmware to the device
scp -O -oHostKeyAlgorithms=+ssh-rsa -oPubkeyAcceptedAlgorithms=+ssh-rsa -oUserKnownHostsFile=/dev/null -oStrictHostKeyChecking=no <aredn-image-factory.bin> admin@192.168.1.20:/tmp/factory.bin
Once this is successful, the AREDN |trade| firmware will be in ``/tmp`` on the device waiting to be installed.
Once this is successful, the AREDN® firmware will be in ``/tmp`` on the device waiting to be installed.
Step3: Install the firmware
The installation procedure requires you to **ssh** to the command line of the device. On your computer, open a terminal session (“CMD” in windows). Type or copy/paste the following command:
@ -177,7 +177,7 @@ Step3: Install the firmware
You will be asked for the password created in **Step 1** (for example, admin!23) and once entered you will be logged into the device and shown the shell prompt.
To install the AREDN |trade| firmware you first need to create a program to do this. Ubiquiti devices expect signed firmware but AREDN |trade| is not signed, so we need to bypass the checking process. To do this type or copy/paste the following two commands:
To install the AREDN® firmware you first need to create a program to do this. Ubiquiti devices expect signed firmware but AREDN® is not signed, so we need to bypass the checking process. To do this type or copy/paste the following two commands:
::
@ -187,18 +187,18 @@ Step3: Install the firmware
These commands take the standard Ubiquiti program used for flashing new firmware and change a few bytes to create our own version with the signature checking code disabled. The first command can take a little while to complete but when successful will return you to the shell prompt.
Finally flash the AREDN |trade| firmware by typing:
Finally flash the AREDN® firmware by typing:
::
/tmp/fwupdate.real -m /tmp/factory.bin
Do **not** unplug the device until the flashing process is complete and the device has rebooted. The device will install the AREDN |trade| image, boot into it, and end up on IP address 192.168.1.1 as a normal AREDN |trade| device. If you cannot connect to the device on its new IP address after five minutes, power cycle the device and try connecting to 192.168.1.1 again. You can then configure the device by following the steps in the **Basic Radio Setup** section of the documentation.
Do **not** unplug the device until the flashing process is complete and the device has rebooted. The device will install the AREDN® image, boot into it, and end up on IP address 192.168.1.1 as a normal AREDN® device. If you cannot connect to the device on its new IP address after five minutes, power cycle the device and try connecting to 192.168.1.1 again. You can then configure the device by following the steps in the **Basic Radio Setup** section of the documentation.
Mikrotik First Install Process
------------------------------
Download the *Install Checklist* for Mikrotik devices. These devices require a **two-part install** process: First, boot the correct Mikrotik *initramfs-kernel* file, and then use that temporary AREDN |trade| environment to complete the installation of the appropriate *sysupgrade* file.
Download the *Install Checklist* for Mikrotik devices. These devices require a **two-part install** process: First, boot the correct Mikrotik *initramfs-kernel* file, and then use that temporary AREDN® environment to complete the installation of the appropriate *sysupgrade* file.
Mikrotik devices have a built-in `PXE <https://en.wikipedia.org/wiki/Preboot_Execution_Environment>`_ *client* which allows them to download a boot image from an external source. See the **Preparing Your Computer** section above for an explanation. The Windows example below uses *Tiny PXE*, while the Linux example uses the native ``dnsmasq`` program.
@ -208,12 +208,12 @@ For Mikrotik devices you will use what is called *Etherboot* mode, and there are
:alt: Uncheck Mikrotik Protected Boot
:align: right
If your Mikrotik device has "Protected Routerboot" enabled, then you will need to disable it before proceeding. Use the manufacturer's instructions to connect to your device and display the RouterOS web interface or command line. Navigate to *System > Routerboard > Settings > Boot Device* to uncheck or deselect ``Protected Routerboot``. Click the *Apply* button, then you should be able to power down the device and continue with the steps in the AREDN |trade| firmware install checklist.
If your Mikrotik device has "Protected Routerboot" enabled, then you will need to disable it before proceeding. Use the manufacturer's instructions to connect to your device and display the RouterOS web interface or command line. Navigate to *System > Routerboard > Settings > Boot Device* to uncheck or deselect ``Protected Routerboot``. Click the *Apply* button, then you should be able to power down the device and continue with the steps in the AREDN® firmware install checklist.
Install Preparation
- Download *both* of the appropriate Mikrotik *factory* and *sysupgrade* files from the AREDN |trade| website. Rename the *initramfs-kernel* file to ``rb.elf`` and keep the *sysupgrade* **bin** file available for later.
- Download *both* of the appropriate Mikrotik *factory* and *sysupgrade* files from the AREDN® website. Rename the *initramfs-kernel* file to ``rb.elf`` and keep the *sysupgrade* **bin** file available for later.
- Set your computer’s Ethernet network adapter to a static IP address on the subnet you will be using for the new device. This can be any network number of your choice, but it is recommended that you use the 192.168.1.x subnet. Using the 192.168.1.x network on your server will avoid having to change IP addresses on your computer during the install process. AREDN |trade| firmware uses the 192.168.1.x network once it is loaded, so using it all the way through the process will simplify things for you. For example, you can give your computer a static IP such as 192.168.1.10 with a netmask of 255.255.255.0. You can choose any number for the fourth octet, as long as it is *not* within the range of DHCP addresses you will be providing as shown below.
- Set your computer’s Ethernet network adapter to a static IP address on the subnet you will be using for the new device. This can be any network number of your choice, but it is recommended that you use the 192.168.1.x subnet. Using the 192.168.1.x network on your server will avoid having to change IP addresses on your computer during the install process. AREDN® firmware uses the 192.168.1.x network once it is loaded, so using it all the way through the process will simplify things for you. For example, you can give your computer a static IP such as 192.168.1.10 with a netmask of 255.255.255.0. You can choose any number for the fourth octet, as long as it is *not* within the range of DHCP addresses you will be providing as shown below.
- Connect an Ethernet cable from your computer to the network switch as described at the top of this document, then connect another cable from the LAN port of the PoE adapter to the switch. Finally connect an Ethernet cable from the *POE* port to the node, but leave the device powered off for now. If you are flashing a device which uses a separate power adapter (such as a *Mikrotik hAP ac* family device), connect the last Ethernet cable from the switch to the device's WAN port [1].
@ -232,7 +232,7 @@ Linux Procedure
4. With the unit powered off, press and hold the reset button on the radio while powering on the device. Continue to hold the reset button until you see output information from the computer window where you ran the dnsmasq command, which should happen after 20-30 seconds. Release the reset button when you see the "sent" message, which indicates success, and you can now <ctrl>-C or end dnsmasq.
5. The node will now automatically reboot with the temporary AREDN |trade| Administration image.
5. The node will now automatically reboot with the temporary AREDN® Administration image.
Windows Procedure
If you are using a Windows computer, use the following steps.
@ -253,9 +253,9 @@ Windows Procedure
5. Release the node’s reset button and wait for the image to be transferred to the device. You are finished using *Tiny PXE* when the firmware image has been read by the node, so you can click the *Offline* button in *Tiny PXE*.
6. The node will now automatically reboot with the temporary AREDN |trade| Administration image.
6. The node will now automatically reboot with the temporary AREDN® Administration image.
.. tip:: If you have followed the install procedure above but your Mikrotik device does not boot the AREDN |trade| *initramfs-kernel* file, you may be able to try the procedure on this page (`OpenWRT - downgrading RouterOS <https://openwrt.org/toh/mikrotik/common#downgrading_routeros>`_) to downgrade Mikrotik RouterOS prior to flashing the AREDN |trade| firmware. You can find earlier versions in the `Mikrotik Download Archive <https://mikrotik.com/download/archive>`_. Download the ARM version (routeros-arm) for devices that use the *ipq40xx* AREDN |trade| firmware, or download the MIPSBE version (routeros-mipsbe) for other Mikrotik devices. You need to download a RouterOS version that is equal or newer than the RouterOS version shown in the *Factory Firmware* field on your device.
.. tip:: If you have followed the install procedure above but your Mikrotik device does not boot the AREDN® *initramfs-kernel* file, you may be able to try the procedure on this page (`OpenWRT - downgrading RouterOS <https://openwrt.org/toh/mikrotik/common#downgrading_routeros>`_) to downgrade Mikrotik RouterOS prior to flashing the AREDN® firmware. You can find earlier versions in the `Mikrotik Download Archive <https://mikrotik.com/download/archive>`_. Download the ARM version (routeros-arm) for devices that use the *ipq40xx* AREDN® firmware, or download the MIPSBE version (routeros-mipsbe) for other Mikrotik devices. You need to download a RouterOS version that is equal or newer than the RouterOS version shown in the *Factory Firmware* field on your device.
Install the *sysupgrade* Firmware Image
1. After booting the **elf** image the node will have a default IP address of 192.168.1.1. Your computer should already have a static IP address on this subnet, but if not then give your computer an IP address on this subnet.
@ -266,7 +266,7 @@ Install the *sysupgrade* Firmware Image
3. In a web browser, open the node’s Administration page ``http://192.168.1.1/cgi-bin/admin`` (user = 'root', password = 'hsmm') and immediately navigate to the *Firmware Update* section. Browse to find the *sysupgrade* **bin** file you previously downloaded and click the *Upload* button.
As an alternative to using the node's web interface, you can manually copy the *sysupgrade* **bin** file to the node and run a command line program to install the firmware. This will allow you to see any error messages that may not appear when using the web interface. Note that devices running AREDN |trade| firmware images use port 2222 for secure copy/shell access.
As an alternative to using the node's web interface, you can manually copy the *sysupgrade* **bin** file to the node and run a command line program to install the firmware. This will allow you to see any error messages that may not appear when using the web interface. Note that devices running AREDN® firmware images use port 2222 for secure copy/shell access.
Execute the following commands from a Linux computer:
@ -279,14 +279,14 @@ Install the *sysupgrade* Firmware Image
To transfer the image from a Windows computer you can use a *Secure Copy* program such as *WinSCP*. Then use a terminal program such as *PuTTY* to connect to the node via ssh or telnet in order to run the sysupgrade command shown as the last line above.
The node will now automatically reboot with the new AREDN |trade| firmware image.
The node will now automatically reboot with the new AREDN® firmware image.
TP-LINK First Install Process
-----------------------------
Download the *Install Checklist* for TP-LINK devices. These devices may allow you to use the manufacturer's native *PharOS* web browser interface to apply new firmware images. If available, this is the most user-friendly way to install AREDN |trade| firmware. Navigate to the system setup menu to select and upload new firmware. Check the TP-LINK documentation for your device if you have questions about using their built-in user interface. If this process works then you will have AREDN |trade| firmware installed on your device and you skip all of the steps described below.
Download the *Install Checklist* for TP-LINK devices. These devices may allow you to use the manufacturer's native *PharOS* web browser interface to apply new firmware images. If available, this is the most user-friendly way to install AREDN® firmware. Navigate to the system setup menu to select and upload new firmware. Check the TP-LINK documentation for your device if you have questions about using their built-in user interface. If this process works then you will have AREDN® firmware installed on your device and you skip all of the steps described below.
If the process above does not work or if you choose not to use the *PharOS* web interface, then you can install AREDN |trade| firmware on your device using steps similar to those described above for Mikrotik devices. TP-LINK devices are programmed to use `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ for downloading a boot image from an external source. If you already have a `PXE <https://en.wikipedia.org/wiki/Preboot_Execution_Environment>`_ *server* on your Windows computer then you can use that. The example below uses *Tiny PXE*. It may also be possible to use a simple TFTP server instead. For more information, see the **Preparing Your Computer** section above.
If the process above does not work or if you choose not to use the *PharOS* web interface, then you can install AREDN® firmware on your device using steps similar to those described above for Mikrotik devices. TP-LINK devices are programmed to use `TFTP <https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol>`_ for downloading a boot image from an external source. If you already have a `PXE <https://en.wikipedia.org/wiki/Preboot_Execution_Environment>`_ *server* on your Windows computer then you can use that. The example below uses *Tiny PXE*. It may also be possible to use a simple TFTP server instead. For more information, see the **Preparing Your Computer** section above.
Install Preparation
- Download the appropriate TP-LINK *factory* file and rename this file as ``recovery.bin``
@ -308,7 +308,7 @@ Linux Procedure
4. With the unit powered off, press and hold the reset button on the radio while powering on the device. Continue to hold the reset button until you see output information from the computer window where you ran the dnsmasq command, which should happen after 20-30 seconds. Release the reset button when you see the "sent" message, which indicates success, and you can now <ctrl>-C or end dnsmasq.
5. The node will now automatically reboot with the new AREDN |trade| firmware image.
5. The node will now automatically reboot with the new AREDN® firmware image.
Windows Procedure
Configure the PXE or TFTP Server on your Windows computer. The example below uses *Tiny PXE*. For more information, see the **Preparing Your Computer** section above.
@ -327,18 +327,18 @@ Windows Procedure
5. Release the node’s reset button and wait for the image to be transferred to the device. You are finished using *Tiny PXE* when the firmware image has been read by the node, so you can click the *Offline* button in *Tiny PXE*.
6. The node will now automatically reboot with the new AREDN |trade| firmware image.
6. The node will now automatically reboot with the new AREDN® firmware image.
GL-iNet First Install Process
------------------------------
Download the *Install Checklist* for GL-iNet devices. These devices allow you to use the manufacturer's pre-installed *OpenWRT* web interface to upload and apply new firmware images. Check the GL-iNet documentation for your device if you have questions about initial configuration. Both GL-iNet and AREDN |trade| devices provide DHCP services, so you should be able to connect your computer and automatically receive an IP address on the correct subnet. GL-iNet devices usually have a default IP address of 192.168.8.1, so if for some reason you need to give your computer a static IP address you can use that subnet.
Download the *Install Checklist* for GL-iNet devices. These devices allow you to use the manufacturer's pre-installed *OpenWRT* web interface to upload and apply new firmware images. Check the GL-iNet documentation for your device if you have questions about initial configuration. Both GL-iNet and AREDN® devices provide DHCP services, so you should be able to connect your computer and automatically receive an IP address on the correct subnet. GL-iNet devices usually have a default IP address of 192.168.8.1, so if for some reason you need to give your computer a static IP address you can use that subnet.
After the GL-iNet device is first booted and configured, navigate to the **Upgrade** section and click *Local Upgrade* to select the AREDN |trade| *sysupgrade.bin* file you downloaded for your device.
After the GL-iNet device is first booted and configured, navigate to the **Upgrade** section and click *Local Upgrade* to select the AREDN® *sysupgrade.bin* file you downloaded for your device.
.. warning:: Be sure to uncheck the **Keep Settings** checkbox, since GL.iNet settings are incompatible with AREDN |trade| firmware. Also, the AR300M16 devices may have a *boot_dev* switch, so be sure to read the `GL.iNet boot documentation <https://docs.gl-inet.com/router/en/3/specification/gl-ar300m/#control-which-firmware-you-are-booting-into>`_ to select the correct boot mode.
.. warning:: Be sure to uncheck the **Keep Settings** checkbox, since GL.iNet settings are incompatible with AREDN® firmware. Also, the AR300M16 devices may have a *boot_dev* switch, so be sure to read the `GL.iNet boot documentation <https://docs.gl-inet.com/router/en/3/specification/gl-ar300m/#control-which-firmware-you-are-booting-into>`_ to select the correct boot mode.
The node will automatically reboot with the new AREDN |trade| firmware image. If for some reason your GL-iNet device gets into an unusable state, you should be able to recover using the process documented here:
The node will automatically reboot with the new AREDN® firmware image. If for some reason your GL-iNet device gets into an unusable state, you should be able to recover using the process documented here:
`GL-iNet debrick procedure <https://docs.gl-inet.com/en/3/tutorials/debrick/>`_
After the Firmware Install
@ -346,6 +346,6 @@ After the Firmware Install
After the node reboots, it should have a default IP address of 192.168.1.1. Make sure your computer has an IP address on the 192.168.1.x network. You should be able to ping the node at 192.168.1.1. Don't proceed until you can ping the node. You may need to disconnect and reconnect your computer's network cable to ensure that it has a connection.
Once your device is running AREDN |trade| firmware, you can display its web interface by navigating to either ``http://192.168.1.1`` or ``http://localnode.local.mesh``. Some computers may have DNS search paths configured that require you to use the `fully qualified domain name (FQDN) <https://en.wikipedia.org/wiki/Fully_qualified_domain_name>`_ to resolve *localnode* to the mesh node's IP address. You may need to clear your web browser's cache in order to remove any cached pages.
Once your device is running AREDN® firmware, you can display its web interface by navigating to either ``http://192.168.1.1`` or ``http://localnode.local.mesh``. Some computers may have DNS search paths configured that require you to use the `fully qualified domain name (FQDN) <https://en.wikipedia.org/wiki/Fully_qualified_domain_name>`_ to resolve *localnode* to the mesh node's IP address. You may need to clear your web browser's cache in order to remove any cached pages.
You can use your web browser to configure the new node with your callsign, admin password, and other settings as described in the **Firstboot Node Setup** section of the documentation.

44
arednGettingStarted/node_admin.rst
View File

@ -4,7 +4,7 @@ Node Admin Guide
You must login as the node administrator in order to perform node management tasks.
|icon1| Click the user icon at the far right of the top nav bar. Select ``login`` and enter your node's admin password (which was configured when you installed the AREDN |trade| firmware).
|icon1| Click the user icon at the far right of the top nav bar. Select ``login`` and enter your node's admin password (which was configured when you installed the AREDN® firmware).
|icon2| Upon successful authentication you will see the admin icon, and the label to the right of your node name should say *admin*.
@ -32,7 +32,7 @@ The Name & Security section allows you to configure the following settings. Cont
|
Node Name
Begin the node name with your callsign, followed by unique identifying information of your choice. Node names may contain up to 63 letters, numbers, and dashes, but cannot begin or end with a dash. Underscores, spaces, or any other characters are not allowed. Node names are not case sensitive, but the case will be preserved on the node status display. Amateur radio operators are required to identify all transmitting stations. The AREDN |trade| node name is beaconed automatically by the node every five minutes, so the node name must contain your callsign. Recommended names follow the (callsign)-(label) format, such as AD5BC-MOBILE or AD5BC-120SE. As a general rule node names should be kept as short as possible, while clearly and uniquely identifying the node.
Begin the node name with your callsign, followed by unique identifying information of your choice. Node names may contain up to 63 letters, numbers, and dashes, but cannot begin or end with a dash. Underscores, spaces, or any other characters are not allowed. Node names are not case sensitive, but the case will be preserved on the node status display. Amateur radio operators are required to identify all transmitting stations. The AREDN® node name is beaconed automatically by the node every five minutes, so the node name must contain your callsign. Recommended names follow the (callsign)-(label) format, such as AD5BC-MOBILE or AD5BC-120SE. As a general rule node names should be kept as short as possible, while clearly and uniquely identifying the node.
Description
This is not a required field, but it is a good place to describe the features or function of this device. Many operators use this field to list their contact information or the tactical purpose for the node. There are no character restrictions in the field, but the maximum length allowed is 210 characters.
@ -52,7 +52,7 @@ By clicking **Advanced Options** you can configure additional settings.
|
Upload SSH Key
Uploading SSH keys allows computers to connect to the node via SSH without having to know the password. The SSH keys are generated on your computer using built-in utilities or the `PuTTY <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`_ program's *Key Generator*. Once you have the key files on your computer, you can upload the *public* key to your AREDN |trade| node. Click the ``Browse`` button and locate the *public* key file, then click the ``Upload Key`` button at the lower right. SSH keys are only valid if they contain a string in the form of ``<USER>@<SOMEWHERE>`` in the comment section of the key. SSH keys generated with the above tools add this comment by default.
Uploading SSH keys allows computers to connect to the node via SSH without having to know the password. The SSH keys are generated on your computer using built-in utilities or the `PuTTY <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`_ program's *Key Generator*. Once you have the key files on your computer, you can upload the *public* key to your AREDN® node. Click the ``Browse`` button and locate the *public* key file, then click the ``Upload Key`` button at the lower right. SSH keys are only valid if they contain a string in the form of ``<USER>@<SOMEWHERE>`` in the comment section of the key. SSH keys generated with the above tools add this comment by default.
.. note:: If you plan to use ssh keys you may want to review **Use PuTTYGen to Make SSH Keys** in the **How-To Guide** section which describes this process in detail for users of Microsoft Windows computers.
@ -89,7 +89,7 @@ Download Firmware
If your node has Internet access or access to a firmware repository on your local network, you can click the *refresh* icon on the right side of the field in order to update the list of available images. Select the image to install and click the ``Fetch and Update`` button to begin the process. You may need to scroll down in the display to see the ``Fetch and Update`` button.
Upload Firmware
If you have a new firmware image that you already downloaded to your local computer from the AREDN |trade| website or a local firmware repository, click the ``Browse`` button and navigate to the location where you saved the firmware file. Select the image to install and click the ``Fetch and Update`` button to begin the process. You may need to scroll down in the display to see the ``Fetch and Update`` button.
If you have a new firmware image that you already downloaded to your local computer from the AREDN® website or a local firmware repository, click the ``Browse`` button and navigate to the location where you saved the firmware file. Select the image to install and click the ``Fetch and Update`` button to begin the process. You may need to scroll down in the display to see the ``Fetch and Update`` button.
Sideload Local Firmware
If you need to remotely upgrade the firmware on a node which has a marginal connection to the network, the standard web/http method may not reliably transfer the image to the node. In this situation you may want to use an independent means of uploading the firmware to the node before beginning the upgrade process. Choose an upload method such as ``scp`` (secure copy) with a long connection timeout, which may allow the file transfer to continue the upload in the event of a network interruption. Transfer the new firmware file to your node, place it in the ``/tmp/web`` folder, and name it ``local_firmware.bin``. Once the node detects the presence of ``/tmp/web/local_firmware.bin``, then the filename in the field at the right will be active. Click the ``Fetch and Update`` button to begin the process. You may need to scroll down in the display to see the ``Fetch and Update`` button.
@ -111,7 +111,7 @@ Dangerous Upgrade
This setting allows you to disable the normal firmware compatibility safety checks that typically prevent you from loading the wrong firmware image on your node. The default setting is ``disabled`` which means that the safety checks remain active, and this setting should not be changed unless you have a specific reason to bypass the firmware compatibility checks. One example for using this setting would be if you mistakenly installed an incorrect firmware image and would like to correct that mistake by installing the correct firmware image.
Firmware URL
This is the source URL that is queried by the *Download Firmware* process in order to refresh the list of available firmware for your node. The default value is ``https://downloads.arednmesh.org`` which allows your Internet-connected node to retrieve firmware from the AREDN |trade| website. You can also set this firmware URL to a local network server which provides firmware images.
This is the source URL that is queried by the *Download Firmware* process in order to refresh the list of available firmware for your node. The default value is ``https://downloads.arednmesh.org`` which allows your Internet-connected node to retrieve firmware from the AREDN® website. You can also set this firmware URL to a local network server which provides firmware images.
When you are finished with your changes, click the ``Done`` button.
@ -127,7 +127,7 @@ This display allows you to install or remove software packages on the node. When
|
Download Package
If the node has a connection to the Internet, it can retrieve a package from the AREDN |trade| website. Click the *refresh* icon at the right of the field to update the list of packages available for download. Select the package you want to install, click the ``Fetch and Install`` button, and wait for the package to be installed. A progress bar at the bottom of the display will show the status of the process. A status message will appear at the top of the display to indicate whether the package was installed successfully.
If the node has a connection to the Internet, it can retrieve a package from the AREDN® website. Click the *refresh* icon at the right of the field to update the list of packages available for download. Select the package you want to install, click the ``Fetch and Install`` button, and wait for the package to be installed. A progress bar at the bottom of the display will show the status of the process. A status message will appear at the top of the display to indicate whether the package was installed successfully.
Upload Package
If you have a package file that you already downloaded to your local computer from a package repository, click the ``Browse`` button and navigate to the location where you saved the package file. After selecting the package, click the ``Fetch and Update`` button and wait for the package to be uploaded and installed. A progress bar at the bottom of the display will show the status of the upload and install. A status message will appear at the top of the display to indicate whether the package was installed successfully.
@ -138,7 +138,7 @@ Remove Package
By clicking **Advanced Options** you can configure additional settings.
Package URL
This field contains the URL which your node will use to download packages. The default value is ``https://downloads.arednmesh.org`` which allows your Internet-connected node to retrieve packages from the AREDN |trade| website. You can also set this package URL to a local network server which provides packages.
This field contains the URL which your node will use to download packages. The default value is ``https://downloads.arednmesh.org`` which allows your Internet-connected node to retrieve packages from the AREDN® website. You can also set this package URL to a local network server which provides packages.
When you are finished with your changes, click the ``Done`` button.
@ -154,7 +154,7 @@ This display allows you to update the network settings on your node. Context-sen
|
Mesh Address
This is the primary IP address of your node. The AREDN |trade| firmware has been designed to simplify the process of configuring network interfaces. Network values are automatically calculated based on the unique :abbr:`MAC (Media Access Control)` addresses of your node. Normally you will not need to change this, so keep this value unless you fully understand how the mesh works and why the defaults may not be suitable for your situation.
This is the primary IP address of your node. The AREDN® firmware has been designed to simplify the process of configuring network interfaces. Network values are automatically calculated based on the unique :abbr:`MAC (Media Access Control)` addresses of your node. Normally you will not need to change this, so keep this value unless you fully understand how the mesh works and why the defaults may not be suitable for your situation.
LAN Size
This allows you to set the number of devices your node will be able to host on its Local Area Network (LAN). Click in the field at the right to see the dropdown list of options for the size of your node's LAN. The default value is ``5`` hosts.
@ -187,9 +187,9 @@ By clicking **Advanced Options** you can configure additional settings.
|
WAN VLAN
Many of the devices used as AREDN |trade| nodes have only one Ethernet port, but more than one type of network traffic must share that single port. The AREDN |trade| firmware implements :abbr:`VLANs (Virtual Local Area Network)` in order to accomplish this. Different types of traffic are tagged to identify the network to which they belong. By default the WAN uses an *untagged* VLAN on multi-port devices, and ``VLAN 1`` on single port devices. This can be changed if your network requires something different. Enter the VLAN number or leave the field blank for *untagged*. If you change this setting, do not use single digit identifiers or any number larger than can be supported by your network equipment. Different types of network equipment can support various numbers of VLANS, but the maximum number is limited by the `802.1Q standard <https://en.wikipedia.org/wiki/IEEE_802.1Q#Frame_format>`_ to no more than 4094.
Many of the devices used as AREDN® nodes have only one Ethernet port, but more than one type of network traffic must share that single port. The AREDN® firmware implements :abbr:`VLANs (Virtual Local Area Network)` in order to accomplish this. Different types of traffic are tagged to identify the network to which they belong. By default the WAN uses an *untagged* VLAN on multi-port devices, and ``VLAN 1`` on single port devices. This can be changed if your network requires something different. Enter the VLAN number or leave the field blank for *untagged*. If you change this setting, do not use single digit identifiers or any number larger than can be supported by your network equipment. Different types of network equipment can support various numbers of VLANS, but the maximum number is limited by the `802.1Q standard <https://en.wikipedia.org/wiki/IEEE_802.1Q#Frame_format>`_ to no more than 4094.
The following VLANs are preconfigured in the AREDN |trade| firmware:
The following VLANs are preconfigured in the AREDN® firmware:
- VLAN 1: these packets will be identified as WAN traffic from the Internet or another external network.
@ -197,10 +197,10 @@ WAN VLAN
- No VLAN tag: these packets will be identified as LAN traffic from devices on the local area network.
It is important to understand AREDN |trade| VLANs when configuring network smart switches for Internet access, tunneling, or DtD linking of nodes. There are some useful tutorials available on the AREDN |trade| website for configuring VLAN-capable switches: `Video <https://www.arednmesh.org/content/understanding-vlans>`_ or `Text+Images <https://www.arednmesh.org/content/configuring-netgear-gs105e-switch-lanwan-ports>`_. Also, on the AREDN |trade| GitHub site there is more information about node VLANs that have been preconfigured in the firmware images for specific types of radio hardware (`Ethernet Port Usage <http://downloads.arednmesh.org/snapshots/readme.md>`_)
It is important to understand AREDN® VLANs when configuring network smart switches for Internet access, tunneling, or DtD linking of nodes. There are some useful tutorials available on the AREDN® website for configuring VLAN-capable switches: `Video <https://www.arednmesh.org/content/understanding-vlans>`_ or `Text+Images <https://www.arednmesh.org/content/configuring-netgear-gs105e-switch-lanwan-ports>`_. Also, on the AREDN® GitHub site there is more information about node VLANs that have been preconfigured in the firmware images for specific types of radio hardware (`Ethernet Port Usage <http://downloads.arednmesh.org/snapshots/readme.md>`_)
Mesh to WAN
Enabling this switch will allow your node to route traffic from its Mesh interface to/from its WAN interface. This allows any device on the local mesh network to use the WAN on your node, typically for accessing the Internet. It is usually not desirable to route Internet traffic over your Mesh interface. AREDN |trade| is an FCC Part 97 amateur radio network, so be sure that any traffic which will be sent over the radio complies with FCC Part 97 rules. If you want local devices to have wireless Internet access, consider using an FCC Part 15 access point instead of your node's WAN gateway. The default value is ``disabled`` and it is recommended that you keep this default unless there is a special reason to enable it.
Enabling this switch will allow your node to route traffic from its Mesh interface to/from its WAN interface. This allows any device on the local mesh network to use the WAN on your node, typically for accessing the Internet. It is usually not desirable to route Internet traffic over your Mesh interface. AREDN® is an FCC Part 97 amateur radio network, so be sure that any traffic which will be sent over the radio complies with FCC Part 97 rules. If you want local devices to have wireless Internet access, consider using an FCC Part 15 access point instead of your node's WAN gateway. The default value is ``disabled`` and it is recommended that you keep this default unless there is a special reason to enable it.
LAN to WAN
The default value is ``enabled`` which allows devices on your node's LAN to access your node's WAN network. Setting this value to ``disabled`` will prevent LAN devices from accessing the WAN, which means that your LAN hosts will not be able to reach the Internet even if your node has Internet access via its WAN. You may need to disable WAN access if your device needs to be connected to two networks at once, such as an Ethernet connection to your node as well as a wifi connection to a local served agency network.
@ -234,7 +234,7 @@ By clicking **Advanced Options** you can configure additional settings.
|
Map URL
The map URL is used to embed maps in your node's displays. The default value is ``https://worldmap.arednmesh.org/#12/(lat)/(lon)`` which attempts to get the map data from the AREDN |trade| server. The (lat) and (lon) parameters in the URL are substitutes with your GPS coordinates before the map is rendered.
The map URL is used to embed maps in your node's displays. The default value is ``https://worldmap.arednmesh.org/#12/(lat)/(lon)`` which attempts to get the map data from the AREDN® server. The (lat) and (lon) parameters in the URL are substitutes with your GPS coordinates before the map is rendered.
You can click the ``Cancel`` button to ignore any changes you made on this display. When you are finished with your changes, click the ``Done`` button. You will then be returned to your node's *admin* view where you will be able to ``Commit`` or ``Revert`` your changes.
@ -290,7 +290,7 @@ PoE and USB Power Passthrough
These settings will only appear 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 (5v) as well as PoE power passthrough on Ethernet port 5 (~22v). You are allowed to enable or disable power passthrough on nodes with ports that support this feature.
Message Updates
The AREDN |trade| development team may post messages which Internet-connected nodes will automatically download and display. You may also use a local message source to display messages on your node's status page. Enter an integer in this field for the number of hours you want your node to wait before refreshing its messages. The default value is ``1`` hour between updates.
The AREDN® development team may post messages which Internet-connected nodes will automatically download and display. You may also use a local message source to display messages on your node's status page. Enter an integer in this field for the number of hours you want your node to wait before refreshing its messages. The default value is ``1`` hour between updates.
.. image:: _images/admin-internal-svc-3.png
:alt: Admin Internal Services continued
@ -622,7 +622,7 @@ Advanced Options
Ethernet Ports and Xlinks
-------------------------
If you have a supported multiport device, then you will see an *Ethernet Ports and Xlinks* section. This provides a way for you to configure the ports on your multiport node. For more information on the AREDN |trade| VLANs being used, refer to the *VLAN* description in the **Network Settings** section above. Context-sensitive help is available by clicking the ``Help`` button.
If you have a supported multiport device, then you will see an *Ethernet Ports and Xlinks* section. This provides a way for you to configure the ports on your multiport node. For more information on the AREDN® VLANs being used, refer to the *VLAN* description in the **Network Settings** section above. Context-sensitive help is available by clicking the ``Help`` button.
.. image:: _images/admin-ports-xlinks.png
@ -636,21 +636,21 @@ Ports
- The first port is configured as a WAN port. The data entry field to the right of the *vlan* label can contain any valid vlan identifier if it is required, typically in the range between 1 and 4094. The default for these multiport devices is no vlan (untagged), so leave the default unless there is a specific reason why it is required in your situation.
- The middle ports are configured as LAN ports with no vlan (untagged).
- The last port is configured for DtD linking to another AREDN |trade| node using vlan2 (tagged).
- The last port is configured for DtD linking to another AREDN® node using vlan2 (tagged).
If you want to change a port's configuration, simply check or uncheck the settings desired on each port.
Xlinks
A cross-link allows your node to pass AREDN |trade| traffic across non-AREDN |trade| point-to-point links. To add a cross-link click the [+] icon, enter an unused VLAN number for the link, the IP address of the near-side device, the IP address of the far-side device, a weighting factor, the `CIDR <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing>`_ netmask, and the port to which the near-side device is connected on your node. The *Weight* will be used by `OLSR <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to determine the best route for AREDN |trade| traffic. If you want to remove a cross-link, simply click the [-] icon on the right side of the row to remove it.
A cross-link allows your node to pass AREDN® traffic across non-AREDN® point-to-point links. To add a cross-link click the [+] icon, enter an unused VLAN number for the link, the IP address of the near-side device, the IP address of the far-side device, a weighting factor, the `CIDR <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing>`_ netmask, and the port to which the near-side device is connected on your node. The *Weight* will be used by `OLSR <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to determine the best route for AREDN® traffic. If you want to remove a cross-link, simply click the [-] icon on the right side of the row to remove it.
You can click the ``Cancel`` button to ignore any changes you made on this display. When you are finished with your changes, click the ``Done`` button. You will then be returned to your node's *admin* view where you will be able to ``Commit`` or ``Revert`` any changes.
Tunnel Settings
---------------
Tunnels are typically used as a means of connecting mesh islands if RF links cannot be established. Before using the AREDN |trade| tunnel feature, be aware of how this type of connection could impact your local mesh network. If your node participates in a local mesh, then adding one or more tunnel connections will cause the nodes and hosts on the far side of the tunnel(s) to appear as part of your local mesh network. This essentially joins the two networks into a single large network, increasing the total network traffic across the entire range of devices.
Tunnels are typically used as a means of connecting mesh islands if RF links cannot be established. Before using the AREDN® tunnel feature, be aware of how this type of connection could impact your local mesh network. If your node participates in a local mesh, then adding one or more tunnel connections will cause the nodes and hosts on the far side of the tunnel(s) to appear as part of your local mesh network. This essentially joins the two networks into a single large network, increasing the total network traffic across the entire range of devices.
If you want to participate in remote mesh networks, consider using the *Cloud Mesh* network established through worldwide Supernodes. If your local network does not have a Supernode and you need to connect to another remote network, consider establishing a tunnel from one of your nodes that is *not* connected to your local mesh. Remember that AREDN |trade| is first and foremost an emergency communication resource, so it's possible that Internet-dependent links and the assets they provide will not be available during a disaster.
If you want to participate in remote mesh networks, consider using the *Cloud Mesh* network established through worldwide Supernodes. If your local network does not have a Supernode and you need to connect to another remote network, consider establishing a tunnel from one of your nodes that is *not* connected to your local mesh. Remember that AREDN® is first and foremost an emergency communication resource, so it's possible that Internet-dependent links and the assets they provide will not be available during a disaster.
Internet Connectivity Requirements
++++++++++++++++++++++++++++++++++
@ -663,7 +663,7 @@ In order to run your node as either a *Tunnel Server* or *Tunnel Client*, you wi
|
If you are using *Mikrotik hAP ac* or *GL.iNET* devices, those multiport nodes have the appropriate VLANs preconfigured by the AREDN |trade| firmware. If you are using any other type of node, then you will need to configure a separate VLAN-capable switch. Set your VLAN-capable network switch to appropriately tag traffic from the Internet with *VLAN 1* before sending it to your node. This allows your node to properly identify the traffic as coming from the Internet to its WAN interface. See the equipment manual for your smart switch to determine how to configure these settings.
If you are using *Mikrotik hAP ac* or *GL.iNET* devices, those multiport nodes have the appropriate VLANs preconfigured by the AREDN® firmware. If you are using any other type of node, then you will need to configure a separate VLAN-capable switch. Set your VLAN-capable network switch to appropriately tag traffic from the Internet with *VLAN 1* before sending it to your node. This allows your node to properly identify the traffic as coming from the Internet to its WAN interface. See the equipment manual for your smart switch to determine how to configure these settings.
.. image:: _images/admin-tunnel-1.png
:alt: Admin Tunnel Settings 1
@ -774,12 +774,12 @@ iPerf3
You can click the down arrow icon at the right of the *Target Address* and *Source Address* fields to select the desired nodes from a dropdown list. If your desired device is not shown, you can click in the fields to enter or edit the device name that you want to test. After selecting the *Target* and *Source* devices, click the ``Go`` button to the bottom right of the results field to view the results. You may want to test network throughput in both directions by clicking the double-arrow icon to swap the *Target* and *Source* devices. When you are finished studying the results, click the ``Done`` button to return to the status display.
Support Data
There may be times when you want to view more detailed information about the configuration and operation of your node, or even forward this information to the AREDN |trade| team in order to get help with a problem. Click the *Support Data* icon to save a compressed archive file to your local computer.
There may be times when you want to view more detailed information about the configuration and operation of your node, or even forward this information to the AREDN® team in order to get help with a problem. Click the *Support Data* icon to save a compressed archive file to your local computer.
Node Reset Button Actions
-------------------------
The reset button on an AREDN |trade| node has two built-in functions based on the length of time the button is pressed.
The reset button on an AREDN® node has two built-in functions based on the length of time the button is pressed.
With the node powered on and fully booted:

8
arednGettingStarted/node_status.rst
View File

@ -2,7 +2,7 @@
Node Status Display
===================
Once you have completed the initial setup on your AREDN |trade| node, you can connect your computer to a :abbr:`LAN (Local Area Network)` port on the device or the :abbr:`PoE (Power over Ethernet)` and use a web browser to navigate to the **node status** page.
Once you have completed the initial setup on your AREDN® node, you can connect your computer to a :abbr:`LAN (Local Area Network)` port on the device or the :abbr:`PoE (Power over Ethernet)` and use a web browser to navigate to the **node status** page.
``http://localnode.local.mesh`` or ``http://<your-nodename>.local.mesh``
.. image:: _images/node-status-columns.png
@ -14,7 +14,7 @@ This display has been designed to present all of the important information about
Top Nav Bar
-----------
From left to right, after the AREDN |trade| logo, the node name is displayed along with a label indicating whether you are viewing the *status* or *admin* display.
From left to right, after the AREDN® logo, the node name is displayed along with a label indicating whether you are viewing the *status* or *admin* display.
|icon1| At the far right is the default icon indicating that you are viewing the page as a normal user. Clicking this icon will allow you to login as the node administrator.
@ -31,7 +31,7 @@ Using the icons on the left side bar you can navigate to various displays.
|icon5| navigates to the *Cloud Mesh* view through the Supernode network (if available).
|icon6| navigates to the world map on the AREDN |trade| website.
|icon6| navigates to the world map on the AREDN® website.
Left Column
-----------
@ -45,7 +45,7 @@ Node Time, Uptime, Load Average, and Free Memory
The node time is displayed, as well as the ``uptime``, which is the time since the last reboot. If an Internet connection or a local :abbr:`NTP (Network Time Protocol)` server is available, your node's NTP client will sync its time with that time source. The ``load`` is the average system utilization for the last 1, 5, and 15 minutes. ``free flash`` and ``free ram`` shows how much storage space is remaining on your node. ``flash`` is the internal non-volatile storage where the operating system, configuration files, and software packages are kept. ``ram`` is the amount of :abbr:`RAM (Random Access Memory)` available for running processes on the node.
Firmware Information
This displays the node's current firmware version. A badge on the right indicates the status of the firmware, with valid values including ``Up to date``, ``Update available``, and ``Custom``. If your node has access to the Internet you can also click on the *issues* label below the firmware version, and this will open the AREDN |trade| `Issues <https://github.com/aredn/aredn/issues>`_ page on GitHub. Clicking the *release notes* label will open the `Changelog <https://downloads.arednmesh.org/snapshots/CHANGELOG.md>`_ page on the AREDN |trade| website.
This displays the node's current firmware version. A badge on the right indicates the status of the firmware, with valid values including ``Up to date``, ``Update available``, and ``Custom``. If your node has access to the Internet you can also click on the *issues* label below the firmware version, and this will open the AREDN® `Issues <https://github.com/aredn/aredn/issues>`_ page on GitHub. Clicking the *release notes* label will open the `Changelog <https://downloads.arednmesh.org/snapshots/CHANGELOG.md>`_ page on the AREDN® website.
Network Information
The Mesh IP address/netmask is displayed using `CIDR <https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing>`_ notation, followed by the :abbr:`LAN (Local Area Network)` IP address/netmask. If the :abbr:`WAN (Wide Area Network)` interface is enabled, the WAN IP address/netmask is displayed along with whether this address was obtained via `DHCP <https://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol>`_ or assigned as a static IP address. The WAN gateway IP address is also displayed along with the IP(s) of the WAN `DNS servers <https://en.wikipedia.org/wiki/Domain_Name_System>`_.

6
arednGettingStarted/report_issues.rst
View File

@ -2,9 +2,9 @@
Reporting Problems or Issues
============================
If you experience issues with building or using AREDN |trade| devices, there are several sources of help. There is an active user community that regularly contributes to the AREDN |trade| `Forum <https://www.arednmesh.org/forum>`_, and you can post your experience there to receive help and feedback.
If you experience issues with building or using AREDN® devices, there are several sources of help. There is an active user community that regularly contributes to the AREDN® `Forum <https://www.arednmesh.org/forum>`_, and you can post your experience there to receive help and feedback.
However, if you have issues that you think should be investigated by the AREDN |trade| development team, you can follow the steps below for engaging with the software developers.
However, if you have issues that you think should be investigated by the AREDN® development team, you can follow the steps below for engaging with the software developers.
Download a Support Data File
.. image:: _images/admin-support-data.png
@ -19,7 +19,7 @@ Create a GitHub account
1. Open your web browser and navigate to the `GitHub URL <https://github.com>`_.
2. Click the ``Sign Up`` button and enter the required information. We suggest using your callsign as the username.
3. On the GitHub website, click the ``Sign In`` button and authenticate to GitHub with the credentials you created.
4. Navigate on GitHub to the AREDN |trade| code repository: ``https://github.com/aredn/aredn``
4. Navigate on GitHub to the AREDN® code repository: ``https://github.com/aredn/aredn``
Open a new issue on GitHub
.. image:: _images/github-issues.png

18
arednGettingStarted/selecting_devices.rst
View File

@ -2,19 +2,19 @@
Selecting Radio Hardware
========================
The amateur radio community has recognized the benefits of using inexpensive commercial :abbr:`WISP (Wireless Internet Service Provider)` radios to create AREDN |trade| networks. Each of these devices come with the vendor's firmware pre-installed, but by following a few simple steps this firmware can be replaced with an AREDN |trade| firmware image.
The amateur radio community has recognized the benefits of using inexpensive commercial :abbr:`WISP (Wireless Internet Service Provider)` radios to create AREDN® networks. Each of these devices come with the vendor's firmware pre-installed, but by following a few simple steps this firmware can be replaced with an AREDN® firmware image.
Several open source software projects have been adapted and enhanced to create the AREDN |trade| firmware, including `OpenWRT (Open Wireless Router) <https://en.wikipedia.org/wiki/OpenWRT>`_ and `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_.
Several open source software projects have been adapted and enhanced to create the AREDN® firmware, including `OpenWRT (Open Wireless Router) <https://en.wikipedia.org/wiki/OpenWRT>`_ and `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_.
The AREDN |trade| team builds specific firmware images tailored to each type of radio, and the current list of supported devices is found on the AREDN |trade| website. For a complete list of all supported hardware, including both *Stable Release* and *Nightly Build* firmware, refer to the `Supported Devices <http://downloads.arednmesh.org/snapshots/SUPPORTED_DEVICES.md>`_ list.
The AREDN® team builds specific firmware images tailored to each type of radio, and the current list of supported devices is found on the AREDN® website. For a complete list of all supported hardware, including both *Stable Release* and *Nightly Build* firmware, refer to the `Supported Devices <http://downloads.arednmesh.org/snapshots/SUPPORTED_DEVICES.md>`_ list.
When selecting a device for your AREDN |trade| hardware there are several things to consider in your decision.
When selecting a device for your AREDN® hardware there are several things to consider in your decision.
- Radios should be purchased for the specific frequency band on which they will operate. Currently AREDN |trade| supports devices which operate in several bands. Check the `frequency and channel chart <https://arednmesh.readthedocs.io/en/latest/appendix/freq_charts.html>`_ on the AREDN |trade| website for the latest information.
- Radios should be purchased for the specific frequency band on which they will operate. Currently AREDN® supports devices which operate in several bands. Check the `frequency and channel chart <https://arednmesh.readthedocs.io/en/latest/appendix/freq_charts.html>`_ on the AREDN® website for the latest information.
- Many devices have an integrated dual-polarity :abbr:`MIMO (Multiple Input-Multiple Output)` antenna which helps to leverage multipath propagation. AREDN |trade| has always supported and recommended using MIMO hardware, since these devices typically outperform single chain radios when used as mesh nodes.
- Many devices have an integrated dual-polarity :abbr:`MIMO (Multiple Input-Multiple Output)` antenna which helps to leverage multipath propagation. AREDN® has always supported and recommended using MIMO hardware, since these devices typically outperform single chain radios when used as mesh nodes.
- Radios can be purchased separately from the antenna, so it is possible to have more than one antenna option for a radio in order to optimize AREDN |trade| nodes for varying deployment conditions.
- Radios can be purchased separately from the antenna, so it is possible to have more than one antenna option for a radio in order to optimize AREDN® nodes for varying deployment conditions.
- Costs of devices range from $25 to several hundred dollars for a complete node/antenna system, so there are many options even for the budget-conscious operator.
@ -22,8 +22,8 @@ When selecting a device for your AREDN |trade| hardware there are several things
- Check the maximum power output of the device, since some devices have lower power capabilities.
One of the best sources of detailed hardware information is a manufacturer's datasheet, usually available for download from the manufacturer's website. Currently AREDN |trade| supports dozens of device models from manufacturers including GL-iNet, Mikrotik, TP-LINK, and Ubiquiti Networks.
One of the best sources of detailed hardware information is a manufacturer's datasheet, usually available for download from the manufacturer's website. Currently AREDN® supports dozens of device models from manufacturers including GL-iNet, Mikrotik, TP-LINK, and Ubiquiti Networks.
If you are just getting started with AREDN |trade| you can easily begin with one of the low-cost devices that comes with an integrated antenna and a :abbr:`PoE (Power over Ethernet)` unit. If you are expanding your AREDN |trade| network with more sophisticated equipment, you may choose a standalone radio attached to a high-gain antenna.
If you are just getting started with AREDN® you can easily begin with one of the low-cost devices that comes with an integrated antenna and a :abbr:`PoE (Power over Ethernet)` unit. If you are expanding your AREDN® network with more sophisticated equipment, you may choose a standalone radio attached to a high-gain antenna.
.. note:: See the **Network Design Guide** for more information about constructing robust mesh networks.

18
arednHow-toGuides/beginner-guide.rst
View File

@ -7,7 +7,7 @@ Beginner's Guide
What it’s all about
-------------------
By loading the AREDN |trade| firmware in a outdoor wireless access point, you can join a ham radio network. It’s like the Internet but runs on ham radio frequencies, mostly in the 2.4, 3.4, and 5.8 GHz bands. By joining this network you can find and use all sorts of applications (known as “services”). Anything running on a server, like weather stations, web sites showing site conditions, and email servers can be provided as a service. There are also services that don’t rely on a browser: video streams, chat servers, and VOIP PBXes. The network can also be used to connect Winlink stations, Dstar and DMR repeaters, and Allstar devices. Pretty much any kind of service you can put on the Internet you can put on the AREDN network, subject to the restrictions of the ham radio regulations (FCC “Part 97”).
By loading the AREDN® firmware in a outdoor wireless access point, you can join a ham radio network. It’s like the Internet but runs on ham radio frequencies, mostly in the 2.4, 3.4, and 5.8 GHz bands. By joining this network you can find and use all sorts of applications (known as “services”). Anything running on a server, like weather stations, web sites showing site conditions, and email servers can be provided as a service. There are also services that don’t rely on a browser: video streams, chat servers, and VOIP PBXes. The network can also be used to connect Winlink stations, Dstar and DMR repeaters, and Allstar devices. Pretty much any kind of service you can put on the Internet you can put on the AREDN network, subject to the restrictions of the ham radio regulations (FCC “Part 97”).
RF access to the network
------------------------
@ -36,23 +36,23 @@ Alternative to RF network access
If after doing your research you find that you don’t have any RF path to the network, don’t despair; there is an alternative. The nodes have the capability of ‘tunneling’ over the Internet to another node. While this isn’t a radio connection, it will let you get on the network until such time as the network has grown into your area.
In order to establish a tunnel, you’ll need an additional piece of network equipment beyond the node itself. The current preferred device is the Mikrotik hAP AC Lite router which when running AREDN |trade| firmware will provide your node access to the Internet (plus a host of other really useful features when running a ham network in your shack). Current price on Amazon is about $50.
In order to establish a tunnel, you’ll need an additional piece of network equipment beyond the node itself. The current preferred device is the Mikrotik hAP AC Lite router which when running AREDN® firmware will provide your node access to the Internet (plus a host of other really useful features when running a ham network in your shack). Current price on Amazon is about $50.
Recommended equipment
---------------------
The following recommendations are for a home station. Recommendations for network nodes on hilltops are likely to be different and beyond the scope of this introductory article. In order to ensure good performance you need a strong RF link to the network. Like most other ham radio activities, more gain is better than less. And even if you have two nodes within range the node’s routing software will always pick the strongest one as your path into the network. Omnidirectional antennas are discouraged and dish antennas greatly preferred.
All of the equipment using dish antennas supported by AREDN |trade| use electronics integrated into the feedpoint: two transceivers, two modems, and an embedded computer with RAM, ROM, and a network interface. They are all POE-enabled (Power Over Ethernet). This avoids having to run both a network cable and a power cable up a mast to the node. A web interface is used to control and configure the device.
All of the equipment using dish antennas supported by AREDN® use electronics integrated into the feedpoint: two transceivers, two modems, and an embedded computer with RAM, ROM, and a network interface. They are all POE-enabled (Power Over Ethernet). This avoids having to run both a network cable and a power cable up a mast to the node. A web interface is used to control and configure the device.
Obviously your equipment will need to be on the same band as the node you want to connect to. If there are both 2 GHz and 5 GHz nodes equidistant from you with similar path characteristics, choose 5 GHz. That band is quieter, there’s more bandwidth, more channels, and the gear is about the same cost (and in some cases noticeably less).
Fortunately AREDN |trade| now supports dozens devices (including new ones added in the nightly builds), so there are many options when choosing what to buy. The AREDN |trade| team has flagged *Sunset devices* that are no longer recommended for new purchase in the `Supported Platform Matrix: <https://www.arednmesh.org/content/supported-devices-0>`_. The Mikrotik dishes may be slightly less durable than equivalent Ubiquiti dishes, so if you live where there’s severe icing choose more rugged equipment. Reportedly the Mikrotik receivers may be slightly more sensitive than Ubiquiti, and Mikrotik dishes are lighter, making them more suitable for portable work (e.g., go boxes), but both brands work well.
Fortunately AREDN® now supports dozens devices (including new ones added in the nightly builds), so there are many options when choosing what to buy. The AREDN® team has flagged *Sunset devices* that are no longer recommended for new purchase in the `Supported Platform Matrix: <https://www.arednmesh.org/content/supported-devices-0>`_. The Mikrotik dishes may be slightly less durable than equivalent Ubiquiti dishes, so if you live where there’s severe icing choose more rugged equipment. Reportedly the Mikrotik receivers may be slightly more sensitive than Ubiquiti, and Mikrotik dishes are lighter, making them more suitable for portable work (e.g., go boxes), but both brands work well.
Important considerations
++++++++++++++++++++++++
- The older models of equipment have less flash memory and RAM than current versions. The latest AREDN |trade| firmware runs on these devices but there are not enough resources to run services like tunnels. As time goes on the AREDN |trade| firmware grows slowly, so at some point in time it will no longer fit in the available resources of older devices. Don’t buy any used equipment unless you know it has at least 16 MB of flash and 64 MB of RAM and is “MIMO”.
- The older models of equipment have less flash memory and RAM than current versions. The latest AREDN® firmware runs on these devices but there are not enough resources to run services like tunnels. As time goes on the AREDN® firmware grows slowly, so at some point in time it will no longer fit in the available resources of older devices. Don’t buy any used equipment unless you know it has at least 16 MB of flash and 64 MB of RAM and is “MIMO”.
- Do not stand in front of the radio for extended periods of time when it’s powered on. NEVER look into the focus of the radio when it’s powered on. These small dishes have 80-100 watts of ERP at 5.8 Ghz! The Mikrotik Basebox 2 has 30 dBm of power output. When fed to a Mikrotik 30dB gain dish, that’s 1 KW of ERP. Use caution!
@ -92,7 +92,7 @@ Indoor Radios
+++++++++++++
Mikrotik
The *Mikrotik hAP ac lite (RB952Ui-5ac2nD)* is a five-port router. It provides a seamless method for integrating the ham radio network into your ham shack network. When running AREDN |trade| firmware, it provides:
The *Mikrotik hAP ac lite (RB952Ui-5ac2nD)* is a five-port router. It provides a seamless method for integrating the ham radio network into your ham shack network. When running AREDN® firmware, it provides:
- One port to connect to your outside node (a “DtD” - Device to Device port). POE power for the node can be enabled on this port.
- One port to connect to your home router for Internet access (necessary if you need to tunnel your node to another node for network access).
@ -106,17 +106,17 @@ GL-iNet
Configuring your node
---------------------
After you have your equipment in hand, you need to install the AREDN |trade| firmware, configure its settings, and put it up in the air. Installation and configuration of the firmware is covered in the **Installing AREDN Firmware** and **Basic Radio Setup** sections of the *Getting Started Guide*.
After you have your equipment in hand, you need to install the AREDN® firmware, configure its settings, and put it up in the air. Installation and configuration of the firmware is covered in the **Installing AREDN Firmware** and **Basic Radio Setup** sections of the *Getting Started Guide*.
Aiming High Gain Antennas
-------------------------
Note that the higher the gain, the narrower the beamwidth and the trickier it is to aim these dishes accurately. Fortunately, some aiming tools have been added to the AREDN |trade| firmware that help in setting up the dish in the correct direction and elevation. Remember that the vertical beamwidth is as narrow as the horizontal beamwidth. Review the **Tips for Aiming Directional Antennas** document in the **How-To Guides** section for more information.
Note that the higher the gain, the narrower the beamwidth and the trickier it is to aim these dishes accurately. Fortunately, some aiming tools have been added to the AREDN® firmware that help in setting up the dish in the correct direction and elevation. Remember that the vertical beamwidth is as narrow as the horizontal beamwidth. Review the **Tips for Aiming Directional Antennas** document in the **How-To Guides** section for more information.
Typical Node Deployments
------------------------
Here are some typical deployment scenarios for connecting an AREDN |trade| node with PoE power adapters and computers.
Here are some typical deployment scenarios for connecting an AREDN® node with PoE power adapters and computers.
.. figure:: _images/orv-basic-install.png
:alt: Basic Deployment

4
arednHow-toGuides/command-line.rst
View File

@ -2,7 +2,7 @@
Command Line Access to Your Node
================================
There may be times when it would be useful to have command line access to your node. AREDN |trade| nodes support both `Secure Shell (ssh) <https://en.wikipedia.org/wiki/Secure_Shell>`_ and `Telnet <https://en.wikipedia.org/wiki/Telnet>`_. Both access methods will require a set of login credentials (*root* username & password). Linux and MacOS computers have native tools for both *SSH* and *Telnet*.
There may be times when it would be useful to have command line access to your node. AREDN® nodes support both `Secure Shell (ssh) <https://en.wikipedia.org/wiki/Secure_Shell>`_ and `Telnet <https://en.wikipedia.org/wiki/Telnet>`_. Both access methods will require a set of login credentials (*root* username & password). Linux and MacOS computers have native tools for both *SSH* and *Telnet*.
The *OpenSSH* package can be enabled on Windows computers. Use a web search engine to find information for your specific operating system (for example search "openssh for windows 10"). Here are some examples for enabling OpenSSH on Windows computers:
@ -27,7 +27,7 @@ Telnet
:align: center
SSH
*SSH* requires you to specify the port, *root* username, and password on the command line. This is because AREDN |trade| nodes do not use the default well-known *ssh* port [22], but nodes use port ``2222`` for *ssh* connections. An example *SSH* command string is
*SSH* requires you to specify the port, *root* username, and password on the command line. This is because AREDN® nodes do not use the default well-known *ssh* port [22], but nodes use port ``2222`` for *ssh* connections. An example *SSH* command string is
::

4
arednHow-toGuides/devtools.rst
View File

@ -2,12 +2,12 @@
Tools for Developers
====================
This section of the AREDN |trade| documentation contains information useful for developers who want to retrieve information from one or more nodes for use in any of several applications. For example, a developer may want to write a program which periodically polls a set of nodes to gather link quality or signal values to insert them into a network management or historian system for trending and analysis. The popular KG6WXC MeshMap application uses these tools to create and update a comprehensive mesh network map.
This section of the AREDN® documentation contains information useful for developers who want to retrieve information from one or more nodes for use in any of several applications. For example, a developer may want to write a program which periodically polls a set of nodes to gather link quality or signal values to insert them into a network management or historian system for trending and analysis. The popular KG6WXC MeshMap application uses these tools to create and update a comprehensive mesh network map.
SYSINFO.JSON
============
The **sysinfo.json** `API (Application Programming Interface) <https://en.wikipedia.org/wiki/Application_programming_interface>`_ has been included in AREDN |trade| firmware for several releases, and each release includes an *api_version* tag which can be used to track the feature set supported by that version of the API. As new features are added, the *api_version* number is incremented.
The **sysinfo.json** `API (Application Programming Interface) <https://en.wikipedia.org/wiki/Application_programming_interface>`_ has been included in AREDN® firmware for several releases, and each release includes an *api_version* tag which can be used to track the feature set supported by that version of the API. As new features are added, the *api_version* number is incremented.
The basic API retrieves general node information in JSON format, and it can be invoked using the following URL:
``http://<nodename>.local.mesh/cgi-bin/sysinfo.json``

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

@ -4,7 +4,7 @@ Tips for Aiming Directional Antennas
*Contributor: Brett Popovich KG7GDB*
AREDN |trade| nodes with directional antennas can be challenging to align, especially if they have very narrow beam widths. The goal is to achieve the closest alignment in order to pass RF signals efficiently.
AREDN® nodes with directional antennas can be challenging to align, especially if they have very narrow beam widths. The goal is to achieve the closest alignment in order to pass RF signals efficiently.
Practice with Nearby Nodes
--------------------------

12
arednHow-toGuides/firmware_tips.rst
View File

@ -2,7 +2,7 @@
Tips for Uploading Firmware
===========================
Uploading firmware to an AREDN |trade| node is usually a straightforward process. Follow the procedures documented in the **Downloading AREDN Firmware** section to ensure you have the correct firmware version from the AREDN |trade| website to install on your node. If you experience issues uploading firmware, the following tips may be helpful.
Uploading firmware to an AREDN® node is usually a straightforward process. Follow the procedures documented in the **Downloading AREDN Firmware** section to ensure you have the correct firmware version from the AREDN® website to install on your node. If you experience issues uploading firmware, the following tips may be helpful.
Error message when uploading firmware
If you see an error message displayed when uploading new firmware to your node, verify that you are loading the correct file by referring to the `AREDN Firmware Selector (AFS) <http://downloads.arednmesh.org/afs/www/>`_, then you can safely ignore the warning. The file naming standard recently changed from a non-standard naming convention to the standard naming convention used by OpenWRT.
@ -10,7 +10,7 @@ Error message when uploading firmware
Web browser cache and sessions
One common issue can occur when installing firmware using a web browser. Your computer's browser cache stores data for the URLs that have been visited, but IP addresses and other parameters may change during the install process. It is possible for the cache to contain information that doesn’t match the latest settings for the URL, so the browser may block the connection setup and display an ERR_CONNECTION_RESET message. Clearing your computer's web browser cache will allow the latest URL settings to be registered so you can continue with the install process.
Instead of a *Connection Reset* message, sometimes a *Bad Gateway* message may appear. This is an `HTTP Status Code <https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml>`_ that can mean any of several things. Often it indicates a network communication issue between a web browser and a web server. During AREDN |trade| firmware installs you can usually resolve a *Bad Gateway* issue by doing one or more of the following things:
Instead of a *Connection Reset* message, sometimes a *Bad Gateway* message may appear. This is an `HTTP Status Code <https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml>`_ that can mean any of several things. Often it indicates a network communication issue between a web browser and a web server. During AREDN® firmware installs you can usually resolve a *Bad Gateway* issue by doing one or more of the following things:
- Refresh or Reload the URL for your node.
@ -28,9 +28,9 @@ PXE Server
Tips for Upgrading Firmware
---------------------------
Upgrading an AREDN |trade| node is accomplished using the *Setup > Administration > Firmware Update* feature on the node's web interface. Follow the procedures documented in the **Downloading AREDN Firmware** section to ensure you have the correct firmware version from the AREDN |trade| website to install on your node.
Upgrading an AREDN® node is accomplished using the *Setup > Administration > Firmware Update* feature on the node's web interface. Follow the procedures documented in the **Downloading AREDN Firmware** section to ensure you have the correct firmware version from the AREDN® website to install on your node.
.. note:: Currently there are a few Mikrotik devices which require that the standard firmware compatibility checks be disabled in order to upgrade from version 3.22.12.0 or older to a newer firmware version. This is a "one time" issue which will migrate these devices from the legacy *ar71xx* firmware architecture to the current *ath79* architecture. The specific devices are shown in the **Supported Devices** list on the AREDN |trade| website (see footnote 1). You must first install the `Dangerous Upgrade package <https://github.com/kn6plv/DangerousUpgrade/>`_ (the **ipk** file) which will disable the firmware compatibility checks. After this package is installed on your node you can perform a normal firmware upgrade (for example) from 3.22.12.0 to 3.24.4.0.
.. note:: Currently there are a few Mikrotik devices which require that the standard firmware compatibility checks be disabled in order to upgrade from version 3.22.12.0 or older to a newer firmware version. This is a "one time" issue which will migrate these devices from the legacy *ar71xx* firmware architecture to the current *ath79* architecture. The specific devices are shown in the **Supported Devices** list on the AREDN® website (see footnote 1). You must first install the `Dangerous Upgrade package <https://github.com/kn6plv/DangerousUpgrade/>`_ (the **ipk** file) which will disable the firmware compatibility checks. After this package is installed on your node you can perform a normal firmware upgrade (for example) from 3.22.12.0 to 3.24.4.0.
In rare cases the upgrade process can fail due to lack of node resources, but such a failure will leave the node running its previous firmware version. The following tips help ensure that memory utilization is at a minimum on the node.
@ -48,7 +48,7 @@ Tips for legacy nodes with low memory (32mb)
- Get everything ready to do the upgrade, then do a fresh reboot of the node and immediately start the sysupgrade process before the node has time to initialize services which use memory.
- Use command line access to copy the *sysupgrade.bin* image to the /tmp directory on the node, then run the sysupgrade process manually from the command line on the node. Note that AREDN |trade| nodes use port 2222 for secure copy and secure shell access.
- Use command line access to copy the *sysupgrade.bin* image to the /tmp directory on the node, then run the sysupgrade process manually from the command line on the node. Note that AREDN® nodes use port 2222 for secure copy and secure shell access.
Execute the following commands from a Linux computer:
@ -66,7 +66,7 @@ Tips for legacy nodes with low memory (32mb)
Tips for Downgrading Firmware
-----------------------------
Downgrading AREDN |trade| firmware is typically accomplished using the same procedure as for uploading firmware to your node. You are simply uploading a previous version of the firmware rather than the latest version.
Downgrading AREDN® firmware is typically accomplished using the same procedure as for uploading firmware to your node. You are simply uploading a previous version of the firmware rather than the latest version.
However, there is a difference if you are downgrading the firmware on a node which previously used a different target architecture. As explained in the **Downloading AREDN Firmware** section, the legacy ``ar71xx`` target has been retired and replaced by the ``ath79`` target. For example, you may have a node that was previously running an ``ar71xx`` firmware version but you installed the latest Stable Release or Nightly Build which upgraded it to an ``ath79`` firmware target. In this case you will need to do a fresh First Install using the legacy architecture's firmware.

2
arednHow-toGuides/home-router-connection.rst
View File

@ -2,7 +2,7 @@
Connecting Nodes to Home Routers
================================
There are several indoor AREDN |trade| nodes that have more than one Ethernet port, including the *Mikrotik hAP ac lite* as well as the *GL.iNet AR150, AR300M16*, and *AR750 Creta*. The AREDN |trade| firmware running on these types of nodes has the WAN port preconfigured for connecting to the Internet. You can get the latest information about the specific port configured as the node's WAN port from the AREDN |trade| website here: `Ethernet Port Usage <http://downloads.arednmesh.org/snapshots/readme.md>`_
There are several indoor AREDN® nodes that have more than one Ethernet port, including the *Mikrotik hAP ac lite* as well as the *GL.iNet AR150, AR300M16*, and *AR750 Creta*. The AREDN® firmware running on these types of nodes has the WAN port preconfigured for connecting to the Internet. You can get the latest information about the specific port configured as the node's WAN port from the AREDN® website here: `Ethernet Port Usage <http://downloads.arednmesh.org/snapshots/readme.md>`_
.. image:: _images/home-router-connection.png
:alt: Connect nodes to Internet through home router

16
arednHow-toGuides/local-software-source.rst
View File

@ -1,31 +1,31 @@
==============================================
Creating a Local AREDN |trade| Software Server
Creating a Local AREDN® Software Server
==============================================
There may be cases where your mesh nodes have no way to access the AREDN |trade| servers for installing new software. One way to resolve this is to create your own software server on the local mesh and then point your nodes to this local service. The following sections describe the high-level tasks required to implement such a software service. In order to accomplish this, you may need to consult with someone who has System Administration skills for the specific platform you will be using to host your local software repository.
There may be cases where your mesh nodes have no way to access the AREDN® servers for installing new software. One way to resolve this is to create your own software server on the local mesh and then point your nodes to this local service. The following sections describe the high-level tasks required to implement such a software service. In order to accomplish this, you may need to consult with someone who has System Administration skills for the specific platform you will be using to host your local software repository.
Configure your software server
==============================
Your software server must be connected to the mesh as a host on your local node's LAN network, using a node that also has Internet access via its WAN interface. The reason this node is connected to the Internet is to allow the web server to download updated files from the AREDN |trade| downloads server. You should add this host to the node's *DHCP Reservation List*. You do not need to add the software host to the *Advertised Services List* of the node to which it is connected. The software server should be given a hostname that is unique on your mesh, typically prefixed with the callsign of the server owner. You can use any operating system platform you desire *(Windows, Linux, Mac)*, as long as it has the ability to function as a web server. The following are the two main tasks required of the local software server:
Your software server must be connected to the mesh as a host on your local node's LAN network, using a node that also has Internet access via its WAN interface. The reason this node is connected to the Internet is to allow the web server to download updated files from the AREDN® downloads server. You should add this host to the node's *DHCP Reservation List*. You do not need to add the software host to the *Advertised Services List* of the node to which it is connected. The software server should be given a hostname that is unique on your mesh, typically prefixed with the callsign of the server owner. You can use any operating system platform you desire *(Windows, Linux, Mac)*, as long as it has the ability to function as a web server. The following are the two main tasks required of the local software server:
- Obtain the set of AREDN |trade| software files from ``downloads.arednmesh.org``
- Obtain the set of AREDN® software files from ``downloads.arednmesh.org``
- Make those files available via its web server so nodes can query the software URLs
There are several ways to accomplish these tasks, and the best approach may vary depending on the platform you implement for your software server. Downloading the AREDN |trade| software files can be done manually as needed, or the process could be automated and executed on a regular schedule. The recommended method is to use the `rsync <https://en.wikipedia.org/wiki/Rsync>`_ program which supports recursive copying of only the changed files on the source. An example *rsync* command is shown below:
There are several ways to accomplish these tasks, and the best approach may vary depending on the platform you implement for your software server. Downloading the AREDN® software files can be done manually as needed, or the process could be automated and executed on a regular schedule. The recommended method is to use the `rsync <https://en.wikipedia.org/wiki/Rsync>`_ program which supports recursive copying of only the changed files on the source. An example *rsync* command is shown below:
::
/usr/bin/rsync -rv --delete --size-only downloads.arednmesh.org::aredn_firmware /var/www/html/arednSoftware/
Once you have a local duplicate of the AREDN |trade| files, you need to verify that your copy of the files have the correct path pointing to your local software repository. In the example above, the local repository was placed in /var/www/html/arednSoftware, so you will navigate to that directory.
Once you have a local duplicate of the AREDN® files, you need to verify that your copy of the files have the correct path pointing to your local software repository. In the example above, the local repository was placed in /var/www/html/arednSoftware, so you will navigate to that directory.
::
cd /var/www/html/arednSoftware
Under this directory you should see the ``afs`` subdirectory which contains all of the information used by the AREDN |trade| Firmware Selector. Navigate into the ``afs/www`` subdirectory and use the editor of your choice to edit the ``config.js`` file. Locate the *Image download URL* section and change the default value of the *image_url* variable to point to your local download server. The default value is ``image_url: "http://downloads.arednmesh.org"`` and the example below shows the line edited to point to our example server.
Under this directory you should see the ``afs`` subdirectory which contains all of the information used by the AREDN® Firmware Selector. Navigate into the ``afs/www`` subdirectory and use the editor of your choice to edit the ``config.js`` file. Locate the *Image download URL* section and change the default value of the *image_url* variable to point to your local download server. The default value is ``image_url: "http://downloads.arednmesh.org"`` and the example below shows the line edited to point to our example server.
::
@ -43,7 +43,7 @@ Since you will already be in the *arednSoftware* directory, you can use relative
cd /var/www/html/arednSoftware
./afs/misc/collect.py . ./afs/www/
Now your local AREDN |trade| software source is configured to serve its files to any local nodes which want to update their firmware from your repository.
Now your local AREDN® software source is configured to serve its files to any local nodes which want to update their firmware from your repository.
Next make these files available to network nodes via your web server. The steps for accomplishing this task will vary based on the specific web server software you are using. For example, using the `Apache Web Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`_, you could store the software files under the web server's *DocumentRoot* (as in the example above) or you could create an *Alias* to allow web access to parts of the filesystem that are not under the Apache *DocumentRoot* (as described `here <https://http
d.apache.org/docs/2.4/urlmapping.html>`_). Once the software has been made available via the web server, you should be able to enter that URL in a web browser to see the entire software tree as shown in the example below.

18
arednHow-toGuides/lqm.rst
View File

@ -4,7 +4,7 @@ Link Quality Manager (LQM)
*Contributor: Tim Wilkerson KN6PLV*
AREDN |trade| mesh networks often lack the bandwidth you might expect. Here we look at what may be happening, a proposal to fix it, and results from these fixes.
AREDN® mesh networks often lack the bandwidth you might expect. Here we look at what may be happening, a proposal to fix it, and results from these fixes.
Introduction
------------
@ -14,7 +14,7 @@ Low SNR links between nodes break the Linux “auto distance” algorithm result
Expected link speed vs. actual link speeds
------------------------------------------
We’ve all pointed an AREDN |trade| node at another node, found the sweet spot for the best SNR, and then been underwhelmed by how much bandwidth there seems to be. WiFi is famous for over-reporting how much bandwidth is available vs. what you actually get (think 1/6th in many cases), but somehow we all expect a 2 mile link with SNR > 20 to do more than 1 Mbps. Unfortunately actual performance data is difficult to come by, and experiments to see what might improve are difficult to coordinate. Several theories are described below.
We’ve all pointed an AREDN® node at another node, found the sweet spot for the best SNR, and then been underwhelmed by how much bandwidth there seems to be. WiFi is famous for over-reporting how much bandwidth is available vs. what you actually get (think 1/6th in many cases), but somehow we all expect a 2 mile link with SNR > 20 to do more than 1 Mbps. Unfortunately actual performance data is difficult to come by, and experiments to see what might improve are difficult to coordinate. Several theories are described below.
Performance theories
--------------------
@ -22,23 +22,23 @@ Performance theories
Hidden nodes
^^^^^^^^^^^^
The classic problem with CSMA networks like AREDN |trade| is that of “hidden nodes”. CSMA works by nodes listening for transmitters before themselves transmitting. This can fail when nodes are spread out so only some nodes can hear others resulting in many transmitting simultaneously, corrupting data, requiring retransmissions, and wasting bandwidth.
The classic problem with CSMA networks like AREDN® is that of “hidden nodes”. CSMA works by nodes listening for transmitters before themselves transmitting. This can fail when nodes are spread out so only some nodes can hear others resulting in many transmitting simultaneously, corrupting data, requiring retransmissions, and wasting bandwidth.
While this could be a real issue for AREDN |trade| networks, it only has an effect when there are a lot of collisions. For there to be a lot of collisions there has to be a lot of traffic ... but AREDN |trade| networks are largely idle. Probably the biggest traffic generator is OLSRD, and on the SF Bay Area network (for example) OLSR accounts for only a few kilobytes/second. Statistically it is difficult to ascribe the bandwidth problems to hidden nodes.
While this could be a real issue for AREDN® networks, it only has an effect when there are a lot of collisions. For there to be a lot of collisions there has to be a lot of traffic ... but AREDN® networks are largely idle. Probably the biggest traffic generator is OLSRD, and on the SF Bay Area network (for example) OLSR accounts for only a few kilobytes/second. Statistically it is difficult to ascribe the bandwidth problems to hidden nodes.
Bandwidth decimation
^^^^^^^^^^^^^^^^^^^^
Bandwidth decimation occurs when too many radios are using the same channel at similar locations, and so rather than adding bandwidth each radio ends up with a share of the original.
As noted above, AREDN |trade| doesn’t currently use much of its available bandwidth. There is some overhead in having multiple radios on the same channel, even if they are not very active, but it is not significant. Compare this to a home wifi setup: if many devices are constantly using a lot of bandwidth then it is definitely noticeable.
As noted above, AREDN® doesn’t currently use much of its available bandwidth. There is some overhead in having multiple radios on the same channel, even if they are not very active, but it is not significant. Compare this to a home wifi setup: if many devices are constantly using a lot of bandwidth then it is definitely noticeable.
Checking the status of various omnidirectional antennas on the SF Bay Area network (for example), there are rarely more than five neighbors on each node and never more than ten. If everyone were transmitting constantly there would be a problem, but this does not occur often.
CSMA vs. TDMA
^^^^^^^^^^^^^
TDMA is more efficient than CSMA and avoids many of its problems. However, Linux currently has no implementation of the protocol; it is restricted to proprietary radios. This means that AREDN |trade| as currently envisaged cannot support TDMA. While TDMA radios can have a place in an AREDN |trade| network, they seem better suited for backbone operation.
TDMA is more efficient than CSMA and avoids many of its problems. However, Linux currently has no implementation of the protocol; it is restricted to proprietary radios. This means that AREDN® as currently envisaged cannot support TDMA. While TDMA radios can have a place in an AREDN® network, they seem better suited for backbone operation.
That said, racing to embrace TDMA without understanding why the current CSMA network is failing is problematic. If hidden nodes aren’t the issue, and network utilization is too low for bandwidth decimation, how would TDMA fix this? What actually is the problem?
@ -53,9 +53,9 @@ The WiFi standard (IEEE Std 802.11TM-2007, Part 11) briefly discusses “Coverag
Auto-distance
^^^^^^^^^^^^^
AREDN |trade| provides a “Distance to FARTHEST Neighbor” setting which, indirectly, allows the Coverage Class to be set (the Linux kernel calculates the coverage class from the distance setting). An “auto” option is provided and enabled by default. “Auto” uses a “dynamic ack” algorithm in the kernel which automatically adjusts the Coverage Class. The adjustment is based on the timing of packets sent to and acknowledged from other devices. The class will always be large enough to handle the most distant device.
AREDN® provides a “Distance to FARTHEST Neighbor” setting which, indirectly, allows the Coverage Class to be set (the Linux kernel calculates the coverage class from the distance setting). An “auto” option is provided and enabled by default. “Auto” uses a “dynamic ack” algorithm in the kernel which automatically adjusts the Coverage Class. The adjustment is based on the timing of packets sent to and acknowledged from other devices. The class will always be large enough to handle the most distant device.
AREDN |trade| is an open, ad hoc, network allowing any node to associate with any other node as long as it uses the same channel and bandwidth. This results in distant nodes with very low SNRs being associated with each other. Unfortunately the dynamic-ack algorithm does not know that these links are essentially unusable, but it still adjusts the Coverage Class to accommodate them. The result is a higher Coverage Class than is required for optimal network operation, resulting in longer delays in packet retransmission. This compounds the already increased retransmissions inherent in longer links and further reduces the throughput.
AREDN® is an open, ad hoc, network allowing any node to associate with any other node as long as it uses the same channel and bandwidth. This results in distant nodes with very low SNRs being associated with each other. Unfortunately the dynamic-ack algorithm does not know that these links are essentially unusable, but it still adjusts the Coverage Class to accommodate them. The result is a higher Coverage Class than is required for optimal network operation, resulting in longer delays in packet retransmission. This compounds the already increased retransmissions inherent in longer links and further reduces the throughput.
Link Quality Manager (LQM)
--------------------------
@ -82,7 +82,7 @@ What does this mean?
What LQM does not do
^^^^^^^^^^^^^^^^^^^^
LQM blocks nodes by blocking traffic from the appropriate MAC addresses. What it does not do is prevent nodes from associating with the radio. It would be ideal to either ban “poorly performing” nodes from associating with a radio, or alternatively telling the node not to associate with distant radios. However, the ad-hoc wifi mode used in AREDN |trade| does not currently support this.
LQM blocks nodes by blocking traffic from the appropriate MAC addresses. What it does not do is prevent nodes from associating with the radio. It would be ideal to either ban “poorly performing” nodes from associating with a radio, or alternatively telling the node not to associate with distant radios. However, the ad-hoc wifi mode used in AREDN® does not currently support this.
Test Results
------------

10
arednHow-toGuides/poe.rst
View File

@ -2,16 +2,16 @@
Power over Ethernet (PoE)
=========================
The phrase `Power over Ethernet <https://en.wikipedia.org/wiki/Power_over_Ethernet>`_ (PoE) encompasses any of several different standards and methods for passing DC power over twisted-pair Ethernet cabling. The advantage of PoE is that it allows a single cable to carry both data and power to your devices, and several AREDN |trade| supported devices can be powered using PoE.
The phrase `Power over Ethernet <https://en.wikipedia.org/wiki/Power_over_Ethernet>`_ (PoE) encompasses any of several different standards and methods for passing DC power over twisted-pair Ethernet cabling. The advantage of PoE is that it allows a single cable to carry both data and power to your devices, and several AREDN® supported devices can be powered using PoE.
This section of the documentation provides a high-level overview for those who are not already familiar with this concept. You do not need to be an expert in *Power over Ethernet* technology, but it may help to be aware of a few concepts in case you run into these terms when researching PoE switches or injectors.
Passive PoE
-----------
At the present time, all of the PoE radios supported by AREDN |trade| require the use of **Passive PoE**. In a *Passive PoE* system the power source does not negotiate voltage or wattage requirements with the powered device. *Passive PoE* power sources simply supply a specific voltage constantly, up to the maximum current limit that the power source allows.
At the present time, all of the PoE radios supported by AREDN® require the use of **Passive PoE**. In a *Passive PoE* system the power source does not negotiate voltage or wattage requirements with the powered device. *Passive PoE* power sources simply supply a specific voltage constantly, up to the maximum current limit that the power source allows.
The primary message of this section is to encourage you to read the manufacturer's data sheet carefully for the hardware that you will be deploying. Pay particular attention to the specifications for **Input Voltage** and **Maximum Power Consumption**. The allowed voltage ranges and maximum power consumption for AREDN |trade| radios will vary by hardware model as shown in the comparison below.
The primary message of this section is to encourage you to read the manufacturer's data sheet carefully for the hardware that you will be deploying. Pay particular attention to the specifications for **Input Voltage** and **Maximum Power Consumption**. The allowed voltage ranges and maximum power consumption for AREDN® radios will vary by hardware model as shown in the comparison below.
**Example Data Sheet Info**
@ -47,6 +47,6 @@ Pin 7 DC-
Pin 8 DC-
=========== ======== ========
You should not need to concern yourself with the various IEEE 802.3 standards that may be used for other types of PoE equipment. The radios currently supported by AREDN |trade| do not use standards such as *802.3af, 802.3at, 802.3bt, PoE+, 4PPoE, or Ultra PoE*. There is a wealth of information on the Internet if you decide to learn more about these other standards.
You should not need to concern yourself with the various IEEE 802.3 standards that may be used for other types of PoE equipment. The radios currently supported by AREDN® do not use standards such as *802.3af, 802.3at, 802.3bt, PoE+, 4PPoE, or Ultra PoE*. There is a wealth of information on the Internet if you decide to learn more about these other standards.
Be aware that it should not damage your AREDN |trade| device if you connect it to an 802.3af/at switch or :abbr:`PSE (power sourcing equipment)`. The only consequence would be that the device will not be powered, since switches using the other standards will not send power if they do not detect a compatible device.
Be aware that it should not damage your AREDN® device if you connect it to an 802.3af/at switch or :abbr:`PSE (power sourcing equipment)`. The only consequence would be that the device will not be powered, since switches using the other standards will not send power if they do not detect a compatible device.

12
arednHow-toGuides/puttygen_ssh_keys.rst
View File

@ -4,7 +4,7 @@ Use PuTTYGen to Make SSH Keys
*Contributor: Randy Smith WU2S*
This How-to will show you a method for generating SSH key pairs on a Windows computer, saving them to a USB flash drive, installing the SSH key on an AREDN |trade| node and using the SSH keys with a PuTTY terminal session. The use of Secure Shell (SSH) keys when using PuTTY or another SSH client is a useful aid to managing a group of AREDN |trade| nodes.
This How-to will show you a method for generating SSH key pairs on a Windows computer, saving them to a USB flash drive, installing the SSH key on an AREDN® node and using the SSH keys with a PuTTY terminal session. The use of Secure Shell (SSH) keys when using PuTTY or another SSH client is a useful aid to managing a group of AREDN® nodes.
- First, obtain the PuTTY suite of applications from the `PuTTY Download Page <https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html>`_ and install them on your computer.
@ -36,7 +36,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
|
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.
4. In order for your new public key to be installed on an AREDN® 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.
.. image:: _images/04a-puttygen.png
:alt: Notepad view EOL
@ -44,7 +44,7 @@ This How-to will show you a method for generating SSH key pairs on a Windows com
|
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.
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® 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.
.. image:: _images/04b-puttygen.png
:alt: Puttygen copy key text
@ -68,7 +68,7 @@ Save this Notepad++ window to a suitable filename with the **.pub** file extensi
|
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.
5. In order to use your new SSH key pair, login to your AREDN® 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.
.. image:: _images/05-puttygen.png
:alt: Node Administration page
@ -76,7 +76,7 @@ Save this Notepad++ window to a suitable filename with the **.pub** file extensi
|
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.
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® node.
.. image:: _images/06-puttygen.png
:alt: Select key to install
@ -109,7 +109,7 @@ SAVE the session definition again.
|
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.
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® 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.
.. image:: _images/10-puttygen.png
:alt: Enter passphrase to use SSH key

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

@ -2,7 +2,7 @@
Comparing SISO and MIMO Hardware
================================
SISO (Single Input Single Output) device hardware has a single transceiver-antenna chain, while `MIMO (Multiple Input Multiple Output) <https://en.wikipedia.org/wiki/MIMO>`_ devices have multiple chains coordinated through the `Digital Signal Processor (DSP) <https://en.wikipedia.org/wiki/Digital_signal_processor>`_. The MIMO devices supported by AREDN |trade| have dual chains for both transmit and receive, and they support dual data streams [2x2:2].
SISO (Single Input Single Output) device hardware has a single transceiver-antenna chain, while `MIMO (Multiple Input Multiple Output) <https://en.wikipedia.org/wiki/MIMO>`_ devices have multiple chains coordinated through the `Digital Signal Processor (DSP) <https://en.wikipedia.org/wiki/Digital_signal_processor>`_. The MIMO devices supported by AREDN® have dual chains for both transmit and receive, and they support dual data streams [2x2:2].
.. image:: _images/siso-mimo-overview.png
:alt: SISO and MIMO radio chains

2
arednHow-toGuides/supernodes.rst
View File

@ -30,7 +30,7 @@ Because Supernodes use the `OLSR (Optimized Link State Routing) <https://en.wiki
By having each Supernode connected to only a single local network, the owners of each local network are responsible for their own Supernodes. This simplifies management and maintenance. There is also some fault isolation as a failed Supernode will only impact the one local network to which it is connected.
The number of messages a Supernode receives will scale linearly with the total number of nodes in all connected local networks. A Supernode receives a management message from every node in the network (all nodes in all local networks) every 5 seconds. With a typical message size of 100 bytes, a Supernode receives about 20 bytes per second per node. At the time of initial testing, there were 4,300 AREDN |trade| nodes registered world-wide, so a Supernode for this network would receive ``84 KB/s`` or ``0.7 Mb/s``, which is a manageable bandwidth requirement.
The number of messages a Supernode receives will scale linearly with the total number of nodes in all connected local networks. A Supernode receives a management message from every node in the network (all nodes in all local networks) every 5 seconds. With a typical message size of 100 bytes, a Supernode receives about 20 bytes per second per node. At the time of initial testing, there were 4,300 AREDN® nodes registered world-wide, so a Supernode for this network would receive ``84 KB/s`` or ``0.7 Mb/s``, which is a manageable bandwidth requirement.
As more Supernodes are deployed linking more local networks, the overall performance of the *Cloud Mesh* will be impacted. Therefore, it is a good idea to coordinate the deployment of Supernodes among the Supernode owners at the time when tunnel links are requested for the *Cloud Mesh*.

12
arednHow-toGuides/vm-install.rst
View File

@ -4,9 +4,9 @@ Virtual Machine Installs
*Contributor: Trevor Raty KG6MDW*
The use of virtual machines as AREDN |trade| nodes is for advanced users. Most users should use *Mikrotik ac2* or *ac3* hardware to achieve similar functionality. These instructions are provided with the assumption that you understand your virtualization platform and are familiar with creating images and uploading virtual disks. The x86_64 image has been tested and is considered stable on the Proxmox, Unraid, and VMware ESXi platforms, so usage on other virtualization platforms may not work as expected.
The use of virtual machines as AREDN® nodes is for advanced users. Most users should use *Mikrotik ac2* or *ac3* hardware to achieve similar functionality. These instructions are provided with the assumption that you understand your virtualization platform and are familiar with creating images and uploading virtual disks. The x86_64 image has been tested and is considered stable on the Proxmox, Unraid, and VMware ESXi platforms, so usage on other virtualization platforms may not work as expected.
In order to have the most current features, it is recommended that you install a Nightly Build image of the AREDN |trade| firmware. For example, there is a known issue in the x86_64 firmware before 3.23.12.0 when using more than one Ethernet interface, but this was resolved in subsequent releases.
In order to have the most current features, it is recommended that you install a Nightly Build image of the AREDN® firmware. For example, there is a known issue in the x86_64 firmware before 3.23.12.0 when using more than one Ethernet interface, but this was resolved in subsequent releases.
Prerequisites / Image information
---------------------------------
@ -30,7 +30,7 @@ Multi-port mode
QEMU Install Process
--------------------
1. Download the latest firmware image from the AREDN |trade| downloads website.
1. Download the latest firmware image from the AREDN® downloads website.
2. Extract the .gz file. *7zip* on Windows may have issues with the .gz file, so you may need to download *gzip* for Windows or extract it on a Linux or Mac computer/VM.
@ -38,7 +38,7 @@ QEMU Install Process
4. Create the VM/Domain on your server and assign the ``.img`` file to it.
5. Boot the VM and proceed with the AREDN |trade| node configuration steps.
5. Boot the VM and proceed with the AREDN® node configuration steps.
VMware Install Process
----------------------
@ -49,7 +49,7 @@ For VMware you will need to use QEMU tools or another V2V converter in order to
- `QEMU Official downloads <https://www.qemu.org/download/#windows>`_
- `Starwind Converter <https://www.starwindsoftware.com/starwind-v2v-converter>`_
1. Download the latest firmware image from the AREDN |trade| downloads website.
1. Download the latest firmware image from the AREDN® downloads website.
2. Extract the .gz file. *7zip* on Windows may have issues with the .gz file, so you may need to download *gzip* for Windows or extract it on a Linux or Mac computer/VM.
@ -77,4 +77,4 @@ If you are using Virtualbox, below is the built-in command, replacing "aredn.vmd
7. Assign the verified ``.vmdk`` disk to the VM.
8. Boot the VM and proceed with the AREDN |trade| node configuration steps.
8. Boot the VM and proceed with the AREDN® node configuration steps.

16
arednHow-toGuides/xlinks.rst
View File

@ -4,35 +4,35 @@ Using Cross Links
*Contributor: Tim Wilkinson KN6PLV*
A cross-link allows you to pass AREDN |trade| traffic across non-AREDN |trade| network links.
A cross-link allows you to pass AREDN® traffic across non-AREDN® network links.
Comparison with tunnels
-----------------------
Tunnels and cross-links both connect two nodes together, so they are the same in that respect. However, they do it in very different ways.
**Tunnels** are a simple to use, all in one feature, which operates over your regular Internet to connect two AREDN |trade| nodes. There is a bit of configuration information to exchange, but it is all fairly easy to set up. Tunnels *only work* over your **WAN** connection, you use the IP address given by the server, and there is very little else to configure.
**Tunnels** are a simple to use, all in one feature, which operates over your regular Internet to connect two AREDN® nodes. There is a bit of configuration information to exchange, but it is all fairly easy to set up. Tunnels *only work* over your **WAN** connection, you use the IP address given by the server, and there is very little else to configure.
**Cross-links**, on the other hand, are much more basic and flexible. The configuration lets you choose IP addresses yourself, as well as setting a VLAN and *port* on which xlink traffic leaves the device. The IP addresses let the system route the data (OLSR works at layer 3 so every interface needs an IP address), but unlike the tunnel you can set these addresses any way you desire. You choose any unused VLAN number yourself, and the *port* sets how you want the data to be physically sent into or out of the node. How the data is moved to the peer device is not defined in any way, and deliberately so. Maybe you want to connect that *port* directly to a non-AREDN |trade| PtP radio. Maybe you feed it into a switch then use some other tunneling technology to get it where it needs to go. Maybe it is just a bit of Ethernet cable. It is entirely up to you. Personally, I use tunnels to connect nodes over the Internet, but I use xlinks to connect nodes over Point-to-Point radios which are not running AREDN |trade| firmware.
**Cross-links**, on the other hand, are much more basic and flexible. The configuration lets you choose IP addresses yourself, as well as setting a VLAN and *port* on which xlink traffic leaves the device. The IP addresses let the system route the data (OLSR works at layer 3 so every interface needs an IP address), but unlike the tunnel you can set these addresses any way you desire. You choose any unused VLAN number yourself, and the *port* sets how you want the data to be physically sent into or out of the node. How the data is moved to the peer device is not defined in any way, and deliberately so. Maybe you want to connect that *port* directly to a non-AREDN® PtP radio. Maybe you feed it into a switch then use some other tunneling technology to get it where it needs to go. Maybe it is just a bit of Ethernet cable. It is entirely up to you. Personally, I use tunnels to connect nodes over the Internet, but I use xlinks to connect nodes over Point-to-Point radios which are not running AREDN® firmware.
Configure the AREDN |trade| nodes at both ends
Configure the AREDN® nodes at both ends
----------------------------------------------
You can use either a *Mikrotik hAP ac2* or *ac3* as the AREDN |trade| device on each end of the cross-link. Navigate to the **Administration > Advanced Network** page of the node on one side of the link. To add a cross-link click the *plus* icon, enter an unused VLAN number for the link, an IP address for the near-side radio, an IP address for the far-side radio, a weighting factor, and the available port to which the near-side radio is connected on your node. The *Weight* will be used by `OLSR <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to determine the best route for AREDN |trade| traffic.
You can use either a *Mikrotik hAP ac2* or *ac3* as the AREDN® device on each end of the cross-link. Navigate to the **Administration > Advanced Network** page of the node on one side of the link. To add a cross-link click the *plus* icon, enter an unused VLAN number for the link, an IP address for the near-side radio, an IP address for the far-side radio, a weighting factor, and the available port to which the near-side radio is connected on your node. The *Weight* will be used by `OLSR <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to determine the best route for AREDN® traffic.
.. image:: ../arednGettingStarted/_images/admin-ports-xlinks.png
:alt: Advanced Networking
:align: center
In this example we chose VLAN ``20`` because it is not in use anywhere else on our network. We assigned an *IP Address* of ``172.16.1.1`` for the this node, and we assigned ``172.16.1.2`` as the *Peer Address* for the node on the other side of the link. The xlink knows nothing about the details or configuration of the PtP radios, or their IP addresses. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. *Port* ``3`` was chosen because it is an open port on this device. After entering your values, click *Save Changes* to save the new cross-link information. Now you can cable your near-side PtP device to port 3 on your AREDN |trade| node.
In this example we chose VLAN ``20`` because it is not in use anywhere else on our network. We assigned an *IP Address* of ``172.16.1.1`` for the this node, and we assigned ``172.16.1.2`` as the *Peer Address* for the node on the other side of the link. The xlink knows nothing about the details or configuration of the PtP radios, or their IP addresses. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. *Port* ``3`` was chosen because it is an open port on this device. After entering your values, click *Save Changes* to save the new cross-link information. Now you can cable your near-side PtP device to port 3 on your AREDN® node.
.. image:: _images/xlink.png
:alt: Cross-link diagram
:align: center
Next, open the **Administration > Advanced Network** page on the node for the other side of the PtP link. Set the *IP Address* for this node to ``172.16.1.2`` and the *Peer Address* for the node on the other side of the link to ``172.16.1.1``. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. In our example we are setting the *Port* to ``4`` because it is an open port on this device. After entering your values, click *Save Changes* to save the cross-link configuration for this side of the PtP link. Now you can cable your far-side PtP device to port 4 on your AREDN |trade| node.
Next, open the **Administration > Advanced Network** page on the node for the other side of the PtP link. Set the *IP Address* for this node to ``172.16.1.2`` and the *Peer Address* for the node on the other side of the link to ``172.16.1.1``. The *Weight* is set to ``1`` which is the same weight as would be used by a tunnel connection, but this can be increased if you want the cross-link to be chosen at a lower priority for routing traffic on the mesh. In our example we are setting the *Port* to ``4`` because it is an open port on this device. After entering your values, click *Save Changes* to save the cross-link configuration for this side of the PtP link. Now you can cable your far-side PtP device to port 4 on your AREDN® node.
Configure the intermediate Point-to-Point link
----------------------------------------------
How data is moved between the peer devices is not restricted or defined. There are many types of vendor-specific Point-to-Point products that can be used to establish an AREDN |trade| cross-link. Refer to your manufacturer's documentation for the best way to ensure that network packets can be successfully transferred between the two endpoint devices. The easiest way to accomplish this is to bridge the traffic directly between the peer devices.
How data is moved between the peer devices is not restricted or defined. There are many types of vendor-specific Point-to-Point products that can be used to establish an AREDN® cross-link. Refer to your manufacturer's documentation for the best way to ensure that network packets can be successfully transferred between the two endpoint devices. The easiest way to accomplish this is to bridge the traffic directly between the peer devices.

14
arednNetworkDesign/channel_planning.rst
View File

@ -2,16 +2,16 @@
Channel Planning
================
The previous section identified the different channels in each frequency band which are available for AREDN |trade| networking. Devices on each side of a radio link must use the same frequency band, channel, channel width, and SSID. Beyond that requirement, however, you have quite a bit of flexibility to select the radio channels that will ensure the highest signal quality and throughput for your network. In a basic AREDN |trade| network with several nodes spread across a limited geographical area, all of the nodes may use the same band, channel, and channel width. This allows them to establish network routing to any of the sites as needed.
The previous section identified the different channels in each frequency band which are available for AREDN® networking. Devices on each side of a radio link must use the same frequency band, channel, channel width, and SSID. Beyond that requirement, however, you have quite a bit of flexibility to select the radio channels that will ensure the highest signal quality and throughput for your network. In a basic AREDN® network with several nodes spread across a limited geographical area, all of the nodes may use the same band, channel, and channel width. This allows them to establish network routing to any of the sites as needed.
However, as more nodes join the network or when several nodes are :abbr:`collocated (same physical site)` and share the same channel, it is possible for overall network performance to degrade. In order for an AREDN |trade| network to scale up in size and complexity, frequency coordination and channel planning become increasingly important. To plan for future growth, local AREDN |trade| groups may need to partition use different network topologies and to allocate different channels for specific geographic areas or types of links in order to ensure the network will be able to support the expected services.
However, as more nodes join the network or when several nodes are :abbr:`collocated (same physical site)` and share the same channel, it is possible for overall network performance to degrade. In order for an AREDN® network to scale up in size and complexity, frequency coordination and channel planning become increasingly important. To plan for future growth, local AREDN® groups may need to partition use different network topologies and to allocate different channels for specific geographic areas or types of links in order to ensure the network will be able to support the expected services.
Wireless Network Operation
--------------------------
A wireless network is a shared half-duplex medium on which only one station at a time should transmit. In that sense wireless operations are analogous to other types of radio transmissions. If two stations key up their transmitters at the same time, they will interfere with each other to the extent that neither of them will receive the other's message. That is why net control procedures are implemented to ensure controlled access to a radio channel during emergency communication.
AREDN |trade| firmware automatically mediates station access to the wireless medium by implementing `IEEE 802.11a/b/g/n <https://en.wikipedia.org/wiki/IEEE_802.11n-2009>`_ standards and `Carrier Sense Multiple Access / Collision Avoidance (CSMA/CA) <https://en.wikipedia.org/wiki/Carrier-sense_multiple_access>`_. This listen-before-talk technology helps nodes to determine whether a channel is busy. Each node performs a *Clear Channel Assessment (CCA)* as well as using `Request to Send / Clear to Send (RTS/CTS) <https://en.wikipedia.org/wiki/IEEE_802.11_RTS/CTS>`_ messages to negotiate access to a channel. A negligible amount of network traffic is also required for `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to maintain routes for the network as a whole, but this OLSR traffic is a very small fraction of the total.
AREDN® firmware automatically mediates station access to the wireless medium by implementing `IEEE 802.11a/b/g/n <https://en.wikipedia.org/wiki/IEEE_802.11n-2009>`_ standards and `Carrier Sense Multiple Access / Collision Avoidance (CSMA/CA) <https://en.wikipedia.org/wiki/Carrier-sense_multiple_access>`_. This listen-before-talk technology helps nodes to determine whether a channel is busy. Each node performs a *Clear Channel Assessment (CCA)* as well as using `Request to Send / Clear to Send (RTS/CTS) <https://en.wikipedia.org/wiki/IEEE_802.11_RTS/CTS>`_ messages to negotiate access to a channel. A negligible amount of network traffic is also required for `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ to maintain routes for the network as a whole, but this OLSR traffic is a very small fraction of the total.
In a single-channel wireless network, any node that needs to transmit will automatically coordinate with the other nodes for a clear channel. This is by design, but as more devices try to gain access to the same channel there is an increased potential for each node to wait longer for its chance to transmit. This can result in increased latency and decreased network throughput as the number of network nodes increases.
@ -40,7 +40,7 @@ Hidden Nodes
: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 can be used by AREDN |trade| nodes to minimize these issues. For example, node **A** broadcasts a short RTS message with a proposed timeslot/duration for transmitting its 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.
`Request to Send / Clear to Send (RTS/CTS) <https://en.wikipedia.org/wiki/IEEE_802.11_RTS/CTS>`_ messages can be used by AREDN® nodes to minimize these issues. For example, node **A** broadcasts a short RTS message with a proposed timeslot/duration for transmitting its 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.
Exposed Nodes
In the `Exposed Node <https://en.wikipedia.org/wiki/Exposed_node_problem>`_ example below, Endpoint **A** and tower **B** can communicate with each other at the same time that tower **C** can communicate with endpoint **D**. However, if endpoint **E** is exposed to *both* of the towers, then the tower nodes will detect that the channel is not clear and will not be able to communicate when the exposed node is transmitting. This increases the network wait time which impacts overall throughput.
@ -101,7 +101,7 @@ In its most basic configuration for two collocated nodes, an Ethernet cable is c
One added benefit of DtD linking is that you can link nodes which are operating on different bands and channels. Nodes that are using *Channel Separation* to segment traffic can still pass data at high speeds through their DtD link and be members of a single network. At a tower site like the one shown here, you could link 2.4 GHz and 5.8 GHz nodes to the same network. In fact, at a busy site like this it is best practice to use DtD linking, because otherwise RF channel contention could make the network unusable.
Ideally you should configure your collocated nodes to use different bands and channels, then set up DtD links between the nodes to ensure that traffic is routed efficiently without generating RF contention or delays. :abbr:`OLSR (Optimized Link State Routing protocol)` will always choose the DtD path first when passing traffic between linked nodes. Each AREDN |trade| node recognizes incoming packets tagged with :abbr:`VLAN (Virtual Local Area Network)` 2 as DtD traffic. In the simple example shown here, the switch will share all traffic across all ports and every node will receive the traffic on its DtD link.
Ideally you should configure your collocated nodes to use different bands and channels, then set up DtD links between the nodes to ensure that traffic is routed efficiently without generating RF contention or delays. :abbr:`OLSR (Optimized Link State Routing protocol)` will always choose the DtD path first when passing traffic between linked nodes. Each AREDN® node recognizes incoming packets tagged with :abbr:`VLAN (Virtual Local Area Network)` 2 as DtD traffic. In the simple example shown here, the switch will share all traffic across all ports and every node will receive the traffic on its DtD link.
Be aware that if several nodes are connected through a network switch (as shown in the diagrams) and then you connect your laptop to an open port on that switch, your laptop may receive a DHCP IP address from any of the nodes' DHCP servers. This may not be an issue for a laptop doing periodic maintenance activities at the site. However, if you deploy another device which must receive a consistent DHCP IP address, then it is best practice to disable the DHCP server on all but one of the nodes which will be the primary DHCP server for any local devices connected to that network switch.
@ -116,12 +116,12 @@ If you want to partition traffic even further, you can configure VLANs on a mana
Antenna Polarization
++++++++++++++++++++
Most of the latest AREDN |trade| devices use dual polarity antennas and :abbr:`MIMO (Multiple Input - Multiple Output)` features in the radios that exploit multipath propagation. However, if you are using single polarity antennas with "single chain" radios, another way to achieve signal separation for collocated devices is to orient the site's antennas so that one is vertically polarized and the other is horizontally polarized. This can result in a signal separation of up to 20 dB. Because of the predominance of vertical polarization in commercial WiFi devices, single chain AREDN |trade| nodes may achieve slightly better performance using horizontal polarization with clear line of sight. You can test both polarizations to see which one yields better performance dealing with the man-made noise in your specific environment. Note that the antennas on both sides of a radio link must be oriented the same way.
Most of the latest AREDN® devices use dual polarity antennas and :abbr:`MIMO (Multiple Input - Multiple Output)` features in the radios that exploit multipath propagation. However, if you are using single polarity antennas with "single chain" radios, another way to achieve signal separation for collocated devices is to orient the site's antennas so that one is vertically polarized and the other is horizontally polarized. This can result in a signal separation of up to 20 dB. Because of the predominance of vertical polarization in commercial WiFi devices, single chain AREDN® nodes may achieve slightly better performance using horizontal polarization with clear line of sight. You can test both polarizations to see which one yields better performance dealing with the man-made noise in your specific environment. Note that the antennas on both sides of a radio link must be oriented the same way.
Aligning Linked Nodes
+++++++++++++++++++++
The AREDN |trade| web interface provides information that is helpful when aligning two nodes that are being installed to form a link. On the **Node Status** page, click the **Charts** button to view the *Realtime Signal to Noise* graph. Slowly turn and tilt your antenna, pausing to view the signal metrics. Once you see the best signal, as shown below, you can lock your antenna into position. If you want to focus on the antenna position without having to watch the SNR graph, you can also enable the *SNR Sound* feature and align the antenna to the highest pitch tone. Depending on the implementation, a Signal to Noise Ratio of 15 dB is adequate to pass data at speeds in the range of 5 to 20 :abbr:`Mbps (Megabits per second)`. See "Tips for Aiming Directional Antennas" in the **How-To Guides** section for additional information.
The AREDN® web interface provides information that is helpful when aligning two nodes that are being installed to form a link. On the **Node Status** page, click the **Charts** button to view the *Realtime Signal to Noise* graph. Slowly turn and tilt your antenna, pausing to view the signal metrics. Once you see the best signal, as shown below, you can lock your antenna into position. If you want to focus on the antenna position without having to watch the SNR graph, you can also enable the *SNR Sound* feature and align the antenna to the highest pitch tone. Depending on the implementation, a Signal to Noise Ratio of 15 dB is adequate to pass data at speeds in the range of 5 to 20 :abbr:`Mbps (Megabits per second)`. See "Tips for Aiming Directional Antennas" in the **How-To Guides** section for additional information.
.. image:: _images/align-nodes.png
:alt: Aligning Nodes for Best SNR

22
arednNetworkDesign/frequency_bands.rst
View File

@ -2,7 +2,7 @@
Radio Spectrum Characteristics
==============================
AREDN |trade| networks operate in the microwave radio spectrum, and licensed Amateur radio operators have unique access to some of these frequencies. For bands in which Amateur operators share the spectrum, there is more chance for RF interference which may make some frequencies unusable for AREDN |trade| data networking. For best results, select frequencies that are not being heavily used within the coverage area.
AREDN® networks operate in the microwave radio spectrum, and licensed Amateur radio operators have unique access to some of these frequencies. For bands in which Amateur operators share the spectrum, there is more chance for RF interference which may make some frequencies unusable for AREDN® data networking. For best results, select frequencies that are not being heavily used within the coverage area.
.. warning:: **You are responsible for using frequencies, channels, bandwidths, and power levels that comply with your country's Amateur radio license requirements.**
@ -13,7 +13,7 @@ Channel Information
:alt: Channel Width Example
:align: center
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.
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® networking in the US.
======= ================= ========
Band Frequency Range Channels
@ -24,16 +24,16 @@ Band Frequency Range Channels
33 cm 902-928 MHz 4
======= ================= ========
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.
The choice of a frequency band for AREDN® 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.
You have the option of selecting the channel width for each link. When using channels at the top or bottom of a band, be certain that your chosen width will not transmit outside of the FCC Part 97 allocation for that band. Different channel widths may yield better throughput than others. In some areas operators use different channels to isolate links, so they may need to use 10 MHz rather than 20 MHz channels in order to ensure they have enough available channels. Also, long distance links simply have better performance using 10 MHz vs. 20 MHz or 5 MHz channel widths. Test the performance of your links using various channel widths to ensure that they are optimized.
Power Limitations
The power limits that apply to AREDN |trade| networks are the same as those that apply generally for Amateur radio operators in your country. As with any other operating mode, you should use the *minimum* power required to make radio links between nodes. In the United States, for example, this rule is specified in FCC part 97.313(a), and the maximum transmitter output power cannot exceed 1.5 kW PEP as specified by FCC part 97.313(b).
The power limits that apply to AREDN® networks are the same as those that apply generally for Amateur radio operators in your country. As with any other operating mode, you should use the *minimum* power required to make radio links between nodes. In the United States, for example, this rule is specified in FCC part 97.313(a), and the maximum transmitter output power cannot exceed 1.5 kW PEP as specified by FCC part 97.313(b).
However there is one situation in the US where AREDN |trade| devices are limited to 10W PEP. This special limitation applies to legacy devices that use 802.11b, which is a Spread Spectum (SS) emission. FCC part 97.313(j) limits SS transmitter power to 10W PEP. All other AREDN |trade| devices use 802.11n which transmits carrier waves with combinations of PSK and AM modulations. Refer to the 802.11n MCS rate tables for specific modulations that are used.
However there is one situation in the US where AREDN® devices are limited to 10W PEP. This special limitation applies to legacy devices that use 802.11b, which is a Spread Spectum (SS) emission. FCC part 97.313(j) limits SS transmitter power to 10W PEP. All other AREDN® devices use 802.11n which transmits carrier waves with combinations of PSK and AM modulations. Refer to the 802.11n MCS rate tables for specific modulations that are used.
In actual practice, the output power of AREDN |trade| devices will be limited by the hardware that is used. Even though in the US the FCC rules allow higher power, all of the modern commercial routers being used for AREDN |trade| physically cannot transmit these high power levels. Therefore, the power limits allowed in the US by the FCC will never be reached unless you have an external Power Amplifier.
In actual practice, the output power of AREDN® devices will be limited by the hardware that is used. Even though in the US the FCC rules allow higher power, all of the modern commercial routers being used for AREDN® physically cannot transmit these high power levels. Therefore, the power limits allowed in the US by the FCC will never be reached unless you have an external Power Amplifier.
Some of the advantages and disadvantages of each frequency range are explained in the sections below which give examples of frequencies that are available to Amateur radio operators in the US.
@ -43,7 +43,7 @@ Some of the advantages and disadvantages of each frequency range are explained i
Advantages
One advantage for using the 5 cm band is that it contains 54 channels, and many of them may be under-utilized with less chance of interference. You can choose channel widths of 5, 10, or 20 MHz, with larger channel widths providing higher data rates. Remember that reducing the channel width may increase the :abbr:`SNR (Signal to Noise Ratio)` to improve signal quality if that is an issue for a marginal radio link.
The radio equipment and antenna systems for this band are readily available and are less expensive due to greater consumer demand. There is a wide variety of equipment from several manufacturers which supports the AREDN |trade| firmware and operates across the 54 available channels. Radio and antenna systems for this band which are similar in size to those for other bands will often have higher gain. Devices in the 5 cm band are also well-suited for *Backbone Links* since there is little chance for RF interference from other radios sharing these frequencies at high profile sites. With clear line of sight and well-aligned antennas, 5.8 GHz signals can propagate across very long distances.
The radio equipment and antenna systems for this band are readily available and are less expensive due to greater consumer demand. There is a wide variety of equipment from several manufacturers which supports the AREDN® firmware and operates across the 54 available channels. Radio and antenna systems for this band which are similar in size to those for other bands will often have higher gain. Devices in the 5 cm band are also well-suited for *Backbone Links* since there is little chance for RF interference from other radios sharing these frequencies at high profile sites. With clear line of sight and well-aligned antennas, 5.8 GHz signals can propagate across very long distances.
.. image:: ../_images/5.8ghz.png
:alt: 5.8 GHz Band
@ -57,7 +57,7 @@ Disadvantages
3.4 GHz Characteristics
-----------------------
.. note:: Late in 2020 the FCC ruled to sunset secondary Amateur allocations in the 9 cm *(3.3-3.5 GHz)* band. Although existing Amateur operations *"may continue while the Commission finalizes plans to reallocate spectrum,"* be aware that future FCC actions could remove Amateur operations altogether. Consider this before investing in or implementing new AREDN |trade| devices in this band.
.. note:: Late in 2020 the FCC ruled to sunset secondary Amateur allocations in the 9 cm *(3.3-3.5 GHz)* band. Although existing Amateur operations *"may continue while the Commission finalizes plans to reallocate spectrum,"* be aware that future FCC actions could remove Amateur operations altogether. Consider this before investing in or implementing new AREDN® devices in this band.
Advantages
Equipment in the 9 cm band is appropriate for *Backbone Links* since there is less potential for interference from other devices sharing these frequencies at tower sites. With clear line of sight and well-aligned antennas, 3.4 GHz signals can propagate across very long distances. You can select channel widths of 5, 10, or 20 MHz, with larger channel widths providing higher data rates. Remember that reducing the channel width may increase the SNR to improve signal quality if that is an issue for a marginal link.
@ -69,13 +69,13 @@ Advantages
|
Disadvantages
Equipment for the 9 cm band is no longer being manufactured and used devices are becoming difficult to find. Care must be taken when selecting radios so as not to confuse them with the more common WiMAX devices which are designed for the 3.65 GHz range and are not supported for use with AREDN |trade| firmware. As mentioned previously, there must be clear line of sight and the Fresnel Zone between nodes also must be clear. For a link in the 9 cm band with 10 miles between nodes the first Fresnel Zone radius will be 62 feet, which is less than the 13 cm band discussed below. However, the 60% no blockage radius is still about 37 feet. Consider node AGL and terrain in order to minimize obstructions.
Equipment for the 9 cm band is no longer being manufactured and used devices are becoming difficult to find. Care must be taken when selecting radios so as not to confuse them with the more common WiMAX devices which are designed for the 3.65 GHz range and are not supported for use with AREDN® firmware. As mentioned previously, there must be clear line of sight and the Fresnel Zone between nodes also must be clear. For a link in the 9 cm band with 10 miles between nodes the first Fresnel Zone radius will be 62 feet, which is less than the 13 cm band discussed below. However, the 60% no blockage radius is still about 37 feet. Consider node AGL and terrain in order to minimize obstructions.
2.4 GHz Characteristics
-----------------------
Advantages
One advantage for the 13 cm band is that radio equipment and antenna systems are more readily available and less costly due to higher consumer demand. There is a wide variety of equipment from several manufacturers which supports the AREDN |trade| firmware and operates in this band. With clear line of sight and well-aligned antennas, 2.4 GHz signals can propagate across very long distances.
One advantage for the 13 cm band is that radio equipment and antenna systems are more readily available and less costly due to higher consumer demand. There is a wide variety of equipment from several manufacturers which supports the AREDN® firmware and operates in this band. With clear line of sight and well-aligned antennas, 2.4 GHz signals can propagate across very long distances.
Within the available frequency range you have the option of selecting channel widths of either 5, 10, or 20 MHz. A larger channel width will provide higher data rates. However, one effect of reducing the channel width is to increase the :abbr:`SNR (Signal to Noise Ratio)` to improve signal quality. For example, changing from a 20 MHz to a 10 MHz channel width will result in a 3 dB signal gain and could make the difference between a marginal link and a usable one. Just remember that when you cut the channel width in half you are also reducing your maximum throughput by half. Carefully test your links to ensure optimal performance.
@ -103,7 +103,7 @@ Advantages
|
Disadvantages
The entire 33 cm band is shared between several FCC authorized radio services. The disadvantage of using this band for AREDN |trade| networking is that in all but the most remote areas the RF noise floor may be very high, which reduces the :abbr:`SNR (Signal to Noise Ratio)` and results in packet loss, retransmission delays, and lower usable link quality.
The entire 33 cm band is shared between several FCC authorized radio services. The disadvantage of using this band for AREDN® networking is that in all but the most remote areas the RF noise floor may be very high, which reduces the :abbr:`SNR (Signal to Noise Ratio)` and results in packet loss, retransmission delays, and lower usable link quality.
Equipment for the 33 cm band is no longer being manufactured and used devices are becoming difficult to find. Also the entire band is quite narrow (25 MHz) which means that only one, two, or four radio channels can exist in this shared frequency range, depending on the channel width that is selected.

2
arednNetworkDesign/network_modeling.rst
View File

@ -2,7 +2,7 @@
Network Modeling
================
As you design your AREDN |trade| network it is often helpful to estimate ahead of time whether a node or link might accomplish your goals for the network. One way to get this information is to use computer modeling programs that predict the performance of RF devices. There are many types of computerized tools that you can use, ranging from relatively expensive commercial software to freely available open source programs. You should select and become familiar with the tool that best fits your aptitude, experience, and budget.
As you design your AREDN® network it is often helpful to estimate ahead of time whether a node or link might accomplish your goals for the network. One way to get this information is to use computer modeling programs that predict the performance of RF devices. There are many types of computerized tools that you can use, ranging from relatively expensive commercial software to freely available open source programs. You should select and become familiar with the tool that best fits your aptitude, experience, and budget.
In this section some free tools will be used to illustrate how to determine your network's available paths and overall coverage. Keep in mind that a computer modeling tool only provides a prediction and does not guarantee that two sites will be able to communicate when actually deployed.

6
arednNetworkDesign/network_topology.rst
View File

@ -2,18 +2,18 @@
Network Topologies
==================
Every AREDN |trade| node is capable of automatically joining an *ad hoc* mesh network which is operating with the same SSID, channel, and bandwidth. New nodes will each explore their surroundings by broadcasting their identity and listening for their neighbors' responses. Once nodes identify others within radio range, they share this information so that each node has a picture of the network topology. Periodic updates adjust the network routes based on changes in signal quality or loss of a link, allowing the network to adapt to changing conditions. Since there can be several possible routes between nodes, and since network disruptions typically effect only part of the network, a mesh topology can provide redundancy for network links.
Every AREDN® node is capable of automatically joining an *ad hoc* mesh network which is operating with the same SSID, channel, and bandwidth. New nodes will each explore their surroundings by broadcasting their identity and listening for their neighbors' responses. Once nodes identify others within radio range, they share this information so that each node has a picture of the network topology. Periodic updates adjust the network routes based on changes in signal quality or loss of a link, allowing the network to adapt to changing conditions. Since there can be several possible routes between nodes, and since network disruptions typically effect only part of the network, a mesh topology can provide redundancy for network links.
.. image:: _images/mesh-topology.png
:alt: Mesh Topology
:align: right
Every AREDN |trade| node within radio range of other nodes will be able to participate in the network to extend its reach, provide route redundancy, or host services needed on the network at large. This simple mesh topology may serve its purpose perfectly for a short-term network deployed in support of a local event, or even for more permanent communication between nodes which are always within radio range. However, as mentioned in the previous chapter, the most important consideration for you network design is, *"What is the purpose for this particular network?"* The specific requirements of your mission should drive the design of your data network.
Every AREDN® node within radio range of other nodes will be able to participate in the network to extend its reach, provide route redundancy, or host services needed on the network at large. This simple mesh topology may serve its purpose perfectly for a short-term network deployed in support of a local event, or even for more permanent communication between nodes which are always within radio range. However, as mentioned in the previous chapter, the most important consideration for you network design is, *"What is the purpose for this particular network?"* The specific requirements of your mission should drive the design of your data network.
Types of Topologies
-------------------
Although AREDN |trade| nodes are capable of forming a simple mesh network, it is more common for operators to use different topologies in order to accomplish their data communication goals in growing networks. Typical network designs include Point-to-Point, Hub-and-Spoke, Tree or hybrid topologies.
Although AREDN® nodes are capable of forming a simple mesh network, it is more common for operators to use different topologies in order to accomplish their data communication goals in growing networks. Typical network designs include Point-to-Point, Hub-and-Spoke, Tree or hybrid topologies.
Point-to-Point Topology
Point-to-Point topologies are best suited for moving data between the far endpoints, potentially using one or more intermediate nodes in order to traverse different types of terrain or to overcome obstacles in the network path.

8
arednNetworkDesign/networking_overview.rst
View File

@ -2,9 +2,9 @@
Networking Overview
===================
This **Network Design Guide** will discuss some of the useful principles for creating robust data networks as a service both to the amateur radio hobby and the community at large. An AREDN |trade| network is able to serve as the transport mechanism for the applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
This **Network Design Guide** will discuss some of the useful principles for creating robust data networks as a service both to the amateur radio hobby and the community at large. An AREDN® network is able to serve as the transport mechanism for the applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
There are a variety of ways to interconnect AREDN |trade| nodes, but the most important question that should be answered is *"What is the purpose for this particular network?"* The specific requirements of your situation will drive the design of your data network. For example, consider the following issues.
There are a variety of ways to interconnect AREDN® nodes, but the most important question that should be answered is *"What is the purpose for this particular network?"* The specific requirements of your situation will drive the design of your data network. For example, consider the following issues.
Temporary or Permanent
Is your network being deployed as a short-term communication mechanism, possibly to meet the needs of a day-long event or a training exercise? If so, then several amateur radio operators with portable nodes can quickly establish an *ad hoc* mesh network with a specific set of services to meet the communication needs for that situation. Those nodes and computers can probably operate from portable batteries, without any external power dependencies for such a limited-time deployment.
@ -12,7 +12,7 @@ Temporary or Permanent
Is your network intended as a long-term or permanent infrastructure to serve the on-going communication needs of a local region? If so, then a more sophisticated network topology must be designed and constructed to meet those long-term requirements. More robust or ruggedized radio equipment may be necessary, and more reliable AC power or off-grid renewable energy resources will be required to ensure consistent operations.
Geography and Terrain
Where is data communication needed? Are there specific locations where network nodes are required? What level of :abbr:`RF (Radio Frequency)` coverage will be needed in order to reach those locations? The places that the network must reach will determine the number and position of AREDN |trade| nodes.
Where is data communication needed? Are there specific locations where network nodes are required? What level of :abbr:`RF (Radio Frequency)` coverage will be needed in order to reach those locations? The places that the network must reach will determine the number and position of AREDN® nodes.
What are the geographical characteristics of the area across which your data network will operate? Different types of terrain may require specific types of network connections in order to adequately cover the region over which data communications are needed. More demanding terrain may require a larger number of intermediate nodes or possibly larger higher-gain antenna systems and mounting structures.
@ -22,6 +22,6 @@ Expansion and Growth
Applications and Throughput
What network programs, applications, or services should be provided in order to fulfill the purpose for this network? Each application will generate a certain amount of data traffic, and some programs or services are more data-intensive than others. The network needs to be designed to adequately pass the traffic for the required applications.
How many simultaneous users will be generating network traffic at different times? As the number of users increases, the amount of data traversing the network will also increase. In addition, with an increasing number of nodes on the network there will be a corresponding increase in the amount of `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ traffic that is necessary to maintain the network. An AREDN |trade| network should be designed to handle the expected workload.
How many simultaneous users will be generating network traffic at different times? As the number of users increases, the amount of data traversing the network will also increase. In addition, with an increasing number of nodes on the network there will be a corresponding increase in the amount of `OLSR (Optimized Link State Routing protocol) <https://en.wikipedia.org/wiki/Optimized_Link_State_Routing_Protocol>`_ traffic that is necessary to maintain the network. An AREDN® network should be designed to handle the expected workload.
With these issues in mind, it is always best to keep your network as simple as possible and to include only those services which are required. Be sure to design your network so that it accomplishes its mission and suits its intended purpose.

6
arednServicesGuide/chat_programs.rst
View File

@ -9,7 +9,7 @@ Chat programs are one of the least network-intensive types of communication prog
MeshChat
--------
MeshChat has become the primary chat service for AREDN |trade| networks because it was written specifically for mesh communication by Trevor Paskett K7FPV. Users access MeshChat via web browser, and the service can run on the mesh node itself or on a LAN-connected Debian or Raspberry Pi computer. After logging in by entering a call sign, you can send a message by typing into a text box and clicking the *Submit* button. The list of active users is displayed, and every message is visible to all participants on the chat service. Multiple *Zones* and *Channels* are supported for categorizing and filtering message traffic.
MeshChat has become the primary chat service for AREDN® networks because it was written specifically for mesh communication by Trevor Paskett K7FPV. Users access MeshChat via web browser, and the service can run on the mesh node itself or on a LAN-connected Debian or Raspberry Pi computer. After logging in by entering a call sign, you can send a message by typing into a text box and clicking the *Submit* button. The list of active users is displayed, and every message is visible to all participants on the chat service. Multiple *Zones* and *Channels* are supported for categorizing and filtering message traffic.
A copy of the message database is stored on every device where MeshChat is running. Nodes may have intermittent network connectivity, but as long as at least one node is available the MeshChat database remains intact. Once nodes come online they immediately sync by retrieving a full copy of the message database. If any new messages are found, they are appended to the local message database.
@ -17,9 +17,9 @@ In addition to the keyboard-to-keyboard chat feature, MeshChat also allows files
MeshChat *Action Scripts* also provide for functional extensions, such as sending messages to an SMS gateway for external distribution. It is also possible for action scripts to periodically save the message database for archive purposes or integration with external tools.
Although MeshChat is a commonly deployed service, it is a third party package which is not available in the AREDN |trade| repositories. You can find additional information by visiting this link: `MeshChat at Trevor's Bench <http://www.trevorsbench.com/meshchat-messaging-for-mesh-networks/>`_
Although MeshChat is a commonly deployed service, it is a third party package which is not available in the AREDN® repositories. You can find additional information by visiting this link: `MeshChat at Trevor's Bench <http://www.trevorsbench.com/meshchat-messaging-for-mesh-networks/>`_
As originally designed, MeshChat uses the Perl programming language and is able to run either on an AREDN |trade| node or on a LAN-connected Debian or Raspberry Pi computer. After the retirement of Perl on AREDN |trade| nodes, there are now alternative MeshChat packages which use the Lua programming language for running on nodes. If you are running the original Perl version on an external computer, you can still use the new Lua API on your node to provide the computer with the list of MeshChat nodes. These packages are available at the following links:
As originally designed, MeshChat uses the Perl programming language and is able to run either on an AREDN® node or on a LAN-connected Debian or Raspberry Pi computer. After the retirement of Perl on AREDN® nodes, there are now alternative MeshChat packages which use the Lua programming language for running on nodes. If you are running the original Perl version on an external computer, you can still use the new Lua API on your node to provide the computer with the list of MeshChat nodes. These packages are available at the following links:
- `Latest Lua version of Meshchat at the new package maintainer's repository <https://github.com/hickey/meshchat/releases>`_

4
arednServicesGuide/dispatch_programs.rst
View File

@ -4,7 +4,7 @@ Computer Aided Dispatch
`Computer Aided Dispatch <https://en.wikipedia.org/wiki/Computer-aided_dispatch>`_ provides an automated way for emergency services agencies to keep track of incidents, activities, information, tasks, messages, and the status of deployed resources. Command staff are able to see the big picture, while at the same time maintaining detailed records of plans and actions for future reference. Deployed resources are able to clearly communicate in realtime, while having much better situational awareness of surrounding events.
Served agencies have been using Computer Aided Dispatch (CAD) software for quite some time, and it has become their preferred method for managing events and incidents within their jurisdiction. In emergencies when electrical power or mission-critical facilities become unavailable and agencies are forced to operate off-grid, AREDN |trade| operators with portable power for mesh networks and computing resources can bridge the gap by providing :abbr:`CAD (Computer Aided Dispatch)` solutions for personnel at key sites.
Served agencies have been using Computer Aided Dispatch (CAD) software for quite some time, and it has become their preferred method for managing events and incidents within their jurisdiction. In emergencies when electrical power or mission-critical facilities become unavailable and agencies are forced to operate off-grid, AREDN® operators with portable power for mesh networks and computing resources can bridge the gap by providing :abbr:`CAD (Computer Aided Dispatch)` solutions for personnel at key sites.
There is a wide variety of :abbr:`CAD (Computer Aided Dispatch)` software in use today. Many of the sophisticated commercial packages have integrated `automatic vehicle location (AVL) <https://en.wikipedia.org/wiki/Automatic_vehicle_location>`_ and `geographic information systems (GIS) <https://en.wikipedia.org/wiki/Geographic_information_system>`_ which require large amounts of network bandwidth and dedicated computing resources that might not be accessible during an emergency.
@ -13,7 +13,7 @@ The programs described in this section can help you to provision :abbr:`CAD (Com
EmComMap
--------
EmComMap was designed by an `Amateur Radio Emergency Service <https://en.wikipedia.org/wiki/Amateur_Radio_Emergency_Service>`_ operator for use on AREDN |trade| mesh networks during deployments. It leverages modern technologies for interactive maps and sync-able web browser databases to enable map-based situational awareness and emergency communication across IP networks. Based on this architecture, EmComMap is one of the more mesh-friendly :abbr:`CAD (Computer Aided Dispatch)` programs with additional features in progress for data distribution.
EmComMap was designed by an `Amateur Radio Emergency Service <https://en.wikipedia.org/wiki/Amateur_Radio_Emergency_Service>`_ operator for use on AREDN® mesh networks during deployments. It leverages modern technologies for interactive maps and sync-able web browser databases to enable map-based situational awareness and emergency communication across IP networks. Based on this architecture, EmComMap is one of the more mesh-friendly :abbr:`CAD (Computer Aided Dispatch)` programs with additional features in progress for data distribution.
.. image:: _images/emcommap.png
:alt: EmComMap Display

2
arednServicesGuide/email_programs.rst
View File

@ -51,7 +51,7 @@ Using WinLink to Send Email
Although it is not typically used as a TCP/IP network application, many operators are already familiar with `WinLink 2000 <https://en.wikipedia.org/wiki/Winlink>`_ for sending message traffic between WinLink computers across amateur radio frequencies. It is possible to configure *Winlink Express* and Telnet Post Office or Telnet P2P for sending email with attachments across a mesh network.
You will need a stable Microsoft Windows computer with plenty of memory to run this system (8GB recommended). The maximum attachment size is currently 5MB per message as compared to the 100KB limitation on HF and Packet RMS stations. Refer to the information below for details about specific network settings and procedures for configuring Winlink over AREDN |trade|. Additional information compiled by Orv Beach W6BI can be found in the `document linked here <https://www.arednmesh.org/sites/default/files/Configuring%20Winlink%20Express.pdf>`_.
You will need a stable Microsoft Windows computer with plenty of memory to run this system (8GB recommended). The maximum attachment size is currently 5MB per message as compared to the 100KB limitation on HF and Packet RMS stations. Refer to the information below for details about specific network settings and procedures for configuring Winlink over AREDN®. Additional information compiled by Orv Beach W6BI can be found in the `document linked here <https://www.arednmesh.org/sites/default/files/Configuring%20Winlink%20Express.pdf>`_.
.. image:: _images/winlink.png
:alt: Winlink Interface

10
arednServicesGuide/network_tools.rst
View File

@ -2,19 +2,19 @@
Networking Tools
================
There are several service programs that can assist in visualizing or mapping an AREDN |trade| network, as well as for viewing local RF conditions near your node. Some of these programs are discussed below.
There are several service programs that can assist in visualizing or mapping an AREDN® network, as well as for viewing local RF conditions near your node. Some of these programs are discussed below.
Manage Extra Static Routes
--------------------------
There may be cases when you need to create extra static routes to control the flow of network traffic through your node. You can maintain your extra routes by entering them into the ``/etc/aredn_include/static_routes`` file. You must login to your node at the command line and use the ``vi`` editor to manage the routes in this file. A helpful example is provided in the file, and you can view the `OpenWRT Static Routes <https://openwrt.org/docs/guide-user/network/routing/routes_configuration>`_ page for additional information about managing static routes.
AREDN |trade| Prometheus Exporter
AREDN® Prometheus Exporter
---------------------------------
`Prometheus <https://en.wikipedia.org/wiki/Prometheus_(software)>`_ is an open-source monitoring and alerting toolkit which collects and stores metrics as time series data. At given intervals it can collect metrics from AREDN |trade| nodes having the ``prometheus-exporter`` package installed. Prometheus evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are detected.
`Prometheus <https://en.wikipedia.org/wiki/Prometheus_(software)>`_ is an open-source monitoring and alerting toolkit which collects and stores metrics as time series data. At given intervals it can collect metrics from AREDN® nodes having the ``prometheus-exporter`` package installed. Prometheus evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are detected.
AREDN |trade| metrics in the ``prometheus-exporter`` package include the following:
AREDN® metrics in the ``prometheus-exporter`` package include the following:
- Node details (name, model, firmware, description, Lat/Lon, grid square, band, channel, width, frequency, SSID)
- Memory, storage, CPU, and networking metrics
@ -30,7 +30,7 @@ In order for Prometheus to pull metrics from a node it will use the following ta
|
The AREDN |trade| ``prometheus-exporter`` simply makes these metrics available for Prometheus to pull. For additional information about Prometheus itself, visit `their website here <https://prometheus.io/>`_. The following image shows Prometheus metrics for an AREDN |trade| node being displayed by the `Grafana <https://en.wikipedia.org/wiki/Grafana>`_ visualization application.
The AREDN® ``prometheus-exporter`` simply makes these metrics available for Prometheus to pull. For additional information about Prometheus itself, visit `their website here <https://prometheus.io/>`_. The following image shows Prometheus metrics for an AREDN® node being displayed by the `Grafana <https://en.wikipedia.org/wiki/Grafana>`_ visualization application.
.. image:: _images/grafana.png
:alt: Prometheus Exporter metrics in Grafana

14
arednServicesGuide/other_programs.rst
View File

@ -2,14 +2,14 @@
Other Services
==============
As mentioned in the *Services Overview*, almost any program that can operate across a peer-to-peer TCP/IP network is a candidate for AREDN |trade| networking. Many useful services have been discussed previously, and this section will list some of the other types of services that you might consider deploying on your mesh network.
As mentioned in the *Services Overview*, almost any program that can operate across a peer-to-peer TCP/IP network is a candidate for AREDN® networking. Many useful services have been discussed previously, and this section will list some of the other types of services that you might consider deploying on your mesh network.
Network Time Services
---------------------
Although the AREDN |trade| nodes themselves do not depend on network time synchronization, there may be other programs or services running on your mesh network which would benefit from having accurate network time updates. `Network Time Protocol (NTP) <https://en.wikipedia.org/wiki/Network_Time_Protocol>`_ is a reliable way for networked devices to update their system clocks. This may be especially helpful for devices that do not have an onboard realtime clock, such as Raspberry Pi computers. It may also be important to have accurate timestamps across the network for programs such as MeshChat, email message logging, file timestamps, video surveillance images, and many others.
Although the AREDN® nodes themselves do not depend on network time synchronization, there may be other programs or services running on your mesh network which would benefit from having accurate network time updates. `Network Time Protocol (NTP) <https://en.wikipedia.org/wiki/Network_Time_Protocol>`_ is a reliable way for networked devices to update their system clocks. This may be especially helpful for devices that do not have an onboard realtime clock, such as Raspberry Pi computers. It may also be important to have accurate timestamps across the network for programs such as MeshChat, email message logging, file timestamps, video surveillance images, and many others.
Most NTP implementations depend on an Internet connection in order to synchronize with upstream time servers. However, it would be more useful to be able to synchronize system clocks in an off-grid situation when AREDN |trade| nodes are deployed during an emergency. One way to accomplish this would be to configure one or more battery powered computers as NTP servers which retrieve upstream time from GPS satellites *(stratum 0)*.
Most NTP implementations depend on an Internet connection in order to synchronize with upstream time servers. However, it would be more useful to be able to synchronize system clocks in an off-grid situation when AREDN® nodes are deployed during an emergency. One way to accomplish this would be to configure one or more battery powered computers as NTP servers which retrieve upstream time from GPS satellites *(stratum 0)*.
.. image:: _images/centerclick.png
:alt: NTP Appliance
@ -27,10 +27,10 @@ You may choose to purchase an inexpensive off-the-shelf NTP appliance such as th
|
AREDN |trade| Alert Message Manager
AREDN® Alert Message Manager
-----------------------------------
AREDN |trade| Alert Messages were explained in the **Getting Started Guide** under the *Node Status* and *Advanced Configuration* sections. The example given there showed the Alert Message source running on a separate LAN-connected web server. It is also possible to provide Alert Messages using an application created by Gerard Hickey (WT0F) which runs directly on a node having adequate storage. The AREDN |trade| Alert Message Manager *(aamm)* uses the node's web server to provide a web interface for creating, updating, or deleting Alert Messages -- as well as actually hosting the message repository on the node itself, so that no external LAN-connected web server is required.
AREDN® Alert Messages were explained in the **Getting Started Guide** under the *Node Status* and *Advanced Configuration* sections. The example given there showed the Alert Message source running on a separate LAN-connected web server. It is also possible to provide Alert Messages using an application created by Gerard Hickey (WT0F) which runs directly on a node having adequate storage. The AREDN® Alert Message Manager *(aamm)* uses the node's web server to provide a web interface for creating, updating, or deleting Alert Messages -- as well as actually hosting the message repository on the node itself, so that no external LAN-connected web server is required.
.. image:: _images/aamm-display.png
:alt: AAMM Display
@ -46,7 +46,7 @@ The two advantages of using this application are 1) having the message managemen
|
The recipient nodes are configured the same way as described in the **Getting Started Guide** under the *Advanced Configuration* section for AREDN |trade| Alert Messages. For additional information about the AREDN |trade| Alert Message Manager, visit this link: `aamm <https://gitlab.com/aredn-apps/aamm>`_. You may also download and install the latest *aamm* package files `here <https://gitlab.com/aredn-apps/aamm/-/packages>`_.
The recipient nodes are configured the same way as described in the **Getting Started Guide** under the *Advanced Configuration* section for AREDN® Alert Messages. For additional information about the AREDN® Alert Message Manager, visit this link: `aamm <https://gitlab.com/aredn-apps/aamm>`_. You may also download and install the latest *aamm* package files `here <https://gitlab.com/aredn-apps/aamm/-/packages>`_.
weeWx Weather Service
---------------------
@ -74,7 +74,7 @@ Tracking deployed resources is an important task during any emergency. There are
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.
There may be situations when it would also be helpful to track the locations of aircraft during an emergency. `Automatic Dependent Surveillance-Broadcast (ADS-B) <https://en.wikipedia.org/wiki/Automatic_dependent_surveillance_%E2%80%93_broadcast>`_ information is available which can be captured using portable computers with ADS-B receivers. The following image shows the track of two water tankers dropping fire retardant above Santa Barbara, California, during the 2017 `Thomas Fire <https://en.wikipedia.org/wiki/Thomas_Fire>`_. This information was displayed across an AREDN |trade| network using an `ADS-B Ground station <https://flightaware.com/adsb/piaware/build>`_ which was running as a mesh network service.
There may be situations when it would also be helpful to track the locations of aircraft during an emergency. `Automatic Dependent Surveillance-Broadcast (ADS-B) <https://en.wikipedia.org/wiki/Automatic_dependent_surveillance_%E2%80%93_broadcast>`_ information is available which can be captured using portable computers with ADS-B receivers. The following image shows the track of two water tankers dropping fire retardant above Santa Barbara, California, during the 2017 `Thomas Fire <https://en.wikipedia.org/wiki/Thomas_Fire>`_. This information was displayed across an AREDN® network using an `ADS-B Ground station <https://flightaware.com/adsb/piaware/build>`_ which was running as a mesh network service.
.. image:: _images/ADS-B.png
:alt: ADS-B Map Display

12
arednServicesGuide/services_overview.rst
View File

@ -1,10 +1,10 @@
===============================
AREDN |trade| Services Overview
AREDN® Services Overview
===============================
As mentioned in the AREDN |trade| overview, the purpose of an amateur radio emergency data network is to provide typical Internet or intranet programs to people who need to communicate across a wide area during an emergency or community event. An AREDN |trade| network provides the transport mechanism for the types of programs people typically use today to communicate with each other in the normal course of their business and social interactions. This may include keyboard-to-keyboard chat, email messages with images and attachments, file transfer, collaborative document sharing, :abbr:`VoIP (Voice over IP)` phone service, video conferencing, :abbr:`GPS (Global Positioning System)` tracking, surveillance camera streaming, computer aided dispatch, deployed resource management, weather station reporting, sensor monitoring and control, repeater linking, and many other services.
As mentioned in the AREDN® overview, the purpose of an amateur radio emergency data network is to provide typical Internet or intranet programs to people who need to communicate across a wide area during an emergency or community event. An AREDN® network provides the transport mechanism for the types of programs people typically use today to communicate with each other in the normal course of their business and social interactions. This may include keyboard-to-keyboard chat, email messages with images and attachments, file transfer, collaborative document sharing, :abbr:`VoIP (Voice over IP)` phone service, video conferencing, :abbr:`GPS (Global Positioning System)` tracking, surveillance camera streaming, computer aided dispatch, deployed resource management, weather station reporting, sensor monitoring and control, repeater linking, and many other services.
The purpose for this section of the AREDN |trade| documentation is to identify examples of services that might be useful for communication across a mesh network. None of these programs are directly supported by the AREDN |trade| development team. Almost any program that can operate on a peer-to-peer TCP/IP network is a candidate for AREDN |trade| networking, but you should carefully select and test your services to ensure they will work within the following guidelines.
The purpose for this section of the AREDN® documentation is to identify examples of services that might be useful for communication across a mesh network. None of these programs are directly supported by the AREDN® development team. Almost any program that can operate on a peer-to-peer TCP/IP network is a candidate for AREDN® networking, but you should carefully select and test your services to ensure they will work within the following guidelines.
- An important consideration for selecting programs is to understand the impact each service will have on the performance and reliability of the network during the times when digital communication is required. As a best practice, choose programs which require the least amount of computing and network resources in order to operate successfully.
@ -12,9 +12,9 @@ The purpose for this section of the AREDN |trade| documentation is to identify e
- It is equally important to choose data services that meet the criteria defined in FCC Part 97 regulations for amateur radio services. Try to avoid programs that use encryption or proprietary compression algorithms, which may be interpreted as "encoding messages for the purpose of obscuring their meaning" (FCC Part 97.113-a-4).
- As a general rule services should be run on separate LAN-connected computers rather than on the AREDN |trade| nodes themselves. Node devices have very limited resources which should be conserved for node operation rather than for running extra programs. Try to select external computers that have low power requirements, since many AREDN |trade| deployments are off-grid and without any external network access. Many operators use `Raspberry Pi <https://en.wikipedia.org/wiki/Raspberry_Pi>`_ computers which are small, easy to transport, and require minimal DC power for operation.
- As a general rule services should be run on separate LAN-connected computers rather than on the AREDN® nodes themselves. Node devices have very limited resources which should be conserved for node operation rather than for running extra programs. Try to select external computers that have low power requirements, since many AREDN® deployments are off-grid and without any external network access. Many operators use `Raspberry Pi <https://en.wikipedia.org/wiki/Raspberry_Pi>`_ computers which are small, easy to transport, and require minimal DC power for operation.
When choosing programs to use as AREDN |trade| services you will probably find that there is more than one way to accomplish your goals. It is crucial to clearly understand the types of communication that meet the requirements of your mission, and then you will be able to select the best programs for the job. Always try to use a program that will cause the least performance impact to your network.
When choosing programs to use as AREDN® services you will probably find that there is more than one way to accomplish your goals. It is crucial to clearly understand the types of communication that meet the requirements of your mission, and then you will be able to select the best programs for the job. Always try to use a program that will cause the least performance impact to your network.
Most TCP/IP programs are designed to use the `Client-Server <https://en.wikipedia.org/wiki/Client%E2%80%93server_model>`_ model, where one or more client programs communicate through a central server or servers distributed hierarchically. These types of programs can operate on a mesh network as long as the server is reachable or readily accessible by the nodes that need to use them.
@ -22,4 +22,4 @@ As a general rule for mesh networks, simpler is better. The more complicated and
Several programs have been designed to take advantage of multiple paths between nodes and multiple peer servers coexisting on a mesh network. There are fewer of these mesh-friendly programs, but they will be identified as they appear in the following sections.
The remaining parts of this guide will focus on examples of services that could be offered on your AREDN |trade| network. Programs are grouped by type, and where possible the network impact of each program will be described in order for you to understand the resources that may be required to use the program as a service on the mesh. Remember that the mentioned programs are merely suggestions or examples of typical Internet-style TCP/IP applications which could be deployed on you network to meet the specific communication requirements of your mission.
The remaining parts of this guide will focus on examples of services that could be offered on your AREDN® network. Programs are grouped by type, and where possible the network impact of each program will be described in order for you to understand the resources that may be required to use the program as a service on the mesh. Remember that the mentioned programs are merely suggestions or examples of typical Internet-style TCP/IP applications which could be deployed on you network to meet the specific communication requirements of your mission.

12
arednServicesGuide/video_streaming.rst
View File

@ -2,7 +2,7 @@
Video Streaming and Surveillance
================================
The previous section described how audio and video traffic can be transmitted across an AREDN |trade| network to facilitate communication. Since these multimedia streams are supported on mesh networks, you can also use them for many other tasks. One example, `video surveillance <https://en.wikipedia.org/wiki/Closed-circuit_television>`_, is often helpful during an emergency or event and AREDN |trade| networks can be used to deliver this type of traffic to Emergency Operations Centers. Keep in mind that multimedia traffic incurs a much greater cost in terms of network performance and computing resources, so be sure your mesh network is designed with the appropriate bandwidth to handle this traffic.
The previous section described how audio and video traffic can be transmitted across an AREDN® network to facilitate communication. Since these multimedia streams are supported on mesh networks, you can also use them for many other tasks. One example, `video surveillance <https://en.wikipedia.org/wiki/Closed-circuit_television>`_, is often helpful during an emergency or event and AREDN® networks can be used to deliver this type of traffic to Emergency Operations Centers. Keep in mind that multimedia traffic incurs a much greater cost in terms of network performance and computing resources, so be sure your mesh network is designed with the appropriate bandwidth to handle this traffic.
The photo below shows a Mobile Command Center (MCC) deployed to support a large event in San Juan Capistrano, California. An estimated 35,000 people attend this annual gathering, and the local :abbr:`RACES (Radio Amateur Civil Emergency Service)` team provides realtime video coverage of the parade route for the sheriff’s department and emergency response agencies.
@ -12,7 +12,7 @@ The photo below shows a Mobile Command Center (MCC) deployed to support a large
|
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.”
More than a dozen high definition `IP cameras <https://en.wikipedia.org/wiki/IP_camera>`_ were collocated at portable AREDN® 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
----------------
@ -25,9 +25,9 @@ IP Video Cameras
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/cameras>`_, 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.
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/cameras>`_, 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® 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.
A 1920x1080 resolution video stream at 60 frames/second can consume up to eight megabits/second of network bandwidth. Few AREDN |trade| networks can consistently support that load, but lower frame rates reduce the required bandwidth proportionally. Typically 720p at 10 frames per second is more than adequate for video surveillance.
A 1920x1080 resolution video stream at 60 frames/second can consume up to eight megabits/second of network bandwidth. Few AREDN® networks can consistently support that load, but lower frame rates reduce the required bandwidth proportionally. Typically 720p at 10 frames per second is more than adequate for video surveillance.
IP cameras with an Ethernet port are preferred in order to simplify network connectivity and ensure adequate data transfer speeds. Configure the camera to obtain a mesh IP address from the node, and reserve the address for that camera in the node's DHCP settings so you have a consistent way to connect to it. A camera with :abbr:`PoE (Power over Ethernet)` support is also very useful as this simplifies site cabling.
@ -47,7 +47,7 @@ The Windows program provides a "surface" or workspace where you add and configur
iSpy can connect to IP cameras using MJPEG or JPEG sources. It also supports camera connections using MP4, ASF, or RTSP, which it accomplishes through a VLC plugin after `Videolan <http://www.videolan.org/>`_ software is installed. VLC requires usernames and passwords directly in the URL, so you must enter them in clear text as in this example: ``http://admin:password@192.168.1.4/video.asf``.
In the lower right video stream on the iSpy display below you can see the smoke plume from the 2017 `Thomas Fire <https://en.wikipedia.org/wiki/Thomas_Fire>`_ in California, which was recorded by a camera on the local AREDN |trade| network. For additional information about iSpy, visit this link: `iSpy <https://www.ispyconnect.com/>`_.
In the lower right video stream on the iSpy display below you can see the smoke plume from the 2017 `Thomas Fire <https://en.wikipedia.org/wiki/Thomas_Fire>`_ in California, which was recorded by a camera on the local AREDN® network. For additional information about iSpy, visit this link: `iSpy <https://www.ispyconnect.com/>`_.
.. image:: _images/ispy.png
:alt: iSpy Display
@ -60,7 +60,7 @@ MotionEye
MotionEye is a lightweight video display program which runs on Linux and Raspberry Pi computers. It can connect to a variety of USB or IP cameras, and it has the ability to display video streams in a grid format accessible by any web browser on the mesh network. Authentication as a regular user or an administrator will display different menu options: view options for regular users or full administrative control for admin users.
The backend `Motion <https://motion-project.github.io/index.html>`_ engine is built to provide robust motion detection and event triggering. It also enables custom scripts to extend its features, for example to print the system temperature and update it every ten seconds on the display. Many AREDN |trade| operators implement MotionEye on low-power portable Raspberry Pi computers, and the `MotionEyeOS distro <https://github.com/motioneye-project/motioneyeos/wiki>`_ installs the operating system with all dependencies on this platform. For additional information about MotionEye, visit this link: `MotionEye <https://github.com/motioneye-project/motioneye/wiki>`_
The backend `Motion <https://motion-project.github.io/index.html>`_ engine is built to provide robust motion detection and event triggering. It also enables custom scripts to extend its features, for example to print the system temperature and update it every ten seconds on the display. Many AREDN® operators implement MotionEye on low-power portable Raspberry Pi computers, and the `MotionEyeOS distro <https://github.com/motioneye-project/motioneyeos/wiki>`_ installs the operating system with all dependencies on this platform. For additional information about MotionEye, visit this link: `MotionEye <https://github.com/motioneye-project/motioneye/wiki>`_
.. image:: _images/motioneye.png
:alt: MotionEye Display

14
aredn_overview.rst
View File

@ -1,8 +1,8 @@
======================
AREDN |trade| Overview
AREDN® Overview
======================
The AREDN |trade| acronym stands for "Amateur Radio Emergency Data Network" and it provides a way for *Amateur Radio* operators to create high-speed ad hoc *Data Networks* for use in *Emergency* and service-oriented communications.
The AREDN® acronym stands for "Amateur Radio Emergency Data Network" and it provides a way for *Amateur Radio* operators to create high-speed ad hoc *Data Networks* for use in *Emergency* and service-oriented communications.
For many years amateur radio operators and their served agencies have relied on voice transmissions for emergency or event communications. A typical message-passing scenario involved conveying the message to a radio operator who would write or type it onto a standard ICS-213 form. The message would then be relayed by radio to another operator who would write or type it on another ICS-213 form at the receiving end. The form would typically be hand-delivered to the recipient who would read and sign the form. Any acknowledgement or reply would then be handled through the same process from the receiving end back to the originator.
@ -10,14 +10,14 @@ This tried-and-true scenario has worked well, and it continues to work for handl
.. sidebar:: Our Mission
The primary goal of the AREDN |trade| project is to empower licensed amateur radio operators to quickly and easily deploy high-speed data networks when and where they are needed.
The primary goal of the AREDN® project is to empower licensed amateur radio operators to quickly and easily deploy high-speed data networks when and where they are needed.
In today's high-tech society people have become accustomed to different ways of handling their communication needs. The preferred methods involve short messaging and keyboard-to-keyboard communication, along with audio-video communication using Voice over IP (VoIP) and streaming technologies.
The amateur radio community is able to meet these high-bandwidth digital communication requirements by using FCC Part 97 amateur radio frequency bands to send digital data between devices which are linked with each other to form a self-healing, fault-tolerant data network. Some have described this as an amateur radio version of the Internet. Although it is not intended for connecting people to **the Internet**, an AREDN |trade| mesh network will provide typical Internet or intranet-type applications to people who need to communicate across a wide area during an emergency or community event.
The amateur radio community is able to meet these high-bandwidth digital communication requirements by using FCC Part 97 amateur radio frequency bands to send digital data between devices which are linked with each other to form a self-healing, fault-tolerant data network. Some have described this as an amateur radio version of the Internet. Although it is not intended for connecting people to **the Internet**, an AREDN® mesh network will provide typical Internet or intranet-type applications to people who need to communicate across a wide area during an emergency or community event.
An AREDN |trade| network is able to serve as the transport mechanism for the preferred applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the AREDN |trade| implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
An AREDN® network is able to serve as the transport mechanism for the preferred applications people rely upon to communicate with each other in the normal course of their business and social interactions, including email, chat, phone service, document sharing, video conferencing, and many other useful programs. Depending on the characteristics of the AREDN® implementation, this digital data network can operate at near-Internet speeds with many miles between network nodes.
A foundational design goal of the AREDN |trade| project is to minimize the technical expertise that is normally required to configure a robust radio network. Devices running AREDN |trade| firmware are in many ways self-configuring so that users without a background in IP networking can easily build or connect to a local RF network. As mentioned in a recent `Amateur Radio Digital Communications (ARDC) <https://www.ardc.net/>`_ annual report, "AREDN |trade| software allows volunteers to set up a node with minimal expertise and effort, and because the software configures the network automatically, advanced network technology is not needed."
A foundational design goal of the AREDN® project is to minimize the technical expertise that is normally required to configure a robust radio network. Devices running AREDN® firmware are in many ways self-configuring so that users without a background in IP networking can easily build or connect to a local RF network. As mentioned in a recent `Amateur Radio Digital Communications (ARDC) <https://www.ardc.net/>`_ annual report, "AREDN® software allows volunteers to set up a node with minimal expertise and effort, and because the software configures the network automatically, advanced network technology is not needed."
This facilitates the primary goal of the AREDN |trade| project, which is to empower licensed amateur radio operators to quickly and easily deploy high-speed data networks when and where they are needed, as a service both to the hobby and the community. This is especially important in cases when traditional "utility" services (electricity, phone lines, or Internet services) become unavailable. In those cases an off-grid amateur radio emergency data network may be a lifeline for communities impacted by a local disaster.
This facilitates the primary goal of the AREDN® project, which is to empower licensed amateur radio operators to quickly and easily deploy high-speed data networks when and where they are needed, as a service both to the hobby and the community. This is especially important in cases when traditional "utility" services (electricity, phone lines, or Internet services) become unavailable. In those cases an off-grid amateur radio emergency data network may be a lifeline for communities impacted by a local disaster.

16
conf.py
View File

@ -41,16 +41,16 @@ extensions = [
'sphinx.ext.autodoc',
]
rst_epilog = """
`Link: AREDN® Webpage <https://www.arednmesh.org>`_
"""
###rst_epilog = """
###`Link: AREDN® Webpage <https://www.arednmesh.org>`_
###"""
# Include the trademark symbol in the prolog
rst_prolog = """
.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
:ltrim:
"""
###rst_prolog = """
###.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
### :ltrim:
###
###"""
# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']

8
index.rst
View File

@ -1,12 +1,12 @@
===========================
AREDN |trade| Documentation
AREDN® Documentation
===========================
:Release: |release|
This documentation set consists of several sections which are shown in the navigation list.
* The **Getting Started Guide** walks through the process of configuring an AREDN |trade| radio node to be part of a mesh network.
* The **Getting Started Guide** walks through the process of configuring an AREDN® radio node to be part of a mesh network.
* The **Network Design Guide** provides background information and tips for planning and deploying a robust mesh network.
* The **Applications and Services Guide** discusses the types of programs or services that can be used across a mesh network.
* The **How-to Guides** provide tips and techniques for various tasks.
@ -14,9 +14,9 @@ This documentation set consists of several sections which are shown in the navig
If you wish to locate specific topics within the documentation, you can type keywords into the *Search docs* field to display a list of items which match your search.
If you would like to see the documentation for a specific AREDN |trade| release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
If you would like to see the documentation for a specific AREDN® release, click on the **Read the Docs** label at the bottom of the navigation bar. This label shows the version you are currently viewing, but clicking the label bar opens a panel with several other options. Here you may choose to view another version of the documentation, and you can also download the entire documentation set in any of several formats *(PDF, ePub, HTML)* for offline use.
.. note:: AREDN |trade| is a registered trademark of *Amateur Radio Emergency Data Network, Inc.* and may not be used without permission.
.. note:: AREDN® is a registered trademark of *Amateur Radio Emergency Data Network, Inc.* and may not be used without permission.
.. toctree::
:maxdepth: 1

40
why_aredn.rst
View File

@ -1,12 +1,12 @@
==================
Why AREDN |trade|
Why AREDN®
==================
AREDN |trade| provides a way for amateur radio operators to create high-speed data networks for use in emergency and community service communication. At a high level, an Amateur Radio Emergency Data Network is simply another tool for your EmComm toolbox. As an amateur radio operator involved in emergency communication, you already have quite a few RF resources that you use on a regular basis. AREDN |trade| is yet another tool that you might want to have available if it meets an important EmComm requirement, which we’ll see in a moment.
AREDN® provides a way for amateur radio operators to create high-speed data networks for use in emergency and community service communication. At a high level, an Amateur Radio Emergency Data Network is simply another tool for your EmComm toolbox. As an amateur radio operator involved in emergency communication, you already have quite a few RF resources that you use on a regular basis. AREDN® is yet another tool that you might want to have available if it meets an important EmComm requirement, which we’ll see in a moment.
Some seasoned operators may ask, “Why do I need another tool when the ones I already have are working just fine?” The simple answer is that you only need AREDN |trade| when it serves a useful purpose or meets an important need for your served agency. As always, you should use the right tool for the job.
Some seasoned operators may ask, “Why do I need another tool when the ones I already have are working just fine?” The simple answer is that you only need AREDN® when it serves a useful purpose or meets an important need for your served agency. As always, you should use the right tool for the job.
When might you want to use AREDN |trade| mesh networking? It depends on what type of communication is required for your deployment. AREDN |trade| is very useful if your served agency needs specific applications or services that require a computer network between sites. If high-speed digital communication is needed across an area, then AREDN |trade| is a good solution. If the sites to be linked are located in areas where normal infrastructure has become unavailable, then AREDN |trade| nodes can be used to create a portable off-grid data network. Also, if different resources are transient because they come and go at various locations, then an AREDN |trade| node’s ability to automatically join or form mesh networks might be a real benefit. It might be helpful to look at the evolution of EmComm capabilities used by amateur radio operators through the years.
When might you want to use AREDN® mesh networking? It depends on what type of communication is required for your deployment. AREDN® is very useful if your served agency needs specific applications or services that require a computer network between sites. If high-speed digital communication is needed across an area, then AREDN® is a good solution. If the sites to be linked are located in areas where normal infrastructure has become unavailable, then AREDN® nodes can be used to create a portable off-grid data network. Also, if different resources are transient because they come and go at various locations, then an AREDN® node’s ability to automatically join or form mesh networks might be a real benefit. It might be helpful to look at the evolution of EmComm capabilities used by amateur radio operators through the years.
.. image:: _images/intro-02.png
:alt: Intro 02
@ -18,7 +18,7 @@ Traditionally we have used RF voice communication on a variety of radio bands. A
In recent years Digital RF communication was included in the EmComm toolkit, with the addition of things like Packet Radio and WinLink. These modes moved emergency message passing into the digital realm, and this minimized or eliminated some of the sources of error in the communication chain. Digital RF communication was mainly text-based and is relatively slow speed but very reliable.
When AREDN |trade| became available it added several features which the served agency staff were already familiar with in their normal operations. These include the ability to transfer digital messages at relatively high speeds (in the multi-megabit range), as well as the capability for multimedia communication such as Voice, Photos, and streaming Video. It gave them the ability to use Internet-style applications or programs, and to integrate their smartphones, tablets, and laptops into the EmComm network. Let’s take a look at one example of how amateur public service communication has evolved over the years.
When AREDN® became available it added several features which the served agency staff were already familiar with in their normal operations. These include the ability to transfer digital messages at relatively high speeds (in the multi-megabit range), as well as the capability for multimedia communication such as Voice, Photos, and streaming Video. It gave them the ability to use Internet-style applications or programs, and to integrate their smartphones, tablets, and laptops into the EmComm network. Let’s take a look at one example of how amateur public service communication has evolved over the years.
.. image:: _images/intro-03.png
:alt: Intro 03
@ -30,7 +30,7 @@ This photo was taken at a recent Marine Corp Marathon in the Washington, DC area
In the past they used mainly Voice & Digital RF modes. Typically they deployed Icom ID-1 data radios with speeds around 128 kbps, as well as packet radio with speeds around 9600 baud. Their After Action Reports identified several concerns, though. They indicated that data transfer rates were too slow. They also mentioned that the equipment was heavier and more complex to set up, as well as requiring higher capacity portable power sources.
For a couple of years they began experimenting with AREDN |trade|, and recent deployments have been based around AREDN |trade| networks. They indicated that they were able to achieve high data transfer speeds (in the range of 10 Mbps or more), using equipment that was lighter weight, less complex, and required much less power to operate. In addition, they were able to provide Voice over IP, Video Streaming, and multi-user network database access.
For a couple of years they began experimenting with AREDN®, and recent deployments have been based around AREDN® networks. They indicated that they were able to achieve high data transfer speeds (in the range of 10 Mbps or more), using equipment that was lighter weight, less complex, and required much less power to operate. In addition, they were able to provide Voice over IP, Video Streaming, and multi-user network database access.
.. image:: _images/intro-04.png
:alt: Intro 04
@ -38,7 +38,7 @@ For a couple of years they began experimenting with AREDN |trade|, and recent de
|
Devices that support AREDN |trade| come in a wide variety of shapes and sizes because AREDN |trade| firmware can be installed on many types of inexpensive “off the shelf” wifi radios. AREDN |trade| allows us to repurpose commercially available radios as mesh network nodes, many of which can communicate on unshared frequencies set aside specifically for licensed amateurs. Most of these commercial radios are rugged and weather-proof for outdoor installations. They typically use Power over Ethernet (PoE) which makes them less complicated to deploy by having a single cable to the device. Many of them also have integrated high gain antennas.
Devices that support AREDN® come in a wide variety of shapes and sizes because AREDN® firmware can be installed on many types of inexpensive “off the shelf” wifi radios. AREDN® allows us to repurpose commercially available radios as mesh network nodes, many of which can communicate on unshared frequencies set aside specifically for licensed amateurs. Most of these commercial radios are rugged and weather-proof for outdoor installations. They typically use Power over Ethernet (PoE) which makes them less complicated to deploy by having a single cable to the device. Many of them also have integrated high gain antennas.
The frequency ranges that are currently supported are the 900 MHz, 2.4 GHz, and 5.8 GHz bands. These microwave frequencies do require direct line of sight for reliable communication. Depending on the type of radios and antennas that are deployed, it’s possible to achieve network links anywhere from a few miles to well over 30 miles between sites.
@ -58,9 +58,9 @@ From this you can see that different types of radios serve different functions w
|
For our purposes in providing emergency or event communication as volunteers, we should focus on designing a network that is able to reliably transfer information to and from the locations where it is needed. A successful network is one that achieves its purpose, so design your networks to meet the specific requirements of a mission. We’ll see some good examples of this in a moment, but we should keep this as our main goal for using AREDN |trade| to provide EmComms.
For our purposes in providing emergency or event communication as volunteers, we should focus on designing a network that is able to reliably transfer information to and from the locations where it is needed. A successful network is one that achieves its purpose, so design your networks to meet the specific requirements of a mission. We’ll see some good examples of this in a moment, but we should keep this as our main goal for using AREDN® to provide EmComms.
In simplest terms, when you deploy AREDN |trade| devices you are providing a high-speed digital data network. Keep in mind that the network itself doesn’t really accomplish your mission. The applications, programs, and services riding your network are the key to accomplishing the mission. Your group may or may not be responsible for providing those applications and services. But if you do provide a program or service, be sure that what you provide is simple and intuitive to use, both for other amateur operators as well as for served agency staff members. Let’s look at some specific examples.
In simplest terms, when you deploy AREDN® devices you are providing a high-speed digital data network. Keep in mind that the network itself doesn’t really accomplish your mission. The applications, programs, and services riding your network are the key to accomplishing the mission. Your group may or may not be responsible for providing those applications and services. But if you do provide a program or service, be sure that what you provide is simple and intuitive to use, both for other amateur operators as well as for served agency staff members. Let’s look at some specific examples.
.. image:: _images/intro-08.png
:alt: Intro 08
@ -68,8 +68,8 @@ In simplest terms, when you deploy AREDN |trade| devices you are providing a hig
|
Whenever possible, deploy services that people are already familiar with. These days anyone can pick up a telephone and call someone’s phone number. They’re used to chatting with friends and co-workers using their computer keyboard. Almost everyone can read and send an email, often with large files or photos as attachments. People are used to pulling up a photo or image in their web browser or watching a streaming video from a web site. These are the types of services that would be a good fit for AREDN |trade| networks.
In this example, several stations were set up as part of an EmComms exercise. Participants were able to pick up a standard telephone to dial or answer phone calls between distant locations, all transmitted by RF using an AREDN |trade| network.
Whenever possible, deploy services that people are already familiar with. These days anyone can pick up a telephone and call someone’s phone number. They’re used to chatting with friends and co-workers using their computer keyboard. Almost everyone can read and send an email, often with large files or photos as attachments. People are used to pulling up a photo or image in their web browser or watching a streaming video from a web site. These are the types of services that would be a good fit for AREDN® networks.
In this example, several stations were set up as part of an EmComms exercise. Participants were able to pick up a standard telephone to dial or answer phone calls between distant locations, all transmitted by RF using an AREDN® network.
.. image:: _images/intro-09.png
:alt: Intro 09
@ -77,7 +77,7 @@ In this example, several stations were set up as part of an EmComms exercise. Pa
|
In this example, an amateur radio group was given the mission to provide live video feeds across a specific area. AREDN |trade| nodes with video cameras were deployed at key points along the route, and network connected computers displayed each video stream on different monitors in the Sheriff's mobile command post.
In this example, an amateur radio group was given the mission to provide live video feeds across a specific area. AREDN® nodes with video cameras were deployed at key points along the route, and network connected computers displayed each video stream on different monitors in the Sheriff's mobile command post.
After this event someone from the served agency said, “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 real time. Incredibly, there was only one arrest for fighting, which just happened to take place in the camera’s view.”
@ -87,7 +87,7 @@ After this event someone from the served agency said, “This mesh camera system
|
When a community-wide event or emergency occurs, one of the challenges is keeping track of deployed resources -- whether they are people, or places, or equipment. In this example, an AREDN |trade| network is being used to track resources and display messages that are sent between sites. The map on the left is a great visualization tool, and the main goal of this application is to increase the team’s situational awareness. The specific software running on this mesh network was developed by Dan K6OAT for the Los Angeles ARES team. People at each location are able to see what is going on around them from their mesh-connected computer.
When a community-wide event or emergency occurs, one of the challenges is keeping track of deployed resources -- whether they are people, or places, or equipment. In this example, an AREDN® network is being used to track resources and display messages that are sent between sites. The map on the left is a great visualization tool, and the main goal of this application is to increase the team’s situational awareness. The specific software running on this mesh network was developed by Dan K6OAT for the Los Angeles ARES team. People at each location are able to see what is going on around them from their mesh-connected computer.
.. image:: _images/intro-11.png
:alt: Intro 11
@ -95,9 +95,9 @@ When a community-wide event or emergency occurs, one of the challenges is keepin
|
In southern California some of the mountaintop AREDN |trade| backbone sites were deployed with video surveillance cameras on the towers. In this example, one of these mountaintop cameras captured and recorded this image. It was the first view of the 2017 Thomas Fire. This recording was requested by the fire management authorities to be included in their after action reports.
In southern California some of the mountaintop AREDN® backbone sites were deployed with video surveillance cameras on the towers. In this example, one of these mountaintop cameras captured and recorded this image. It was the first view of the 2017 Thomas Fire. This recording was requested by the fire management authorities to be included in their after action reports.
The inset on the right is an image of the flight paths of tanker aircraft traversing the region. Flight data was captured using an ADS-B receiver and displayed from a Raspberry Pi computer on the AREDN |trade| network.
The inset on the right is an image of the flight paths of tanker aircraft traversing the region. Flight data was captured using an ADS-B receiver and displayed from a Raspberry Pi computer on the AREDN® network.
.. image:: _images/intro-12.png
:alt: Intro 12
@ -105,7 +105,7 @@ The inset on the right is an image of the flight paths of tanker aircraft traver
|
This example illustrates using small AREDN |trade| nodes connected to agency laptops. Each computer then has access to the AREDN |trade| network and has the ability to communicate with other network resources. This would provide local communication across a field or parking lot as shown here, but the laptops could also link to an intermediate AREDN |trade| node on top of a mast in the center of the area. From there the data could be transferred across longer distances to sites that are coordinating the event or exercise.
This example illustrates using small AREDN® nodes connected to agency laptops. Each computer then has access to the AREDN® network and has the ability to communicate with other network resources. This would provide local communication across a field or parking lot as shown here, but the laptops could also link to an intermediate AREDN® node on top of a mast in the center of the area. From there the data could be transferred across longer distances to sites that are coordinating the event or exercise.
.. image:: _images/intro-13.png
:alt: Intro 13
@ -113,10 +113,10 @@ This example illustrates using small AREDN |trade| nodes connected to agency lap
|
Almost any Internet-style program that operates across a standard TCP/IP network can be deployed using AREDN |trade| devices. This includes all of the examples shown in this list. Just remember that the services deployed should align with the specific mission or purpose for the network you are creating. Just because you can add nodes or services to a network, doesn’t mean you should add them. Each new item added to a network will use part of the limited processing and bandwidth resources that are available. Make sure your network is successful by deploying exactly what is needed in order to accomplish your mission.
Almost any Internet-style program that operates across a standard TCP/IP network can be deployed using AREDN® devices. This includes all of the examples shown in this list. Just remember that the services deployed should align with the specific mission or purpose for the network you are creating. Just because you can add nodes or services to a network, doesn’t mean you should add them. Each new item added to a network will use part of the limited processing and bandwidth resources that are available. Make sure your network is successful by deploying exactly what is needed in order to accomplish your mission.
Probably the best single place to go for additional information is the AREDN |trade| website at www.arednmesh.org. There you will find information about the types of radios that are supported, as well as all of the AREDN |trade| software available for download.
Probably the best single place to go for additional information is the AREDN® website at www.arednmesh.org. There you will find information about the types of radios that are supported, as well as all of the AREDN® software available for download.
There is also a wealth of information on choosing devices and planning AREDN |trade| networks for EmComms. The Forum provides a way to engage with a very active worldwide community of fellow hams who are working with the same hardware and software that you are. They are eager to help answer questions, as well as testing various devices and network configurations.
There is also a wealth of information on choosing devices and planning AREDN® networks for EmComms. The Forum provides a way to engage with a very active worldwide community of fellow hams who are working with the same hardware and software that you are. They are eager to help answer questions, as well as testing various devices and network configurations.
Regional and local AREDN |trade| mesh groups can also be contacted through the Forum. You can also access the extensive set of documentation that is available online, including detailed sections on installing and configuring radios, planning and modeling network links, providing different kinds of services for your network, and a variety of other topics.
Regional and local AREDN® mesh groups can also be contacted through the Forum. You can also access the extensive set of documentation that is available online, including detailed sections on installing and configuring radios, planning and modeling network links, providing different kinds of services for your network, and a variety of other topics.