MQTT Camera
The mqtt
camera platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as a camera. Every time a message under the topic
in the configuration is received, the image displayed in Home Assistant will also be updated.
This can be used with an application or a service capable of sending images through MQTT.
Configuration
To enable this camera in your installation, add the following to your configuration.yaml
file:
# Example configuration.yaml entry
camera:
- platform: mqtt
topic: zanzito/shared_locations/my-device
Configuration Variables
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic
.
The payload that represents the available state.
The payload that represents the unavailable state.
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.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability
.
Information about the device this camera is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id
is set.
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"]
.
A list of IDs that uniquely identify the device. For example a serial number.
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic
.
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.
Suggest an edit to this page, or provide/view feedback for this page.