Fixed homebridge startup failed when robot does not support mapping

Support for zone cleaning

.gitignore

@@ -0,0 +1,75 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules
+jspm_packages
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/dist-server
+/dist-e2e
+/tmp
+/out-tsc
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+*.iml
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/libpeerconnection.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+package-lock.json

CHANGELOG.md

@@ -75,3 +75,23 @@
 * Changed debug messages
 * Updated node-botvac dependency to 0.1.6
 * Removed extra care navigation option parameter (is now a button)
+
+## 0.5.1
+
+* Updated node-botvac dependency to 0.1.7
+
+## 0.5.2
+
+* Added schema file for use with homebridge-config-ui-x
+
+## 0.6.0
+
+* Added support for zone cleaning
+
+## 0.6.1
+
+* Fixed homebridge startup failed when robot does not support zone cleaning
+
+## 0.6.2
+
+* Fixed homebridge startup failed when robot does not support mapping

README.md

@@ -7,16 +7,15 @@ This is a plugin for [homebridge](https://github.com/nfarina/homebridge) to cont
 
 Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
 
-If you update from a previous version 0.3.x you have to adapt your config (plugin is now a platform).
-
 ## Features
 
 - Start and pause cleaning
 - Return to dock
-- Toggle schedule
+- Scheduling
-- Toggle eco mode
+- Eco mode
-- Toggle extra care navigation
+- Extra care navigation
-- toggle nogo lines
+- Nogo lines
+- Zone cleaning
 - Get battery info
 - Get dock info
 - Periodic refresh of robot state
@@ -69,7 +68,7 @@ The parameter **disabled** accepts a list of switches/sensors that can be disabl
 
 - BotVac Connected (Firmware 2.2.0)
 - BotVac D3 Connected
-- BotVac D5 Connected (Firmware 4.0.0, Firmware 4.3.0)
+- BotVac D5 Connected (Firmware 4.0.0, 4.3.0)
 - BotVac D7 Connected
 
 The plugin should work with D4 and D6 as well. If you have connected neato robot, please [tell me](https://github.com/naofireblade/homebridge-neato/issues) about your experience with this plugin.
@@ -77,3 +76,5 @@ The plugin should work with D4 and D6 as well. If you have connected neato robot
 ## Contributors
 Many thanks go to
 - [ghulands](https://github.com/ghulands) for finding and fixing a bug when no robot is associated with the neato account
+- [Berkay](https://github.com/btutal) for adding the schema file to use the plugin with homebridge-config-ui-x
+- [Antoine de Maleprade](https://github.com/az0uz) for adding the zone cleaning feature

config.schema.json

@@ -0,0 +1,23 @@
+{
+    "pluginAlias": "NeatoVacuumRobot",
+    "pluginType": "platform",
+    "headerDisplay": "For Advanced settings like Refresh time interval or Disabled switches/sensors. [Check Here](https://github.com/naofireblade/homebridge-neato#readme)",
+    "schema": {
+      "type": "object",
+      "properties": {
+        "email": {
+          "title": "email",
+          "type": "string",
+          "required": true,
+          "format": "email",
+          "description": "Your Email Address"
+        },
+        "password": {
+            "title": "password",
+            "type": "string",
+            "required": true,
+            "description": "Your Password"
+        }
+      }
+    }
+}

index.js

@@ -4,13 +4,13 @@ var inherits = require('util').inherits,
     botvac = require('node-botvac'),
 
     Service,
-	Characteristic
+    Characteristic;
 
 module.exports = function (homebridge) {
     Service = homebridge.hap.Service;
     Characteristic = homebridge.hap.Characteristic;
     homebridge.registerPlatform("homebridge-neato", "NeatoVacuumRobot", NeatoVacuumRobotPlatform);
-}
+};
 
 function NeatoVacuumRobotPlatform(log, config) {
     this.log = log;
@@ -36,16 +36,26 @@ function NeatoVacuumRobotPlatform(log, config) {
 
 NeatoVacuumRobotPlatform.prototype = {
     accessories: function (callback) {
-		this.accessories = [];
+        let accessories = [];
 
         let that = this;
-		this.robots = this.getRobots(function () {
+        this.getRobots(function () {
-			for (var i = 0; i < that.robots.length; i++) {
+            for (let i = 0; i < that.robots.length; i++) {
                 that.log("Found robot #" + (i + 1) + " named \"" + that.robots[i].name + "\" with serial \"" + that.robots[i]._serial + "\"");
-				var robotAccessory = new NeatoVacuumRobotAccessory(that.robots[i], that);
+                let robotAccessory = new NeatoVacuumRobotAccessory(that.robots[i], that);
-				that.accessories.push(robotAccessory);
+                accessories.push(robotAccessory);
+                if (that.robots[i].maps && that.robots[i].maps.length > 0)
+                {
+                    that.robots[i].maps.forEach((map) => {
+                        map.boundaries.forEach((boundary) => {
+                            if (boundary.type === "polygon") {
+                                accessories.push(new NeatoVacuumRobotAccessory(that.robots[i], that, boundary))
                             }
-			callback(that.accessories);
+                        })
+                    })
+                }
+            }
+            callback(accessories);
         });
     },
 
@@ -53,54 +63,99 @@ NeatoVacuumRobotPlatform.prototype = {
         debug("Loading your robots");
         let client = new botvac.Client();
         let that = this;
-		client.authorize(this.email, this.password, false, function (error) {
+        client.authorize(this.email, this.password, false, (error) => {
             if (error) {
                 that.log(error);
                 that.log.error("Can't log on to neato cloud. Please check your credentials.");
                 callback();
-			}
+            } else {
-			else {
+                client.getRobots((error, robots) => {
-				client.getRobots(function (error, robots) {
                     if (error) {
                         that.log(error);
                         that.log.error("Successful login but can't connect to your neato robot.");
                         callback();
-					}
+                    } else {
-					else {
                         if (robots.length === 0) {
                             that.log.error("Successful login but no robots associated with your account.");
                             that.robots = [];
                             callback();
-						}
+                        } else {
-						else {
                             debug("Found " + robots.length + " robots");
+                            let updatedRobotCount = 0;
                             that.robots = robots;
+                            that.robots.forEach((robot) => {
+                                robot.getPersistentMaps((error, result) => {
+                                    if (error) {
+                                        that.log("Error updating persistent maps: " + error + ": " + result);
+                                        callback();
+                                        return;
+                                    }
+                                    robot.maps = result;
+                                    let processedMapCount = 0;
+                                    if (robot.maps.length === 0)
+                                    {
+                                        callback();
+                                    }
+                                    robot.maps.forEach((map) => {
+                                        robot.getMapBoundaries(map.id, (error, result) => {
+                                            if (error) {
+                                                this.log("error getting boundaries: " + error + ": " + result)
+                                            } else {
+                                                map.boundaries = result.boundaries;
+                                            }
+                                            processedMapCount++;
+                                            if (processedMapCount == robot.maps.length) {
+                                                updatedRobotCount++;
+                                                if (updatedRobotCount === that.robots.length) {
                                                     callback();
                                                 }
                                             }
+                                        })
+                                    })
+                                })
+                            })
+                        }
+                    }
                 });
             }
         });
     }
-}
+};
 
-function NeatoVacuumRobotAccessory(robot, platform) {
+function NeatoVacuumRobotAccessory(robot, platform, boundary) {
     this.platform = platform;
+    this.boundary = boundary;
     this.log = platform.log;
     this.refresh = platform.refresh;
     this.hiddenServices = platform.hiddenServices;
     this.robot = robot;
+    if (!this.boundary) {
         this.name = robot.name;
+    } else {
+        this.name = this.robot.name + ' - ' + this.boundary.name;
+    }
     this.lastUpdate = null;
 
-	this.vacuumRobotCleanService = new Service.Switch(this.name + " Clean", "clean");
+    this.vacuumRobotBatteryService = new Service.BatteryService("Battery", "battery");
+
+    if (!this.boundary) {
+        this.vacuumRobotCleanService = new Service.Switch("Clean", "clean");
         this.vacuumRobotGoToDockService = new Service.Switch(this.name + " Go to Dock", "goToDock");
         this.vacuumRobotDockStateService = new Service.OccupancySensor(this.name + " Dock", "dockState");
         this.vacuumRobotEcoService = new Service.Switch(this.name + " Eco Mode", "eco");
         this.vacuumRobotNoGoLinesService = new Service.Switch(this.name + " NoGo Lines", "noGoLines");
         this.vacuumRobotExtraCareService = new Service.Switch(this.name + " Extra Care", "extraCare");
         this.vacuumRobotScheduleService = new Service.Switch(this.name + " Schedule", "schedule");
-	this.vacuumRobotBatteryService = new Service.BatteryService("Battery", "battery");
+    } else {
+        const splitName = boundary.name.split(' ');
+        let serviceName = "Clean the " + boundary.name;
+        if (splitName.length >= 2 && splitName[splitName.length - 2].match(/[']s$/g)) {
+            serviceName = "Clean " + boundary.name;
+        }
+        this.vacuumRobotCleanBoundaryService =
+            new Service.Switch(serviceName, "cleanBoundary:" + boundary.id);
+        this.log("Adding zone cleaning for: " + boundary.name);
+    }
 
     this.updateRobotTimer();
 }
@@ -118,18 +173,29 @@ NeatoVacuumRobotAccessory.prototype = {
             that.log(that.robot);
             that.robot._serial = _serial;
             that.robot._secret = _secret;
-			callback();
         });
     },
 
     getServices: function () {
         this.informationService = new Service.AccessoryInformation();
         this.informationService
-			.setCharacteristic(Characteristic.Name, this.robot.name)
             .setCharacteristic(Characteristic.Manufacturer, "Neato Robotics")
             .setCharacteristic(Characteristic.Model, "Coming soon")
             .setCharacteristic(Characteristic.SerialNumber, this.robot._serial);
+        if (!this.boundary) {
+            this.informationService
+                .setCharacteristic(Characteristic.Name, this.robot.name)
+        } else {
+            this.informationService
+                .setCharacteristic(Characteristic.Name, this.robot.name + ' - ' + this.boundary.name)
+        }
 
+        this.vacuumRobotBatteryService.getCharacteristic(Characteristic.BatteryLevel).on('get', this.getBatteryLevel.bind(this));
+        this.vacuumRobotBatteryService.getCharacteristic(Characteristic.ChargingState).on('get', this.getBatteryChargingState.bind(this));
+
+        this.services = [this.informationService, this.vacuumRobotBatteryService];
+
+        if (!this.boundary) {
             this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('set', this.setClean.bind(this));
             this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('get', this.getClean.bind(this));
 
@@ -150,10 +216,8 @@ NeatoVacuumRobotAccessory.prototype = {
             this.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).on('set', this.setSchedule.bind(this));
             this.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).on('get', this.getSchedule.bind(this));
 
-		this.vacuumRobotBatteryService.getCharacteristic(Characteristic.BatteryLevel).on('get', this.getBatteryLevel.bind(this));
+            this.services.push(this.vacuumRobotCleanService);
-		this.vacuumRobotBatteryService.getCharacteristic(Characteristic.ChargingState).on('get', this.getBatteryChargingState.bind(this));
 
-		this.services = [this.informationService, this.vacuumRobotCleanService, this.vacuumRobotBatteryService];
             if (this.hiddenServices.indexOf('dock') === -1)
                 this.services.push(this.vacuumRobotGoToDockService);
             if (this.hiddenServices.indexOf('dockstate') === -1)
@@ -166,10 +230,55 @@ NeatoVacuumRobotAccessory.prototype = {
                 this.services.push(this.vacuumRobotExtraCareService);
             if (this.hiddenServices.indexOf('schedule') === -1)
                 this.services.push(this.vacuumRobotScheduleService);
+        }
+
+        if (this.boundary) {
+            this.vacuumRobotCleanBoundaryService.getCharacteristic(Characteristic.On).on('set', (on, serviceCallback) => {
+                this.setCleanBoundary(this.boundary.id, on, serviceCallback)
+            });
+            this.vacuumRobotCleanBoundaryService.getCharacteristic(Characteristic.On).on('get', (serviceCallback) => {
+                this.getCleanBoundary(this.boundary.id, serviceCallback);
+            });
+            this.services.push(this.vacuumRobotCleanBoundaryService);
+        }
 
         return this.services;
     },
 
+    setCleanBoundary: function (boundaryId, on, callback) {
+        this.updateRobot((error, result) => {
+            if (on) {
+                if (this.robot.canStart) {
+                    this.log("Starting to clean: " + boundaryId);
+                    this.robot.startCleaningBoundary(this.eco, this.extraCare, boundaryId, (error, result) => {
+                        if (error) {
+                            this.log(error + ": " + JSON.stringify(result));
+                        }
+                        callback();
+                    });
+                    return
+                } else {
+                    this.log("Error, robot is already cleaning");
+                }
+            } else {
+                if (this.robot.canPause) {
+                    debug(this.name + ": Pause cleaning");
+                    this.robot.pauseCleaning(callback);
+                    return;
+                } else {
+                    debug(this.name + ": Already stopped");
+                }
+            }
+            callback();
+        });
+    },
+
+    getCleanBoundary: function (boundaryId, callback) {
+        this.updateRobot((error, result) => {
+            callback(false, this.robot.canPause && (this.robot.cleaningBoundaryId == boundaryId));
+        });
+    },
+
     setClean: function (on, callback) {
         let that = this;
         this.updateRobot(function (error, result) {
@@ -187,8 +296,7 @@ NeatoVacuumRobotAccessory.prototype = {
                     if (that.robot.canResume) {
                         debug(that.name + ": Resume cleaning");
                         that.robot.resumeCleaning(callback);
-					}
+                    } else {
-					else {
                         let eco = that.vacuumRobotEcoService.getCharacteristic(Characteristic.On).value;
                         let extraCare = that.vacuumRobotExtraCareService.getCharacteristic(Characteristic.On).value;
                         let nogoLines = that.vacuumRobotNoGoLinesService.getCharacteristic(Characteristic.On).value;
@@ -201,24 +309,20 @@ NeatoVacuumRobotAccessory.prototype = {
                                 if (error) {
                                     that.log.error(error + ": " + result);
                                     callback(true);
-								}
+                                } else {
-								else {
                                     callback();
                                 }
                             });
                     }
-				}
+                } else {
-				else {
                     debug(that.name + ": Cant start, maybe already cleaning");
                     callback();
                 }
-			}
+            } else {
-			else {
                 if (that.robot.canPause) {
                     debug(that.name + ": Pause cleaning");
                     that.robot.pauseCleaning(callback);
-				}
+                } else {
-				else {
                     debug(that.name + ": Already stopped");
                     callback();
                 }
@@ -238,12 +342,10 @@ NeatoVacuumRobotAccessory.prototype = {
                             that.robot.sendToBase(callback);
                         }, 1000);
                     });
-				}
+                } else if (that.robot.canGoToBase) {
-				else if (that.robot.canGoToBase) {
                     debug(that.name + ": Go to dock");
                     that.robot.sendToBase(callback);
-				}
+                } else {
-				else {
                     that.log.warn(that.name + ": Can't go to dock at the moment");
                     callback();
                 }
@@ -277,8 +379,7 @@ NeatoVacuumRobotAccessory.prototype = {
             if (on) {
                 debug(that.name + ": Enable schedule");
                 that.robot.enableSchedule(callback);
-			}
+            } else {
-			else {
                 debug(that.name + ": Disable schedule");
                 that.robot.disableSchedule(callback);
             }
@@ -358,8 +459,7 @@ NeatoVacuumRobotAccessory.prototype = {
         let that = this;
         if (this.lastUpdate !== null && new Date() - this.lastUpdate < 2000) {
             callback();
-		}
+        } else {
-		else {
             debug(this.name + ": Updating robot state");
             this.robot.getState(function (error, result) {
                 if (error) {
@@ -373,8 +473,9 @@ NeatoVacuumRobotAccessory.prototype = {
 
     updateRobotTimer: function () {
         let that = this;
-		this.updateRobot(function (error, result) {
+        this.updateRobot((error, result) => {
 
+            if (!this.boundary) {
                 // only update these values if the state is different from the current one, otherwise we might accidentally start an action
                 if (that.vacuumRobotCleanService.getCharacteristic(Characteristic.On).value !== that.robot.canPause) {
                     that.vacuumRobotCleanService.setCharacteristic(Characteristic.On, that.robot.canPause);
@@ -394,12 +495,19 @@ NeatoVacuumRobotAccessory.prototype = {
                 that.vacuumRobotEcoService.setCharacteristic(Characteristic.On, that.robot.eco);
                 that.vacuumRobotNoGoLinesService.setCharacteristic(Characteristic.On, that.robot.noGoLines);
                 that.vacuumRobotExtraCareService.setCharacteristic(Characteristic.On, that.robot.navigationMode == 2 ? true : false);
+
+            } else {
+                if (this.vacuumRobotCleanBoundaryService.getCharacteristic(Characteristic.On).value !== that.robot.canPause) {
+                    this.vacuumRobotCleanBoundaryService.setCharacteristic(Characteristic.On, that.robot.canPause);
+                }
+            }
+
             that.vacuumRobotBatteryService.setCharacteristic(Characteristic.BatteryLevel, that.robot.charge);
             that.vacuumRobotBatteryService.setCharacteristic(Characteristic.ChargingState, that.robot.isCharging);
 
             // robot is currently cleaning, update if refresh is set to auto or a specific interval
             if (that.robot.canPause && that.refresh !== 0) {
-				let refreshTime = that.refresh === 'auto' ? 60 : that.refresh
+                let refreshTime = that.refresh === 'auto' ? 60 : that.refresh;
                 debug("Updating state in background every " + refreshTime + " seconds while cleaning");
                 that.timer = setTimeout(that.updateRobotTimer.bind(that), refreshTime * 1000);
             }
@@ -407,10 +515,9 @@ NeatoVacuumRobotAccessory.prototype = {
             else if (that.refresh !== 'auto' && that.refresh !== 0) {
                 debug("Updating state in background every " + that.refresh + " seconds (user setting)");
                 that.timer = setTimeout(that.updateRobotTimer.bind(that), that.refresh * 1000);
-			}
+            } else {
-			else {
                 debug("Updating state in background disabled");
             }
         });
     },
-}
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-neato",
-  "version": "0.5.0",
+  "version": "0.6.2",
   "description": "A Neato vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [
@@ -13,14 +13,30 @@
     "homebridge": ">=0.2.0"
   },
   "author": {
-    "name": "Arne Blumentritt"
+    "name": "Arne Blumentritt",
+    "url2": "https://github.com/naofireblade"
   },
+  "contributors": [
+    {
+      "name": "ghulands",
+      "url": "https://github.com/ghulands"
+    },
+    {
+      "name": "Berkay",
+      "url": "https://github.com/btutal"
+    },
+    {
+      "name": "Antoine de Maleprade",
+      "url": "https://github.com/az0uz"
+    }
+  ],
   "repository": {
     "type": "git",
     "url": "git://github.com/naofireblade/homebridge-neato.git"
   },
   "dependencies": {
-    "node-botvac": ">=0.1.6",
+    "debug": "^2.2.0",
-    "debug": "^2.2.0"
+    "node-botvac": ">=0.3.0",
+    "uuid": "^3.3.2"
   }
 }