Version 0.4.1

* Added config parameter for extraCareNavigation

.gitattributes

@@ -1,17 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto
-
-# Custom for Visual Studio
-*.cs     diff=csharp
-
-# Standard to msysgit
-*.doc	 diff=astextplain
-*.DOC	 diff=astextplain
-*.docx diff=astextplain
-*.DOCX diff=astextplain
-*.dot  diff=astextplain
-*.DOT  diff=astextplain
-*.pdf  diff=astextplain
-*.PDF	 diff=astextplain
-*.rtf	 diff=astextplain
-*.RTF	 diff=astextplain

.gitignore

@@ -1,47 +0,0 @@
-# Windows image file caches
-Thumbs.db
-ehthumbs.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-# =========================
-# Operating System Files
-# =========================
-
-# OSX
-# =========================
-
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk

CHANGELOG.md

@@ -4,4 +4,41 @@
 * Added return to base
 * Added enable and disable schedule
 * Added enable and disable eco mode
-* Added battery info
+* Added battery info
+
+## 0.2.0
+
+* Added dock info
+* Improved logging to use a debug library
+
+## 0.2.1
+
+* Improved the go to dock command
+
+## 0.3.0
+
+* Added periodic refresh of robot state while cleaning
+* Added optional periodic refresh of robot state while not cleaning
+* Added error messages when cant login or get robot
+* Improved go to dock switch to be enabled as soon as possible without manual refresh
+* Improved switches to indicate the time an action needs to complete
+* Improved eco mode to not be overwritten by robot state update
+
+## 0.3.1
+
+* Added support for Neato BotVac D5 Connected
+
+## 0.3.2
+
+* Fixed a bug that refresh is not disabled when set to 0
+
+## 0.4.0
+
+* Added support for multiple robots
+* Added log output when user requests accessory identify
+* Changed plugin to platform instead of single accessory
+* Removed parameter name from config
+
+## 0.4.1
+
+* Added config parameter for extraCareNavigation

README.md

@@ -1,40 +1,71 @@
 # homebridge-neato
 
