just drying someting

Add npm shield tag

.github/workflows/npm.yml

@@ -0,0 +1,19 @@
+name: npm
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    # Setup .npmrc file to publish to npm
+    - uses: actions/setup-node@v2
+      with:
+        node-version: '12.x'
+        registry-url: 'https://registry.npmjs.org'
+    - run: npm install
+    - run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -110,4 +110,26 @@
 * Added logic to be able to change the currently cleaned room
 * Improved number of requests when having multiple rooms
 * Fixed room switches not taking eco and extraCare mode into account
-* Fixed room switches to support pause/resume
+* Fixed room switches not supporting pause/resume
+
+## 0.7.1
+* Fixed robot not shown before setting up a floor plan
+
+## 0.7.2
+* Fixed homebridge crash with multiple robots per account
+
+## 0.8.0
+* Add German plugin language (for example, this gives you a "Sauge Küche" Siri command for a zone called "Küche")
+* Added possibility to toggle between languages (English/German) in Homebridge UI Plugin Settings
+
+## 0.8.1
+* Include Robot name in Homekit battery service name
+
+## 0.8.2
+* Eliminate warnings on Homebridge >= 1.3.0 (77945f8 and 877c3d7 on `naofireblade/homebridge-neato`)
+
+## 0.8.3
+* Add French plugin language (for example, this gives you a "Aspirer la cuisine" Siri command for a zone called "La cuisine")
+
+## 0.8.4
+* Link to token getter tool in homebridge UI 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Arne Blumentritt
+Copyright (c) 2020 Luis Riegger
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,15 +1,14 @@
-# homebridge-neato
+[![Latest NPM release](https://img.shields.io/npm/v/homebridge-kobold.svg)](https://www.npmjs.com/package/homebridge-kobold)
-[![npm](https://img.shields.io/npm/v/homebridge-neato)](https://www.npmjs.com/package/homebridge-neato)
+[![NPM Downloads](https://img.shields.io/npm/dt/homebridge-kobold.svg)](https://www.npmjs.com/package/homebridge-kobold?activeTab=versions)
-[![npm](https://img.shields.io/npm/dt/homebridge-neato)](https://www.npmjs.com/package/homebridge-neato?activeTab=versions)
-[![GitHub last commit](https://img.shields.io/github/last-commit/naofireblade/homebridge-neato)](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).
 
-If you like this plugin and find it useful, I would be forever grateful for your support:
+# homebridge-kobold
 
-<a href="https://www.buymeacoffee.com/2D1nUuK36" target="_blank"><img width="140" src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee"></a>
+This is a plugin for [homebridge](https://github.com/nfarina/homebridge) to control your [Vorwerk Kobold](https://kobold.vorwerk.de/saugroboter/) VR300 vacuum robot. You can download it via [npm](https://www.npmjs.com/package/homebridge-kobold).
 
-Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
+It is based on a fork of naofireblade's [homebridge-neato](https://github.com/naofireblade/homebridge-neato), merged with the oAuth authentication mechanism from nicoh88's [homebridge-vorwerk](https://github.com/nicoh88/homebridge-vorwerk).
+
+The interaction with the Server is handled by the underlying [node-kobold-control](https://github.com/himbeles/node-kobold-control) module.
 
 ## Features
 
@@ -17,10 +16,10 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
   - Eco mode
   - Extra care navigation
   - Nogo lines
-- Zone cleaning* (only D7)
+- Zone cleaning <sup>[1](#change-room)</sup>
 - Spot cleaning
-  - Individual spot size (only D7)
+  - Individual spot size <sup>[2](#eve)</sup>
-  - Clean twice
+  - Clean twice <sup>[2](#eve)</sup>
 - Return to dock
 - Find the robot
 - Schedule (de)activation
@@ -32,58 +31,101 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
 - Automatic or periodic refresh of robot state
 - Multiple robots
 
->*You can also send the robot from one room to another. He will return to the base, wait there some seconds and then starts cleaning the other room.
+- German, English or French Language Setting
+
+> <b name="change-room">2</b> You can send the robot from one room to another as well. He will return to the base, wait there some seconds and then starts cleaning the next room.
+
+> <b name="eve">3</b> You need a third party app like eve to access these features.
+
+
 
 ## Installation
 
 1. Install homebridge using: `npm install -g homebridge`
-2. Install this plugin using: `npm install -g homebridge-neato`
+2. Install this plugin using: `npm install -g homebridge-kobold`
-3. If you don't have a Neato account yet, create one [here](https://www.neatorobotics.com/create-account/).
+3. Update your configuration file. See the sample below.
-4. Update your configuration file. See the sample below.
 
 ## Configuration
 
-Add the following information to your config file. Change the values for email and password.
+Add the following information to your config file. Adapt the value for `token`.
 
 ### Simple
 
 ```json
 "platforms": [
   {
-		"platform": "NeatoVacuumRobot",
+    "platform": "KoboldVacuumRobot",
-		"email": "YourEmail",
+    "token": "YourToken",
-		"password": "YourPassword"
+    "language": "de"
   }
 ]
 ```
 
+You can get a token using the GUI tool [Kobold Token Getter](https://github.com/himbeles/kobold-token-get) or using the following two curl commands:
+
+```bash
+# This will trigger the email sending
+curl -X "POST" "https://mykobold.eu.auth0.com/passwordless/start" \
+     -H 'Content-Type: application/json' \
+     -d '{
+  "send": "code",
+  "email": "ENTER_YOUR_EMAIL_HERE",
+  "client_id": "KY4YbVAvtgB7lp8vIbWQ7zLk3hssZlhR",
+  "connection": "email"
+}'
+```
+==== wait for the email to be received ====
+
+```bash
+# this will generate a token using the numbers you received via email
+# replace the value of otp 123456 with the value you received from the email
+curl -X "POST" "https://mykobold.eu.auth0.com/oauth/token" \
+     -H 'Content-Type: application/json' \
+     -d '{
+  "prompt": "login",
+  "grant_type": "http://auth0.com/oauth/grant-type/passwordless/otp",
+  "scope": "openid email profile read:current_user",
+  "locale": "en",
+  "otp": "123456",
+  "source": "vorwerk_auth0",
+  "platform": "ios",
+  "audience": "https://mykobold.eu.auth0.com/userinfo",
+  "username": "ENTER_YOUR_EMAIL_HERE",
+  "client_id": "KY4YbVAvtgB7lp8vIbWQ7zLk3hssZlhR",
+  "realm": "email",
+  "country_code": "DE"
+}'
+```
+
+From the output, you want to copy the `id_token` value.
+
+The `language` can be `de` for German, `en` for English, or `fr` for French.
+
 ### Advanced
 
-The following config contains advanced optional settings.
+Below are explanations for advanced parameters to adjust the plugin to your needs. All parameters are *optional*.
 
-The parameter **refresh** is default set to `auto` and updates the robot state when a cleaning was started via homekit so that you can activate automations based on a successful cleaning. If you want to get robot state updates after starting the cleaning from outside of homekit as well (neato app or schedule), you have to set refresh to a static value in seconds e.g. `120`. You can disable background updates completely by setting this to `0`.
+**refresh**  
+Timer for periodic refresh of robot state. The default is `auto`. The options are:  
+`auto` Updates the robot state when a cleaning was started via homekit so that you can activate automations based on a successful cleaning.  
+`120` Or any other time in seconds (minimum `60`) is required if you want to receive robot state updates after starting the cleaning from outside of homekit (e.g. neato app or schedule).  
+`0` Disables background updates completely.
 
-The parameter **hidden** accepts a list of switches/sensors that can be hidden from homekit (e.g. `dock`, `dockstate`, `eco`, `nogolines`, `extracare`, `schedule`, `find`, `spot`).
+**hidden**  
+List of plugin features that you don't want to use in homekit (e.g. `dock`, `dockstate`, `eco`, `nogolines`, `extracare`, `schedule`, `find`, `spot`).
 
 ```json
 "platforms": [
   {
-		"platform": "NeatoVacuumRobot",
+    "platform": "KoboldVacuumRobot",
-		"email": "YourEmail",
+    "token": "YourToken",
-		"password": "YourPassword",
     "refresh": "120",
-		"hidden": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule", "find", "spot"]
+    "hidden": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule", "find", "spot"],
+    "language": "de"
   }
 ]
 ```
 
 ## Tested robots
 
-The plugin is successfully tested with all Neato Connected Robots.
+- Vorwerk Kobold VR300
-
-## 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
-- [DJay](https://github.com/DJay-X) for testing out tons of new beta versions

_config.yml

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

accessories/koboldVacuumRobot.js

@@ -1,4 +1,4 @@
-const debug = require('debug')('homebridge-neato');
+const debug = require('debug')('homebridge-kobold');
 const colors = require('colors');
 
 const CustomUUID = {
@@ -17,11 +17,14 @@ module.exports = function (_Service, _Characteristic)
 {
 	Service = _Service;
 	Characteristic = _Characteristic;
+	SpotWidthCharacteristic = require('../characteristics/spotWidth')(Characteristic, CustomUUID);
+	SpotHeightCharacteristic = require('../characteristics/spotHeight')(Characteristic, CustomUUID);
+	SpotRepeatCharacteristic = require('../characteristics/spotRepeat')(Characteristic, CustomUUID);
 
-	return NeatoVacuumRobotAccessory;
+	return KoboldVacuumRobotAccessory;
 };
 
-function NeatoVacuumRobotAccessory(platform, robotObject)
+function KoboldVacuumRobotAccessory(platform, robotObject)
 {
 	this.platform = platform;
 	this.log = platform.log;
@@ -32,9 +35,51 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
 	this.robotObject = robotObject;
 	this.robot = robotObject.device;
 	this.meta = robotObject.meta;
-	this.availableServices = robotObject.availableServices;
+	this.spotPlusFeatures = ((typeof robotObject.availableServices.spotCleaning !== 'undefined') && robotObject.availableServices.spotCleaning.includes("basic"));
 	this.boundary = (typeof robotObject.boundary === 'undefined') ? null : robotObject.boundary;
 
+	this.dict = {
+		'en': {
+			"clean": "Clean",
+			"clean the": "Clean the",
+			"goToDock": "Go to Dock",
+			"dockState": "Dock",
+			"eco": "Eco Mode",
+			"noGoLines": "NoGo Lines",
+			"extraCare": "Extra Care",
+			"schedule": "Schedule",
+			"findMe": "Find me",
+			"cleanSpot": "Clean Spot",
+			"battery": "Battery"
+		},
+		'de': {
+			"clean": "Sauge",
+			"clean the": "Sauge",
+			"goToDock": "Zur Basis",
+			"dockState": "In der Basis",
+			"eco": "Eco Modus",
+			"noGoLines": "NoGo Linien",
+			"extraCare": "Extra Care",
+			"schedule": "Zeitplan",
+			"findMe": "Finde mich",
+			"cleanSpot": "Spot Reinigung",
+			"battery": "Batterie"
+		},
+		'fr': {
+			"clean": "Aspirer",
+			"clean the": "Aspirer",
+			"goToDock": "Retour à la base",
+			"dockState": "Sur la base",
+			"eco": "Eco mode",
+			"noGoLines": "Lignes NoGo",
+			"extraCare": "Extra Care",
+			"schedule": "Planifier",
+			"findMe": "Me retrouver",
+			"cleanSpot": "Nettoyage local",
+			"battery": "Batterie"
+		}
+	}[this.platform.language]
+
 	if (this.boundary == null)
 	{
 		this.name = this.robot.name;
@@ -61,53 +106,43 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
 		this.name = this.robot.name + ' - ' + this.boundary.name;
 	}
 
-	this.batteryService = new Service.BatteryService("Battery", "battery");
+	this.batteryService = new Service.BatteryService(this.name + " " + this.dict["battery"], "battery");
 
 	if (this.boundary == null)
 	{
-		this.cleanService = new Service.Switch(this.name + " Clean", "clean");
+		this.cleanService = new Service.Switch(this.name + " " + this.dict["clean"], "clean");
-		this.goToDockService = new Service.Switch(this.name + " Go to Dock", "goToDock");
+		this.goToDockService = new Service.Switch(this.name + " " + this.dict["goToDock"], "goToDock");
-		this.dockStateService = new Service.OccupancySensor(this.name + " Dock", "dockState");
+		this.dockStateService = new Service.OccupancySensor(this.name + " " + this.dict["dockState"], "dockState");
-		this.ecoService = new Service.Switch(this.name + " Eco Mode", "eco");
+		this.ecoService = new Service.Switch(this.name + " " + this.dict["eco"], "eco");
-		this.noGoLinesService = new Service.Switch(this.name + " NoGo Lines", "noGoLines");
+		this.noGoLinesService = new Service.Switch(this.name + " " + this.dict["noGoLines"], "noGoLines");
-		this.extraCareService = new Service.Switch(this.name + " Extra Care", "extraCare");
+		this.extraCareService = new Service.Switch(this.name + " " + this.dict["extraCare"], "extraCare");
-		this.scheduleService = new Service.Switch(this.name + " Schedule", "schedule");
+		this.scheduleService = new Service.Switch(this.name + " " + this.dict["schedule"], "schedule");
-		this.findMeService = new Service.Switch(this.name + " Find Me", "findMe");
+		this.findMeService = new Service.Switch(this.name + " " + this.dict["findMe"], "findMe");
 
-		SpotWidthCharacteristic = require('../characteristics/spotWidth')(Characteristic, CustomUUID);
+		this.spotCleanService = new Service.Switch(this.name + " " + this.dict["cleanSpot"], "cleanSpot");
-		SpotHeightCharacteristic = require('../characteristics/spotHeight')(Characteristic, CustomUUID);
+		this.spotCleanService.addCharacteristic(SpotRepeatCharacteristic);
-		SpotRepeatCharacteristic = require('../characteristics/spotRepeat')(Characteristic, CustomUUID);
+		if (this.spotPlusFeatures)
-
-		// Spot cleaning with advanced options
-		if ((typeof this.availableServices.spotCleaning !== 'undefined') && this.availableServices.spotCleaning.includes("basic"))
 		{
-			this.spotCleanAdvancedService = new Service.Switch(this.name + " Clean Spot", "cleanSpot");
+			this.spotCleanService.addCharacteristic(SpotWidthCharacteristic);
-			this.spotCleanAdvancedService.addCharacteristic(SpotRepeatCharacteristic);
+			this.spotCleanService.addCharacteristic(SpotHeightCharacteristic);
-			this.spotCleanAdvancedService.addCharacteristic(SpotWidthCharacteristic);
-			this.spotCleanAdvancedService.addCharacteristic(SpotHeightCharacteristic);
-		}
-		// Spot cleaning without advanced options
-		else
-		{
-			this.spotCleanSimpleService = new Service.Switch(this.name + " Clean Spot", "cleanSpot");
-			this.spotCleanSimpleService.addCharacteristic(SpotRepeatCharacteristic);
 		}
 	}
 	else
 	{
 		const splitName = this.boundary.name.split(' ');
-		let serviceName = "Clean the " + this.boundary.name;
+		let serviceName = this.dict["clean the"] + " " + this.boundary.name;
 		if (splitName.length >= 2 && splitName[splitName.length - 2].match(/[']s$/g))
 		{
-			serviceName = "Clean " + this.boundary.name;
+			serviceName = this.dict["clean"] + " " + this.boundary.name;
 		}
 		this.cleanService = new Service.Switch(serviceName, "cleanBoundary:" + this.boundary.id);
+		this.cleanService = new Service.Switch(serviceName + "1", "cleanBoundary:" + this.boundary.id)
 	}
 
 	this.log("Added cleaning device named: " + this.name);
 }
 
-NeatoVacuumRobotAccessory.prototype = {
+KoboldVacuumRobotAccessory.prototype = {
 	identify: function (callback)
 	{
 		this.robot.getState((error, result) =>
@@ -129,7 +164,7 @@ NeatoVacuumRobotAccessory.prototype = {
 	{
 		this.informationService = new Service.AccessoryInformation();
 		this.informationService
-		.setCharacteristic(Characteristic.Manufacturer, "Neato Robotics")
+		.setCharacteristic(Characteristic.Manufacturer, "Vorwerk Deutschland Stiftung & Co. KG")
 		.setCharacteristic(Characteristic.Model, this.meta.modelName)
 		.setCharacteristic(Characteristic.SerialNumber, this.robot._serial)
 		.setCharacteristic(Characteristic.FirmwareRevision, this.meta.firmware)
@@ -166,29 +201,22 @@ NeatoVacuumRobotAccessory.prototype = {
 			this.findMeService.getCharacteristic(Characteristic.On).on('set', this.setFindMe.bind(this));
 			this.findMeService.getCharacteristic(Characteristic.On).on('get', this.getFindMe.bind(this));
 
-			if (typeof this.spotCleanAdvancedService !== 'undefined')
+			this.spotCleanService.getCharacteristic(Characteristic.On).on('set', this.setSpotClean.bind(this));
-			{
+			this.spotCleanService.getCharacteristic(Characteristic.On).on('get', this.getSpotClean.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(Characteristic.On).on('set', this.setSpotClean.bind(this));
+			this.spotCleanService.getCharacteristic(SpotRepeatCharacteristic).on('set', this.setSpotRepeat.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(Characteristic.On).on('get', this.getSpotClean.bind(this));
+			this.spotCleanService.getCharacteristic(SpotRepeatCharacteristic).on('get', this.getSpotRepeat.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotRepeatCharacteristic).on('set', this.setSpotRepeat.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotRepeatCharacteristic).on('get', this.getSpotRepeat.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotWidthCharacteristic).on('set', this.setSpotWidth.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotWidthCharacteristic).on('get', this.getSpotWidth.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotHeightCharacteristic).on('set', this.setSpotHeight.bind(this));
-				this.spotCleanAdvancedService.getCharacteristic(SpotHeightCharacteristic).on('get', this.getSpotHeight.bind(this));
 
-				if (this.hiddenServices.indexOf('spot') === -1)
+			if (this.spotPlusFeatures)
-					this.services.push(this.spotCleanAdvancedService);
+			{
+				this.spotCleanService.getCharacteristic(SpotWidthCharacteristic).on('set', this.setSpotWidth.bind(this));
+				this.spotCleanService.getCharacteristic(SpotWidthCharacteristic).on('get', this.getSpotWidth.bind(this));
+				this.spotCleanService.getCharacteristic(SpotHeightCharacteristic).on('set', this.setSpotHeight.bind(this));
+				this.spotCleanService.getCharacteristic(SpotHeightCharacteristic).on('get', this.getSpotHeight.bind(this));
 			}
-			else
-			{
-				this.spotCleanSimpleService.getCharacteristic(Characteristic.On).on('set', this.setSpotClean.bind(this));
-				this.spotCleanSimpleService.getCharacteristic(Characteristic.On).on('get', this.getSpotClean.bind(this));
-				this.spotCleanSimpleService.getCharacteristic(SpotRepeatCharacteristic).on('set', this.setSpotRepeat.bind(this));
-				this.spotCleanSimpleService.getCharacteristic(SpotRepeatCharacteristic).on('get', this.getSpotRepeat.bind(this));
 
 			if (this.hiddenServices.indexOf('spot') === -1)
-					this.services.push(this.spotCleanSimpleService);
+			{
+				this.services.push(this.spotCleanService);
 			}
 
 			// Add optional services
@@ -246,13 +274,16 @@ NeatoVacuumRobotAccessory.prototype = {
 					if (this.robot.canResume)
 					{
 						debug(this.name + ": ## Resume cleaning");
-						this.robot.resumeCleaning(callback);
+						this.robot.resumeCleaning((error) =>
+						{
+							callback(error);
+						});
 					}
 					// Start cleaning
 					else if (this.robot.canStart)
 					{
 						debug(this.name + ": ## Start cleaning");
-						this.clean(callback, this.boundary);
+						this.clean(callback);
 					}
 					// Cannot start
 					else
@@ -278,7 +309,7 @@ NeatoVacuumRobotAccessory.prototype = {
 					else
 					{
 						debug(this.name + ": ## Start cleaning of new room");
-						this.clean(callback, this.boundary);
+						this.clean(callback);
 					}
 				}
 			}
@@ -288,7 +319,10 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (this.robot.canPause)
 				{
 					debug(this.name + ": ## Pause cleaning");
-					this.robot.pauseCleaning(callback);
+					this.robot.pauseCleaning((error) =>
+					{
+						callback(error);
+					});
 				}
 				else
 				{
@@ -324,12 +358,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 		// Room cleaning
@@ -340,12 +370,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start room cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 		// Spot cleaning
@@ -356,12 +382,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start spot cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 	},
@@ -385,14 +407,20 @@ NeatoVacuumRobotAccessory.prototype = {
 						setTimeout(() =>
 						{
 							debug(this.name + ": ## Go to dock");
-							this.robot.sendToBase(callback);
+							this.robot.sendToBase(() =>
+							{
+								callback();
+							});
 						}, 1000);
 					});
 				}
 				else if (this.robot.canGoToBase)
 				{
 					debug(this.name + ": ## Go to dock");
-					this.robot.sendToBase(callback);
+					this.robot.sendToBase(() =>
+					{
+						callback();
+					});
 				}
 				else
 				{
@@ -471,12 +499,18 @@ NeatoVacuumRobotAccessory.prototype = {
 			if (on)
 			{
 				debug(this.name + ": " + "Enabled".brightGreen + " Schedule");
-				this.robot.enableSchedule(callback);
+				this.robot.enableSchedule((error) =>
+				{
+					callback(error);
+				});
 			}
 			else
 			{
 				debug(this.name + ": " + "Disabled".red + " Schedule");
-				this.robot.disableSchedule(callback);
+				this.robot.disableSchedule((error) =>
+				{
+					callback(error);
+				});
 			}
 		});
 	},
@@ -496,23 +530,24 @@ NeatoVacuumRobotAccessory.prototype = {
 				this.findMeService.setCharacteristic(Characteristic.On, false);
 			}, 1000);
 
-			this.robot.findMe(callback);
+			this.robot.findMe((error) =>
+			{
+				callback(error);
+			});
 		}
 	},
 
 	getSpotClean: function (callback)
 	{
-		callback();
+		callback(false, this.spotCleanService.getCharacteristic(Characteristic.On).value);
 	},
 
 	setSpotClean: function (on, callback)
 	{
-		let spotCleanService = (typeof this.spotCleanAdvancedService !== 'undefined') ? this.spotCleanAdvancedService : this.spotCleanSimpleService;
-
 		let spot = {
-			width:  spotCleanService.getCharacteristic(SpotWidthCharacteristic).value,
+			width: this.spotPlusFeatures ? this.spotCleanService.getCharacteristic(SpotWidthCharacteristic).value : null,
-			height: spotCleanService.getCharacteristic(SpotHeightCharacteristic).value,
+			height: this.spotPlusFeatures ? this.spotCleanService.getCharacteristic(SpotHeightCharacteristic).value : null,
-			repeat: spotCleanService.getCharacteristic(SpotRepeatCharacteristic).value
+			repeat: this.spotCleanService.getCharacteristic(SpotRepeatCharacteristic).value
 		};
 
 		this.platform.updateRobot(this.robot._serial, (error, result) =>
@@ -544,7 +579,10 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (this.robot.canPause)
 				{
 					debug(this.name + ": ## Pause cleaning");
-					this.robot.pauseCleaning(callback);
+					this.robot.pauseCleaning((error) =>
+					{
+						callback(error);
+					});
 				}
 				else
 				{
@@ -658,15 +696,17 @@ NeatoVacuumRobotAccessory.prototype = {
 			this.noGoLinesService.setCharacteristic(Characteristic.On, this.robot.noGoLines);
 			this.extraCareService.setCharacteristic(Characteristic.On, this.robot.navigationMode == 2 ? true : false);
 
-			if (typeof this.spotCleanAdvancedService !== 'undefined')
+			this.spotCleanService.setCharacteristic(SpotRepeatCharacteristic, this.robot.spotRepeat);
+
+			if (this.spotPlusFeatures)
 			{
-				this.spotCleanAdvancedService.setCharacteristic(SpotWidthCharacteristic, this.robot.spotWidth);
+				let widthProps = this.spotCleanService.getCharacteristic(SpotWidthCharacteristic).props;
-				this.spotCleanAdvancedService.setCharacteristic(SpotHeightCharacteristic, this.robot.spotHeight);
+				let heightProps = this.spotCleanService.getCharacteristic(SpotHeightCharacteristic).props;
-				this.spotCleanAdvancedService.setCharacteristic(SpotRepeatCharacteristic, this.robot.spotRepeat);
+
-			}
+				this.spotCleanService.setCharacteristic(SpotWidthCharacteristic,
-			else
+					this.robot.spotWidth >= widthProps.minValue && this.robot.spotWidth <= widthProps.maxValue ? this.robot.spotWidth : widthProps.minValue);
-			{
+				this.spotCleanService.setCharacteristic(SpotHeightCharacteristic,
-				this.spotCleanSimpleService.setCharacteristic(SpotRepeatCharacteristic, this.robot.spotRepeat);
+					this.robot.spotHeight >= heightProps.minValue && this.robot.spotHeight <= heightProps.maxValue ? this.robot.spotHeight : heightProps.minValue);
 			}
 		}
 

config.schema.json

@@ -1,22 +1,41 @@
 {
-    "pluginAlias": "NeatoVacuumRobot",
+    "pluginAlias": "KoboldVacuumRobot",
     "pluginType": "platform",
-    "headerDisplay": "For Advanced settings like Refresh time interval or Disabled switches/sensors. [Check Here](https://github.com/naofireblade/homebridge-neato#readme)",
+    "headerDisplay": "For Advanced settings like the refresh time interval or disabled switches/sensors. [Check Here](https://github.com/himbeles/homebridge-kobold#readme)",
     "schema": {
       "type": "object",
       "properties": {
-        "email": {
+        "token": {
-          "title": "email",
+            "title": "token",
             "type": "string",
             "required": true,
-          "format": "email",
+            "description": "Your Kobold Token (https://git.io/J3g1b)"
-          "description": "Your Email Address"
         },
-        "password": {
+        "language": {
-            "title": "password",
+          "title": "language",
           "type": "string",
-            "required": true,
+          "default": "en",
-            "description": "Your Password"
+          "oneOf": [
+            {
+              "title": "English",
+              "enum": [
+                "en"
+              ]
+            },
+            {
+              "title": "German",
+              "enum": [
+                "de"
+              ]
+            },
+            {
+              "title": "French",
+              "enum": [
+                "fr"
+              ]
+            }
+          ],
+          "required": true
         }
       }
     }

index.js

@@ -1,24 +1,26 @@
 "use strict";
 let inherits = require('util').inherits,
-	debug = require('debug')('homebridge-neato'),
+	debug = require('debug')('homebridge-kobold'),
-	botvac = require('node-botvac'),
+	control = require('node-kobold-control'),
 
 	Service,
-	Characteristic;
+	Characteristic,
+	KoboldVacuumRobotAccessory;
 
 module.exports = function (homebridge)
 {
 	Service = homebridge.hap.Service;
 	Characteristic = homebridge.hap.Characteristic;
-	homebridge.registerPlatform("homebridge-neato", "NeatoVacuumRobot", NeatoVacuumRobotPlatform);
+	KoboldVacuumRobotAccessory = require('./accessories/koboldVacuumRobot')(Service, Characteristic);
+	homebridge.registerPlatform("homebridge-kobold", "KoboldVacuumRobot", KoboldVacuumRobotPlatform);
 };
 
-function NeatoVacuumRobotPlatform(log, config)
+function KoboldVacuumRobotPlatform(log, config)
 {
 	this.log = log;
 	this.serial = "1-3-3-7";
-	this.email = config['email'];
+	this.token = config['token'];
-	this.password = config['password'];
+	this.language = config['language'];
 	this.hiddenServices = '';
 	this.hiddenServices = ('disabled' in config ? config['disabled'] : this.hiddenServices);
 	this.hiddenServices = ('hidden' in config ? config['hidden'] : this.hiddenServices);
@@ -33,10 +35,10 @@ function NeatoVacuumRobotPlatform(log, config)
 		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
+		// minimum 60s to save some load on the Vorwerk servers
 		if (this.refresh > 0 && this.refresh < 60)
 		{
-			this.log.warn("Minimum refresh time is 60 seconds to not overload the neato servers");
+			this.log.warn("Minimum refresh time is 60 seconds to not overload the Vorwerk servers");
 			this.refresh = (this.refresh > 0 && this.refresh < 60) ? 60 : this.refresh;
 		}
 	}
@@ -48,33 +50,47 @@ function NeatoVacuumRobotPlatform(log, config)
 	this.log("Refresh is set to: " + this.refresh + (this.refresh !== 'auto' ? ' seconds' : ''));
 }
 
-NeatoVacuumRobotPlatform.prototype = {
+KoboldVacuumRobotPlatform.prototype = {
 	accessories: function (callback)
 	{
 		debug("Get robots");
 		let accessories = [];
 		this.boundaryNames = [];
+
 		this.getRobots(() =>
 		{
+			// // MOCK MULTIPLE ROBOTS START
+			// let client = new control.Client();
+			// client.authorize(this.token, (error) =>
+			// {
+			// 	client.getRobots((error, robs) =>
+			// 	{
+			// 		let testRobot = robs[0];
+			// 		testRobot.getState((error, result) =>
+			// 		{
+			// 			testRobot.name = "Testrobot";
+			// 			this.robots.push({device: testRobot, meta: result.meta, availableServices: result.availableServices});
+			// 			// MOCK MULTIPLE ROBOTS END
+
 						this.robots.forEach((robot, i) =>
 						{
-				this.log("Found robot #" + (i + 1) + " named \"" + robot.device.name + "\" with serial \"" + robot.device._serial.substring(0,9) + "XXXXXXXXXXXX\"");
+							this.log("Found robot #" + (i + 1) + " named \"" + robot.device.name + "\" with serial \"" + robot.device._serial.substring(0, 9) + "XXXXXXXXXXXX\"");
 
-				// Start Update Intervall
+							let mainAccessory = new KoboldVacuumRobotAccessory(this, robot);
-				this.updateRobotTimer(robot.device._serial);
-
-				let NeatoVacuumRobotAccessory = require('./accessories/neatoVacuumRobot')(Service, Characteristic);
-				let mainAccessory = new NeatoVacuumRobotAccessory(this, robot);
 							accessories.push(mainAccessory);
 
 							robot.mainAccessory = mainAccessory;
 							robot.roomAccessories = [];
 
-				// For testing purposes only
+							// Start Update Intervall
+							this.updateRobotTimer(robot.device._serial);
+
+							// // MOCK ZONE CLEANING START
 							// robot.boundary = {name: "Testroom", id: "1"};
-				// let roomAccessory = new NeatoVacuumRobotAccessory(this, robot);
+							// let roomAccessory = new KoboldVacuumRobotAccessory(this, robot);
 							// accessories.push(roomAccessory);
 							// robot.roomAccessories.push(roomAccessory);
+							// // MOCK ZONE CLEANING END
 
 							if (robot.device.maps)
 							{
@@ -87,7 +103,7 @@ NeatoVacuumRobotPlatform.prototype = {
 											if (boundary.type === "polygon")
 											{
 												robot.boundary = boundary;
-									let roomAccessory = new NeatoVacuumRobotAccessory(this, robot);
+												let roomAccessory = new KoboldVacuumRobotAccessory(this, robot);
 												accessories.push(roomAccessory);
 
 												robot.roomAccessories.push(roomAccessory);
@@ -98,30 +114,36 @@ NeatoVacuumRobotPlatform.prototype = {
 							}
 						});
 						callback(accessories);
+
+			// 			// MOCK MULTIPLE ROBOTS START
+			// 		});
+			// 	});
+			// });
+			// // MOCK MULTIPLE ROBOTS END
 		});
 	},
 
 	getRobots: function (callback)
 	{
 		debug("Loading your robots");
-		let client = new botvac.Client();
+		let client = new control.Client();
 
 		// Login
-		client.authorize(this.email, this.password, false, (error) =>
+		client.authorize(this.token, (error) =>
 		{
 			if (error)
 			{
-				this.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: " + error);
+				this.log.error("Can't log on to Vorwerk cloud. Please check your internet connection and your token. Try again later if the Vorwerk servers have issues: " + error);
 				callback();
 			}
 			else
 			{
-				// Get robots
+				// Get all robots
 				client.getRobots((error, robots) =>
 				{
 					if (error)
 					{
-						this.log.error("Successful login but can't connect to your neato robot: " + error);
+						this.log.error("Successful login but can't connect to your Vorwerk robot: " + error);
 						callback();
 					}
 					else if (robots.length === 0)
@@ -133,30 +155,47 @@ NeatoVacuumRobotPlatform.prototype = {
 					else
 					{
 						debug("Found " + robots.length + " robots");
-						let requestedRobot = 0;
+						let loadedRobots = 0;
 
 						robots.forEach((robot) =>
 						{
-							// Get Maps for each robot
+							// Get additional information for the robot
-							robot.getPersistentMaps((error, result) =>
+							robot.getState((error, state) =>
 							{
 								if (error)
 								{
-									this.log.error("Error updating persistent maps: " + error + ": " + result);
+									this.log.error("Error getting robot meta information: " + error + ": " + state);
-									callback();
-								}
-								else if (result.length === 0)
-								{
-									robot.maps = [];
 									callback();
 								}
 								else
 								{
-									robot.maps = result;
+									// Get all maps for each robot
-									let requestedMap = 0;
+									robot.getPersistentMaps((error, maps) =>
+									{
+										if (error)
+										{
+											this.log.error("Error updating persistent maps: " + error + ": " + maps);
+											callback();
+										}
+										// Robot has no maps
+										else if (maps.length === 0)
+										{
+											robot.maps = [];
+											this.robots.push({device: robot, meta: state.meta, availableServices: state.availableServices});
+											loadedRobots++;
+											if (loadedRobots === robots.length)
+											{
+												callback();
+											}
+										}
+										// Robot has maps
+										else
+										{
+											robot.maps = maps;
+											let loadedMaps = 0;
 											robot.maps.forEach((map) =>
 											{
-										// Get Map Boundary Lines
+												// Save zones in each map
 												robot.getMapBoundaries(map.id, (error, result) =>
 												{
 													if (error)
@@ -167,36 +206,24 @@ NeatoVacuumRobotPlatform.prototype = {
 													{
 														map.boundaries = result.boundaries;
 													}
-											requestedMap++;
+													loadedMaps++;
 
-											// Robot is completely requested if all maps are requested
+													// Robot is completely requested if zones for all maps are loaded
-											if (requestedMap === robot.maps.length)
+													if (loadedMaps === robot.maps.length)
 													{
-												// Get additional information
+														this.robots.push({device: robot, meta: state.meta, availableServices: state.availableServices});
-												robot.getState((error, result) =>
+														loadedRobots++;
-												{
+														if (loadedRobots === robots.length)
-													if (error)
-													{
-														this.log.error("Error getting robot meta information: " + error + ": " + result);
-														callback();
-													}
-													else
-													{
-														this.robots.push({device: robot, meta: result.meta, availableServices: result.availableServices});
-														requestedRobot++;
-
-														// Initial request is complete if all robots are requested.
-														if (requestedRobot === robots.length)
 														{
 															callback();
 														}
 													}
-												});
-											}
 												})
 											});
 										}
 									});
+								}
+							});
 						});
 					}
 				});

package.json

@@ -1,43 +1,35 @@
 {
-  "name": "homebridge-neato",
+  "name": "homebridge-kobold",
-  "version": "0.7.0",
+  "version": "0.8.4",
-  "description": "A Neato vacuum robot plugin for homebridge.",
+  "description": "A Vorwerk Kobold vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [
     "homebridge-plugin",
-    "neato",
+    "vorwerk",
-    "botvac"
+    "kobold"
   ],
   "engines": {
     "node": ">=0.12.0",
     "homebridge": ">=0.2.0"
   },
   "author": {
-    "name": "Arne Blumentritt",
+    "name": "Luis R.",
-    "url2": "https://github.com/naofireblade"
+    "url2": "https://github.com/himbeles"
   },
   "contributors": [
     {
-      "name": "ghulands",
+      "name": "Alexandre L.",
-      "url": "https://github.com/ghulands"
+      "url": "https://github.com/aluini"
-    },
-    {
-      "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"
+    "url": "git://github.com/himbeles/homebridge-kobold.git"
   },
   "dependencies": {
     "colors": "^1.4.0",
     "debug": "^4.1.1",
-    "node-botvac": ">=0.4.0",
+    "node-kobold-control": ">=0.4.2",
     "uuid": "^3.3.2"
   }
 }