Home Assistant Unofficial Reference 2024.12.1
__init__.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.light.ColorMode
 
class  homeassistant.components.light.LightEntity
 
class  homeassistant.components.light.LightEntityDescription
 
class  homeassistant.components.light.LightEntityFeature
 
class  homeassistant.components.light.Profile
 
class  homeassistant.components.light.Profiles
 

Namespaces

 homeassistant.components.light
 

Functions

None homeassistant.components.light._coerce_none (str value)
 
bool homeassistant.components.light.async_setup (HomeAssistant hass, ConfigType config)
 
bool homeassistant.components.light.async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool homeassistant.components.light.async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
bool homeassistant.components.light.brightness_supported (Iterable[ColorMode|str]|None color_modes)
 
bool homeassistant.components.light.color_supported (Iterable[ColorMode|str]|None color_modes)
 
bool homeassistant.components.light.color_temp_supported (Iterable[ColorMode|str]|None color_modes)
 
set[ColorMode] homeassistant.components.light.filter_supported_color_modes (Iterable[ColorMode] color_modes)
 
dict[str, Any] homeassistant.components.light.filter_turn_off_params (LightEntity light, dict[str, Any] params)
 
dict[str, Any] homeassistant.components.light.filter_turn_on_params (LightEntity light, dict[str, Any] params)
 
set[str]|None homeassistant.components.light.get_supported_color_modes (HomeAssistant hass, str entity_id)
 
bool homeassistant.components.light.is_on (HomeAssistant hass, str entity_id)
 
None homeassistant.components.light.preprocess_turn_on_alternatives (HomeAssistant hass, dict[str, Any] params)
 
set[ColorMode|str] homeassistant.components.light.valid_supported_color_modes (Iterable[ColorMode|str] color_modes)
 

Variables

 homeassistant.components.light._LOGGER = logging.getLogger(__name__)
 
string homeassistant.components.light.ATTR_BRIGHTNESS = "brightness"
 
string homeassistant.components.light.ATTR_BRIGHTNESS_PCT = "brightness_pct"
 
string homeassistant.components.light.ATTR_BRIGHTNESS_STEP = "brightness_step"
 
string homeassistant.components.light.ATTR_BRIGHTNESS_STEP_PCT = "brightness_step_pct"
 
string homeassistant.components.light.ATTR_COLOR_MODE = "color_mode"
 
string homeassistant.components.light.ATTR_COLOR_NAME = "color_name"
 
string homeassistant.components.light.ATTR_COLOR_TEMP = "color_temp"
 
string homeassistant.components.light.ATTR_COLOR_TEMP_KELVIN = "color_temp_kelvin"
 
string homeassistant.components.light.ATTR_EFFECT = "effect"
 
string homeassistant.components.light.ATTR_EFFECT_LIST = "effect_list"
 
string homeassistant.components.light.ATTR_FLASH = "flash"
 
string homeassistant.components.light.ATTR_HS_COLOR = "hs_color"
 
string homeassistant.components.light.ATTR_KELVIN = "kelvin"
 
string homeassistant.components.light.ATTR_MAX_COLOR_TEMP_KELVIN = "max_color_temp_kelvin"
 
string homeassistant.components.light.ATTR_MAX_MIREDS = "max_mireds"
 
string homeassistant.components.light.ATTR_MIN_COLOR_TEMP_KELVIN = "min_color_temp_kelvin"
 
string homeassistant.components.light.ATTR_MIN_MIREDS = "min_mireds"
 
string homeassistant.components.light.ATTR_PROFILE = "profile"
 
string homeassistant.components.light.ATTR_RGB_COLOR = "rgb_color"
 
string homeassistant.components.light.ATTR_RGBW_COLOR = "rgbw_color"
 
string homeassistant.components.light.ATTR_RGBWW_COLOR = "rgbww_color"
 
string homeassistant.components.light.ATTR_SUPPORTED_COLOR_MODES = "supported_color_modes"
 
string homeassistant.components.light.ATTR_TRANSITION = "transition"
 
string homeassistant.components.light.ATTR_WHITE = "white"
 
string homeassistant.components.light.ATTR_XY_COLOR = "xy_color"
 
dictionary homeassistant.components.light.CACHED_PROPERTIES_WITH_ATTR_
 
string homeassistant.components.light.COLOR_GROUP = "Color descriptors"
 
string homeassistant.components.light.COLOR_MODE_BRIGHTNESS = "brightness"
 
string homeassistant.components.light.COLOR_MODE_COLOR_TEMP = "color_temp"
 
string homeassistant.components.light.COLOR_MODE_HS = "hs"
 
string homeassistant.components.light.COLOR_MODE_ONOFF = "onoff"
 
string homeassistant.components.light.COLOR_MODE_RGB = "rgb"
 
string homeassistant.components.light.COLOR_MODE_RGBW = "rgbw"
 
string homeassistant.components.light.COLOR_MODE_RGBWW = "rgbww"
 
string homeassistant.components.light.COLOR_MODE_UNKNOWN = "unknown"
 
string homeassistant.components.light.COLOR_MODE_WHITE = "white"
 
string homeassistant.components.light.COLOR_MODE_XY = "xy"
 
dictionary homeassistant.components.light.COLOR_MODES_BRIGHTNESS = VALID_COLOR_MODES - {ColorMode.ONOFF}
 
dictionary homeassistant.components.light.COLOR_MODES_COLOR
 
string homeassistant.components.light.DOMAIN = "light"
 
string homeassistant.components.light.EFFECT_COLORLOOP = "colorloop"
 
string homeassistant.components.light.EFFECT_OFF = "off"
 
string homeassistant.components.light.EFFECT_RANDOM = "random"
 
string homeassistant.components.light.EFFECT_WHITE = "white"
 
string homeassistant.components.light.ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
string homeassistant.components.light.FLASH_LONG = "long"
 
string homeassistant.components.light.FLASH_SHORT = "short"
 
string homeassistant.components.light.LIGHT_PROFILES_FILE = "light_profiles.csv"
 
 homeassistant.components.light.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
 
 homeassistant.components.light.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
 
 homeassistant.components.light.SCAN_INTERVAL = timedelta(seconds=30)
 
int homeassistant.components.light.SUPPORT_BRIGHTNESS = 1
 
int homeassistant.components.light.SUPPORT_COLOR = 16
 
int homeassistant.components.light.SUPPORT_COLOR_TEMP = 2
 
int homeassistant.components.light.SUPPORT_EFFECT = 4
 
int homeassistant.components.light.SUPPORT_FLASH = 8
 
int homeassistant.components.light.SUPPORT_TRANSITION = 32
 
 homeassistant.components.light.VALID_BRIGHTNESS = vol.All(vol.Coerce(int), vol.Clamp(min=0, max=255))
 
 homeassistant.components.light.VALID_BRIGHTNESS_PCT = vol.All(vol.Coerce(float), vol.Range(min=0, max=100))
 
 homeassistant.components.light.VALID_BRIGHTNESS_STEP = vol.All(vol.Coerce(int), vol.Clamp(min=-255, max=255))
 
 homeassistant.components.light.VALID_BRIGHTNESS_STEP_PCT = vol.All(vol.Coerce(float), vol.Clamp(min=-100, max=100))
 
dictionary homeassistant.components.light.VALID_COLOR_MODES
 
 homeassistant.components.light.VALID_FLASH = vol.In([FLASH_SHORT, FLASH_LONG])
 
 homeassistant.components.light.VALID_TRANSITION = vol.All(vol.Coerce(float), vol.Clamp(min=0, max=6553))
 
 homeassistant.components.light.VolDictType