npm - @homebridge-plugins/homebridge-firstalert - Versions diffs - 0.0.1-beta.0 - Mend

@homebridge-plugins/homebridge-firstalert 0.0.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (121) hide show

package/.gitattributes +2 -0
package/.github/FUNDING.yml +4 -0
package/.github/ISSUE_TEMPLATE/bug-report.yml +97 -0
package/.github/ISSUE_TEMPLATE/config.yml +8 -0
package/.github/ISSUE_TEMPLATE/feature-request.yml +38 -0
package/.github/ISSUE_TEMPLATE/support-request.yml +85 -0
package/.github/ISSUE_TEMPLATE.md +52 -0
package/.github/PULL_REQUEST_TEMPLATE/pull_request.md +27 -0
package/.github/dependabot.yml +17 -0
package/.github/labeler.yml +38 -0
package/.github/release-drafter.yml +33 -0
package/.github/workflows/beta-release.yml +55 -0
package/.github/workflows/build.yml +18 -0
package/.github/workflows/changerelease.yml +11 -0
package/.github/workflows/labeler.yml +9 -0
package/.github/workflows/release-drafter.yml +14 -0
package/.github/workflows/release.yml +35 -0
package/.github/workflows/stale.yml +12 -0
package/CHANGELOG.md +10 -0
package/LICENSE +14 -0
package/README.md +67 -0
package/SECURITY.md +19 -0
package/branding/Homebridge_x_FirstAlert.svg +48 -0
package/branding/icon.png +0 -0
package/config.schema.json +58 -0
package/dist/homebridge-ui/public/index.html +548 -0
package/dist/src/api/resideoClient.d.ts +32 -0
package/dist/src/api/resideoClient.d.ts.map +1 -0
package/dist/src/api/resideoClient.js +76 -0
package/dist/src/api/resideoClient.js.map +1 -0
package/dist/src/devices/device.d.ts +40 -0
package/dist/src/devices/device.d.ts.map +1 -0
package/dist/src/devices/device.js +207 -0
package/dist/src/devices/device.js.map +1 -0
package/dist/src/devices/leaksensors.d.ts +34 -0
package/dist/src/devices/leaksensors.d.ts.map +1 -0
package/dist/src/devices/leaksensors.js +163 -0
package/dist/src/devices/leaksensors.js.map +1 -0
package/dist/src/devices/smoke.d.ts +35 -0
package/dist/src/devices/smoke.d.ts.map +1 -0
package/dist/src/devices/smoke.js +150 -0
package/dist/src/devices/smoke.js.map +1 -0
package/dist/src/devices/thermostats.d.ts +42 -0
package/dist/src/devices/thermostats.d.ts.map +1 -0
package/dist/src/devices/thermostats.js +192 -0
package/dist/src/devices/thermostats.js.map +1 -0
package/dist/src/devices/valve.d.ts +21 -0
package/dist/src/devices/valve.d.ts.map +1 -0
package/dist/src/devices/valve.js +131 -0
package/dist/src/devices/valve.js.map +1 -0
package/dist/src/homebridge-ui/server.d.ts +5 -0
package/dist/src/homebridge-ui/server.d.ts.map +1 -0
package/dist/src/homebridge-ui/server.js +95 -0
package/dist/src/homebridge-ui/server.js.map +1 -0
package/dist/src/index.d.ts +4 -0
package/dist/src/index.d.ts.map +1 -0
package/dist/src/index.js +7 -0
package/dist/src/index.js.map +1 -0
package/dist/src/platform.d.ts +18 -0
package/dist/src/platform.d.ts.map +1 -0
package/dist/src/platform.js +108 -0
package/dist/src/platform.js.map +1 -0
package/dist/src/settings.d.ts +341 -0
package/dist/src/settings.d.ts.map +1 -0
package/dist/src/settings.js +25 -0
package/dist/src/settings.js.map +1 -0
package/dist/src/utils.d.ts +21 -0
package/dist/src/utils.d.ts.map +1 -0
package/dist/src/utils.js +58 -0
package/dist/src/utils.js.map +1 -0
package/dist/test/index.test.d.ts +2 -0
package/dist/test/index.test.d.ts.map +1 -0
package/dist/test/index.test.js +14 -0
package/dist/test/index.test.js.map +1 -0
package/dist/test/platform.test.d.ts +2 -0
package/dist/test/platform.test.d.ts.map +1 -0
package/dist/test/platform.test.js +56 -0
package/dist/test/platform.test.js.map +1 -0
package/dist/test/settings.test.d.ts +2 -0
package/dist/test/settings.test.d.ts.map +1 -0
package/dist/test/settings.test.js +48 -0
package/dist/test/settings.test.js.map +1 -0
package/dist/test/utils.test.d.ts +2 -0
package/dist/test/utils.test.d.ts.map +1 -0
package/dist/test/utils.test.js +17 -0
package/dist/test/utils.test.js.map +1 -0
package/docs/.nojekyll +1 -0
package/docs/assets/hierarchy.js +1 -0
package/docs/assets/highlight.css +22 -0
package/docs/assets/icons.js +18 -0
package/docs/assets/icons.svg +1 -0
package/docs/assets/main.js +60 -0
package/docs/assets/navigation.js +1 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1633 -0
package/docs/hierarchy.html +1 -0
package/docs/index.html +77 -0
package/docs/modules.html +1 -0
package/docs/variables/default.html +1 -0
package/eslint.config.js +44 -0
package/nodemon.json +10 -0
package/package.json +106 -0
package/scripts/free-dev-ports.mjs +105 -0
package/src/api/resideoClient.ts +106 -0
package/src/devices/device.ts +226 -0
package/src/devices/leaksensors.ts +206 -0
package/src/devices/smoke.ts +173 -0
package/src/devices/thermostats.ts +243 -0
package/src/devices/valve.ts +162 -0
package/src/homebridge-ui/public/index.html +548 -0
package/src/homebridge-ui/server.ts +102 -0
package/src/index.ts +13 -0
package/src/platform.ts +112 -0
package/src/settings.ts +402 -0
package/src/utils.ts +61 -0
package/test/index.test.ts +18 -0
package/test/platform.test.ts +65 -0
package/test/settings.test.ts +56 -0
package/test/utils.test.ts +20 -0
package/tsconfig.json +27 -0
package/typedoc.json +22 -0

package/docs/hierarchy.html ADDED Viewed

@@ -0,0 +1 @@

package/docs/index.html ADDED Viewed

@@ -0,0 +1,77 @@
+<!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-firstalert</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-firstalert"/><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-firstalert</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-firstalert</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-firstalert/latest/branding/Homebridge_x_Resideo.svg?sanitize=true" width="350px"></a></p>
+<h1 id="homebridge-firstalert" class="tsd-anchor-link">Homebridge FirstAlert<a href="#homebridge-firstalert" 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-firstalert"><img title="npm version" src="https://badgen.net/npm/v/homebridge-firstalert?icon=npm&label" ></a>
+<a href="https://www.npmjs.com/package/homebridge-firstalert"><img title="npm downloads" src="https://badgen.net/npm/dt/homebridge-firstalert?label=downloads" ></a>
+<a href="https://discord.gg/8fpZA4S"><img title="discord-firstalert" 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://firstalert.com">FirstAlert</a>
+plugin allows you to access your FirstAlert 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;FirstAlert&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 FirstAlert Developer Account, this account is different then your FirstAlert Account that you log into the FirstAlert 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.firstalert.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 FirstAlert accessories to show up.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Restart Homebridge</li>
+</ol>
+<h2 id="supported-firstalert-devices" class="tsd-anchor-link">Supported FirstAlert Devices<a href="#supported-firstalert-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.firstalert.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.firstalert.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.firstalert.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.firstalert.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.firstalert.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.firstalert.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.firstalert.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-firstalert"><span>Homebridge <wbr/>First<wbr/>Alert</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-firstalert-devices"><span>Supported <wbr/>First<wbr/>Alert <wbr/>Devices</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">@homebridge-plugins/homebridge-firstalert</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>

package/docs/modules.html ADDED Viewed

@@ -0,0 +1 @@

+ <!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-firstalert</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-firstalert"/><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-firstalert</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"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"></ul><h1>@homebridge-plugins/homebridge-firstalert</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Variables"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Variables</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="default"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Variable"><use href="assets/icons.svg#icon-32"></use></svg><a href="variables/default.html">default</a><a href="#default" 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></span></dt><dd class="tsd-member-summary"></dd></dl></details></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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Variables"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Variables</summary><div><a href="#default"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Variable"><use href="assets/icons.svg#icon-32"></use></svg><span>default</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">@homebridge-plugins/homebridge-firstalert</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>

