Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/n8acl/aprsnotify

APRS Notification bot for various Social Media Networks
https://github.com/n8acl/aprsnotify

aprs aprs-packet bot discord discord-bot hamradio hamradio-application mastodon mattermost notification packet-data pushover python3 slack telegram telegram-bot twitter weather

Last synced: about 1 month ago
JSON representation

APRS Notification bot for various Social Media Networks

Awesome Lists containing this project

README 

        
# APRSNotify



###### Current Release 02032023



## Notice 10/28/2024 - Currently working on APRSNotify2. This work is a complete rrework of how the script works. Lots of new features coming. Make sure to check out the Project Board for this Project. If there is a messaging service you want me to look at adding support for, open an issue and I can look at adding it, if it is possible. Should be out soon.



APRSNotify is a python based bot script designed to send parsed APRS packet data to various Social Media or Communications networks.



This software is for use by Amateur Radio Operators only.



This bot was designed to be used by one person with multiple APRS Trackers to track packets for that one person. There is the ability to send to club chat servers, but again, each person will need to run their own copy of the script. However, a club hosted version is in the works.



Please see [the Wiki](https://n8acl.github.io/aprsnotify) for more information and installation and configuration steps as well as running the script.



##### Working Examples:

- Mastodon: [You will need to follow [email protected].](https://botsin.space/@n8acl_aprs)



#### Important Note

Due to the announcement that Twitter will be Discontinuing the free developer API on February 9, 2023, as of February 3, 2023 APRSNotify no longer supports Twitter. You will need to update to the current release if you are running APRSNotify to remove the Twitter support if you want to continue using it.



##### Currently Supported Networks/Functions



| Function | Supported Services|

|----------|------------------|

|Position Packet Data
Weather Packet Data| Telegram, Mastodon, Discord, Mattermost, Slack|

|Message Notification| Telegram, Discord, Pushover, Mattermost, Slack|

|Send Packet Data
to Club Server| Telegram, Discord, Mattermost, Slack|



---



## Features

- Pulls most recent packet data from [APRS.fi API](https://aprs.fi/page/api) for the following types of packets:

  - Position Data

  - Weather Station Data

- Reverse Geocode with OpenStreetMaps API.

- Get Weather Conditions from OpenWeatherMaps API for the location of the position packet

- Find Maidenhead Grid Square of packet location.

- Send Status to Social Media Networks (See above for supported Networks)

- Get notification of an APRS message sent to your station (see above for supported Networks). If someone sends a message via APRS to one of the callsigns being tracked, the script will notify you and share the message with you.

- Send packet data to a club Server channel. This allows club members to share packet data information with each other.



---



### Use Cases

* Sending an APRS Position packet to Social Media for your followers to see.

* Sending Weather data from APRS to Social Media.

* Sending APRS data to yourself to confirm that it is making it to the internet.

* Sending your position information to a Telegram/Discord/Mattermost/Slack Channel that you have your non-ham radio family and friends on so they can track you when you are traveling by car for a long distance.

* Participating in sending packet data to a club server/channel in addition to your own channels/servers

* Other uses that your imagination comes up with.



---



## UPGRADE TO RELEASE 02032023



#### Normal Upgrade



To upgrade to the current version of the script, enter the folder where you have the APRSNotify scrpts and do a ```git pull -ff``` to get the newest updated scripts. Then please run the update.py ```python3 update.py``` script. It will update your database to the most current version.



If you are installing the whole script for the first time (i.e. have never used APRSNotify before), please run an_util.py instead. Only run the upgrade script if you have used APRSNotify before and have previously upgraded to version 4.



#### Upgrading a version older than Version 4 to current version



Please note that any version prior to 4 has had to be depreciated and is no longer supported. With all the changes, it is difficult to support those older versions with the new version.



The easiest way to upgrade a version of APRSNotify that is older than Version 4 is to make sure to backup the config.py file to another location and then deleting the old APRSnotify script folder. Then clone the repo to get the latest script files. This allows you to setup the script as basically a brand new setup, just follow the directions in the wiki for a new setup and using the an_util.py file. You can use your old config.py file as reference to copy and paste your keys and things in as needed.



---



## Credits

The Original Telegram Notify bot functionality was based off a gist by Github user Lucaspg96. [Click Here](https://gist.github.com/lucaspg96/284c9dbe01d05d0563fde8fbb00db220).



Adding Grid Square to Status message was suggested by Alex, N7AGF.



The Grid Square Function was developed by Walter Underwood, K6WRU and posted on ham.stackexchange.com. [Click Here](https://ham.stackexchange.com/questions/221/how-can-one-convert-from-lat-long-to-grid-square)



The map image functionality for the Telegram Bot and suggestions to include or not include Weather data among other suggestions were contributed by Chanyeol Yoo, Ph.D., VK2FAED



APRS.FI API Limitations issues found and troubleshot by [Alex Bowman, KN4KNG](https://github.com/KN4KNG). 



Installation of the Verison 4 scripts troubleshot by Diego, EA3ICN.



Pushover Notification API mechanics from [Micheal Clemens, DL6MHC](https://qrz.is/)



APRS and the APRS System and associated copyright were developed by Bob Bruninga, WB4APR (SK) [http://www.aprs.org](http://www.aprs.org).



---



## Contact

If you have questions, please feel free to reach out to me. You can reach me in one of the following ways:



- Discord: Ravendos

- Mastodon: @[email protected]

- E-mail: [email protected]



Or open an issue on Github. I will respond to it, and of course you, when I can. Remember, this is a hobby and there are other daily distractors that come first, like work, school and family.



If you reach out to me and have an error, please include what error you are getting and what you were doing. I may also ask you to send me certain files to look at. Otherwise just reach out to me :).



---



## Change Log 

Changes Prior to current year have been moved to the [ChangeLog](https://n8acl.github.io/aprsnotify/changelog/) on the wiki.



* 02/03/2023

  * Removed support for Twitter from the script. 

  * Updated the Wiki to reflect current changes to the script.



* 01/24/2023 - Minor Update

  * Put the flask package back in the requirements.txt file. Accidently deleted it and did not realize it. (Thanks to [Russ, KV4S](https://github.com/Russell-KV4S) for catching this one.)