From 1a34109b814de5939a4c7f3abe7737d876f47e87 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Wed, 17 Apr 2024 20:07:37 +0200 Subject: [PATCH] Add mqtt notify entity (#32327) * Add mqtt notify entity * tiny tweaks * Apply suggestions from code review * fix typo --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/mqtt.markdown | 3 + source/_integrations/notify.mqtt.markdown | 202 ++++++++++++++++++++++ 2 files changed, 205 insertions(+) create mode 100644 source/_integrations/notify.mqtt.markdown diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown index 9288d8e15a6..9a183cb4630 100644 --- a/source/_integrations/mqtt.markdown +++ b/source/_integrations/mqtt.markdown @@ -28,6 +28,7 @@ ha_platforms: - lawn_mower - light - lock + - notify - number - scene - select @@ -66,6 +67,7 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things - [Lawn mower](/integrations/lawn_mower.mqtt/) - [Light](/integrations/light.mqtt/) - [Lock](/integrations/lock.mqtt/) +- [Notify](/integrations/notify.mqtt/) - [Number](/integrations/number.mqtt/) - [Scene](/integrations/scene.mqtt/) - [Select](/integrations/select.mqtt/) @@ -98,6 +100,7 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things - [Lawn mower](/integrations/lawn_mower.mqtt/) - [Light](/integrations/light.mqtt/) - [Lock](/integrations/lock.mqtt/) +- [Notify](/integrations/notify.mqtt/) - [Number](/integrations/number.mqtt/) - [Scene](/integrations/scene.mqtt/) - [Select](/integrations/select.mqtt/) diff --git a/source/_integrations/notify.mqtt.markdown b/source/_integrations/notify.mqtt.markdown new file mode 100644 index 00000000000..1e6be2f85d0 --- /dev/null +++ b/source/_integrations/notify.mqtt.markdown @@ -0,0 +1,202 @@ +--- +title: "MQTT notify" +description: "Instructions on how to integrate MQTT notify entities into Home Assistant." +ha_category: + - Notifications +ha_release: 2024.5.0 +ha_iot_class: Configurable +ha_domain: mqtt +--- + +The **MQTT notify** platform lets you send an MQTT message when the `send_message` service is called. This can be used to expose a service of a remote device that allows processing a message, such as showing it on a screen. + +## Configuration + +```yaml +# Example configuration.yaml entry +mqtt: + - notify: + command_topic: "home/living_room/status_screen/notifications" +``` + +{% configuration %} +availability: + description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`. + required: false + type: list + keys: + payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online + payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline + topic: + description: An MQTT topic subscribed to receive availability (online/offline) updates. + required: true + type: string + value_template: + description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the device's availability from the `topic`. To determine the device's availability, the result of this template will be compared to `payload_available` and `payload_not_available`." + required: false + type: template +availability_mode: + description: When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid entries are `all`, `any`, and `latest`. If set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online. If set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online. If set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability. + required: false + type: string + default: latest +availability_template: + description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the device's availability from the `availability_topic`. To determine the device's availability result, the template will be compared to `payload_available` and `payload_not_available`." + required: false + type: template +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`. + required: false + type: string +command_template: + description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`. + required: false + type: template +command_topic: + description: The MQTT topic to publish send message commands at. + required: false + type: string +device: + description: "Information about the device this notify entity is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works when [`unique_id`](#unique_id) is set. At least one of the identifiers or connections must be present to identify the device." + required: false + type: map + keys: + configuration_url: + description: 'A link to the webpage that can manage the configuration of this device. Can be either an `http://`, `https://` or an internal `homeassistant://` URL.' + required: false + type: string + connections: + description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example, the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' + required: false + type: list + hw_version: + description: The hardware version of the device. + required: false + type: string + identifiers: + description: A list of IDs that uniquely identify the device. For example, a serial number. + required: false + type: [string, list] + manufacturer: + description: The manufacturer of the device. + required: false + type: string + model: + description: The model of the device. + required: false + type: string + name: + description: The name of the device. + required: false + type: string + serial_number: + description: "The serial number of the device." + required: false + type: string + suggested_area: + description: 'Suggest an area if the device isn’t in one yet.' + required: false + type: string + sw_version: + description: The firmware version of the device. + required: false + type: string + via_device: + description: 'Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.' + required: false + type: string +enabled_by_default: + description: Flag which defines if the entity should be enabled when first added. + required: false + type: boolean + default: true +encoding: + description: The encoding of the published messages. + required: false + type: string + default: "utf-8" +entity_category: + description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. + required: false + type: string +icon: + description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." + required: false + type: icon +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name to use when displaying this notify entity. Can be set to `null` if only the device name is relevant. + required: false + type: string + default: MQTT notify +object_id: + description: Used instead of `name` for automatic generation of `entity_id` + required: false + type: string +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +qos: + description: The maximum QoS level to be used when receiving and publishing messages. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: false +unique_id: + description: An ID that uniquely identifies this notify entity. If two notify entities have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +{% endconfiguration %} + +
+ +Make sure that your topic matches exactly. `some-topic/` and `some-topic` are different topics. + +
+ +## Examples + +In this section, you will find some real-life examples of how to use this feature. + +### Full configuration + +The example below shows a full configuration for a notify entity. + +```yaml +# Example configuration.yaml entry +mqtt: + - notify: + unique_id: living_room_stat_scr01 + name: "Living room status screen" + command_topic: "home/living_room/status_screen/notifications" + availability: + - topic: "home/living_room/status_screen/available" + qos: 0 + retain: false +```