From c189a53daa06dc8d0c1ced0cb2697ffb5e4c8c61 Mon Sep 17 00:00:00 2001 From: Trevor Blanarik Date: Mon, 23 Sep 2024 06:06:18 +0000 Subject: [PATCH] docs update --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a63e84e..8deca0c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Description -Spotbot is a simple Azure Function App to convert [HamAlert](https://hamalert.org/) alerts from [POTA](https://pota.app) or [SOTA](https://www.sota.org.uk/) in to a message format that can be forwarded on to a Discord channel webhook. +Spotbot is an Azure Function App to convert [HamAlert](https://hamalert.org/) alerts from [POTA](https://pota.app) or [SOTA](https://www.sota.org.uk/) in to a message format that can be forwarded on to a Discord channel webhook. | HamAlert Configuration | | -- | @@ -13,12 +13,21 @@ Spotbot is a simple Azure Function App to convert [HamAlert](https://hamalert.or | ![image](https://github.com/user-attachments/assets/f664d60f-2042-4b2d-9c88-4ce4051f17c7) | -## Requirements +The function uses a Table in an Azure Storage Account to store the `messageId` of the last message posted for each callsign. If that message was posted recently (as defined by `LOOKBACK_SECONDS`), it will _update_ the message instead of posting a new one to reduce the chatter of the bot. -- Python 3.x -- Azure Functions -- requests +You can find a live, working version of this bot in the [Cascadia Radio](https://www.cascadiaradio.org/) Discord server, in the `#spots` channel. Join us! ## Config -The Azure Function App expects one environment variable: `TARGET_URL`, which should be the webhook URL from the target Discord channel. +The Azure Function App expects three environment variables: +- `TARGET_URL` - the webhook URL from the target Discord channel. +- `LOOKBACK_SECONDS` - the number of seconds to look backwards for previous messages to update instead of posting a new one +- `TABLE_NAME` - the name of the table in the Azure Storage Account where the last messageIds will be stored for each callsign + +## Deploy Notes + +- Some basic tests run in `tests.py` on the creation of a new PR +- To deploy, manually run `main_hamalertspotbot.yml` + - This will deploy to the staging slot for testing. + - The staging `TARGET_URL` points to my private Discord server + - `LOOKBACK_SECONDS` is set to only 300 (instead of 7200) for easier testing. \ No newline at end of file