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

Public Member Functions

None __init__ (self, CustomerDevice device, Manager device_manager)
 
int|None battery_level (self)
 
str|None fan_speed (self)
 
None locate (self, **Any kwargs)
 
None pause (self, **Any kwargs)
 
None return_to_base (self, **Any kwargs)
 
None send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None set_fan_speed (self, str fan_speed, **Any kwargs)
 
None start (self, **Any kwargs)
 
str|None state (self)
 
None stop (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.tuya.entity.TuyaEntity
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)
 
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)
 
str|None suggested_object_id (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 Member Functions inherited from homeassistant.components.vacuum.StateVacuumEntity
None async_clean_spot (self, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
None async_pause (self)
 
None async_return_to_base (self, **Any kwargs)
 
None async_send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None async_set_fan_speed (self, str fan_speed, **Any kwargs)
 
None async_start (self)
 
None async_stop (self, **Any kwargs)
 
str battery_icon (self)
 
dict[str, Any]|None capability_attributes (self)
 
None clean_spot (self, **Any kwargs)
 
list[strfan_speed_list (self)
 
None pause (self)
 
None start (self)
 
dict[str, Any] state_attributes (self)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Static Public Attributes

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

Private Attributes

 _attr_fan_speed_list
 
 _attr_supported_features
 
 _battery_level
 
 _fan_speed
 

Static Private Attributes

 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.tuya.entity.TuyaEntity
 device
 
 device_manager
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 state
 

Detailed Description

Tuya Vacuum Device.

Definition at line 76 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.__init__ (   self,
CustomerDevice  device,
Manager  device_manager 
)
Init Tuya vacuum.

Reimplemented from homeassistant.components.tuya.entity.TuyaEntity.

Definition at line 83 of file vacuum.py.

Member Function Documentation

◆ battery_level()

int | None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.battery_level (   self)
Return Tuya device state.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 126 of file vacuum.py.

◆ fan_speed()

str | None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.fan_speed (   self)
Return the fan speed of the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 135 of file vacuum.py.

◆ locate()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.locate (   self,
**Any  kwargs 
)
Locate the device.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 171 of file vacuum.py.

◆ pause()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.pause (   self,
**Any  kwargs 
)
Pause the device.

Definition at line 158 of file vacuum.py.

◆ return_to_base()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.return_to_base (   self,
**Any  kwargs 
)
Return device to dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 162 of file vacuum.py.

◆ send_command()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.send_command (   self,
str  command,
dict[str, Any] | list[Any] | None   params = None,
**Any  kwargs 
)
Send raw command.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 179 of file vacuum.py.

◆ set_fan_speed()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 175 of file vacuum.py.

◆ start()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.start (   self,
**Any  kwargs 
)
Start the device.

Definition at line 150 of file vacuum.py.

◆ state()

str | None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.state (   self)
Return Tuya vacuum device state.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 140 of file vacuum.py.

◆ stop()

None homeassistant.components.tuya.vacuum.TuyaVacuumEntity.stop (   self,
**Any  kwargs 
)
Stop the device.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 154 of file vacuum.py.

Member Data Documentation

◆ _attr_fan_speed_list

homeassistant.components.tuya.vacuum.TuyaVacuumEntity._attr_fan_speed_list
private

Definition at line 87 of file vacuum.py.

◆ _attr_name

homeassistant.components.tuya.vacuum.TuyaVacuumEntity._attr_name = None
staticprivate

Definition at line 81 of file vacuum.py.

◆ _attr_supported_features

homeassistant.components.tuya.vacuum.TuyaVacuumEntity._attr_supported_features
private

Definition at line 89 of file vacuum.py.

◆ _battery_level

homeassistant.components.tuya.vacuum.TuyaVacuumEntity._battery_level
private

Definition at line 123 of file vacuum.py.

◆ _fan_speed

homeassistant.components.tuya.vacuum.TuyaVacuumEntity._fan_speed
private

Definition at line 117 of file vacuum.py.

◆ None

homeassistant.components.tuya.vacuum.TuyaVacuumEntity.None
static

Definition at line 79 of file vacuum.py.


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