UNPKG

@homebridge-plugins/homebridge-resideo

Version:

The Resideo plugin allows you to access your Resideo device(s) from HomeKit.

78 lines (77 loc) 9.74 kB
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@homebridge-plugins/homebridge-resideo</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-resideo"/><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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@homebridge-plugins/homebridge-resideo</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@homebridge-plugins/homebridge-resideo</h1></div><div class="tsd-panel tsd-typography"><span align="center"> <p><a href="https://github.com/homebridge/verified/blob/latest/verified-plugins.json"><img alt="homebridge-verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-resideo/latest/branding/Homebridge_x_Resideo.svg?sanitize=true" width="350px"></a></p> <h1 id="homebridge-resideo" class="tsd-anchor-link">Homebridge Resideo<a href="#homebridge-resideo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1> <p><a href="https://www.npmjs.com/package/homebridge-resideo"><img title="npm version" src="https://badgen.net/npm/v/homebridge-resideo?icon=npm&label" ></a> <a href="https://www.npmjs.com/package/homebridge-resideo"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-resideo?label=downloads" ></a> <a href="https://discord.gg/8fpZA4S"><img title="discord-resideo" src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord" ></a> <a href="https://paypal.me/donavanbecker"><img title="donate" src="https://badgen.net/badge/donate/paypal/yellow" ></a></p> <p>The Homebridge <a href="https://resideo.com">Resideo</a> plugin allows you to access your Resideo Device(s) from HomeKit with <a href="https://homebridge.io">Homebridge</a>. </p> </span> <h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2> <ol> <li>Search for &quot;Resideo&quot; on the plugin screen of <a href="https://github.com/oznu/homebridge-config-ui-x">Homebridge Config UI X</a>.</li> <li>Click <strong>Install</strong>.</li> </ol> <h2 id="configuration" class="tsd-anchor-link">Configuration<a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2> <ol> <li>Login / create an account at <a href="https://developer.honeywellhome.com/user">https://developer.honeywellhome.com/user</a> <ul> <li>Your Resideo Developer Account, this account is different then your Resideo Account that you log into the Resideo App with</li> </ul> </li> <li>Click <strong>Create New App</strong></li> <li>Give your application a name</li> <li>Copy the hostname found on #3 of the Intro Page into the Callback URL field</li> </ol> <p align="center"> <img src="https://user-images.githubusercontent.com/9875439/192078620-6998511c-1c11-4e06-b7e1-475b22ef5180.png" width="300px"> </p> <ol start="5"> <li>Enter the generated consumer key and secret into the plugin settings screen of <a href="https://github.com/oznu/homebridge-config-ui-x">Homebridge Config UI X</a></li> <li>Click <strong>Link Account</strong></li> </ol> <p align="center"> <img src="https://user-images.githubusercontent.com/9875439/192078614-e568d121-e0e4-4123-bdda-4238e8a6e601.png" width="300px"> </p> <ol start="7"> <li>Login to your <a href="https://account.honeywellhome.com">https://www.resideo.com</a>.</li> <li>Click Allow</li> <li>Select Devices <ul> <li>I would recommend selecting all devices since you can restrict the devices you don't want in the Home app later, by DeviceID.</li> </ul> </li> <li>Click Connect</li> <li>Click Save <ul> <li>If you plan on adding this plugin into a child bridge, I would configure that at this time before restarting Homebridge. <ul> <li>Reminder that you will have to add this child bridge into the home app to get Resideo accessories to show up.</li> </ul> </li> </ul> </li> <li>Restart Homebridge</li> </ol> <h2 id="supported-resideo-devices" class="tsd-anchor-link">Supported Resideo Devices<a href="#supported-resideo-devices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2> <ul> <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t10-pro-smart-thermostat-with-redlinkr-room-sensor-thx321wfs2001w-u/">T10 Thermostat</a> - Already HomeKit Certified</li> <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t9-smart-thermostat-with-sensor-rcht9610wfsw2003-u/">T9 Thermostat</a> - Already HomeKit Certified <ul> <li><a href="https://www.resideo.com/us/en/products/air/thermostat-accessories/t9-smart-sensor-rchtsensor-1pk-u/">T9 Smart Roomsensors</a></li> </ul> </li> <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t6-pro-smart-thermostat-multi-stage-3-heat-2-cool-th6320wf2003-u/">T6 Thermostat</a> - Already HomeKit Certified</li> <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/t5-smart-thermostat-with-c-wire-adapter-rcht8612wf2005-u/">T5 Thermostat</a> - Already HomeKit Certified</li> <li><a href="https://www.resideo.com/us/en/products/air/thermostats/wifi-thermostats/the-round-smart-thermostat-rch9310wf5003-u/">Round Thermostat</a> - Already HomeKit Certified</li> <li>Some Total Comfort Control Thermostats <ul> <li>Pushing Commands may not be supported on some.</li> </ul> </li> <li><a href="https://www.resideo.com/us/en/products/water/spot-leak-detection/wifi-water-leak-freeze-detector-rchw3610wf1001-u/">WiFi Water Leak &amp; Freeze Detector</a></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>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-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></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#homebridge-resideo"><span>Homebridge <wbr/>Resideo</span></a><ul><li><a href="#installation"><span>Installation</span></a></li><li><a href="#configuration"><span>Configuration</span></a></li><li><a href="#supported-resideo-devices"><span>Supported <wbr/>Resideo <wbr/>Devices</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@homebridge-plugins/homebridge-resideo</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>