From 170772eb7c5c59642b015319109370129a742a9f Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 24 Jun 2023 09:36:52 +1000 Subject: [PATCH] HA Docs --- README.md | 4 ++-- docs/HOME_ASSISTANT.md | 27 ++++++++++++++++----------- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e7db1602..0615356f 100755 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ The system continuously scans the network for, **New devices**, **New connection ## 🧩 Integrations - [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/) - - [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md) ([sample JSON](docs/webhook_json_sample.json)) - - Home Assistant via [MQTT](https://www.home-assistant.io/integrations/mqtt/) - discovery ~10s per device, use [MQTT Explorer](https://mqtt-explorer.com/) to delete devices + - [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md) + - [Home Assistant](https://github.com/jokob-sk/Pi.Alert/edit/main/docs/HOME_ASSISTANT.md) - [API endpoint](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/API.md) - [Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins) for custom script monitoring diff --git a/docs/HOME_ASSISTANT.md b/docs/HOME_ASSISTANT.md index bf7882a5..4c81d09e 100755 --- a/docs/HOME_ASSISTANT.md +++ b/docs/HOME_ASSISTANT.md @@ -2,6 +2,11 @@ PiAlert comes with MQTT support, allowing you to show all detected devices as devices in Home Assistant. It also supplies a collection of stats, such as number of online devices. +## ⚠ Note + +- Please note that discovery takes about ~10s per device. +- Deleting of devices is not handled automatically. Please use [MQTT Explorer](https://mqtt-explorer.com/) to delete devices in the broker (Home Assistant), if needed. + ## 🧭 Guide @@ -12,15 +17,15 @@ PiAlert comes with MQTT support, allowing you to show all detected devices as de 2. Configure a user name and password on your broker. 3. Note down the following details that you will need to configure PiAlert: - - MQTT host url (usually your Home Assistant IP) - - MQTT broker port - - User - - Password + - MQTT host url (usually your Home Assistant IP) + - MQTT broker port + - User + - Password 4. Ope the `PiAlert` > `Settings` > `MQTT` settings group - - Enable MQTT - - Fill in the details from above - - Fill in remaining settings as per description + - Enable MQTT + - Fill in the details from above + - Fill in remaining settings as per description ## 📷 Screenshots @@ -30,8 +35,8 @@ PiAlert comes with MQTT support, allowing you to show all detected devices as de | ![Screen 3][list] | ![Screen 4][overview] | - [sensors]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png "sensors" - [history]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History "history" - [list]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png "list" - [overview]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png "overview" + [sensors]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png "sensors" + [history]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History.png "history" + [list]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png "list" + [overview]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png "overview"