Update README.md

has StateVacuumEntity but no async, will push release like this that should work and push another release with async

README.md

@@ -1,3 +1,6 @@
+# Latest version is 1.7.0 that includes updates that SHOULD at least let the component work with newer HASS versions.  This version includes async updates so the comoponent won't crap out on setup if it's unable to reach the vacuum.  I am unable to tset these changes since I don't have HASS currently setup and I don't have my old Ecovacs vacuum anymore (handed down to younger sis).
+# If 1.7.0 doesn't work, use version 1.6.0.  I just made the bare minimum changes to the component that again SHOULD work, but I'm unable to test it.  HASS ditched the VacuumEntity import for the vacuum component at some point and change it to StateVacuumEntity.  That's all that's included in this update.  Thanks @guillaume042 for making it easy for me by pointing me straight to a an issue with another component using VacuumEntity (though theirs was just leftover code that wasn't actually being used).
+
 # Home Assistant Ecovacs Custom Component with Bumper Support
 Based off the regular home assistant ecovacs components and bmartin's fork of sucks, https://github.com/bmartin5692/sucks.  Replaces built in ecovacs component, with some upgrades and fixes.  Allows SSL verification to be set to false to work with a self-hosted bumper server, https://github.com/bmartin5692/bumper, a replacement for Ecovacs servers to truly get local control.
 

custom_components/ecovacs/__init__.py

@@ -44,26 +44,25 @@ ECOVACS_API_DEVICEID = "".join(
     random.choice(string.ascii_uppercase + string.digits) for _ in range(8)
 )
 
-def setup(hass: HomeAssistant, config: ConfigType) -> bool:
+async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     """Set up the Ecovacs component."""
     LOGGER.debug("Creating new Ecovacs component")
-    hass.data[ECOVACS_DEVICES] = []
-    SERVER_ADDRESS = None
-
+    def get_devices() -> list[VacBot]:
         ecovacs_api = EcoVacsAPI(
             ECOVACS_API_DEVICEID,
             config[DOMAIN].get(CONF_USERNAME),
             EcoVacsAPI.md5(config[DOMAIN].get(CONF_PASSWORD)),
             config[DOMAIN].get(CONF_COUNTRY),
             config[DOMAIN].get(CONF_CONTINENT),
-        config[DOMAIN].get(CONF_VERIFY_SSL), # add to class call
         )
+        ecovacs_devices = ecovacs_api.devices()
+        _LOGGER.debug("Ecobot devices: %s", ecovacs_devices)
 
-    devices = ecovacs_api.devices()
-    LOGGER.debug("Ecobot devices: %s", devices)
+    SERVER_ADDRESS = None
 
-    for device in devices:
-        LOGGER.info(
+        devices: list[VacBot] = []
+        for device in ecovacs_devices:
+            _LOGGER.info(
                 "Discovered Ecovacs device on account: %s with nickname %s",
                 device.get("did"),
                 device.get("nick"),
@@ -75,24 +74,30 @@ def setup(hass: HomeAssistant, config: ConfigType) -> bool:
                 ecovacs_api.user_access_token,
                 device,
                 config[DOMAIN].get(CONF_CONTINENT).lower(),
-            SERVER_ADDRESS, # include server address in class, if it's null should be no effect
                 config[DOMAIN].get(CONF_VERIFY_SSL), # add to class call
-            monitor=True
+                monitor=True,
             )
-        hass.data[ECOVACS_DEVICES].append(vacbot)
 
-    def stop(event: object) -> None:
+            devices.append(vacbot)
+        return devices
+
+    hass.data[ECOVACS_DEVICES] = await hass.async_add_executor_job(get_devices)
+
+    async def async_stop(event: object) -> None:
         """Shut down open connections to Ecovacs XMPP server."""
-        for device in hass.data[ECOVACS_DEVICES]:
+        devices: list[VacBot] = hass.data[ECOVACS_DEVICES]
+        for device in devices:
             LOGGER.info(
                 "Shutting down connection to Ecovacs device %s",
                 device.vacuum.get("did"),
             )
-            device.disconnect()
+            await hass.async_add_executor_job(device.disconnect)
 
     # Listen for HA stop to disconnect.
-    hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop)
+    hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STOP, async_stop)
     if hass.data[ECOVACS_DEVICES]:
         LOGGER.debug("Starting vacuum components")
-        discovery.load_platform(hass, Platform.VACUUM, DOMAIN, {}, config)
+        hass.async_create_task(
+            discovery.async_load_platform(hass, Platform.VACUUM, DOMAIN, {}, config)
+        )
     return True

custom_components/ecovacs/manifest.json

