Compare commits

..

No commits in common. "master" and "v0.7.0" have entirely different histories.

9 changed files with 254 additions and 414 deletions

View File

@ -1,19 +0,0 @@
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 }}

View File

@ -110,26 +110,4 @@
* 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 not supporting pause/resume * Fixed room switches to support 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

View File

@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2020 Luis Riegger Copyright (c) 2017 Arne Blumentritt
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

110
README.md
View File

@ -1,14 +1,15 @@
[![Latest NPM release](https://img.shields.io/npm/v/homebridge-kobold.svg)](https://www.npmjs.com/package/homebridge-kobold) # 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/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).
# homebridge-kobold If you like this plugin and find it useful, I would be forever grateful for your support:
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). <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>
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). Feel free to leave any feedback [here](https://github.com/naofireblade/homebridge-neato/issues).
The interaction with the Server is handled by the underlying [node-kobold-control](https://github.com/himbeles/node-kobold-control) module.
## Features ## Features
@ -16,10 +17,10 @@ The interaction with the Server is handled by the underlying [node-kobold-contro
- Eco mode - Eco mode
- Extra care navigation - Extra care navigation
- Nogo lines - Nogo lines
- Zone cleaning <sup>[1](#change-room)</sup> - Zone cleaning* (only D7)
- Spot cleaning - Spot cleaning
- Individual spot size <sup>[2](#eve)</sup> - Individual spot size (only D7)
- Clean twice <sup>[2](#eve)</sup> - Clean twice
- Return to dock - Return to dock
- Find the robot - Find the robot
- Schedule (de)activation - Schedule (de)activation
@ -31,101 +32,58 @@ The interaction with the Server is handled by the underlying [node-kobold-contro
- Automatic or periodic refresh of robot state - Automatic or periodic refresh of robot state
- Multiple robots - Multiple robots
- German, English or French Language Setting >*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.
> <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-kobold` 2. Install this plugin using: `npm install -g homebridge-neato`
3. Update your configuration file. See the sample below. 3. If you don't have a Neato account yet, create one [here](https://www.neatorobotics.com/create-account/).
4. Update your configuration file. See the sample below.
## Configuration ## Configuration
Add the following information to your config file. Adapt the value for `token`. Add the following information to your config file. Change the values for email and password.
### Simple ### Simple
```json ```json
"platforms": [ "platforms": [
{ {
"platform": "KoboldVacuumRobot", "platform": "NeatoVacuumRobot",
"token": "YourToken", "email": "YourEmail",
"language": "de" "password": "YourPassword"
} }
] ]
``` ```
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 ### Advanced
Below are explanations for advanced parameters to adjust the plugin to your needs. All parameters are *optional*. The following config contains advanced optional settings.
**refresh** 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`.
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.
**hidden** 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`).
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": "KoboldVacuumRobot", "platform": "NeatoVacuumRobot",
"token": "YourToken", "email": "YourEmail",
"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
- Vorwerk Kobold VR300 The plugin is successfully tested with all Neato Connected Robots.
## 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

1
_config.yml Normal file
View File

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

View File

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

View File

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

127
index.js
View File

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

View File

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