21 Commits

Author SHA1 Message Date
Luis Riegger
c847481487 Include Include Robot name in Homekit battery service name 2021-02-07 15:27:57 +01:00
Luis Riegger
cc99ecef0d add german plugin language 2021-02-07 11:15:08 +01:00
Luis Riegger
721db866ff remove _config.yml 2021-02-07 10:25:02 +01:00
Luis R
6821adc1e3 Update README.md 2020-12-13 22:51:05 +01:00
Luis R
df52bd103f Update README.md 2020-12-13 22:49:48 +01:00
Luis Riegger
28cdabe47c correct typos in config.schema.json 2020-12-13 22:20:01 +01:00
Luis Riegger
6fd2e46bff Update README 2020-12-13 18:33:13 +01:00
Luis Riegger
a99359f6ac adapt for node-kobold-control api 2020-12-13 18:31:44 +01:00
Luis Riegger
49e3fdf191 adapt package dependency 2020-12-13 10:23:59 +01:00
Luis Riegger
295c9b01a1 Further adapt README.md, Licence and Package 2020-12-12 15:52:26 +01:00
Luis Riegger
eecf7f21f8 Adapt README.md 2020-12-12 15:42:06 +01:00
Arne
5ff3951668 Update README.md 2020-10-08 12:10:43 +02:00
Arne
b83d30cfad Update README.md 2020-03-14 00:33:45 +01:00
Arne
b53ef4ff2f Update README.md 2020-03-14 00:32:48 +01:00
Arne
d8ca308338 Updated changelog 2019-10-19 17:33:58 +02:00
Arne
75180b27cb Bumped version to v0.7.2 2019-10-19 17:31:38 +02:00
Arne
b8971b64a9 Updated readme 2019-10-18 10:02:55 +02:00
Arne
32e47d0a8f Fixed launch error with multiple robots 2019-10-16 22:32:53 +02:00
Arne
f0dd89353e Bumped version to v0.7.1 2019-10-15 09:33:32 +02:00
Arne
d809be5b03 Fixed robot without floorplan cannot start cleaning 2019-10-14 22:33:08 +02:00
Arne
6e5b0d522c Fixed robot not shown before setting up a floor plan 2019-10-14 12:47:52 +02:00
8 changed files with 320 additions and 235 deletions

View File

@@ -110,4 +110,17 @@
* Added logic to be able to change the currently cleaned room * Added logic to be able to change the currently cleaned room
* Improved number of requests when having multiple rooms * Improved number of requests when having multiple rooms
* Fixed room switches not taking eco and extraCare mode into account * 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

View File

@@ -1,6 +1,6 @@
The MIT License (MIT) 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

118
README.md
View File

@@ -1,15 +1,10 @@
# homebridge-neato # homebridge-kobold
[![npm](https://img.shields.io/npm/v/homebridge-neato)](https://www.npmjs.com/package/homebridge-neato)
[![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). 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).
If you like this plugin and find it useful, I would be forever grateful for your support: 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).
<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> The interaction with the Server is handled by the underlying [node-kobold-control](https://github.com/himbeles/node-kobold-control) module.
Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
## Features ## Features
@@ -17,10 +12,10 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
- Eco mode - Eco mode
- Extra care navigation - Extra care navigation
- Nogo lines - Nogo lines
- Zone cleaning* (only D7) - Zone cleaning <sup>[1](#change-room)</sup>
- Spot cleaning - 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 - Return to dock
- Find the robot - Find the robot
- Schedule (de)activation - Schedule (de)activation
@@ -32,58 +27,101 @@ Feel free to leave any feedback [here](https://github.com/naofireblade/homebridg
- Automatic or periodic refresh of robot state - Automatic or periodic refresh of robot state
- Multiple robots - 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 or English 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 ## Installation
1. Install homebridge using: `npm install -g homebridge` 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 ## Configuration
Add the following information to your config file. Change the values for email and password. Add the following information to your config file. Change the values for email and password.
### Simple ### Simple
```json ```json
"platforms": [ "platforms": [
{ {
"platform": "NeatoVacuumRobot", "platform": "KoboldVacuumRobot",
"email": "YourEmail", "token": "YourToken",
"password": "YourPassword" "language": "de"
} }
] ]
``` ```
You can get a token 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, or `en` for English.
### Advanced ### 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 ```json
"platforms": [ "platforms": [
{ {
"platform": "NeatoVacuumRobot", "platform": "KoboldVacuumRobot",
"email": "YourEmail", "token": "YourToken",
"password": "YourPassword", "refresh": "120",
"refresh": "120", "hidden": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule", "find", "spot"],
"hidden": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule", "find", "spot"] "language": "de"
} }
] ]
``` ```
## Tested robots ## 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

View File

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

View File

@@ -1,4 +1,4 @@
const debug = require('debug')('homebridge-neato'); const debug = require('debug')('homebridge-kobold');
const colors = require('colors'); const colors = require('colors');
const CustomUUID = { const CustomUUID = {
@@ -17,11 +17,14 @@ module.exports = function (_Service, _Characteristic)
{ {
Service = _Service; Service = _Service;
Characteristic = _Characteristic; 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.platform = platform;
this.log = platform.log; this.log = platform.log;
@@ -32,9 +35,38 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
this.robotObject = robotObject; this.robotObject = robotObject;
this.robot = robotObject.device; this.robot = robotObject.device;
this.meta = robotObject.meta; 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.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"
}
}[this.platform.language]
if (this.boundary == null) if (this.boundary == null)
{ {
this.name = this.robot.name; this.name = this.robot.name;
@@ -61,45 +93,34 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
this.name = this.robot.name + ' - ' + this.boundary.name; 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) 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 else
{ {
const splitName = this.boundary.name.split(' '); 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)) 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, "cleanBoundary:" + this.boundary.id);
} }
@@ -107,7 +128,7 @@ function NeatoVacuumRobotAccessory(platform, robotObject)
this.log("Added cleaning device named: " + this.name); this.log("Added cleaning device named: " + this.name);
} }
NeatoVacuumRobotAccessory.prototype = { KoboldVacuumRobotAccessory.prototype = {
identify: function (callback) identify: function (callback)
{ {
this.robot.getState((error, result) => this.robot.getState((error, result) =>
@@ -129,7 +150,7 @@ NeatoVacuumRobotAccessory.prototype = {
{ {
this.informationService = new Service.AccessoryInformation(); this.informationService = new Service.AccessoryInformation();
this.informationService this.informationService
.setCharacteristic(Characteristic.Manufacturer, "Neato Robotics") .setCharacteristic(Characteristic.Manufacturer, "Vorwerk Deutschland Stiftung & Co. KG")
.setCharacteristic(Characteristic.Model, this.meta.modelName) .setCharacteristic(Characteristic.Model, this.meta.modelName)
.setCharacteristic(Characteristic.SerialNumber, this.robot._serial) .setCharacteristic(Characteristic.SerialNumber, this.robot._serial)
.setCharacteristic(Characteristic.FirmwareRevision, this.meta.firmware) .setCharacteristic(Characteristic.FirmwareRevision, this.meta.firmware)
@@ -166,29 +187,22 @@ NeatoVacuumRobotAccessory.prototype = {
this.findMeService.getCharacteristic(Characteristic.On).on('set', this.setFindMe.bind(this)); this.findMeService.getCharacteristic(Characteristic.On).on('set', this.setFindMe.bind(this));
this.findMeService.getCharacteristic(Characteristic.On).on('get', this.getFindMe.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) if (this.hiddenServices.indexOf('spot') === -1)
this.services.push(this.spotCleanSimpleService); {
this.services.push(this.spotCleanService);
} }
// Add optional services // Add optional services
@@ -252,7 +266,7 @@ NeatoVacuumRobotAccessory.prototype = {
else if (this.robot.canStart) else if (this.robot.canStart)
{ {
debug(this.name + ": ## Start cleaning"); debug(this.name + ": ## Start cleaning");
this.clean(callback, this.boundary); this.clean(callback);
} }
// Cannot start // Cannot start
else else
@@ -278,7 +292,7 @@ NeatoVacuumRobotAccessory.prototype = {
else else
{ {
debug(this.name + ": ## Start cleaning of new room"); debug(this.name + ": ## Start cleaning of new room");
this.clean(callback, this.boundary); this.clean(callback);
} }
} }
} }
@@ -507,12 +521,10 @@ NeatoVacuumRobotAccessory.prototype = {
setSpotClean: function (on, callback) setSpotClean: function (on, callback)
{ {
let spotCleanService = (typeof this.spotCleanAdvancedService !== 'undefined') ? this.spotCleanAdvancedService : this.spotCleanSimpleService;
let spot = { 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) => this.platform.updateRobot(this.robot._serial, (error, result) =>
@@ -658,15 +670,12 @@ NeatoVacuumRobotAccessory.prototype = {
this.noGoLinesService.setCharacteristic(Characteristic.On, this.robot.noGoLines); this.noGoLinesService.setCharacteristic(Characteristic.On, this.robot.noGoLines);
this.extraCareService.setCharacteristic(Characteristic.On, this.robot.navigationMode == 2 ? true : false); 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); this.spotCleanService.setCharacteristic(SpotWidthCharacteristic, this.robot.spotWidth);
this.spotCleanAdvancedService.setCharacteristic(SpotHeightCharacteristic, this.robot.spotHeight); this.spotCleanService.setCharacteristic(SpotHeightCharacteristic, this.robot.spotHeight);
this.spotCleanAdvancedService.setCharacteristic(SpotRepeatCharacteristic, this.robot.spotRepeat);
}
else
{
this.spotCleanSimpleService.setCharacteristic(SpotRepeatCharacteristic, this.robot.spotRepeat);
} }
} }

View File

@@ -1,22 +1,35 @@
{ {
"pluginAlias": "NeatoVacuumRobot", "pluginAlias": "KoboldVacuumRobot",
"pluginType": "platform", "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": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"email": { "token": {
"title": "email", "title": "token",
"type": "string",
"required": true,
"format": "email",
"description": "Your Email Address"
},
"password": {
"title": "password",
"type": "string", "type": "string",
"required": true, "required": true,
"description": "Your Password" "description": "Your Token"
},
"language": {
"title": "language",
"type": "string",
"default": "en",
"oneOf": [
{
"title": "English",
"enum": [
"en"
]
},
{
"title": "German",
"enum": [
"de"
]
}
],
"required": true
} }
} }
} }

205
index.js
View File

@@ -1,24 +1,26 @@
"use strict"; "use strict";
let inherits = require('util').inherits, 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, Service,
Characteristic; Characteristic,
KoboldVacuumRobotAccessory;
module.exports = function (homebridge) module.exports = function (homebridge)
{ {
Service = homebridge.hap.Service; Service = homebridge.hap.Service;
Characteristic = homebridge.hap.Characteristic; 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.log = log;
this.serial = "1-3-3-7"; 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 = '';
this.hiddenServices = ('disabled' in config ? config['disabled'] : this.hiddenServices); this.hiddenServices = ('disabled' in config ? config['disabled'] : this.hiddenServices);
this.hiddenServices = ('hidden' in config ? config['hidden'] : this.hiddenServices); this.hiddenServices = ('hidden' in config ? config['hidden'] : this.hiddenServices);
@@ -33,10 +35,10 @@ function NeatoVacuumRobotPlatform(log, config)
this.refresh = parseInt(config['refresh']); this.refresh = parseInt(config['refresh']);
// must be integer and positive // must be integer and positive
this.refresh = (typeof this.refresh !== 'number' || (this.refresh % 1) !== 0 || this.refresh < 0) ? 60 : this.refresh; 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) 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; this.refresh = (this.refresh > 0 && this.refresh < 60) ? 60 : this.refresh;
} }
} }
@@ -48,80 +50,100 @@ function NeatoVacuumRobotPlatform(log, config)
this.log("Refresh is set to: " + this.refresh + (this.refresh !== 'auto' ? ' seconds' : '')); this.log("Refresh is set to: " + this.refresh + (this.refresh !== 'auto' ? ' seconds' : ''));
} }
NeatoVacuumRobotPlatform.prototype = { KoboldVacuumRobotPlatform.prototype = {
accessories: function (callback) accessories: function (callback)
{ {
debug("Get robots"); debug("Get robots");
let accessories = []; let accessories = [];
this.boundaryNames = []; this.boundaryNames = [];
this.getRobots(() => this.getRobots(() =>
{ {
this.robots.forEach((robot, i) => // // MOCK MULTIPLE ROBOTS START
{ // let client = new control.Client();
this.log("Found robot #" + (i + 1) + " named \"" + robot.device.name + "\" with serial \"" + robot.device._serial.substring(0,9) + "XXXXXXXXXXXX\""); // 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
// Start Update Intervall this.robots.forEach((robot, i) =>
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
// robot.boundary = {name: "Testroom", id: "1"};
// let roomAccessory = new NeatoVacuumRobotAccessory(this, robot);
// accessories.push(roomAccessory);
// robot.roomAccessories.push(roomAccessory);
if (robot.device.maps)
{
robot.device.maps.forEach((map) =>
{
if (map.boundaries)
{ {
map.boundaries.forEach((boundary) => this.log("Found robot #" + (i + 1) + " named \"" + robot.device.name + "\" with serial \"" + robot.device._serial.substring(0, 9) + "XXXXXXXXXXXX\"");
{
if (boundary.type === "polygon")
{
robot.boundary = boundary;
let roomAccessory = new NeatoVacuumRobotAccessory(this, robot);
accessories.push(roomAccessory);
robot.roomAccessories.push(roomAccessory); let mainAccessory = new KoboldVacuumRobotAccessory(this, robot);
} accessories.push(mainAccessory);
})
} robot.mainAccessory = mainAccessory;
}) robot.roomAccessories = [];
}
}); // Start Update Intervall
callback(accessories); this.updateRobotTimer(robot.device._serial);
// // MOCK ZONE CLEANING START
// robot.boundary = {name: "Testroom", id: "1"};
// let roomAccessory = new KoboldVacuumRobotAccessory(this, robot);
// accessories.push(roomAccessory);
// robot.roomAccessories.push(roomAccessory);
// // MOCK ZONE CLEANING END
if (robot.device.maps)
{
robot.device.maps.forEach((map) =>
{
if (map.boundaries)
{
map.boundaries.forEach((boundary) =>
{
if (boundary.type === "polygon")
{
robot.boundary = boundary;
let roomAccessory = new KoboldVacuumRobotAccessory(this, robot);
accessories.push(roomAccessory);
robot.roomAccessories.push(roomAccessory);
}
})
}
})
}
});
callback(accessories);
// // MOCK MULTIPLE ROBOTS START
// });
// });
// });
// // MOCK MULTIPLE ROBOTS END
}); });
}, },
getRobots: function (callback) getRobots: function (callback)
{ {
debug("Loading your robots"); debug("Loading your robots");
let client = new botvac.Client(); let client = new control.Client();
// Login // Login
client.authorize(this.email, this.password, false, (error) => client.authorize(this.token, (error) =>
{ {
if (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(); callback();
} }
else else
{ {
// Get robots // Get all robots
client.getRobots((error, robots) => client.getRobots((error, robots) =>
{ {
if (error) 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(); callback();
} }
else if (robots.length === 0) else if (robots.length === 0)
@@ -133,67 +155,72 @@ NeatoVacuumRobotPlatform.prototype = {
else else
{ {
debug("Found " + robots.length + " robots"); debug("Found " + robots.length + " robots");
let requestedRobot = 0; let loadedRobots = 0;
robots.forEach((robot) => robots.forEach((robot) =>
{ {
// Get Maps for each robot // Get additional information for the robot
robot.getPersistentMaps((error, result) => robot.getState((error, state) =>
{ {
if (error) 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(); callback();
} }
else else
{ {
robot.maps = result; // Get all maps for each robot
let requestedMap = 0; robot.getPersistentMaps((error, maps) =>
robot.maps.forEach((map) =>
{ {
// Get Map Boundary Lines if (error)
robot.getMapBoundaries(map.id, (error, result) =>
{ {
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)
{ {
this.log.error("Error getting boundaries: " + error + ": " + result) callback();
} }
else }
// Robot has maps
else
{
robot.maps = maps;
let loadedMaps = 0;
robot.maps.forEach((map) =>
{ {
map.boundaries = result.boundaries; // Save zones in each map
} robot.getMapBoundaries(map.id, (error, result) =>
requestedMap++;
// Robot is completely requested if all maps are requested
if (requestedMap === robot.maps.length)
{
// Get additional information
robot.getState((error, result) =>
{ {
if (error) if (error)
{ {
this.log.error("Error getting robot meta information: " + error + ": " + result); this.log.error("Error getting boundaries: " + error + ": " + result)
callback();
} }
else else
{ {
this.robots.push({device: robot, meta: result.meta, availableServices: result.availableServices}); map.boundaries = result.boundaries;
requestedRobot++; }
loadedMaps++;
// Initial request is complete if all robots are requested. // Robot is completely requested if zones for all maps are loaded
if (requestedRobot === robots.length) if (loadedMaps === robot.maps.length)
{
this.robots.push({device: robot, meta: state.meta, availableServices: state.availableServices});
loadedRobots++;
if (loadedRobots === robots.length)
{ {
callback(); callback();
} }
} }
}); })
} });
}) }
}); });
} }
}); });

View File

@@ -1,43 +1,29 @@
{ {
"name": "homebridge-neato", "name": "homebridge-kobold",
"version": "0.7.0", "version": "0.8.0",
"description": "A Neato vacuum robot plugin for homebridge.", "description": "A Vorwerk Kobold vacuum robot plugin for homebridge.",
"license": "MIT", "license": "MIT",
"keywords": [ "keywords": [
"homebridge-plugin", "homebridge-plugin",
"neato", "vorwerk",
"botvac" "kobold"
], ],
"engines": { "engines": {
"node": ">=0.12.0", "node": ">=0.12.0",
"homebridge": ">=0.2.0" "homebridge": ">=0.2.0"
}, },
"author": { "author": {
"name": "Arne Blumentritt", "name": "Luis R.",
"url2": "https://github.com/naofireblade" "url2": "https://github.com/himbeles"
}, },
"contributors": [
{
"name": "ghulands",
"url": "https://github.com/ghulands"
},
{
"name": "Berkay",
"url": "https://github.com/btutal"
},
{
"name": "Antoine de Maleprade",
"url": "https://github.com/az0uz"
}
],
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git://github.com/naofireblade/homebridge-neato.git" "url": "git://github.com/himbeles/homebridge-kobold.git"
}, },
"dependencies": { "dependencies": {
"colors": "^1.4.0", "colors": "^1.4.0",
"debug": "^4.1.1", "debug": "^4.1.1",
"node-botvac": ">=0.4.0", "node-kobold-control": ">=0.4.0",
"uuid": "^3.3.2" "uuid": "^3.3.2"
} }
} }