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

Classes

class  MqttLightTemplate
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
tuple COMMAND_TEMPLATES = (CONF_COMMAND_ON_TEMPLATE, CONF_COMMAND_OFF_TEMPLATE)
 
string CONF_BLUE_TEMPLATE = "blue_template"
 
string CONF_BRIGHTNESS_TEMPLATE = "brightness_template"
 
string CONF_COLOR_TEMP_TEMPLATE = "color_temp_template"
 
string CONF_COMMAND_OFF_TEMPLATE = "command_off_template"
 
string CONF_COMMAND_ON_TEMPLATE = "command_on_template"
 
string CONF_EFFECT_LIST = "effect_list"
 
string CONF_EFFECT_TEMPLATE = "effect_template"
 
string CONF_GREEN_TEMPLATE = "green_template"
 
string CONF_MAX_MIREDS = "max_mireds"
 
string CONF_MIN_MIREDS = "min_mireds"
 
string CONF_RED_TEMPLATE = "red_template"
 
string DEFAULT_NAME = "MQTT Template Light"
 
 DISCOVERY_SCHEMA_TEMPLATE
 
string DOMAIN = "mqtt_template"
 
tuple PLATFORM_SCHEMA_MODERN_TEMPLATE
 
tuple VALUE_TEMPLATES
 

Detailed Description

Support for MQTT Template lights.

Variable Documentation

◆ _LOGGER

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

Definition at line 52 of file schema_template.py.

◆ COMMAND_TEMPLATES

tuple homeassistant.components.mqtt.light.schema_template.COMMAND_TEMPLATES = (CONF_COMMAND_ON_TEMPLATE, CONF_COMMAND_OFF_TEMPLATE)

Definition at line 70 of file schema_template.py.

◆ CONF_BLUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_BLUE_TEMPLATE = "blue_template"

Definition at line 58 of file schema_template.py.

◆ CONF_BRIGHTNESS_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_BRIGHTNESS_TEMPLATE = "brightness_template"

Definition at line 59 of file schema_template.py.

◆ CONF_COLOR_TEMP_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_COLOR_TEMP_TEMPLATE = "color_temp_template"

Definition at line 60 of file schema_template.py.

◆ CONF_COMMAND_OFF_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_COMMAND_OFF_TEMPLATE = "command_off_template"

Definition at line 61 of file schema_template.py.

◆ CONF_COMMAND_ON_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_COMMAND_ON_TEMPLATE = "command_on_template"

Definition at line 62 of file schema_template.py.

◆ CONF_EFFECT_LIST

string homeassistant.components.mqtt.light.schema_template.CONF_EFFECT_LIST = "effect_list"

Definition at line 63 of file schema_template.py.

◆ CONF_EFFECT_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_EFFECT_TEMPLATE = "effect_template"

Definition at line 64 of file schema_template.py.

◆ CONF_GREEN_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_GREEN_TEMPLATE = "green_template"

Definition at line 65 of file schema_template.py.

◆ CONF_MAX_MIREDS

string homeassistant.components.mqtt.light.schema_template.CONF_MAX_MIREDS = "max_mireds"

Definition at line 66 of file schema_template.py.

◆ CONF_MIN_MIREDS

string homeassistant.components.mqtt.light.schema_template.CONF_MIN_MIREDS = "min_mireds"

Definition at line 67 of file schema_template.py.

◆ CONF_RED_TEMPLATE

string homeassistant.components.mqtt.light.schema_template.CONF_RED_TEMPLATE = "red_template"

Definition at line 68 of file schema_template.py.

◆ DEFAULT_NAME

string homeassistant.components.mqtt.light.schema_template.DEFAULT_NAME = "MQTT Template Light"

Definition at line 56 of file schema_template.py.

◆ DISCOVERY_SCHEMA_TEMPLATE

homeassistant.components.mqtt.light.schema_template.DISCOVERY_SCHEMA_TEMPLATE
Initial value:
1 = vol.All(
2  PLATFORM_SCHEMA_MODERN_TEMPLATE.extend({}, extra=vol.REMOVE_EXTRA),
3 )

Definition at line 103 of file schema_template.py.

◆ DOMAIN

string homeassistant.components.mqtt.light.schema_template.DOMAIN = "mqtt_template"

Definition at line 54 of file schema_template.py.

◆ PLATFORM_SCHEMA_MODERN_TEMPLATE

tuple homeassistant.components.mqtt.light.schema_template.PLATFORM_SCHEMA_MODERN_TEMPLATE
Initial value:
1 = (
2  MQTT_RW_SCHEMA.extend(
3  {
4  vol.Optional(CONF_BLUE_TEMPLATE): cv.template,
5  vol.Optional(CONF_BRIGHTNESS_TEMPLATE): cv.template,
6  vol.Optional(CONF_COLOR_TEMP_TEMPLATE): cv.template,
7  vol.Required(CONF_COMMAND_OFF_TEMPLATE): cv.template,
8  vol.Required(CONF_COMMAND_ON_TEMPLATE): cv.template,
9  vol.Optional(CONF_EFFECT_LIST): vol.All(cv.ensure_list, [cv.string]),
10  vol.Optional(CONF_EFFECT_TEMPLATE): cv.template,
11  vol.Optional(CONF_GREEN_TEMPLATE): cv.template,
12  vol.Optional(CONF_MAX_MIREDS): cv.positive_int,
13  vol.Optional(CONF_MIN_MIREDS): cv.positive_int,
14  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
15  vol.Optional(CONF_RED_TEMPLATE): cv.template,
16  vol.Optional(CONF_STATE_TEMPLATE): cv.template,
17  }
18  )
19  .extend(MQTT_ENTITY_COMMON_SCHEMA.schema)
20  .extend(MQTT_LIGHT_SCHEMA_SCHEMA.schema)
21 )

Definition at line 81 of file schema_template.py.

◆ VALUE_TEMPLATES

tuple homeassistant.components.mqtt.light.schema_template.VALUE_TEMPLATES
Initial value:
1 = (
2  CONF_BLUE_TEMPLATE,
3  CONF_BRIGHTNESS_TEMPLATE,
4  CONF_COLOR_TEMP_TEMPLATE,
5  CONF_EFFECT_TEMPLATE,
6  CONF_GREEN_TEMPLATE,
7  CONF_RED_TEMPLATE,
8  CONF_STATE_TEMPLATE,
9 )

Definition at line 71 of file schema_template.py.