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

Namespaces

 schema
 
 schema_basic
 
 schema_json
 
 schema_template
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
ConfigType validate_mqtt_light_discovery (dict[str, Any] config_value)
 
ConfigType validate_mqtt_light_modern (dict[str, Any] config_value)
 

Variables

 DISCOVERY_SCHEMA
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_MODERN
 

Detailed Description

Support for MQTT lights.

Function Documentation

◆ async_setup_entry()

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

Definition at line 69 of file __init__.py.

◆ validate_mqtt_light_discovery()

ConfigType homeassistant.components.mqtt.light.validate_mqtt_light_discovery ( dict[str, Any]  config_value)
Validate MQTT light schema for discovery.

Definition at line 36 of file __init__.py.

◆ validate_mqtt_light_modern()

ConfigType homeassistant.components.mqtt.light.validate_mqtt_light_modern ( dict[str, Any]  config_value)
Validate MQTT light schema for setup from configuration.yaml.

Definition at line 47 of file __init__.py.

Variable Documentation

◆ DISCOVERY_SCHEMA

homeassistant.components.mqtt.light.DISCOVERY_SCHEMA
Initial value:
1 = vol.All(
2  MQTT_LIGHT_SCHEMA_SCHEMA.extend({}, extra=vol.ALLOW_EXTRA),
3  validate_mqtt_light_discovery,
4 )

Definition at line 58 of file __init__.py.

◆ PARALLEL_UPDATES

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

Definition at line 33 of file __init__.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.light.PLATFORM_SCHEMA_MODERN
Initial value:
1 = vol.All(
2  MQTT_LIGHT_SCHEMA_SCHEMA.extend({}, extra=vol.ALLOW_EXTRA),
3  validate_mqtt_light_modern,
4 )

Definition at line 63 of file __init__.py.