Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tasmota.entity.TasmotaOnOffEntity Class Reference
Inheritance diagram for homeassistant.components.tasmota.entity.TasmotaOnOffEntity:
[legend]
Collaboration diagram for homeassistant.components.tasmota.entity.TasmotaOnOffEntity:
[legend]

Public Member Functions

None __init__ (self, **Any kwds)
 
None async_added_to_hass (self)
 
bool is_on (self)
 
None state_updated (self, bool state, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.tasmota.entity.TasmotaEntity
None __init__ (self, HATasmotaEntity tasmota_entity)
 
None async_will_remove_from_hass (self)
 
None discovery_update (self, TasmotaEntityConfig update, bool write_state=True)
 
str|None name (self)
 
bool should_poll (self)
 
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_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (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)
 
StateType state (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)
 

Private Attributes

 _on_off_state
 

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
 

Detailed Description

Base class for Tasmota entities which can be on or off.

Definition at line 84 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tasmota.entity.TasmotaOnOffEntity.__init__ (   self,
**Any  kwds 
)
Initialize.

Reimplemented in homeassistant.components.tasmota.light.TasmotaLight.

Definition at line 87 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.tasmota.entity.TasmotaOnOffEntity.async_added_to_hass (   self)
Subscribe to MQTT events.

Reimplemented from homeassistant.components.tasmota.entity.TasmotaEntity.

Definition at line 92 of file entity.py.

◆ is_on()

bool homeassistant.components.tasmota.entity.TasmotaOnOffEntity.is_on (   self)
Return true if device is on.

Definition at line 104 of file entity.py.

◆ state_updated()

None homeassistant.components.tasmota.entity.TasmotaOnOffEntity.state_updated (   self,
bool  state,
**Any  kwargs 
)
Handle state updates.

Reimplemented in homeassistant.components.tasmota.light.TasmotaLight.

Definition at line 98 of file entity.py.

Member Data Documentation

◆ _on_off_state

homeassistant.components.tasmota.entity.TasmotaOnOffEntity._on_off_state
private

Definition at line 100 of file entity.py.


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