package/docs/variables/default.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | @homebridge-plugins/homebridge-firstalert</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-firstalert"/><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-firstalert</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"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">default</a></li></ul><h1>Variable default</h1></div><div class="tsd-signature"><span class="tsd-kind-variable">default</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type">API</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge-plugins/homebridge-firstalert/blob/4e9b7a0dafe971e2a3d4653fe9b6c5b65ad9c47d/src/index.ts#L11">index.ts:11</a></li></ul></aside></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@homebridge-plugins/homebridge-firstalert</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>

package/eslint.config.js ADDED Viewed

@@ -0,0 +1,44 @@
+import antfu from '@antfu/eslint-config'
+export default antfu(
+  {
+    ignores: ['dist', 'docs'],
+    jsx: false,
+    typescript: true,
+    formatters: {
+      markdown: true,
+    },
+    rules: {
+      'curly': ['error', 'multi-line'],
+      'import/order': 0,
+      'jsdoc/check-alignment': 'error',
+      'jsdoc/check-line-alignment': 'error',
+      'no-undef': 'error',
+      'perfectionist/sort-exports': 'error',
+      'perfectionist/sort-imports': [
+        'error',
+        {
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            ['parent', 'sibling', 'index'],
+            'unknown',
+          ],
+          order: 'asc',
+          type: 'natural',
+        },
+      ],
+      'perfectionist/sort-named-exports': 'error',
+      'perfectionist/sort-named-imports': 'error',
+      'sort-imports': 0,
+      'style/brace-style': ['error', '1tbs', { allowSingleLine: true }],
+      'style/quote-props': ['error', 'consistent-as-needed'],
+      'test/no-only-tests': 'error',
+      'unicorn/no-useless-spread': 'error',
+      'unused-imports/no-unused-vars': ['error', { caughtErrors: 'none' }],
+      'no-new': 0, // Disable the no-new rule
+      'new-cap': 0, // Disable the new-cap rule
+    },
+  },
+)

package/nodemon.json ADDED Viewed

@@ -0,0 +1,10 @@
+{
+  "watch": ["src"],
+  "ext": "ts,html,json",
+  "ignore": [],
+  "exec": "npm run build",
+  "signal": "SIGTERM",
+  "env": {
+    "NODE_OPTIONS": "--trace-warnings"
+  }
+}

package/package.json ADDED Viewed

