Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.mqtt.camera Namespace Reference

Classes

class  MqttCamera
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_IMAGE_ENCODING = "image_encoding"
 
string DEFAULT_NAME = "MQTT Camera"
 
 DISCOVERY_SCHEMA = PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA)
 
 MQTT_CAMERA_ATTRIBUTES_BLOCKED
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_BASE
 
 PLATFORM_SCHEMA_MODERN
 

Detailed Description

Camera that loads a picture from an MQTT topic.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.mqtt.camera.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up MQTT camera through YAML and through MQTT discovery.

Definition at line 60 of file camera.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt.camera._LOGGER = logging.getLogger(__name__)
private

Definition at line 28 of file camera.py.

◆ CONF_IMAGE_ENCODING

string homeassistant.components.mqtt.camera.CONF_IMAGE_ENCODING = "image_encoding"

Definition at line 32 of file camera.py.

◆ DEFAULT_NAME

string homeassistant.components.mqtt.camera.DEFAULT_NAME = "MQTT Camera"

Definition at line 34 of file camera.py.

◆ DISCOVERY_SCHEMA

homeassistant.components.mqtt.camera.DISCOVERY_SCHEMA = PLATFORM_SCHEMA_BASE.extend({}, extra=vol.REMOVE_EXTRA)

Definition at line 57 of file camera.py.

◆ MQTT_CAMERA_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.camera.MQTT_CAMERA_ATTRIBUTES_BLOCKED
Initial value:
1 = frozenset(
2  {
3  "access_token",
4  "brand",
5  "model_name",
6  "motion_detection",
7  }
8 )

Definition at line 36 of file camera.py.

◆ PARALLEL_UPDATES

int homeassistant.components.mqtt.camera.PARALLEL_UPDATES = 0

Definition at line 30 of file camera.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.mqtt.camera.PLATFORM_SCHEMA_BASE
Initial value:
1 = MQTT_BASE_SCHEMA.extend(
2  {
3  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
4  vol.Required(CONF_TOPIC): valid_subscribe_topic,
5  vol.Optional(CONF_IMAGE_ENCODING): "b64",
6  }
7 ).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 45 of file camera.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.camera.PLATFORM_SCHEMA_MODERN
Initial value:
1 = vol.All(
2  PLATFORM_SCHEMA_BASE.schema,
3 )

Definition at line 53 of file camera.py.