diff --git a/arednGettingStarted/_images/01-setup-nocall.png b/arednGettingStarted/_images/01-setup-nocall.png old mode 100755 new mode 100644 index 43809e6..e513cb4 Binary files a/arednGettingStarted/_images/01-setup-nocall.png and b/arednGettingStarted/_images/01-setup-nocall.png differ diff --git a/arednGettingStarted/_images/02-basic-setup.png b/arednGettingStarted/_images/02-basic-setup.png index 691b037..e525cec 100755 Binary files a/arednGettingStarted/_images/02-basic-setup.png and b/arednGettingStarted/_images/02-basic-setup.png differ diff --git a/arednGettingStarted/_images/03-node-status.png b/arednGettingStarted/_images/03-node-status.png old mode 100755 new mode 100644 index a2c9810..43327a9 Binary files a/arednGettingStarted/_images/03-node-status.png and b/arednGettingStarted/_images/03-node-status.png differ diff --git a/arednGettingStarted/_images/07-setup-options.png b/arednGettingStarted/_images/07-setup-options.png index e8355f4..6a9ebbf 100755 Binary files a/arednGettingStarted/_images/07-setup-options.png and b/arednGettingStarted/_images/07-setup-options.png differ diff --git a/arednGettingStarted/_images/07a-lanAP-on.png b/arednGettingStarted/_images/07a-lanAP-on.png new file mode 100755 index 0000000..a36f8eb Binary files /dev/null and b/arednGettingStarted/_images/07a-lanAP-on.png differ diff --git a/arednGettingStarted/_images/09-admin-upgrade.png b/arednGettingStarted/_images/09-admin-upgrade.png old mode 100755 new mode 100644 index 0284fec..b7ec4d4 Binary files a/arednGettingStarted/_images/09-admin-upgrade.png and b/arednGettingStarted/_images/09-admin-upgrade.png differ diff --git a/arednGettingStarted/_images/snr-sound.png b/arednGettingStarted/_images/snr-sound.png old mode 100644 new mode 100755 index c89e20d..7771b94 Binary files a/arednGettingStarted/_images/snr-sound.png and b/arednGettingStarted/_images/snr-sound.png differ diff --git a/arednGettingStarted/advanced_config.rst b/arednGettingStarted/advanced_config.rst index 7972d46..9df40be 100644 --- a/arednGettingStarted/advanced_config.rst +++ b/arednGettingStarted/advanced_config.rst @@ -37,9 +37,17 @@ You have already configured many of the basic settings, but there are several ad Mesh RF Column ^^^^^^^^^^^^^^ -*Mesh RF* is the node's *radio* interface. The AREDN |trade| firmware has been designed to simplify the process of configuring networking 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 any of the network settings on this page, so keep these values unless you fully understand how the mesh works and why the defaults may not be suitable for your situation. +*Mesh RF* is the node's *radio* interface. The AREDN |trade| firmware has been designed to simplify the process of configuring networking interfaces. Network values are automatically calculated based on the unique :abbr:`MAC (Media Access Control)` addresses of your node. You may need to change the *Channel* and possibly the *Channel Width* parameters to match those of your local AREDN |trade| mesh, as explained previously in the **Basic Radio Setup** section. Normally you will not need to change the other network settings on this page, so keep these values unless you fully understand how the mesh works and why the defaults may not be suitable for your situation. -The *Active Settings* can be adjusted and applied without saving changes or rebooting your node. However, they will return to their original values after a reboot unless you click *Save Changes*. A node may decrease its output power as it increases its data rate in order to maintain a linear spectrum. The *Distance* setting increases the packet retry timer to allow stations that are farther away more time to respond. +The *Active Settings* can be adjusted and applied without saving changes or rebooting your node. However, they will return to their original values after a reboot unless you click *Save Changes*. A node may decrease its output power as it increases its data rate in order to maintain a linear spectrum. The *Distance* setting, which must be a value greater than zero, increases the packet retry timer to allow stations that are farther away more time to respond. + +.. image:: _images/07a-lanAP-on.png + :alt: LAN AP Settings + :align: left + +You can disable your node's radio interface by deselecting the *Enable* checkbox, saving your changes, and rebooting the node. With the Mesh RF interface disabled the *Active Settings* no longer apply and will disappear. Since your node now has an unused RF interface, you will notice that a new section appears which allows you to use the node's radio as an FCC Part 15 *LAN Access Point*. You can enable or disable the LAN AP using the *Enable* checkbox. See the details below for configuring the LAN Access Point. + +---------- LAN Column ^^^^^^^^^^ @@ -56,7 +64,7 @@ The other LAN Mode is ``NAT``, and in this mode the LAN is isolated from the mes By default each node runs a :abbr:`DHCP (Dynamic Host Control Protocol)` server for its LAN interface, which lets the node assign IP addresses automatically for devices connected to the node's local area network. The last octet of the start/end range for host IP addresses is shown in the LAN column. If you choose to disable the DHCP server, you must manually configure the host IP addresses to be within the LAN network range. There should be only one DHCP server for each IP address scope or range, so you may need to disable your node's DHCP server if there is already another device providing DHCP services on your node's local area network. Click this link for additional information on `Dynamic Host Control Protocol `_. -The *Disable Default Route* checkbox will tell the node not to advertise that it can be used as a default gateway. This means that computers on the LAN network will have no route to reach the Internet or other networks via the mesh node. If this checkbox is selected your hosts will not be able to access the Internet even if your node has Internet available on its WAN port. You may need to disable the default route if your node needs to be connected to two networks at once, such as being wired to the mesh and connected to a local served agency WiFi network. +If you enabled the *LAN Access Point* feature, edit the access point's SSID, channel, encryption method, and password. Click *Save Changes* to write your information to the node's configuration, and a node reboot will also be required. Now wireless devices can connect to your node through this new WiFi AP, and their DHCP IP address will be assigned by the node's DHCP server. If your node hardware has two radios, for example the *Mikrotik hAP ac lite* with both 2.4 and 5.8 GHz radios in a single unit, the *LAN Access Point* section will always be visible whether or not your *Mesh RF* interface is enabled. WAN Column ^^^^^^^^^^ @@ -65,7 +73,9 @@ The :abbr:`WAN (Wide Area Network)` interface on your node is typically used to If you are not going to use the WAN interface on your node, you can select *disabled* from the *Protocol* dropdown list. If you will be using your node as a *Tunnel Server*, you should assign the node a *Static* IP address on your WAN network. This will be explained in the *Tunnel Server* section below. -When a node has Internet access from either the WAN or LAN interface, that access is available to the node itself and to any computers connected via the *LAN* port. Checking the *Mesh Gateway* box will also allow this node to route traffic from the *Mesh RF* interface to/from the Internet or other external network. By default the *Mesh Gateway* box is unchecked because it is not desirable to route Internet traffic over the radio 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 wireless Internet access, consider using a standard FCC Part 15 compliant access point instead of the node's *Mesh Gateway* feature. +When a node has Internet access on its WAN interface, that access is available to the node itself and to any computers connected via the LAN port. Checking the *Allow others to use my WAN* box will allow this node to route traffic from all its interfaces to/from the Internet or other external network. This box is unchecked by default because it is not desirable to route Internet traffic over the radio 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 wireless Internet access, consider using an FCC Part 15 access point instead of the node's WAN gateway. + +The *Prevent LAN devices from accessing WAN* checkbox will tell the node not to advertise that it can be used as a default gateway. This means that computers on the LAN network will lose their route to the Internet or other networks via your mesh node. This checkbox is deselected by default. If this checkbox is selected your LAN hosts will have no access to the Internet even if your node has Internet access on its WAN interface. You may need to disable the default route if your node needs to be connected to two networks at once, such as being wired to the mesh and connected to a local served agency WiFi network. Node VLANs ^^^^^^^^^^ diff --git a/arednGettingStarted/node_status.rst b/arednGettingStarted/node_status.rst index 796fbb0..c20fb1d 100644 --- a/arednGettingStarted/node_status.rst +++ b/arednGettingStarted/node_status.rst @@ -79,7 +79,7 @@ If you click and drag your mouse across a region of the chart, the display will :alt: SNR Sound Control :align: left -On the left of the Realtime Graph for some devices there is an **SNR Sound** control. Clicking the *On* button will cause your computer to emit a tone that corresponds to the relative SNR level, with higher pitch tones indicating better SNR. This feature was added in order to provide an audio queue to operators in the process of aligning directional antennas. When your antenna reaches a position at which the highest pitch tone is heard you can lock it down without having to look at the signal graph display, knowing that you are receiving the best signal available. +On the left of the Realtime Graph there is an **SNR Sound** control. Clicking the *On* button will cause your computer to emit a tone that corresponds to the relative SNR level, with higher pitch tones indicating better SNR. This feature was added in order to provide an audio queue to operators in the process of aligning directional antennas. When your antenna reaches a position at which the highest pitch tone is heard you can lock it down without having to look at the signal graph display, knowing that you are receiving the best signal available. You can also adjust the tone pitch and volume with the sliders on the sound control. .. |trade| unicode:: U+02122 .. TRADE MARK SIGN :ltrim: diff --git a/arednServicesGuide/_images/ADS-B.png b/arednServicesGuide/_images/ADS-B.png new file mode 100644 index 0000000..66b1254 Binary files /dev/null and b/arednServicesGuide/_images/ADS-B.png differ diff --git a/arednServicesGuide/_images/aprs.png b/arednServicesGuide/_images/aprs.png new file mode 100644 index 0000000..7287bfa Binary files /dev/null and b/arednServicesGuide/_images/aprs.png differ diff --git a/arednServicesGuide/_images/eoc-video.png b/arednServicesGuide/_images/eoc-video.png index 617b768..87db543 100644 Binary files a/arednServicesGuide/_images/eoc-video.png and b/arednServicesGuide/_images/eoc-video.png differ diff --git a/arednServicesGuide/_images/etherpad.png b/arednServicesGuide/_images/etherpad.png index 2efde95..1d73b0f 100644 Binary files a/arednServicesGuide/_images/etherpad.png and b/arednServicesGuide/_images/etherpad.png differ diff --git a/arednServicesGuide/_images/ntp-gps.png b/arednServicesGuide/_images/ntp-gps.png new file mode 100644 index 0000000..9f777fc Binary files /dev/null and b/arednServicesGuide/_images/ntp-gps.png differ diff --git a/arednServicesGuide/_images/weewx.png b/arednServicesGuide/_images/weewx.png new file mode 100644 index 0000000..8c226df Binary files /dev/null and b/arednServicesGuide/_images/weewx.png differ diff --git a/arednServicesGuide/dispatch_programs.rst b/arednServicesGuide/dispatch_programs.rst index 3d0e6f9..fd5cbfc 100644 --- a/arednServicesGuide/dispatch_programs.rst +++ b/arednServicesGuide/dispatch_programs.rst @@ -28,7 +28,7 @@ Open ISES Tickets The *Open Information Systems for Emergency Services* (ISES) project is a community of software developers, paramedics, EMTs, law enforcement, and fire fighters working to create software and training materials for the emergency service community. They currently offer the *Tickets* :abbr:`CAD (Computer Aided Dispatch)` system, which has an extensive suite of features that are accessible by web browser from a mesh network server. Any computing platform is capable of running a *Tickets* server if it supports the traditional `LAMP `_, `XAMPP `_, or `MAMP `_ packages. -*Tickets* presents a situation dashboard showing incidents, responders, and facilities along with a GIS map of their locations. Open Street Map tiles can be downloaded for standalone operation. Clicking any of the controls allows operators to drill into item details, and *Tickets* provides database tracking for a large array of information about each item. The dashboard can be fully integrated with several different functions, including email, chat, routing, and tracking (for example, with :abbr:`APRS (Automatic Position Reporting System)`). +*Tickets* presents a situation dashboard showing incidents, responders, and facilities along with a GIS map of their locations. Open Street Map tiles can be downloaded for standalone operation. Clicking any of the controls allows operators to drill into item details, and *Tickets* provides database tracking for a large array of information about each item. The dashboard can be fully integrated with several different functions, including email, chat, routing, and tracking (for example, with `Automatic Packet Reporting System [APRS] `_). A variety of built-in reports are available which can be viewed, printed, and downloaded for distribution. Standard ICS forms are available for online completion and emailing, and custom *Standard Operating Procedure* (SOP) documents can be integrated for viewing through dashboard links in the web browser. For additional information about *Tickets*, visit this link: `Open ISES Tickets `_. diff --git a/arednServicesGuide/other_programs.rst b/arednServicesGuide/other_programs.rst index b65bf8c..0082b07 100644 --- a/arednServicesGuide/other_programs.rst +++ b/arednServicesGuide/other_programs.rst @@ -2,9 +2,52 @@ Other Possible Services ======================= -.. important:: This section of the documentation is currently a work in progress. +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. +weeWx Weather Service +--------------------- +Many operators have weather stations, as do quite a few repeater sites. If +those weather stations can be put on the mesh network, they can provide +a valuable overview of weather conditions across a wide area, for example, showing wind speeds and rainfall totals for each location. The *weeWx* package is available for many different operating systems and weather station models. It supports serial, USB, and Ethernet connections to weather stations. For additional information about weeWx, visit this link: `weeWx `_. + +.. image:: _images/weewx.png + :alt: weeWx Display + :align: center + +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) `_ 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 email message logging, file updates, 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)*. Position your portable NTP server so that it maintains a clear view of the sky and can get a fix on as many GPS satellites as possible. + +.. image:: _images/ntp-gps.png + :alt: OffGrid NTP Server + :align: center + +In order for NTP to operate properly, each client device must have a fast and reliable connection to the NTP servers on the network. Be sure to locate your NTP servers on reliable high-speed segments of your mesh. For additional information about building an off-grid NTP server, visit this link: `G4WNC NTP post `_. + +GPS Tracking Services +--------------------- + +.. image:: _images/aprs.png + :alt: APRS Map Display + :align: right + +Tracking deployed resources is an important task during any emergency. There are many options for monitoring and displaying the GPS locations of tracked resources, two of which are mentioned here. + +Many amateur radios and portable locating beacons transmit `Automatic Packet Reporting System (APRS) `_ information. It is possible to implement an APRS receiver using inexpensive, battery-powered, portable computers and USB `Software Defined Radios (SDR) `_. The details are widely available for building these receivers using Raspberry Pi computers with `Direwolf `_ and `Xastir `_ or `YAAC `_ 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) `_ 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 `_. This information was displayed across an AREDN |trade| network using an `ADS-B Ground station `_ which was running as a mesh network service. + +.. image:: _images/ADS-B.png + :alt: ADS-B Map Display + :align: center + +---------- + +Depending on the requirements of your specific situation, almost any program that can operate across a peer-to-peer TCP/IP network could be deployed as a service on your mesh network. Check the `AREDN Forums `_ for additional information, ideas, and how-to posts about possible services for mesh networking. .. |trade| unicode:: U+02122 .. TRADE MARK SIGN diff --git a/conf.py b/conf.py index 65beeb9..bfd9ed1 100644 --- a/conf.py +++ b/conf.py @@ -24,9 +24,9 @@ copyright = u'2019, AREDN' author = u'KC0EUW' # The short X.Y version -version = u'3.18.9.0' +version = u'3.19.3.0' # The full version, including alpha/beta/rc tags -release = u'3.18.9.0 base with additions' +release = u'3.19.3.0 pre-release' # -- General configuration --------------------------------------------------- diff --git a/index.rst b/index.rst index 71515a3..9abd021 100644 --- a/index.rst +++ b/index.rst @@ -2,7 +2,7 @@ AREDN Documentation =================== -:Version: 3.18.9.0 plus nightly build additions +:Version: 3.19.3.0 pre-release :Reviewers: KC0EUW, K5DLQ, AE6XE, K6AH, WU2S This documentation set consists of several sections which are shown in the navigation list.