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

Public Member Functions

None __init__ (self, CustomerDevice device, Manager device_manager)
 
None async_added_to_hass (self)
 
bool available (self)
 
DeviceInfo device_info (self)
 
DPCode|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False)
 
DPCode|EnumTypeData|IntegerTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, DPType|None dptype=None)
 
EnumTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, Literal[DPType.ENUM] dptype)
 
IntegerTypeData|None find_dpcode (self, str|DPCode|tuple[DPCode,...]|None dpcodes, *bool prefer_function=False, Literal[DPType.INTEGER] dptype)
 
DPType|None get_dptype (self, DPCode|None dpcode, bool prefer_function=False)
 
- 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)
 
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)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
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 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 Attributes

 device
 
 device_manager
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _handle_state_update (self, list[str]|None updated_status_properties)
 
None _send_command (self, list[dict[str, Any]] commands)
 

Private Attributes

 _attr_unique_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Tuya base device.

Definition at line 144 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tuya.entity.TuyaEntity.__init__ (   self,
CustomerDevice  device,
Manager  device_manager 
)

Member Function Documentation

◆ _handle_state_update()

None homeassistant.components.tuya.entity.TuyaEntity._handle_state_update (   self,
list[str] | None   updated_status_properties 
)
private

Definition at line 290 of file entity.py.

◆ _send_command()

None homeassistant.components.tuya.entity.TuyaEntity._send_command (   self,
list[dict[str, Any]]  commands 
)
private
Send command to the device.

Definition at line 295 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.tuya.entity.TuyaEntity.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.tuya.climate.TuyaClimateEntity.

Definition at line 280 of file entity.py.

◆ available()

bool homeassistant.components.tuya.entity.TuyaEntity.available (   self)
Return if the device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 170 of file entity.py.

◆ device_info()

DeviceInfo homeassistant.components.tuya.entity.TuyaEntity.device_info (   self)
Return a device description for device registry.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 159 of file entity.py.

◆ find_dpcode() [1/4]

DPCode | None homeassistant.components.tuya.entity.TuyaEntity.find_dpcode (   self,
str | DPCode | tuple[DPCode, ...] | None  dpcodes,
*bool   prefer_function = False 
)

Definition at line 193 of file entity.py.

◆ find_dpcode() [2/4]

DPCode | EnumTypeData | IntegerTypeData | None homeassistant.components.tuya.entity.TuyaEntity.find_dpcode (   self,
str | DPCode | tuple[DPCode, ...] | None  dpcodes,
*bool   prefer_function = False,
DPType | None   dptype = None 
)
Find a matching DP code available on for this device.

Definition at line 200 of file entity.py.

◆ find_dpcode() [3/4]

EnumTypeData | None homeassistant.components.tuya.entity.TuyaEntity.find_dpcode (   self,
str | DPCode | tuple[DPCode, ...] | None  dpcodes,
*bool   prefer_function = False,
Literal[DPType.ENUM dptype 
)

Definition at line 175 of file entity.py.

◆ find_dpcode() [4/4]

IntegerTypeData | None homeassistant.components.tuya.entity.TuyaEntity.find_dpcode (   self,
str | DPCode | tuple[DPCode, ...] | None  dpcodes,
*bool   prefer_function = False,
Literal[DPType.INTEGER dptype 
)

Definition at line 184 of file entity.py.

◆ get_dptype()

DPType | None homeassistant.components.tuya.entity.TuyaEntity.get_dptype (   self,
DPCode | None  dpcode,
bool   prefer_function = False 
)
Find a matching DPCode data type available on for this device.

Definition at line 258 of file entity.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.tuya.entity.TuyaEntity._attr_has_entity_name = True
staticprivate

Definition at line 147 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.tuya.entity.TuyaEntity._attr_should_poll = False
staticprivate

Definition at line 148 of file entity.py.

◆ _attr_unique_id

homeassistant.components.tuya.entity.TuyaEntity._attr_unique_id
private

Definition at line 152 of file entity.py.

◆ device

homeassistant.components.tuya.entity.TuyaEntity.device

Definition at line 155 of file entity.py.

◆ device_manager

homeassistant.components.tuya.entity.TuyaEntity.device_manager

Definition at line 156 of file entity.py.


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