Add language support to README.md

CHANGELOG.md

@@ -116,4 +116,7 @@
 * Fixed robot not shown before setting up a floor plan
 
 ## 0.7.2
-* Fixed homebridge crash with multiple robots per account
+* Fixed homebridge crash with multiple robots per account
+
+## 0.7.3
+* Fixed warnings since homebridge 1.3.0

README.md

@@ -7,7 +7,7 @@ This is a plugin for [homebridge](https://github.com/nfarina/homebridge) to cont
 
 If you like this plugin and find it useful, I would be forever grateful for your support:
 
-<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>
+<a href="https://www.buymeacoffee.com/naofireblade" 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>
 
 Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
 
@@ -19,8 +19,8 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
   - Nogo lines
 - Zone cleaning <sup>[1](#d7)</sup><sup>, </sup><sup>[2](#change-room)</sup>
 - Spot cleaning
-  - Individual spot size <sup>[1](#d7)</sup>
+  - Individual spot size <sup>[1](#d7)</sup><sup>, </sup><sup>[3](#eve)</sup>
-  - Clean twice
+  - Clean twice <sup>[3](#eve)</sup>
 - Return to dock
 - Find the robot
 - Schedule (de)activation
@@ -31,11 +31,16 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
   - Model and firmware version
 - Automatic or periodic refresh of robot state
 - Multiple robots
+- Multiple language support (en, de, fr)
 
 > <b name="d7">1</b> Only available on the Neato D7.  
 
 > <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`
@@ -54,7 +59,8 @@ Add the following information to your config file. Change the values for email a
 	{
 		"platform": "NeatoVacuumRobot",
 		"email": "YourEmail",
-		"password": "YourPassword"
+		"password": "YourPassword",
+		"language": "de"
 	}
 ]
 ```
@@ -78,6 +84,7 @@ List of plugin features that you don't want to use in homekit (e.g. `dock`, `doc
 		"platform": "NeatoVacuumRobot",
 		"email": "YourEmail",
 		"password": "YourPassword",
+		"language": "de",
 		"refresh": "120",
 		"hidden": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule", "find", "spot"]
 	}
@@ -93,4 +100,4 @@ 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
+- [DJay](https://github.com/DJay-X) for testing out tons of new beta versions

accessories/neatoVacuumRobot.js

@@ -38,6 +38,48 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
 	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;
@@ -64,20 +106,20 @@ 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");
 
-		this.spotCleanService = new Service.Switch(this.name + " Clean Spot", "cleanSpot");
+		this.spotCleanService = new Service.Switch(this.name + " " + this.dict["cleanSpot"], "cleanSpot");
 		this.spotCleanService.addCharacteristic(SpotRepeatCharacteristic);
 		if (this.spotPlusFeatures)
 		{
@@ -88,10 +130,10 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
 	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);
 	}
@@ -231,12 +273,14 @@ 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);
 					}
 					// Cannot start
@@ -273,7 +317,10 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (this.robot.canPause)
 				{
 					debug(this.name + ": ## Pause cleaning");
-					this.robot.pauseCleaning(callback);
+					this.robot.pauseCleaning((error) =>
+					{
+						callback(error);
+					});
 				}
 				else
 				{
@@ -309,12 +356,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 		// Room cleaning
@@ -325,12 +368,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start room cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 		// Spot cleaning
@@ -341,12 +380,8 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (error)
 				{
 					this.log.error("Cannot start spot cleaning. " + error + ": " + JSON.stringify(result));
-					callback(true);
-				}
-				else
-				{
-					callback();
 				}
+				callback(error);
 			});
 		}
 	},
@@ -370,14 +405,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
 				{
@@ -456,12 +497,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);
+				});
 			}
 		});
 	},
@@ -481,13 +528,16 @@ 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)
@@ -527,7 +577,10 @@ NeatoVacuumRobotAccessory.prototype = {
 				if (this.robot.canPause)
 				{
 					debug(this.name + ": ## Pause cleaning");
-					this.robot.pauseCleaning(callback);
+					this.robot.pauseCleaning((error) =>
+					{
+						callback(error);
+					});
 				}
 				else
 				{
@@ -645,8 +698,13 @@ NeatoVacuumRobotAccessory.prototype = {
 
 			if (this.spotPlusFeatures)
 			{
-					this.spotCleanService.setCharacteristic(SpotWidthCharacteristic, this.robot.spotWidth);
+				let widthProps = this.spotCleanService.getCharacteristic(SpotWidthCharacteristic).props;
-					this.spotCleanService.setCharacteristic(SpotHeightCharacteristic, this.robot.spotHeight);
+				let heightProps = this.spotCleanService.getCharacteristic(SpotHeightCharacteristic).props;
+
+				this.spotCleanService.setCharacteristic(SpotWidthCharacteristic,
+					this.robot.spotWidth >= widthProps.minValue && this.robot.spotWidth <= widthProps.maxValue ? this.robot.spotWidth : widthProps.minValue);
+				this.spotCleanService.setCharacteristic(SpotHeightCharacteristic,
+					this.robot.spotHeight >= heightProps.minValue && this.robot.spotHeight <= heightProps.maxValue ? this.robot.spotHeight : heightProps.minValue);
 			}
 		}
 
@@ -663,4 +721,4 @@ NeatoVacuumRobotAccessory.prototype = {
 			});
 		}
 	}
-};
+};

config.schema.json

@@ -17,7 +17,33 @@
             "type": "string",
             "required": true,
             "description": "Your Password"
+        },
+        "language": {
+          "title": "language",
+          "type": "string",
+          "default": "en",
+          "oneOf": [
+            {
+              "title": "English",
+              "enum": [
+                "en"
+              ]
+            },
+            {
+              "title": "German",
+              "enum": [
+                "de"
+              ]
+            },
+            {
+              "title": "French",
+              "enum": [
+                "fr"
+              ]
+            }
+          ],
+          "required": true
         }
       }
     }
-}
+}

index.js

@@ -21,6 +21,7 @@ function NeatoVacuumRobotPlatform(log, config)
 	this.serial = "1-3-3-7";
 	this.email = config['email'];
 	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);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-neato",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "description": "A Neato vacuum robot plugin for homebridge.",
   "license": "MIT",
   "keywords": [