@@ -1,7 +1,7 @@
 {
   "domain": "ecovacs",
   "name": "Ecovacs Bumper",
-  "version": "1.5.0",
+  "version": "1.5.3",
   "documentation": "https://github.com/bittles/ha_ecovacs_bumper",
   "issue_tracker": "https://github.com/bittles/ha_ecovacs_bumper/issues",
   "requirements": ["sleekxmppfs==1.4.1", "requests>=2.18", "pycryptodome>=3.4", "pycountry-convert>=0.5", "paho-mqtt>=1.4", "stringcase>=1.2"],

custom_components/ecovacs/sucks.py

@@ -7,6 +7,7 @@ import os
 from sleekxmppfs.xmlstream import ET
 from sleekxmppfs.exceptions import XMPPError
 
+#from . import sucks_api
 from .sucks_mqtt import EcoVacsIOTMQ
 from .sucks_xmpp import EcoVacsXMPP
 
@@ -105,14 +106,40 @@ class VacBot():
             getattr(self, method)(ctl)
 
     def _handle_error(self, event):
+        if 'error' in event or 'errs' in event:
+            error = '' # init error var so it's available outside of first if loop
             if 'error' in event:
                 error = event['error']
             elif 'errs' in event:
                 error = event['errs']
-        if not error == '':
             self.errorEvents.notify(error)
             LOGGER.error("*** error = " + error)
 
+#        if not error == '':
+
+
+# Errors
+# The bot broadcasts error codes for a number of cases.
+
+# <ctl td="error" error="BatteryLow" errno="101"></ctl>
+
+# The latest error can be requested like so:
+
+# Request <ctl td="GetError" />
+# Response <ctl ret="ok" errs="100"/>
+# However in some cases the robot sends to code 100 shortly after an error has occurred, meaning that we cannot trust the GetError request to contain the last relevant error. For example, if the robot gets stuck it broadcasts 102 HostHang, then proceeds to stop and broadcasts 100 NoError.
+
+# Known error codes
+
+# 100 NoError: Robot is operational
+# 101 BatteryLow: Low battery
+# 102 HostHang: Robot is stuck
+# 103 WheelAbnormal: Wheels are not moving as expected
+# 104 DownSensorAbnormal: Down sensor is getting abnormal values
+# 110 NoDustBox: Dust Bin Not installed
+# These codes are taken from model M81 Pro. Error codes may differ between models.
+
+
     def _handle_life_span(self, event):
         type = event['type']
         try:

custom_components/ecovacs/sucks_mqtt.py

@@ -10,7 +10,7 @@ from paho.mqtt import publish as MQTTPublish
 from paho.mqtt import subscribe as MQTTSubscribe
 from sleekxmppfs.xmlstream import ET
 
-from .sucks_api_const import API_REALM, API_IOTDEVMANAGERAPI
+from .sucks_api_const import API_REALM, API_IOTDEVMANAGERAPI, API_PORTAL_URL_FORMAT
 
 import logging
 LOGGER = logging.getLogger(__name__)

custom_components/ecovacs/vacuum.py

@@ -7,7 +7,7 @@ from typing import Any
 #sucks
 from . import sucks
 
-from homeassistant.components.vacuum import VacuumEntity, VacuumEntityFeature
+from homeassistant.components.vacuum import StateVacuumEntity, VacuumEntityFeature
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.icon import icon_for_battery_level
@@ -21,21 +21,23 @@ ATTR_ERROR = "error"
 ATTR_COMPONENT_PREFIX = "component_"
 
 
-def setup_platform(
+async def async_setup_platform(
     hass: HomeAssistant,
     config: ConfigType,
-    add_entities: AddEntitiesCallback,
+    async_add_entities: AddEntitiesCallback,
     discovery_info: DiscoveryInfoType | None = None,
 ) -> None:
     """Set up the Ecovacs vacuums."""
     vacuums = []
-    for device in hass.data[ECOVACS_DEVICES]:
+    devices: list[sucks.VacBot] = hass.data[ECOVACS_DEVICES]
+    for device in devices:
+        await hass.async_add_executor_job(device.connect_and_wait_until_ready)
         vacuums.append(EcovacsVacuum(device))
     _LOGGER.debug("Adding Ecovacs Vacuums to Home Assistant: %s", vacuums)
-    add_entities(vacuums, True)
+    async_add_entities(vacuums)
 
 
-class EcovacsVacuum(VacuumEntity):
+class EcovacsVacuum(StateVacuumEntity):
     """Ecovacs Vacuums such as Deebot."""
 
     _attr_fan_speed_list = [sucks.FAN_SPEED_NORMAL, sucks.FAN_SPEED_HIGH]
@@ -56,7 +58,7 @@ class EcovacsVacuum(VacuumEntity):
     def __init__(self, device: sucks.VacBot) -> None:
         """Initialize the Ecovacs Vacuum."""
         self.device = device
-        self.device.connect_and_wait_until_ready()
+
         if self.device.vacuum.get("nick") is not None:
             self._attr_name = str(self.device.vacuum["nick"])
         else:
@@ -64,7 +66,6 @@ class EcovacsVacuum(VacuumEntity):
             self._attr_name = str(format(self.device.vacuum["did"]))
 
         self._error = None
-        _LOGGER.debug("Vacuum initialized: %s", self.name)
 
     async def async_added_to_hass(self) -> None:
         """Set up the event listeners now that hass is ready."""