forked from home-assistant/home-assistant.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Mqtt device trigger (home-assistant#12200)
- Loading branch information
1 parent
c973e65
commit 55e9890
Showing
3 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
--- | ||
title: "MQTT Device Trigger" | ||
description: "Instructions on how to integrate MQTT device triggers within Home Assistant." | ||
logo: mqtt.png | ||
ha_category: | ||
- Device Automation | ||
ha_release: 0.106 | ||
ha_iot_class: Configurable | ||
--- | ||
|
||
The `mqtt` device trigger platform uses an MQTT message payload to generate device trigger events. | ||
|
||
An MQTT device trigger is a better option than a [binary sensor](/integrations/binary_sensor.mqtt/) for buttons, remote controls etc. | ||
|
||
## Configuration | ||
|
||
MQTT device triggers are only supported through [MQTT discovery](/docs/mqtt/discovery/), manual setup through `configuration.yaml` is not supported. | ||
The discovery topic needs to be: `<discovery_prefix>/device_automation/[<node_id>/]<object_id>/config`. | ||
|
||
{% configuration %} | ||
automation_type: | ||
description: The type of automation, must be 'device_trigger'. | ||
required: true | ||
type: string | ||
payload: | ||
description: Optional payload to match the payload being sent over the topic. | ||
required: false | ||
type: string | ||
qos: | ||
description: The maximum QoS level to be used when receiving messages. | ||
required: false | ||
type: integer | ||
default: 0 | ||
topic: | ||
description: The MQTT topic subscribed to receive trigger events. | ||
required: true | ||
type: string | ||
type: | ||
description: "The type of the trigger, e.g. `button_short_press`. Entries supported by the frontend: `button_short_press`, `button_short_release`, `button_long_press`, `button_long_release`, `button_double_press`, `button_triple_press`, `button_quadruple_press`, `button_quintuple_press`. If set to an unsupported value, will render as `subtype type`, e.g. `First button spammed` with `type` set to `spammed` and `subtype` set to `button_1`" | ||
required: true | ||
type: string | ||
subtype: | ||
description: "The subtype of the trigger, e.g. `button_1`. Entries supported by the frontend: `turn_on`, `turn_off`, `button_1`, `button_2`, `button_3`, `button_4`, `button_5`, `button_6`. If set to an unsupported value, will render as `subtype type`, e.g. `left_button pressed` with `type` set to `button_short_press` and `subtype` set to `left_button`" | ||
required: true | ||
type: string | ||
device: | ||
description: "Information about the device this device trigger is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html)." | ||
required: true | ||
type: map | ||
keys: | ||
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, map] | ||
identifiers: | ||
description: A list of IDs that uniquely identify the device. For example a serial number. | ||
required: false | ||
type: [list, string] | ||
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 | ||
sw_version: | ||
description: The firmware version of the device. | ||
required: false | ||
type: string | ||
{% endconfiguration %} |