Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch Class Reference
Inheritance diagram for homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch:
[legend]
Collaboration diagram for homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch:
[legend]

Public Member Functions

def __init__ (self, device, name, data_key, supports_power_consumption, xiaomi_hub, config_entry)
 
def extra_state_attributes (self)
 
def icon (self)
 
def is_on (self)
 
def parse_data (self, data, raw_data)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.xiaomi_aqara.entity.XiaomiDevice
def __init__ (self, device, device_type, xiaomi_hub, config_entry)
 
def async_added_to_hass (self)
 
None async_push_data (self, dict[str, Any] data, dict[Any, Any] raw_data)
 
def available (self)
 
def device_id (self)
 
DeviceInfo device_info (self)
 
def name (self)
 
def parse_voltage (self, data)
 
None push_data (self, dict[str, Any] data, dict[Any, Any] raw_data)
 
str unique_id (self)
 
- 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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (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)
 
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)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 
- Public Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (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)
 

Private Attributes

 _attr_should_poll
 
 _data_key
 
 _in_use
 
 _load_power
 
 _power_consumed
 
 _state
 
 _supports_power_consumption
 

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.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Representation of a XiaomiPlug.

Definition at line 136 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.__init__ (   self,
  device,
  name,
  data_key,
  supports_power_consumption,
  xiaomi_hub,
  config_entry 
)
Initialize the XiaomiPlug.

Definition at line 139 of file switch.py.

Member Function Documentation

◆ extra_state_attributes()

def homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.components.xiaomi_aqara.entity.XiaomiDevice.

Definition at line 171 of file switch.py.

◆ icon()

def homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.icon (   self)
Return the icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 159 of file switch.py.

◆ is_on()

def homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.is_on (   self)
Return true if it is on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 166 of file switch.py.

◆ parse_data()

def homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.parse_data (   self,
  data,
  raw_data 
)
Parse data sent by gateway.

Reimplemented from homeassistant.components.xiaomi_aqara.entity.XiaomiDevice.

Definition at line 196 of file switch.py.

◆ turn_off()

None homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.turn_off (   self,
**Any  kwargs 
)
Turn the switch off.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 190 of file switch.py.

◆ turn_on()

None homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.turn_on (   self,
**Any  kwargs 
)
Turn the switch on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 184 of file switch.py.

◆ update()

None homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch.update (   self)
Get data from hub.

Definition at line 221 of file switch.py.

Member Data Documentation

◆ _attr_should_poll

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._attr_should_poll
private

Definition at line 155 of file switch.py.

◆ _data_key

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._data_key
private

Definition at line 149 of file switch.py.

◆ _in_use

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._in_use
private

Definition at line 150 of file switch.py.

◆ _load_power

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._load_power
private

Definition at line 151 of file switch.py.

◆ _power_consumed

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._power_consumed
private

Definition at line 152 of file switch.py.

◆ _state

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._state
private

Definition at line 187 of file switch.py.

◆ _supports_power_consumption

homeassistant.components.xiaomi_aqara.switch.XiaomiGenericSwitch._supports_power_consumption
private

Definition at line 153 of file switch.py.


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