mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
38 lines
1.3 KiB
Markdown
Executable File
38 lines
1.3 KiB
Markdown
Executable File
# Overview
|
|
|
|
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.
|
|
|
|
|
|
## 🧭 Guide
|
|
|
|
> 💡 This guide was tested only with the Mosquitto MQTT broker
|
|
|
|
1. Enable Mosquitto MQTT in Home Assistant by following the [documentation](https://www.home-assistant.io/integrations/mqtt/)
|
|
|
|
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
|
|
|
|
4. Ope the `PiAlert` > `Settings` > `MQTT` settings group
|
|
- Enable MQTT
|
|
- Fill in the details from above
|
|
- Fill in remaining settings as per description
|
|
|
|
|
|
## 📷 Screenshots
|
|
|
|
| ![Screen 1][sensors] | ![Screen 2][history] |
|
|
|----------------------|----------------------|
|
|
| ![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"
|
|
|