vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 01:26:11 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

HA Docs

Browse Source
This commit is contained in:
Jokob-sk
2023-06-24 09:36:52 +10:00
parent 6f1d795c60
commit 170772eb7c
2 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -31,8 +31,8 @@ The system continuously scans the network for, **New devices**, **New connection
## 🧩 Integrations ## 🧩 Integrations
- [Apprise](https://hub.docker.com/r/caronc/apprise), [Pushsafer](https://www.pushsafer.com/), [NTFY](https://ntfy.sh/) - [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)) - [Webhooks](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/WEBHOOK_N8N.md)
- 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 - [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) - [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 - [Plugin system](https://github.com/jokob-sk/Pi.Alert/tree/main/front/plugins) for custom script monitoring

27
docs/HOME_ASSISTANT.md
View File

@@ -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. 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 ## 🧭 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. 2. Configure a user name and password on your broker.
3. Note down the following details that you will need to configure PiAlert: 3. Note down the following details that you will need to configure PiAlert:
- MQTT host url (usually your Home Assistant IP) - MQTT host url (usually your Home Assistant IP)
- MQTT broker port - MQTT broker port
- User - User
- Password - Password
4. Ope the `PiAlert` > `Settings` > `MQTT` settings group 4. Ope the `PiAlert` > `Settings` > `MQTT` settings group
- Enable MQTT - Enable MQTT
- Fill in the details from above - Fill in the details from above
- Fill in remaining settings as per description - Fill in remaining settings as per description
## 📷 Screenshots ## 📷 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] | | ![Screen 3][list] | ![Screen 4][overview] |
[sensors]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png "sensors" [sensors]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-as-Sensors.png "sensors"
[history]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History "history" [history]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Device-Presence-History.png "history"
[list]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png "list" [list]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Devices-List.png "list"
[overview]: ./docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png "overview" [overview]: /docs/img/HOME_ASISSTANT/PiAlert-HomeAssistant-Overview-Card.png "overview"