homeassistant.components.mqtt.light.schema_basic Namespace Reference

Classes
class	MqttLight

Variables
	_LOGGER = logging.getLogger(__name__)
list	COMMAND_TEMPLATE_KEYS
string	CONF_BRIGHTNESS_COMMAND_TEMPLATE = "brightness_command_template"
string	CONF_BRIGHTNESS_COMMAND_TOPIC = "brightness_command_topic"
string	CONF_BRIGHTNESS_SCALE = "brightness_scale"
string	CONF_BRIGHTNESS_STATE_TOPIC = "brightness_state_topic"
string	CONF_BRIGHTNESS_VALUE_TEMPLATE = "brightness_value_template"
string	CONF_COLOR_MODE_STATE_TOPIC = "color_mode_state_topic"
string	CONF_COLOR_MODE_VALUE_TEMPLATE = "color_mode_value_template"
string	CONF_COLOR_TEMP_COMMAND_TEMPLATE = "color_temp_command_template"
string	CONF_COLOR_TEMP_COMMAND_TOPIC = "color_temp_command_topic"
string	CONF_COLOR_TEMP_STATE_TOPIC = "color_temp_state_topic"
string	CONF_COLOR_TEMP_VALUE_TEMPLATE = "color_temp_value_template"
string	CONF_EFFECT_COMMAND_TEMPLATE = "effect_command_template"
string	CONF_EFFECT_COMMAND_TOPIC = "effect_command_topic"
string	CONF_EFFECT_LIST = "effect_list"
string	CONF_EFFECT_STATE_TOPIC = "effect_state_topic"
string	CONF_EFFECT_VALUE_TEMPLATE = "effect_value_template"
string	CONF_HS_COMMAND_TEMPLATE = "hs_command_template"
string	CONF_HS_COMMAND_TOPIC = "hs_command_topic"
string	CONF_HS_STATE_TOPIC = "hs_state_topic"
string	CONF_HS_VALUE_TEMPLATE = "hs_value_template"
string	CONF_MAX_MIREDS = "max_mireds"
string	CONF_MIN_MIREDS = "min_mireds"
string	CONF_ON_COMMAND_TYPE = "on_command_type"
string	CONF_RGB_COMMAND_TEMPLATE = "rgb_command_template"
string	CONF_RGB_COMMAND_TOPIC = "rgb_command_topic"
string	CONF_RGB_STATE_TOPIC = "rgb_state_topic"
string	CONF_RGB_VALUE_TEMPLATE = "rgb_value_template"
string	CONF_RGBW_COMMAND_TEMPLATE = "rgbw_command_template"
string	CONF_RGBW_COMMAND_TOPIC = "rgbw_command_topic"
string	CONF_RGBW_STATE_TOPIC = "rgbw_state_topic"
string	CONF_RGBW_VALUE_TEMPLATE = "rgbw_value_template"
string	CONF_RGBWW_COMMAND_TEMPLATE = "rgbww_command_template"
string	CONF_RGBWW_COMMAND_TOPIC = "rgbww_command_topic"
string	CONF_RGBWW_STATE_TOPIC = "rgbww_state_topic"
string	CONF_RGBWW_VALUE_TEMPLATE = "rgbww_value_template"
string	CONF_WHITE_COMMAND_TOPIC = "white_command_topic"
string	CONF_WHITE_SCALE = "white_scale"
string	CONF_XY_COMMAND_TEMPLATE = "xy_command_template"
string	CONF_XY_COMMAND_TOPIC = "xy_command_topic"
string	CONF_XY_STATE_TOPIC = "xy_state_topic"
string	CONF_XY_VALUE_TEMPLATE = "xy_value_template"
int	DEFAULT_BRIGHTNESS_SCALE = 255
string	DEFAULT_NAME = "MQTT LightEntity"
string	DEFAULT_ON_COMMAND_TYPE = "last"
string	DEFAULT_PAYLOAD_OFF = "OFF"
string	DEFAULT_PAYLOAD_ON = "ON"
int	DEFAULT_WHITE_SCALE = 255
	DISCOVERY_SCHEMA_BASIC
	MQTT_LIGHT_ATTRIBUTES_BLOCKED
tuple	PLATFORM_SCHEMA_MODERN_BASIC
list	VALUE_TEMPLATE_KEYS
list	VALUES_ON_COMMAND_TYPE = ["first", "last", "brightness"]

Detailed Description

Support for MQTT lights.

Variable Documentation

_LOGGER

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

private

Definition at line 67 of file schema_basic.py.

COMMAND_TEMPLATE_KEYS

list homeassistant.components.mqtt.light.schema_basic.COMMAND_TEMPLATE_KEYS

Initial value:

=  [
    CONF_BRIGHTNESS_COMMAND_TEMPLATE,
    CONF_COLOR_TEMP_COMMAND_TEMPLATE,
    CONF_EFFECT_COMMAND_TEMPLATE,
    CONF_HS_COMMAND_TEMPLATE,
    CONF_RGB_COMMAND_TEMPLATE,
    CONF_RGBW_COMMAND_TEMPLATE,
    CONF_RGBWW_COMMAND_TEMPLATE,
    CONF_XY_COMMAND_TEMPLATE,
]

Definition at line 138 of file schema_basic.py.

CONF_BRIGHTNESS_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_BRIGHTNESS_COMMAND_TEMPLATE = "brightness_command_template"

Definition at line 69 of file schema_basic.py.

CONF_BRIGHTNESS_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_BRIGHTNESS_COMMAND_TOPIC = "brightness_command_topic"

Definition at line 70 of file schema_basic.py.

CONF_BRIGHTNESS_SCALE

string homeassistant.components.mqtt.light.schema_basic.CONF_BRIGHTNESS_SCALE = "brightness_scale"

Definition at line 71 of file schema_basic.py.

CONF_BRIGHTNESS_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_BRIGHTNESS_STATE_TOPIC = "brightness_state_topic"

Definition at line 72 of file schema_basic.py.

CONF_BRIGHTNESS_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_BRIGHTNESS_VALUE_TEMPLATE = "brightness_value_template"

Definition at line 73 of file schema_basic.py.

CONF_COLOR_MODE_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_MODE_STATE_TOPIC = "color_mode_state_topic"

Definition at line 74 of file schema_basic.py.

CONF_COLOR_MODE_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_MODE_VALUE_TEMPLATE = "color_mode_value_template"

Definition at line 75 of file schema_basic.py.

CONF_COLOR_TEMP_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_TEMP_COMMAND_TEMPLATE = "color_temp_command_template"

Definition at line 76 of file schema_basic.py.

CONF_COLOR_TEMP_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_TEMP_COMMAND_TOPIC = "color_temp_command_topic"

Definition at line 77 of file schema_basic.py.

CONF_COLOR_TEMP_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_TEMP_STATE_TOPIC = "color_temp_state_topic"

Definition at line 78 of file schema_basic.py.

CONF_COLOR_TEMP_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_COLOR_TEMP_VALUE_TEMPLATE = "color_temp_value_template"

Definition at line 79 of file schema_basic.py.

CONF_EFFECT_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_EFFECT_COMMAND_TEMPLATE = "effect_command_template"

Definition at line 80 of file schema_basic.py.

CONF_EFFECT_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_EFFECT_COMMAND_TOPIC = "effect_command_topic"

Definition at line 81 of file schema_basic.py.

CONF_EFFECT_LIST

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

Definition at line 82 of file schema_basic.py.

CONF_EFFECT_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_EFFECT_STATE_TOPIC = "effect_state_topic"

Definition at line 83 of file schema_basic.py.

CONF_EFFECT_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_EFFECT_VALUE_TEMPLATE = "effect_value_template"

Definition at line 84 of file schema_basic.py.

CONF_HS_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_HS_COMMAND_TEMPLATE = "hs_command_template"

Definition at line 85 of file schema_basic.py.

CONF_HS_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_HS_COMMAND_TOPIC = "hs_command_topic"

Definition at line 86 of file schema_basic.py.

CONF_HS_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_HS_STATE_TOPIC = "hs_state_topic"

Definition at line 87 of file schema_basic.py.

CONF_HS_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_HS_VALUE_TEMPLATE = "hs_value_template"

Definition at line 88 of file schema_basic.py.

CONF_MAX_MIREDS

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

Definition at line 89 of file schema_basic.py.

CONF_MIN_MIREDS

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

Definition at line 90 of file schema_basic.py.

CONF_ON_COMMAND_TYPE

string homeassistant.components.mqtt.light.schema_basic.CONF_ON_COMMAND_TYPE = "on_command_type"

Definition at line 109 of file schema_basic.py.

CONF_RGB_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGB_COMMAND_TEMPLATE = "rgb_command_template"

Definition at line 91 of file schema_basic.py.

CONF_RGB_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGB_COMMAND_TOPIC = "rgb_command_topic"

Definition at line 92 of file schema_basic.py.

CONF_RGB_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGB_STATE_TOPIC = "rgb_state_topic"

Definition at line 93 of file schema_basic.py.

CONF_RGB_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGB_VALUE_TEMPLATE = "rgb_value_template"

Definition at line 94 of file schema_basic.py.

CONF_RGBW_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBW_COMMAND_TEMPLATE = "rgbw_command_template"

Definition at line 95 of file schema_basic.py.

CONF_RGBW_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBW_COMMAND_TOPIC = "rgbw_command_topic"

Definition at line 96 of file schema_basic.py.

CONF_RGBW_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBW_STATE_TOPIC = "rgbw_state_topic"

Definition at line 97 of file schema_basic.py.

CONF_RGBW_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBW_VALUE_TEMPLATE = "rgbw_value_template"

Definition at line 98 of file schema_basic.py.

CONF_RGBWW_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBWW_COMMAND_TEMPLATE = "rgbww_command_template"

Definition at line 99 of file schema_basic.py.

CONF_RGBWW_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBWW_COMMAND_TOPIC = "rgbww_command_topic"

Definition at line 100 of file schema_basic.py.

CONF_RGBWW_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBWW_STATE_TOPIC = "rgbww_state_topic"

