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

Public Member Functions

None __init__ (self, NeatoHub neato, Robot robot, dict[str, Any]|None mapdata, dict[str, Any]|None persistent_maps)
 
None clean_spot (self, **Any kwargs)
 
DeviceInfo device_info (self)
 
dict[str, Any] extra_state_attributes (self)
 
None locate (self, **Any kwargs)
 
None neato_custom_cleaning (self, str mode, str navigation, str category, str|None zone=None)
 
None pause (self)
 
None return_to_base (self, **Any kwargs)
 
None start (self)
 
None stop (self, **Any kwargs)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.neato.entity.NeatoEntity
None __init__ (self, Robot robot)
 
- 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)
 
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 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)
 
int|None battery_level (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None fan_speed (self)
 
list[strfan_speed_list (self)
 
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)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
VacuumEntityFeature supported_features (self)
 
VacuumEntityFeature supported_features_compat (self)
 

Private Attributes

 _attr_available
 
 _attr_battery_level
 
 _attr_state
 
 _clean_area
 
 _clean_battery_end
 
 _clean_battery_start
 
 _clean_error_time
 
 _clean_pause_time
 
 _clean_susp_charge_count
 
 _clean_susp_time
 
 _clean_time_start
 
 _clean_time_stop
 
 _launched_from
 
 _mapdata
 
 _robot_boundaries
 
 _robot_maps
 
 _robot_stats
 
 _state
 
 _status_state
 

Static Private Attributes

 _attr_name = None
 
tuple _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.neato.entity.NeatoEntity
 robot
 
- 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
 
- 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
 

Detailed Description

Representation of a Neato Connected Vacuum.

Definition at line 96 of file vacuum.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.__init__ (   self,
NeatoHub  neato,
Robot  robot,
dict[str, Any] | None  mapdata,
dict[str, Any] | None  persistent_maps 
)
Initialize the Neato Connected Vacuum.

Definition at line 112 of file vacuum.py.

Member Function Documentation

◆ clean_spot()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.clean_spot (   self,
**Any  kwargs 
)
Run a spot cleaning starting from the base.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 356 of file vacuum.py.

◆ device_info()

DeviceInfo homeassistant.components.neato.vacuum.NeatoConnectedVacuum.device_info (   self)
Device info for neato robot.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 295 of file vacuum.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.neato.vacuum.NeatoConnectedVacuum.extra_state_attributes (   self)
Return the state attributes of the vacuum cleaner.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 265 of file vacuum.py.

◆ locate()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.locate (   self,
**Any  kwargs 
)
Locate the robot by making it emit a sound.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 347 of file vacuum.py.

◆ neato_custom_cleaning()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.neato_custom_cleaning (   self,
str  mode,
str  navigation,
str  category,
str | None   zone = None 
)
Zone cleaning service call.

Definition at line 365 of file vacuum.py.

◆ pause()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.pause (   self)
Pause the vacuum.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 317 of file vacuum.py.

◆ return_to_base()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.return_to_base (   self,
**Any  kwargs 
)
Set the vacuum cleaner to return to the dock.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 326 of file vacuum.py.

◆ start()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.start (   self)
Start cleaning or resume cleaning.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 304 of file vacuum.py.

◆ stop()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.stop (   self,
**Any  kwargs 
)
Stop the vacuum cleaner.

Reimplemented from homeassistant.components.vacuum.StateVacuumEntity.

Definition at line 338 of file vacuum.py.

◆ update()

None homeassistant.components.neato.vacuum.NeatoConnectedVacuum.update (   self)
Update the states of Neato Vacuums.

Definition at line 142 of file vacuum.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._attr_available
private

Definition at line 159 of file vacuum.py.

◆ _attr_battery_level

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._attr_battery_level
private

Definition at line 209 of file vacuum.py.

◆ _attr_name

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._attr_name = None
staticprivate

Definition at line 110 of file vacuum.py.

◆ _attr_state

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._attr_state
private

Definition at line 172 of file vacuum.py.

◆ _attr_supported_features

tuple homeassistant.components.neato.vacuum.NeatoConnectedVacuum._attr_supported_features
staticprivate
Initial value:
= (
VacuumEntityFeature.BATTERY
| VacuumEntityFeature.PAUSE
| VacuumEntityFeature.RETURN_HOME
| VacuumEntityFeature.STOP
| VacuumEntityFeature.START
| VacuumEntityFeature.CLEAN_SPOT
| VacuumEntityFeature.STATE
| VacuumEntityFeature.MAP
| VacuumEntityFeature.LOCATE
)

Definition at line 99 of file vacuum.py.

◆ _clean_area

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_area
private

Definition at line 219 of file vacuum.py.

◆ _clean_battery_end

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_battery_end
private

Definition at line 225 of file vacuum.py.

◆ _clean_battery_start

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_battery_start
private

Definition at line 224 of file vacuum.py.

◆ _clean_error_time

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_error_time
private

Definition at line 223 of file vacuum.py.

◆ _clean_pause_time

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_pause_time
private

Definition at line 222 of file vacuum.py.

◆ _clean_susp_charge_count

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_susp_charge_count
private

Definition at line 220 of file vacuum.py.

◆ _clean_susp_time

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_susp_time
private

Definition at line 221 of file vacuum.py.

◆ _clean_time_start

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_time_start
private

Definition at line 217 of file vacuum.py.

◆ _clean_time_stop

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._clean_time_stop
private

Definition at line 218 of file vacuum.py.

◆ _launched_from

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._launched_from
private

Definition at line 226 of file vacuum.py.

◆ _mapdata

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._mapdata
private

Definition at line 122 of file vacuum.py.

◆ _robot_boundaries

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._robot_boundaries
private

Definition at line 238 of file vacuum.py.

◆ _robot_maps

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._robot_maps
private

Definition at line 124 of file vacuum.py.

◆ _robot_stats

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._robot_stats
private

Definition at line 147 of file vacuum.py.

◆ _state

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._state
private

Definition at line 152 of file vacuum.py.

◆ _status_state

homeassistant.components.neato.vacuum.NeatoConnectedVacuum._status_state
private

Definition at line 173 of file vacuum.py.


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