homeassistant.components.knx.light._KnxLight Class Reference

Inheritance diagram for homeassistant.components.knx.light._KnxLight:

Collaboration diagram for homeassistant.components.knx.light._KnxLight:

Public Member Functions
None	async_turn_off (self, **Any kwargs)
None	async_turn_on (self, **Any kwargs)
int|None	brightness (self)
int|None	color_temp_kelvin (self)
tuple[float, float]|None	hs_color (self)
bool	is_on (self)
tuple[int, int, int]|None	rgb_color (self)
tuple[int, int, int, int]|None	rgbw_color (self)
set[ColorMode]	supported_color_modes (self)
tuple[float, float]|None	xy_color (self)
Public Member Functions inherited from homeassistant.components.light.LightEntity
dict[str, Any]	capability_attributes (self)
ColorMode|str|None	color_mode (self)
int|None	color_temp (self)
str|None	effect (self)
list[str]|None	effect_list (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, int, int]|None	rgbww_color (self)
dict[str, Any]|None	state_attributes (self)
LightEntityFeature	supported_features (self)
LightEntityFeature	supported_features_compat (self)
Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None	async_toggle (self, **Any kwargs)
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)

Private Attributes
	_attr_color_mode

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Static Public Attributes inherited from homeassistant.components.light.LightEntity
	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

Detailed Description

Representation of a KNX light.

Definition at line 301 of file light.py.

Member Function Documentation

async_turn_off()

None homeassistant.components.knx.light._KnxLight.async_turn_off	(		self,
		**Any	kwargs
	)

Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 529 of file light.py.

async_turn_on()

None homeassistant.components.knx.light._KnxLight.async_turn_on	(		self,
		**Any	kwargs
	)

Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 419 of file light.py.

brightness()

int | None homeassistant.components.knx.light._KnxLight.brightness

(

self

)

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 314 of file light.py.

color_temp_kelvin()

int | None homeassistant.components.knx.light._KnxLight.color_temp_kelvin

(

self

)

Return the color temperature in Kelvin.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 373 of file light.py.

hs_color()

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

(

self

)

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 359 of file light.py.

is_on()

bool homeassistant.components.knx.light._KnxLight.is_on

(

self

)

Return true if light is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 309 of file light.py.

rgb_color()

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

(

self

)

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 330 of file light.py.

rgbw_color()

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

(

self

)

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

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 344 of file light.py.

supported_color_modes()

set[ColorMode] homeassistant.components.knx.light._KnxLight.supported_color_modes

(

self

)

Get supported color modes.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 394 of file light.py.

xy_color()

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

(

self

)

Return the xy color value [float, float].

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 366 of file light.py.

Member Data Documentation

_attr_color_mode

homeassistant.components.knx.light._KnxLight._attr_color_mode

private

Definition at line 425 of file light.py.

---

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

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