rafabernad / homebridge-roomba2

Homebridge plugin to connect iRobot Roomba devices with Homebridge/HomeKit.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

Homebridge plugin to connect iRobot Roomba devices with Homebridge/HomeKit.

License:MIT License


Languages

Language:JavaScript 100.0%