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

Public Member Functions

None __init__ (self, SharkIqVacuum sharkiq, SharkIqUpdateCoordinator coordinator)
 
None async_clean_room (self, list[str] rooms, **Any kwargs)
 
None async_locate (self, **Any kwargs)
 
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)
 
None async_stop (self, **Any kwargs)
 
bool available (self)
 
list|None available_rooms (self)
 
int|None battery_level (self)
 
None clean_spot (self, **Any kwargs)
 
int|None error_code (self)
 
str|None error_message (self)
 
dict[str, Any] extra_state_attributes (self)
 
str|None fan_speed (self)
 
bool is_online (self)
 
def low_light (self)
 
str model (self)
 
str|None operating_mode (self)
 
bool|None recharge_resume (self)
 
int|None recharging_to_resume (self)
 
int|None rssi (self)
 
None send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
str|None state (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.sharkiq.coordinator.SharkIqUpdateCoordinator
None __init__ (self, HomeAssistant hass, ConfigEntry config_entry, AylaApi ayla_api, list[SharkIqVacuum] shark_vacs)
 
bool device_is_online (self, str dsn)
 
set[str] online_dsns (self)
 
- 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_send_command (self, str command, dict[str, Any]|list[Any]|None params=None, **Any kwargs)
 
str battery_icon (self)
 
dict[str, Any]|None capability_attributes (self)
 
list[strfan_speed_list (self)
 
None locate (self, **Any kwargs)
 
None pause (self)
 
None return_to_base (self, **Any kwargs)
 
None set_fan_speed (self, str fan_speed, **Any kwargs)
 
None start (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)
 
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)
 
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 Attributes

 sharkiq
 
- Public Attributes inherited from homeassistant.components.sharkiq.coordinator.SharkIqUpdateCoordinator
 ayla_api
 
- 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
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 

Static Private Attributes

 _attr_fan_speed_list = list(FAN_SPEEDS_MAP)
 
bool _attr_has_entity_name = True
 
 _attr_name = None
 
tuple _attr_supported_features
 
 _unrecorded_attributes = frozenset({ATTR_ROOMS})
 

Additional Inherited Members

- 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
 

Detailed Description

Shark IQ vacuum entity.

Definition at line 83 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.__init__ (   self,
SharkIqVacuum  sharkiq,
SharkIqUpdateCoordinator   coordinator 
)
Create a new SharkVacuumEntity.

Definition at line 101 of file vacuum.py.

Member Function Documentation

◆ async_clean_room()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_clean_room (   self,
list[str rooms,
**Any  kwargs 
)
Clean specific rooms.

Definition at line 211 of file vacuum.py.

◆ async_locate()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_locate (   self,
**Any  kwargs 
)
Cause the device to generate a loud chirp.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 207 of file vacuum.py.

◆ async_pause()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_pause (   self)
Pause the cleaning task.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 192 of file vacuum.py.

◆ async_return_to_base()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_return_to_base (   self,
**Any  kwargs 
)
Have the device return to base.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 187 of file vacuum.py.

◆ async_set_fan_speed()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_set_fan_speed (   self,
str  fan_speed,
**Any  kwargs 
)
Set the fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 240 of file vacuum.py.

◆ async_start()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_start (   self)
Start the device.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 197 of file vacuum.py.

◆ async_stop()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.async_stop (   self,
**Any  kwargs 
)
Stop the device.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 202 of file vacuum.py.

◆ available()

bool homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.available (   self)
Determine if the sensor is available based on API results.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 177 of file vacuum.py.

◆ available_rooms()

list | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.available_rooms (   self)
Return a list of rooms available to clean.

Definition at line 264 of file vacuum.py.

◆ battery_level()

int | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.battery_level (   self)
Get the current battery level.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 183 of file vacuum.py.

◆ clean_spot()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.clean_spot (   self,
**Any  kwargs 
)
Clean a spot. Not yet implemented.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 116 of file vacuum.py.

◆ error_code()

int | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.error_code (   self)
Return the last observed error code (or None).

Definition at line 142 of file vacuum.py.

◆ error_message()

str | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.error_message (   self)
Return the last observed error message (or None).

Definition at line 147 of file vacuum.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.extra_state_attributes (   self)
Return a dictionary of device state attributes specific to sharkiq.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 272 of file vacuum.py.

◆ fan_speed()

str | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.fan_speed (   self)
Return the current fan speed.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 231 of file vacuum.py.

◆ is_online()

bool homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.is_online (   self)
Tell us if the device is online.

Definition at line 130 of file vacuum.py.

◆ low_light()

def homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.low_light (   self)
Let us know if the robot is operating in low-light mode.

Definition at line 259 of file vacuum.py.

◆ model()

str homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.model (   self)
Vacuum model number.

Definition at line 135 of file vacuum.py.

◆ operating_mode()

str | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.operating_mode (   self)
Operating mode.

Definition at line 154 of file vacuum.py.

◆ recharge_resume()

bool | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.recharge_resume (   self)
Recharge and resume mode active.

Definition at line 249 of file vacuum.py.

◆ recharging_to_resume()

int | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.recharging_to_resume (   self)
Return True if vacuum set to recharge and resume cleaning.

Definition at line 160 of file vacuum.py.

◆ rssi()

int | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.rssi (   self)
Get the WiFi RSSI.

Definition at line 254 of file vacuum.py.

◆ send_command()

None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.send_command (   self,
str  command,
dict[str, Any] | list[Any] | None   params = None,
**Any  kwargs 
)
Send a command to the vacuum. Not yet implemented.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 120 of file vacuum.py.

◆ state()

str | None homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.state (   self)
Get the current vacuum state.

NB: Currently, we do not return an error state because they can be very, very stale.
In the app, these are (usually) handled by showing the robot as stopped and sending the
user a notification.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 165 of file vacuum.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_device_info
private

Definition at line 108 of file vacuum.py.

◆ _attr_fan_speed_list

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_fan_speed_list = list(FAN_SPEEDS_MAP)
staticprivate

Definition at line 86 of file vacuum.py.

◆ _attr_has_entity_name

bool homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_has_entity_name = True
staticprivate

Definition at line 87 of file vacuum.py.

◆ _attr_name

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_name = None
staticprivate

Definition at line 88 of file vacuum.py.

◆ _attr_supported_features

tuple homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_supported_features
staticprivate
Initial value:
= (
VacuumEntityFeature.BATTERY
| VacuumEntityFeature.FAN_SPEED
| VacuumEntityFeature.PAUSE
| VacuumEntityFeature.RETURN_HOME
| VacuumEntityFeature.START
| VacuumEntityFeature.STATE
| VacuumEntityFeature.STOP
| VacuumEntityFeature.LOCATE
)

Definition at line 89 of file vacuum.py.

◆ _attr_unique_id

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._attr_unique_id
private

Definition at line 107 of file vacuum.py.

◆ _unrecorded_attributes

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity._unrecorded_attributes = frozenset({ATTR_ROOMS})
staticprivate

Definition at line 99 of file vacuum.py.

◆ sharkiq

homeassistant.components.sharkiq.vacuum.SharkVacuumEntity.sharkiq

Definition at line 106 of file vacuum.py.


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