homeassistant.components.light.LightEntity Class Reference

Inherits homeassistant.helpers.entity.ToggleEntity, cached_properties, and CACHED_PROPERTIES_WITH_ATTR_.

Inherited by homeassistant.components.abode.light.AbodeLight, homeassistant.components.ads.light.AdsLight, homeassistant.components.advantage_air.light.AdvantageAirLight, homeassistant.components.advantage_air.light.AdvantageAirThingLight, homeassistant.components.advantage_air.light.AdvantageAirThingLightDimmable, homeassistant.components.avea.light.AveaLight, homeassistant.components.avion.light.AvionLight, homeassistant.components.axis.light.AxisLight, homeassistant.components.baf.light.BAFLight, homeassistant.components.balboa.light.BalboaLightEntity, homeassistant.components.blebox.light.BleBoxLightEntity, homeassistant.components.blinksticklight.light.BlinkStickLight, homeassistant.components.bond.light.BondBaseLight, homeassistant.components.bond.light.BondDownLight, homeassistant.components.bond.light.BondFireplace, homeassistant.components.bond.light.BondLight, homeassistant.components.bond.light.BondUpLight, homeassistant.components.broadlink.light.BroadlinkLight, homeassistant.components.comelit.light.ComelitLightEntity, homeassistant.components.control4.light.Control4Light, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.deako.light.DeakoLightEntity, homeassistant.components.decora.light.DecoraLight, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.demo.light.DemoLight, homeassistant.components.devolo_home_control.light.DevoloLightDeviceEntity, homeassistant.components.duotecno.light.DuotecnoLight, homeassistant.components.dynalite.light.DynaliteLight, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.elkm1.light.ElkLight, homeassistant.components.enocean.light.EnOceanLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.everlights.light.EverLightsLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.ezviz.light.EzvizLight, homeassistant.components.fibaro.light.FibaroLight, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.fjaraskupan.light.Light, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.freedompro.light.Device, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.greenwave.light.GreenwaveLight, homeassistant.components.group.light.LightGroup, homeassistant.components.hive.light.HiveDeviceLight, homeassistant.components.home_connect.light.HomeConnectLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.homematicip_cloud.light.HomematicipDimmer, homeassistant.components.homematicip_cloud.light.HomematicipLight, homeassistant.components.homematicip_cloud.light.HomematicipMultiDimmer, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.hue.v2.group.GroupedHueLight, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.ihc.light.IhcLight, homeassistant.components.insteon.light.InsteonDimmerEntity, homeassistant.components.intellifire.light.IntellifireLight, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.knx.light._KnxLight, homeassistant.components.kulersky.light.KulerskyLight, homeassistant.components.lcn.light.LcnOutputLight, homeassistant.components.lcn.light.LcnRelayLight, homeassistant.components.led_ble.light.LEDBLEEntity, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.lightwave.light.LWRFLight, homeassistant.components.limitlessled.light.LimitlessLEDGroup, homeassistant.components.linear_garage_door.light.LinearLightEntity, homeassistant.components.litejet.light.LiteJetLight, homeassistant.components.lookin.light.LookinLightEntity, homeassistant.components.lutron.light.LutronLight, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.matter.light.MatterLight, homeassistant.components.microbees.light.MBLight, homeassistant.components.mochad.light.MochadLight, homeassistant.components.modbus.light.ModbusLight, homeassistant.components.modern_forms.light.ModernFormsLightEntity, homeassistant.components.mqtt.light.schema_basic.MqttLight, homeassistant.components.mqtt.light.schema_json.MqttLightJson, homeassistant.components.mqtt.light.schema_template.MqttLightTemplate, homeassistant.components.mysensors.light.MySensorsLight, homeassistant.components.mystrom.light.MyStromLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.netatmo.light.NetatmoCameraLight, homeassistant.components.netatmo.light.NetatmoLight, homeassistant.components.nice_go.light.NiceGOLightEntity, homeassistant.components.niko_home_control.light.NikoHomeControlLight, homeassistant.components.opple.light.OppleLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.pilight.light.PilightLight, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.qwikswitch.light.QSLight, homeassistant.components.reolink.light.ReolinkHostLightEntity, homeassistant.components.reolink.light.ReolinkLightEntity, homeassistant.components.rflink.light.DimmableRflinkLight, homeassistant.components.rflink.light.RflinkLight, homeassistant.components.rfxtrx.light.RfxtrxLight, homeassistant.components.ring.light.RingLight, homeassistant.components.screenlogic.light.ScreenLogicLight, homeassistant.components.scsgate.light.SCSGateLight, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.sleepiq.light.SleepIQLightEntity, homeassistant.components.smartthings.light.SmartThingsLight, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.switch.light.LightSwitch, homeassistant.components.switch_as_x.light.LightSwitch, homeassistant.components.switchbee.light.SwitchBeeLightEntity, homeassistant.components.switchbot.light.SwitchbotLightEntity, homeassistant.components.switcher_kis.light.SwitcherBaseLightEntity, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.tellduslive.light.TelldusLiveLight, homeassistant.components.tellstick.light.TellstickLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tikteck.light.TikteckLight, homeassistant.components.tolo.light.ToloLight, homeassistant.components.tplink.light.TPLinkLightEntity, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.unifiled.light.UnifiLedLight, homeassistant.components.unifiprotect.light.ProtectLight, homeassistant.components.upb.light.UpbLight, homeassistant.components.velbus.light.VelbusButtonLight, homeassistant.components.velbus.light.VelbusLight, homeassistant.components.velux.light.VeluxLight, homeassistant.components.vera.light.VeraLight, homeassistant.components.vesync.light.VeSyncBaseLight, homeassistant.components.vesync.light.VeSyncDimmableLightHA, homeassistant.components.vesync.light.VeSyncTunableWhiteLightHA, homeassistant.components.wemo.light.WemoDimmer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.wilight.light.WiLightLightDimmer, homeassistant.components.wilight.light.WiLightLightOnOff, homeassistant.components.wiz.light.WizBulbEntity, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wmspro.light.WebControlProLight, homeassistant.components.x10.light.X10Light, homeassistant.components.xiaomi_aqara.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.yeelightsunflower.light.SunflowerBulb, homeassistant.components.yolink.light.YoLinkDimmerEntity, homeassistant.components.zengge.light.ZenggeLight, homeassistant.components.zerproc.light.ZerprocLight, homeassistant.components.zha.light.Light, homeassistant.components.zwave_js.light.ZwaveLight, and homeassistant.components.zwave_me.light.ZWaveMeRGB.