Definition at line 101 of file schema_basic.py.

CONF_RGBWW_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_RGBWW_VALUE_TEMPLATE = "rgbww_value_template"

Definition at line 102 of file schema_basic.py.

CONF_WHITE_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_WHITE_COMMAND_TOPIC = "white_command_topic"

Definition at line 107 of file schema_basic.py.

CONF_WHITE_SCALE

string homeassistant.components.mqtt.light.schema_basic.CONF_WHITE_SCALE = "white_scale"

Definition at line 108 of file schema_basic.py.

CONF_XY_COMMAND_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_XY_COMMAND_TEMPLATE = "xy_command_template"

Definition at line 103 of file schema_basic.py.

CONF_XY_COMMAND_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_XY_COMMAND_TOPIC = "xy_command_topic"

Definition at line 104 of file schema_basic.py.

CONF_XY_STATE_TOPIC

string homeassistant.components.mqtt.light.schema_basic.CONF_XY_STATE_TOPIC = "xy_state_topic"

Definition at line 105 of file schema_basic.py.

CONF_XY_VALUE_TEMPLATE

string homeassistant.components.mqtt.light.schema_basic.CONF_XY_VALUE_TEMPLATE = "xy_value_template"

Definition at line 106 of file schema_basic.py.

DEFAULT_BRIGHTNESS_SCALE

int homeassistant.components.mqtt.light.schema_basic.DEFAULT_BRIGHTNESS_SCALE = 255

Definition at line 129 of file schema_basic.py.

DEFAULT_NAME

string homeassistant.components.mqtt.light.schema_basic.DEFAULT_NAME = "MQTT LightEntity"

Definition at line 130 of file schema_basic.py.

DEFAULT_ON_COMMAND_TYPE

string homeassistant.components.mqtt.light.schema_basic.DEFAULT_ON_COMMAND_TYPE = "last"

Definition at line 134 of file schema_basic.py.

DEFAULT_PAYLOAD_OFF

string homeassistant.components.mqtt.light.schema_basic.DEFAULT_PAYLOAD_OFF = "OFF"

Definition at line 131 of file schema_basic.py.

DEFAULT_PAYLOAD_ON

string homeassistant.components.mqtt.light.schema_basic.DEFAULT_PAYLOAD_ON = "ON"

Definition at line 132 of file schema_basic.py.

DEFAULT_WHITE_SCALE

int homeassistant.components.mqtt.light.schema_basic.DEFAULT_WHITE_SCALE = 255

Definition at line 133 of file schema_basic.py.

DISCOVERY_SCHEMA_BASIC

homeassistant.components.mqtt.light.schema_basic.DISCOVERY_SCHEMA_BASIC

Initial value:

=  vol.All(
    PLATFORM_SCHEMA_MODERN_BASIC.extend({}, extra=vol.REMOVE_EXTRA),
)

Definition at line 221 of file schema_basic.py.

MQTT_LIGHT_ATTRIBUTES_BLOCKED

homeassistant.components.mqtt.light.schema_basic.MQTT_LIGHT_ATTRIBUTES_BLOCKED

Initial value:

=  frozenset(
    {
        ATTR_COLOR_MODE,
        ATTR_BRIGHTNESS,
        ATTR_COLOR_TEMP,
        ATTR_EFFECT,
        ATTR_EFFECT_LIST,
        ATTR_HS_COLOR,
        ATTR_MAX_MIREDS,
        ATTR_MIN_MIREDS,
        ATTR_RGB_COLOR,
        ATTR_RGBW_COLOR,
        ATTR_RGBWW_COLOR,
        ATTR_SUPPORTED_COLOR_MODES,
        ATTR_XY_COLOR,
    }
)

Definition at line 111 of file schema_basic.py.

PLATFORM_SCHEMA_MODERN_BASIC

tuple homeassistant.components.mqtt.light.schema_basic.PLATFORM_SCHEMA_MODERN_BASIC

Definition at line 161 of file schema_basic.py.

VALUE_TEMPLATE_KEYS

list homeassistant.components.mqtt.light.schema_basic.VALUE_TEMPLATE_KEYS

Initial value:

=  [
    CONF_BRIGHTNESS_VALUE_TEMPLATE,
    CONF_COLOR_MODE_VALUE_TEMPLATE,
    CONF_COLOR_TEMP_VALUE_TEMPLATE,
    CONF_EFFECT_VALUE_TEMPLATE,
    CONF_HS_VALUE_TEMPLATE,
    CONF_RGB_VALUE_TEMPLATE,
    CONF_RGBW_VALUE_TEMPLATE,
    CONF_RGBWW_VALUE_TEMPLATE,
    CONF_STATE_VALUE_TEMPLATE,
    CONF_XY_VALUE_TEMPLATE,
]

Definition at line 148 of file schema_basic.py.

VALUES_ON_COMMAND_TYPE

list homeassistant.components.mqtt.light.schema_basic.VALUES_ON_COMMAND_TYPE = ["first", "last", "brightness"]

Definition at line 136 of file schema_basic.py.