@switchbot/homebridge-switchbot 5.0.0-beta.11 → 5.0.0-beta.111

package/scripts/e2e/light-advanced-e2e.sh

@@ -0,0 +1,97 @@
+#!/usr/bin/env bash
+# Advanced light E2E helper: exercises On/Off, Brightness steps, Color Temperature and RGB color where supported.
+# Usage:
+# 1) Ensure Homebridge is running and the plugin is installed/linked.
+# 2) Populate `HB_URL`, `HB_TOKEN`, and `ACCESSORY_ID` below (or export them).
+# 3) Run: `bash scripts/e2e/light-advanced-e2e.sh`
+
+set -euo pipefail
+
+: ${HB_URL:="http://localhost:8581"}
+: ${HB_TOKEN:=""}
+: ${ACCESSORY_ID:=""}
+: ${ACCESSORY_NAME:=""}
+
+# Resolve accessory id (aid) from Homebridge API when ACCESSORY_NAME supplied
+resolve_accessory_id() {
+  if [[ -n "$ACCESSORY_ID" ]]; then
+    return 0
+  fi
+  if [[ -z "$ACCESSORY_NAME" ]]; then
+    return 1
+  fi
+  local resp
+  resp=$(curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}/api/accessories") || return 1
+  ACCESSORY_ID=$(printf '%s' "$resp" | node -e "const fs=require('fs');const name=process.argv[1];const j=JSON.parse(fs.readFileSync(0,'utf8'));const arr=Array.isArray(j)?j:(j.accessories||j);for(const a of arr||[]){if(a.displayName===name||a.name===name||(a.context&&a.context.deviceId===name)){if(a.aid){console.log(a.aid);process.exit(0);}else if(a.UUID){console.log(a.UUID);process.exit(0);}}}process.exit(1);" "$ACCESSORY_NAME") || return 1
+  return 0
+}
+
+if [[ -z "$HB_TOKEN" ]]; then
+  echo "Please set HB_TOKEN environment variable or edit the top of this script."
+  exit 1
+fi
+
+if [[ -z "$ACCESSORY_ID" ]]; then
+  if resolve_accessory_id; then
+    echo "Discovered ACCESSORY_ID=${ACCESSORY_ID} for name '${ACCESSORY_NAME}'"
+  else
+    echo "No ACCESSORY_ID or ACCESSORY_NAME resolved. Please set one." && exit 1
+  fi
+fi
+
+echo "Running advanced light E2E script against $HB_URL (accessory $ACCESSORY_ID)"
+
+curl_common() {
+  local method="$1" path="$2" data="$3"
+  if [[ "$method" == "GET" ]]; then
+    curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}${path}"
+  else
+    curl -sS -X "$method" -H "Authorization: Bearer ${HB_TOKEN}" -H "Content-Type: application/json" -d "$data" "${HB_URL}${path}"
+  fi
+}
+
+echo "1) Fetch accessories listing"
+curl_common GET "/api/accessories" ""
+
+echo
+echo "2) Toggle On"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":true}] }'
+sleep 1
+
+echo
+echo "3) Brightness sweep: 10% -> 50% -> 100%"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":12,"value":10}] }'
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":12,"value":50}] }'
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":12,"value":100}] }'
+sleep 1
+
+echo
+echo "4) Color Temperature test (if supported): 2700K -> 4000K -> 6500K"
+# HomeKit uses Mireds for color temperature; approximate conversions used here
+MIREDS_2700=370
+MIREDS_4000=250
+MIREDS_6500=154
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" "{ \"characteristics\": [{\"aid\":1,\"iid\":14,\"value\":${MIREDS_2700}}] }"
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" "{ \"characteristics\": [{\"aid\":1,\"iid\":14,\"value\":${MIREDS_4000}}] }"
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" "{ \"characteristics\": [{\"aid\":1,\"iid\":14,\"value\":${MIREDS_6500}}] }"
+sleep 1
+
+echo
+echo "5) Color (RGB) test (if supported): Red -> Green -> Blue"
+# Many HomeKit bridges expose Hue (iid 15) and Saturation (iid 16). We'll set hue and sat values accordingly.
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":15,"value":0},{"aid":1,"iid":16,"value":100}] }'
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":15,"value":120},{"aid":1,"iid":16,"value":100}] }'
+sleep 1
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":15,"value":240},{"aid":1,"iid":16,"value":100}] }'
+sleep 1
+
+echo
+echo "6) Toggle Off"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":false}] }'
+
+echo "Done. Review Homebridge logs and physical device behavior."

package/scripts/e2e/light-e2e.sh

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+# Lightweight automated E2E helper for lights.
+# Usage:
+# 1) Ensure Homebridge is running and the plugin is installed/linked.
+# 2) Populate `HB_URL`, `HB_TOKEN`, and `ACCESSORY_ID` below (or export them).
+# 3) Run: `bash scripts/e2e/light-e2e.sh`
+
+set -euo pipefail
+
+: ${HB_URL:="http://localhost:8581"}
+: ${HB_TOKEN:=""}
+: ${ACCESSORY_ID:=""}
+: ${ACCESSORY_NAME:=""}
+
+# Resolve accessory id (aid) from Homebridge API when ACCESSORY_NAME supplied
+resolve_accessory_id() {
+  if [[ -n "$ACCESSORY_ID" ]]; then
+    return 0
+  fi
+  if [[ -z "$ACCESSORY_NAME" ]]; then
+    return 1
+  fi
+  local resp
+  resp=$(curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}/api/accessories") || return 1
+  ACCESSORY_ID=$(printf '%s' "$resp" | node -e "const fs=require('fs');const name=process.argv[1];const j=JSON.parse(fs.readFileSync(0,'utf8'));const arr=Array.isArray(j)?j:(j.accessories||j);for(const a of arr||[]){if(a.displayName===name||a.name===name||(a.context&&a.context.deviceId===name)){if(a.aid){console.log(a.aid);process.exit(0);}else if(a.UUID){console.log(a.UUID);process.exit(0);}}}process.exit(1);" "$ACCESSORY_NAME") || return 1
+  return 0
+}
+
+if [[ -z "$HB_TOKEN" ]]; then
+  echo "Please set HB_TOKEN environment variable or edit the top of this script."
+  exit 1
+fi
+
+if [[ -z "$ACCESSORY_ID" ]]; then
+  if resolve_accessory_id; then
+    echo "Discovered ACCESSORY_ID=${ACCESSORY_ID} for name '${ACCESSORY_NAME}'"
+  else
+    echo "No ACCESSORY_ID or ACCESSORY_NAME resolved. Please set one." && exit 1
+  fi
+fi
+
+echo "Running light E2E script against $HB_URL (accessory $ACCESSORY_ID)"
+
+curl_common() {
+  local method="$1" path="$2" data="$3"
+  if [[ "$method" == "GET" ]]; then
+    curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}${path}"
+  else
+    curl -sS -X "$method" -H "Authorization: Bearer ${HB_TOKEN}" -H "Content-Type: application/json" -d "$data" "${HB_URL}${path}"
+  fi
+}
+
+echo "1) Fetch accessories listing (to verify connectivity)"
+curl_common GET "/api/accessories" ""
+
+echo
+echo "2) Toggle On"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":true}] }'
+sleep 1
+
+echo
+echo "3) Set Brightness to 25%"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":12,"value":25}] }'
+sleep 1
+
+echo
+echo "4) Set Brightness to 100%"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":12,"value":100}] }'
+sleep 1
+
+echo
+echo "5) Toggle Off"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":false}] }'
+
+echo "Done. Review Homebridge logs and physical device behavior."

package/scripts/e2e/list-accessories.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+# List accessories from Homebridge UI and print name, aid/UUID, and context.deviceId
+# Usage:
+#   export HB_URL=http://localhost:8581
+#   export HB_TOKEN=your_token
+#   bash scripts/e2e/list-accessories.sh
+
+set -euo pipefail
+
+: ${HB_URL:="http://localhost:8581"}
+: ${HB_TOKEN:=""}
+
+if [[ -z "$HB_TOKEN" ]]; then
+  echo "Please set HB_TOKEN environment variable (Homebridge UI token)."
+  exit 1
+fi
+
+resp=$(curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}/api/accessories")
+node -e "const fs=require('fs');const j=JSON.parse(fs.readFileSync(0,'utf8'));const arr=Array.isArray(j)?j:(j.accessories||j)||[];console.log('Name | aid/UUID | context.deviceId');for(const a of arr){const name=a.displayName||a.name||'(unknown)';const id=a.aid||a.UUID||'';const ctx=(a.context&&a.context.deviceId)||'';console.log(`${name} | ${id} | ${ctx}`);}" <<< "$resp"

package/scripts/e2e/lock-e2e.sh

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+# Lightweight automated E2E helper for locks.
+# Usage:
+# 1) Ensure Homebridge is running and the plugin is installed/linked.
+# 2) Populate `HB_URL`, `HB_TOKEN`, and `ACCESSORY_ID` below (or export them).
+# 3) Run: `bash scripts/e2e/lock-e2e.sh`
+
+set -euo pipefail
+
+: ${HB_URL:="http://localhost:8581"}
+: ${HB_TOKEN:=""}
+: ${ACCESSORY_ID:=""}
+: ${ACCESSORY_NAME:=""}
+
+# Resolve accessory id (aid) from Homebridge API when ACCESSORY_NAME supplied
+resolve_accessory_id() {
+  if [[ -n "$ACCESSORY_ID" ]]; then
+    return 0
+  fi
+  if [[ -z "$ACCESSORY_NAME" ]]; then
+    return 1
+  fi
+  local resp
+  resp=$(curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}/api/accessories") || return 1
+  ACCESSORY_ID=$(printf '%s' "$resp" | node -e "const fs=require('fs');const name=process.argv[1];const j=JSON.parse(fs.readFileSync(0,'utf8'));const arr=Array.isArray(j)?j:(j.accessories||j);for(const a of arr||[]){if(a.displayName===name||a.name===name||(a.context&&a.context.deviceId===name)){if(a.aid){console.log(a.aid);process.exit(0);}else if(a.UUID){console.log(a.UUID);process.exit(0);}}}process.exit(1);" "$ACCESSORY_NAME") || return 1
+  return 0
+}
+
+if [[ -z "$HB_TOKEN" ]]; then
+  echo "Please set HB_TOKEN environment variable or edit the top of this script."
+  exit 1
+fi
+
+if [[ -z "$ACCESSORY_ID" ]]; then
+  if resolve_accessory_id; then
+    echo "Discovered ACCESSORY_ID=${ACCESSORY_ID} for name '${ACCESSORY_NAME}'"
+  else
+    echo "No ACCESSORY_ID or ACCESSORY_NAME resolved. Please set one." && exit 1
+  fi
+fi
+
+echo "Running lock E2E script against $HB_URL (accessory $ACCESSORY_ID)"
+
+curl_common() {
+  local method="$1" path="$2" data="$3"
+  if [[ "$method" == "GET" ]]; then
+    curl -sS -H "Authorization: Bearer ${HB_TOKEN}" "${HB_URL}${path}"
+  else
+    curl -sS -X "$method" -H "Authorization: Bearer ${HB_TOKEN}" -H "Content-Type: application/json" -d "$data" "${HB_URL}${path}"
+  fi
+}
+
+echo "1) Fetch accessories listing"
+curl_common GET "/api/accessories" ""
+
+echo
+echo "2) Lock"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":1}] }'
+sleep 1
+
+echo
+echo "3) Unlock"
+curl_common POST "/api/accessories/${ACCESSORY_ID}/characteristics" '{ "characteristics": [{"aid":1,"iid":11,"value":0}] }'
+
+echo "Done. Review Homebridge logs and physical device behavior."

package/scripts/free-dev-ports.mjs

@@ -0,0 +1,105 @@
+import { execSync } from 'node:child_process'
+import { readFileSync } from 'node:fs'
+import { homedir } from 'node:os'
+import { resolve } from 'node:path'
+
+function resolvePorts() {
+  let bridgePort = 51829
+  let uiPort = 8581
+
+  try {
+    const configPath = resolve(homedir(), '.homebridge-dev', 'config.json')
+    const config = JSON.parse(readFileSync(configPath, 'utf8'))
+
+    if (typeof config?.bridge?.port === 'number') {
+      bridgePort = config.bridge.port
+    }
+
+    const configUiPlatform = Array.isArray(config?.platforms)
+      ? config.platforms.find(platform => platform?.platform === 'config')
+      : undefined
+
+    if (typeof configUiPlatform?.port === 'number') {
+      uiPort = configUiPlatform.port
+    }
+  } catch {}
+
+  return [...new Set([bridgePort, uiPort])]
+}
+
+function pidsForPort(port) {
+  try {
+    const output = execSync(`lsof -ti tcp:${port}`, { stdio: ['ignore', 'pipe', 'ignore'] }).toString().trim()
+    return output ? output.split('\n').filter(Boolean) : []
+  } catch {
+    return []
+  }
+}
+
+function freePort(port) {
+  const initialPids = pidsForPort(port)
+  if (initialPids.length === 0) {
+    return
+  }
+
+  try {
+    execSync(`lsof -ti tcp:${port} | xargs -r kill -TERM`, { stdio: ['ignore', 'ignore', 'ignore'] })
+  } catch {}
+
+  const remainingPids = pidsForPort(port)
+  if (remainingPids.length > 0) {
+    try {
+      execSync(`lsof -ti tcp:${port} | xargs -r kill -KILL`, { stdio: ['ignore', 'ignore', 'ignore'] })
+    } catch {}
+  }
+}
+
+function cleanupDevProcesses() {
+  let output = ''
+  try {
+    output = execSync('ps -axo pid=,command=', { stdio: ['ignore', 'pipe', 'ignore'] }).toString()
+  } catch {
+    return
+  }
+
+  const targetPids = output
+    .split('\n')
+    .map(line => line.trim())
+    .filter(Boolean)
+    .map((line) => {
+      const firstSpace = line.indexOf(' ')
+      if (firstSpace === -1) {
+        return null
+      }
+
+      const pid = Number(line.slice(0, firstSpace).trim())
+      const command = line.slice(firstSpace + 1)
+      return Number.isFinite(pid) ? { pid, command } : null
+    })
+    .filter((entry) => {
+      if (!entry) {
+        return false
+      }
+
+      if (entry.pid === process.pid || entry.pid === process.ppid) {
+        return false
+      }
+
+      const isNodemonProcess = entry.command.includes('homebridge-switchbot/node_modules/.bin/nodemon')
+      const isConfigUiProcess = entry.command.trim().startsWith('homebridge-config-ui-x')
+      return isNodemonProcess || isConfigUiProcess
+    })
+    .map(entry => entry.pid)
+
+  for (const pid of targetPids) {
+    try {
+      process.kill(pid, 'SIGTERM')
+    } catch {}
+  }
+}
+
+cleanupDevProcesses()
+
+for (const port of resolvePorts()) {
+  freePort(port)
+}

package/scripts/generate-matter-maps.js

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+const fs = require('fs')
+const path = require('path')
+
+function usage() {
+  console.error('Usage: node scripts/generate-matter-maps.js <input-json> [output-file]')
+  process.exit(2)
+}
+
+const input = process.argv[2]
+const outFile = process.argv[3] || path.join(__dirname, '..', 'src', 'matter-maps.generated.ts')
+
+if (!input) usage()
+if (!fs.existsSync(input)) {
+  console.error('Input file not found:', input)
+  process.exit(2)
+}
+
+const json = JSON.parse(fs.readFileSync(input, 'utf8'))
+
+// Expecting structure: { clusters: [{ name, id, attributes: [{ name, id }, ...] }, ...] }
+const clusters = json.clusters || []
+
+const clusterMapEntries = []
+const attrGroups = {}
+
+for (const c of clusters) {
+  if (!c.name || typeof c.id === 'undefined') continue
+  const key = c.name.replace(/[^A-Za-z0-9_]/g, '')
+  clusterMapEntries.push(`  ${key}: 0x${parseInt(String(c.id), 10).toString(16)}`)
+  const attrs = {}
+  if (Array.isArray(c.attributes)) {
+    for (const a of c.attributes) {
+      if (!a.name || typeof a.id === 'undefined') continue
+      const an = a.name.replace(/[^A-Za-z0-9_]/g, '')
+      attrs[an] = `0x${parseInt(String(a.id), 10).toString(16)}`
+    }
+  }
+  if (Object.keys(attrs).length) attrGroups[key] = attrs
+}
+
+const clusterMap = `export const MATTER_CLUSTER_IDS = {
+${clusterMapEntries.join(',\n')}
+} as const
+\n`
+
+let attrText = 'export const MATTER_ATTRIBUTE_IDS = {\n'
+for (const [k, v] of Object.entries(attrGroups)) {
+  attrText += `  ${k}: {\n`
+  for (const [an, aid] of Object.entries(v)) {
+    attrText += `    ${an}: ${aid},\n`
+  }
+  attrText += `  },\n`
+}
+attrText += `} as const\n`
+
+const fileContent = `// GENERATED FILE - do not edit by hand.\n// Run: node scripts/generate-matter-maps.js <zap-matter.json>\n\n${clusterMap}\n${attrText}`
+
+fs.writeFileSync(outFile, fileContent, 'utf8')
+console.log('Wrote', outFile)

package/scripts/run-e2e-local.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# Wrapper to run the repository's E2E vitest harness locally.
+# Usage: export HB_URL HB_TOKEN [LIGHT_ACCESSORY_ID ...]; export RUN_E2E=1; bash scripts/run-e2e-local.sh
+
+set -euo pipefail
+
+: ${RUN_E2E:=1}
+
+echo "Running E2E vitest harness (RUN_E2E=${RUN_E2E})"
+
+# Run only the e2e spec file so the full unit test suite isn't executed
+npx vitest run test/e2e/run-e2e.spec.ts
+
+echo "E2E harness finished. Check logs for per-script output."

package/scripts/sync-device-types.mjs

@@ -0,0 +1,28 @@
+import fs from 'node:fs'
+import path from 'node:path'
+
+const root = process.cwd()
+const sourcePath = path.join(root, 'src/device-types.ts')
+const schemaPath = path.join(root, 'config.schema.json')
+
+const source = fs.readFileSync(sourcePath, 'utf8')
+const schemaRaw = fs.readFileSync(schemaPath, 'utf8')
+const schema = JSON.parse(schemaRaw)
+
+const match = source.match(/export const DEVICE_TYPES = (\{[\s\S]*?\}) as const/)
+if (!match) {
+  throw new Error('Could not find DEVICE_TYPES in src/device-types.ts')
+}
+
+const deviceTypesByCategory = Function(`return (${match[1]})`)()
+const enumValues = [...new Set(Object.values(deviceTypesByCategory).flat())]
+
+const configDeviceType = schema?.schema?.properties?.devices?.items?.properties?.configDeviceType
+if (!configDeviceType) {
+  throw new Error('Could not locate schema.properties.devices.items.properties.configDeviceType')
+}
+
+configDeviceType.enum = enumValues
+
+fs.writeFileSync(schemaPath, `${JSON.stringify(schema, null, 2)}\n`, 'utf8')
+console.log(`Synchronized ${enumValues.length} device types into config.schema.json`)