https://github.com/stvmallen/homebridge-roomba-stv

Homebrige plugin for Roomba 9xx
https://github.com/stvmallen/homebridge-roomba-stv

homebridge homebridge-plugin roomba

Last synced: 3 months ago
JSON representation

Homebrige plugin for Roomba 9xx

• Host: GitHub
• URL: https://github.com/stvmallen/homebridge-roomba-stv
• Owner: stvmallen
• License: mit
• Created: 2017-11-06T18:36:13.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-10-18T12:01:34.000Z (over 4 years ago)
• Last Synced: 2024-07-29T22:59:07.334Z (6 months ago)
• Topics: homebridge, homebridge-plugin, roomba
• Language: JavaScript
• Size: 65.4 KB
• Stars: 38
• Watchers: 8
• Forks: 15
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# homebridge-roomba-stv

homebridge-plugin for Roomba 9xx (Roomba 900 Software Version 2.x).

[![npm version](https://badge.fury.io/js/homebridge-roomba-stv.svg)](https://badge.fury.io/js/homebridge-roomba-stv)

[![dependencies Status](https://david-dm.org/esteban-mallen/homebridge-roomba-stv/status.svg)](https://david-dm.org/esteban-mallen/homebridge-roomba-stv)

### Features:

- Roomba start on demand

- Roomba stop and dock on demand

- Roomba charging status

- Roomba battery level (with low battery warning)

### Credits to:

https://github.com/umesan/homebridge-roomba

https://github.com/steedferns/homebridge-roomba980

https://github.com/gbro115/homebridge-roomba690

 [@matanelgabsi](https://github.com/matanelgabsi) for keepAlive feature

## Installation:

### 1. Install homebridge and Roomba plugin.

- 1.a `sudo npm install -g homebridge --unsafe-perm`

- 1.b `sudo npm install -g homebridge-roomba-stv`

### 2. Find robotpwd and blid.

- 2.a Run `npm run getrobotpwd 192.16.xx.xx` where this plugin in installed

- 2.b Follow instructions

If successful, the following message will be displayed.

Please check **blid** and **Password** of displayed message.

```

Robot Data:

{ ver: '2',

  hostname: 'Roomba-xxxxxxxxxxxxxxxx',

  robotname: 'Your Roomba’s Name',

  ip: '192.168.xx.xx',

  mac: 'xx:xx:xx:xx:xx:xx',

  sw: 'vx.x.x-x',

  sku: 'R98----',

  nc: 0,

  proto: 'mqtt',

  blid: '0123456789abcdef' }

Password=> :1:2345678910:ABCDEFGHIJKLMNOP <= Yes, all this string.

```

### 4. Update homebridge configuration file.

```

"accessories": [

  {

    "accessory": "Roomba",

    "name": "Roomba",

    "model": "960",

    "blid": "1234567890",

    "robotpwd": "aPassword",

    "ipaddress": "10.0.0.30",

    "autoRefreshEnabled": true,

    "keepAliveEnabled": true, //If you use local network mode in roomba app, consider disabling. see note below

    "cacheTTL": 30 //in seconds

  }

]

```

#### Refresh mode

This plugins supports these refresh modes:

- NONE (`autoRefreshEnabled` and `keepAlive` both set to false) - no auto refresh, we will connect to roomba and poll status when requested by home app. Please note that this will cause "Updating" status for all homebridge accessories.

- AUTO REFRESH (`autoRefreshEnabled` set to true) - we will connect to roomba, every `pollingInterval` seconds, and store the status in cache. if `pollingInterval` = `cacheTTL` - 10 (or more), this will make sure we will always have a valid status.

- KEEP ALIVE (`keepAlive` set to true) - we will keep a connection to roomba, this will cause app to fail to connect to roomba in local network mode (cloud mode will work just fine, even in your home wifi). This will lead to better performance (status will refresh faster, and toggle will work faster as well). **Keep in mind this will increase the Roomba battery consumption**.