@switchbot/homebridge-switchbot 2.14.0 → 3.0.0-beta.0

package/src/device/plug.ts

@@ -3,10 +3,14 @@ import { sleep } from '../utils';
 import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
-import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
-import { device, devicesConfig, deviceStatus, ad, serviceData, Devices } from '../settings';
+import { Service, PlatformAccessory, CharacteristicValue, API, Logging, HAP } from 'homebridge';
+import { device, devicesConfig, deviceStatus, ad, serviceData, Devices, SwitchBotPlatformConfig } from '../settings';
 
 export class Plug {
+  public readonly api: API;
+  public readonly log: Logging;
+  public readonly config!: SwitchBotPlatformConfig;
+  protected readonly hap: HAP;
   // Services
   outletService: Service;
 
@@ -32,20 +36,27 @@ export class Plug {
   doPlugUpdate!: Subject<void>;
 
   // Connection
-  private readonly BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
-  private readonly OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
+  private readonly OpenAPI: boolean;
+  private readonly BLE: boolean;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
     public device: device & devicesConfig,
   ) {
+    this.api = this.platform.api;
+    this.log = this.platform.log;
+    this.config = this.platform.config;
+    this.hap = this.api.hap;
+    // Connection
+    this.BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
+    this.OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
     // default placeholders
-    this.logs(device);
+    this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
     this.context();
-    this.config(device);
+    this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doPlugUpdate = new Subject();
@@ -56,27 +67,27 @@ export class Plug {
 
     // set accessory information
     accessory
-      .getService(this.platform.Service.AccessoryInformation)!
-      .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId)
-      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
+      .getService(this.hap.Service.AccessoryInformation)!
+      .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
+      .setCharacteristic(this.hap.Characteristic.Model, this.model(device))
+      .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
+      .setCharacteristic(this.hap.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
 
     // get the Outlet service if it exists, otherwise create a new Outlet service
     // you can create multiple services for each accessory
     const outletService = `${accessory.displayName} ${device.deviceType}`;
-    (this.outletService = accessory.getService(this.platform.Service.Outlet)
-    || accessory.addService(this.platform.Service.Outlet)), outletService;
+    (this.outletService = accessory.getService(this.hap.Service.Outlet)
+      || accessory.addService(this.hap.Service.Outlet)), outletService;
 
-    this.outletService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
-    if (!this.outletService.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
-      this.outletService.addCharacteristic(this.platform.Characteristic.ConfiguredName, accessory.displayName);
+    this.outletService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
+    if (!this.outletService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
+      this.outletService.addCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName);
     }
     // each service must implement at-minimum the "required characteristics" for the given service type
     // see https://developers.homebridge.io/#/service/Outlet
 
     // create handlers for required characteristics
-    this.outletService.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
+    this.outletService.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
 
     // Update Homekit
     this.updateHomeKitCharacteristics();
@@ -97,14 +108,14 @@ export class Plug {
           const { powerState } = context;
           const { On } = this;
           this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
-                      '(powerState) = ' +
-                      `Webhook:(${powerState}), ` +
-                      `current:(${On})`);
+            '(powerState) = ' +
+            `Webhook:(${powerState}), ` +
+            `current:(${On})`);
           this.On = powerState === 'ON' ? true : false;
           this.updateHomeKitCharacteristics();
         } catch (e: any) {
           this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
-                    + `failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e}`);
+            + `failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
       };
     }
@@ -442,7 +453,7 @@ export class Plug {
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
     } else {
       this.accessory.context.On = this.On;
-      this.outletService.updateCharacteristic(this.platform.Characteristic.On, this.On);
+      this.outletService.updateCharacteristic(this.hap.Characteristic.On, this.On);
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
   }
@@ -595,7 +606,7 @@ export class Plug {
   }
 
   async apiError(e: any): Promise<void> {
-    this.outletService.updateCharacteristic(this.platform.Characteristic.On, e);
+    this.outletService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
   async context() {
@@ -616,7 +627,7 @@ export class Plug {
     }
   }
 
-  async config(device: device & devicesConfig): Promise<void> {
+  async deviceConfig(device: device & devicesConfig): Promise<void> {
     let config = {};
     if (device.plug) {
       config = device.plug;
@@ -647,7 +658,7 @@ export class Plug {
     }
   }
 
-  async logs(device: device & devicesConfig): Promise<void> {
+  async deviceLogs(device: device & devicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);

package/src/device/robotvacuumcleaner.ts

@@ -3,10 +3,14 @@ import { sleep } from '../utils';
 import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
-import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
-import { device, devicesConfig, deviceStatus, ad, serviceData, Devices } from '../settings';
+import { Service, PlatformAccessory, CharacteristicValue, API, Logging, HAP } from 'homebridge';
+import { device, devicesConfig, deviceStatus, ad, serviceData, Devices, SwitchBotPlatformConfig } from '../settings';
 
 export class RobotVacuumCleaner {
+  public readonly api: API;
+  public readonly log: Logging;
+  public readonly config!: SwitchBotPlatformConfig;
+  protected readonly hap: HAP;
   // Services
   batteryService: Service;
   robotVacuumCleanerService: Service;
@@ -39,20 +43,27 @@ export class RobotVacuumCleaner {
   doRobotVacuumCleanerUpdate!: Subject<void>;
 
   // Connection
-  private readonly BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
-  private readonly OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
+  private readonly OpenAPI: boolean;
+  private readonly BLE: boolean;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
     public device: device & devicesConfig,
   ) {
+    this.api = this.platform.api;
+    this.log = this.platform.log;
+    this.config = this.platform.config;
+    this.hap = this.api.hap;
+    // Connection
+    this.BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
+    this.OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
     // default placeholders
-    this.logs(device);
+    this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
     this.context();
-    this.config(device);
+    this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doRobotVacuumCleanerUpdate = new Subject();
@@ -63,31 +74,31 @@ export class RobotVacuumCleaner {
 
     // set accessory information
     accessory
-      .getService(this.platform.Service.AccessoryInformation)!
-      .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId)
-      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
+      .getService(this.hap.Service.AccessoryInformation)!
+      .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
+      .setCharacteristic(this.hap.Characteristic.Model, this.model(device))
+      .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
+      .setCharacteristic(this.hap.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
 
     // get the Lightbulb service if it exists, otherwise create a new Lightbulb service
     // you can create multiple services for each accessory
     const robotVacuumCleanerService = `${accessory.displayName} ${device.deviceType}`;
-    (this.robotVacuumCleanerService = accessory.getService(this.platform.Service.Lightbulb)
-      || accessory.addService(this.platform.Service.Lightbulb)), robotVacuumCleanerService;
+    (this.robotVacuumCleanerService = accessory.getService(this.hap.Service.Lightbulb)
+      || accessory.addService(this.hap.Service.Lightbulb)), robotVacuumCleanerService;
 
-    this.robotVacuumCleanerService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
-    if (!this.robotVacuumCleanerService.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
-      this.robotVacuumCleanerService.addCharacteristic(this.platform.Characteristic.ConfiguredName, accessory.displayName);
+    this.robotVacuumCleanerService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
+    if (!this.robotVacuumCleanerService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
+      this.robotVacuumCleanerService.addCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName);
     }
     // each service must implement at-minimum the "required characteristics" for the given service type
     // see https://developers.homebridge.io/#/service/Lightbulb
 
     // create handlers for required characteristics
-    this.robotVacuumCleanerService.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
+    this.robotVacuumCleanerService.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
 
     // handle Brightness events using the Brightness characteristic
     this.robotVacuumCleanerService
-      .getCharacteristic(this.platform.Characteristic.Brightness)
+      .getCharacteristic(this.hap.Characteristic.Brightness)
       .setProps({
         minStep: 25,
         minValue: 0,
@@ -102,12 +113,12 @@ export class RobotVacuumCleaner {
 
     // Battery Service
     const batteryService = `${accessory.displayName} Battery`;
-    (this.batteryService = this.accessory.getService(this.platform.Service.Battery)
-      || accessory.addService(this.platform.Service.Battery)), batteryService;
+    (this.batteryService = this.accessory.getService(this.hap.Service.Battery)
+      || accessory.addService(this.hap.Service.Battery)), batteryService;
 
-    this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
-    if (!this.batteryService.testCharacteristic(this.platform.Characteristic.ConfiguredName)) {
-      this.batteryService.addCharacteristic(this.platform.Characteristic.ConfiguredName, `${accessory.displayName} Battery`);
+    this.batteryService.setCharacteristic(this.hap.Characteristic.Name, `${accessory.displayName} Battery`);
+    if (!this.batteryService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
+      this.batteryService.addCharacteristic(this.hap.Characteristic.ConfiguredName, `${accessory.displayName} Battery`);
     }
 
     // Update Homekit
@@ -129,15 +140,15 @@ export class RobotVacuumCleaner {
           const { onlineStatus, battery } = context;
           const { On, BatteryLevel } = this;
           this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
-                        '(onlineStatus, battery) = ' +
-                        `Webhook:(${onlineStatus}, ${battery}), ` +
-                        `current:(${On}, ${BatteryLevel})`);
+            '(onlineStatus, battery) = ' +
+            `Webhook:(${onlineStatus}, ${battery}), ` +
+            `current:(${On}, ${BatteryLevel})`);
           this.On = onlineStatus === 'online' ? true : false;
           this.BatteryLevel = battery;
           this.updateHomeKitCharacteristics();
         } catch (e: any) {
           this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
-                      + `failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e}`);
+            + `failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
       };
     }
