@switchbot/homebridge-switchbot 3.6.1-beta.16 → 3.6.1-beta.18
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/CHANGELOG.md +1 -1
- package/docs/.nojekyll +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 +1448 -0
- package/docs/functions/default.html +1 -0
- package/docs/index.html +368 -0
- package/docs/modules.html +2 -0
- package/package.json +8 -5
- package/typedoc.json +17 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | @switchbot/homebridge-switchbot</title><meta name="description" content="Documentation for @switchbot/homebridge-switchbot"/><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">@switchbot/homebridge-switchbot</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@switchbot/homebridge-switchbot</a></li><li><a href="default.html">default</a></li></ul><h1>Function default</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/blob/8bb3faecdfed24721e3940dd8652587017c0ec77/src/index.ts#L11">index.ts:11</a></li></ul></aside></li></ul></section></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></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@switchbot/homebridge-switchbot</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>
|
package/docs/index.html
ADDED
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@switchbot/homebridge-switchbot</title><meta name="description" content="Documentation for @switchbot/homebridge-switchbot"/><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">@switchbot/homebridge-switchbot</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"><h2>@switchbot/homebridge-switchbot</h2></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/OpenWonderLabs/homebridge-switchbot/latest/branding/Homebridge_x_SwitchBot.svg?sanitize=true" width="350px"></a></p>
|
|
3
|
+
<a id="md:switchbothomebridge-switchbot" class="tsd-anchor"></a><h1 class="tsd-anchor-link">@switchbot/homebridge-switchbot<a href="#md:switchbothomebridge-switchbot" 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/@switchbot/homebridge-switchbot"><img src="https://badgen.net/npm/v/@switchbot/homebridge-switchbot" alt="npm version"></a>
|
|
4
|
+
<a href="https://www.npmjs.com/package/@switchbot/homebridge-switchbot"><img src="https://badgen.net/npm/dt/@switchbot/homebridge-switchbot" alt="npm downloads"></a>
|
|
5
|
+
<a href="https://discord.gg/5wYTbwP4ha"><img src="https://badgen.net/discord/online-members/5wYTbwP4ha?icon=discord&label=discord" alt="discord-switchbot"></a></p>
|
|
6
|
+
<p>The Homebridge <a href="https://www.switch-bot.com">SwitchBot</a> plugin allows you to access your SwitchBot Device(s) from HomeKit with
|
|
7
|
+
<a href="https://homebridge.io">Homebridge</a>.
|
|
8
|
+
</p>
|
|
9
|
+
</span>
|
|
10
|
+
<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>
|
|
11
|
+
<li>Search for "SwitchBot" on the plugin screen of <a href="https://github.com/oznu/homebridge-config-ui-x">Homebridge Config UI X</a></li>
|
|
12
|
+
<li>Find: <code>@switchbot/homebridge-switchbot</code>
|
|
13
|
+
<ul>
|
|
14
|
+
<li>See noble <a href="https://github.com/abandonware/noble#prerequisites">prerequisites</a> for your OS. (This is used for BLE connection.)</li>
|
|
15
|
+
</ul>
|
|
16
|
+
</li>
|
|
17
|
+
<li>Click <strong>Install</strong></li>
|
|
18
|
+
</ol>
|
|
19
|
+
<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><ul>
|
|
20
|
+
<li>
|
|
21
|
+
<a id="md:if-using-openapi-connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">If using OpenAPI Connection<a href="#md:if-using-openapi-connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ol>
|
|
22
|
+
<li>Download SwitchBot App on App Store or Google Play Store</li>
|
|
23
|
+
<li>Register a SwitchBot account and log in into your account</li>
|
|
24
|
+
<li>Generate an Token within the App
|
|
25
|
+
<ul>
|
|
26
|
+
<li>Click Bottom Profile Tab</li>
|
|
27
|
+
<li>Click Preference</li>
|
|
28
|
+
<li>Click App version 10 Times, this will enable Developer Options</li>
|
|
29
|
+
<li>Click Developer Options</li>
|
|
30
|
+
<li>Click Copy <code>token</code> to Clipboard</li>
|
|
31
|
+
</ul>
|
|
32
|
+
</li>
|
|
33
|
+
<li>Input your <code>token</code> into the config parameter</li>
|
|
34
|
+
<li>Generate an Secret within the App
|
|
35
|
+
<ul>
|
|
36
|
+
<li>Click Bottom Profile Tab</li>
|
|
37
|
+
<li>Click Preference</li>
|
|
38
|
+
<li>Click App version 10 Times, this will enable Developer Options</li>
|
|
39
|
+
<li>Click Developer Options</li>
|
|
40
|
+
<li>Click Copy <code>secret</code> to Clipboard</li>
|
|
41
|
+
</ul>
|
|
42
|
+
</li>
|
|
43
|
+
<li>Input your <code>secret</code> into the config parameter</li>
|
|
44
|
+
</ol>
|
|
45
|
+
</li>
|
|
46
|
+
<li>
|
|
47
|
+
<a id="md:if-using-ble-connection" class="tsd-anchor"></a><h3 class="tsd-anchor-link">If using BLE Connection<a href="#md:if-using-ble-connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ol>
|
|
48
|
+
<li>Download SwitchBot App on App Store or Google Play Store</li>
|
|
49
|
+
<li>Register a SwitchBot account and log in into your account</li>
|
|
50
|
+
<li>Click on Device wanting to connect too plugin
|
|
51
|
+
<ul>
|
|
52
|
+
<li>Click the Settings Gear</li>
|
|
53
|
+
<li>Click Device Info</li>
|
|
54
|
+
<li>Copy BLE Mac aka <code>deviceId</code></li>
|
|
55
|
+
</ul>
|
|
56
|
+
</li>
|
|
57
|
+
<li>Input your <code>deviceId</code> into the Device Config</li>
|
|
58
|
+
</ol>
|
|
59
|
+
</li>
|
|
60
|
+
</ul>
|
|
61
|
+
<a id="md:troubleshooting" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Troubleshooting<a href="#md:troubleshooting" 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>
|
|
62
|
+
<li>
|
|
63
|
+
<a id="md:if-using-linux--raspberry-pi-os" class="tsd-anchor"></a><h3 class="tsd-anchor-link">If using Linux / Raspberry Pi OS<a href="#md:if-using-linux--raspberry-pi-os" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><ol>
|
|
64
|
+
<li>
|
|
65
|
+
<p><code>bluetoothctl</code> must be installed on the device, otherwise it cannot communicate via Bluetooth. Enable it with <code>sudo bluetoothctl power on</code>.</p>
|
|
66
|
+
</li>
|
|
67
|
+
<li>
|
|
68
|
+
<p>If errors occur, while enabling it, restart the process:</p>
|
|
69
|
+
<ul>
|
|
70
|
+
<li><code>rfkill block bluetooth</code></li>
|
|
71
|
+
<li><code>rfkill unblock bluetooth</code></li>
|
|
72
|
+
</ul>
|
|
73
|
+
</li>
|
|
74
|
+
<li>
|
|
75
|
+
<p>Also make sure, that the computer can discover the SwitchBot device:</p>
|
|
76
|
+
<ul>
|
|
77
|
+
<li><code>sudo bluetoothctl</code></li>
|
|
78
|
+
<li><code>scan on</code></li>
|
|
79
|
+
</ul>
|
|
80
|
+
<p>This lists all discovered Bluetooth devices. The BLE address of the SwitchBot device should be included in this list, otherwise your computer does not discover it.</p>
|
|
81
|
+
</li>
|
|
82
|
+
</ol>
|
|
83
|
+
</li>
|
|
84
|
+
</ul>
|
|
85
|
+
<a id="md:supported-switchbot-devices" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported SwitchBot Devices<a href="#md:supported-switchbot-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><ul>
|
|
86
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-smart-humidifier">SwitchBot Humidifier</a>
|
|
87
|
+
<ul>
|
|
88
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Can Push Updates over OpenAPI</li>
|
|
91
|
+
<li>Can Receive Updates over BLE and OpenAPI</li>
|
|
92
|
+
</ul>
|
|
93
|
+
</li>
|
|
94
|
+
</ul>
|
|
95
|
+
</li>
|
|
96
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-meter">SwitchBot Meter</a></li>
|
|
97
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-meter-plus">SwitchBot Meter Plus (US)</a></li>
|
|
98
|
+
<li><a href="https://www.switchbot.jp/products/switchbot-meter-plus">SwitchBot Meter Plus (JP)</a></li>
|
|
99
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-indoor-outdoor-thermo-hygrometer">SwitchBot Indoor/Outdoor Thermo-Hygrometer</a>
|
|
100
|
+
<ul>
|
|
101
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
102
|
+
<li>If using OpenAPI:
|
|
103
|
+
<ul>
|
|
104
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
105
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
106
|
+
</ul>
|
|
107
|
+
</li>
|
|
108
|
+
<li>If using Bluetooth Low Energy (BLE) only:
|
|
109
|
+
<ul>
|
|
110
|
+
<li>Must supply <code>deviceId</code> & <code>deviceName</code> to Device Config</li>
|
|
111
|
+
<li>Check <code>Enable Bluetooth Low Energy (BLE) Connection</code> on Device Config</li>
|
|
112
|
+
</ul>
|
|
113
|
+
</li>
|
|
114
|
+
</ul>
|
|
115
|
+
</li>
|
|
116
|
+
<li><a href="https://www.switch-bot.com/products/motion-sensor">SwitchBot Motion Sensor</a>
|
|
117
|
+
<ul>
|
|
118
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
119
|
+
<li>If using OpenAPI:
|
|
120
|
+
<ul>
|
|
121
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
122
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
123
|
+
</ul>
|
|
124
|
+
</li>
|
|
125
|
+
<li>If using Bluetooth Low Energy (BLE) only:
|
|
126
|
+
<ul>
|
|
127
|
+
<li>Must supply <code>deviceId</code> & <code>deviceName</code> to Device Config</li>
|
|
128
|
+
<li>Check <code>Enable Bluetooth Low Energy (BLE) Connection</code> on Device Config</li>
|
|
129
|
+
</ul>
|
|
130
|
+
</li>
|
|
131
|
+
</ul>
|
|
132
|
+
</li>
|
|
133
|
+
<li><a href="https://www.switch-bot.com/products/contact-sensor">SwitchBot Contact Sensor</a>
|
|
134
|
+
<ul>
|
|
135
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
136
|
+
<li>If using OpenAPI:
|
|
137
|
+
<ul>
|
|
138
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
139
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
140
|
+
</ul>
|
|
141
|
+
</li>
|
|
142
|
+
<li>If using Bluetooth Low Energy (BLE) only:
|
|
143
|
+
<ul>
|
|
144
|
+
<li>Must supply <code>deviceId</code> & <code>deviceName</code> to Device Config</li>
|
|
145
|
+
<li>Check <code>Enable Bluetooth Low Energy (BLE) Connection</code> on Device Config</li>
|
|
146
|
+
</ul>
|
|
147
|
+
</li>
|
|
148
|
+
</ul>
|
|
149
|
+
</li>
|
|
150
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-curtain">SwitchBot Curtain</a></li>
|
|
151
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-curtain-3">SwitchBot Curtain 3</a>
|
|
152
|
+
<ul>
|
|
153
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
154
|
+
<li>If using OpenAPI:
|
|
155
|
+
<ul>
|
|
156
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
157
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
158
|
+
</ul>
|
|
159
|
+
</li>
|
|
160
|
+
<li>If using Bluetooth Low Energy (BLE) only:
|
|
161
|
+
<ul>
|
|
162
|
+
<li>Must supply <code>deviceId</code> & <code>deviceName</code> to Device Config</li>
|
|
163
|
+
<li>Check <code>Enable Bluetooth Low Energy (BLE) Connection</code> on Device Config</li>
|
|
164
|
+
</ul>
|
|
165
|
+
</li>
|
|
166
|
+
</ul>
|
|
167
|
+
</li>
|
|
168
|
+
<li><a href="https://us.switch-bot.com/products/switchbot-blind-tilt">SwitchBot Blind Tilt</a>
|
|
169
|
+
<ul>
|
|
170
|
+
<li>Supports OpenAPI & partial Bluetooth Low Energy (BLE) Connections</li>
|
|
171
|
+
<li>If using OpenAPI:
|
|
172
|
+
<ul>
|
|
173
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
174
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
175
|
+
</ul>
|
|
176
|
+
</li>
|
|
177
|
+
</ul>
|
|
178
|
+
</li>
|
|
179
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-color-bulb">SwitchBot Bulb</a></li>
|
|
180
|
+
<li><a href="https://www.switchbot.jp/collections/all/products/switchbot-ceiling-light">SwitchBot Ceiling Light</a></li>
|
|
181
|
+
<li><a href="https://www.switchbot.jp/collections/all/products/switchbot-ceiling-light">SwitchBot Ceiling Light Pro</a></li>
|
|
182
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-light-strip">SwitchBot Light Strip</a>
|
|
183
|
+
<ul>
|
|
184
|
+
<li>Supports OpenAPI & partial Bluetooth Low Energy (BLE) Connections</li>
|
|
185
|
+
<li>If using OpenAPI:
|
|
186
|
+
<ul>
|
|
187
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
188
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
189
|
+
</ul>
|
|
190
|
+
</li>
|
|
191
|
+
</ul>
|
|
192
|
+
</li>
|
|
193
|
+
<li><a href="https://us.switch-bot.com/products/switchbot-lock">SwitchBot Lock</a></li>
|
|
194
|
+
<li><a href="https://www.switchbot.jp/products/switchbot-lock-pro">SwitchBot Lock Pro</a>
|
|
195
|
+
<ul>
|
|
196
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
197
|
+
<li>If using OpenAPI:
|
|
198
|
+
<ul>
|
|
199
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
200
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
201
|
+
</ul>
|
|
202
|
+
</li>
|
|
203
|
+
</ul>
|
|
204
|
+
</li>
|
|
205
|
+
<li>US: <a href="https://www.switch-bot.com/products/switchbot-mini-robot-vacuum-k10">SwitchBot Mini Robot Vacuum K10+</a></li>
|
|
206
|
+
<li>US: <a href="https://www.switch-bot.com/products/switchbot-floor-cleaning-robot-s10">SwitchBot Floor Cleaning Robot S10</a></li>
|
|
207
|
+
<li>JP: <a href="https://www.switchbot.jp/products/switchbot-robot-vacuum-cleaner">SwitchBot Robot Vacuum Cleaner S1</a></li>
|
|
208
|
+
<li>JP: <a href="https://www.switchbot.jp/products/switchbot-robot-vacuum-cleaner">SwitchBot Robot Vacuum Cleaner S1 Plus</a>
|
|
209
|
+
<ul>
|
|
210
|
+
<li>Supports OpenAPI Connection Only</li>
|
|
211
|
+
</ul>
|
|
212
|
+
</li>
|
|
213
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-plug">SwitchBot Plug</a></li>
|
|
214
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-plug-mini">SwitchBot Plug Mini (US)</a></li>
|
|
215
|
+
<li><a href="https://www.switchbot.jp/products/switchbot-plug-mini">SwitchBot Plug Mini (JP)</a>
|
|
216
|
+
<ul>
|
|
217
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
218
|
+
<li>If using OpenAPI:
|
|
219
|
+
<ul>
|
|
220
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
221
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
222
|
+
</ul>
|
|
223
|
+
</li>
|
|
224
|
+
</ul>
|
|
225
|
+
</li>
|
|
226
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-bot">SwitchBot Bot</a>
|
|
227
|
+
<ul>
|
|
228
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections</li>
|
|
229
|
+
<li>If using OpenAPI:
|
|
230
|
+
<ul>
|
|
231
|
+
<li><a href="https://www.switch-bot.com/products/switchbot-hub-mini">SwitchBot Hub Mini</a> or <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> Required</li>
|
|
232
|
+
<li>Enable Cloud Services for Device on SwitchBot App</li>
|
|
233
|
+
<li>You must set your Bot's Device ID for either Press Mode or Switch Mode in Plugin Config (SwitchBot Device Settings > Bot Settings)
|
|
234
|
+
<ul>
|
|
235
|
+
<li>Press Mode - Turns on then instantly turn it off</li>
|
|
236
|
+
<li>Switch Mode - Turns on and keep it on until it is turned off
|
|
237
|
+
<ul>
|
|
238
|
+
<li>This can get out of sync, since API doesn't give me a status</li>
|
|
239
|
+
<li>To Correct you must go into the SwitchBot App and correct the status of either <code>On</code> or <code>Off</code></li>
|
|
240
|
+
</ul>
|
|
241
|
+
</li>
|
|
242
|
+
</ul>
|
|
243
|
+
</li>
|
|
244
|
+
</ul>
|
|
245
|
+
</li>
|
|
246
|
+
<li>If using Bluetooth Low Energy (BLE) only:
|
|
247
|
+
<ul>
|
|
248
|
+
<li>Must supply <code>deviceId</code> & <code>deviceName</code> to Device Config</li>
|
|
249
|
+
<li>Check <code>Enable Bluetooth Low Energy (BLE) Connection</code> on Device Config</li>
|
|
250
|
+
</ul>
|
|
251
|
+
</li>
|
|
252
|
+
</ul>
|
|
253
|
+
</li>
|
|
254
|
+
<li><a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a>
|
|
255
|
+
<ul>
|
|
256
|
+
<li>Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
|
|
257
|
+
<ul>
|
|
258
|
+
<li>Enables Humidity, Temperature, and Light Sensor</li>
|
|
259
|
+
</ul>
|
|
260
|
+
</li>
|
|
261
|
+
</ul>
|
|
262
|
+
</li>
|
|
263
|
+
<li><a href="https://us.switch-bot.com/products/switchbot-battery-circulator-fan">SwitchBot Battery Circulator Fan</a>
|
|
264
|
+
<ul>
|
|
265
|
+
<li>Supports OpenAPI Connection Only</li>
|
|
266
|
+
</ul>
|
|
267
|
+
</li>
|
|
268
|
+
<li><a href="https://us.switch-bot.com/products/switchbot-water-leak-detector">SwitchBot Water Leak Detector</a>
|
|
269
|
+
<ul>
|
|
270
|
+
<li>Supports OpenAPI Connection Only</li>
|
|
271
|
+
</ul>
|
|
272
|
+
</li>
|
|
273
|
+
</ul>
|
|
274
|
+
<a id="md:supported-ir-devices" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Supported IR Devices<a href="#md:supported-ir-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><a id="md:all-ir-devices-require-switchbot-hub-2-or-hub-mini" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><em>(All IR Devices require <a href="https://us.switch-bot.com/products/switchbot-hub-2">SwitchBot Hub 2</a> or <a href="https://www.switch-bot.com/products/switchbot-hub-mini">Hub Mini</a>)</em><a href="#md:all-ir-devices-require-switchbot-hub-2-or-hub-mini" 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>
|
|
275
|
+
<li>TV
|
|
276
|
+
<ul>
|
|
277
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
278
|
+
<li>Optional Disable Sending Power Command</li>
|
|
279
|
+
</ul>
|
|
280
|
+
</li>
|
|
281
|
+
<li>Projector (Displayed as TV)
|
|
282
|
+
<ul>
|
|
283
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
284
|
+
</ul>
|
|
285
|
+
</li>
|
|
286
|
+
<li>Set Top Box (Displayed as Set Top Box)
|
|
287
|
+
<ul>
|
|
288
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
289
|
+
</ul>
|
|
290
|
+
</li>
|
|
291
|
+
<li>DVD (Displayed as Set Top Box)
|
|
292
|
+
<ul>
|
|
293
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
294
|
+
</ul>
|
|
295
|
+
</li>
|
|
296
|
+
<li>Streamer (Displayed as Streaming Stick)
|
|
297
|
+
<ul>
|
|
298
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
299
|
+
</ul>
|
|
300
|
+
</li>
|
|
301
|
+
<li>Speaker (Displayed as Speaker)
|
|
302
|
+
<ul>
|
|
303
|
+
<li>Allows for On/Off and Volume Controls</li>
|
|
304
|
+
</ul>
|
|
305
|
+
</li>
|
|
306
|
+
<li>Fans
|
|
307
|
+
<ul>
|
|
308
|
+
<li>Allows for On/Off Controls</li>
|
|
309
|
+
<li>Optional Rotation Speed</li>
|
|
310
|
+
<li>Optional Swing Mode</li>
|
|
311
|
+
</ul>
|
|
312
|
+
</li>
|
|
313
|
+
<li>Lights
|
|
314
|
+
<ul>
|
|
315
|
+
<li>Allows for On/Off Controls</li>
|
|
316
|
+
</ul>
|
|
317
|
+
</li>
|
|
318
|
+
<li>Air Purifiers
|
|
319
|
+
<ul>
|
|
320
|
+
<li>Allows for On/Off Controls</li>
|
|
321
|
+
</ul>
|
|
322
|
+
</li>
|
|
323
|
+
<li>Air Conditioners
|
|
324
|
+
<ul>
|
|
325
|
+
<li>Allows for On/Off, Tempeture, and Mode Controls</li>
|
|
326
|
+
<li>Optional Disable Auto Mode</li>
|
|
327
|
+
</ul>
|
|
328
|
+
</li>
|
|
329
|
+
<li>Cameras
|
|
330
|
+
<ul>
|
|
331
|
+
<li>Allows for On/Off Controls</li>
|
|
332
|
+
</ul>
|
|
333
|
+
</li>
|
|
334
|
+
<li>Vacuum Cleaners
|
|
335
|
+
<ul>
|
|
336
|
+
<li>Allows for On/Off Controls</li>
|
|
337
|
+
</ul>
|
|
338
|
+
</li>
|
|
339
|
+
<li>Water Heaters
|
|
340
|
+
<ul>
|
|
341
|
+
<li>Allows for On/Off Controls</li>
|
|
342
|
+
</ul>
|
|
343
|
+
</li>
|
|
344
|
+
<li>Others
|
|
345
|
+
<ul>
|
|
346
|
+
<li>Option to Display as differenet Device Type
|
|
347
|
+
<ul>
|
|
348
|
+
<li>Supports Fan Device Type</li>
|
|
349
|
+
</ul>
|
|
350
|
+
</li>
|
|
351
|
+
<li>Allows for On/Off Controls</li>
|
|
352
|
+
</ul>
|
|
353
|
+
</li>
|
|
354
|
+
</ul>
|
|
355
|
+
<a id="md:switchbot-apis" class="tsd-anchor"></a><h2 class="tsd-anchor-link">SwitchBot APIs<a href="#md:switchbot-apis" 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>
|
|
356
|
+
<li><a href="https://github.com/OpenWonderLabs/SwitchBotAPI">OpenWonderLabs/SwitchBotAPI</a></li>
|
|
357
|
+
<li><a href="https://github.com/OpenWonderLabs/SwitchBotAPI-BLE">OpenWonderLabs/SwitchBotAPI-BLE</a>
|
|
358
|
+
<ul>
|
|
359
|
+
<li><a href="https://github.com/OpenWonderLabs/node-switchbot">OpenWonderLabs/node-switchbot</a></li>
|
|
360
|
+
</ul>
|
|
361
|
+
</li>
|
|
362
|
+
</ul>
|
|
363
|
+
<a id="md:community" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Community<a href="#md:community" 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>
|
|
364
|
+
<li><a href="https://www.switch-bot.com/">SwitchBot (Official website)</a></li>
|
|
365
|
+
<li><a href="https://www.facebook.com/SwitchBotRobot/">Facebook @SwitchBotRobot</a></li>
|
|
366
|
+
<li><a href="https://twitter.com/switchbot">Twitter @SwitchBot</a></li>
|
|
367
|
+
</ul>
|
|
368
|
+
</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:switchbothomebridge-switchbot"><span>@switchbot/homebridge-<wbr/>switchbot</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><a href="#md:configuration"><span>Configuration</span></a></li><li><ul><li><a href="#md:if-using-openapi-connection"><span>If using <wbr/>OpenAPI <wbr/>Connection</span></a></li><li><a href="#md:if-using-ble-connection"><span>If using BLE <wbr/>Connection</span></a></li></ul></li><li><a href="#md:troubleshooting"><span>Troubleshooting</span></a></li><li><ul><li><a href="#md:if-using-linux--raspberry-pi-os"><span>If using <wbr/>Linux / <wbr/>Raspberry <wbr/>Pi OS</span></a></li></ul></li><li><a href="#md:supported-switchbot-devices"><span>Supported <wbr/>Switch<wbr/>Bot <wbr/>Devices</span></a></li><li><a href="#md:supported-ir-devices"><span>Supported IR <wbr/>Devices</span></a></li><li><ul><li><a href="#md:all-ir-devices-require-switchbot-hub-2-or-hub-mini"><span>(<wbr/>All IR <wbr/>Devices require <wbr/>Switch<wbr/>Bot <wbr/>Hub 2 or <wbr/>Hub <wbr/>Mini)</span></a></li></ul></li><li><a href="#md:switchbot-apis"><span>Switch<wbr/>Bot APIs</span></a></li><li><a href="#md:community"><span>Community</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>@switchbot/homebridge-switchbot</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>
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@switchbot/homebridge-switchbot</title><meta name="description" content="Documentation for @switchbot/homebridge-switchbot"/><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">@switchbot/homebridge-switchbot</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"><h2>@switchbot/homebridge-switchbot</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/default.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>default</span></a>
|
|
2
|
+
</div></section></section></section></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></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>@switchbot/homebridge-switchbot</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>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"displayName": "SwitchBot",
|
|
3
3
|
"name": "@switchbot/homebridge-switchbot",
|
|
4
|
-
"version": "3.6.1-beta.
|
|
4
|
+
"version": "3.6.1-beta.18",
|
|
5
5
|
"description": "The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "SwitchBot",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
},
|
|
27
27
|
"engineStrict": true,
|
|
28
28
|
"engines": {
|
|
29
|
-
"homebridge": "^1.8.4-
|
|
29
|
+
"homebridge": "^1.8.4 || ^2.0.0-alpha.0",
|
|
30
30
|
"node": "^18 || ^20 || ^22"
|
|
31
31
|
},
|
|
32
32
|
"main": "dist/index.js",
|
|
@@ -40,7 +40,9 @@
|
|
|
40
40
|
"prepublishOnly": "npm run lint && npm run build && npm run plugin-ui ",
|
|
41
41
|
"postpublish": "npm run clean",
|
|
42
42
|
"clean": "rimraf ./dist",
|
|
43
|
-
"test": "npm run lint"
|
|
43
|
+
"test": "npm run lint",
|
|
44
|
+
"docs": "typedoc",
|
|
45
|
+
"lint-docs": "typedoc --emit none --treatWarningsAsErrors"
|
|
44
46
|
},
|
|
45
47
|
"funding": [
|
|
46
48
|
{
|
|
@@ -85,7 +87,7 @@
|
|
|
85
87
|
"undici": "^6.19.2"
|
|
86
88
|
},
|
|
87
89
|
"optionalDependencies": {
|
|
88
|
-
"node-switchbot": "2.
|
|
90
|
+
"node-switchbot": "2.3.0"
|
|
89
91
|
},
|
|
90
92
|
"devDependencies": {
|
|
91
93
|
"@eslint/js": "^9.7.0",
|
|
@@ -94,12 +96,13 @@
|
|
|
94
96
|
"@types/node": "^20.14.11",
|
|
95
97
|
"eslint": "^9.7.0",
|
|
96
98
|
"globals": "^15.8.0",
|
|
97
|
-
"homebridge": "^1.8.4
|
|
99
|
+
"homebridge": "^1.8.4",
|
|
98
100
|
"homebridge-config-ui-x": "4.56.4",
|
|
99
101
|
"nodemon": "^3.1.4",
|
|
100
102
|
"npm-check-updates": "^16.14.20",
|
|
101
103
|
"rimraf": "^6.0.1",
|
|
102
104
|
"ts-node": "^10.9.2",
|
|
105
|
+
"typedoc": "^0.26.5",
|
|
103
106
|
"typescript": "^5.5.3",
|
|
104
107
|
"typescript-eslint": "^8.0.0-alpha.44"
|
|
105
108
|
}
|
package/typedoc.json
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
{
|
|
2
|
+
"out": "docs",
|
|
3
|
+
"exclude": ["src/**/*.spec.ts"],
|
|
4
|
+
"entryPoints": [
|
|
5
|
+
"src/index.ts"
|
|
6
|
+
],
|
|
7
|
+
"excludePrivate": true,
|
|
8
|
+
"excludeProtected": true,
|
|
9
|
+
"excludeExternals": true,
|
|
10
|
+
"hideGenerator": true,
|
|
11
|
+
"includeVersion": false,
|
|
12
|
+
"validation": {
|
|
13
|
+
"invalidLink": true,
|
|
14
|
+
"notExported": false
|
|
15
|
+
},
|
|
16
|
+
"inlineTags": ["@link", "@see"]
|
|
17
|
+
}
|