npm - @switchbot/homebridge-switchbot - Versions diffs - 2.14.0-beta.3 → 2.14.1-beta.0 - Mend

@switchbot/homebridge-switchbot 2.14.0-beta.3 → 2.14.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 (11) hide show

package/CHANGELOG.md +9 -0
package/config.schema.json +1 -0
package/dist/homebridge-ui/server.d.ts +2 -0
package/dist/homebridge-ui/server.d.ts.map +1 -0
package/dist/homebridge-ui/server.js +49 -0
package/dist/homebridge-ui/server.js.map +1 -0
package/package.json +12 -10
package/src/homebridge-ui/public/index.html +240 -0
package/src/homebridge-ui/server.ts +48 -0
package/homebridge-ui/server.js +0 -50
/package/{homebridge-ui → dist/homebridge-ui}/public/index.html +0 -0

package/CHANGELOG.md CHANGED Viewed

@@ -2,6 +2,15 @@
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
+## [2.14.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v2.14.0) (2024-1-6)
+### What's Changed
+- Added Curtain Hold Command to OpenAPI.
+  - This will only Works in 3rd Party Home App, Like [Eve](https://apps.apple.com/us/app/eve-for-homekit/id917695792) or [Home+ 5](https://apps.apple.com/us/app/home-5/id995994352)
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.13.2...v2.14.0
 ## [2.13.2](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v2.13.2) (2024-1-5)
 ### What's Changed

package/config.schema.json CHANGED Viewed

@@ -3,6 +3,7 @@
   "pluginType": "platform",
   "singular": true,
   "customUi": true,
+  "customUiPath": "./dist/homebridge-ui",
   "headerDisplay": "<p align='center'><img width='100px' src='https://user-images.githubusercontent.com/9875439/102681754-ac2eb800-4189-11eb-8e17-7c47c804484b.png'></p>\n\nThe **SwitchBot** plugin allows you to control SwitchBot Devices. \n\nTo get started link your SwitchBot account.\n\n1. Download SwitchBot App on App Store or Google Play Store.\n\n2. Register a SwitchBot account and log in into your account.\n\n3. Generate an Open Token within the App.\n\n4. Input your `Open Token` into the paramter below.",
   "footerDisplay": "Please raise any issues on our [project page](https://github.com/OpenWonderLabs/homebridge-switchbot/issues).\n\nIf you would like to have other SwitchBot Devices added to this plugin fill out [Feature Request Form](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/new?assignees=&labels=&template=feature_request.md).\n\n[SwitchBot Website](https://www.switch-bot.com)",
   "schema": {

package/dist/homebridge-ui/server.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=server.d.ts.map

package/dist/homebridge-ui/server.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/homebridge-ui/server.ts"],"names":[],"mappings":""}

package/dist/homebridge-ui/server.js ADDED Viewed

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const plugin_ui_utils_1 = require("@homebridge/plugin-ui-utils");
+const fs_1 = __importDefault(require("fs"));
+class PluginUiServer extends plugin_ui_utils_1.HomebridgePluginUiServer {
+    constructor() {
+        super();
+        /*
+          A native method getCachedAccessories() was introduced in config-ui-x v4.37.0
+          The following is for users who have a lower version of config-ui-x
+        */
+        this.onRequest('getCachedAccessories', () => {
+            try {
+                const plugin = 'homebridge-switchbot';
+                const devicesToReturn = [];
+                // The path and file of the cached accessories
+                const accFile = this.homebridgeStoragePath + '/accessories/cachedAccessories';
+                // Check the file exists
+                if (fs_1.default.existsSync(accFile)) {
+                    // read the cached accessories file
+                    const cachedAccessories = JSON.parse(fs_1.default.readFileSync(accFile, 'utf8'));
+                    cachedAccessories.forEach((accessory) => {
+                        // Check the accessory is from this plugin
+                        if (accessory.plugin === plugin) {
+                            // Add the cached accessory to the array
+                            devicesToReturn.push(accessory.accessory);
+                        }
+                    });
+                }
+                // Return the array
+                return devicesToReturn;
+            }
+            catch (err) {
+                // Just return an empty accessory list in case of any errors
+                return [];
+            }
+        });
+        this.ready();
+    }
+}
+function startPluginUiServer() {
+    return new PluginUiServer();
+}
+startPluginUiServer();
+//# sourceMappingURL=server.js.map

package/dist/homebridge-ui/server.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/homebridge-ui/server.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,iEAAuE;AACvE,4CAAoB;AAEpB,MAAM,cAAe,SAAQ,0CAAwB;IACnD;QACE,KAAK,EAAE,CAAC;QACR;;;UAGE;QACF,IAAI,CAAC,SAAS,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC1C,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,sBAAsB,CAAC;gBACtC,MAAM,eAAe,GAAG,EAAE,CAAC;gBAE3B,8CAA8C;gBAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,GAAG,gCAAgC,CAAC;gBAE9E,wBAAwB;gBACxB,IAAI,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC3B,mCAAmC;oBACnC,MAAM,iBAAiB,GAAU,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;oBAE9E,iBAAiB,CAAC,OAAO,CAAC,CAAC,SAAc,EAAE,EAAE;wBAC3C,0CAA0C;wBAC1C,IAAI,SAAS,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;4BAChC,wCAAwC;4BACxC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,SAAkB,CAAC,CAAC;wBACrD,CAAC;oBACH,CAAC,CAAC,CAAC;gBACL,CAAC;gBACD,mBAAmB;gBACnB,OAAO,eAAe,CAAC;YACzB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4DAA4D;gBAC5D,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;CACF;AAED,SAAS,mBAAmB;IAC1B,OAAO,IAAI,cAAc,EAAE,CAAC;AAC9B,CAAC;AAED,mBAAmB,EAAE,CAAC"}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "displayName": "SwitchBot",
   "name": "@switchbot/homebridge-switchbot",
-  "version": "2.14.0-beta.3",
+  "version": "2.14.1-beta.0",
   "description": "The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.",
   "author": "SwitchBot <support@wondertechlabs.com> (https://github.com/SwitchBot)",
   "license": "ISC",
@@ -21,11 +21,13 @@
   "scripts": {
     "check": "npm install && npm outdated",
     "update": "ncu -u && npm update && npm install",
-    "updateDependencies": "npm run check && npm run update",
+    "update dependencies": "npm run check && npm run update",
     "lint": "eslint src/**.ts",
-    "watch": "npm run build && npm link && nodemon",
+    "jlint": "eslint homebridge-ui/public/**.mjs",
+    "watch": "npm run build && npm run plugin-ui && npm link && nodemon",
+    "plugin-ui": "rsync ./src/homebridge-ui/public/index.html ./dist/homebridge-ui/public/",
     "build": "rimraf ./dist && tsc",
-    "prepublishOnly": "npm run lint && npm run build",
+    "prepublishOnly": "npm run lint && npm run build && npm run plugin-ui ",
     "postpublish": "npm run clean",
     "clean": "rimraf ./dist",
     "test": "eslint src/**.ts"
@@ -57,12 +59,12 @@
     "ir"
   ],
   "dependencies": {
-    "@homebridge/plugin-ui-utils": "^1.0.0",
+    "@homebridge/plugin-ui-utils": "^1.0.1",
     "async-mqtt": "^2.6.3",
     "fakegato-history": "^0.6.4",
     "homebridge-lib": "^6.7.3",
     "rxjs": "^7.8.1",
-    "undici": "^6.2.1"
+    "undici": "^6.4.0"
   },
   "optionalDependencies": {
     "node-switchbot": "^1.10.0",
@@ -70,12 +72,12 @@
     "@abandonware/bluetooth-hci-socket": "^0.5.3-10"
   },
   "devDependencies": {
-    "@types/node": "^20.10.6",
-    "@typescript-eslint/eslint-plugin": "^6.17.0",
-    "@typescript-eslint/parser": "^6.17.0",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
     "eslint": "^8.56.0",
     "homebridge": "^1.7.0",
-    "nodemon": "^3.0.2",
+    "nodemon": "^3.0.3",
     "npm-check-updates": "^16.14.12",
     "rimraf": "^5.0.5",
     "ts-node": "^10.9.2",

package/src/homebridge-ui/public/index.html ADDED Viewed

@@ -0,0 +1,240 @@
+<p class="text-center">
+  <img
+    src="https://raw.githubusercontent.com/OpenWonderLabs/homebridge-switchbot/latest/branding/Homebridge_x_SwitchBot.svg"
+    alt="homebridge-switchbot logo"
+    style="width: 50%" />
+</p>
+<div id="pageIntro" style="display: none">
+  <p class="lead text-center">Thank you for installing <strong>homebridge-switchbot</strong></p>
+  <p class="lead text-center">Before continuing:</p>
+  <ol>
+    <li class="mb-3">
+      Download the SwitchBot App from either the
+      <a href="https://apps.apple.com/us/app/switchbot/id1087374760" target="_blank" rel="noreferrer noopener">App Store</a> or the
+      <a href="https://play.google.com/store/apps/details?id=com.theswitchbot.switchbot&hl=en_US&gl=US" target="_blank" rel="noreferrer noopener"
+        >Play Store</a
+      >.
+    </li>
+    <li class="mb-3">Select <strong>Profile</strong>.</li>
+    <li class="mb-3">Select <strong>Preferences</strong>.</li>
+    <li class="mb-3">Tap the <strong>App version</strong> 10 times, this will enable Developer Options.</li>
+    <li class="mb-3">Select <strong>Developer Options</strong>.</li>
+    <li class="mb-3">Copy your token by hitting <strong>Copy to Clipboard</strong>.</li>
+    <li class="mb-3">Paste the Token into the Token parameter on the next page.</li>
+  </ol>
+  <div class="text-center">
+    <button type="button" class="btn btn-primary" id="introLink">Continue &rarr;</button>
+  </div>
+</div>
+<div id="menuWrapper" class="btn-group w-100 mb-0" role="group" aria-label="UI Menu" style="display: none">
+  <button type="button" class="btn btn-primary" id="menuSettings">Settings</button>
+  <button type="button" class="btn btn-primary" id="menuDevices">Devices</button>
+  <button type="button" class="btn btn-primary mr-0" id="menuHome">Support</button>
+</div>
+<div id="disabledBanner" class="alert alert-secondary mb-0 mt-3" role="alert" style="display: none">
+  Plugin is currently disabled
+  <button id="disabledEnable" type="button" class="btn btn-link p-0 m-0 float-right">Enable</button>
+</div>
+<div id="pageDevices" class="mt-4" style="display: none">
+  <div id="deviceInfo">
+    <form>
+      <div class="form-group">
+        <select class="form-control" id="deviceSelect"></select>
+      </div>
+    </form>
+    <table class="table w-100" id="deviceTable" style="display: none">
+      <thead>
+        <tr class="table-active">
+          <th scope="col" style="width: 40%">Device Name</th>
+          <th scope="col" style="width: 60%" id="displayName"></th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <th scope="row">Device ID</th>
+          <td id="deviceID"></td>
+        </tr>
+        <tr>
+          <th scope="row">Model</th>
+          <td id="model"></td>
+        </tr>
+        <tr>
+          <th scope="row">Firmware Version</th>
+          <td id="firmwareRevision"></td>
+        </tr>
+        <tr>
+          <th scope="row">Device Type</th>
+          <td id="deviceType"></td>
+        </tr>
+        <tr>
+          <th scope="row">Connection Type</th>
+          <td id="connectionType"></td>
+        </tr>
+      </tbody>
+    </table>
+    <p class="text-center">External Accessories Will Not Display Here.</p>
+  </div>
+</div>
+<div id="pageSupport" class="mt-4" style="display: none">
+  <p class="text-center lead">Thank you for using <strong>homebridge-switchbot</strong></p>
+  <p class="text-center">The links below will take you to our GitHub wiki</p>
+  <h5>Setup</h5>
+  <ul>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki" target="_blank">Wiki Home</a>
+    </li>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Configuration" target="_blank">Configuration</a>
+    </li>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Beta-Version" target="_blank">Beta Version</a>
+    </li>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Node-Version" target="_blank">Node Version</a>
+    </li>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Uninstallation" target="_blank">Uninstallation</a>
+    </li>
+  </ul>
+  <h5>Features</h5>
+  <ul>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/wiki/Supported-Devices" target="_blank">Supported Devices</a>
+    </li>
+  </ul>
+  <h5>Help/About</h5>
+  <ul>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/issues/new/choose" target="_blank">Support Request</a>
+    </li>
+    <li>
+      <a href="https://github.com/OpenWonderLabs/homebridge-switchbot/blob/latest/CHANGELOG.md" target="_blank">Changelog</a>
+    </li>
+  </ul>
+</div>
+<script>
+  (async () => {
+    try {
+      const currentConfig = await homebridge.getPluginConfig();
+      showIntro = () => {
+        const introLink = document.getElementById('introLink');
+        introLink.addEventListener('click', () => {
+          homebridge.showSpinner();
+          document.getElementById('pageIntro').style.display = 'none';
+          document.getElementById('menuWrapper').style.display = 'inline-flex';
+          showSettings();
+          homebridge.hideSpinner();
+        });
+        document.getElementById('pageIntro').style.display = 'block';
+      };
+      showDevices = async () => {
+        homebridge.showSpinner();
+        homebridge.hideSchemaForm();
+        document.getElementById('menuHome').classList.remove('btn-elegant');
+        document.getElementById('menuHome').classList.add('btn-primary');
+        document.getElementById('menuDevices').classList.add('btn-elegant');
+        document.getElementById('menuDevices').classList.remove('btn-primary');
+        document.getElementById('menuSettings').classList.remove('btn-elegant');
+        document.getElementById('menuSettings').classList.add('btn-primary');
+        document.getElementById('pageSupport').style.display = 'none';
+        document.getElementById('pageDevices').style.display = 'block';
+        const cachedAccessories =
+          typeof homebridge.getCachedAccessories === 'function'
+            ? await homebridge.getCachedAccessories()
+            : await homebridge.request('/getCachedAccessories');
+        if (cachedAccessories.length > 0) {
+          cachedAccessories.sort((a, b) => {
+            return a.displayName.toLowerCase() > b.displayName.toLowerCase() ? 1 : b.displayName.toLowerCase() > a.displayName.toLowerCase() ? -1 : 0;
+          });
+        }
+        const deviceSelect = document.getElementById('deviceSelect');
+        deviceSelect.innerHTML = '';
+        cachedAccessories.forEach((a) => {
+          const option = document.createElement('option');
+          option.text = a.displayName;
+          option.value = a.UUID;
+          deviceSelect.add(option);
+        });
+        showDeviceInfo = async (UUID) => {
+          homebridge.showSpinner();
+          const thisAcc = cachedAccessories.find((x) => x.UUID === UUID);
+          const context = thisAcc.context;
+          document.getElementById('displayName').innerHTML = thisAcc.displayName;
+          document.getElementById('deviceID').innerHTML = context.deviceID;
+          document.getElementById('model').innerHTML = context.model;
+          document.getElementById('firmwareRevision').innerHTML = context.firmwareRevision || 'N/A';
+          document.getElementById('deviceType').innerHTML = context.deviceType;
+          document.getElementById('connectionType').innerHTML = context.connectionType;
+          document.getElementById('deviceTable').style.display = 'inline-table';
+          homebridge.hideSpinner();
+        };
+        deviceSelect.addEventListener('change', (event) => showDeviceInfo(event.target.value));
+        if (cachedAccessories.length > 0) {
+          showDeviceInfo(cachedAccessories[0].UUID);
+        } else {
+          const option = document.createElement('option');
+          option.text = 'No Devices';
+          deviceSelect.add(option);
+          deviceSelect.disabled = true;
+        }
+        homebridge.hideSpinner();
+      };
+      showSupport = () => {
+        homebridge.showSpinner();
+        homebridge.hideSchemaForm();
+        document.getElementById('menuHome').classList.add('btn-elegant');
+        document.getElementById('menuHome').classList.remove('btn-primary');
+        document.getElementById('menuDevices').classList.remove('btn-elegant');
+        document.getElementById('menuDevices').classList.add('btn-primary');
+        document.getElementById('menuSettings').classList.remove('btn-elegant');
+        document.getElementById('menuSettings').classList.add('btn-primary');
+        document.getElementById('pageSupport').style.display = 'block';
+        document.getElementById('pageDevices').style.display = 'none';
+        homebridge.hideSpinner();
+      };
+      showSettings = () => {
+        homebridge.showSpinner();
+        document.getElementById('menuHome').classList.remove('btn-elegant');
+        document.getElementById('menuHome').classList.add('btn-primary');
+        document.getElementById('menuDevices').classList.remove('btn-elegant');
+        document.getElementById('menuDevices').classList.add('btn-primary');
+        document.getElementById('menuSettings').classList.add('btn-elegant');
+        document.getElementById('menuSettings').classList.remove('btn-primary');
+        document.getElementById('pageSupport').style.display = 'none';
+        document.getElementById('pageDevices').style.display = 'none';
+        homebridge.showSchemaForm();
+        homebridge.hideSpinner();
+      };
+      showDisabledBanner = () => {
+        document.getElementById('disabledBanner').style.display = 'block';
+      };
+      enablePlugin = async () => {
+        homebridge.showSpinner();
+        document.getElementById('disabledBanner').style.display = 'none';
+        currentConfig[0].disablePlugin = false;
+        await homebridge.updatePluginConfig(currentConfig);
+        await homebridge.savePluginConfig();
+        homebridge.hideSpinner();
+      };
+      menuHome.addEventListener('click', () => showSupport());
+      menuDevices.addEventListener('click', () => showDevices());
+      menuSettings.addEventListener('click', () => showSettings());
+      disabledEnable.addEventListener('click', () => enablePlugin());
+      if (currentConfig.length) {
+        document.getElementById('menuWrapper').style.display = 'inline-flex';
+        showSettings();
+        if (currentConfig[0].disablePlugin) {
+          showDisabledBanner();
+        }
+      } else {
+        currentConfig.push({ name: 'SwitchBot' });
+        await homebridge.updatePluginConfig(currentConfig);
+        showIntro();
+      }
+    } catch (err) {
+      homebridge.toast.error(err.message, 'Error');
+    } finally {
+      homebridge.hideSpinner();
+    }
+  })();
+</script>

package/src/homebridge-ui/server.ts ADDED Viewed

@@ -0,0 +1,48 @@
+/* eslint-disable no-console */
+import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils';
+import fs from 'fs';
+class PluginUiServer extends HomebridgePluginUiServer {
+  constructor() {
+    super();
+    /*
+      A native method getCachedAccessories() was introduced in config-ui-x v4.37.0
+      The following is for users who have a lower version of config-ui-x
+    */
+    this.onRequest('getCachedAccessories', () => {
+      try {
+        const plugin = 'homebridge-switchbot';
+        const devicesToReturn = [];
+        // The path and file of the cached accessories
+        const accFile = this.homebridgeStoragePath + '/accessories/cachedAccessories';
+        // Check the file exists
+        if (fs.existsSync(accFile)) {
+          // read the cached accessories file
+          const cachedAccessories: any[] = JSON.parse(fs.readFileSync(accFile, 'utf8'));
+          cachedAccessories.forEach((accessory: any) => {
+            // Check the accessory is from this plugin
+            if (accessory.plugin === plugin) {
+              // Add the cached accessory to the array
+              devicesToReturn.push(accessory.accessory as never);
+            }
+          });
+        }
+        // Return the array
+        return devicesToReturn;
+      } catch (err) {
+        // Just return an empty accessory list in case of any errors
+        return [];
+      }
+    });
+    this.ready();
+  }
+}
+function startPluginUiServer(): PluginUiServer {
+  return new PluginUiServer();
+}
+startPluginUiServer();

package/homebridge-ui/server.js DELETED Viewed

@@ -1,50 +0,0 @@
-/* eslint-disable no-undef */
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* jshint node: true,esversion: 9, -W014, -W033 */
-/* eslint-disable new-cap */
-'use strict';
-const { HomebridgePluginUiServer } = require('@homebridge/plugin-ui-utils');
-const fs = require('fs');
-class PluginUiServer extends HomebridgePluginUiServer {
-  constructor() {
-    super();
-    /*
-      A native method getCachedAccessories() was introduced in config-ui-x v4.37.0
-      The following is for users who have a lower version of config-ui-x
-    */
-    this.onRequest('/getCachedAccessories', async () => {
-      try {
-        // Define the plugin and create the array to return
-        const plugin = 'homebridge-switchbot';
-        const devicesToReturn = [];
-        // The path and file of the cached accessories
-        const accFile = this.homebridgeStoragePath + '/accessories/cachedAccessories';
-        // Check the file exists
-        if (fs.existsSync(accFile)) {
-          // Read the cached accessories file
-          let cachedAccessories = await fs.promises.readFile(accFile);
-          // Parse the JSON
-          cachedAccessories = JSON.parse(cachedAccessories);
-          // We only want the accessories for this plugin
-          cachedAccessories.filter((accessory) => accessory.plugin === plugin).forEach((accessory) => devicesToReturn.push(accessory));
-        }
-        // Return the array
-        return devicesToReturn;
-      } catch (err) {
-        // Just return an empty accessory list in case of any errors
-        return [];
-      }
-    });
-    this.ready();
-  }
-}
-(() => new PluginUiServer())();

/package/{homebridge-ui → dist/homebridge-ui}/public/index.html RENAMED Viewed

File without changes