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. Messages received on
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.
To enable this camera in your installation, add the following to your
# Example configuration.yaml entry mqtt: - camera: topic: zanzito/shared_locations/my-device
The sample configuration above can be tested by publishing an image to the topic from the console:
mosquitto_pub -h <mqtt_broker> -t zanzito/shared_locations/my-device -f <camera_imaga.jpg>
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with
The payload that represents the available state.
The payload that represents the unavailable state.
availability is configured, this controls the conditions needed to set the entity to
available. Valid entries are
latest. If set to
payload_available must be received on all configured availability topics before the entity is marked as online. If set to
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_not_available received on any configured availability topic controls the availability.
Defines a template to extract device’s availability from the
availability_topic. To determine the devices’s availability result of this template will be compared to
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with
Information about the device this camera is a part of to tie it into the device registry. Only works when
unique_id is set. At least one of identifiers or connections must be present to identify the device.
A link to the webpage that can manage the configuration of this device. Can be either an
https:// or an internal
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.
Flag which defines if the entity should be enabled when first added.
The encoding of the payloads received. Set to
"" to disable decoding of incoming payload. Use
image_encoding to enable
Base64 decoding on
The category of the entity.
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.
Defines a template to extract the JSON dictionary from messages received on the
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.
The name of the camera. Can be set to
null if only the device name is relevant.