@@ -215,9 +226,9 @@ export class RobotVacuumCleaner {
     // Battery
     this.BatteryLevel = Number(this.OpenAPI_BatteryLevel);
     if (this.BatteryLevel < 15) {
-      this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
+      this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
     } else {
-      this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
+      this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
     }
     this.debugLog(`${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
 
@@ -583,7 +594,7 @@ export class RobotVacuumCleaner {
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
     } else {
       this.accessory.context.On = this.On;
-      this.robotVacuumCleanerService.updateCharacteristic(this.platform.Characteristic.On, this.On);
+      this.robotVacuumCleanerService.updateCharacteristic(this.hap.Characteristic.On, this.On);
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
     // Brightness
@@ -591,7 +602,7 @@ export class RobotVacuumCleaner {
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Brightness: ${this.Brightness}`);
     } else {
       this.accessory.context.Brightness = this.Brightness;
-      this.robotVacuumCleanerService.updateCharacteristic(this.platform.Characteristic.Brightness, this.Brightness);
+      this.robotVacuumCleanerService.updateCharacteristic(this.hap.Characteristic.Brightness, this.Brightness);
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic Brightness: ${this.Brightness}`);
     }
     // BatteryLevel
@@ -599,7 +610,7 @@ export class RobotVacuumCleaner {
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
     } else {
       this.accessory.context.BatteryLevel = this.BatteryLevel;
-      this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, this.BatteryLevel);
+      this.batteryService?.updateCharacteristic(this.hap.Characteristic.BatteryLevel, this.BatteryLevel);
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic BatteryLevel: ${this.BatteryLevel}`);
     }
     // StatusLowBattery
