Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.knx.schema.LightSchema Class Reference
Inheritance diagram for homeassistant.components.knx.schema.LightSchema:
[legend]
Collaboration diagram for homeassistant.components.knx.schema.LightSchema:
[legend]

Static Public Attributes

string CONF_BLUE = "blue"
 
string CONF_BRIGHTNESS_ADDRESS = "brightness_address"
 
string CONF_BRIGHTNESS_STATE_ADDRESS = "brightness_state_address"
 
string CONF_COLOR_ADDRESS = "color_address"
 
string CONF_COLOR_STATE_ADDRESS = "color_state_address"
 
string CONF_COLOR_TEMP_ADDRESS = "color_temperature_address"
 
string CONF_COLOR_TEMP_MODE = "color_temperature_mode"
 
string CONF_COLOR_TEMP_STATE_ADDRESS = "color_temperature_state_address"
 
string CONF_GREEN = "green"
 
string CONF_HUE_ADDRESS = "hue_address"
 
string CONF_HUE_STATE_ADDRESS = "hue_state_address"
 
string CONF_INDIVIDUAL_COLORS = "individual_colors"
 
string CONF_MAX_KELVIN = "max_kelvin"
 
string CONF_MIN_KELVIN = "min_kelvin"
 
string CONF_RED = "red"
 
string CONF_RGBW_ADDRESS = "rgbw_address"
 
string CONF_RGBW_STATE_ADDRESS = "rgbw_state_address"
 
string CONF_SATURATION_ADDRESS = "saturation_address"
 
string CONF_SATURATION_STATE_ADDRESS = "saturation_state_address"
 
 CONF_STATE_ADDRESS = CONF_STATE_ADDRESS
 
string CONF_WHITE = "white"
 
string CONF_XYY_ADDRESS = "xyy_address"
 
string CONF_XYY_STATE_ADDRESS = "xyy_state_address"
 
string DEFAULT_COLOR_TEMP_MODE = "absolute"
 
int DEFAULT_MAX_KELVIN = 6000
 
int DEFAULT_MIN_KELVIN = 2700
 
string DEFAULT_NAME = "KNX Light"
 
 ENTITY_SCHEMA
 
dictionary HS_COLOR_SCHEMA
 
 INDIVIDUAL_COLOR_SCHEMA
 
 PLATFORM = Platform.LIGHT
 

Static Private Attributes

tuple _hs_color_inclusion_msg
 

Additional Inherited Members

- Public Member Functions inherited from homeassistant.components.knx.schema.KNXPlatformSchema
dict[vol.Optional, vol.All] platform_node (cls)
 

Detailed Description

Voluptuous schema for KNX lights.

Definition at line 607 of file schema.py.

Member Data Documentation

◆ _hs_color_inclusion_msg

tuple homeassistant.components.knx.schema.LightSchema._hs_color_inclusion_msg
staticprivate
Initial value:
= (
"'hue_address', 'saturation_address' and 'brightness_address'"
" are required for hs_color configuration"
)

Definition at line 642 of file schema.py.

◆ CONF_BLUE

string homeassistant.components.knx.schema.LightSchema.CONF_BLUE = "blue"
static

Definition at line 639 of file schema.py.

◆ CONF_BRIGHTNESS_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_BRIGHTNESS_ADDRESS = "brightness_address"
static

Definition at line 613 of file schema.py.

◆ CONF_BRIGHTNESS_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_BRIGHTNESS_STATE_ADDRESS = "brightness_state_address"
static

Definition at line 614 of file schema.py.

◆ CONF_COLOR_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_COLOR_ADDRESS = "color_address"
static

Definition at line 615 of file schema.py.

◆ CONF_COLOR_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_COLOR_STATE_ADDRESS = "color_state_address"
static

Definition at line 616 of file schema.py.

◆ CONF_COLOR_TEMP_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_COLOR_TEMP_ADDRESS = "color_temperature_address"
static

Definition at line 617 of file schema.py.

◆ CONF_COLOR_TEMP_MODE

string homeassistant.components.knx.schema.LightSchema.CONF_COLOR_TEMP_MODE = "color_temperature_mode"
static

Definition at line 619 of file schema.py.

◆ CONF_COLOR_TEMP_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_COLOR_TEMP_STATE_ADDRESS = "color_temperature_state_address"
static

Definition at line 618 of file schema.py.

◆ CONF_GREEN

string homeassistant.components.knx.schema.LightSchema.CONF_GREEN = "green"
static

Definition at line 638 of file schema.py.

◆ CONF_HUE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_HUE_ADDRESS = "hue_address"
static

Definition at line 620 of file schema.py.

◆ CONF_HUE_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_HUE_STATE_ADDRESS = "hue_state_address"
static

Definition at line 621 of file schema.py.

◆ CONF_INDIVIDUAL_COLORS

string homeassistant.components.knx.schema.LightSchema.CONF_INDIVIDUAL_COLORS = "individual_colors"
static

Definition at line 636 of file schema.py.

◆ CONF_MAX_KELVIN

string homeassistant.components.knx.schema.LightSchema.CONF_MAX_KELVIN = "max_kelvin"
static

Definition at line 629 of file schema.py.

◆ CONF_MIN_KELVIN

string homeassistant.components.knx.schema.LightSchema.CONF_MIN_KELVIN = "min_kelvin"
static

Definition at line 628 of file schema.py.

◆ CONF_RED

string homeassistant.components.knx.schema.LightSchema.CONF_RED = "red"
static

Definition at line 637 of file schema.py.

◆ CONF_RGBW_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_RGBW_ADDRESS = "rgbw_address"
static

Definition at line 622 of file schema.py.

◆ CONF_RGBW_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_RGBW_STATE_ADDRESS = "rgbw_state_address"
static

Definition at line 623 of file schema.py.

◆ CONF_SATURATION_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_SATURATION_ADDRESS = "saturation_address"
static

Definition at line 624 of file schema.py.

◆ CONF_SATURATION_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_SATURATION_STATE_ADDRESS = "saturation_state_address"
static

Definition at line 625 of file schema.py.

◆ CONF_STATE_ADDRESS

homeassistant.components.knx.schema.LightSchema.CONF_STATE_ADDRESS = CONF_STATE_ADDRESS
static

Definition at line 612 of file schema.py.

◆ CONF_WHITE

string homeassistant.components.knx.schema.LightSchema.CONF_WHITE = "white"
static

Definition at line 640 of file schema.py.

◆ CONF_XYY_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_XYY_ADDRESS = "xyy_address"
static

Definition at line 626 of file schema.py.

◆ CONF_XYY_STATE_ADDRESS

string homeassistant.components.knx.schema.LightSchema.CONF_XYY_STATE_ADDRESS = "xyy_state_address"
static

Definition at line 627 of file schema.py.

◆ DEFAULT_COLOR_TEMP_MODE

string homeassistant.components.knx.schema.LightSchema.DEFAULT_COLOR_TEMP_MODE = "absolute"
static

Definition at line 632 of file schema.py.

◆ DEFAULT_MAX_KELVIN

int homeassistant.components.knx.schema.LightSchema.DEFAULT_MAX_KELVIN = 6000
static

Definition at line 634 of file schema.py.

◆ DEFAULT_MIN_KELVIN

int homeassistant.components.knx.schema.LightSchema.DEFAULT_MIN_KELVIN = 2700
static

Definition at line 633 of file schema.py.

◆ DEFAULT_NAME

string homeassistant.components.knx.schema.LightSchema.DEFAULT_NAME = "KNX Light"
static

Definition at line 631 of file schema.py.

◆ ENTITY_SCHEMA

homeassistant.components.knx.schema.LightSchema.ENTITY_SCHEMA
static

Definition at line 662 of file schema.py.

◆ HS_COLOR_SCHEMA

dictionary homeassistant.components.knx.schema.LightSchema.HS_COLOR_SCHEMA
static
Initial value:
= {
vol.Optional(CONF_HUE_ADDRESS): ga_list_validator,
vol.Optional(CONF_HUE_STATE_ADDRESS): ga_list_validator,
vol.Optional(CONF_SATURATION_ADDRESS): ga_list_validator,
vol.Optional(CONF_SATURATION_STATE_ADDRESS): ga_list_validator,
}

Definition at line 646 of file schema.py.

◆ INDIVIDUAL_COLOR_SCHEMA

homeassistant.components.knx.schema.LightSchema.INDIVIDUAL_COLOR_SCHEMA
static
Initial value:
= vol.Schema(
{
vol.Optional(KNX_ADDRESS): ga_list_validator,
vol.Optional(CONF_STATE_ADDRESS): ga_list_validator,
vol.Required(CONF_BRIGHTNESS_ADDRESS): ga_list_validator,
vol.Optional(CONF_BRIGHTNESS_STATE_ADDRESS): ga_list_validator,
}
)

Definition at line 653 of file schema.py.

◆ PLATFORM

homeassistant.components.knx.schema.LightSchema.PLATFORM = Platform.LIGHT
static

Definition at line 610 of file schema.py.


The documentation for this class was generated from the following file: