Merge pull request #16 from bittles/dev

Update README.md

custom_components/ecovacs/manifest.json

@@ -1,7 +1,7 @@
 {
   "domain": "ecovacs",
   "name": "Ecovacs Bumper",
-  "version": "1.5.3",
+  "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

@@ -117,28 +117,28 @@ class VacBot():
 
 #        if not error == '':
 
+"""
+Errors
+The bot broadcasts error codes for a number of cases.
 
-# Errors
-# The bot broadcasts error codes for a number of cases.
+<ctl td="error" error="BatteryLow" errno="101"></ctl>
 
-# <ctl td="error" error="BatteryLow" errno="101"></ctl>
+The latest error can be requested like so:
 
-# 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.
 
-# 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.
+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']