homeassistant.components.knx.light.KnxYamlLight Class Reference

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

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

Public Member Functions
None	__init__ (self, KNXModule knx_module, ConfigType config)
Public Member Functions inherited from homeassistant.components.knx.light._KnxLight
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_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_write_ha_state (self)
str|None	attribution (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)
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)
Public Member Functions inherited from homeassistant.components.knx.entity.KnxYamlEntity
None	__init__ (self, KNXModule knx_module, XknxDevice device)
Public Member Functions inherited from homeassistant.components.knx.entity._KnxEntityBase
None	after_update_callback (self, XknxDevice _device)
None	async_added_to_hass (self)
None	async_update (self)
None	async_will_remove_from_hass (self)
bool	available (self)
str	name (self)

Private Member Functions
str	_device_unique_id (self)

Private Attributes
	_attr_color_mode
	_attr_entity_category
	_attr_unique_id

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 534 of file light.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.knx.light.KnxYamlLight.__init__	(		self,
		KNXModule	knx_module,
		ConfigType	config
	)

Initialize of KNX light.

Definition at line 539 of file light.py.

Member Function Documentation

_device_unique_id()

str homeassistant.components.knx.light.KnxYamlLight._device_unique_id (   self )

private

Return unique id for this device.

Definition at line 551 of file light.py.

Member Data Documentation

_attr_color_mode

homeassistant.components.knx.light.KnxYamlLight._attr_color_mode

private

Definition at line 545 of file light.py.

_attr_entity_category

homeassistant.components.knx.light.KnxYamlLight._attr_entity_category

private

Definition at line 548 of file light.py.

_attr_unique_id

homeassistant.components.knx.light.KnxYamlLight._attr_unique_id

private

Definition at line 549 of file light.py.

---

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

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