homeassistant.components.lawn_mower.LawnMowerEntity Class Reference

Inheritance diagram for homeassistant.components.lawn_mower.LawnMowerEntity:

Collaboration diagram for homeassistant.components.lawn_mower.LawnMowerEntity:

Public Member Functions
LawnMowerActivity|None	activity (self)
None	async_dock (self)
None	async_pause (self)
None	async_start_mowing (self)
None	dock (self)
None	pause (self)
None	start_mowing (self)
str|None	state (self)
LawnMowerEntityFeature	supported_features (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)
dict[str, Any]|None	capability_attributes (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)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_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
	LawnMowerEntityFeature
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Base class for lawn mower entities.

Definition at line 79 of file __init__.py.

Member Function Documentation

activity()

LawnMowerActivity | None homeassistant.components.lawn_mower.LawnMowerEntity.activity

(

self

)

Return the current lawn mower activity.

Reimplemented in homeassistant.components.husqvarna_automower.lawn_mower.AutomowerLawnMowerEntity.

Definition at line 93 of file __init__.py.

async_dock()

None homeassistant.components.lawn_mower.LawnMowerEntity.async_dock

(

self

)

Dock the mower.

Reimplemented in homeassistant.components.mqtt.lawn_mower.MqttLawnMower, homeassistant.components.kitchen_sink.lawn_mower.DemoLawnMower, homeassistant.components.husqvarna_automower_ble.lawn_mower.AutomowerLawnMower, homeassistant.components.husqvarna_automower.lawn_mower.AutomowerLawnMowerEntity, and homeassistant.components.ecovacs.lawn_mower.EcovacsMower.

Definition at line 114 of file __init__.py.

async_pause()

None homeassistant.components.lawn_mower.LawnMowerEntity.async_pause

(

self

)

Pause the lawn mower.

Reimplemented in homeassistant.components.mqtt.lawn_mower.MqttLawnMower, homeassistant.components.kitchen_sink.lawn_mower.DemoLawnMower, homeassistant.components.husqvarna_automower_ble.lawn_mower.AutomowerLawnMower, homeassistant.components.husqvarna_automower.lawn_mower.AutomowerLawnMowerEntity, and homeassistant.components.ecovacs.lawn_mower.EcovacsMower.

Definition at line 122 of file __init__.py.

async_start_mowing()

None homeassistant.components.lawn_mower.LawnMowerEntity.async_start_mowing

(

self

)

Start or resume mowing.

Reimplemented in homeassistant.components.mqtt.lawn_mower.MqttLawnMower, homeassistant.components.kitchen_sink.lawn_mower.DemoLawnMower, homeassistant.components.husqvarna_automower_ble.lawn_mower.AutomowerLawnMower, homeassistant.components.husqvarna_automower.lawn_mower.AutomowerLawnMowerEntity, and homeassistant.components.ecovacs.lawn_mower.EcovacsMower.

Definition at line 106 of file __init__.py.

dock()

None homeassistant.components.lawn_mower.LawnMowerEntity.dock

(

self

)

Dock the mower.

Definition at line 110 of file __init__.py.

pause()

None homeassistant.components.lawn_mower.LawnMowerEntity.pause

(

self

)

Pause the lawn mower.

Definition at line 118 of file __init__.py.

start_mowing()

None homeassistant.components.lawn_mower.LawnMowerEntity.start_mowing

(

self

)

Start or resume mowing.

Definition at line 102 of file __init__.py.

state()

str | None homeassistant.components.lawn_mower.LawnMowerEntity.state

(

self

)

Return the current state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 88 of file __init__.py.

supported_features()

LawnMowerEntityFeature homeassistant.components.lawn_mower.LawnMowerEntity.supported_features

(

self

)

Flag lawn mower features that are supported.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 98 of file __init__.py.

Member Data Documentation

LawnMowerEntityFeature

homeassistant.components.lawn_mower.LawnMowerEntity.LawnMowerEntityFeature

static

Definition at line 84 of file __init__.py.

None

homeassistant.components.lawn_mower.LawnMowerEntity.None

static

Definition at line 83 of file __init__.py.

---

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

• core/homeassistant/components/lawn_mower/__init__.py