mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-07 09:36:05 -08:00
46 lines
2.0 KiB
Markdown
Executable File
46 lines
2.0 KiB
Markdown
Executable File
# Overview
|
|
|
|
NetAlertX 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.
|
|
- For optimization reasons, the devices are not always fully synchronized. You can delete Plugin objects as described in the [MQTT plugin](https://github.com/jokob-sk/NetAlertX/tree/main/front/plugins/_publisher_mqtt#forcing-an-update) docs to force a full synchronization.
|
|
|
|
|
|
## 🧭 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 NetAlertX:
|
|
- MQTT host url (usually your Home Assistant IP)
|
|
- MQTT broker port
|
|
- User
|
|
- Password
|
|
|
|
4. Open the _NetAlertX_ > _Settings_ > _MQTT_ settings group
|
|
- Enable MQTT
|
|
- Fill in the details from above
|
|
- Fill in remaining settings as per description
|
|
|
|
![Configuration Example][configuration]
|
|
|
|
## 📷 Screenshots
|
|
|
|
| ![Screen 1][sensors] | ![Screen 2][history] |
|
|
|----------------------|----------------------|
|
|
| ![Screen 3][list] | ![Screen 4][overview] |
|
|
|
|
|
|
[configuration]: /docs/img/HOME_ASISSTANT/HomeAssistant-Configuration.png "configuration"
|
|
[sensors]: /docs/img/HOME_ASISSTANT/HomeAssistant-Device-as-Sensors.png "sensors"
|
|
[history]: /docs/img/HOME_ASISSTANT/HomeAssistant-Device-Presence-History.png "history"
|
|
[list]: /docs/img/HOME_ASISSTANT/HomeAssistant-Devices-List.png "list"
|
|
[overview]: /docs/img/HOME_ASISSTANT/HomeAssistant-Overview-Card.png "overview"
|
|
|