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

Public Member Functions

None async_locate (self, **Any kwargs)
 
None async_pause (self)
 
None async_return_to_base (self, **Any kwargs)
 
None async_start (self)
 
None async_stop (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.matter.entity.MatterEntity
None __init__ (self, MatterClient matter_client, MatterEndpoint endpoint, MatterEntityInfo entity_info)
 
None async_added_to_hass (self)
 
str get_matter_attribute_path (self, type[ClusterAttributeDescriptor] attribute)
 
Any get_matter_attribute_value (self, type[ClusterAttributeDescriptor] attribute, bool null_as_none=True)
 
str|UndefinedType|None name (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)
 
bool available (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)
 
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_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)
 
str battery_icon (self)
 
int|None battery_level (self)
 
dict[str, Any]|None capability_attributes (self)
 
None clean_spot (self, **Any kwargs)
 
str|None fan_speed (self)
 
list[strfan_speed_list (self)
 
None locate (self, **Any kwargs)
 
None pause (self)
 
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)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop (self, **Any kwargs)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 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 Member Functions

None _calculate_features (self)
 
None _send_device_command (self, clusters.ClusterCommand command)
 
None _update_from_device (self)
 

Private Attributes

 _attr_battery_level
 
 _attr_state
 
 _attr_supported_features
 
 _last_accepted_commands
 
 _supported_run_modes
 

Static Private Attributes

string _platform_translation_key = "vacuum"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.matter.entity.MatterEntity
 entity_description
 
 matter_client
 
- 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

Representation of a Matter Vacuum cleaner entity.

Definition at line 63 of file vacuum.py.

Member Function Documentation

◆ _calculate_features()

None homeassistant.components.matter.vacuum.MatterVacuum._calculate_features (   self)
private
Calculate features for HA Vacuum platform.

Definition at line 151 of file vacuum.py.

◆ _send_device_command()

None homeassistant.components.matter.vacuum.MatterVacuum._send_device_command (   self,
clusters.ClusterCommand  command 
)
private
Send a command to the device.

Definition at line 103 of file vacuum.py.

◆ _update_from_device()

None homeassistant.components.matter.vacuum.MatterVacuum._update_from_device (   self)
private
Update from device.

Reimplemented from homeassistant.components.matter.entity.MatterEntity.

Definition at line 115 of file vacuum.py.

◆ async_locate()

None homeassistant.components.matter.vacuum.MatterVacuum.async_locate (   self,
**Any  kwargs 
)
Locate the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 81 of file vacuum.py.

◆ async_pause()

None homeassistant.components.matter.vacuum.MatterVacuum.async_pause (   self)
Pause the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 99 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.matter.vacuum.MatterVacuum.async_return_to_base (   self,
**Any  kwargs 
)
Set the vacuum cleaner to return to the dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 77 of file vacuum.py.

◆ async_start()

None homeassistant.components.matter.vacuum.MatterVacuum.async_start (   self)
Start or resume the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 85 of file vacuum.py.

◆ async_stop()

None homeassistant.components.matter.vacuum.MatterVacuum.async_stop (   self,
**Any  kwargs 
)
Stop the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 73 of file vacuum.py.

Member Data Documentation

◆ _attr_battery_level

homeassistant.components.matter.vacuum.MatterVacuum._attr_battery_level
private

Definition at line 120 of file vacuum.py.

◆ _attr_state

homeassistant.components.matter.vacuum.MatterVacuum._attr_state
private

Definition at line 148 of file vacuum.py.

◆ _attr_supported_features

homeassistant.components.matter.vacuum.MatterVacuum._attr_supported_features
private

Definition at line 205 of file vacuum.py.

◆ _last_accepted_commands

homeassistant.components.matter.vacuum.MatterVacuum._last_accepted_commands
private

Definition at line 157 of file vacuum.py.

◆ _platform_translation_key

string homeassistant.components.matter.vacuum.MatterVacuum._platform_translation_key = "vacuum"
staticprivate

Definition at line 71 of file vacuum.py.

◆ _supported_run_modes

homeassistant.components.matter.vacuum.MatterVacuum._supported_run_modes
private

Definition at line 176 of file vacuum.py.

◆ None

homeassistant.components.matter.vacuum.MatterVacuum.None
static

Definition at line 66 of file vacuum.py.


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