mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-20 00:56:53 +00:00
6cbcc1acdc
* fixing ha_category components annotation
Signed-off-by: Piotr Żuralski <piotr.zuralski@gmail.com>
* ✏️ Tweak
75 lines
2.5 KiB
Markdown
75 lines
2.5 KiB
Markdown
---
|
|
layout: page
|
|
title: "MQTT Camera"
|
|
description: "Instructions on how to use an MQTT image message as a Camera within Home Assistant."
|
|
date: 2017-04-14 00:45
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: mqtt.png
|
|
ha_category:
|
|
- Camera
|
|
ha_release: 0.43
|
|
ha_iot_class: Configurable
|
|
---
|
|
|
|
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, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito).
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To enable this camera in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
camera:
|
|
- platform: mqtt
|
|
topic: zanzito/shared_locations/my-device
|
|
```
|
|
|
|
{% configuration %}
|
|
topic:
|
|
description: The MQTT topic to subscribe to.
|
|
required: true
|
|
type: string
|
|
name:
|
|
description: The name of the camera.
|
|
required: false
|
|
type: string
|
|
unique_id:
|
|
description: An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception.
|
|
required: false
|
|
type: string
|
|
device:
|
|
description: "Information about the device this camera 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."
|
|
required: false
|
|
type: map
|
|
keys:
|
|
identifiers:
|
|
description: 'A list of IDs that uniquely identify the device. For example a serial number.'
|
|
required: false
|
|
type: list, 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
|
|
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
|
|
sw_version:
|
|
description: The firmware version of the device.
|
|
required: false
|
|
type: string
|
|
{% endconfiguration %}
|