@switchbot/homebridge-switchbot 5.0.0-beta.70 → 5.0.0-beta.72

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

@@ -1,449 +1,81 @@
-<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" id="menuHome">Support</button>
-  <button type="button" class="btn btn-primary mr-0" id="dynamic-config-tab">Dynamic Config</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>
-          <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="version"></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>
-        <tr>
-          <th scope="row">Refresh Rate</th>
-          <td id="refreshRate"></td>
-        </tr>
-        <tr>
-          <th scope="row">Update Rate</th>
-          <td id="updateRate"></td>
-        </tr>
-        <tr>
-          <th scope="row">Push Rate</th>
-          <td id="pushRate"></td>
-        </tr>
-      </tbody>
-    </table>
-    <h5 class="mt-4">Cached Accessories</h5>
-    <ul id="cachedAccessoriesList"></ul>
-    <p class="text-center">External accessories will not be displayed 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>
-<div id="dynamic-config-content" class="tab-content" style="display: none;">
-  <h2>Dynamic Config</h2>
-  <p>Discover and configure devices dynamically.</p>
-  <!-- Placeholder for dynamic content -->
-</div>
-<script>
-  (async () => {
-    try {
-      const currentConfig = await homebridge.getPluginConfig();
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title>SwitchBot Plugin UI</title>
+    <style>
+      body { font-family: system-ui, -apple-system, Arial; padding: 16px; }
+      h1 { font-size: 18px }
+      ul { padding-left: 0; list-style: none }
+      li { margin: 8px 0; display:flex; gap:8px; align-items:center }
+      button { padding: 6px 10px }
+      code { background:#f3f3f3; padding:4px 6px; border-radius:4px }
+    </style>
+  </head>
+  <body>
+    <h1>SwitchBot: Configured Devices</h1>
+    <p>This page lists devices found in your Homebridge config for the SwitchBot platform. Use the copy button to insert device IDs into the plugin configuration. Connection preference (BLE/OpenAPI) is shown when available.</p>
+    <div id="status">Loading…</div>
+    <ul id="devices"></ul>
 
-      // Defensive wrapper: ensure token/secret aren't accidentally cleared by
-      // the UI/schema form. Some versions of config UI can omit sensitive
-      // fields from the submitted payload; when that happens we copy the
-      // existing values from `currentConfig` into the outgoing payload so
-      // saved config does not inadvertently remove credentials.
-      try {
-        if (typeof homebridge.updatePluginConfig === 'function') {
-          const _origUpdatePluginConfig = homebridge.updatePluginConfig.bind(homebridge)
-          homebridge.updatePluginConfig = async (cfg) => {
-            try {
-              if (Array.isArray(cfg) && cfg.length > 0 && Array.isArray(currentConfig) && currentConfig.length > 0) {
-                const incoming = cfg[0] || {}
-                const existing = currentConfig[0] || {}
-                incoming.credentials = incoming.credentials || {}
-                // Preserve token/secret when incoming payload leaves them blank/undefined
-                if ((incoming.credentials.token === undefined || String(incoming.credentials.token).trim() === '') && existing.credentials && existing.credentials.token) {
-                  incoming.credentials.token = existing.credentials.token
-                }
-                if ((incoming.credentials.secret === undefined || String(incoming.credentials.secret).trim() === '') && existing.credentials && existing.credentials.secret) {
-                  incoming.credentials.secret = existing.credentials.secret
-                }
-                cfg[0] = incoming
-              }
-            } catch (e) {
-              // Swallow any wrapper errors but log to console for debugging
-              // (do not expose secrets).
-              console.error('updatePluginConfig wrapper error', e)
-            }
-            return await _origUpdatePluginConfig(cfg)
-          }
+    <script>
+      async function fetchDevices() {
+        try {
+          const resp = await homebridge.request('/devices', {})
+          if (!resp || !resp.success) throw new Error(resp?.data?.message || 'request failed')
+          return resp.data || []
+        } catch (e) {
+          console.error(e)
+          return []
         }
-      } catch (e) {
-        console.error('Failed to attach updatePluginConfig wrapper', e)
       }
-      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';
-        let cachedAccessories =
-          typeof homebridge.getCachedAccessories === 'function'
-            ? await homebridge.getCachedAccessories()
-            : await homebridge.request('/getCachedAccessories');
 
-        // If no HAP cached accessories were returned, try the Matter cached list using the new native method
-        if ((!cachedAccessories || cachedAccessories.length === 0)) {
-          try {
-            // Use the new native getCachedMatterAccessories() method from @homebridge/plugin-ui-utils v2.1.1-beta.0+
-            const matter = typeof homebridge.getCachedMatterAccessories === 'function'
-              ? await homebridge.getCachedMatterAccessories()
-              : await homebridge.request('/getCachedMatterAccessories'); // Fallback to custom handler for older UI versions
-            if (Array.isArray(matter) && matter.length > 0) {
-              cachedAccessories = matter
-            }
-          } catch (e) {
-            // ignore
-          }
-        }
-        console.log('Cached Accessories:', cachedAccessories); // Log cached accessories for debugging
-        if (cachedAccessories.length > 0) {
-          cachedAccessories.sort((a, b) => {
-            return a.displayName.toLowerCase() > b.displayName.toLowerCase()
-              ? 1
-              : b.displayName.toLowerCase() > a.displayName.toLowerCase()
-              ? -1
-              : 0;
-          });
+      function render(list) {
+        const ul = document.getElementById('devices')
+        const status = document.getElementById('status')
+        if (!list.length) {
+          status.textContent = 'No devices found in config.'
+          return
         }
-        const deviceSelect = document.getElementById('deviceSelect');
-        deviceSelect.innerHTML = '';
-        cachedAccessories.forEach((a) => {
-          const option = document.createElement('option');
-          option.text = a.displayName;
-          option.value = a.UUID || a.uuid; // Handle both HAP and Matter UUID formats
-          deviceSelect.add(option);
-        });
-        const cachedAccessoriesList = document.getElementById('cachedAccessoriesList');
-        cachedAccessoriesList.innerHTML = ''; // Clear previous entries
-        cachedAccessories.forEach((a) => {
-          const listItem = document.createElement('li');
-          listItem.textContent = `${a.displayName} (${a.UUID || a.uuid})`;
-          cachedAccessoriesList.appendChild(listItem);
-        });
-        const validateConfig = (config) => {
-          const deviceIds = new Set();
-          const isValid = config[0].options.devices.every((device) => {
-            if (!device.deviceId || typeof device.deviceId !== 'string') {
-              homebridge.toast.error(`Invalid device ID: ${device.deviceId}`, 'Error');
-              return false;
-            }
-            if (deviceIds.has(device.deviceId)) {
-              homebridge.toast.error(`Duplicate device ID found: ${device.deviceId}`, 'Error');
-              return false;
-            }
-            deviceIds.add(device.deviceId);
-            return true;
-          });
-          return isValid;
-        };
-
-        const addDeviceToConfig = async (deviceId) => {
-          try {
-            homebridge.showSpinner();
-            const currentConfig = await homebridge.getPluginConfig();
-            if (!currentConfig[0].options.devices) {
-              currentConfig[0].options.devices = [];
-            }
-            currentConfig[0].options.devices.push({
-              deviceId: deviceId.replace(/:/g, ''),
-              hide_device: false,
-              disablePlatformBLE: false,
-              allowPush: false,
-              disableCaching: false,
-            });
-            if (!validateConfig(currentConfig)) {
-              homebridge.hideSpinner();
-              return;
-            }
-            await homebridge.updatePluginConfig(currentConfig);
-            await homebridge.savePluginConfig();
-            homebridge.toast.success('Device added to config successfully!', 'Success');
-          } catch (error) {
-            homebridge.toast.error('Failed to add device to config!', 'Error');
-          } finally {
-            homebridge.hideSpinner();
-          }
-        };
-
-        const protocolInfo = document.createElement('p');
-        protocolInfo.id = 'protocolInfo';
-        protocolInfo.style.marginTop = '10px';
-        document.getElementById('deviceInfo').appendChild(protocolInfo);
-
-        const addDeviceButton = document.createElement('button');
-        addDeviceButton.textContent = 'Add Device to Config';
-        addDeviceButton.className = 'btn btn-success';
-        addDeviceButton.style.marginTop = '10px';
-        addDeviceButton.addEventListener('click', () => {
-          const deviceId = document.getElementById('deviceId').textContent;
-          if (deviceId) {
-            addDeviceToConfig(deviceId);
-          } else {
-            homebridge.toast.error('No device ID found!', 'Error');
-          }
-        });
-        document.getElementById('deviceInfo').appendChild(addDeviceButton);
-
-        const updateTableWithDetails = (deviceContext) => {
-          const tableBody = document.querySelector('#deviceTable tbody');
-
-          Object.entries(deviceContext).forEach(([key, value]) => {
-            if (/string|number|boolean/.test(typeof value) && (typeof value !== 'string' || value.trim())) {
-              let existingCell = document.getElementById(key);
-              if (existingCell) {
-                existingCell.textContent = value;
-              } else {
-                const row = document.createElement('tr');
-                const keyCell = document.createElement('th');
-                keyCell.scope = 'row';
-                keyCell.textContent = key;
-                const valueCell = document.createElement('td');
-                valueCell.textContent = value;
-                row.appendChild(keyCell);
-                row.appendChild(valueCell);
-                tableBody.appendChild(row);
-              }
-            }
-          });
-        };
-
-        // Ensure the element exists before attempting to set its innerHTML
-        const safeSetInnerHTML = (id, value) => {
-          const element = document.getElementById(id);
-          if (element) {
-            element.innerHTML = value;
-          } else {
-            console.warn(`Element with id '${id}' not found.`);
-          }
-        };
-
-        showDeviceInfo = async (UUID) => {
-          try {
-            homebridge.showSpinner();
-            const thisAcc = cachedAccessories.find((x) => x.UUID === UUID);
-            if (!thisAcc) {
-              throw new Error('Device not found');
+        status.textContent = `Found ${list.length} device(s)`
+        ul.innerHTML = ''
+        for (const d of list) {
+          const li = document.createElement('li')
+          const name = document.createElement('span')
+          name.textContent = d.name || d.id
+          const code = document.createElement('code')
+          code.textContent = d.id
+          const meta = document.createElement('span')
+          meta.style.opacity = '0.75'
+          meta.style.marginLeft = '8px'
+          const typeText = d.type ? `type: ${d.type}` : ''
+          const connText = d.connectionPreference ? `conn: ${d.connectionPreference}` : ''
+          const roomText = d.room ? `room: ${d.room}` : ''
+          meta.textContent = [typeText, connText, roomText].filter(Boolean).join(' | ')
+          const btn = document.createElement('button')
+          btn.textContent = 'Copy ID'
+          btn.addEventListener('click', async () => {
+            try {
+              await navigator.clipboard.writeText(d.id)
+              btn.textContent = 'Copied'
+              setTimeout(() => (btn.textContent = 'Copy ID'), 1200)
+            } catch (e) {
+              alert('Failed to copy')
             }
-            const context = thisAcc.context;
-            const protocol = thisAcc.isMatter ? 'Matter Protocol' : 'HAP Protocol';
-            safeSetInnerHTML('displayName', thisAcc.displayName);
-            safeSetInnerHTML('deviceId', context.deviceId);
-            safeSetInnerHTML('model', context.model);
-            safeSetInnerHTML('version', context.version);
-            safeSetInnerHTML('deviceType', context.deviceType);
-            safeSetInnerHTML('connectionType', context.connectionType);
-            safeSetInnerHTML('refreshRate', context.refreshRate);
-            safeSetInnerHTML('updateRate', context.updateRate);
-            safeSetInnerHTML('pushRate', context.pushRate);
-            safeSetInnerHTML('protocolInfo', protocol);
-            document.getElementById('deviceTable').style.display = 'inline-table';
-
-
-            updateTableWithDetails(context);
-          } catch (error) {
-            homebridge.toast.error(error.message, 'Error');
-          } finally {
-            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;
+          })
+          li.appendChild(name)
+          li.appendChild(code)
+          li.appendChild(meta)
+          li.appendChild(btn)
+          ul.appendChild(li)
         }
-        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();
-    }
-  })();
-
-  document.getElementById('dynamic-config-tab').addEventListener('click', function() {
-    // Hide other tabs
-    document.querySelectorAll('.tab-content').forEach(tab => tab.style.display = 'none');
 
-    // Show Dynamic Config tab
-    document.getElementById('dynamic-config-content').style.display = 'block';
-  });
-</script>
+      (async () => {
+        const list = await fetchDevices()
+        render(list)
+      })()
+    </script>
+  </body>
+  </html>

package/src/homebridge-ui/server.ts

@@ -1,14 +1,56 @@
-import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+import fs from 'node:fs/promises'
 
-class PluginUiServer extends HomebridgePluginUiServer {
-  constructor() {
-    super()
-    this.ready()
+import { HomebridgePluginUiServer, RequestError } from '@homebridge/plugin-ui-utils'
+
+const server = new HomebridgePluginUiServer()
+
+server.onRequest('/devices', async () => {
+  try {
+    const cfgPath = server.homebridgeConfigPath
+    if (!cfgPath) {
+      throw new Error('HOMEBRIDGE_CONFIG_PATH not set')
+    }
+
+    const raw = await fs.readFile(cfgPath, 'utf8')
+    const cfg = JSON.parse(raw)
+    const found: Array<{ id: string, name?: string, type?: string, connectionPreference?: string, room?: string }> = []
+
+    const platforms = Array.isArray(cfg.platforms) ? cfg.platforms : []
+    for (const p of platforms) {
+      try {
+        const platformName = p.platform || p.name || ''
+        // Match known SwitchBot platform identifiers
+        if (!platformName || !/switchbot/i.test(String(platformName))) {
+          continue
+        }
+
+        const options = p.options || p
+        const devices = Array.isArray(options.devices) ? options.devices : []
+        for (const d of devices) {
+          const id = d.deviceId ?? d.id
+          if (!id) {
+            continue
+          }
+
+          found.push({
+            id,
+            name: d.configDeviceName ?? d.name ?? d.deviceName,
+            type: d.configDeviceType ?? d.type ?? d.deviceType,
+            connectionPreference: d.connectionPreference ?? d.connection ?? 'auto',
+            room: d.room || d.location || undefined,
+          })
+        }
+      } catch (e) {
+        // ignore malformed platform entries
+      }
+    }
+
+    return found
+  } catch (e) {
+    throw new RequestError('Failed to read Homebridge config', e)
   }
-}
+})
 
-function startPluginUiServer(): PluginUiServer {
-  return new PluginUiServer()
-}
+server.ready()
 
-startPluginUiServer()
+export default server

package/src/index.ts

@@ -4,14 +4,12 @@
  */
 import type { API } from 'homebridge'
 
-import { SwitchBotHAPPlatform } from './platform-hap.js'
-import { SwitchBotMatterPlatform } from './platform-matter.js'
+import { SwitchBotHAPPlatform, SwitchBotMatterPlatform } from './platform.js'
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
 import { createPlatformProxy } from './utils.js'
 
 // Register our platform with homebridge.
 export default (api: API): void => {
-  // Create and register a small proxy that selects the correct platform (HAP or Matter) at runtime.
   const ProxyCtor = createPlatformProxy(SwitchBotHAPPlatform, SwitchBotMatterPlatform)
   api.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, ProxyCtor as any)
 }