Merge pull request #16 from bittles/dev

Update README.md

README.md

@@ -78,4 +78,4 @@ Make component async, use config_flow, create device and clean up some of the ha
 ### Misc Info From Making This
 Commit history is a bit of a mess.  master branch shows changes from bmartins fork of sucks to v1.3.0 of this custom component.  dev branch shows commits from my attempts at testing and getting this to work.
 
-Added additional catches to sucks because my N79 sends some weird payloads, but attributes all pull in now for brush life spans.  Couple initial queries it also sends weird that I'm in process of catching atm.  As of version 1.3.0 (in the manifest.json) these initial queries and all attributes are working.  Was using an implementation completely mine but saw in the MQTT class there were already catches for child payloads without the main payload having the expected td in its payload.  Kept comments in giving credit and adapted them to work with xmpp.
+Added additional catches to sucks because my N79 sends some weird payloads, but attributes all pull in now for brush life spans.  Couple initial queries it also sends weird that I'm in process of catching atm.  As of version 1.3.0 (in the manifest.json) these initial queries and all attributes are working.  Was using an implementation completely mine but saw in the MQTT class there were already catches for child payloads without the main payload having the expected td in its payload.  Kept comments in giving credit and adapted them to work with xmpp.

custom_components/ecovacs/manifest.json

@@ -1,7 +1,7 @@
 {
   "domain": "ecovacs",
   "name": "Ecovacs Bumper",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "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:
-            error = event['error']
-        elif 'errs' in event:
-            error = event['errs']
-        if not error == '':
+        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']
             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: