Version 0.6.3

.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

@@ -83,3 +83,21 @@
 ## 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
+
+## 0.6.3
+
+* Fixed homebridge crash when robot has a map without zones
+* Fixed homebridge crash when homebridge has no internet connection or the neato servers are offline
+* Fixed homebridge crash when 2 zones have the same name

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;
@@ -37,19 +37,25 @@ function NeatoVacuumRobotPlatform(log, config) {
 NeatoVacuumRobotPlatform.prototype = {
     accessories: function (callback) {
         let accessories = [];
-
         let that = this;
+        that.boundaryNames = [];
         this.getRobots(function () {
-			for (var i = 0; i < that.robots.length; i++) {
+            if (that.robots) {
-				that.log("Found robot #" + (i + 1) + " named \"" + that.robots[i].name + "\" with serial \"" + that.robots[i]._serial + "\"");
+                that.robots.forEach((robot, i) => {
-				var robotAccessory = new NeatoVacuumRobotAccessory(that.robots[i], that);
+                    that.log("Found robot #" + (i + 1) + " named \"" + robot.name + "\" with serial \"" + robot._serial + "\"");
+                    let robotAccessory = new NeatoVacuumRobotAccessory(robot, that);
                     accessories.push(robotAccessory);
-				that.robots[i].maps.forEach((map) => {
+                    if (robot.maps) {
+                        robot.maps.forEach((map) => {
+                            if (map.boundaries) {
                                 map.boundaries.forEach((boundary) => {
                                     if (boundary.type === "polygon") {
-							accessories.push(new NeatoVacuumRobotAccessory(that.robots[i], that, boundary))
+                                        accessories.push(new NeatoVacuumRobotAccessory(robot, that, boundary))
                                     }
                                 })
+                            }
+                        })
+                    }
                 })
             }
             callback(accessories);
@@ -63,23 +69,20 @@ NeatoVacuumRobotPlatform.prototype = {
         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.");
+                that.log.error("Can't log on to neato cloud. Please check your internet connection and your credentials. Try again later if the neato servers have issues.");
                 callback();
-			}
+            } else {
-			else {
                 client.getRobots((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;
@@ -91,17 +94,21 @@ NeatoVacuumRobotPlatform.prototype = {
                                         return;
                                     }
                                     robot.maps = result;
-									let processedMapCount = 0
+                                    let processedMapCount = 0;
+                                    if (robot.maps.length === 0)
+                                    {
+                                        callback();
+                                    }
                                     robot.maps.forEach((map) => {
                                         robot.getMapBoundaries(map.id, (error, result) => {
-											if(error) {
+                                            if (error) {
                                                 this.log("error getting boundaries: " + error + ": " + result)
                                             } else {
                                                 map.boundaries = result.boundaries;
                                             }
                                             processedMapCount++;
-											if(processedMapCount == robot.maps.length) {
+                                            if (processedMapCount == robot.maps.length) {
-												updatedRobotCount++
+                                                updatedRobotCount++;
                                                 if (updatedRobotCount === that.robots.length) {
                                                     callback();
                                                 }
@@ -116,7 +123,7 @@ NeatoVacuumRobotPlatform.prototype = {
             }
         });
     }
-}
+};
 
 function NeatoVacuumRobotAccessory(robot, platform, boundary) {
     this.platform = platform;
@@ -125,16 +132,29 @@ function NeatoVacuumRobotAccessory(robot, platform, boundary) {
     this.refresh = platform.refresh;
     this.hiddenServices = platform.hiddenServices;
     this.robot = robot;
-	if(!this.boundary) {
+    if (!this.boundary) {
         this.name = robot.name;
     } else {
+        // if boundary name already exists
+        if (platform.boundaryNames.includes(this.boundary.name)) {
+            let lastChar = this.boundary.name.slice(-1);
+            // boundary name already contains a count number
+            if (!isNaN(lastChar)) {
+                // Increment existing count number
+                this.boundary.name = this.boundary.name.slice(0, -1) + (parseInt(lastChar) + 1);
+            } else {
+                // Add a new count number
+                this.boundary.name = this.boundary.name + " 2";
+            }
+        }
+        platform.boundaryNames.push(this.boundary.name);
         this.name = this.robot.name + ' - ' + this.boundary.name;
     }
     this.lastUpdate = null;
 
     this.vacuumRobotBatteryService = new Service.BatteryService("Battery", "battery");
 
-	if(!this.boundary) {
+    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");
@@ -145,7 +165,7 @@ function NeatoVacuumRobotAccessory(robot, platform, boundary) {
     } else {
         const splitName = boundary.name.split(' ');
         let serviceName = "Clean the " + boundary.name;
-		if(splitName.length >= 2 && splitName[splitName.length-2].match(/[']s$/g)){
+        if (splitName.length >= 2 && splitName[splitName.length - 2].match(/[']s$/g)) {
             serviceName = "Clean " + boundary.name;
         }
         this.vacuumRobotCleanBoundaryService =
@@ -178,7 +198,7 @@ NeatoVacuumRobotAccessory.prototype = {
             .setCharacteristic(Characteristic.Manufacturer, "Neato Robotics")
             .setCharacteristic(Characteristic.Model, "Coming soon")
             .setCharacteristic(Characteristic.SerialNumber, this.robot._serial);
-		if(!this.boundary) {
+        if (!this.boundary) {
             this.informationService
                 .setCharacteristic(Characteristic.Name, this.robot.name)
         } else {
@@ -191,7 +211,7 @@ NeatoVacuumRobotAccessory.prototype = {
 
         this.services = [this.informationService, this.vacuumRobotBatteryService];
 
-	    if(!this.boundary) {
+        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));
 
@@ -228,13 +248,13 @@ NeatoVacuumRobotAccessory.prototype = {
                 this.services.push(this.vacuumRobotScheduleService);
         }
 
-	    if(this.boundary){
+        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);
         }
 
@@ -243,15 +263,15 @@ NeatoVacuumRobotAccessory.prototype = {
 
     setCleanBoundary: function (boundaryId, on, callback) {
         this.updateRobot((error, result) => {
-		if(on){
+            if (on) {
-		    if(this.robot.canStart) {
+                if (this.robot.canStart) {
-			this.log("Starting to clean: "+boundaryId);
+                    this.log("Starting to clean: " + boundaryId);
                     this.robot.startCleaningBoundary(this.eco, this.extraCare, boundaryId, (error, result) => {
-			    if (error){
+                        if (error) {
-				this.log(error+": "+JSON.stringify(result));
+                            this.log(error + ": " + JSON.stringify(result));
                         }
                         callback();
-			})
+                    });
                     return
                 } else {
                     this.log("Error, robot is already cleaning");
@@ -261,8 +281,7 @@ NeatoVacuumRobotAccessory.prototype = {
                     debug(this.name + ": Pause cleaning");
                     this.robot.pauseCleaning(callback);
                     return;
-		    }
+                } else {
-		    else {
                     debug(this.name + ": Already stopped");
                 }
             }
@@ -293,8 +312,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;
@@ -305,26 +323,22 @@ NeatoVacuumRobotAccessory.prototype = {
                             nogoLines,
                             function (error, result) {
                                 if (error) {
-					    that.log.error(error + ": " + result);
+                                    that.log.error("Cannot start cleaning. " + error + ": " + result);
                                     callback(true);
-					}
+                                } else {
-					else {
                                     callback();
                                 }
                             });
                     }
-			}
+                } else {
-			else {
+                    debug(that.name + ": Cannot start, maybe already cleaning");
-			    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();
                 }
@@ -344,12 +358,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();
                 }
@@ -383,8 +395,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);
             }
@@ -464,12 +475,11 @@ 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) {
-					that.log.error(error + ": " + result);
+                    that.log.error("Cannot update robot. Check if robot is online. " + error);
                 }
                 that.lastUpdate = new Date();
                 callback();
@@ -503,7 +513,7 @@ NeatoVacuumRobotAccessory.prototype = {
                 that.vacuumRobotExtraCareService.setCharacteristic(Characteristic.On, that.robot.navigationMode == 2 ? true : false);
 
             } else {
-		    if(this.vacuumRobotCleanBoundaryService.getCharacteristic(Characteristic.On).value !== that.robot.canPause) {
+                if (this.vacuumRobotCleanBoundaryService.getCharacteristic(Characteristic.On).value !== that.robot.canPause) {
                     this.vacuumRobotCleanBoundaryService.setCharacteristic(Characteristic.On, that.robot.canPause);
                 }
             }
@@ -513,7 +523,7 @@ NeatoVacuumRobotAccessory.prototype = {
 
             // 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);
             }
@@ -521,10 +531,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.6.0",
+  "version": "0.6.3",
   "description": "A Neato vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [