NoGo Lines and options sync

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)

index.js

@@ -19,9 +19,6 @@ function NeatoVacuumRobotPlatform(log, config) {
 	this.password = config['password'];
 	this.hiddenServices = ('disabled' in config ? config['disabled'] : '');
 
-	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
@@ -37,7 +34,7 @@ NeatoVacuumRobotPlatform.prototype = {
 		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);
 			}
@@ -46,7 +43,7 @@ NeatoVacuumRobotPlatform.prototype = {
 	},
 
 	getRobots: function (callback) {
-		debug("Get all robots");
+		debug("Loading your robots");
 		let client = new botvac.Client();
 		let that = this;
 		client.authorize(this.email, this.password, false, function (error) {
@@ -69,6 +66,7 @@ NeatoVacuumRobotPlatform.prototype = {
 							callback();
 						}
 						else {
+							debug("Found " + robots.length + " robots");
 							that.robots = robots;
 							callback();
 						}
@@ -83,7 +81,6 @@ function NeatoVacuumRobotAccessory(robot, platform) {
 	this.platform = platform;
 	this.log = platform.log;
 	this.refresh = platform.refresh;
-	this.careNavigation = platform.careNavigation;
 	this.hiddenServices = platform.hiddenServices;
 	this.robot = robot;
 	this.name = robot.name;
@@ -93,6 +90,8 @@ 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");
 
@@ -117,7 +116,6 @@ NeatoVacuumRobotAccessory.prototype = {
 	},
 
 	getServices: function () {
-		debug(this.robot._serial);
 		this.informationService = new Service.AccessoryInformation();
 		this.informationService
 			.setCharacteristic(Characteristic.Name, this.robot.name)
@@ -136,6 +134,12 @@ 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));
 
@@ -149,6 +153,10 @@ NeatoVacuumRobotAccessory.prototype = {
 			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);
 
@@ -160,7 +168,8 @@ 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
+					// TODO
+					// start update robot timer if refresh ist "auto"
 					setTimeout(function () {
 						clearTimeout(that.timer);
 						that.updateRobotTimer();
@@ -171,8 +180,23 @@ NeatoVacuumRobotAccessory.prototype = {
 						that.robot.resumeCleaning(callback);
 					}
 					else {
-						debug(that.name + ": Start cleaning (" + that.careNavigation + ")");
+						let eco = that.vacuumRobotEcoService.getCharacteristic(Characteristic.On).value;
-						that.robot.startCleaning(that.robot.eco, that.careNavigation, callback);
+						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 {
@@ -206,13 +230,12 @@ NeatoVacuumRobotAccessory.prototype = {
 						}, 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 {
@@ -227,6 +250,18 @@ 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) {
@@ -250,30 +285,45 @@ NeatoVacuumRobotAccessory.prototype = {
 	},
 
 	getGoToDock: function (callback) {
-		let that = this;
+		callback(false, false);
-		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.updateRobot(function (error, result) {
+		this.updateRobot(function () {
 			debug(that.name + ": Is docked: " + 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
+		let that = this;
-		callback(false, this.robot.eco);
+		this.updateRobot(function () {
+			debug(that.name + ": Is eco: " + that.robot.eco);
+			callback(false, that.robot.eco);
+		});
+	},
+
+	getNoGoLines: function (callback) {
+		let that = this;
+		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 (error, result) {
+		this.updateRobot(function () {
-			debug(that.name + ": Schedule: " + that.robot.isScheduleEnabled);
+			debug(that.name + ": Is schedule: " + that.robot.isScheduleEnabled);
 			callback(false, that.robot.isScheduleEnabled);
 		});
 	},
@@ -281,15 +331,15 @@ NeatoVacuumRobotAccessory.prototype = {
 
 	getBatteryLevel: function (callback) {
 		let that = this;
-		this.updateRobot(function (error, result) {
+		this.updateRobot(function () {
-			debug(that.name + ": Battery: " + that.robot.charge);
+			debug(that.name + ": Battery: " + that.robot.charge + "%");
 			callback(false, that.robot.charge);
 		});
 	},
 
 	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);
 		});
@@ -298,15 +348,13 @@ NeatoVacuumRobotAccessory.prototype = {
 	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 while updating robot state.");
+					that.log.error(error + ": " + result);
-					that.log.error(error);
 				}
 				that.lastUpdate = new Date();
 				callback();
@@ -316,7 +364,6 @@ NeatoVacuumRobotAccessory.prototype = {
 
 	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
@@ -335,21 +382,22 @@ NeatoVacuumRobotAccessory.prototype = {
 
 			// no commands here, values can be updated without problems
 			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");
+				debug("Updating state in background every 30 seconds while cleaning");
 				that.timer = setTimeout(that.updateRobotTimer.bind(that), 30 * 1000);
 			}
 			else if (that.refresh != 0) {
-				debug(that.name + ": Timer set (user): " + that.refresh + "s");
+				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.7",
+  "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"
   }
 }