Skip to content

Commit

Permalink
change download page to AFS (#249)
Browse files Browse the repository at this point in the history
  • Loading branch information
ab7pa authored Apr 16, 2023
1 parent 4637c15 commit 5fc9c88
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 21 deletions.
Binary file added arednGettingStarted/_images/afs-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added arednGettingStarted/_images/afs-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 36 additions & 16 deletions arednGettingStarted/downloading_firmware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,51 @@
Downloading AREDN |trade| Firmware
==================================

Current Stable Releases
-----------------------
Types of Firmware
-----------------

Once you have selected and obtained a device, the next step is to choose the matching AREDN |trade| firmware image for that specific device. The `AREDN download page <http://downloads.arednmesh.org/firmware/html/stable.html>`_ displays the most current firmware releases for every supported device.
**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.

Locate your device model/version in the left column. Most manufacturers print the hardware version on the product package label. In some cases, though, you may need to start the device using the manufacturer's pre-installed firmware and navigate to the system information page to determine the hardware version.
**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 firmware will have a series of alphanumeric characters such as ``2526-e8911a9`` indicating the software commit identifier for that specific firmware build.

There are two types of firmware images: 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.
Choosing Firmware to Download
-----------------------------

- If you are loading AREDN |trade| firmware on TP-LINK or Ubuquiti devices for the first time you must download the *factory* firmware from the middle column. For Mikrotik devices you must download both the *factory* and *sysupgrade* images. For GL.iNet devices you must download the *sysupgrade* image from the righthand column.
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/>`_.

- If you are already running AREDN |trade| firmware on the node then you will choose the *sysupgrade* firmware from the righthand column, and you will use the AREDN |trade| web interface to perform the firmware upgrade.
.. image:: _images/afs-1.png
:alt: AREDN Firmware Selector
:align: center

Once you have selected the correct firmware image for your device, click the link to download the image file to your local computer. Make a note of the download location on your computer, since you will need to use that image to install the AREDN |trade| 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.
Enter the first few characters of the hardware manufacturer in the *Model* search field (case insensitive), then click the firmware image dropdown on the right to choose the firmware release that you want to download. Next, find your device model in the search results list and click the row for your hardware.

.. image:: _images/afs-2.png
:alt: AREDN Firmware Selector
:align: center

|
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.

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.
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.

Nightly Build Firmware
-----------------------
Mikrotik
If you are loading firmware on Mikrotik devices for the first time you must download **both** the *KERNEL* and *SYSUPGRADE* images. Otherwise download only the *SYSUPGRADE* firmware image.

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.

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.

*Nightly Build* firmware contains the latest bug fixes, features, and support for the newest devices being added to the *Supported Platform Matrix*. It allows the wider mesh community to test new code before it is included in a formal code release. The Nightly Build is considered more experimental or cutting-edge and may not be suitable for *production* nodes. However, 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 has just been added, then it might make sense to install the nightly build firmware.
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.

To download the *Nightly Build*, navigate to the `Software > Nightly Builds <https://www.arednmesh.org/content/nightly-builds>`_ link on the AREDN |trade| website. Nightly Build filenames are prefixed with *aredn-XXXX-yyyyyyy*, where *XXXX* identifies the build number and *yyyyyyy* is a unique software commit identifier. You will find the most recent *README* file, a cumulative list of the changes included in the *CHANGELOG*, the most recent list of *SUPPORTED_DEVICES*, and a link to download the firmware. As explained above, select the correct target and subtarget for the device you will be flashing. To return your device to the current stable release, download the correct *Stable Release* firmware and reflash your device.
Nightly Build Direct Download
To download the *Nightly Build* directly, navigate to `http://downloads.arednmesh.org/snapshots/targets/ <http://downloads.arednmesh.org/snapshots/targets/>`_. Nightly Build filenames are prefixed with *aredn-XXXX-yyyyyyy*, where *XXXX* identifies the build number and *yyyyyyy* is a unique software commit identifier. As explained above, select the correct target and subtarget for the device you will be flashing. To return your device to the current stable release, download the correct *Stable Release* firmware and reflash your device.

Be aware that when a new nightly build becomes available, any older builds automatically become obsolete. If you want to install add-on packages for nodes running a nightly build, understand that specific packages will not be available for an *older* build if a *newer* build has superseded it. Be sure to upgrade to the current nightly build before installing packages. Nightly build firmware contains the cumulative changes that have gone before, so review the *Changelog* to determine which features are included in the build.
Be aware that when a new nightly build becomes available, any older builds automatically become obsolete. If you want to install add-on packages for nodes running a nightly build, understand that specific packages will not be available for an *older* build if a *newer* build has superseded it. Be sure to upgrade to the current nightly build before installing packages.
6 changes: 2 additions & 4 deletions arednGettingStarted/mesh_status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ Remote Nodes
Searchable Column Headers
^^^^^^^^^^^^^^^^^^^^^^^^^

As your network grows in size, the length of the *Mesh Status* display will also grow. At some point it may become difficult to find specific devices or services on the page, especially in the *Remote Nodes* section. To help alleviate this issue search fields have been provided on several column headers in the *Current Neighbors* and *Remote Nodes* tables.
As your network grows in size, the length of the *Mesh Status* display will also grow. At some point it may become difficult to find specific devices or services on the page, especially in the *Remote Nodes* section. To help alleviate this issue search fields have been provided on the column headers in these tables.

As you enter each character from your keyboard into the search fields, the display will change to show only the entries that match your character or string. The filter is case insensitive, so it will find both upper and lower case entries for the characters you enter.

If you press the **Refresh** button on the *Mesh Status* display, your search fields will be cleared. In some cases if you press the ``Enter`` key after entering your search string, you may notice that the *Mesh Status* display is refreshed and your search string is gone -- but if you click the field where you entered the search string you may see that the browser has saved that string for future use and it can be selected from a dropdown list. This behavior is browser-dependent, so you may find slightly different behavior depending on the web browser you are using.
As you enter each character from your keyboard into the search fields, the display will change to show only the entries that match your character or string. The filter is case insensitive, so it will find both upper and lower case entries for the characters you enter. If you press the **Refresh** button on the *Mesh Status* display, your search fields will be cleared.
2 changes: 1 addition & 1 deletion arednGettingStarted/selecting_devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The amateur radio community has recognized the benefits of using inexpensive com

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>`_.

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 *Stable* firmware this list is found in the `Supported Platform Matrix <https://www.arednmesh.org/content/supported-platform-matrix/>`_. 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 |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.

There is additional guidance on the features and characteristics of specific devices in the `Device Selection Chart <https://www.arednmesh.org/content/device-selection-chart/>`_ on the AREDN |trade| website.

Expand Down

0 comments on commit 5fc9c88

Please sign in to comment.