@switchbot/homebridge-switchbot 5.0.0-beta.112 → 5.0.0-beta.113

package/src/homebridge-ui/endpoints/discovery.ts

@@ -10,9 +10,37 @@ import { uiLog } from '../utils/logger.js'
  * Discovers SwitchBot devices via BLE and OpenAPI
  */
 export function registerDiscoveryEndpoint(server: HomebridgePluginUiServer) {
-  server.onRequest('/discover', async () => {
+  server.onRequest('/ble-status', async () => {
     try {
       const { platform } = await getSwitchBotPlatformConfig(server)
+      const token = getCredential(platform, 'openApiToken') || platform.token
+      const secret = getCredential(platform, 'openApiSecret') || platform.secret
+      const { SwitchBot } = await import('node-switchbot')
+      const switchbot = new SwitchBot({
+        token: token || undefined,
+        secret: secret || undefined,
+        enableBLE: true,
+        enableFallback: true,
+        enableRetry: true,
+      })
+
+      await switchbot.discover({ timeout: 1000 })
+      return { success: true, data: { available: true, message: 'adapter ready' } }
+    } catch (e) {
+      const message = e instanceof Error ? e.message : String(e)
+      uiLog.warn(`GET /ble-status failed: ${message}`)
+      return { success: true, data: { available: false, message } }
+    }
+  })
+
+  server.onRequest('/discover', async (payload?: any) => {
+    try {
+      const { platform } = await getSwitchBotPlatformConfig(server)
+      const mode = String(payload?.mode || 'all').toLowerCase()
+      const runBle = mode === 'all' || mode === 'ble'
+      const runOpenApi = mode === 'all' || mode === 'openapi'
+      const bleScanDurationSeconds = Math.max(3, Math.min(15, Number(payload?.bleScanDurationSeconds || 5)))
+      const bleTimeoutSeconds = Math.max(3, Math.min(30, Number(payload?.bleTimeoutSeconds || 8)))
 
       uiLog.debug(`GET /discover - Platform config keys: ${Object.keys(platform).join(', ')}`)
 
@@ -40,55 +68,57 @@ export function registerDiscoveryEndpoint(server: HomebridgePluginUiServer) {
       const deviceMap = new Map<string, any>()
 
       // 1. Try BLE discovery first (with timeout)
-      uiLog.info('GET /discover - Starting BLE scan...')
-      try {
-        const bleTimeout = 8000 // 8 second timeout for BLE scan
-        const bleDiscoveryPromise = switchbot.discover({ timeout: 5000 }) // 5 second scan timeout
-        const bleDevices = await Promise.race([
-          bleDiscoveryPromise,
-          new Promise<any[]>(resolve => setTimeout(resolve, bleTimeout, [])),
-        ])
-
-        if (Array.isArray(bleDevices) && bleDevices.length > 0) {
-          uiLog.info(`GET /discover - Found ${bleDevices.length} BLE devices`)
-          for (const [index, d] of bleDevices.entries()) {
-            const info = typeof d?.getInfo === 'function' ? d.getInfo() : undefined
-            const id = d?.id
-              || (typeof d?.getId === 'function' ? d.getId() : undefined)
-              || info?.id
-
-            const mac = d?.mac
-              || (typeof d?.getMAC === 'function' ? d.getMAC() : undefined)
-              || info?.mac
+      if (runBle) {
+        uiLog.info('GET /discover - Starting BLE scan...')
+        try {
+          const bleTimeout = bleTimeoutSeconds * 1000
+          const bleDiscoveryPromise = switchbot.discover({ timeout: bleScanDurationSeconds * 1000 })
+          const bleDevices = await Promise.race([
+            bleDiscoveryPromise,
+            new Promise<any[]>(resolve => setTimeout(resolve, bleTimeout, [])),
+          ])
+
+          if (Array.isArray(bleDevices) && bleDevices.length > 0) {
+            uiLog.info(`GET /discover - Found ${bleDevices.length} BLE devices`)
+            for (const [index, d] of bleDevices.entries()) {
+              const info = typeof d?.getInfo === 'function' ? d.getInfo() : undefined
+              const id = d?.id
+                || (typeof d?.getId === 'function' ? d.getId() : undefined)
+                || info?.id
+
+              const mac = d?.mac
+                || (typeof d?.getMAC === 'function' ? d.getMAC() : undefined)
+                || info?.mac
+
+              if (!id) {
+                uiLog.warn(`GET /discover - BLE device at index ${index} has no id, skipping`)
+                continue
+              }
+
+              const connectionTypes = Array.isArray(info?.connectionTypes) ? info.connectionTypes : []
+              const isHybrid = connectionTypes.includes('api')
 
-            if (!id) {
-              uiLog.warn(`GET /discover - BLE device at index ${index} has no id, skipping`)
-              continue
+              deviceMap.set(id, {
+                id,
+                name: d?.name || (typeof d?.getName === 'function' ? d.getName() : undefined) || info?.name || d?.deviceName || id,
+                type: d?.deviceType || (typeof d?.getDeviceType === 'function' ? d.getDeviceType() : undefined) || info?.deviceType || d?.type || d?.model || 'unknown',
+                model: info?.model || d?.model || d?.deviceModel,
+                address: mac,
+                connectionType: isHybrid ? 'Both' : 'BLE',
+                rssi: info?.rssi || d?.rssi,
+              })
             }
-
-            const connectionTypes = Array.isArray(info?.connectionTypes) ? info.connectionTypes : []
-            const isHybrid = connectionTypes.includes('api')
-
-            deviceMap.set(id, {
-              id,
-              name: d?.name || (typeof d?.getName === 'function' ? d.getName() : undefined) || info?.name || d?.deviceName || id,
-              type: d?.deviceType || (typeof d?.getDeviceType === 'function' ? d.getDeviceType() : undefined) || info?.deviceType || d?.type || d?.model || 'unknown',
-              model: info?.model || d?.model || d?.deviceModel,
-              address: mac,
-              connectionType: isHybrid ? 'Both' : 'BLE',
-              rssi: info?.rssi || d?.rssi,
-            })
+          } else {
+            uiLog.info('GET /discover - No BLE devices found or scan timed out')
           }
-        } else {
-          uiLog.info('GET /discover - No BLE devices found or scan timed out')
+        } catch (bleErr) {
+          uiLog.warn(`GET /discover - BLE discovery failed: ${bleErr instanceof Error ? bleErr.message : String(bleErr)}`)
+          // Continue with OpenAPI even if BLE fails
         }
-      } catch (bleErr) {
-        uiLog.warn(`GET /discover - BLE discovery failed: ${bleErr instanceof Error ? bleErr.message : String(bleErr)}`)
-        // Continue with OpenAPI even if BLE fails
       }
 
       // 2. Get devices from OpenAPI (only if credentials are available)
-      if (hasOpenAPICredentials) {
+      if (runOpenApi && hasOpenAPICredentials) {
         uiLog.info('GET /discover - Fetching devices from OpenAPI...')
         try {
           const apiClient = switchbot.getAPIClient()
@@ -157,7 +187,7 @@ export function registerDiscoveryEndpoint(server: HomebridgePluginUiServer) {
             throw apiErr
           }
         }
-      } else {
+      } else if (runOpenApi) {
         uiLog.info('GET /discover - Skipping OpenAPI discovery (no credentials configured)')
       }
 
@@ -166,6 +196,10 @@ export function registerDiscoveryEndpoint(server: HomebridgePluginUiServer) {
       uiLog.info(`GET /discover - Normalized BLE devices: ${normalizedBleDevices.length} (firstId: ${firstNormalizedBleId})`)
 
       // Check if we found any devices
+      if (deviceMap.size === 0 && mode === 'openapi' && !hasOpenAPICredentials) {
+        return { success: true, data: [] }
+      }
+
       if (deviceMap.size === 0) {
         const errorMsg = hasOpenAPICredentials
           ? 'No devices found via BLE or OpenAPI. Make sure devices are powered on and in range.'

package/src/homebridge-ui/public/css/styles.css

@@ -310,6 +310,92 @@ select:focus {
   gap: 6px;
 }
 
+.discover-phase-progress {
+  margin-bottom: 8px;
+}
+
+.discovery-settings-row {
+  display: flex;
+  flex-wrap: wrap;
+  gap: 8px;
+  align-items: center;
+}
+
+.discover-phase-track {
+  width: 100%;
+  height: 5px;
+  border-radius: 999px;
+  background: rgba(148, 163, 184, 0.35);
+  overflow: hidden;
+}
+
+.discover-phase-fill {
+  width: 0%;
+  height: 100%;
+  border-radius: 999px;
+  background: var(--switchbot-red, #ef4444);
+  transition: width 0.25s ease;
+}
+
+.discover-phase-label {
+  margin-top: 3px;
+  font-size: 10px;
+  opacity: 0.75;
+}
+
+.discovery-groups {
+  display: block;
+  max-height: 400px;
+  overflow-y: auto;
+  margin-top: 10px;
+}
+
+.discovery-group {
+  margin-top: 8px;
+}
+
+.discovery-group:first-child {
+  margin-top: 0;
+}
+
+.discovery-group-header {
+  margin: 0 0 4px;
+  font-size: 11px;
+  font-weight: 600;
+  opacity: 0.85;
+}
+
+.discovery-group-header-btn {
+  width: 100%;
+  text-align: left;
+  margin: 0 0 4px;
+  padding: 2px 0;
+  border: 0;
+  background: transparent;
+  color: inherit;
+  font-size: 11px;
+  font-weight: 600;
+  opacity: 0.9;
+  cursor: pointer;
+  border-radius: 0;
+  box-shadow: none;
+  transform: none;
+}
+
+.discovery-group-header-btn:hover,
+.discovery-group-header-btn:active {
+  background: transparent;
+  color: inherit;
+  box-shadow: none;
+  transform: none;
+}
+
+.discovery-group-empty {
+  font-size: 11px;
+  opacity: 0.75;
+  padding: 4px 0;
+}
+
 #devices.device-grid,
 #discoveredDevices.device-grid,
 ul.device-grid {
@@ -347,3 +433,15 @@ ul.device-grid {
 .card:hover {
   box-shadow: 0 4px 12px rgba(0, 0, 0, 0.08);
 }
+@keyframes pulse {
+  0%, 100% {
+    opacity: 1;
+  }
+  50% {
+    opacity: 0.5;
+  }
+}
+
+.discovery-scanning-pulse {
+  animation: pulse 1.5s ease-in-out infinite;
+}

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

@@ -42,10 +42,66 @@
           Adds all discovered devices automatically; already configured devices are skipped.
         </div>
       </div>
+      <div class="discovery-settings-row" style="margin-bottom: 2px">
+        <label id="bleScanSetting" style="display: inline-flex; align-items: center; gap: 4px; font-size: 11px">
+          <span>Scan:</span>
+          <select id="bleScanDurationSelect" style="font-size: 11px; padding: 2px 6px">
+            <option value="3">3s</option>
+            <option value="5" selected>5s</option>
+            <option value="10">10s</option>
+            <option value="15">15s</option>
+          </select>
+        </label>
+        <label id="bleTimeoutSetting" style="display: inline-flex; align-items: center; gap: 4px; font-size: 11px">
+          <span>Timeout:</span>
+          <input
+            id="bleTimeoutInput"
+            type="number"
+            min="3"
+            max="30"
+            step="1"
+            value="8"
+            style="width: 56px; font-size: 11px; padding: 2px 4px"
+          />
+          <span>s</span>
+        </label>
+        <label style="display: flex; align-items: center; gap: 4px; cursor: pointer; font-size: 11px">
+          <input type="checkbox" id="disableBleScanCheckbox" style="width: auto; margin: 0" />
+          <span>Disable BLE scan</span>
+        </label>
+      </div>
+      <div id="bluetoothStatus" style="margin-bottom: 4px; font-size: 10px; opacity: 0.8">Bluetooth: checking...</div>
+      <div class="discovery-settings-row" style="margin-bottom: 8px">
+        <div id="lastScannedStatus" style="font-size: 10px; opacity: 0.8; flex: 1 1 auto">Last scanned: never</div>
+        <label style="font-size: 11px">
+          Auto-refresh:
+          <select id="autoRefreshIntervalSelect" style="margin-left: 4px; font-size: 11px; padding: 2px 6px">
+            <option value="0" selected>Off</option>
+            <option value="30">30s</option>
+            <option value="60">1m</option>
+            <option value="300">5m</option>
+          </select>
+        </label>
+        <button id="refreshDiscoverBtn" class="secondary" style="padding: 4px 9px; font-size: 11px">Refresh</button>
+      </div>
       <button id="discoverBtn" onclick="discoverDevices()" style="margin-bottom: 8px">
         🔍 Discover
       </button>
+      <button
+        id="cancelDiscoverBtn"
+        style="margin-left: 6px; margin-bottom: 8px; display: none; padding: 6px 10px; font-size: 11px"
+        class="secondary"
+      >
+        Cancel
+      </button>
       <div id="discoverStatus" style="margin-bottom: 6px; font-size: 11px"></div>
+      <div id="discoverDevicesFound" style="margin-bottom: 6px; font-size: 11px; display: none"></div>
+      <div id="discoverPhaseProgress" class="discover-phase-progress" style="display: none">
+        <div class="discover-phase-track">
+          <div id="discoverPhaseFill" class="discover-phase-fill"></div>
+        </div>
+        <div id="discoverPhaseLabel" class="discover-phase-label"></div>
+      </div>
       <div id="discoveredList" style="display: none">
         <h3 style="margin-top: 0; font-size: 12px; margin-bottom: 6px; font-weight: 600">Available Devices</h3>
         <ul
@@ -59,6 +115,7 @@
       <h2>Configured Devices</h2>
       <div id="status">Loading…</div>
       <ul id="devices"></ul>
+      <!-- BLE encryption key fields will be rendered dynamically per device in the UI (see app.ts/devices.js) -->
       <div
         id="removeAllContainer"
         style="

package/src/homebridge-ui/public/js/api.ts

@@ -100,9 +100,18 @@ export async function fetchDevices(): Promise<any[]> {
   }
 }
 
-export async function discoverDevices(): Promise<any[]> {
+export type DiscoverRequestOptions = {
+  bleEnabled?: boolean
+  bleScanDurationSeconds?: number
+  bleTimeoutSeconds?: number
+}
+
+export async function discoverDevices(
+  mode: 'all' | 'ble' | 'openapi' = 'all',
+  options?: DiscoverRequestOptions,
+): Promise<any[]> {
   try {
-    const resp = await homebridge.request('/discover', {})
+    const resp = await homebridge.request('/discover', { mode, ...options })
     uiLog.info('Discover response:', resp)
 
     if (!resp || resp.success === false) {
@@ -115,17 +124,57 @@ export async function discoverDevices(): Promise<any[]> {
   }
 }
 
+export async function fetchBluetoothStatus(): Promise<{ available: boolean, message: string }> {
+  try {
+    const resp = await homebridge.request('/ble-status', {})
+    if (!resp || resp.success === false) {
+      return { available: false, message: 'Bluetooth status unavailable' }
+    }
+    return resp.data || { available: false, message: 'Bluetooth status unavailable' }
+  } catch (_e) {
+    return { available: false, message: 'Bluetooth status unavailable' }
+  }
+}
+
+export async function testDeviceConnection(payload: {
+  deviceId: string
+  connectionType?: string
+  address?: string
+}): Promise<{
+  success: boolean
+  deviceId: string
+  method: string
+  latencyMs: number
+  message: string
+  state?: Record<string, any>
+}> {
+  const resp = await homebridge.request('/test-connection', payload)
+  if (!resp || resp.success === false) {
+    throw new Error(resp?.data?.message || 'Connection test failed')
+  }
+
+  return resp.data || {
+    success: false,
+    deviceId: payload.deviceId,
+    method: 'Auto',
+    latencyMs: 0,
+    message: 'Connection test failed',
+  }
+}
+
 export async function addDevice(
   deviceId: string,
   name: string,
   type: string,
-  options?: { address?: string, model?: string, rssi?: number },
+  options?: { address?: string, model?: string, rssi?: number, encryptionKey?: string, keyId?: string },
 ): Promise<any> {
   try {
     const payload: any = { deviceId, name, type }
     if (options?.address) { payload.address = options.address }
     if (options?.model) { payload.model = options.model }
     if (options?.rssi !== undefined && options?.rssi !== null && options?.rssi !== 0) { payload.rssi = options.rssi }
+    if (options?.encryptionKey) { payload.encryptionKey = options.encryptionKey }
+    if (options?.keyId) { payload.keyId = options.keyId }
 
     uiLog.info('Adding device to config:', payload)
     const resp = await homebridge.request('/add-device', payload)

package/src/homebridge-ui/public/js/app.ts

@@ -1,7 +1,7 @@
 import { loadCredentialStatus, saveCredentials } from './credentials.js'
 import { loadConfiguredDevices, initRemoveAllButton } from './devices.js'
 // Wire up global event handlers
-import { discoverDevices } from './discovery.js';
+import { discoverDevices, initializeDiscoverySettings } from './discovery.js';
 
 (window as any).loadCredentialStatus = loadCredentialStatus
 ;(window as any).saveCredentials = saveCredentials
@@ -10,6 +10,7 @@ import { discoverDevices } from './discovery.js';
 // Initialize on page load
 async function init(): Promise<void> {
   await loadCredentialStatus()
+  await initializeDiscoverySettings()
   const list = await loadConfiguredDevices()
   await initRemoveAllButton()
 }

package/src/homebridge-ui/public/js/devices.ts

@@ -1,15 +1,25 @@
+
 import { addDevice, fetchDevices, syncParentPluginConfigFromDisk } from './api.js'
 import { uiLog } from './logger.js'
 import { hideBusyUi, showBusyUi } from './modal.js'
 import { renderDeviceList } from './render.js'
 import { toastError, toastInfo, toastSuccess, toastWarning } from './toast.js'
 
+type ImportDiscoveredDeviceResult = {
+  configDeviceName: string
+  configDeviceType: string
+  address?: string
+  encryptionKey?: string
+  keyId?: string
+} | null
+
 export async function addDeviceToConfig(device: any, options: { refresh?: boolean, showStatus?: boolean } = {}): Promise<{ added: boolean }> {
   const { refresh = true, showStatus = true } = options
 
   try {
     const { importDiscoveredDevice } = await import('./modals.js')
-    const importValues = await importDiscoveredDevice(device)
+
+    const importValues: ImportDiscoveredDeviceResult = await importDiscoveredDevice(device)
     if (!importValues) {
       return { added: false }
     }
@@ -20,6 +30,8 @@ export async function addDeviceToConfig(device: any, options: { refresh?: boolea
       address: importValues.address,
       model: device.model,
       rssi: device.rssi,
+      encryptionKey: importValues.encryptionKey,
+      keyId: importValues.keyId,
     })
     uiLog.info('Add device response:', resp)