Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight Class Reference
Inheritance diagram for homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight:
[legend]
Collaboration diagram for homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight:
[legend]

Public Member Functions

def __init__ (self, gateway_device, gateway_name, gateway_device_id)
 
None async_update (self)
 
def available (self)
 
def brightness (self)
 
DeviceInfo device_info (self)
 
def hs_color (self)
 
def is_on (self)
 
def name (self)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
def unique_id (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)
 
int|None color_temp_kelvin (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]|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)
 
Literal["on", "off"]|None state (self)
 
None toggle (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)
 
str|None device_class (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, strtranslation_placeholders (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

 _available
 
 _brightness_pct
 
 _gateway
 
 _gateway_device_id
 
 _hs
 
 _is_on
 
 _name
 
 _rgb
 
 _unique_id
 

Static Private Attributes

 _attr_color_mode = ColorMode.HS
 
dictionary _attr_supported_color_modes = {ColorMode.HS}
 

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 gateway device's light.

Definition at line 959 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.__init__ (   self,
  gateway_device,
  gateway_name,
  gateway_device_id 
)
Initialize the XiaomiGatewayLight.

Definition at line 965 of file light.py.

Member Function Documentation

◆ async_update()

None homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.async_update (   self)
Fetch state from the device.

Definition at line 1035 of file light.py.

◆ available()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.available (   self)
Return true when state is known.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 995 of file light.py.

◆ brightness()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.brightness (   self)
Return the brightness of this light between 0..255.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 1005 of file light.py.

◆ device_info()

DeviceInfo homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.device_info (   self)
Return the device info of the gateway.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 983 of file light.py.

◆ hs_color()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.hs_color (   self)
Return the hs color value.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 1010 of file light.py.

◆ is_on()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.is_on (   self)
Return true if it is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 1000 of file light.py.

◆ name()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.name (   self)
Return the name of this entity, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 990 of file light.py.

◆ turn_off()

None homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.turn_off (   self,
**Any  kwargs 
)
Turn the light off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 1030 of file light.py.

◆ turn_on()

None homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.turn_on (   self,
**Any  kwargs 
)
Turn the light on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 1014 of file light.py.

◆ unique_id()

def homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight.unique_id (   self)
Return an unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 978 of file light.py.

Member Data Documentation

◆ _attr_color_mode

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._attr_color_mode = ColorMode.HS
staticprivate

Definition at line 962 of file light.py.

◆ _attr_supported_color_modes

dictionary homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._attr_supported_color_modes = {ColorMode.HS}
staticprivate

Definition at line 963 of file light.py.

◆ _available

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._available
private

Definition at line 971 of file light.py.

◆ _brightness_pct

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._brightness_pct
private

Definition at line 973 of file light.py.

◆ _gateway

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._gateway
private

Definition at line 967 of file light.py.

◆ _gateway_device_id

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._gateway_device_id
private

Definition at line 969 of file light.py.

◆ _hs

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._hs
private

Definition at line 975 of file light.py.

◆ _is_on

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._is_on
private

Definition at line 972 of file light.py.

◆ _name

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._name
private

Definition at line 968 of file light.py.

◆ _rgb

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._rgb
private

Definition at line 974 of file light.py.

◆ _unique_id

homeassistant.components.xiaomi_miio.light.XiaomiGatewayLight._unique_id
private

Definition at line 970 of file light.py.


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