homebridge-irobot-v2

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>homebridge-irobot-v2</title><meta name="description" content="Documentation for homebridge-irobot-v2"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">homebridge-irobot-v2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>homebridge-irobot-v2</h1></div><div class="tsd-panel tsd-typography"><p align="center"> <a href="https://github.com/taurgis/homebridge-iRobo-v2"><img alt="Homebridge iRobot" src="https://user-images.githubusercontent.com/75853497/143301930-e2f3bc9a-9f0d-4e03-95f8-c69769712ca5.png" width="600px"></a> </p> <span align="center"> <a id="md:homebridge-irobot-v2" class="tsd-anchor"></a><h1 class="tsd-anchor-link">homebridge-iRobot-v2<a href="#md:homebridge-irobot-v2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>A Homebridge plugin to integrate iRobot Roombas into HomeKit.</p> <p>This plugin is based on <a href="https://github.com/bloomkd46/homebridge-iRobot">homebridge-IRobot</a>, but since this plugin has not gotten any updates for a long time, I decided to create a new plugin based on the old one. This plugin is not compatible with the old one, so you have to remove the old plugin and install this one. The general idea for this new plugin is to make fix reported bugs and keep it up to date where necessary.</p> <p>Once the latest iOS 18 update is released, I will update the plugin to support the new features (if possible).</p> <p><a href="https://npmcharts.com/compare/homebridge-irobot-v2?log=true&interval=1&minimal=true" target="_blank" class="external"><img src="https://img.shields.io/npm/dt/homebridge-irobot-v2" alt="downloads"></a></p> <p><a href="https://www.npmjs.com/package/homebridge-irobot-v2" target="_blank" class="external"><img src="https://img.shields.io/npm/v/homebridge-irobot-v2/latest?label=latest" alt="npm"></a> <a href="../../wiki/Beta-Version"><img src="https://img.shields.io/npm/v/homebridge-irobot-v2/beta?label=beta" alt="npm"></a><br> <a href="../../wiki/Beta-Version"><img src="https://img.shields.io/npm/v/homebridge-irobot-v2/alpha?label=alpha" alt="npm"></a></p> <p><a href="../../actions/workflows/build.yml"><img src="https://github.com/taurgis/homebridge-iRobot-v2/actions/workflows/build.yml/badge.svg" alt="build workflow"></a> <a href="/LICENSE"><img src="https://badgen.net/github/license/taurgis/homebridge-irobot-v2" alt="license"></a> <a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins" target="_blank" class="external"><img src="https://badgen.net/badge/homebridge/verified/purple" alt="verified-by-homebridge"></a></p> </span> <a id="md:plugin-information" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Plugin Information<a href="#md:plugin-information" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>This plugin allows you to view and control your iRobot roombas within HomeKit. The plugin: <ul> <li>downloads a device list if your iRobot credentials are supplied</li> <li>controls your devices locally</li> <li>listens for real-time device updates when controlled externally</li> </ul> </li> </ul> <a id="md:supported-devices" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported Devices<a href="#md:supported-devices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><blockquote> <p>Don't See Your Device Below? Let Me Know If It Worked By Filling Out <a href="https://github.com/taurgis/homebridge-iRobot-v2/issues/new?assignees=taurgis&labels=enchancment&template=add-supported-device.yml&title=Supported+Device%3A+" target="_blank" class="external">This Template</a></p> </blockquote> <table> <thead> <tr> <th>Model</th> <th>Supported</th> <th>Reported By</th> </tr> </thead> <tbody> <tr> <td>e5</td> <td>No</td> <td><a href="https://github.com/mylover21" target="_blank" class="external">mylover21</a></td> </tr> <tr> <td>i5</td> <td>Yes</td> <td><a href="https://github.com/jandrade45" target="_blank" class="external">jandrade45</a></td> </tr> <tr> <td>i7</td> <td>Yes</td> <td><a href="https://github.com/Clouder59" target="_blank" class="external">Clouder59</a></td> </tr> <tr> <td>606</td> <td>No</td> <td><a href="https://github.com/PvdGulik" target="_blank" class="external">PvdGulik</a></td> </tr> <tr> <td>690</td> <td>No</td> <td><a href="https://github.com/gabe-calabro" target="_blank" class="external">gabe-calabro</a></td> </tr> <tr> <td>698</td> <td>No</td> <td><a href="https://github.com/jojoballa" target="_blank" class="external">jojoballa</a></td> </tr> <tr> <td>Braava m6</td> <td>Yes</td> <td><a href="https://github.com/taurgis" target="_blank" class="external">taurgis</a></td> </tr> <tr> <td>m6</td> <td>Yes</td> <td><a href="https://github.com/ginoledesma" target="_blank" class="external">ginoledesma</a></td> </tr> <tr> <td>j7</td> <td>Yes</td> <td><a href="https://github.com/ginoledesma" target="_blank" class="external">ginoledesma</a></td> </tr> <tr> <td>j7 Combo</td> <td>Yes</td> <td><a href="https://github.com/tomadimitrie" target="_blank" class="external">tomadimitrie</a></td> </tr> <tr> <td>i3</td> <td>yes</td> <td><a href="https://github.com/taurgis" target="_blank" class="external">taurgis</a></td> </tr> <tr> <td>980</td> <td>No</td> <td><a href="https://github.com/jeanchrijaz" target="_blank" class="external">jeanchrijaz</a></td> </tr> <tr> <td>i9</td> <td>Yes</td> <td><a href="https://github.com/douginoz" target="_blank" class="external">douginoz</a></td> </tr> <tr> <td>s9</td> <td>Yes</td> <td><a href="https://github.com/cheese-maker" target="_blank" class="external">cheese-maker</a></td> </tr> <tr> <td>s9+</td> <td>Yes</td> <td><a href="https://github.com/bigadron" target="_blank" class="external">bigadron</a>.</td> </tr> <tr> <td>960</td> <td>No</td> <td><a href="https://github.com/MathiasBrendal" target="_blank" class="external">MathiasBrendel</a></td> </tr> <tr> <td>965</td> <td>Yes</td> <td><a href="https://github.com/bloomkd46" target="_blank" class="external">bloomkd46</a></td> </tr> <tr> <td>965</td> <td>Yes</td> <td><a href="https://github.com/bloomkd46" target="_blank" class="external">bloomkd46</a></td> </tr> <tr> <td>i8</td> <td>Yes</td> <td><a href="https://github.com/bloomkd46" target="_blank" class="external">bloomkd46</a></td> </tr> <tr> <td>y0</td> <td>No</td> <td><a href="https://github.com/Oloman2A" target="_blank" class="external">Oloman2A</a></td> </tr> </tbody> </table> <a id="md:features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Features:<a href="#md:features" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li>[x] Custom UI For Viewing Devices</li> <li>[x] On/Off Control</li> <li>[x] Room-By-Room Control On Models That Support It (Only Tested When Using One Map)</li> <li>[x] Auto-Dicovery Of All Devices On Your Acount</li> <li>[x] Battery Percent/Charging ifo</li> <li>[x] Binfull Detection In The Form Of Filter/Contact/Motion Sensor</li> <li>[x] Stuck Sensor</li> <li>[x] Verified By Homebridge</li> </ul> <a id="md:todo" class="tsd-anchor"></a><h2 class="tsd-anchor-link">TODO:<a href="#md:todo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li>[ ] Support iOS 18 Features</li> </ul> <a id="md:prerequisites" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Prerequisites<a href="#md:prerequisites" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>To use this plugin, you will need to already have <a href="https://homebridge.io" target="_blank" class="external">Homebridge</a> (at least v1.3.5) or <a href="https://hoobs.org" target="_blank" class="external">HOOBS</a> (at least v4) installed. Refer to the links for more information and installation instructions.</li> </ul> <a id="md:setup" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Setup<a href="#md:setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li><a href="../../wiki/Installation">Installation</a></li> <li><a href="../../wiki/Configuration">Configuration</a></li> <li><a href="../../wiki/Beta-Version">Beta Version</a></li> <li><a href="../../wiki/Node-Version">Node Version</a></li> <li><a href="../../wiki/Uninstallation">Uninstallation</a></li> </ul> <a id="md:helpabout" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Help/About<a href="#md:helpabout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li><a href="../../wiki/Common-Errors">Common Errors</a></li> <li><a href="../../issues/new/choose">Support Request</a></li> <li><a href="/CHANGELOG.md">Changelog</a></li> </ul> <a id="md:credits" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Credits<a href="#md:credits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>To the creators/contributors of <a href="https://homebridge.io" target="_blank" class="external">Homebridge</a> who make this plugin possible.</li> <li>To <a href="https://github.com/bwp91/homebridge-meross" target="_blank" class="external">homebridge-Meross</a> of which I based this readme, wiki, and homebridge-ui off of</li> <li>To <a href="https://github.com/bloomkd46/homebridge-iRobot" target="_blank" class="external">homebridge-IRobot</a> which this plugin is based off of</li> <li>To <a href="https://github.com/koalazak/dorita980" target="_blank" class="external">Dorita980</a> Who cracked the iRobot API</li> </ul> <a id="md:disclaimer" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Disclaimer<a href="#md:disclaimer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ul> <li>I am in no way affiliated with iRobot and this plugin is a personal project that I maintain in my free time.</li> <li>Use this plugin entirely at your own risk - please see licence for more information.</li> </ul> </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:homebridge-irobot-v2"><span>homebridge-<wbr/>i<wbr/>Robot-<wbr/>v2</span></a><ul><li><ul><li><a href="#md:plugin-information"><span>Plugin <wbr/>Information</span></a></li></ul></li><li><a href="#md:supported-devices"><span>Supported <wbr/>Devices</span></a></li><li><a href="#md:features"><span>Features:</span></a></li><li><a href="#md:todo"><span>TODO:</span></a></li><li><ul><li><a href="#md:prerequisites"><span>Prerequisites</span></a></li><li><a href="#md:setup"><span>Setup</span></a></li><li><a href="#md:helpabout"><span>Help/<wbr/>About</span></a></li><li><a href="#md:credits"><span>Credits</span></a></li><li><a href="#md:disclaimer"><span>Disclaimer</span></a></li></ul></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>homebridge-irobot-v2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>