jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 19:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add initial support for MQTT subentries with notify platform support (#37473)

Browse Source 
* Add initial support for MQTT subentries for notify platform

* Apply changes from code review

* tiny tweak

* Update source/_integrations/mqtt.markdown

* Move removing instructions to the end of the document

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Jan Bouwhuis 2025-03-14 14:04:15 +01:00 committed by GitHub
parent 4dd96b3396
commit a4afb5b6ca
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
source/_integrations/mqtt.markdown
View File

@ -51,19 +51,7 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
{% include integrations/config_flow.md %}
### Removing the MQTT integration
The MQTT integration and its entities can be removed by following these steps:
1. Navigate to **Settings** > **Devices & Services**
2. Find the MQTT integration and click on it
3. Click the delete button to remove the MQTT config entry
Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its data. If you want to completely remove MQTT:
1. Check your `configuration.yaml` and other YAML files for MQTT-related configurations and remove them
2. Review your automations and scripts for any MQTT dependencies
3. Consider backing up your configuration before making these changes
MQTT Devices and entities can be set up through [MQTT -discovery](#mqtt-discovery) or [added manually](#manual-configured-mqtt-items) via YAML or subentries.
<a name="configuration-via-mqtt-discovery"></a>
{% details "Configuration of MQTT components via MQTT discovery" %}
@ -131,6 +119,21 @@ Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its
{% enddetails %}
<a name="configuration-via-subentries"></a>
{% details "Configuration of MQTT components via Subentries" %}
- [Notify](/integrations/notify.mqtt/)
To add an MQTT device via a Subentry, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & services" %}**.
2. Select the MQTT integration.
3. Add a subentry via {% my integrations title="**Settings** > **Devices & services**" %}, click {% icon "mdi:dots-vertical" %} and select **Add MQTT device**.
A device context and one or more entities can be added to the subentry.
{% enddetails %}
Your first step to get MQTT and Home Assistant working is to choose a broker.
The easiest option is to install the official Mosquitto Broker add-on. You can choose to set up and configure this add-on automatically when you set up the MQTT integration. Home Assistant will automatically generate and assign a safe username and password, and no further attention is required. This also works if you have already set up this add-on yourself in advance.
@ -163,6 +166,8 @@ Add the MQTT integration, then provide your broker's hostname (or IP address) an
2. Select the MQTT integration.
3. Reconfigure the MQTT broker settings via {% my integrations title="**Settings** > **Devices & services**" %}, click {% icon "mdi:dots-vertical" %} and select **Reconfigure**.
MQTT subentries can also be reconfigured. Additional entities can be added, or an entity can bve removed from the sub entry. Each MQTT subentry holds one MQTT device. The MQTT device must have at least one entity.
{% important %}
If you experience an error message like `Failed to connect due to exception: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed`, then turn on `Advanced options` and set [Broker certificate validation](/integrations/mqtt/#broker-certificate-validation) to `Auto`.
{% endimportant %}
@ -1371,6 +1376,8 @@ Compatibility and features will vary, and not all devices may work.
## Manual configured MQTT items
Support to add manual items is added for the MQTT Notify entities, other platforms will follow later.
For most integrations, it is also possible to manually set up MQTT items in {% term "`configuration.yaml`" %}. Read more [about configuration in YAML](/docs/configuration/yaml).
MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt.
@ -1578,3 +1585,13 @@ logger:
Event `event_mqtt_reloaded` is fired when Manually configured MQTT entities have been reloaded and entities thus might have changed.
This event has no additional data.
## Removing the integration
{% include integrations/remove_device_service_steps.md %}
Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its data. If you want to completely remove MQTT:
1. Check your {% term "`configuration.yaml`" %} and other YAML files for MQTT-related configurations and remove them
2. Review your automations and scripts for any MQTT dependencies
3. Consider backing up your configuration before making these changes