-This is a plugin to control your [Neato](https://www.neatorobotics.com/) vacuum robot.
+This is a plugin for [homebridge](https://github.com/nfarina/homebridge) to control your [Neato](https://www.neatorobotics.com/) vacuum robot. You can download it via [npm](https://www.npmjs.com/package/homebridge-neato).
 
-# Installation
+Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
 
-1. Install homebridge using: npm install -g homebridge
-2. Install this plugin using: npm install -g homebridge-neato
-3. Update your configuration file. See the sample below.
-
-# Configuration
-
-Configuration sample:
-
-Add the following information to your config file. Change the values for name, email and password.
-
-```json
-"accessories": [
-		{
-			"accessory": "NeatoVacuumRobot",
-			"name": "YourRobot",
-			"email": "YourEmail",
-			"password": "YourPassword"
-		}
-    ]
-```
+If you update from a previous version 0.3.x you have to adapt your config.
 
 # Features
 
-- Atart and pause cleaning
-- Return to base
+- Start and pause cleaning
+- Return to dock\*
 - Enable and disable schedule
 - Enable and disable eco mode
 - Get battery info
+- Get dock info
+- Periodic refresh of robot state
+- Support for multiple robots
+- Extra care navigation
+
+\* Available after some seconds of cleaning.
+
+# Installation
+
+1. Install homebridge using: `npm install -g homebridge`
+2. Install this plugin using: `npm install -g homebridge-neato`
+3. If you don't have a Neato account yet create one [here](https://www.neatorobotics.com/create-account/).
+4. Update your configuration file. See the sample below.
+
+### Configuration
+
+Add the following information to your config file. Change the values for name, email and password.
+
+#### Simple
+
+```json
+"platforms": [
+	{
+		"platform": "NeatoVacuumRobot",
+		"email": "YourEmail",
+		"password": "YourPassword"
+	}
+]
+```
+
+The following config contains optional settings that are disabled when not specified.
+
+The parameter **refresh** adjusts in what interval (seconds) changes of the robot state will be pushed to homekit. The minimum refresh time is 60 seconds. You need this only when you set up rules based on the robot state and start him outside of homekit (e.g. with the Neato app).
+
+The parameter **extraCareNavigation** determines if supporting models (currently Neato D3 and D5) take extra care of your furniture while cleaning.
+
+#### Advanced
+
+```json
+"platforms": [
+	{
+		"platform": "NeatoVacuumRobot",
+		"email": "YourEmail",
+		"password": "YourPassword",
+		"refresh": "120",
+		"extraCareNavigation": true
+	}
+]
+```
 
 # Tested robots
 
-- BotVac Connected Firmware 2.2.0
+- BotVac Connected (Firmware 2.2.0)
+- BotVac D5 Connected
 
-if you have another connected neato robot, please [tell me](https://github.com/naofireblade/homebridge-neato/issues/new) your experience with this plugin.
+If you have another connected neato robot, please [tell me](https://github.com/naofireblade/homebridge-neato/issues) about your experience with this plugin.

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

index.js

@@ -1,154 +1,267 @@
 "use strict";
-var inherits = require('util').inherits;
-var botvac = require('node-botvac');
+var inherits = require('util').inherits,
+	debug = require('debug')('homebridge-neato'),
+	botvac = require('node-botvac'),
 
-var Service, Characteristic;
+	Service,
+	Characteristic
 
 module.exports = function (homebridge) {
 	Service = homebridge.hap.Service;
 	Characteristic = homebridge.hap.Characteristic;
-	homebridge.registerAccessory("homebridge-neato", "NeatoVacuumRobot", NeatoVacuumRobot);
+	homebridge.registerPlatform("homebridge-neato", "NeatoVacuumRobot", NeatoVacuumRobotPlatform);
 }
 
-function NeatoVacuumRobot(log, config) {
+function NeatoVacuumRobotPlatform(log, config) {
 	this.log = log;
-	this.name = config['name'];
 	this.serial = "1-3-3-7";
 	this.email = config['email'];
 	this.password = config['password'];
 
-	this.lastUpdate = null;
-	this.robot = null;
+	this.careNavigation = ('extraCareNavigation' in config && config['extraCareNavigation'] ? 2 : 1);
+	debug("Extra Care Navigation: " + this.careNavigation);
+
+	// default off
+	this.refresh = ('refresh' in config ? parseInt(config['refresh']) : 0);
+	// must be integer and positive
+	this.refresh = (typeof this.refresh !=='number' || (this.refresh%1)!==0 || this.refresh < 0) ? 0 : this.refresh;
+	// minimum 60s
+	this.refresh = (this.refresh > 0 && this.refresh < 60) ? 60 : this.refresh;
 }
 
-NeatoVacuumRobot.prototype = {
+NeatoVacuumRobotPlatform.prototype = {
+	accessories: function(callback) {
+		this.accessories = [];
+
+		let that = this;
+		this.robots = this.getRobots(function () {
+			for (var i = 0; i < that.robots.length; i++) {
+				that.log("Found robot #" + (i+1) + ": " + that.robots[i].name);
+				var robotAccessory = new NeatoVacuumRobotAccessory(that.robots[i], that);
+				that.accessories.push(robotAccessory);
+			}
+			callback(that.accessories);
+		});
+	},
+
+	getRobots: function(callback) {
+		debug("Get all robots");
+		let client = new botvac.Client();
+		let that = this;
+		client.authorize(this.email, this.password, false, function (error) {
+			if (error) {
+				that.log(error);
+				that.log.error("Can't log on to neato cloud. Please check your credentials.");
+				callback();
+			}
+			else {
+				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 {
+						if (robots.length === 0) {
+							that.log.error("Successful login but no robots associated with your account.");
+							callback();					
+						}
+						else {
+							that.robots = robots;
+							callback();
+						}
+					}
+				});
+			}
+		});
+	}
+}
+
+function NeatoVacuumRobotAccessory(robot, platform) {
+	this.platform = platform;
+	this.log = platform.log;
+	this.refresh = platform.refresh;
+	this.careNavigation = platform.careNavigation;
+	this.robot = robot;
+	this.name = robot.name;
+	this.lastUpdate = null;
+
+	this.vacuumRobotCleanService = new Service.Switch(this.name + " 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.vacuumRobotScheduleService = new Service.Switch(this.name + " Schedule", "schedule");
+	this.vacuumRobotBatteryService = new Service.BatteryService("Battery", "battery");
+
+	this.updateRobotTimer();	
+}
+
+
+NeatoVacuumRobotAccessory.prototype = {
 	identify: function (callback) {
-		this.log("Identify requested");
-		callback();
+		let that = this;
+		this.updateRobot(function() {
+			// hide serial and secret in log
+			let _serial = that.robot._serial;
+			let _secret = that.robot._secret;
+			that.robot._serial = "*****";
+			that.robot._secret = "*****";
+			that.log(that.robot);
+			that.robot._serial = _serial;
+			that.robot._secret = _secret;
+			callback();
+		});
 	},
 
 	getServices: function () {
+		debug(this.robot._serial);
 		this.informationService = new Service.AccessoryInformation();
 		this.informationService
+		.setCharacteristic(Characteristic.Name, this.robot.name)
 		.setCharacteristic(Characteristic.Manufacturer, "Neato Robotics")
-		.setCharacteristic(Characteristic.Model, this.name)
-		.setCharacteristic(Characteristic.SerialNumber, this.serial);
+		.setCharacteristic(Characteristic.Model, "Coming soon")
+		.setCharacteristic(Characteristic.SerialNumber, this.robot._serial);
 
-		this.vacuumRobotCleanService = new Service.Switch(this.name + " Clean", "clean");
-		this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('set', this.clean.bind(this));
+		this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('set', this.setClean.bind(this));
 		this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('get', this.getClean.bind(this));
 
-		this.vacuumRobotDockService = new Service.Switch(this.name + " Dock", "dock");
-		this.vacuumRobotDockService.getCharacteristic(Characteristic.On).on('set', this.dock.bind(this));
-		this.vacuumRobotDockService.getCharacteristic(Characteristic.On).on('get', this.getDock.bind(this));
+		this.vacuumRobotGoToDockService.getCharacteristic(Characteristic.On).on('set', this.setGoToDock.bind(this));
+		this.vacuumRobotGoToDockService.getCharacteristic(Characteristic.On).on('get', this.getGoToDock.bind(this));
 
-		this.vacuumRobotEcoService = new Service.Switch(this.name + " Eco Mode", "eco");
-		this.vacuumRobotEcoService.getCharacteristic(Characteristic.On).on('set', this.eco.bind(this));
+		this.vacuumRobotDockStateService.getCharacteristic(Characteristic.OccupancyDetected).on('get', this.getDock.bind(this));
+
+		this.vacuumRobotEcoService.getCharacteristic(Characteristic.On).on('set', this.setEco.bind(this));
 		this.vacuumRobotEcoService.getCharacteristic(Characteristic.On).on('get', this.getEco.bind(this));
 
-		this.vacuumRobotScheduleService = new Service.Switch(this.name + " Schedule", "schedule");
-		this.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).on('set', this.schedule.bind(this));
+		this.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).on('set', this.setSchedule.bind(this));
 		this.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).on('get', this.getSchedule.bind(this));
 
-		this.vacuumRobotBatteryService = new Service.BatteryService("Battery", "battery");
 		this.vacuumRobotBatteryService.getCharacteristic(Characteristic.BatteryLevel).on('get', this.getBatteryLevel.bind(this));
 		this.vacuumRobotBatteryService.getCharacteristic(Characteristic.ChargingState).on('get', this.getBatteryChargingState.bind(this));
 
-		return [this.informationService, this.vacuumRobotCleanService, this.vacuumRobotDockService, this.vacuumRobotEcoService,
+		return [this.informationService, this.vacuumRobotCleanService, this.vacuumRobotGoToDockService, this.vacuumRobotDockStateService, this.vacuumRobotEcoService,
 			this.vacuumRobotScheduleService, this.vacuumRobotBatteryService];
 	},
 
-	clean: function (on, callback) {
+	setClean: function (on, callback) {
 		let that = this;
-		if (on) {
-			this.getState(function (error, result) {
-				that.log(that.robot);
-				if (that.robot.canResume === true) {
-					that.log("Resume cleaning");
-					that.robot.resumeCleaning(function (error, result) {
-						that.log(result);
-					});
+		this.updateRobot(function (error, result) {
+			if (on) {
+				if (that.robot.canResume || that.robot.canStart) {
+					// wait for robot to start and then start a short timer to recognize when he can go to dock or is finished
+					setTimeout(function() {
+						clearTimeout(that.timer);
+						that.updateRobotTimer();
+					}, 10000);
+
+					if (that.robot.canResume) {
+						debug(that.name + ": Resume cleaning");
+						that.robot.resumeCleaning(callback);
+					}
+					else {
+						debug(that.name + ": Start cleaning (" + that.careNavigation + ")");
+						that.robot.startCleaning(that.robot.eco, that.careNavigation, callback);
+					}
 				}
 				else {
-					that.log("Start cleaning");
-					that.robot.startCleaning(that.robot.eco, function (error, result) {
-						that.log(result);
+					debug(that.name + ": Cant start, maybe already cleaning");
+					callback();
+				}
+			}
+			else {
+				if (that.robot.canPause) {
+					debug(that.name + ": Pause cleaning");
+					that.robot.pauseCleaning(callback);
+				}
+				else {
+					debug(that.name + ": Already stopped");
+					callback();
+				}
+			}
+		});
+	},
+
+	setGoToDock: function (on, callback) {
+		let that = this;
+		this.updateRobot(function (error, result) {
+			if (on) {
+				if (that.robot.canPause) {
+					debug(that.name + ": Pause cleaning to go to dock");
+					that.robot.pauseCleaning(function (error, result) {
+						setTimeout(function() {
+							debug("Go to dock");
+						    that.robot.sendToBase(callback);
+						}, 1000);
 					});
 				}
-			});
-		}
-		else {
-			this.log("Pause cleaning");
-			this.robot.pauseCleaning(false, function (error, result) {
-				that.log(result);
-			});
-		}
-		callback();
+				else if (that.robot.canGoToBase)
+				{
+					debug(that.name + ": Go to dock");
+					that.robot.sendToBase(callback);
+				}
+				else {
+					debug(that.name + ": Can't go to dock at the moment");
+					callback();
+				}
+			} else {
+				callback();
+			}
+		});
 	},
 
-	dock: function (on, callback) {
-		let that = this;
-		that.log(that.robot);
-		if (on) {
-			that.log("Send to dock");
-			that.robot.sendToBase(false, function (error, result) {
-				that.log(result);
-			});
-		}
-		callback();
-	},
-
-	eco: function (on, callback) {
-		this.log(on ? "Enable eco mode" : "Disable eco mode");
+	setEco: function (on, callback) {
+		debug(this.name + ": " + (on ? "Enable eco mode" : "Disable eco mode"));
 		this.robot.eco = on;
 		callback();
 	},
 
-	schedule: function (on, callback) {
-		if (on) {
-			this.log("Enable schedule");
-			this.robot.enableSchedule(false, function (error, result) {
-				onsole.log(result);
-			}); 
-		}
-		else {
-			this.log("Disable schedule");
-			this.robot.disableSchedule(false, function (error, result) {
-				onsole.log(result);
-			}); 
-		}
-		callback();
+	setSchedule: function (on, callback) {
+		let that = this;
+		this.updateRobot(function (error, result) {
+			if (on) {
+				debug(that.name + ": Enable schedule");
+				that.robot.enableSchedule(callback); 
+			}
+			else {
+				debug(that.name + ": Disable schedule");
+				that.robot.disableSchedule(callback); 
+			}
+		});
 	},
 
 	getClean: function(callback) {
 		let that = this;
-		this.getState(function (error, result) {
-			that.log("Is cleaning: " + that.robot.canPause);
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Is cleaning: " + that.robot.canPause);
 			callback(false, that.robot.canPause);
 		});
 	},
 
+	getGoToDock: function(callback) {
+		let that = this;
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Can go to dock: " + that.robot.dockHasBeenSeen);
+			callback(false, !that.robot.dockHasBeenSeen);
+		});
+	},
+
 	getDock: function(callback) {
 		let that = this;
-		this.getState(function (error, result) {
-			that.log("Can go to dock: " + that.robot.canGoToBase);
-			that.log("Is docked: " + that.robot.isDocked);
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Is docked: " + that.robot.isDocked);
 			callback(false, that.robot.isDocked);
 		});
 	},
 
 	getEco: function(callback) {
-		let that = this;
-		this.getState(function (error, result) {
-			that.log("Eco mode: " + that.robot.eco);
-			callback(false, that.robot.eco);
-		});
+		// dont load eco here, because we cant save the eco state on the robot
+		callback(false, this.robot.eco);
 	},
 
 	getSchedule: function(callback) {
 		let that = this;
-		this.getState(function (error, result) {
-			that.log("Schedule: " + that.robot.isScheduleEnabled);
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Schedule: " + that.robot.isScheduleEnabled);
 			callback(false, that.robot.isScheduleEnabled);
 		});
 	},
@@ -156,41 +269,28 @@ NeatoVacuumRobot.prototype = {
 
 	getBatteryLevel: function(callback) {
 		let that = this;
-		this.getState(function (error, result) {
-			that.log("Battery: " + that.robot.charge);
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Battery: " + that.robot.charge);
 			callback(false, that.robot.charge);
 		});
 	},
 
 	getBatteryChargingState: function(callback) {
 		let that = this;
-		this.getState(function (error, result) {
-			that.log("Is charging: " + that.robot.isCharging);
+		this.updateRobot(function (error, result) {
+			debug(that.name + ": Is charging: " + that.robot.isCharging);
 			callback(false, that.robot.isCharging);
 		});
 	},
 
-	getState: function(callback) {
+	updateRobot: function(callback) {
 		let that = this;
-		if (this.robot === null)
-		{
-			this.getRobot(function (error, result) {
-				that._getState(callback);
-			});
-		}
-		else {
-			that._getState(callback);
-		}	
-	},
-
-	_getState: function(callback) {
 		if (this.lastUpdate !== null && new Date() - this.lastUpdate < 2000) {
-			//this.log("Get state (cached)");
+			debug(this.name + ": Update (cached)");
 			callback();
 		}
 		else {
-			//this.log("Get state (new)");
-			let that = this;
+			debug(this.name + ": Update (online)");
 			this.robot.getState(function (error, result) {
 				that.lastUpdate = new Date();
 				callback();
@@ -198,26 +298,42 @@ NeatoVacuumRobot.prototype = {
 		}
 	},
 
-	getRobot: function(callback) {
-		//this.log("Get robot");
-		let client = new botvac.Client();
+	updateRobotTimer: function() {
 		let that = this;
-		client.authorize(this.email, this.password, false, function (error) {
-			if (error) {
-				that.log(error);
+		debug(this.name + ": Timer called");
+		this.updateRobot(function (error, result) {
+
+			// 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);
+			}
+
+			if (that.vacuumRobotGoToDockService.getCharacteristic(Characteristic.On).value !== !that.robot.dockHasBeenSeen) {
+				that.vacuumRobotGoToDockService.setCharacteristic(Characteristic.On, !that.robot.dockHasBeenSeen);
+			}
+
+			if (that.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).value !== that.robot.isScheduleEnabled) {
+				that.vacuumRobotScheduleService.setCharacteristic(Characteristic.On, that.robot.isScheduleEnabled);
+			}
+
+			// no commands here, values can be updated without problems
+			that.vacuumRobotDockStateService.setCharacteristic(Characteristic.OccupancyDetected, that.robot.isDocked);
+			that.vacuumRobotBatteryService.setCharacteristic(Characteristic.BatteryLevel, that.robot.charge);
+			that.vacuumRobotBatteryService.setCharacteristic(Characteristic.ChargingState, that.robot.isCharging);
+
+			// dont update eco, because we cant write that value onto the robot and dont want it to be overwritten in our plugin
+
+			if (that.robot.canPause) {
+				debug(that.name + ": Timer set (cleaning): 30s");
+				that.timer = setTimeout(that.updateRobotTimer.bind(that), 30 * 1000);			
+			}
+			else if (that.refresh != 0) {
+				debug(that.name + ": Timer set (user): " + that.refresh + "s");
+				that.timer = setTimeout(that.updateRobotTimer.bind(that), that.refresh * 1000);
 			}
 			else {
-				client.getRobots(function (error, robots) {
-					if (error) {
-						that.log(error);
-					}
-					else {
-						that.robot = robots[0];
-						that.log("Found robot: " + that.robot.name);
-						callback();
-					}
-				});
+				debug(that.name + ": Timer stopped");
 			}
 		});
-	}
+	},
 }

package.json

@@ -1,10 +1,12 @@
 {
   "name": "homebridge-neato",
-  "version": "0.1.0",
-  "description": "control your neato vacuum robot",
+  "version": "0.4.1",
+  "description": "A Neato vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [
-    "homebridge-plugin"
+    "homebridge-plugin",
+    "neato",
+    "botvac"
   ],
   "engines": {
     "node": ">=0.12.0",
@@ -18,6 +20,7 @@
     "url": "git://github.com/naofireblade/homebridge-neato.git"
   },
   "dependencies": {
-    "node-botvac": ">=0.1.4"
+    "node-botvac": ">=0.1.5",
+    "debug": "^2.2.0"
   }
 }