From b4713b269488bc35740d305da7c466588deef98b Mon Sep 17 00:00:00 2001 From: Hemna Date: Sat, 17 Jul 2021 15:15:52 -0400 Subject: [PATCH] Updated docs for 2.0.0 --- ChangeLog | 24 ++++++++++++++++++++++++ docs/apidoc/aprsd.plugins.rst | 8 ++++++++ docs/apidoc/aprsd.rst | 16 ++++++++++++++++ docs/changelog.rst | 24 ++++++++++++++++++++++++ docs/readme.rst | 17 +++++++++++++++-- 5 files changed, 87 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6bdaceb..a4673d7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,30 @@ CHANGES ======= +v2.0.0 +------ + +* Reworked the notification threads and admin ui +* Fixed small bug with packets get\_packet\_type +* Updated overview images +* Move version string output to top of log +* Add new watchlist feature +* Fixed the Ack thread not resending acks +* reworked the admin ui to use semenatic ui more +* Added messages count to admin messages list +* Add admin UI tabs for charts, messages, config +* Removed a noisy debug log +* Dump out the config during startup +* Added message counts for each plugin +* Bump urllib3 from 1.26.4 to 1.26.5 +* Added aprsd version checking +* Updated INSTALL.txt +* Update my callsign +* Update README.rst +* Update README.rst +* Bump urllib3 from 1.26.3 to 1.26.4 +* Prep for v1.6.1 release + v1.6.1 ------ diff --git a/docs/apidoc/aprsd.plugins.rst b/docs/apidoc/aprsd.plugins.rst index a8126fd..5b7ace6 100644 --- a/docs/apidoc/aprsd.plugins.rst +++ b/docs/apidoc/aprsd.plugins.rst @@ -28,6 +28,14 @@ aprsd.plugins.location module :undoc-members: :show-inheritance: +aprsd.plugins.notify module +--------------------------- + +.. automodule:: aprsd.plugins.notify + :members: + :undoc-members: + :show-inheritance: + aprsd.plugins.ping module ------------------------- diff --git a/docs/apidoc/aprsd.rst b/docs/apidoc/aprsd.rst index e95eae2..8013d43 100644 --- a/docs/apidoc/aprsd.rst +++ b/docs/apidoc/aprsd.rst @@ -68,6 +68,14 @@ aprsd.healthcheck module :undoc-members: :show-inheritance: +aprsd.listen module +------------------- + +.. automodule:: aprsd.listen + :members: + :undoc-members: + :show-inheritance: + aprsd.main module ----------------- @@ -84,6 +92,14 @@ aprsd.messaging module :undoc-members: :show-inheritance: +aprsd.packets module +-------------------- + +.. automodule:: aprsd.packets + :members: + :undoc-members: + :show-inheritance: + aprsd.plugin module ------------------- diff --git a/docs/changelog.rst b/docs/changelog.rst index 6bdaceb..a4673d7 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,6 +1,30 @@ CHANGES ======= +v2.0.0 +------ + +* Reworked the notification threads and admin ui +* Fixed small bug with packets get\_packet\_type +* Updated overview images +* Move version string output to top of log +* Add new watchlist feature +* Fixed the Ack thread not resending acks +* reworked the admin ui to use semenatic ui more +* Added messages count to admin messages list +* Add admin UI tabs for charts, messages, config +* Removed a noisy debug log +* Dump out the config during startup +* Added message counts for each plugin +* Bump urllib3 from 1.26.4 to 1.26.5 +* Added aprsd version checking +* Updated INSTALL.txt +* Update my callsign +* Update README.rst +* Update README.rst +* Bump urllib3 from 1.26.3 to 1.26.4 +* Prep for v1.6.1 release + v1.6.1 ------ diff --git a/docs/readme.rst b/docs/readme.rst index e0a8c46..d14091d 100644 --- a/docs/readme.rst +++ b/docs/readme.rst @@ -54,7 +54,9 @@ the weather. an APRS message is sent, and then picked up by APRSD. The APRS packet is decoded, and the message is sent through the list of plugins for processing. For example, the WeatherPlugin picks up the message, fetches the weather for the area around the user who sent the request, and then responds with -the weather conditions in that area. +the weather conditions in that area. Also includes a watch list of HAM +callsigns to look out for. The watch list can notify you when a HAM callsign +in the list is seen and now available to message on the APRS network. APRSD Capabilities @@ -82,6 +84,18 @@ If it matches, the plugin runs. IF the regex doesn't match, the plugin is skipp * VersionPlugin - Reports the version information for aprsd +List of core notification plugins +================================= + +These plugins see all APRS messages from ham callsigns in the config's watch +list. + +* NotifySeenPlugin - Send a message when a message is seen from a callsign in + the watch list. This is helpful when you want to know + when a friend is online in the ARPS network, but haven't + been seen in a while. + + Current messages this will respond to: ====================================== @@ -201,7 +215,6 @@ Output - aprsd.plugins.version.VersionPlugin logfile: /tmp/aprsd.log logformat: '[%(asctime)s] [%(threadName)-12s] [%(levelname)-5.5s] %(message)s - [%(pathname)s:%(lineno)d]' - plugin_dir: ~/.config/aprsd/plugins trace: false units: imperial web: