Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

homebridge-irobot

bloomkd46342Apache-2.02.1.16TypeScript support: included

A homebridge plugin for controlling iRobot devices

homebridge-plugin, iRobot, roomba, homebridge, vacuum

readme

Homebridge iRobot

homebridge-iRobot

Homebridge plugin to integrate iRobot roombas into HomeKit

(Wiki Links Don't Work Yet)

verified-by-homebridge downloads

npm npm

build workflow license

Plugin Information

  • This plugin allows you to view and control your iRobot roombas within HomeKit. The plugin:
    • downloads a device list if your iRobot credentials are supplied
    • controls your devices locally
    • listens for real-time device updates when controlled externally

Supported Devices

Don't See Your Device Below? Let Me Know If It Worked By Filling Out This Template

Model Supported Reported By
braava jet m6 No ghazel
J7 No spurzack
j7 No franciswernet
j7 No franciswernet
j7 No VinceBab
i7 Yes Clouder59
606 No PvdGulik
Braava m6 No Jer-emy
m6 Yes ginoledesma
j7 Yes ginoledesma
i3 No rminear68
980 No jeanchrijaz
i9 Yes douginoz
960 Yes NateUT99
965 Yes bloomkd46
i8 Yes bloomkd46

Features:

  • <input checked="" disabled="" type="checkbox"> Approved By Homebridge
  • <input checked="" disabled="" type="checkbox"> Custom UI For Viewing Devices
  • <input checked="" disabled="" type="checkbox"> On/Off Control
  • <input checked="" disabled="" type="checkbox"> Room-By-Room Control On Models That Support It (Only Tested When Using One Map)
  • <input checked="" disabled="" type="checkbox"> Auto-Dicovery Of All Devices On Your Acount
  • <input checked="" disabled="" type="checkbox"> Battery Percent/Charging ifo
  • <input checked="" disabled="" type="checkbox"> Binfull Detection In The Form Of Filter/Contact/Motion Sensor
  • <input checked="" disabled="" type="checkbox"> Stuck Sensor

TODO:

  • <input disabled="" type="checkbox"> Add ability for rooms to show up with names instead of id number

    Prerequisites

  • To use this plugin, you will need to already have Homebridge (at least v1.3.5) or HOOBS (at least v4) installed. Refer to the links for more information and installation instructions.

Setup

Help/About

Credits

  • To the creators/contributors of Homebridge who make this plugin possible.
  • To homebridge-Meross of which I based this readme, wiki, and homebridge-ui off of
  • To Dorita980 Who cracked the iRobot API

Disclaimer

  • I am in no way affiliated with iRobot and this plugin is a personal project that I maintain in my free time.
  • Use this plugin entirely at your own risk - please see licence for more information.

changelog

2.1.16

  • This release represents releases 2.1.14 and 2.1.15

2.1.15

  • Set program to resume robot if job is already active
  • Set program to stop Roomba if room-by-room request received
  • Added j7 support (hopefully 🤞)

2.1.14

  • Added the ability to manually configure Roomba's instead of using your iRobot credentials

2.1.14 Beta 4

  • Improved logging when using manual configuration
  • Fixed logic when determining if device supports room-by-room cleaning

2.1.14 Beta 3

  • Fixed homebridge crash due to logic error when configuring Roomba's

2.1.14 Beta 2

  • Fixed homebridge crash when reading variable ver

2.1.14 Beta 1

  • Added support for manually configuring Roomba's instead of entering your Roomba credentials

2.1.13

  • Fixed how getRoombas.ts handles unconfigured Roombas to address issues #23 and #34

2.1.12

  • Added software version to custom ui

2.1.11

  • Fixed Stuck Sensor, Thanks @Ghost108
  • Changed on/off logs from debug to info

2.1.10

  • Fixed crash when starting second IP sweep
  • Removed devices if it fails to find IP

2.1.9

  • Fixed homebridge crash on offline

2.1.8

  • Fixed typo during Roomba IP discovery. Thanks @rcoletti116

2.1.7

  • Set Accessory to not responding in HomeKit when Roomba disconnects
  • Added Log for when Roomba is stuck
  • Made IP search run again after 5 seconds for up to 5 attempts
  • Prevented plugin from adding m6's

2.1.6

  • Removed Log Spam When Reconnecting After Connection Drop
  • Made Low Battery Warnings Not Appear If Roomba Is Charging

2.1.5

  • Removed Broken Status From Device Table In Custom UI

2.1.4

  • Removed Status From Table Since It Always Says Online

2.1.3

  • Changed Logic For Identifying If Region Is Already Saved
  • Added 5 Second Delay Before Reconnecting If The Connection Drops

2.1.2

  • Added Support Page In Custom UI
  • (Wiki Links Don't Work Yet)

2.1.1

  • Re-arranged table
  • fixed rooms section in table

2.1.0

  • Added custom UI

2.1.0-beta.3

  • Removed Mac Address from devices table

2.1.0-beta.2

  • hid spinner while looking for devices in custom UI

2.1.0-beta.1

  • Fixed menuHome custom UI error

2.1.0-beta.0

  • Started To Work On Custom UI

2.0.5

  • Set log added in version 2.0.2 to debug
  • Set on/off logs to info
  • Added log for when roomba is stuck

2.0.4

  • fixed typo in room sync functions when adding new room to existing map

2.0.3

  • Fixed error where it wouldn't add new regions

2.0.2

  • Added Log When Updating Homekit Rooms

2.0.1

  • Made disableMultiRoom default to false in config

2.0.0

  • Became A Homebridge Vertified Plugin
  • Set Password format to password in Schema

1.3.2

  • Made Roomba execute off action 2 after 5 seconds if state dosent change

1.3.1

  • Prevented plugin from initilizing if it dosent have an email/password

1.3.0

  • Added support for Multiple Rooms
  • Made Roomba wait 1 second for scenes when it is turned on

1.2.0

  • Added Room-By-Room Abilities On Models That Support It

1.1.0

  • Added More Configuation options