Updated readme and changelog

ADDED
- NoGo lines button
- Extra care navigation button
- Syncing cleaning options from last run

CHANGED
- Goto dock button is now always off
- Better error handling
- More detailed debug messages
- Updated node-botvac dependency to 0.1.6

REMOVED
- Extra care navigation option parameter (is now a button)

CHANGELOG.md

@@ -37,4 +37,41 @@
 * 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
+* Removed parameter name from config
+
+## 0.4.1
+
+* Added config parameter for extraCareNavigation
+
+## 0.4.2
+
+* Added config parameter to disable switches/sensors
+
+## 0.4.4
+
+* Fixed config parameter to disable switches/sensors not optional
+
+## 0.4.5
+
+* Fixed compatibility with homebridge 0.4.23 (occupancy sensor not working)
+
+## 0.4.6
+
+* Added error log while refreshing robot state
+* Fixed a rare bug where the robot stops after some seconds of cleaning
+
+## 0.4.7
+
+* Fixed an exception when no robot is associated with the account
+
+## 0.5.0
+
+* Added noGo lines button
+* Added extra care navigation button
+* Added syncing cleaning options from last run
+* Added option to disable background state update completely
+* Changed goto dock button is now always off
+* Changed error handling
+* Changed debug messages
+* Updated node-botvac dependency to 0.1.6
+* Removed extra care navigation option parameter (is now a button)

README.md

@@ -1,38 +1,57 @@
 # homebridge-neato
