diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index 01bef85409e..2981d96c35d 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -160,6 +160,8 @@ Supported abbreviations: 'json_attr': 'json_attributes', 'json_attr_t': 'json_attributes_topic', 'json_attr_tpl': 'json_attributes_template', + 'l_ver_t': 'latest_version_topic', + 'l_ver_tpl': 'latest_version_template', 'max_mirs': 'max_mireds', 'min_mirs': 'min_mireds', 'max_temp': 'max_temp', @@ -194,6 +196,7 @@ Supported abbreviations: 'pl_cls': 'payload_close', 'pl_disarm': 'payload_disarm', 'pl_home': 'payload_home', + 'pl_inst': 'payload_install', 'pl_lock': 'payload_lock', 'pl_loc': 'payload_locate', 'pl_not_avail': 'payload_not_available', @@ -209,7 +212,7 @@ Supported abbreviations: 'pl_stpa': 'payload_start_pause', 'pl_ret': 'payload_return_to_base', 'pl_rst_hum': 'payload_reset_humidity', - 'pl_rst_mode': 'payload_reset_mode', + 'pl_rst_mode': 'payload_reset_mode', 'pl_rst_pct': 'payload_reset_percentage', 'pl_rst_pr_mode': 'payload_reset_preset_mode', 'pl_toff': 'payload_turn_off', diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown new file mode 100644 index 00000000000..f616bd3414c --- /dev/null +++ b/source/_integrations/update.mqtt.markdown @@ -0,0 +1,213 @@ +--- +title: "MQTT Update" +description: "Instructions on how to interact with a device exposing an Update entity through MQTT from within Home Assistant." +ha_category: + - Update +ha_release: "2021.11" +ha_iot_class: Configurable +ha_domain: mqtt +--- + +The `mqtt` Update platform allows you to integrate devices that might expose firmware/software installed and the latest versions through MQTT into Home Assistant as an Update entity. Every time a message under the `topic` in the configuration is received, the entity will be updated in Home Assistant. + +## Configuration + +To enable MQTT Update in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +mqtt: + select: + - state_topic: topic-installed + latest_version_topic: topic-latest +``` + +{% 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 device's availability from the `topic`. To determine the devices's availability result of this 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 +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 device's availability from the `availability_topic`. To determine the devices's availability result of this template will be compared to `payload_available` and `payload_not_available`." + required: false + type: template +command_topic: + description: The MQTT topic to publish `payload_install` to start installing process. + required: false + type: string +device: + description: "Information about the device this Update is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set. At least one of 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 or HTTPS link.' + 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: [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 + 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 +device_class: + description: The [type/class](/integrations/update/#device-classes) of the update to set the icon in the frontend. + required: false + type: device_class + default: None +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 payloads received and published messages. Set to `""` to disable decoding of incoming payload. + 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 + default: None +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`." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as entity attributes. Implies `force_update` of the current select state when a message is received on this topic. + required: false + type: string +latest_version_template: + description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the latest version value." + required: false + type: template +latest_version_topic: + description: The MQTT topic subscribed to receive an update of the latest version. + required: true + type: string +name: + description: The name of the Select. + required: false + type: string +object_id: + description: Used instead of `name` for automatic generation of `entity_id` + required: false + type: string +payload_install: + description: The MQTT payload to start installing process. + required: false + type: string +qos: + description: The maximum QoS level of the state topic. Default is 0 and will also be used to 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 +state_topic: + description: The MQTT topic subscribed to receive an update of the installed version. + required: true + type: string +unique_id: + description: An ID that uniquely identifies this Select. If two Selects have the same unique ID Home Assistant will raise an exception. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the installed version value." + required: false + type: template +{% endconfiguration %} + +