UNPKG

node-switchbot

Version:

The node-switchbot is a Node.js module which allows you to control your Switchbot Devices through Bluetooth (BLE).

2 lines (1 loc) 10.2 kB
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>node-switchbot</title><meta name="description" content="Documentation for node-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><script async src="assets/hierarchy.js" id="tsd-hierarchy-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"><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" aria-hidden="true"><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">node-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" aria-hidden="true"><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>node-switchbot</h1></div><h2>Hierarchy Summary</h2><ul class="tsd-full-hierarchy"><li data-refl="2717"><a id="device" class="tsd-anchor"></a><a href="interfaces/device.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>device</a><ul><li data-refl="2837"><a id="deviceStatus" class="tsd-anchor"></a><a href="interfaces/deviceStatus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Interface"><use href="assets/icons.svg#icon-256"></use></svg>deviceStatus</a></li></ul></li></ul><ul class="tsd-full-hierarchy"><li data-refl="216"><a id="SwitchbotDevice" class="tsd-anchor"></a><a href="classes/SwitchbotDevice.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>SwitchbotDevice</a><ul><li data-refl="336"><a id="WoBlindTilt" class="tsd-anchor"></a><a href="classes/WoBlindTilt.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoBlindTilt</a></li><li data-refl="428"><a id="WoBulb" class="tsd-anchor"></a><a href="classes/WoBulb.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoBulb</a></li><li data-refl="518"><a id="WoCeilingLight" class="tsd-anchor"></a><a href="classes/WoCeilingLight.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoCeilingLight</a></li><li data-refl="615"><a id="WoContact" class="tsd-anchor"></a><a href="classes/WoContact.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoContact</a></li><li data-refl="680"><a id="WoCurtain" class="tsd-anchor"></a><a href="classes/WoCurtain.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoCurtain</a></li><li data-refl="762"><a id="WoHand" class="tsd-anchor"></a><a href="classes/WoHand.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoHand</a></li><li data-refl="840"><a id="WoHub2" class="tsd-anchor"></a><a href="classes/WoHub2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoHub2</a></li><li data-refl="905"><a id="WoHumi" class="tsd-anchor"></a><a href="classes/WoHumi.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoHumi</a></li><li data-refl="988"><a id="WoHumi2" class="tsd-anchor"></a><a href="classes/WoHumi2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoHumi2</a></li><li data-refl="1071"><a id="WoIOSensorTH" class="tsd-anchor"></a><a href="classes/WoIOSensorTH.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoIOSensorTH</a></li><li data-refl="1137"><a id="WoKeypad" class="tsd-anchor"></a><a href="classes/WoKeypad.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoKeypad</a></li><li data-refl="1203"><a id="WoLeak" class="tsd-anchor"></a><a href="classes/WoLeak.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoLeak</a></li><li data-refl="1269"><a id="WoPlugMiniJP" class="tsd-anchor"></a><a href="classes/WoPlugMiniJP.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoPlugMiniJP</a></li><li data-refl="1348"><a id="WoPlugMiniUS" class="tsd-anchor"></a><a href="classes/WoPlugMiniUS.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoPlugMiniUS</a></li><li data-refl="1427"><a id="WoPresence" class="tsd-anchor"></a><a href="classes/WoPresence.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoPresence</a></li><li data-refl="1492"><a id="WoRelaySwitch1" class="tsd-anchor"></a><a href="classes/WoRelaySwitch1.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoRelaySwitch1</a></li><li data-refl="1565"><a id="WoRelaySwitch1PM" class="tsd-anchor"></a><a href="classes/WoRelaySwitch1PM.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoRelaySwitch1PM</a></li><li data-refl="1638"><a id="WoRemote" class="tsd-anchor"></a><a href="classes/WoRemote.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoRemote</a></li><li data-refl="1703"><a id="WoSensorTH" class="tsd-anchor"></a><a href="classes/WoSensorTH.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSensorTH</a></li><li data-refl="1768"><a id="WoSensorTHPlus" class="tsd-anchor"></a><a href="classes/WoSensorTHPlus.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSensorTHPlus</a></li><li data-refl="1833"><a id="WoSensorTHPro" class="tsd-anchor"></a><a href="classes/WoSensorTHPro.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSensorTHPro</a></li><li data-refl="1898"><a id="WoSensorTHProCO2" class="tsd-anchor"></a><a href="classes/WoSensorTHProCO2.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSensorTHProCO2</a></li><li data-refl="1964"><a id="WoSmartLock" class="tsd-anchor"></a><a href="classes/WoSmartLock.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSmartLock</a></li><li data-refl="2071"><a id="WoSmartLockPro" class="tsd-anchor"></a><a href="classes/WoSmartLockPro.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoSmartLockPro</a></li><li data-refl="2178"><a id="WoStrip" class="tsd-anchor"></a><a href="classes/WoStrip.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Class"><use href="assets/icons.svg#icon-128"></use></svg>WoStrip</a></li></ul></li></ul></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" aria-hidden="true"><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">node-switchbot</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>