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

availability list(Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_available string(Optional, default: online)

The payload that represents the available state.

payload_not_available string(Optional, default: offline)

The payload that represents the unavailable state.

topic stringRequired

An MQTT topic subscribed to receive availability (online/offline) updates.

availability_topic string(Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

device map(Optional)

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.

connections list(Optional)

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"].

identifiers list | string(Optional)

A list of IDs that uniquely identify the device. For example a serial number.

manufacturer string(Optional)

The manufacturer of the device.

model string(Optional)

The model of the device.

name string(Optional)

The name of the device.

sw_version string(Optional)

The firmware version of the device.

via_device string(Optional)

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.

json_attributes_template template(Optional)

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.

json_attributes_topic string(Optional)

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.

name string(Optional)

The name of the camera.

topic stringRequired

The MQTT topic to subscribe to.

unique_id string(Optional)

An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception.