Erik/homebridge-kobold-Homaassistant-Flavour
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A Kobold vacuum robot plugin for homebridge.
31 Commits 4 Branches 29 Tags 339 KiB
JavaScript 100%
2fec762498
Go to file
naofireblade 2fec762498 Version 0.4.4 
* Fixed config parameter to disable switches/sensors not optional
2017-07-25 08:54:52 +02:00
_config.yml Set theme jekyll-theme-cayman 2017-04-30 18:06:45 +02:00
CHANGELOG.md Version 0.4.3 2017-07-25 08:52:17 +02:00
index.js Version 0.4.3 2017-07-25 08:52:17 +02:00
LICENSE Initial commit 2017-04-17 16:07:21 +02:00
package.json Version 0.4.3 2017-07-25 08:52:17 +02:00
README.md Version 0.4.4 2017-07-25 08:54:52 +02:00

README.md

homebridge-neato

This is a plugin for homebridge to control your Neato vacuum robot. You can download it via npm.

Feel free to leave any feedback here.

If you update from a previous version 0.3.x you have to adapt your config.

Features

  • Start and pause cleaning
  • Return to dock*
  • Enable and disable schedule
  • Enable and disable eco mode
  • Get battery info
  • Get dock info
  • Periodic refresh of robot state
  • Support for multiple robots
  • Extra care navigation

* Available after some seconds of cleaning.

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install this plugin using: npm install -g homebridge-neato
  3. If you don't have a Neato account yet create one here.
  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.

Simple

"platforms": [
	{
		"platform": "NeatoVacuumRobot",
		"email": "YourEmail",
		"password": "YourPassword"
	}
]

Advanced

The following config contains advanced optional settings that are off when not specified.

The parameter refresh sets in what interval (seconds) changes of the robot state will be pushed to homekit. The minimum refresh time is 60 seconds. You need this only when you set up rules based on the robot state and start him outside of homekit (e.g. with the Neato app).

The parameter extraCareNavigation sets if supporting models (currently Neato D3 and D5) should take extra care of your furniture while cleaning.

The parameter disabled accepts a list of switches/sensors that can be disabled in the neato homekit plugin (e.g. dock, dockstate, eco, schedule).

"platforms": [
	{
		"platform": "NeatoVacuumRobot",
		"email": "YourEmail",
		"password": "YourPassword",
		"refresh": "120",
		"extraCareNavigation": true,
		"disabled": ["dock", "dockstate", "eco"]
	}
]

Tested robots

  • BotVac Connected (Firmware 2.2.0)
  • BotVac D3 Connected
  • BotVac D5 Connected

If you have another connected neato robot, please tell me about your experience with this plugin.