Auto discovery deactivation at runtime by MQTT command (#856)
and switch automatic creation for it in HASS (by autodiscovery :-)
This commit is contained in:
1 parent
e8b4c63c6c
commit
2d377a1c3f
9 files changed
+94
-26
No files matched your search
@@ -1,6 +1,6 @@
|
||||
# Integrate Home Assistant
|
||||
## Auto discovery
|
||||
So as to enable HASS auto discovery with MQTT you have to uncomment [ZmqttDiscovery](https://github.com/1technophile/OpenMQTTGateway/blob/0180a0dbd55ed8e0799e30ee84f68070a6f478fa/User_config.h#L99) in User_config.h. Note that Home Assistant discovery is enabled by default on all binaries and platformio configurations except for UNO.
|
||||
Home Assistant discovery is enabled by default on all binaries and platformio configurations except for UNO. With Arduino IDE please read the [advanced configuration section](../upload/advanced-configuration#auto-discovery) of the documentation.
|
||||
|
||||
Once done, enable discovery on your MQTT integration definition in HASS.
|
||||
|
||||
@@ -14,7 +14,9 @@ The max size of the username is 30 and 60 for the password.
|
||||
|
||||
OMG will use the auto discovery functionality of home assistant to create sensors and gateways into your HASS instance automaticaly.
|
||||
|
||||
::: tip
|
||||
The gateway device will be available into Configuration->Devices section of Home Assistant.
|
||||
:::
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -52,3 +52,30 @@ home/OpenMQTTGateway/SRFBtoMQTT/59365 {"raw":"2B660186042E00E7E5","value":"59365
|
||||
```
|
||||
|
||||
It can be usefull to avoid warning or errors on certain controllers.
|
||||
|
||||
## Auto discovery
|
||||
Home Assistant discovery is enabled by default on all binaries and platformio configurations except for UNO. With Arduino IDE you have to uncomment [ZmqttDiscovery](https://github.com/1technophile/OpenMQTTGateway/blob/0180a0dbd55ed8e0799e30ee84f68070a6f478fa/User_config.h#L99) in User_config.h.
|
||||
|
||||
To have a working discovery setup you need to enable it on your MQTT integration definition in HASS.
|
||||
|
||||
::: tip
|
||||
With platformio you can deactivate discovery by adding:
|
||||
``` ini
|
||||
'-UZmqttDiscovery="HADiscovery"'
|
||||
```
|
||||
To your environment definition.
|
||||
:::
|
||||
|
||||
So as to create the MQTT username and password, you have to create a new user(recommended) into Home Assistant->Configuration->Users (available in admin mode) or use an existing username/pwd combination (not recommended). This user doesn't need to be an administrator.
|
||||
|
||||

|
||||
|
||||
::: warning
|
||||
The max size of the username is 30 and 60 for the password.
|
||||
:::
|
||||
|
||||
OMG will use the auto discovery functionality of home assistant to create sensors and gateways into your HASS instance automaticaly.
|
||||
|
||||
The gateway device will be available into Configuration->Devices section of Home Assistant.
|
||||
|
||||

|
||||
@@ -15,6 +15,20 @@ With Home Assistant, this command is directly avalaible through MQTT auto discov
|
||||
With Home Assistant, this command is directly avalaible through MQTT auto discovery as a switch into the HASS OpenMQTTGateway device entities list.
|
||||
:::
|
||||
|
||||
## Auto discovery
|
||||
You can deactivate the MQTT auto discovery function, this function enable to create automaticaly devices/entities with Home Assistant convention.
|
||||
### Deactivate
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"discovery":false}'`
|
||||
|
||||
### Activate
|
||||
`mosquitto_pub -t "home/OpenMQTTGateway/commands/MQTTtoSYS/config" -m '{"discovery":true}'`
|
||||
|
||||
If you want the settings to be kept upon gateway restart, you can publish the command with the retain flag.
|
||||
|
||||
::: tip
|
||||
Auto discovery is enable by default on release binaries, on platformio (except for UNO). With Arduino IDE please read the [advanced configuration section](../upload/advanced-configuration#auto-discovery) of the documentation.
|
||||
:::
|
||||
|
||||
# State LED usage
|
||||
|
||||
The gateway can support up to 3 LED to display its operating state:
|
||||
|
||||
Reference in new issue
Block a user