Git Product home page Git Product logo

homebridge-roomba2's Introduction

Homebridge-Roomba2

verified-by-homebridge

Features

  • Roomba start on demand
  • Roomba stop and dock on demand
  • Roomba charging status
  • Roomba battery level (with low battery warning)
  • Roomba docked notifcation
  • Roomba running notification
  • Roomba bin full notification

Installation

Automatic Installation

  1. Install Homebridge: sudo npm i -g homebridge --unsafe-perm
  2. Download this plugin: sudo npm i -g homebridge-roomba2
  3. Follow Setup, to get Roomba credentials
  4. Continue setup using Config-Ui-X
  5. Restart Homebridge

Manual Installation

  1. Install Homebridge: sudo npm i -g homebridge --unsafe-perm
  2. Download this plugin: sudo npm i -g homebridge-roomba2
  3. Follow Setup, to get Roomba credentials
  4. Enter Roomba credentials to your config.json file.
  5. Restart Homebridge

Setup

  1. CD into where your plugins are installed. On a Pi it is: /usr/local/lib/node_modules/homebridge-roomba2
  2. Type sudo npm run getrobotpwd 192.168.x.xxx
  3. Follow the instructions on screen
  4. Use the credentials from above, to fill into Homebridge. (Config template below):
"accessories": [
  {
    "accessory": "Roomba2",
    "name": "Roomba",
    "model": "960",
    "blid": "1234567890",
    "robotpwd": "aPassword",
    "ipaddress": "192.168.x.xxx",
    "autoRefreshEnabled": true,
    "keepAliveEnabled": true, 
    "dockContactSensor": true,
    "runningContactSensor": true,
    "cacheTTL": 30 //in seconds
  }
]

Credits:

STVMallen - Original plugin

ncovercash - Dock status

homebridge-roomba2's People

Contributors

dvcrn avatar irayankhan 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.