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

Public Member Functions

None async_pause (self)
 
None async_return_to_base (self, **Any kwargs)
 
None async_set_fan_speed (self, str fan_speed, **Any kwargs)
 
None async_start (self)
 
- Public Member Functions inherited from homeassistant.components.switchbot_cloud.entity.SwitchBotCloudEntity
None __init__ (self, SwitchBotAPI api, Device|Remote device, SwitchBotCoordinator coordinator)
 
None send_api_command (self, Commands command, str command_type="command", dict|str parameters="default")
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.switchbot_cloud.coordinator.SwitchBotCoordinator
None __init__ (self, HomeAssistant hass, SwitchBotAPI api, Device|Remote device)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.vacuum.StateVacuumEntity
None async_clean_spot (self, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
None async_send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
None async_stop (self, **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)
 
- 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_added_to_hass (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)
 
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)
 

Static Public Attributes

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

Private Member Functions

None _handle_coordinator_update (self)
 

Private Attributes

 _attr_available
 
 _attr_battery_level
 
 _attr_fan_speed
 
 _attr_state
 

Static Private Attributes

 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.vacuum.StateVacuumEntity
 state
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of a SwitchBot vacuum.

Definition at line 68 of file vacuum.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 108 of file vacuum.py.

◆ async_pause()

None homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum.async_pause (   self)
Pause the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 95 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum.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 99 of file vacuum.py.

◆ async_set_fan_speed()

None homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum.async_set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 85 of file vacuum.py.

◆ async_start()

None homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum.async_start (   self)
Start or resume the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 103 of file vacuum.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._attr_available
private

Definition at line 114 of file vacuum.py.

◆ _attr_battery_level

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._attr_battery_level
private

Definition at line 113 of file vacuum.py.

◆ _attr_fan_speed

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._attr_fan_speed
private

Definition at line 87 of file vacuum.py.

◆ _attr_name

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._attr_name = None
staticprivate

Definition at line 80 of file vacuum.py.

◆ _attr_state

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum._attr_state
private

Definition at line 117 of file vacuum.py.

◆ VacuumEntityFeature

homeassistant.components.switchbot_cloud.vacuum.SwitchBotCloudVacuum.VacuumEntityFeature
static

Definition at line 71 of file vacuum.py.


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