@homebridge-plugins/homebridge-smarthq 0.2.0-beta.1 → 0.2.0-beta.10

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.
package/docs/index.html CHANGED
@@ -1,34 +1,166 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@homebridge-plugins/homebridge-smarthq</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-smarthq"/><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-plugins/homebridge-smarthq</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-plugins/homebridge-smarthq</h1></div><div class="tsd-panel tsd-typography"><span align="center">
2
- <p><a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img alt="homebridge-verified" src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-smarthq/latest/branding/Homebridge_x_Air.svg?sanitize=true" width="350px"></a></p>
3
- <a id="md:homebridge-smarthq" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Homebridge SmartHQ<a href="#md:homebridge-smarthq" 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 href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img title="npm version" src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-smarthq?icon=npm&label" ></a>
4
- <a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img title="npm downloads" src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-smarthq?label=downloads" ></a>
5
- <a href="https://discord.gg/8fpZA4S"><img title="discord-air" src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord" ></a>
6
- <a href="https://paypal.me/donavanbecker"><img title="donate" src="https://badgen.net/badge/donate/paypal/yellow" ></a></p>
7
- <p>The Homebridge <a href="https://airnow.gove">SmartHQ</a>
8
- plugin allows you monitor the current AirQuality for your Zip Code from HomeKit and Siri.
9
- </p>
10
- </span>
11
- <a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ol>
12
- <li>Search for &quot;SmartHQ&quot; on the plugin screen of <a href="https://github.com/oznu/homebridge-config-ui-x" target="_blank" class="external">Homebridge Config UI X</a>.</li>
13
- <li>Click <strong>Install</strong>.</li>
14
- </ol>
15
- <a id="md:configuration" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Configuration<a href="#md:configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ol>
16
- <li>Login / create an account at <a href="https://airnow.gove/" target="_blank" class="external">https://airnow.gove/</a></li>
17
- </ol>
18
- <p align="center">
19
- <img src="https://user-images.githubusercontent.com/9875439/133934622-05a9c19e-c5ba-46ee-b0db-0748420813d7.png" width="450px">
20
- </p>
21
- <ol start="2">
22
- <li>Type in your <a href="http://SmartHQ.gov" target="_blank" class="external">SmartHQ.gov</a> API Key and Zip Code</li>
23
- <li>Click Save</li>
24
- <li>Restart Homebridge</li>
25
- </ol>
26
- <a id="md:supported-smarthq-quality-providers" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported SmartHQ Quality Providers<a href="#md:supported-smarthq-quality-providers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Currently supports AQI Services:</p>
27
- <ul>
28
- <li><a href="https://www.airnow.gov/" target="_blank" class="external">SmartHQ</a> which is limited to the USA. A valid ZipCode is required.</li>
29
- <li><a href="https://www.aqicn.org/" target="_blank" class="external">Aqicn</a> which has international support, provided by the <a href="http://waqi.info/" target="_blank" class="external">World SmartHQ Quality Index Project</a>.</li>
30
- </ul>
31
- <p>Depending on where exactly you would like to monitor AQI, one service may be more appropriate than the other.</p>
32
- <a id="md:supported-smarthq-quality-features" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported SmartHQ Quality Features<a href="#md:supported-smarthq-quality-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><p>This plugin will create an DishWasher element. The Home app works well, but the Eve app seems to show more measurements. Measurements retrieved are PM2.5, PM10, &amp; O3 for SmartHQ. Aqicn adds NO2, SO2, CO...</p>
33
- <a id="md:thanks" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Thanks<a href="#md:thanks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Thank you to <a href="https://github.com/ToddGreenfield" target="_blank" class="external">ToddGreenfield</a> for the the work done on the accesorry based plugin <a href="https://github.com/ToddGreenfield/homebridge-airnow/blob/master/README.md" target="_blank" class="external">homebridge-airnow</a>.</p>
34
- </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-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"><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-smarthq"><span>Homebridge <wbr/>SmartHQ</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><a href="#md:configuration"><span>Configuration</span></a></li><li><a href="#md:supported-smarthq-quality-providers"><span>Supported <wbr/>SmartHQ <wbr/>Quality <wbr/>Providers</span></a></li><li><a href="#md:supported-smarthq-quality-features"><span>Supported <wbr/>SmartHQ <wbr/>Quality <wbr/>Features</span></a></li><li><a href="#md:thanks"><span>Thanks</span></a></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-plugins/homebridge-smarthq</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html>
2
+ <html class="default" lang="en">
3
+
4
+ <head>
5
+ <meta charset="utf-8" />
6
+ <meta http-equiv="x-ua-compatible" content="IE=edge" />
7
+ <title>@homebridge-plugins/homebridge-smarthq</title>
8
+ <meta name="description" content="Documentation for @homebridge-plugins/homebridge-smarthq" />
9
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
10
+ <link rel="stylesheet" href="assets/style.css" />
11
+ <link rel="stylesheet" href="assets/highlight.css" />
12
+ <script defer src="assets/main.js"></script>
13
+ <script async src="assets/icons.js" id="tsd-icons-script"></script>
14
+ <script async src="assets/search.js" id="tsd-search-script"></script>
15
+ <script async src="assets/navigation.js" id="tsd-nav-script"></script>
16
+ </head>
17
+
18
+ <body>
19
+ <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>
20
+ <header class="tsd-page-toolbar">
21
+ <div class="tsd-toolbar-contents container">
22
+ <div class="table-cell" id="tsd-search" data-base=".">
23
+ <div class="field"><label for="tsd-search-field"
24
+ class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16"
25
+ viewBox="0 0 16 16" fill="none">
26
+ <use href="assets/icons.svg#icon-search"></use>
27
+ </svg></label><input type="text" id="tsd-search-field" aria-label="Search" /></div>
28
+ <div class="field">
29
+ <div id="tsd-toolbar-links"></div>
30
+ </div>
31
+ <ul class="results">
32
+ <li class="state loading">Preparing search index...</li>
33
+ <li class="state failure">The search index is not available</li>
34
+ </ul><a href="index.html" class="title">@homebridge-plugins/homebridge-smarthq</a>
35
+ </div>
36
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption"
37
+ data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none">
38
+ <use href="assets/icons.svg#icon-menu"></use>
39
+ </svg></a></div>
40
+ </div>
41
+ </header>
42
+ <div class="container container-main">
43
+ <div class="col-content">
44
+ <div class="tsd-page-title">
45
+ <h1>@homebridge-plugins/homebridge-smarthq</h1>
46
+ </div>
47
+ <div class="tsd-panel tsd-typography"><span align="center">
48
+ <p><a href="https://github.com/homebridge/verified/blob/master/verified-plugins.json"><img
49
+ alt="homebridge-verified"
50
+ src="https://raw.githubusercontent.com/homebridge-plugins/homebridge-smarthq/latest/branding/Homebridge_x_SmartHQ.svg?sanitize=true"
51
+ width="350px"></a></p>
52
+ <a id="md:homebridge-smarthq" class="tsd-anchor"></a>
53
+ <h1 class="tsd-anchor-link">Homebridge SmartHQ<a href="#md:homebridge-smarthq"
54
+ aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24">
55
+ <use href="assets/icons.svg#icon-anchor"></use>
56
+ </svg></a></h1>
57
+ <p><a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img
58
+ title="npm version"
59
+ src="https://badgen.net/npm/v/@homebridge-plugins/homebridge-smarthq?icon=npm&label"></a>
60
+ <a href="https://www.npmjs.com/package/@homebridge-plugins/homebridge-smarthq"><img
61
+ title="npm downloads"
62
+ src="https://badgen.net/npm/dt/@homebridge-plugins/homebridge-smarthq?label=downloads"></a>
63
+ <a href="https://discord.gg/8fpZA4S"><img title="discord-smarthq"
64
+ src="https://badgen.net/discord/online-members/8fpZA4S?icon=discord&label=discord"></a>
65
+ <a href="https://paypal.me/donavanbecker"><img title="donate"
66
+ src="https://badgen.net/badge/donate/paypal/yellow"></a>
67
+ </p>
68
+ <p>The Homebridge <a href="https://www.geappliances.com/connect">SmartHQ</a>
69
+ plugin allows which allows to interact with SmartHQ API.
70
+ </p>
71
+ </span>
72
+ <a id="md:installation" class="tsd-anchor"></a>
73
+ <h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink"
74
+ class="tsd-anchor-icon"><svg viewBox="0 0 24 24">
75
+ <use href="assets/icons.svg#icon-anchor"></use>
76
+ </svg></a></h2>
77
+ <ol>
78
+ <li>Search for &quot;SmartHQ&quot; on the plugin screen of <a
79
+ href="https://github.com/oznu/homebridge-config-ui-x" target="_blank"
80
+ class="external">Homebridge Config UI X</a>.</li>
81
+ <li>Click <strong>Install</strong>.</li>
82
+ </ol>
83
+ <a id="md:configuration" class="tsd-anchor"></a>
84
+ <h2 class="tsd-anchor-link">Configuration<a href="#md:configuration" aria-label="Permalink"
85
+ class="tsd-anchor-icon"><svg viewBox="0 0 24 24">
86
+ <use href="assets/icons.svg#icon-anchor"></use>
87
+ </svg></a></h2>
88
+ <ol>
89
+ <li>Input Username &amp; Password</li>
90
+ <li>Click Save</li>
91
+ <li>Restart Homebridge</li>
92
+ </ol>
93
+ <a id="md:supported-smarthq-features" class="tsd-anchor"></a>
94
+ <h2 class="tsd-anchor-link">Supported SmartHQ Features<a href="#md:supported-smarthq-features"
95
+ aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24">
96
+ <use href="assets/icons.svg#icon-anchor"></use>
97
+ </svg></a></h2>
98
+ <p>This plugin is in developenet</p>
99
+ </div>
100
+ </div>
101
+ <div class="col-sidebar">
102
+ <div class="page-menu">
103
+ <div class="tsd-navigation settings">
104
+ <details class="tsd-accordion">
105
+ <summary class="tsd-accordion-summary">
106
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none">
107
+ <use href="assets/icons.svg#icon-chevronDown"></use>
108
+ </svg>Settings</h3>
109
+ </summary>
110
+ <div class="tsd-accordion-details">
111
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
112
+ <ul id="tsd-filter-options">
113
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox"
114
+ id="tsd-filter-inherited" name="inherited" checked /><svg width="32"
115
+ height="32" viewBox="0 0 32 32" aria-hidden="true">
116
+ <rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1"
117
+ rx="6" fill="none"></rect>
118
+ <path class="tsd-checkbox-checkmark"
119
+ d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none"
120
+ stroke-width="3.5" stroke-linejoin="round" fill="none"></path>
121
+ </svg><span>Inherited</span></label></li>
122
+ </ul>
123
+ </div>
124
+ <div class="tsd-theme-toggle"><label class="settings-label"
125
+ for="tsd-theme">Theme</label><select id="tsd-theme">
126
+ <option value="os">OS</option>
127
+ <option value="light">Light</option>
128
+ <option value="dark">Dark</option>
129
+ </select></div>
130
+ </div>
131
+ </details>
132
+ </div>
133
+ <details open class="tsd-accordion tsd-page-navigation">
134
+ <summary class="tsd-accordion-summary">
135
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none">
136
+ <use href="assets/icons.svg#icon-chevronDown"></use>
137
+ </svg>On This Page</h3>
138
+ </summary>
139
+ <div class="tsd-accordion-details"><a href="#md:homebridge-smarthq"><span>Homebridge
140
+ <wbr/>SmartHQ</span></a>
141
+ <ul>
142
+ <li><a href="#md:installation"><span>Installation</span></a></li>
143
+ <li><a href="#md:configuration"><span>Configuration</span></a></li>
144
+ <li><a href="#md:supported-smarthq-features"><span>Supported <wbr/>SmartHQ
145
+ <wbr/>Features</span></a></li>
146
+ </ul>
147
+ </div>
148
+ </details>
149
+ </div>
150
+ <div class="site-menu">
151
+ <nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon"
152
+ viewBox="0 0 24 24">
153
+ <use href="assets/icons.svg#icon-1"></use>
154
+ </svg><span>@homebridge-plugins/homebridge-smarthq</span></a>
155
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".">
156
+ <li>Loading...</li>
157
+ </ul>
158
+ </nav>
159
+ </div>
160
+ </div>
161
+ </div>
162
+ <footer></footer>
163
+ <div class="overlay"></div>
164
+ </body>
165
+
166
+ </html>
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@homebridge-plugins/homebridge-smarthq",
3
3
  "displayName": "SmartHQ",
4
4
  "type": "module",
5
- "version": "0.2.0-beta.1",
5
+ "version": "0.2.0-beta.10",
6
6
  "description": "The SmartHQ plugin allows you to interact with SmartHQ Devices in HomeKit and with Siri.",
7
7
  "author": {
8
8
  "name": "donavanbecker",