Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecovacs.controller.EcovacsController Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, Mapping[str, Any] config)
 
None add_legacy_entity (self, VacBot device, str component)
 
list[Device] devices (self)
 
None initialize (self)
 
list[VacBot] legacy_devices (self)
 
bool legacy_entity_is_added (self, VacBot device, str component)
 
None teardown (self)
 

Private Member Functions

MqttClient _get_mqtt_client (self)
 

Private Attributes

 _api_client
 
 _authenticator
 
 _continent
 
 _device_id
 
 _hass
 
 _mqtt_client
 
 _mqtt_config_fn
 

Detailed Description

Ecovacs controller.

Definition at line 37 of file controller.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ecovacs.controller.EcovacsController.__init__ (   self,
HomeAssistant  hass,
Mapping[str, Any]  config 
)
Initialize controller.

Definition at line 40 of file controller.py.

Member Function Documentation

◆ _get_mqtt_client()

MqttClient homeassistant.components.ecovacs.controller.EcovacsController._get_mqtt_client (   self)
private
Return validated MQTT client.

Definition at line 134 of file controller.py.

◆ add_legacy_entity()

None homeassistant.components.ecovacs.controller.EcovacsController.add_legacy_entity (   self,
VacBot  device,
str  component 
)
Add legacy entity.

Definition at line 126 of file controller.py.

◆ devices()

list[Device] homeassistant.components.ecovacs.controller.EcovacsController.devices (   self)
Return devices.

Definition at line 145 of file controller.py.

◆ initialize()

None homeassistant.components.ecovacs.controller.EcovacsController.initialize (   self)
Init controller.

Definition at line 78 of file controller.py.

◆ legacy_devices()

list[VacBot] homeassistant.components.ecovacs.controller.EcovacsController.legacy_devices (   self)
Return legacy devices.

Definition at line 150 of file controller.py.

◆ legacy_entity_is_added()

bool homeassistant.components.ecovacs.controller.EcovacsController.legacy_entity_is_added (   self,
VacBot  device,
str  component 
)
Check if legacy entity is added.

Definition at line 130 of file controller.py.

◆ teardown()

None homeassistant.components.ecovacs.controller.EcovacsController.teardown (   self)
Disconnect controller.

Definition at line 116 of file controller.py.

Member Data Documentation

◆ _api_client

homeassistant.components.ecovacs.controller.EcovacsController._api_client
private

Definition at line 60 of file controller.py.

◆ _authenticator

homeassistant.components.ecovacs.controller.EcovacsController._authenticator
private

Definition at line 50 of file controller.py.

◆ _continent

homeassistant.components.ecovacs.controller.EcovacsController._continent
private

Definition at line 48 of file controller.py.

◆ _device_id

homeassistant.components.ecovacs.controller.EcovacsController._device_id
private

Definition at line 46 of file controller.py.

◆ _hass

homeassistant.components.ecovacs.controller.EcovacsController._hass
private

Definition at line 42 of file controller.py.

◆ _mqtt_client

homeassistant.components.ecovacs.controller.EcovacsController._mqtt_client
private

Definition at line 140 of file controller.py.

◆ _mqtt_config_fn

homeassistant.components.ecovacs.controller.EcovacsController._mqtt_config_fn
private

Definition at line 67 of file controller.py.


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