+[![npm](https://img.shields.io/npm/v/homebridge-neato.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-neato)
+[![npm](https://img.shields.io/npm/dt/homebridge-neato.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-neato)
+[![GitHub last commit](https://img.shields.io/github/last-commit/naofireblade/homebridge-neato.svg?style=flat-square)](https://github.com/naofireblade/homebridge-neato)
 
 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).
 
 Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
 
-If you update from a previous version you have to adapt your config.
+If you update from a previous version 0.3.x you have to adapt your config (plugin is now a platform).
 
-# Features
+## Features
 
 - Start and pause cleaning
-- Return to dock\*
-- Enable and disable schedule
-- Enable and disable eco mode
+- Return to dock
+- Toggle schedule
+- Toggle eco mode
+- Toggle extra care navigation
+- toggle nogo lines
 - Get battery info
 - Get dock info
 - Periodic refresh of robot state
 - Support for multiple robots
 
-\* Available after some seconds of cleaning.
-
-**Hint:** To control the robot with your own commands just set up a scene with the name of your choice.
-
-# Installation
+## 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
+## Configuration
 
-Add the following information to your config file. Change the values for name, email and password.
+Add the following information to your config file. Change the values for email and password.
 
-The parameter **refresh** is optional (default 0=off) and 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).
+### Simple
+
+```json
+"platforms": [
+	{
+		"platform": "NeatoVacuumRobot",
+		"email": "YourEmail",
+		"password": "YourPassword"
+	}
+]
+```
+
+### Advanced
+
+The following config contains advanced optional settings.
+
+The parameter **refresh** sets an interval in seconds that is used to update the robot state in the background. This is only required for automations based on the robot state. The default value is `auto` which means that the update is automatically enabled while cleaning and disabled while not cleaning. You can set a value in seconds e.g. `120` to enable background updates even when the robot is not cleaning. You can also disable background updates completely by setting the value `0`. This might be required if you experience timeouts in the app because you have other home automation apps that are connected to your robot.
+
+The parameter **disabled** accepts a list of switches/sensors that can be disabled in the neato homekit plugin (e.g. dock, dockstate, eco, schedule).
 
 ```json
 "platforms": [
@@ -40,14 +59,21 @@ The parameter **refresh** is optional (default 0=off) and adjusts in what interv
 		"platform": "NeatoVacuumRobot",
 		"email": "YourEmail",
 		"password": "YourPassword",
-		"refresh": "0"
+		"refresh": "120",
+		"disabled": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule"]
 	}
 ]
 ```
 
-# Tested robots
+## Tested robots
 
 - BotVac Connected (Firmware 2.2.0)
-- BotVac D5 Connected
+- BotVac D3 Connected
+- BotVac D5 Connected (Firmware 4.0.0, Firmware 4.3.0)
+- BotVac D7 Connected
 
-If you have another connected neato robot, please [tell me](https://github.com/naofireblade/homebridge-neato/issues) about your experience with this plugin.
+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.
+
+## 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

index.js

@@ -17,23 +17,31 @@ function NeatoVacuumRobotPlatform(log, config) {
 	this.serial = "1-3-3-7";
 	this.email = config['email'];
 	this.password = config['password'];
+	this.hiddenServices = ('disabled' in config ? config['disabled'] : '');
 
-	// 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;
+	if ('refresh' in config && config['refresh'] !== 'auto') {
+		// parse config parameter
+		this.refresh = parseInt(config['refresh']);
+		// must be integer and positive
+		this.refresh = (typeof this.refresh !== 'number' || (this.refresh % 1) !== 0 || this.refresh < 0) ? 60 : this.refresh;
+		// minimum 60s to save some load on the neato servers
+		this.refresh = (this.refresh > 0 && this.refresh < 60) ? 60 : this.refresh;
+	}
+	// default auto
+	else {
+		this.refresh = 'auto';
+	}
+	debug("Refresh is set to: " + this.refresh);
 }
 
 NeatoVacuumRobotPlatform.prototype = {
-	accessories: function(callback) {
+	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);
+				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);
 				that.accessories.push(robotAccessory);
 			}
@@ -41,8 +49,8 @@ NeatoVacuumRobotPlatform.prototype = {
 		});
 	},
 
-	getRobots: function(callback) {
-		debug("Get all robots");
+	getRobots: function (callback) {
+		debug("Loading your robots");
 		let client = new botvac.Client();
 		let that = this;
 		client.authorize(this.email, this.password, false, function (error) {
@@ -61,9 +69,11 @@ NeatoVacuumRobotPlatform.prototype = {
 					else {
 						if (robots.length === 0) {
 							that.log.error("Successful login but no robots associated with your account.");
-							callback();					
+							that.robots = [];
+							callback();
 						}
 						else {
+							debug("Found " + robots.length + " robots");
 							that.robots = robots;
 							callback();
 						}
@@ -78,6 +88,7 @@ function NeatoVacuumRobotAccessory(robot, platform) {
 	this.platform = platform;
 	this.log = platform.log;
 	this.refresh = platform.refresh;
+	this.hiddenServices = platform.hiddenServices;
 	this.robot = robot;
 	this.name = robot.name;
 	this.lastUpdate = null;
@@ -86,17 +97,19 @@ function NeatoVacuumRobotAccessory(robot, platform) {
 	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");
 
-	this.updateRobotTimer();	
+	this.updateRobotTimer();
 }
 
 
 NeatoVacuumRobotAccessory.prototype = {
 	identify: function (callback) {
 		let that = this;
-		this.updateRobot(function() {
+		this.updateRobot(function () {
 			// hide serial and secret in log
 			let _serial = that.robot._serial;
 			let _secret = that.robot._secret;
@@ -110,13 +123,12 @@ NeatoVacuumRobotAccessory.prototype = {
 	},
 
 	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, "Coming soon")
-		.setCharacteristic(Characteristic.SerialNumber, this.robot._serial);
+			.setCharacteristic(Characteristic.Name, this.robot.name)
+			.setCharacteristic(Characteristic.Manufacturer, "Neato Robotics")
+			.setCharacteristic(Characteristic.Model, "Coming soon")
+			.setCharacteristic(Characteristic.SerialNumber, this.robot._serial);
 
 		this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('set', this.setClean.bind(this));
 		this.vacuumRobotCleanService.getCharacteristic(Characteristic.On).on('get', this.getClean.bind(this));
@@ -129,14 +141,33 @@ NeatoVacuumRobotAccessory.prototype = {
 		this.vacuumRobotEcoService.getCharacteristic(Characteristic.On).on('set', this.setEco.bind(this));
 		this.vacuumRobotEcoService.getCharacteristic(Characteristic.On).on('get', this.getEco.bind(this));
 
+		this.vacuumRobotNoGoLinesService.getCharacteristic(Characteristic.On).on('set', this.setNoGoLines.bind(this));
+		this.vacuumRobotNoGoLinesService.getCharacteristic(Characteristic.On).on('get', this.getNoGoLines.bind(this));
+
+		this.vacuumRobotExtraCareService.getCharacteristic(Characteristic.On).on('set', this.setExtraCare.bind(this));
+		this.vacuumRobotExtraCareService.getCharacteristic(Characteristic.On).on('get', this.getExtraCare.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.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.vacuumRobotGoToDockService, this.vacuumRobotDockStateService, this.vacuumRobotEcoService,
-			this.vacuumRobotScheduleService, this.vacuumRobotBatteryService];
+		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)
+			this.services.push(this.vacuumRobotDockStateService);
+		if (this.hiddenServices.indexOf('eco') === -1)
+			this.services.push(this.vacuumRobotEcoService);
+		if (this.hiddenServices.indexOf('nogolines') === -1)
+			this.services.push(this.vacuumRobotNoGoLinesService);
+		if (this.hiddenServices.indexOf('extracare') === -1)
+			this.services.push(this.vacuumRobotExtraCareService);
+		if (this.hiddenServices.indexOf('schedule') === -1)
+			this.services.push(this.vacuumRobotScheduleService);
+
+		return this.services;
 	},
 
 	setClean: function (on, callback) {
@@ -144,19 +175,37 @@ NeatoVacuumRobotAccessory.prototype = {
 		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);
+
+					// start extra update robot timer if refresh is set to "auto"
+					if (that.refresh === 'auto') {
+						setTimeout(function () {
+							clearTimeout(that.timer);
+							that.updateRobotTimer();
+						}, 60 * 1000);
+					}
 
 					if (that.robot.canResume) {
 						debug(that.name + ": Resume cleaning");
 						that.robot.resumeCleaning(callback);
 					}
 					else {
-						debug(that.name + ": Start cleaning");
-						that.robot.startCleaning(that.robot.eco, 2, callback);
+						let eco = that.vacuumRobotEcoService.getCharacteristic(Characteristic.On).value;
+						let extraCare = that.vacuumRobotExtraCareService.getCharacteristic(Characteristic.On).value;
+						let nogoLines = that.vacuumRobotNoGoLinesService.getCharacteristic(Characteristic.On).value;
+						debug(that.name + ": Start cleaning (eco: " + eco + ", extraCare: " + extraCare + ", nogoLines: " + nogoLines + ")");
+						that.robot.startCleaning(
+							eco,
+							extraCare ? 2 : 1,
+							nogoLines,
+							function (error, result) {
+								if (error) {
+									that.log.error(error + ": " + result);
+									callback(true);
+								}
+								else {
+									callback();
+								}
+							});
 					}
 				}
 				else {
@@ -184,19 +233,18 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (that.robot.canPause) {
 					debug(that.name + ": Pause cleaning to go to dock");
 					that.robot.pauseCleaning(function (error, result) {
-						setTimeout(function() {
+						setTimeout(function () {
 							debug("Go to dock");
-						    that.robot.sendToBase(callback);
+							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 {
-					debug(that.name + ": Can't go to dock at the moment");
+					that.log.warn(that.name + ": Can't go to dock at the moment");
 					callback();
 				}
 			} else {
@@ -211,21 +259,33 @@ NeatoVacuumRobotAccessory.prototype = {
 		callback();
 	},
 
+	setNoGoLines: function (on, callback) {
+		debug(this.name + ": " + (on ? "Enable nogo lines" : "Disable nogo lines"));
+		this.robot.noGoLines = on;
+		callback();
+	},
+
+	setExtraCare: function (on, callback) {
+		debug(this.name + ": " + (on ? "Enable extra care navigation" : "Disable extra care navigation"));
+		this.robot.navigationMode = on ? 2 : 1;
+		callback();
+	},
+
 	setSchedule: function (on, callback) {
 		let that = this;
 		this.updateRobot(function (error, result) {
 			if (on) {
 				debug(that.name + ": Enable schedule");
-				that.robot.enableSchedule(callback); 
+				that.robot.enableSchedule(callback);
 			}
 			else {
 				debug(that.name + ": Disable schedule");
-				that.robot.disableSchedule(callback); 
+				that.robot.disableSchedule(callback);
 			}
 		});
 	},
 
-	getClean: function(callback) {
+	getClean: function (callback) {
 		let that = this;
 		this.updateRobot(function (error, result) {
 			debug(that.name + ": Is cleaning: " + that.robot.canPause);
@@ -233,70 +293,86 @@ NeatoVacuumRobotAccessory.prototype = {
 		});
 	},
 
-	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);
-		});
+	getGoToDock: function (callback) {
+		callback(false, false);
 	},
 
-	getDock: function(callback) {
+	getDock: function (callback) {
 		let that = this;
-		this.updateRobot(function (error, result) {
+		this.updateRobot(function () {
 			debug(that.name + ": Is docked: " + that.robot.isDocked);
-			callback(false, that.robot.isDocked);
+			callback(false, that.robot.isDocked ? 1 : 0);
 		});
 	},
 
-	getEco: function(callback) {
-		// dont load eco here, because we cant save the eco state on the robot
-		callback(false, this.robot.eco);
+	getEco: function (callback) {
+		let that = this;
+		this.updateRobot(function () {
+			debug(that.name + ": Is eco: " + that.robot.eco);
+			callback(false, that.robot.eco);
+		});
 	},
 
-	getSchedule: function(callback) {
+	getNoGoLines: function (callback) {
 		let that = this;
-		this.updateRobot(function (error, result) {
-			debug(that.name + ": Schedule: " + that.robot.isScheduleEnabled);
+		this.updateRobot(function () {
+			debug(that.name + ": Is nogo lines: " + that.robot.noGoLines);
+			callback(false, that.robot.noGoLines ? 1 : 0);
+		});
+	},
+
+	getExtraCare: function (callback) {
+		let that = this;
+		this.updateRobot(function () {
+			debug(that.name + ": Is extra care navigation: " + (that.robot.navigationMode == 2 ? true : false));
+			callback(false, that.robot.navigationMode == 2 ? 1 : 0);
+		});
+	},
+
+	getSchedule: function (callback) {
+		let that = this;
+		this.updateRobot(function () {
+			debug(that.name + ": Is schedule: " + that.robot.isScheduleEnabled);
 			callback(false, that.robot.isScheduleEnabled);
 		});
 	},
 
 
-	getBatteryLevel: function(callback) {
+	getBatteryLevel: function (callback) {
 		let that = this;
-		this.updateRobot(function (error, result) {
-			debug(that.name + ": Battery: " + that.robot.charge);
+		this.updateRobot(function () {
+			debug(that.name + ": Battery: " + that.robot.charge + "%");
 			callback(false, that.robot.charge);
 		});
 	},
 
-	getBatteryChargingState: function(callback) {
+	getBatteryChargingState: function (callback) {
 		let that = this;
-		this.updateRobot(function (error, result) {
+		this.updateRobot(function () {
 			debug(that.name + ": Is charging: " + that.robot.isCharging);
 			callback(false, that.robot.isCharging);
 		});
 	},
 
-	updateRobot: function(callback) {
+	updateRobot: function (callback) {
 		let that = this;
 		if (this.lastUpdate !== null && new Date() - this.lastUpdate < 2000) {
-			debug(this.name + ": Update (cached)");
 			callback();
 		}
 		else {
-			debug(this.name + ": Update (online)");
+			debug(this.name + ": Updating robot state");
 			this.robot.getState(function (error, result) {
+				if (error) {
+					that.log.error(error + ": " + result);
+				}
 				that.lastUpdate = new Date();
 				callback();
 			});
 		}
 	},
 
-	updateRobotTimer: function() {
+	updateRobotTimer: function () {
 		let that = this;
-		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
@@ -304,8 +380,9 @@ NeatoVacuumRobotAccessory.prototype = {
 				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);
+			// dock switch is on (dock not seen before) and dock has just been seen -> turn switch off
+			if (that.vacuumRobotGoToDockService.getCharacteristic(Characteristic.On).value == true && that.robot.dockHasBeenSeen) {
+				that.vacuumRobotGoToDockService.setCharacteristic(Characteristic.On, false);
 			}
 
 			if (that.vacuumRobotScheduleService.getCharacteristic(Characteristic.On).value !== that.robot.isScheduleEnabled) {
@@ -313,22 +390,26 @@ NeatoVacuumRobotAccessory.prototype = {
 			}
 
 			// no commands here, values can be updated without problems
-			that.vacuumRobotDockStateService.setCharacteristic(Characteristic.OccupancyDetected, that.robot.isDocked);
+			that.vacuumRobotDockStateService.setCharacteristic(Characteristic.OccupancyDetected, that.robot.isDocked ? 1 : 0);
+			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);
 			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);			
+			// 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
+				debug("Updating state in background every " + refreshTime + " seconds while cleaning");
+				that.timer = setTimeout(that.updateRobotTimer.bind(that), refreshTime * 1000);
 			}
-			else if (that.refresh != 0) {
-				debug(that.name + ": Timer set (user): " + that.refresh + "s");
+			// robot is not cleaning, but a specific refresh interval is set
+			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 {
-				debug(that.name + ": Timer stopped");
+				debug("Updating state in background disabled");
 			}
 		});
 	},

package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-neato",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "A Neato vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [
@@ -20,7 +20,7 @@
     "url": "git://github.com/naofireblade/homebridge-neato.git"
   },
   "dependencies": {
-    "node-botvac": ">=0.1.5",
+    "node-botvac": ">=0.1.6",
     "debug": "^2.2.0"
   }
 }