@switchbot/homebridge-switchbot 5.0.0-beta.107 → 5.0.0-beta.109

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

@@ -0,0 +1,321 @@
+import type { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+
+import { RequestError } from '@homebridge/plugin-ui-utils'
+import fs from 'node:fs/promises'
+
+import { getAllDevices, getDeviceArrays, getSwitchBotPlatformConfig } from '../utils/config-parser.js'
+import { uiLog } from '../utils/logger.js'
+
+/**
+ * Register device CRUD endpoints
+ */
+export function registerDeviceEndpoints(server: HomebridgePluginUiServer) {
+  /**
+   * POST /add-device - Add a single device to config
+   */
+  server.onRequest('/add-device', async (body: any) => {
+    try {
+      const { deviceId, name, type } = body
+
+      if (!deviceId) {
+        throw new Error('Device ID is required')
+      }
+
+      const { cfg, platform, cfgPath } = await getSwitchBotPlatformConfig(server)
+
+      uiLog.info('POST /add-device - Request received')
+      uiLog.debug(`POST /add-device - Request body: ${JSON.stringify(body)}`)
+      uiLog.debug(`POST /add-device - Config file path: ${cfgPath}`)
+
+      const deviceArrays = getDeviceArrays(platform)
+      const allDevices = getAllDevices(platform)
+
+      const normalizedDeviceId = String(deviceId).trim().toLowerCase()
+      const exists = allDevices.some((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+      if (exists) {
+        uiLog.info(`POST /add-device - Device already exists: ${deviceId}`)
+        return {
+          success: true,
+          data: {
+            message: 'Device already in config',
+            alreadyExists: true,
+          },
+        }
+      }
+
+      let addCount = 0
+      for (const ref of deviceArrays) {
+        const refHasDevice = ref.some((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+        if (!refHasDevice) {
+          const newDevice = {
+            deviceId,
+            configDeviceName: name,
+            configDeviceType: type,
+          }
+          ref.push(newDevice)
+          addCount++
+        }
+      }
+
+      if (!addCount) {
+        return {
+          success: false,
+          data: { message: 'Failed to add device to config' },
+        }
+      }
+
+      const configJson = JSON.stringify(cfg, null, 2)
+      const fileHandle = await fs.open(cfgPath, 'w')
+      try {
+        await fileHandle.writeFile(configJson, 'utf8')
+        await fileHandle.sync()
+      } finally {
+        await fileHandle.close()
+      }
+
+      // Notify Homebridge UI that config changed
+      server.pushEvent('configChanged', { source: 'switchbot-plugin' })
+      uiLog.debug('POST /add-device - Sent configChanged event to UI')
+
+      return {
+        success: true,
+        data: {
+          message: `Device "${name}" added successfully`,
+          alreadyExists: false,
+          added: true,
+        },
+      }
+    } catch (e) {
+      uiLog.error(`Error in /add-device: ${e instanceof Error ? e.message : String(e)}`)
+      throw new RequestError(`Failed to add device: ${e instanceof Error ? e.message : String(e)}`, e)
+    }
+  })
+
+  /**
+   * POST /add-devices - Add multiple devices to config (bulk add)
+   */
+  server.onRequest('/add-devices', async (body: any) => {
+    try {
+      const { devices } = body
+
+      if (!Array.isArray(devices) || devices.length === 0) {
+        throw new Error('Devices array is required and must not be empty')
+      }
+
+      const { cfg, platform, cfgPath } = await getSwitchBotPlatformConfig(server)
+      uiLog.debug(`POST /add-devices - Received ${devices.length} device(s) to add`)
+      uiLog.debug(`POST /add-devices - Config path: ${cfgPath}`)
+      
+      const deviceArrays = getDeviceArrays(platform)
+      const allDevices = getAllDevices(platform)
+      
+      uiLog.debug(`POST /add-devices - Device arrays count: ${deviceArrays.length}, existing devices: ${allDevices.length}`)
+      uiLog.debug(`POST /add-devices - Platform.devices exists: ${!!platform.devices}, length: ${platform.devices?.length || 0}`)
+
+      let addedCount = 0
+      let skippedCount = 0
+      const results: Array<Record<string, any>> = []
+
+      for (const { deviceId, name, type } of devices) {
+        if (!deviceId) {
+          results.push({ deviceId: '?', success: false, message: 'Device ID is required' })
+          skippedCount++
+          continue
+        }
+
+        const normalizedDeviceId = String(deviceId).trim().toLowerCase()
+        const exists = allDevices.some((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+
+        if (exists) {
+          uiLog.debug(`POST /add-devices - Device already exists: ${deviceId}`)
+          results.push({ deviceId, success: true, message: 'Already in config', alreadyExists: true })
+          skippedCount++
+          continue
+        }
+
+        let addedToArray = false
+        for (const ref of deviceArrays) {
+          const refHasDevice = ref.some((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+          if (!refHasDevice) {
+            const newDevice = {
+              deviceId,
+              configDeviceName: name,
+              configDeviceType: type,
+            }
+            ref.push(newDevice)
+            addedToArray = true
+            uiLog.debug(`POST /add-devices - Added device to array: ${deviceId} (${name}, ${type})`)
+          }
+        }
+
+        if (addedToArray) {
+          results.push({ deviceId, success: true, message: `Device "${name}" added` })
+          addedCount++
+        } else {
+          uiLog.warn(`POST /add-devices - Failed to add device: ${deviceId}`)
+          results.push({ deviceId, success: false, message: 'Failed to add device' })
+          skippedCount++
+        }
+      }
+
+      uiLog.info(`POST /add-devices - Adding ${addedCount} devices to config: ${cfgPath}`)
+      const configJson = JSON.stringify(cfg, null, 2)
+      const fileHandle = await fs.open(cfgPath, 'w')
+      try {
+        await fileHandle.writeFile(configJson, 'utf8')
+        await fileHandle.sync()
+        uiLog.info(`POST /add-devices - Config file written successfully`)
+      } finally {
+        await fileHandle.close()
+      }
+
+      // Notify Homebridge UI that config changed to prevent cache overwrite
+      server.pushEvent('configChanged', { source: 'switchbot-plugin' })
+      uiLog.debug('POST /add-devices - Sent configChanged event to UI')
+
+      return {
+        success: true,
+        data: {
+          message: `Added ${addedCount} device(s)${skippedCount > 0 ? ` (${skippedCount} skipped)` : ''}`,
+          addedCount,
+          skippedCount,
+          results,
+        },
+      }
+    } catch (e) {
+      const errorMsg = e instanceof Error ? e.message : String(e)
+      uiLog.error(`Error in /add-devices: ${errorMsg}`)
+      if (e instanceof Error && e.stack) {
+        uiLog.debug(`Stack trace: ${e.stack}`)
+      }
+      throw new RequestError(`Failed to add devices: ${errorMsg}`, e)
+    }
+  })
+
+  /**
+   * POST /update-device - Update existing device in config
+   */
+  server.onRequest('/update-device', async (body: any) => {
+    try {
+      const { deviceId, configDeviceName, configDeviceType, connectionPreference, room } = body
+
+      if (!deviceId) {
+        throw new Error('Device ID is required')
+      }
+
+      const { cfg, platform, cfgPath } = await getSwitchBotPlatformConfig(server)
+      const deviceArrays = getDeviceArrays(platform)
+      const devices = getAllDevices(platform)
+
+      const normalizedDeviceId = String(deviceId).trim().toLowerCase()
+      const device = devices.find((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+      if (!device) {
+        throw new Error('Device not found in config')
+      }
+
+      for (const ref of deviceArrays) {
+        for (const entry of ref) {
+          const entryId = String(entry.deviceId ?? entry.id ?? '').trim().toLowerCase()
+          if (entryId !== normalizedDeviceId) {
+            continue
+          }
+
+          if (configDeviceName !== undefined && configDeviceName !== null && String(configDeviceName).trim() !== '') {
+            entry.configDeviceName = configDeviceName
+          }
+          if (configDeviceType !== undefined && configDeviceType !== null && String(configDeviceType).trim() !== '') {
+            entry.configDeviceType = configDeviceType
+          }
+          if (connectionPreference !== undefined) {
+            entry.connectionPreference = connectionPreference
+          }
+          if (room !== undefined) {
+            entry.room = room || undefined
+          }
+        }
+      }
+
+      const configJson = JSON.stringify(cfg, null, 2)
+      const fileHandle = await fs.open(cfgPath, 'w')
+      try {
+        await fileHandle.writeFile(configJson, 'utf8')
+        await fileHandle.sync()
+      } finally {
+        await fileHandle.close()
+      }
+
+      // Notify Homebridge UI that config changed
+      server.pushEvent('configChanged', { source: 'switchbot-plugin' })
+      uiLog.debug('POST /update-device - Sent configChanged event to UI')
+
+      return {
+        success: true,
+        data: { message: `Device updated successfully - type: ${configDeviceType || device.configDeviceType}` },
+      }
+    } catch (e) {
+      uiLog.error(`Error in /update-device: ${e instanceof Error ? e.message : String(e)}`)
+      throw new RequestError(`Failed to update device: ${e instanceof Error ? e.message : String(e)}`, e)
+    }
+  })
+
+  /**
+   * POST /delete-device - Remove device from config
+   */
+  server.onRequest('/delete-device', async (body: any) => {
+    try {
+      const { deviceId } = body
+      uiLog.info(`POST /delete-device - Requested deviceId: ${deviceId ?? 'undefined'}`)
+
+      if (!deviceId) {
+        throw new Error('Device ID is required')
+      }
+
+      const { cfg, platform, cfgPath } = await getSwitchBotPlatformConfig(server)
+      const deviceArrays = getDeviceArrays(platform)
+      const normalizedDeviceId = String(deviceId).trim().toLowerCase()
+      const allDevices = getAllDevices(platform)
+
+      const existing = allDevices.find((d: any) => String(d.deviceId ?? d.id ?? '').trim().toLowerCase() === normalizedDeviceId)
+      if (!existing) {
+        throw new Error('Device not found in config')
+      }
+
+      const deviceName = existing.configDeviceName || deviceId
+      let removedCount = 0
+      for (const ref of deviceArrays) {
+        for (let i = ref.length - 1; i >= 0; i--) {
+          const id = String(ref[i]?.deviceId ?? ref[i]?.id ?? '').trim().toLowerCase()
+          if (id === normalizedDeviceId) {
+            ref.splice(i, 1)
+            removedCount++
+          }
+        }
+      }
+
+      if (!removedCount) {
+        throw new Error('Device not found in config')
+      }
+
+      const configJson = JSON.stringify(cfg, null, 2)
+      const fileHandle = await fs.open(cfgPath, 'w')
+      try {
+        await fileHandle.writeFile(configJson, 'utf8')
+        await fileHandle.sync()
+      } finally {
+        await fileHandle.close()
+      }
+
+      // Notify Homebridge UI that config changed
+      server.pushEvent('configChanged', { source: 'switchbot-plugin' })
+      uiLog.debug('DELETE /delete-device - Sent configChanged event to UI')
+
+      return {
+        success: true,
+        data: { message: `Device "${deviceName}" removed from config` },
+      }
+    } catch (e) {
+      uiLog.error(`Error in /delete-device: ${e instanceof Error ? e.message : String(e)}`)
+      throw new RequestError('Failed to delete device', e)
+    }
+  })
+}

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

@@ -0,0 +1,191 @@
+import type { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils'
+
+import { RequestError } from '@homebridge/plugin-ui-utils'
+
+import { getCredential, getSwitchBotPlatformConfig } from '../utils/config-parser.js'
+import { uiLog } from '../utils/logger.js'
+
+/**
+ * Register discovery endpoint
+ * Discovers SwitchBot devices via BLE and OpenAPI
+ */
+export function registerDiscoveryEndpoint(server: HomebridgePluginUiServer) {
+  server.onRequest('/discover', async () => {
+    try {
+      const { platform } = await getSwitchBotPlatformConfig(server)
+
+      uiLog.debug(`GET /discover - Platform config keys: ${Object.keys(platform).join(', ')}`)
+
+      const token = getCredential(platform, 'openApiToken') || platform.token
+      const secret = getCredential(platform, 'openApiSecret') || platform.secret
+
+      const hasOpenAPICredentials = !!token
+
+      if (!hasOpenAPICredentials) {
+        uiLog.warn('GET /discover - No OpenAPI credentials found, will attempt BLE-only discovery')
+      } else {
+        uiLog.info('GET /discover - Using OpenAPI credentials for discovery')
+      }
+
+      // Import and initialize node-switchbot
+      const { SwitchBot } = await import('node-switchbot')
+      const switchbot = new SwitchBot({
+        token: token || undefined,
+        secret: secret || undefined,
+        enableBLE: true,
+        enableFallback: true,
+        enableRetry: true,
+      })
+
+      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 (!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')
+
+            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')
+        }
+      } 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) {
+        uiLog.info('GET /discover - Fetching devices from OpenAPI...')
+        try {
+          const apiClient = switchbot.getAPIClient()
+          if (!apiClient) {
+            throw new Error('API client not available - token/secret may be missing')
+          }
+          const apiData = await apiClient.getDevices()
+          uiLog.debug(`GET /discover - OpenAPI response: ${JSON.stringify(apiData)}`)
+
+          // Parse physical devices - apiData is DeviceListResponse with deviceList and infraredRemoteList
+          const devices = apiData.deviceList || []
+          const irDevices = apiData.infraredRemoteList || []
+
+          uiLog.info(`GET /discover - Found ${devices.length} OpenAPI physical devices and ${irDevices.length} IR devices`)
+
+          // Process physical devices from OpenAPI
+          for (const d of devices) {
+            const id = d.deviceId
+            if (!id) {
+              continue
+            }
+
+            const existing = deviceMap.get(id)
+            if (existing) {
+              // Device found via both BLE and OpenAPI
+              existing.connectionType = 'Both'
+              existing.name = d.deviceName || existing.name
+              existing.type = d.deviceType || existing.type
+              // Note: APIDevice doesn't have a model property
+              existing.enabled = d.enableCloudService !== false
+              existing.hubDeviceId = d.hubDeviceId
+            } else {
+              // Device only found via OpenAPI
+              deviceMap.set(id, {
+                id,
+                name: d.deviceName || id,
+                type: d.deviceType || 'unknown',
+                enabled: d.enableCloudService !== false,
+                hubDeviceId: d.hubDeviceId,
+                connectionType: 'OpenAPI',
+              })
+            }
+          }
+
+          // Process IR devices (OpenAPI only)
+          for (const d of irDevices) {
+            const id = d.deviceId
+            if (!id) {
+              continue
+            }
+
+            deviceMap.set(id, {
+              id,
+              name: d.deviceName || id,
+              type: d.remoteType || 'unknown',
+              enabled: true,
+              hubDeviceId: d.hubDeviceId,
+              connectionType: 'OpenAPI',
+              isIR: true,
+            })
+          }
+        } catch (apiErr) {
+          uiLog.error(`GET /discover - OpenAPI discovery failed: ${apiErr instanceof Error ? apiErr.message : String(apiErr)}`)
+          // If we have BLE devices, we can still return those
+          if (deviceMap.size === 0) {
+            throw apiErr
+          }
+        }
+      } else {
+        uiLog.info('GET /discover - Skipping OpenAPI discovery (no credentials configured)')
+      }
+
+      const normalizedBleDevices = [...deviceMap.values()].filter(d => d.connectionType === 'BLE' || d.connectionType === 'Both')
+      const firstNormalizedBleId = normalizedBleDevices[0]?.id || 'none'
+      uiLog.info(`GET /discover - Normalized BLE devices: ${normalizedBleDevices.length} (firstId: ${firstNormalizedBleId})`)
+
+      // Check if we found any devices
+      if (deviceMap.size === 0) {
+        const errorMsg = hasOpenAPICredentials
+          ? 'No devices found via BLE or OpenAPI. Make sure devices are powered on and in range.'
+          : 'No devices found via BLE. OpenAPI credentials not configured. Please save your credentials in settings to discover cloud-connected devices, or ensure BLE devices are powered on and in range.'
+        uiLog.error(`GET /discover - ${errorMsg}`)
+        throw new Error(errorMsg)
+      }
+
+      // Convert map to array
+      const allDiscovered = [...deviceMap.values()]
+
+      const bleCount = allDiscovered.filter(d => d.connectionType === 'BLE').length
+      const apiCount = allDiscovered.filter(d => d.connectionType === 'OpenAPI').length
+      const bothCount = allDiscovered.filter(d => d.connectionType === 'Both').length
+
+      uiLog.info(`GET /discover - Total: ${allDiscovered.length} devices (BLE: ${bleCount}, OpenAPI: ${apiCount}, Both: ${bothCount})`)
+      return { success: true, data: allDiscovered }
+    } catch (e) {
+      uiLog.error(`Error in /discover: ${e instanceof Error ? e.message : String(e)}`)
+      throw new RequestError(`Failed to discover devices: ${e instanceof Error ? e.message : String(e)}`, e)
+    }
+  })
+}