Coder Social home page Coder Social logo

homebridge-neato's Introduction

homebridge-neato

npm npm GitHub last commit

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.

Features

  • Start and pause cleaning
  • Return to dock
  • Toggle schedule
  • Toggle eco mode
  • Toggle extra care navigation
  • Toggle nogo lines
  • Get battery info
  • Get dock info
  • Periodic refresh of robot state
  • Support for multiple robots

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.

The parameter refresh sets an interval in seconds that is used to update the robot state in the background. This is only required for automations based on the robot state. The default value is auto which means that the update is automatically enabled while cleaning and disabled while not cleaning. You can set a value in seconds e.g. 120 to enable background updates even when the robot is not cleaning. You can also disable background updates completely by setting the value 0. This might be required if you experience timeouts in the app because you have other home automation apps that are connected to your robot.

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",
		"disabled": ["dock", "dockstate", "eco", "nogolines", "extracare", "schedule"]
	}
]

Tested robots

  • BotVac Connected (Firmware 2.2.0)
  • BotVac D3 Connected
  • BotVac D5 Connected (Firmware 4.0.0, 4.3.0)
  • BotVac D7 Connected

The plugin should work with D4 and D6 as well. If you have connected neato robot, please tell me about your experience with this plugin.

Contributors

Many thanks go to

  • ghulands for finding and fixing a bug when no robot is associated with the neato account
  • Berkay for adding the schema file to use the plugin with homebridge-config-ui-x

homebridge-neato's People

Contributors

az0uz avatar naofireblade avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.