Collaboration diagram for homeassistant.components.light.LightEntity:

Public Member Functions
int|None	brightness (self)
dict[str, Any]	capability_attributes (self)
ColorMode|str|None	color_mode (self)
int|None	color_temp (self)
int|None	color_temp_kelvin (self)
str|None	effect (self)
list[str]|None	effect_list (self)
tuple[float, float]|None	hs_color (self)
int	max_color_temp_kelvin (self)
int	max_mireds (self)
int	min_color_temp_kelvin (self)
int	min_mireds (self)
tuple[int, int, int]|None	rgb_color (self)
tuple[int, int, int, int]|None	rgbw_color (self)
tuple[int, int, int, int, int]|None	rgbww_color (self)
dict[str, Any]|None	state_attributes (self)
set[ColorMode]|set[str]|None	supported_color_modes (self)
LightEntityFeature	supported_features (self)
LightEntityFeature	supported_features_compat (self)
tuple[float, float]|None	xy_color (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (self, **Any kwargs)
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
bool|None	is_on (self)
Literal["on", "off"]|None	state (self)
None	toggle (self, **Any kwargs)
None	turn_off (self, **Any kwargs)
None	turn_on (self, **Any kwargs)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_added_to_hass (self)
None	async_device_update (self, bool warning=True)
None	async_internal_added_to_hass (self)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
None	async_will_remove_from_hass (self)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
str|None	entity_picture (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)

Static Public Attributes
	int
	LightEntityFeature
	None
Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Private Member Functions
bool	__should_report_light_issue (self)
None	__validate_color_mode (self, ColorMode|str|None color_mode, set[ColorMode]|set[str] supported_color_modes, str|None effect)
None	__validate_supported_color_modes (self, set[ColorMode]|set[str] supported_color_modes)
str	_light_internal_color_mode (self)
dict[str, tuple[float,...]]	_light_internal_convert_color (self, ColorMode|str color_mode)
tuple[int, int, int, int]|None	_light_internal_rgbw_color (self)
set[ColorMode]|set[str]	_light_internal_supported_color_modes (self)

Private Attributes
	__color_mode_reported
	_deprecated_supported_features_reported

Static Private Attributes
bool	__color_mode_reported = False
	_entity_component_unrecorded_attributes

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Base class for light entities.

Definition at line 856 of file __init__.py.

Member Function Documentation

__should_report_light_issue()

bool homeassistant.components.light.LightEntity.__should_report_light_issue (   self )

private

Return if light color mode issues should be reported.

Definition at line 1342 of file __init__.py.

__validate_color_mode()

None homeassistant.components.light.LightEntity.__validate_color_mode (   self, ColorMode | str | None  color_mode, set[ColorMode] | set[str]  supported_color_modes, str | None  effect  )

private

Validate the color mode.

Definition at line 1094 of file __init__.py.

__validate_supported_color_modes()

None homeassistant.components.light.LightEntity.__validate_supported_color_modes (   self, set[ColorMode] | set[str]  supported_color_modes  )

private

Validate the supported color modes.

Definition at line 1157 of file __init__.py.

_light_internal_color_mode()

str homeassistant.components.light.LightEntity._light_internal_color_mode (   self )

private

Return the color mode of the light with backwards compatibility.

Definition at line 914 of file __init__.py.

_light_internal_convert_color()

dict[str, tuple[float, ...]] homeassistant.components.light.LightEntity._light_internal_convert_color (   self, ColorMode | str   color_mode  )

private

Definition at line 1053 of file __init__.py.

_light_internal_rgbw_color()

tuple[int, int, int, int] | None homeassistant.components.light.LightEntity._light_internal_rgbw_color (   self )

private

Return the rgbw color value [int, int, int, int].

Definition at line 967 of file __init__.py.

_light_internal_supported_color_modes()

set[ColorMode] | set[str] homeassistant.components.light.LightEntity._light_internal_supported_color_modes (   self )

private

Calculate supported color modes with backwards compatibility.

Definition at line 1265 of file __init__.py.

brightness()

int | None homeassistant.components.light.LightEntity.brightness

(

self

)

Return the brightness of this light between 0..255.

Reimplemented in homeassistant.components.zwave_me.light.ZWaveMeRGB, homeassistant.components.zwave_js.light.ZwaveColorOnOffLight, homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zha.light.Light, homeassistant.components.yeelightsunflower.light.SunflowerBulb, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsAbstractLight, homeassistant.components.xiaomi_aqara.light.XiaomiGatewayLight, homeassistant.components.x10.light.X10Light, homeassistant.components.wmspro.light.WebControlProDimmer, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.wled.light.WLEDMainLight, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.wilight.light.WiLightLightDimmer, homeassistant.components.wemo.light.WemoDimmer, homeassistant.components.wemo.light.WemoLight, homeassistant.components.vesync.light.VeSyncBaseLight, homeassistant.components.velux.light.VeluxLight, homeassistant.components.velbus.light.VelbusLight, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tellstick.light.TellstickLight, homeassistant.components.tellduslive.light.TelldusLiveLight, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.sisyphus.light.SisyphusLight, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.rflink.light.DimmableRflinkLight, homeassistant.components.reolink.light.ReolinkLightEntity, homeassistant.components.qwikswitch.light.QSLight, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.pilight.light.PilightLight, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.opple.light.OppleLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.modern_forms.light.ModernFormsLightEntity, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.linear_garage_door.light.LinearLightEntity, homeassistant.components.limitlessled.light.LimitlessLEDGroup, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.knx.light._KnxLight, homeassistant.components.isy994.light.ISYLightEntity, homeassistant.components.intellifire.light.IntellifireLight, homeassistant.components.insteon.light.InsteonDimmerEntity, homeassistant.components.ihc.light.IhcLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homeworks.light.HomeworksLight, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematicip_cloud.light.HomematicipMultiDimmer, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.fjaraskupan.light.Light, homeassistant.components.firmata.light.FirmataLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.elkm1.light.ElkLight, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.dynalite.light.DynaliteLight, homeassistant.components.duotecno.light.DuotecnoLight, homeassistant.components.devolo_home_control.light.DevoloLightDeviceEntity, homeassistant.components.demo.light.DemoLight, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.control4.light.Control4Light, homeassistant.components.blebox.light.BleBoxLightEntity, homeassistant.components.axis.light.AxisLight, homeassistant.components.advantage_air.light.AdvantageAirThingLightDimmable, homeassistant.components.advantage_air.light.AdvantageAirLightDimmable, homeassistant.components.ads.light.AdsLight, and homeassistant.components.abode.light.AbodeLight.

Definition at line 904 of file __init__.py.

capability_attributes()

dict[str, Any] homeassistant.components.light.LightEntity.capability_attributes

(

self

)

Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 1023 of file __init__.py.

color_mode()

ColorMode | str | None homeassistant.components.light.LightEntity.color_mode

(

self

)

Return the color mode of the light.

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zha.light.Light, homeassistant.components.zengge.light.ZenggeLight, homeassistant.components.yeelight.light.YeelightColorLightSupport, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsMoonlightLamp, homeassistant.components.wemo.light.WemoLight, homeassistant.components.vera.light.VeraLight, homeassistant.components.upb.light.UpbLight, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.smartthings.light.SmartThingsLight, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.qwikswitch.light.QSLight, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.philips_js.light.PhilipsTVLightEntity, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.mqtt.light.schema_json.MqttLightJson, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.limitlessled.light.LimitlessLEDGroup, homeassistant.components.lifx.light.LIFXColor, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.demo.light.DemoLight, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.blebox.light.BleBoxLightEntity, and homeassistant.components.abode.light.AbodeLight.

Definition at line 909 of file __init__.py.

color_temp()

int | None homeassistant.components.light.LightEntity.color_temp

(

self

)

Return the CT color value in mireds.

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zha.light.Light, homeassistant.components.yeelight.light.YeelightWithoutNightlightSwitchMixIn, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsBulb, homeassistant.components.wemo.light.WemoLight, homeassistant.components.vesync.light.VeSyncTunableWhiteLightHA, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.opple.light.OppleLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.demo.light.DemoLight, homeassistant.components.blebox.light.BleBoxLightEntity, and homeassistant.components.abode.light.AbodeLight.

Definition at line 977 of file __init__.py.

color_temp_kelvin()

int | None homeassistant.components.light.LightEntity.color_temp_kelvin

(

self

)

Return the CT color value in Kelvin.

Reimplemented in homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.shelly.light.RpcShellyCctLight, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.knx.light._KnxLight, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.fritzbox.light.FritzboxLight, and homeassistant.components.esphome.light.EsphomeLight.

Definition at line 982 of file __init__.py.

effect()

str | None homeassistant.components.light.LightEntity.effect

(

self

)

Return the current effect.

Reimplemented in homeassistant.components.zha.light.Light, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lifx.light.LIFXLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.iaqualink.light.HassAqualinkLight, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homematic.light.HMLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.demo.light.DemoLight, and homeassistant.components.blebox.light.BleBoxLightEntity.

Definition at line 1018 of file __init__.py.

effect_list()

list[str] | None homeassistant.components.light.LightEntity.effect_list

(

self

)

Return the list of supported effects.

Reimplemented in homeassistant.components.zha.light.Light, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.twinkly.light.TwinklyLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.smarttub.light.SmartTubLight, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLightV2, homeassistant.components.homematic.light.HMLight, homeassistant.components.demo.light.DemoLight, and homeassistant.components.blebox.light.BleBoxLightEntity.

Definition at line 1013 of file __init__.py.

hs_color()

tuple[float, float] | None homeassistant.components.light.LightEntity.hs_color

(

self

)

Return the hue and saturation color value [float, float].

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.yeelightsunflower.light.SunflowerBulb, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsMoonlightLamp, homeassistant.components.xiaomi_aqara.light.XiaomiGatewayLight, homeassistant.components.wilight.light.WiLightLightColor, homeassistant.components.tuya.light.TuyaLightEntity, homeassistant.components.tradfri.light.TradfriLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.plum_lightpad.light.GlowRing, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.nanoleaf.light.NanoleafLight, homeassistant.components.lw12wifi.light.LW12WiFi, homeassistant.components.lutron_caseta.light.LutronCasetaLight, homeassistant.components.lifx.light.LIFXColor, homeassistant.components.knx.light._KnxLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hyperion.light.HyperionLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homematicip_cloud.light.HomematicipNotificationLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.fritzbox.light.FritzboxLight, homeassistant.components.eufy.light.EufyHomeLight, homeassistant.components.elgato.light.ElgatoLight, homeassistant.components.demo.light.DemoLight, and homeassistant.components.abode.light.AbodeLight.

Definition at line 947 of file __init__.py.

max_color_temp_kelvin()

int homeassistant.components.light.LightEntity.max_color_temp_kelvin

(

self

)

Return the coldest color_temp_kelvin that this light supports.

Definition at line 1006 of file __init__.py.

max_mireds()

int homeassistant.components.light.LightEntity.max_mireds

(

self

)

Return the warmest color_temp that this light supports.

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zha.light.Light, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsMoonlightLamp, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsCeilingLamp, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsBulb, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.opple.light.OppleLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homekit_controller.light.HomeKitLight, and homeassistant.components.eufy.light.EufyHomeLight.

Definition at line 994 of file __init__.py.

min_color_temp_kelvin()

int homeassistant.components.light.LightEntity.min_color_temp_kelvin

(

self

)

Return the warmest color_temp_kelvin that this light supports.

Definition at line 999 of file __init__.py.

min_mireds()

int homeassistant.components.light.LightEntity.min_mireds

(

self

)

Return the coldest color_temp that this light supports.

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.zha.light.Light, homeassistant.components.xiaomi_miio.light.XiaomiGatewayBulb, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsMoonlightLamp, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsCeilingLamp, homeassistant.components.xiaomi_miio.light.XiaomiPhilipsBulb, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.osramlightify.light.Luminary, homeassistant.components.opple.light.OppleLight, homeassistant.components.iglo.light.IGloLamp, homeassistant.components.hue.v2.light.HueLight, homeassistant.components.hue.v1.light.HueLight, homeassistant.components.homekit_controller.light.HomeKitLight, and homeassistant.components.eufy.light.EufyHomeLight.

Definition at line 989 of file __init__.py.

rgb_color()

tuple[int, int, int] | None homeassistant.components.light.LightEntity.rgb_color

(

self

)

Return the rgb color value [int, int, int].

Reimplemented in homeassistant.components.zwave_me.light.ZWaveMeRGB, homeassistant.components.yeelight.light.YeelightBaseLight, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.skybell.light.SkybellLight, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.overkiz.light.OverkizLight, homeassistant.components.knx.light._KnxLight, homeassistant.components.govee_light_local.light.GoveeLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.evil_genius_labs.light.EvilGeniusLight, homeassistant.components.esphome.light.EsphomeLight, and homeassistant.components.blebox.light.BleBoxLightEntity.

Definition at line 957 of file __init__.py.

rgbw_color()

tuple[int, int, int, int] | None homeassistant.components.light.LightEntity.rgbw_color

(

self

)

Return the rgbw color value [int, int, int, int].

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.wled.light.WLEDSegmentLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.shelly.light.RpcShellyLightBase, homeassistant.components.shelly.light.BlockShellyLight, homeassistant.components.knx.light._KnxLight, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.demo.light.DemoLight, and homeassistant.components.blebox.light.BleBoxLightEntity.

Definition at line 962 of file __init__.py.

rgbww_color()

tuple[int, int, int, int, int] | None homeassistant.components.light.LightEntity.rgbww_color

(

self

)

Return the rgbww color value [int, int, int, int, int].

Reimplemented in homeassistant.components.template.light.LightTemplate, homeassistant.components.flux_led.light.FluxLight, homeassistant.components.esphome.light.EsphomeLight, homeassistant.components.demo.light.DemoLight, and homeassistant.components.blebox.light.BleBoxLightEntity.

Definition at line 972 of file __init__.py.

state_attributes()

dict[str, Any] | None homeassistant.components.light.LightEntity.state_attributes

(

self

)

Return state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 1185 of file __init__.py.

supported_color_modes()

set[ColorMode] | set[str] | None homeassistant.components.light.LightEntity.supported_color_modes

(

self

)

Flag supported color modes.

Reimplemented in homeassistant.components.zwave_js.light.ZwaveLight, homeassistant.components.wemo.light.WemoLight, homeassistant.components.vera.light.VeraLight, homeassistant.components.upb.light.UpbLight, homeassistant.components.template.light.LightTemplate, homeassistant.components.tasmota.light.TasmotaLight, homeassistant.components.qwikswitch.light.QSLight, homeassistant.components.plum_lightpad.light.PlumLight, homeassistant.components.lifx.light.LIFXColor, homeassistant.components.knx.light._KnxLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.homekit_controller.light.HomeKitLight, homeassistant.components.futurenow.light.FutureNowLight, homeassistant.components.demo.light.DemoLight, homeassistant.components.decora_wifi.light.DecoraWifiLight, homeassistant.components.crownstone.light.CrownstoneLightEntity, homeassistant.components.blebox.light.BleBoxLightEntity, and homeassistant.components.abode.light.AbodeLight.

Definition at line 1302 of file __init__.py.

supported_features()

LightEntityFeature homeassistant.components.light.LightEntity.supported_features

(

self

)

Flag supported features.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.yeelight.light.YeelightNightLightMode, homeassistant.components.upb.light.UpbLight, homeassistant.components.homematic.light.HMLight, homeassistant.components.decora_wifi.light.DecoraWifiLight, and homeassistant.components.control4.light.Control4Light.

Definition at line 1307 of file __init__.py.

supported_features_compat()

LightEntityFeature homeassistant.components.light.LightEntity.supported_features_compat

(

self

)

Return the supported features as LightEntityFeature.

Remove this compatibility shim in 2025.1 or later.

Definition at line 1312 of file __init__.py.

xy_color()

tuple[float, float] | None homeassistant.components.light.LightEntity.xy_color

(

self

)

Return the xy color value [float, float].

Reimplemented in homeassistant.components.zha.light.Light, homeassistant.components.wemo.light.WemoLight, homeassistant.components.knx.light._KnxLight, and homeassistant.components.hue.v2.light.HueLight.

Definition at line 952 of file __init__.py.

Member Data Documentation

__color_mode_reported [1/2]

bool homeassistant.components.light.LightEntity.__color_mode_reported = False

staticprivate

Definition at line 901 of file __init__.py.

__color_mode_reported [2/2]

homeassistant.components.light.LightEntity.__color_mode_reported

private

Definition at line 920 of file __init__.py.

_deprecated_supported_features_reported

homeassistant.components.light.LightEntity._deprecated_supported_features_reported

private

Definition at line 1323 of file __init__.py.

_entity_component_unrecorded_attributes

homeassistant.components.light.LightEntity._entity_component_unrecorded_attributes

staticprivate

Initial value:

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

Definition at line 859 of file __init__.py.

int

homeassistant.components.light.LightEntity.int

static

Definition at line 892 of file __init__.py.

LightEntityFeature

homeassistant.components.light.LightEntity.LightEntityFeature

static

Definition at line 898 of file __init__.py.

None

homeassistant.components.light.LightEntity.None

static

Definition at line 881 of file __init__.py.

---

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

• core/homeassistant/components/light/__init__.py