Update 05292025 - N8ACL

Author: n8acl

.DS_Store

@@ -9,7 +9,7 @@ If you want to run this on a Windows or Mac machine, you will need to be able to
 You will need a few things to be able to configure the scripts.
 
 * Your DAPNET Username and Password
-* The Username, Password and IP Address of your MySQL Instance
+* The Username, Password and IP Address of your Database Server Instance
 
 ## Obtaining DAPNET Keys
 
@@ -39,4 +39,4 @@ pip3 install -r requirements.txt
 
 If you are going to run the callsign loader script on another computer, you will need to move that script and the ```requirements.txt``` file to that machine and install the requirements there as well.
 
-Now let's setup the MySQL Database first.
+First let's setup the[```config.json``` file](https://n8acl.github.io/dapnet_paging_gateway/configure_scripts/). You will need this to be able to configure and use your system.

._.DS_Store

@@ -1,70 +1,6 @@
-* 05/30/2021
-  - Minor updates to README and the wiki. 
-
-* 05/19/2021 - Version 5.0 Release
-  - Update of APRSNotify Database to consolidate callsign lists to one table
-  - Redesign of an_util.py into a Flask app to allow for web browser based GUI to configure the script.
-  - Addition of Discord to supported networks.
-  - Automatically does not send a map image with WX Station Data or message notification to Telegram
-  - Updated Wiki with new information.
-
-* 01/15/2021 - Version 4.0 Release
-  - Removal of APRSBot to a different project
-  - Moved from text files for data storage to SQLlite3 Database
-  - Various small bug fixes and rework of the code.
-  - Added: ability to send status to Mastodon
-  - Added: an_util.py configuration utility for interacting with the database
-  - Added: New wiki user guide.
-  - Added: Parsing of Weather Data packet from APRS.
-
-* 12/11/2020 - Release 3.1 - Fixes around APRS.FI API limitations
-  - APRSnotify
-    - Updated aprsnotify.py to split position tracking and messge monitoring lists out to 2 seperate lists due to APRS.fi API restrictions
-  - APRSbot
-    - Updated aprsbot to fix APRS-IS Timeouts for sending locations and messages
-  - README.md
-    - Added limitations to the API to the APRS.fi API key section.
-    - Other updates and clearifications to README.md
-  - Configuration.md
-    - Split callsign lists out to position tracking list and message list. This is due to limitations on the APRS.fi API
-
-* 12/09/2020 - Minor update
-  - Fixed Bug: fixed error in setup.py. Named the config file wrong in variable. (Found by [Alex Bowman, KN4KNG](https://github.com/KN4KNG))
-
-* 11/15/2020 - Version 3.0 Release
-  - Added/New Features:
-    - Added a requirements.txt file to make installing libraries easier for end users
-    - Added checks to make sure all python libraries needed are installed already and notify the user if not and how to install
-    - Created and added new interactive bot functionality, APRSBot
-  - Updates/Changes:
-    - Changed from urllib to requests library to parse json. This makes it easier to use the same url for different purposes
-    - Removed the aprs and msg url variables and combined into aprsfi_url variable for use with new library
-    - Fixed bug: added srccall variable instantiation. This fixes a bug where if the srccall is not pulled properly the script bombs
-    - Removed using Google Geocoder for Reverse geocoding. Only using OpenStreetMaps now
-    - Updated README.md and Configuration.md files
-
-* 08/20/2020
-  - Updates to the ReadMe file
-
-* 07/06/2020 - Version 2.0 Release
-  - Added/New Features:
-    - Ability to choose between Metric and Imperial units
-    - Ability to turn off WX Information and not include it in the status message.
-    - Now sends notification if someone sends the user a message on APRS (requires Telegram bot for this to work).
-    - Sends map image of the packet location to Telegram (requires Telegram bot for this to work).
-  - Updates:
-    - Fixed: If there is not a speed entry in the JSON payload from APRS.FI, the script assumes it's a fixed station and does not include speed in the status message. In Ver. 1.0 this was a bug that would cause the script to fail if there was not a speed entry in the JSON payload.
-    - Updated the config file to include switches for new features.
-    - Updated the configuration walkthrough in this repo.
-    - Updated Setup.py to include switches for new features. Will also update an existing config.py file to the new version. 
-      - NOTE: If you are running version 1, when updating to Version 2 of the script, make sure to run setup.py to update your existing config.py file to the correct config version.
-    - Reworked and tighten up code in the main script
-
-* 02/29/2020 - Initial Release 1.0
-  - Combined functionality of APRSTweet and APRSTelegram
-  - Added: Ability to choose to send to Twitter, Telegram or All
-  - Added: Ability to choose between OpenStreetMaps and Google Geocoding API for reverse geocoding of packet location
-  - Added: Added the hashtag #APRS to the end of the status message for Twitter
-  - Added: Finds the Maidenhead Grid Square based on packet location and includes it in the status message
-  - Added: Created setup utility to help in config file creation.
-  - Update: Fixed URL for aprs.fi in the status message from http:// to https://
+* 05/29/2025
+    * Refactoring/Refining of the code base to bring it up to better programming and Database Standards. 
+    * Update of Documentation
+    * Added Support for Multiple Database Systems
+    * Update to configuration json file.
+    * Changed script to support multiple user modes in one script.

docs/Installation.md

@@ -0,0 +1,58 @@
+# Configure Database
+
+For this to run and work, there is a database component to this that loads some data on a regular basis. So the first thing we need to do is setup the database on your database server.
+
+Note that for this step, you should already have a supported Database System installed and configured. The installation and configuration is out side the scope of this documentation and can be found online.
+
+You also should be a little familiar with Databases and SQL in general to do this part. If not, find a friend who is capable and ask them to help with it (note I didn't say do it for you).
+
+## Create the Database
+
+To create the database, SSH into where you cloned the repo and make sure you are in the scripts directory.
+
+```bash
+cd dapnet_paging_gateway
+
+cd scripts
+```
+
+Then run the ```install.py``` script. This will create the database, the tables and any local directories needed for data downloading and processing.
+
+```bash
+python3 install.py
+```
+
+## Preload some of the data - Multi-User Only
+
+If you are going to use the script in Multi-User mode, you will need to preload some data to the database. These are extensions that people could be calling from, so that the script can pair their extension with the correct Callsign. An example of this would be, say you have multiple Hams at home that could potentially use this system, you will need to add their extension and callsign to the database manually so that the gateway knows what callsign to associate with that extension.
+
+To do this, run the following (modified of course to fix your situation) in your Database Server:
+
+```sql
+insert into dapnet.dbo.ext_data (extension,callsign)
+values('101','W1ABC'),
+('102','WA2ABD')
+```
+
+Make sure to add as many extensions as needed for your PBX.
+
+
+## Test the Scripts
+
+Now you have everything installed and configured, let's try running the script.
+
+Using your DMR ID run the following (making sure you are in the scripts folder):
+
+Replace the following the command first:
+* ```myDMR```: your DMR ID. If you have multiple ones, just choose one, it does not matter.
+* ```test_ext```: If you are in Single user Mode, set this to 12345. If you are in Multi-User Mode, set this to an extension you added earlier.
+
+```bash
+python3 dapnet_paging_gateway.py myDMR 8675309 test_ext
+```
+
+You should get a page on your pager, or check Pi-Star, or check the DAPNET website and you should see a message to you formatted Simliar to ```N8ACL: Call me at 8675309``` but it should be your callsign.
+
+If you get the message, you have everything configured correctly thus far.
+
+Now it's time to [configure FreePBX/Asterisk](https://n8acl.github.io/dapnet_paging_gateway/configure_freepbx/).

docs/changelog.md

@@ -1,6 +1,6 @@
 # Configure FreePBX/Asterisk
 
-Now that we have the scripts configured and the database built, the last step before we can run anything is to configure FreePBX and Asterisk.
+Now that we have the scripts configured and the database built, the last step before we are done is to configure FreePBX and Asterisk.
 
 Note that you should already have a FreePBX/Asterisk instance installed and configured. That is outside the scope of this document/project. There are plenty of guides online to help you do that.
 
@@ -29,48 +29,18 @@ mkdir /var/lib/asterisk/sounds/custom/dapnet_gateway
 
 cd dapnet_paging_gateway
 
-cp /scripts/* /var/lib/asterisk/scripts/dapnet/*
+cp -R /scripts/* /var/lib/asterisk/scripts/dapnet/*
 
 cp /sounds/dapnet_gateway/* /var/lib/asterisk/sounds/custom/dapnet_gateway/*
 ```
 
-Verify your work.
+Verify your work. Make sure all the scripts are in the Asterisk dapnet Scripts folder and that there is a directory called src with 4 scripts in it in the dapnet folder and the sounds are in the sounds folder and the 
 
 ## Modify the extensions_custom.conf
 
 Next, we need to modify the ```extensions_custom.conf``` file. Open that in your editor.
 
-Next copy one of the following stanzas into that file:
-
-If you are using the Single User script use:
-
-```bash
-
-;# // BEGIN DAPNET
-exten => 327638,1,Answer
-exten => 327638,n,Wait(1)
-exten => 327638,n,Set(TIMEOUT(digit)=8)
-exten => 327638,n,Set(TIMEOUT(response)=10)
-exten => 327638,n,Set(VOLUME(TX)=10)
-exten => 327638,n,Playback(/var/lib/asterisk/sounds/custom/dapnet_gateway/dpg_welcome)
-exten => 327638,n,Wait(1)
-exten => 327638,n,Playback(/var/lib/asterisk/sounds/custom/dapnet_gateway/dpg_enter_dmrid)
-exten => 327638,n,Set(VOLUME(TX)=0)
-exten => 327638,n,Read(RIC,beep,8)
-exten => 327638,n,Set(VOLUME(TX)=10)
-exten => 327638,n,Playback(/var/lib/asterisk/sounds/custom/dapnet_gateway/dpg_enter_callback)
-exten => 327638,n,Set(VOLUME(TX)=0)
-exten => 327638,n,Read(CALLBACK,beep,12)
-exten => 327638,n,System(python3 /var/lib/asterisk/scripts/dapnet/dapnet_paging_gateway.py ${RIC} ${CALLBACK})
-exten => 327638,n,Set(VOLUME(TX)=10)
-exten => 327638,n,Playback(/var/lib/asterisk/sounds/custom/dapnet_gateway/dpg_thank_you)
-exten => 327638,n,Wait(1)
-exten => 327638,n,Hangup
-;# // END DAPNET
-
-```
-
-If you are using the Multi User Script, use:
+Next copy the following stanza into that file:
 
 ```bash
 ;# // BEGIN DAPNET
@@ -112,4 +82,4 @@ Now we need to tell FreePBX about this new extension. It will not pick it up aut
 * Click ```Submit```
 * Click ```Apply Changes```
 
-Almost there. Now we can finally run everything.
+That should do it. Now we should be able to [send a page to a user](https://n8acl.github.io/dapnet_paging_gateway/using_the_gateway/).

docs/configure_database.md

@@ -1,76 +1,55 @@
 # Configure the Scripts
 
-Once you have your all the credentials you need, have cloned the repo and installed everything, you can now start configuring the scripts. 
+Once you have your all the credentials you need, have cloned the repo and installed all the libraries, you now need to configuring the scripts. 
 
-## Configure DAPNET.json
+## Configure config.json
 
-First, open the ```dapnet.json``` file in the editor of your choice.
+First, open the ```config.json``` file in the editor of your choice.
 
 In this file you will see the following:
 
 ```json
 {
-    "my_creds": 
-         {
-             "username": "DAPNET USERNAME HERE",
-             "password": "DAPNET PASSWORD HERE",
-             "tx_group": "all"
-         }
- }
+    "dapnet": {
+        "username": "DAPNET USER NAME",
+        "password": "DAPNET PASSWORD",
+        "tx_group": "all"
+    },
+    "database": {
+        "rdbms_type": "DB SERVER TYPE",
+        "credentials": {
+            "username": "DB SERVER USERNAME",
+            "password": "DB SERVER PASSWORD",
+            "host": "FQDN or IP ADDRESS OF DB INSTANCE",
+            "db": "DAPNET"
+        }
+    },
+    "gateway_mode": 1
+}
 ```
 
-Put your DAPNET Username and Passwords into the correct fields and save the file and close it.
-
-## Configure dapnet_callsign_data_load.py
-
-Next, open the ```dapnet_callsign_data_load.py``` file in the editor of your choice. Scroll down till you find a section like so:
-
-```python
-#############################
-##### Define Variables
-
-# define mysql connection variables
-mysql_host = 'MYSQL HOST IP ADDRESS'
-mysql_user = 'MYSQL USERNAME'
-mysql_password = 'MYSQL PASSWORD'
-```
-
-Enter the MySQL IP Address, Username and password as asked in the appropriate places. Do NOT change anything below the line marked:
-
-```python
-#############################
-##### DO NOT CHANGE BELOW
-```
-
-If you do, you will break your script. Remember the Disclaimer on the front page of the Wiki.
-
-## Configure dapnet_paging_gateway_*.py
-
-Next, open one of the paging gateway scripts files in the editor of your choice. 
-
-* If you want to set this up for just yourself, use ```dapnet_paging_gateway_su.py```
-* If you want to set this up for multiple people, use ```dapnet_paging_gateway_mu.py```
-
-Scroll down till you find a section like so:
-
-```python
-#############################
-##### Define Variables
-
-# define mysql connection variables
-mysql_host = 'MYSQL HOST IP ADDRESS'
-mysql_user = 'MYSQL USERNAME'
-mysql_password = 'MYSQL PASSWORD'
-```
-
-Just like with the callsign data loader, enter the MySQL IP Address, Username and password as asked in the appropriate places. Do NOT change anything below the line marked:
-
-```python
-#############################
-##### DO NOT CHANGE BELOW
-```
-
-If you do, you will break your script. Remember the Disclaimer on the front page of the Wiki.
+***Settings Definitions***:
+* ```dapnet``` - This section is your DAPNET Credentials
+    * ```username```: This is your DAPNET Username, usually your callsign.
+    * ```password```: This is your DAPNET Password.
+    * ```tx_group```: This is the DAPNET tx_group to send the messages to. This is usually a regional setting. You will need to look this up on DAPNET to find out where the best place to send the messages is. Try to avoid the ```all``` group to keep from hitting every transmitter connected to DAPNET.
+* ```database``` - This section is your Database Server credentials.
+    * ```rdbms_type```: This is the type of Database Server you are using. 
+        * Supported Types
+            * ```mssql``` - MS SQL Server
+            * ```mysql``` - MySQL/MariaDB
+            * ```postgresql``` - PostgreSQL
+            * ```sqlite``` - SQLite (built in Python DB)
+    * ```credentials```: These are the credentials for your DB Instance
+        * ```username```: Database Username
+        * ```password```: Database Password
+        * ```host```: FQDN or IP address of your Database Instance
+        * ```db```: Always needs to be DAPNET - ***DO NOT CHANGE THIS***. If you change this, it will break things.
+* ```gateway_mode```: This is the mode that the gateway should work in. This defines whether it is in Single-User (personal) or Multi-User (many users like a Cloud PBX) mode.
+    * ```1```: Single-User Mode
+    * ```2```: Multi-User Mode
+
+Make your settings changes and then save the file.
 
 ## Set Callsign Data load for automatic loading
 
@@ -96,4 +75,4 @@ Because this can take a while to run, I would suggest setting up a cron job to r
 
 This will fire my script every day at 2:00 am and do the data load then.
 
-Next we need to configure FreePBX/Asterisk.
+Next we need to [configure the Database](https://n8acl.github.io/dapnet_paging_gateway/configure_database/).

docs/configure_freepbx.md

@@ -16,7 +16,7 @@
     Yeah. This is a tricky question as there really is no straight answer. There are some ways to do this:
 
       * First off, the easiest way is to ask the person you are wanting to send pages to.
-      * If you are a DAPNET Subscriber yourself, you can login to the DAPNET website and do a search for the person. If they come up, they are a subscriber. However, they need to have everything setup and configured for it to go through.
+      * If you are a DAPNET Subscriber yourself, you can login to the DAPNET website and do a search for the person. If they come up, they are a subscriber. However, they need to have everything setup and configured for the message to go through.
 
     Otherwise, there really isn't a straight forward way