@@ -607,7 +618,7 @@ export class RobotVacuumCleaner {
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
     } else {
       this.accessory.context.StatusLowBattery = this.StatusLowBattery;
-      this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, this.StatusLowBattery);
+      this.batteryService?.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.StatusLowBattery);
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic StatusLowBattery: ${this.StatusLowBattery}`);
     }
   }
@@ -759,7 +770,7 @@ export class RobotVacuumCleaner {
   }
 
   async apiError(e: any): Promise<void> {
-    this.robotVacuumCleanerService.updateCharacteristic(this.platform.Characteristic.On, e);
+    this.robotVacuumCleanerService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
   async context() {
@@ -785,7 +796,7 @@ export class RobotVacuumCleaner {
     }
   }
 
-  async config(device: device & devicesConfig): Promise<void> {
+  async deviceConfig(device: device & devicesConfig): Promise<void> {
     let config = {};
     if (device.plug) {
       config = device.plug;
@@ -816,7 +827,7 @@ export class RobotVacuumCleaner {
     }
   }
 
-  async logs(device: device & devicesConfig): Promise<void> {
+  async deviceLogs(device: device & devicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
       this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);

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

@@ -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

@@ -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/src/index.ts

@@ -1,10 +1,13 @@
+/* Copyright(C) 2021-2023, SwitchBot (https://github.com/SwitchBot). All rights reserved.
+ *
+ * index.ts: @switchbot/homebridge-switchbot plugin registration.
+ */
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
 import { API } from 'homebridge';
-import { PLATFORM_NAME } from './settings';
-import { SwitchBotPlatform } from './platform';
+import { SwitchBotPlatform } from './platform.js';
 
-/**
- * This method registers the platform with Homebridge
- */
-export = (api: API): void => {
-  api.registerPlatform(PLATFORM_NAME, SwitchBotPlatform);
+// Register our platform with homebridge.
+export default (api: API): void => {
+
+  api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, SwitchBotPlatform);
 };