hbnet/install.md

90 lines
3.7 KiB
Markdown
Raw Normal View History

2021-02-25 18:35:54 -08:00
## WORK IN PROGRESS
# How to install HBLink3 with D-APRS
### Note about different branches:
There are three different branches to the project. All three branches contain hblink and the D-APRS application. The **gps** branch contains the D-APRS application. The **aprs_features** branch contains the D-APRS application _and_ a modification to allow the beaconing of the location of connected peers, authored by **IU7IGU**. The **termux** branch is optimized to run on Android.
# Installation
2021-02-26 07:58:59 -08:00
Clone the git repository.
`git clone https://github.com/kf7eel/hblink3`
Change directory to hblink3.
`cd hblink3`
2021-02-25 18:35:54 -08:00
Install the required modules.
`python3 -m pip install -r requirements.txt`
_**Note: Ignore any errors regarding smtplib as that module come by default on most Linux distributions.**_
# Configuration
There are 2 diferent ways to run the application.
First, it can be run as a client, think of it as a receive only DMR hotspot. This is useful for operators who just want
to add APRS functionality to a network. This is the simplest approach and allows for the greatest flexibility for implementing the gateway.
The second method is designed for small networks and is highly experimental. Rather than adding the application as a client, the gateway is included in bridge.py. This allows for much simpler configuration, and theoretically would
handle multiple position transmissions at the same time. However, it is not know how well it will scale up and what processor resources are required, use at your own risk.
**It is reccommended to run the gateway as a client.**
2021-02-26 07:49:03 -08:00
A stanza is a section of the configuration file that begins with brackets (example: **[GLOBAL]**). Below is a summary of each stanza found in the configuration. For more detailed definitions, see the example configurations.
**[GLOBAL]**
Contains settings for ACLs (access control) for the whole server. You also configure the path to configuration files and subscriber_ids here (leave as default).
**[REPORTS]**
Contains settings for network reporting. HBmonitor uses this. Leave as default.
**[LOGGER]**
Contains settings for logging to file, console, etc. Set log level here. Leave as default.
2021-02-26 07:58:59 -08:00
**[APRS]**
**Note: This APRS stanza only applies to the _aprs_features_ beanch of the project. It is requires for beaconing the position of connected peers (repeaters or hotspots) and does not affect any GPS data from radios. This stanza only needs to be in hblink.cfg.**
This stanza contains the settings for APRS-IS, this stanza only applies to the **_aprs_features_** branch. When beaconing the location of a connected hotspot or repeater (not GPS location of a radio), the settings here are used.
2021-02-26 07:49:03 -08:00
**[GPS_DATA]**
2021-02-26 07:58:59 -08:00
**Note: The GPS_DATA stanza is only required in the configuration file that gps_data.py will be using.**
**[ALIASES]**
2021-02-26 07:49:03 -08:00
2021-02-26 07:58:59 -08:00
This is the configuration for downloading the latest DMR ID database from radioid.net. Default setting will fetch new DB every 7 days.
2021-02-26 07:49:03 -08:00
**See notes below to continue configuration**
2021-02-25 18:44:16 -08:00
2021-02-25 18:39:32 -08:00
# D-APRS as a client
2021-02-25 18:35:54 -08:00
2021-02-26 08:06:05 -08:00
Copy gps_data-SAMPLE.cfg to gps_data.cfg. Add a PEER stanza to connect to your network via MMDVM connection. Connecting the gateway to your network as a PEER is a fairly simple process. Add a MASTER stanza in you network configuration and call it something like "D-APRS". This is the MASTER that you will connect the gateway to as a client. You will need to modify rules.py on your network to allow the desired talkgroup/private calling to route to the gateway via MMDVM connection.
2021-02-25 18:35:54 -08:00
2021-02-26 08:06:05 -08:00
You could also set a MASTER stanza and connect your network as a PEER. This is more suited for advanced users.
2021-02-26 07:49:03 -08:00
2021-02-26 08:06:05 -08:00
## GPS branch
**gps branch**
**aprs_features branch**
2021-02-25 18:35:54 -08:00
2021-02-25 18:39:32 -08:00
# D-APRS built into bridge.py
2021-02-25 18:35:54 -08:00
2021-02-25 18:37:30 -08:00
**gps branch**
2021-02-25 18:35:54 -08:00
2021-02-25 18:37:30 -08:00
**aprs_features branch**
2021-02-26 08:02:24 -08:00
2021-02-25 18:35:54 -08:00