@@ -0,0 +1,106 @@
+{
+  "name": "@homebridge-plugins/homebridge-firstalert",
+  "displayName": "FirstAlert",
+  "type": "module",
+  "version": "0.0.1-beta.0",
+  "description": "The FirstAlert plugin allows you to access your FirstAlert device(s) from HomeKit.",
+  "author": {
+    "name": "donavanbecker",
+    "url": "https://github.com/donavanbecker"
+  },
+  "maintainers": [
+    "donavanbecker"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "ISC",
+  "funding": [
+    {
+      "type": "Paypal",
+      "url": "https://paypal.me/donavanbecker"
+    },
+    {
+      "type": "GitHub",
+      "url": "https://github.com/sponsors/donavanbecker"
+    }
+  ],
+  "homepage": "https://github.com/homebridge-plugins/homebridge-firstalert",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/homebridge-plugins/homebridge-firstalert.git"
+  },
+  "bugs": {
+    "url": "https://github.com/homebridge-plugins/homebridge-firstalert/issues"
+  },
+  "keywords": [
+    "homebridge-plugin",
+    "honeywell",
+    "honeywell-home",
+    "thermostat",
+    "leaksensor",
+    "leak sensor",
+    "lcc",
+    "tcc",
+    "FirstAlert",
+    "First Alert",
+    "Resideo",
+    "honeywellhome",
+    "honeywell home",
+    "temperature",
+    "humidity",
+    "leak"
+  ],
+  "main": "dist/index.js",
+  "engines": {
+    "homebridge": "^1.11.3 || ^2.0.0-beta.77",
+    "node": "^22 || ^24"
+  },
+  "scripts": {
+    "check": "npm install && npm outdated",
+    "ports:free": "node scripts/free-dev-ports.mjs",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/**/*.ts test/**/*.ts src/homebridge-ui/**/*.html && npm run typecheck",
+    "lint:src": "eslint src/**/*.ts",
+    "lint:test": "eslint test/**/*.ts",
+    "lint:ui": "eslint src/homebridge-ui/**/*.html",
+    "lint:fix": "eslint src/**/*.ts test/**/*.ts src/homebridge-ui/**/*.html --fix && npm run typecheck",
+    "watch": "npm run ports:free && npm run build && npm run plugin-ui && npm link && nodemon",
+    "watch:ui": "npm run ports:free && bash -c 'npx homebridge -I -U -D ~/.homebridge-dev & HB_PID=$!; sleep 6; UIX_STORAGE_PATH=~/.homebridge-dev node ./node_modules/homebridge-config-ui-x/dist/bin/standalone.js & npm run watch:files'",
+    "watch:files": "nodemon",
+    "plugin-ui": "mkdir -p ./dist/homebridge-ui/public && if [ -d ./src/homebridge-ui/public ]; then rsync -a ./src/homebridge-ui/public/ ./dist/homebridge-ui/public/; fi",
+    "build": "npm run clean && tsc && npm run plugin-ui",
+    "prepublishOnly": "npm run lint && npm run build && npm run plugin-ui && npm run docs && npm run lint-docs",
+    "postpublish": "npm run clean && npm ci",
+    "clean": "shx rm -rf ./dist",
+    "test": "npm run lint",
+    "docs": "typedoc",
+    "lint-docs": "typedoc --emit none --treatWarningsAsErrors"
+  },
+  "dependencies": {
+    "@homebridge/plugin-ui-utils": "^2.2.2",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/ms": "^2.1.0",
+    "class-validator": "^0.15.1",
+    "rxjs": "^7.8.1",
+    "undici": "^7.24.5"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^7.7.3",
+    "@types/debug": "^4.1.13",
+    "@types/node": "^25.5.0",
+    "@types/semver": "^7.7.1",
+    "@vitest/coverage-v8": "^4.1.0",
+    "esbuild": "^0.27.4",
+    "eslint": "^10.1.0",
+    "eslint-plugin-format": "^2.0.1",
+    "homebridge": "^1.11.3",
+    "homebridge-config-ui-x": "^5.20.0",
+    "nodemon": "^3.1.14",
+    "shx": "^0.4.0",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.18",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  }
+}

package/scripts/free-dev-ports.mjs ADDED Viewed

@@ -0,0 +1,105 @@
+import { execSync } from 'node:child_process'
+import { readFileSync } from 'node:fs'
+import { homedir } from 'node:os'
+import { resolve } from 'node:path'
+function resolvePorts() {
+  let bridgePort = 51829
+  let uiPort = 8581
+  try {
+    const configPath = resolve(homedir(), '.homebridge-dev', 'config.json')
+    const config = JSON.parse(readFileSync(configPath, 'utf8'))
+    if (typeof config?.bridge?.port === 'number') {
+      bridgePort = config.bridge.port
+    }
+    const configUiPlatform = Array.isArray(config?.platforms)
+      ? config.platforms.find(platform => platform?.platform === 'config')
+      : undefined
+    if (typeof configUiPlatform?.port === 'number') {
+      uiPort = configUiPlatform.port
+    }
+  } catch {}
+  return [...new Set([bridgePort, uiPort])]
+}
+function pidsForPort(port) {
+  try {
+    const output = execSync(`lsof -ti tcp:${port}`, { stdio: ['ignore', 'pipe', 'ignore'] }).toString().trim()
+    return output ? output.split('\n').filter(Boolean) : []
+  } catch {
+    return []
+  }
+}
+function freePort(port) {
+  const initialPids = pidsForPort(port)
+  if (initialPids.length === 0) {
+    return
+  }
+  try {
+    execSync(`lsof -ti tcp:${port} | xargs -r kill -TERM`, { stdio: ['ignore', 'ignore', 'ignore'] })
+  } catch {}
+  const remainingPids = pidsForPort(port)
+  if (remainingPids.length > 0) {
+    try {
+      execSync(`lsof -ti tcp:${port} | xargs -r kill -KILL`, { stdio: ['ignore', 'ignore', 'ignore'] })
+    } catch {}
+  }
+}
+function cleanupDevProcesses() {
+  let output = ''
+  try {
+    output = execSync('ps -axo pid=,command=', { stdio: ['ignore', 'pipe', 'ignore'] }).toString()
+  } catch {
+    return
+  }
+  const targetPids = output
+    .split('\n')
+    .map(line => line.trim())
+    .filter(Boolean)
+    .map((line) => {
+      const firstSpace = line.indexOf(' ')
+      if (firstSpace === -1) {
+        return null
+      }
+      const pid = Number(line.slice(0, firstSpace).trim())
+      const command = line.slice(firstSpace + 1)
+      return Number.isFinite(pid) ? { pid, command } : null
+    })
+    .filter((entry) => {
+      if (!entry) {
+        return false
+      }
+      if (entry.pid === process.pid || entry.pid === process.ppid) {
+        return false
+      }
+      const isNodemonProcess = entry.command.includes('homebridge-switchbot/node_modules/.bin/nodemon')
+      const isConfigUiProcess = entry.command.trim().startsWith('homebridge-config-ui-x')
+      return isNodemonProcess || isConfigUiProcess
+    })
+    .map(entry => entry.pid)
+  for (const pid of targetPids) {
+    try {
+      process.kill(pid, 'SIGTERM')
+    } catch {}
+  }
+}
+cleanupDevProcesses()
+for (const port of resolvePorts()) {
+  freePort(port)
+}

package/src/api/resideoClient.ts ADDED Viewed

@@ -0,0 +1,106 @@
+// FirstAlert API client for OAuth and device polling
+// Implements token refresh, account/device fetch, and strong typing
+import { request } from 'undici'
+export interface ResideoDevice {
+  id: string
+  name: string
+  deviceId: string
+  globalDeviceType: string
+}
+export interface ResideoAccount {
+  id: string
+  firstName: string
+  lastName: string
+  contactEmail: string
+  countryCode: string
+  locale: string
+  devices: ResideoDevice[]
+}
+export interface ResideoDeviceState {
+  name: string
+  deviceType: string
+  isOnline: boolean
+  deviceState: any
+}
+export class ResideoClient {
+  private clientId = 'SRmiA7CaYi1JgivDZdzzoZu4X5VBogGt'
+  private refreshToken: string
+  private accessToken: string | null = null
+  constructor(refreshToken: string) {
+    this.refreshToken = refreshToken
+  }
+  async refreshAccessToken(): Promise<string> {
+    const body = JSON.stringify({
+      grant_type: 'refresh_token',
+      refresh_token: this.refreshToken,
+      client_id: this.clientId,
+    })
+    const { body: resBody } = await request('https://login.firstalert.com/oauth/token', {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body,
+    })
+    const data = await resBody.json() as { access_token?: string }
+    this.accessToken = data.access_token ?? ''
+    if (!this.accessToken) {
+      throw new Error('Failed to obtain access token from FirstAlert API')
+    }
+    return this.accessToken
+  }
+  async getAccessToken(): Promise<string> {
+    if (!this.accessToken) {
+      await this.refreshAccessToken()
+    }
+    return this.accessToken!
+  }
+  async getAccount(): Promise<ResideoAccount> {
+    const token = await this.getAccessToken()
+    const { body: resBody } = await request('https://api.firstalert.com/ris-public-api/api/v1/accounts', {
+      method: 'GET',
+      headers: { Authorization: `Bearer ${token}` },
+    })
+    const resp = await resBody.json() as { data: any }
+    // Parse and flatten devices
+    const data = resp.data
+    const devices: ResideoDevice[] = []
+    for (const user of data.consumerUsers) {
+      for (const loc of user.consumerAccount.locations) {
+        for (const dev of loc.consumerDevices) {
+          devices.push({
+            id: dev.id,
+            name: dev.name,
+            deviceId: dev.device.deviceId,
+            globalDeviceType: dev.device.globalDeviceType,
+          })
+        }
+      }
+    }
+    return {
+      id: data.id,
+      firstName: data.firstName,
+      lastName: data.lastName,
+      contactEmail: data.contactEmail,
+      countryCode: data.countryCode,
+      locale: data.locale,
+      devices,
+    }
+  }
+  async getDeviceState(deviceId: string): Promise<ResideoDeviceState> {
+    const token = await this.getAccessToken()
+    const { body: resBody } = await request(`https://api.firstalert.com/ris-public-api/api/v2/devices/smokeDetectors/${deviceId}/state`, {
+      method: 'GET',
+      headers: { Authorization: `Bearer ${token}` },
+    })
+    return await resBody.json() as ResideoDeviceState
+  }
+}