mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Add documentation for MQTT image platform component (#27887)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Jan Bouwhuis
GitHub
parent
f13610bda5
commit
01ea91578f
171
source/_integrations/image.mqtt.markdown
Normal file
171
source/_integrations/image.mqtt.markdown
Normal file
@ -0,0 +1,171 @@
|
||||
---
|
||||
title: "MQTT Image"
|
||||
description: "Instructions on how to use an MQTT image message as an Image within Home Assistant."
|
||||
ha_category:
|
||||
- Image
|
||||
ha_release: 2023.7.0
|
||||
ha_iot_class: Configurable
|
||||
ha_domain: mqtt
|
||||
---
|
||||
|
||||
The `mqtt` image platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as an image.
|
||||
The `image` platform is a simplified version of the `camera` platform that only accepts images.
|
||||
Every time a message under the `image_topic` in the configuration is received, the image displayed in Home Assistant will also be updated. Messages received on `image_topic` should contain the full contents of an image file, for example, a JPEG image, without any additional encoding or metadata.
|
||||
|
||||
This can be used with an application or a service capable of sending images through MQTT.
|
||||
|
||||
## Configuration
|
||||
|
||||
<a id='new_format'></a>
|
||||
|
||||
To enable this image in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
mqtt:
|
||||
image:
|
||||
- topic: zanzito/shared_locations/my-device
|
||||
```
|
||||
|
||||
The sample configuration above can be tested by publishing an image to the topic from the console:
|
||||
|
||||
```shell
|
||||
mosquitto_pub -h <mqtt_broker> -t zanzito/shared_locations/my-device -f <image_filename.jpg>
|
||||
```
|
||||
|
||||
{% 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_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
|
||||
availability_topic:
|
||||
description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
|
||||
required: false
|
||||
type: string
|
||||
content_type:
|
||||
description: The content type of and image data message received on `image_topic`.
|
||||
required: false
|
||||
type: string
|
||||
default: image/jpeg
|
||||
device:
|
||||
description: "Information about the device this image 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](/integrations/mqtt/#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
|
||||
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. Set to `""` to disable decoding of incoming payload. Use `image_encoding` to enable `Base64` decoding on `image_topic`.
|
||||
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
|
||||
image_encoding:
|
||||
description: The encoding of the image payloads received. Set to `"b64"` to enable base64 decoding of image payload. If not set, the image payload must be raw binary data.
|
||||
required: false
|
||||
type: string
|
||||
default: None
|
||||
image_topic:
|
||||
description: The MQTT topic to subscribe to receive the image payload of the image to be downloaded. Ensure the `content_type` type option is set to the corresponding content type.
|
||||
required: true
|
||||
type: string
|
||||
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 sensor attributes. Implies `force_update` of the current sensor state when a message is received on this topic.
|
||||
required: false
|
||||
type: string
|
||||
name:
|
||||
description: The name of the image.
|
||||
required: false
|
||||
type: string
|
||||
object_id:
|
||||
description: Used instead of `name` for automatic generation of `entity_id`
|
||||
required: false
|
||||
type: string
|
||||
unique_id:
|
||||
description: An ID that uniquely identifies this image. If two images have the same unique ID Home Assistant will raise an exception.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
@ -203,6 +203,7 @@ The discovery of MQTT devices will enable one to use MQTT devices with only mini
|
||||
- [Device Trigger](/integrations/device_trigger.mqtt/)
|
||||
- [Fan](/integrations/fan.mqtt/)
|
||||
- [Humidifier](/integrations/humidifier.mqtt/)
|
||||
- [Image](/integrations/image.mqtt/)
|
||||
- [Climate/HVAC](/integrations/climate.mqtt/)
|
||||
- [Light](/integrations/light.mqtt/)
|
||||
- [Lock](/integrations/lock.mqtt/)
|
||||
@ -298,6 +299,7 @@ Configuration variable names in the discovery payload may be abbreviated to cons
|
||||
'cod_arm_req': 'code_arm_required',
|
||||
'cod_dis_req': 'code_disarm_required',
|
||||
'cod_trig_req': 'code_trigger_required',
|
||||
'cont_type': 'content_type',
|
||||
'curr_temp_t': 'current_temperature_topic',
|
||||
'curr_temp_tpl': 'current_temperature_template',
|
||||
'dev': 'device',
|
||||
@ -338,6 +340,7 @@ Configuration variable names in the discovery payload may be abbreviated to cons
|
||||
'hs_val_tpl': 'hs_value_template',
|
||||
'ic': 'icon',
|
||||
'img_e': 'image_encoding',
|
||||
'img_t': 'image_topic',
|
||||
'init': 'initial',
|
||||
'hum_cmd_t': 'target_humidity_command_topic',
|
||||
'hum_cmd_tpl': 'target_humidity_command_template',
|
||||
@ -503,6 +506,8 @@ Configuration variable names in the discovery payload may be abbreviated to cons
|
||||
't': 'topic',
|
||||
'uniq_id': 'unique_id',
|
||||
'unit_of_meas': 'unit_of_measurement',
|
||||
'url_t': 'url_topic',
|
||||
'url_tpl': 'url_template',
|
||||
'val_tpl': 'value_template',
|
||||
'whit_cmd_t': 'white_command_topic',
|
||||
'whit_scl': 'white_scale',
|
||||
@ -684,6 +689,7 @@ For most components it is also possible to manual set up MQTT items in `configur
|
||||
- [Device Tracker](/integrations/device_tracker.mqtt/)
|
||||
- [Fan](/integrations/fan.mqtt/)
|
||||
- [Humidifier](/integrations/humidifier.mqtt/)
|
||||
- [Image](/integrations/imahe.mqtt/)
|
||||
- [Climate/HVACs](/integrations/climate.mqtt/)
|
||||
- [Light](/integrations/light.mqtt/)
|
||||
- [Lock](/integrations/lock.mqtt/)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user