@mp-consulting/homebridge-unifi-access 1.0.0

package/.claude/settings.local.json

@@ -0,0 +1,91 @@
+{
+  "includeCoAuthoredBy": false,
+  "permissions": {
+    "allow": [
+      "Bash(npm audit)",
+      "Bash(npm install --save-dev homebridge-config-ui-x)",
+      "Bash(npm ls homebridge-config-ui-x --depth=0)",
+      "Bash(npm run start)",
+      "Bash(npm run build)",
+      "Bash(npm run lint)",
+      "Bash(lsof -i :8581)",
+      "Bash(npm install --save-dev homebridge-config-ui-x@^4.6.7)",
+      "Bash(find /Users/mickael/Documents/dev/homebridge-unifi-access/src -type f -name \"*.ts\" -exec wc -l {} +)",
+      "Bash(kill 77941)",
+      "Bash(npm run --workspaces list)",
+      "Bash(npm script)",
+      "Bash(wc -l src/*.ts)",
+      "Bash(npx tsc --noEmit)",
+      "Bash(npx eslint src/access-hub.ts src/access-hub-types.ts)",
+      "Bash(npm ls -g --depth=0)",
+      "Bash(npx eslint src/access-hub.ts src/access-events.ts src/access-controller.ts src/access-types.ts)",
+      "Bash(claude mcp add chrome-devtools --scope user npx chrome-devtools-mcp@latest)",
+      "Bash(npm root -g)",
+      "Bash(mdfind -name \"claude\" -onlyin /usr/local)",
+      "Bash(mdfind -name \"claude\" -onlyin /opt)",
+      "Bash(ls -la /Users/mickael/.npm/_npx/*/node_modules/.bin/claude)",
+      "Bash(ls -la /Users/mickael/.npm/_npx/*/node_modules/@anthropic-ai/claude-code/cli.js)",
+      "Bash(npm install -g @anthropic-ai/claude-code)",
+      "Bash(npx eslint src/access-hub.ts src/access-events.ts src/access-controller.ts src/access-types.ts src/access-hub-types.ts)",
+      "Bash(npm install -D vitest @vitest/coverage-v8)",
+      "Bash(sudo chown -R 501:20 \"/Users/mickael/.npm\")",
+      "Bash(npm install -D vitest @vitest/coverage-v8 --cache /tmp/npm-cache)",
+      "Bash(npm test)",
+      "Bash(npx chrome-devtools-mcp@latest --help 2>&1 | head -20)",
+      "Bash(source ~/.nvm/nvm.sh && nvm install 22.12.0 && nvm use 22.12.0 && node --version)",
+      "Bash(brew upgrade node 2>&1)",
+      "Bash(npx vitest run tests/access-device.test.ts)",
+      "Bash(npx vitest run)",
+      "Bash(npx vitest run tests/access-platform.test.ts)",
+      "Bash(npx vitest run tests/access-controller.test.ts tests/access-events.test.ts)",
+      "Bash(grep -r \"service\\\\|broadcast\\\\|mdns\\\\|discover\" /Users/mickael/Documents/dev/homebridge-unifi-access/node_modules/unifi-access/dist/*.js 2>/dev/null | head -20)",
+      "WebSearch",
+      "Bash(npm install bonjour-service 2>&1)",
+      "Bash(npx vitest run tests/access-hub.test.ts)",
+      "Bash(node -e \"import Bonjour from 'bonjour-service'; console.log\\(typeof Bonjour, Object.keys\\(Bonjour\\)\\)\" 2>&1 || node -e \"const b = await import\\('bonjour-service'\\); console.log\\(Object.keys\\(b\\)\\)\" 2>&1)",
+      "Bash(node -e \"\nimport { Bonjour } from 'bonjour-service';\nconst bonjour = new Bonjour\\(\\);\nconst browser = bonjour.find\\({ type: 'http' }\\);\nbrowser.on\\('up', \\(service\\) => {\n  const ip = service.addresses?.find\\(a => /^\\\\d+\\\\.\\\\d+\\\\.\\\\d+\\\\.\\\\d+$/.test\\(a\\)\\);\n  console.log\\('Found:', service.name, ip, service.host\\);\n}\\);\nsetTimeout\\(\\(\\) => { browser.stop\\(\\); bonjour.destroy\\(\\); console.log\\('Done'\\); process.exit\\(0\\); }, 6000\\);\n\" 2>&1)",
+      "Bash(wc -l /Users/mickael/Documents/dev/homebridge-unifi-access/src/*.ts)",
+      "Bash(node -e \"\nimport { Bonjour } from 'bonjour-service';\nconst bonjour = new Bonjour\\(\\);\n// Try all common UniFi service types\nconst types = ['unifi', 'ubnt', 'ubiquiti', 'unifi-access'];\ntypes.forEach\\(type => {\n  const browser = bonjour.find\\({ type }\\);\n  browser.on\\('up', \\(s\\) => console.log\\('Found [' + type + ']:', s.name, s.addresses, s.host\\)\\);\n}\\);\nsetTimeout\\(\\(\\) => { bonjour.destroy\\(\\); console.log\\('Done scanning specific types'\\); process.exit\\(0\\); }, 6000\\);\n\" 2>&1)",
+      "Bash(npm search ubiquiti discovery 2>&1 | head -20; echo \"---\"; npm search ubnt discovery 2>&1 | head -10; echo \"---\"; npm search unifi discover 2>&1 | head -10)",
+      "Bash(node -e \"\nimport dgram from 'node:dgram';\nconst socket = dgram.createSocket\\({ type: 'udp4', reuseAddr: true }\\);\nconst packet = Buffer.from\\([0x01, 0x00, 0x00, 0x00]\\);\nconst TLV = { MAC_IP: 0x02, FIRMWARE: 0x03, HOSTNAME: 0x0B, MODEL_SHORT: 0x0C, MODEL_LONG: 0x14 };\n\nsocket.on\\('message', \\(msg\\) => {\n  if \\(msg.length < 4\\) return;\n  const device = {};\n  let offset = 4;\n  while \\(offset + 3 <= msg.length\\) {\n    const type = msg[offset];\n    const length = msg.readUInt16BE\\(offset + 1\\);\n    offset += 3;\n    if \\(offset + length > msg.length\\) break;\n    const value = msg.subarray\\(offset, offset + length\\);\n    if \\(type === TLV.MAC_IP && length >= 10\\) {\n      device.mac = [...value.subarray\\(0, 6\\)].map\\(b => b.toString\\(16\\).padStart\\(2, '0'\\)\\).join\\(':'\\);\n      device.ip = value[6] + '.' + value[7] + '.' + value[8] + '.' + value[9];\n    }\n    if \\(type === TLV.HOSTNAME\\) device.hostname = value.toString\\('utf8'\\);\n    if \\(type === TLV.MODEL_SHORT\\) device.model = value.toString\\('utf8'\\);\n    if \\(type === TLV.MODEL_LONG\\) device.modelLong = value.toString\\('utf8'\\);\n    if \\(type === TLV.FIRMWARE\\) device.firmware = value.toString\\('utf8'\\);\n    offset += length;\n  }\n  console.log\\('Found:', JSON.stringify\\(device\\)\\);\n}\\);\n\nsocket.on\\('error', \\(e\\) => console.error\\('Error:', e.message\\)\\);\n\nsocket.bind\\(\\(\\) => {\n  socket.setBroadcast\\(true\\);\n  socket.send\\(packet, 0, packet.length, 10001, '255.255.255.255'\\);\n  console.log\\('Sent discovery packet...'\\);\n}\\);\n\nsetTimeout\\(\\(\\) => { socket.close\\(\\); console.log\\('Done'\\); process.exit\\(0\\); }, 5000\\);\n\" 2>&1)",
+      "Bash(npm uninstall bonjour-service 2>&1)",
+      "Bash(grep \"bonjour\" /Users/mickael/Documents/dev/homebridge-unifi-access/package.json; echo \"exit: $?\")",
+      "Bash(node -e \"\nimport dgram from 'node:dgram';\nconst socket = dgram.createSocket\\({ type: 'udp4', reuseAddr: true }\\);\nconst packet = Buffer.from\\([0x01, 0x00, 0x00, 0x00]\\);\nconst TLV = { MAC_IP: 0x02, FIRMWARE: 0x03, HOSTNAME: 0x0B, MODEL_SHORT: 0x0C, MODEL_LONG: 0x14 };\n\nsocket.on\\('message', \\(msg, rinfo\\) => {\n  if \\(msg.length < 4\\) return;\n  const device = {};\n  let offset = 4;\n  while \\(offset + 3 <= msg.length\\) {\n    const type = msg[offset];\n    const length = msg.readUInt16BE\\(offset + 1\\);\n    offset += 3;\n    if \\(offset + length > msg.length\\) break;\n    const value = msg.subarray\\(offset, offset + length\\);\n    if \\(type === TLV.MAC_IP && length >= 10\\) {\n      device.ip = value[6] + '.' + value[7] + '.' + value[8] + '.' + value[9];\n    }\n    if \\(type === TLV.HOSTNAME\\) device.hostname = value.toString\\('utf8'\\);\n    if \\(type === TLV.MODEL_SHORT\\) device.model = value.toString\\('utf8'\\);\n    offset += length;\n  }\n  console.log\\('Response from', rinfo.address, ':', JSON.stringify\\(device\\)\\);\n}\\);\n\nsocket.bind\\(\\(\\) => {\n  // Try direct probe and subnet broadcast\n  socket.setBroadcast\\(true\\);\n  socket.send\\(packet, 0, packet.length, 10001, '192.168.1.119'\\);\n  socket.send\\(packet, 0, packet.length, 10001, '192.168.1.255'\\);\n  console.log\\('Sent to 192.168.1.119 and 192.168.1.255...'\\);\n}\\);\n\nsetTimeout\\(\\(\\) => { socket.close\\(\\); console.log\\('Done'\\); process.exit\\(0\\); }, 5000\\);\n\" 2>&1)",
+      "Bash(node -e \"console.log\\(process.version\\)\")",
+      "Bash(npx eslint --fix homebridge-ui/server.js)",
+      "Bash(echo \"EXIT: $?\")",
+      "Bash(wc -l /Users/mickael/Documents/dev/homebridge-unifi-access/homebridge-ui/public/*.js /Users/mickael/Documents/dev/homebridge-unifi-access/homebridge-ui/public/*.mjs /Users/mickael/Documents/dev/homebridge-unifi-access/homebridge-ui/server.js)",
+      "Bash(grep -l \"homebridge-ui\\\\|public/\" /Users/mickael/Documents/dev/homebridge-unifi-access/tests/*.ts)",
+      "Bash(npx eslint --fix eslint.config.mjs src homebridge-ui/*.js homebridge-ui/public/*.js homebridge-ui/public/modules/*.js)",
+      "Bash(npx tsc --noEmit --skipLibCheck)",
+      "Bash(npx tsc --noEmit --skipLibCheck --exclude src/hub)",
+      "Bash(ls -la /Users/mickael/Documents/dev/homebridge-unifi-access/src/access-hub*)",
+      "Bash(grep -rn \"access-hub\" /Users/mickael/Documents/dev/homebridge-unifi-access/src/*.ts)",
+      "Bash(grep -rn \"AccessHub\" /Users/mickael/Documents/dev/homebridge-unifi-access/src/*.ts)",
+      "Bash(npx vitest run tests/access-event-schemas.test.ts)",
+      "Bash(npx tsc --noEmit --esModuleInterop --module ES2022 --moduleResolution node --target ES2023 --strict scripts/event-schema-monitor.ts)",
+      "Bash(npx tsx --version)",
+      "Bash(brew install poppler)",
+      "Bash(git -C /Users/mickael/Documents/dev/homebridge-unifi-access status)",
+      "Bash(git -C /Users/mickael/Documents/dev/homebridge-unifi-access diff --stat)",
+      "Bash(git -C /Users/mickael/Documents/dev/homebridge-unifi-access log --oneline -5)",
+      "Bash(git add .github/ .gitignore .npmignore LICENSE.md README.md config.schema.json docs/ eslint.config.mjs homebridge-ui/ nodemon.json package-lock.json package.json scripts/ src/ tests/ tsconfig.json vitest.config.ts)",
+      "Bash(git -C:*)",
+      "Bash(git branch -M main)",
+      "Bash(git remote add origin https://github.com/mp-consulting/homebridge-unifi-access.git)",
+      "Bash(git push -u origin main)",
+      "Bash(gh repo create mp-consulting/homebridge-unifi-access --public --description \"Complete HomeKit support for UniFi Access devices — locks, doorbells, sensors, and readers — with automatic device discovery and realtime events.\" --source . --push)",
+      "Bash(gh repo view mp-consulting/homebridge-unifi-access --json isEmpty,defaultBranchRef)",
+      "Bash(while read f)",
+      "Bash(do sed -i '' 's|Copyright\\(C\\) [0-9]\\\\{4\\\\}-2026, HJD \\(https://github.com/hjdhjd\\). All rights reserved.|Copyright\\(C\\) 2026, Mickael Palma. All rights reserved.|' \"$f\")",
+      "Bash(done)",
+      "Bash(python3 -c \"\nimport io, sys\n\n# Try to extract text using built-in approach\nwith open\\('/Users/mickael/Documents/dev/homebridge-unifi-access/docs/api_reference.pdf', 'rb'\\) as f:\n    content = f.read\\(\\)\n    # Look for text streams in the PDF\n    text_parts = []\n    i = 0\n    while i < len\\(content\\):\n        # Find text between BT and ET markers\n        bt = content.find\\(b'BT', i\\)\n        if bt == -1:\n            break\n        et = content.find\\(b'ET', bt\\)\n        if et == -1:\n            break\n        segment = content[bt:et+2]\n        # Extract text from Tj and TJ operators\n        import re\n        matches = re.findall\\(rb'\\\\\\(\\([^\\)]*\\)\\\\\\)', segment\\)\n        for m in matches:\n            try:\n                text_parts.append\\(m.decode\\('utf-8', errors='replace'\\)\\)\n            except:\n                pass\n        i = et + 2\n    print\\('\\\\\\\\n'.join\\(text_parts[:500]\\)\\)\n\" 2>&1 | head -200)",
+      "Bash(git commit:*)",
+      "Bash(git add CHANGELOG.md)",
+      "Bash(npx eslint .)",
+      "Bash(git add tests/access-event-schemas.test.ts)",
+      "Bash(npx eslint --no-warn-ignored src/ tests/ homebridge-ui/ scripts/ eslint.config.mjs)",
+      "Bash(git add eslint.config.mjs homebridge-ui/public/modules/feature-options.js)"
+    ]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 1.0.0 (2026-02-28)
+
+### Initial Release
+
+- Full HomeKit support for UniFi Access devices: locks, doorbells, door position sensors, terminal inputs (REL, REN, REX), and access method switches.
+- Automatic device discovery and realtime event handling via the UniFi Access events API.
+- Support for UA Hub, UA Hub Door Mini, UA Ultra, and UA Gate (including side door / pedestrian gate).
+- Access method switches for Face, Hand Wave, Mobile, NFC, PIN, QR, and Touch Pass.
+- Feature options system for granular per-device and per-controller control.
+- MQTT support for publishing and subscribing to device events.
+- Homebridge webUI plugin with controller discovery, setup wizard, and feature options editor.

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+===========
+
+Copyright (c) 2026 Mickael Palma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,159 @@
+<div align="center">
+
+![homebridge-unifi-access: Native HomeKit support for UniFi Access](docs/media/homebridge-unifi-access.svg)
+
+# Homebridge UniFi Access
+
+[![Downloads](https://img.shields.io/npm/dt/@mp-consulting/homebridge-unifi-access?color=%230559C9&logo=icloud&logoColor=%23FFFFFF&style=for-the-badge)](https://www.npmjs.com/package/@mp-consulting/homebridge-unifi-access)
+[![Version](https://img.shields.io/npm/v/@mp-consulting/homebridge-unifi-access?color=%230559C9&label=Latest%20Version&logo=ubiquiti&logoColor=%23FFFFFF&style=for-the-badge)](https://www.npmjs.com/package/@mp-consulting/homebridge-unifi-access)
+[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
+[![License](https://img.shields.io/npm/l/@mp-consulting/homebridge-unifi-access?color=%230559C9&logo=open%20source%20initiative&logoColor=%23FFFFFF&style=for-the-badge)](LICENSE.md)
+
+Complete HomeKit support for the [UniFi Access](https://ui.com/door-access) ecosystem using [Homebridge](https://homebridge.io).
+
+</div>
+
+## Table of Contents
+
+- [About](#about)
+- [Supported Devices](#supported-devices)
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## About
+
+`@mp-consulting/homebridge-unifi-access` is a [Homebridge](https://homebridge.io) plugin that provides HomeKit support for [Ubiquiti's](https://www.ui.com) [UniFi Access](https://ui.com/door-access) door access security platform — including doorbell, reader, lock, and controller hardware.
+
+This plugin discovers all your supported UniFi Access devices and makes them available in HomeKit with minimal configuration. It supports all known UniFi Access controller configurations (UniFi CloudKey Gen2+, UniFi Dream Machine Pro/SE, UniFi NVR, etc.) and uses the native UniFi Access events API for realtime event capturing.
+
+## Supported Devices
+
+| Device | Capabilities |
+|--------|-------------|
+| **UA Hub** | Lock, doorbell, door position sensor (DPS), terminal inputs (REL, REN, REX) |
+| **UA Hub Door Mini** | Lock, door position sensor (DPS), request to exit sensor (REX) |
+| **UA Ultra** | Lock, door position sensor (DPS), request to exit sensor (REX) |
+| **UA Gate** | Main gate (lock or garage door opener), side door (pedestrian gate) with separate lock, door position sensors for both doors |
+| **UA Readers** | Access method switches for Face, Hand Wave, Mobile, NFC, PIN, and QR |
+
+## Features
+
+- **Easy configuration** - provide your controller IP address, username, and password to get started
+- **Full HomeKit support** - locks, doorbells, door position sensors, terminal inputs, access method switches, and automation accelerators
+- **Multiple controllers** - seamlessly integrate several UniFi Access controllers into HomeKit
+- **Realtime device detection** - automatically adds and removes devices in HomeKit as they change on your controller, without restarting Homebridge
+- **Customizable** - [feature options](docs/FeatureOptions.md) let you show/hide specific devices and tailor behavior via the built-in webUI
+- **MQTT support** - publish events to an [MQTT broker](docs/MQTT.md) for further automation
+
+## Prerequisites
+
+- [Homebridge](https://homebridge.io) >= 1.8.0
+- Node.js >= 18
+- A UniFi Access controller running the **latest stable firmware**
+- A local user account on the controller (recommended over Ubiquiti cloud credentials; 2FA is not supported)
+
+## Installation
+
+### Via Homebridge UI (recommended)
+
+1. Open the Homebridge UI
+2. Go to the **Plugins** tab
+3. Search for `@mp-consulting/homebridge-unifi-access`
+4. Click **Install**
+
+### Via CLI
+
+```sh
+npm install -g @mp-consulting/homebridge-unifi-access
+```
+
+## Configuration
+
+The recommended way to configure the plugin is through the [Homebridge UI](https://github.com/homebridge/homebridge-config-ui-x). For manual configuration, add the following to the `platforms` array in your Homebridge `config.json`:
+
+```json
+{
+    "platform": "UniFi Access",
+    "name": "UniFi Access",
+    "controllers": [
+        {
+            "address": "1.2.3.4",
+            "username": "homebridge",
+            "password": "your-password-here"
+        }
+    ]
+}
+```
+
+> A sample configuration file is available at [`config.sample.json`](tests/fixtures/config.sample.json).
+
+### Optional Settings
+
+| Setting | Description |
+|---------|-------------|
+| `controllers[].name` | Custom name for the controller (used in logs) |
+| `controllers[].mqttUrl` | MQTT broker URL (e.g. `mqtt://1.2.3.4`) |
+| `controllers[].mqttTopic` | MQTT base topic (default: `unifi/access`) |
+| `options` | Array of [feature options](docs/FeatureOptions.md) for granular control |
+| `ringDelay` | Delay in seconds between doorbell rings (default: `0`) |
+
+## Documentation
+
+- [Feature Options](docs/FeatureOptions.md) - show/hide devices and customize behavior
+- [MQTT](docs/MQTT.md) - configure MQTT event publishing
+- [UniFi Access API](https://www.npmjs.com/package/unifi-access) - native API library
+- [Changelog](CHANGELOG.md) - release notes and version history
+
+## Contributing
+
+```sh
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run linter
+npm run lint
+
+# Run tests
+npm test
+
+# Start in dev mode with live reload
+npm run watch
+```
+
+### Event Schema Monitor
+
+A live monitoring script is included to detect UniFi Access API changes across firmware updates. It connects to a controller, listens to real-time events, and validates each message against known schemas — reporting any new fields, missing fields, or type changes.
+
+```sh
+# Uses credentials from tests/hbConfig/config.json
+npm run monitor:events
+
+# Or point to a different Homebridge config
+npm run monitor:events -- --config /path/to/config.json
+
+# Or specify credentials directly
+npm run monitor:events -- --address 192.168.1.1 --username admin --password secret
+```
+
+Sample output:
+
+```
+2026-02-28T23:02:09.004Z OK DEVICE_REMOTE_UNLOCK event_object_id=6c63f8431750
+2026-02-28T23:02:09.007Z OK DEVICE_UPDATE_V2 event_object_id=3de83e52-...
+2026-02-28T23:02:09.008Z MISMATCH LOCATION_UPDATE event_object_id=c87d8d81-...
+  + data.new_field: unexpected_field — Type: string
+```
+
+When mismatches are found, update the schemas in `tests/event-schemas.ts` (the single source of truth) and the type definitions in `src/hub/access-hub-types.ts` to match the new API.
+
+## License
+
+[MIT](LICENSE.md)

package/config.schema.json

@@ -0,0 +1,202 @@
+{
+  "pluginAlias": "UniFi Access",
+  "pluginType": "platform",
+  "headerDisplay": "Full HomeKit support UniFi Access devices. See the [homebridge-unifi-access](https://github.com/mp-consulting/homebridge-unifi-access) developer page for detailed documentation.",
+  "singular": true,
+  "customUi": true,
+
+  "schema": {
+    "type": "object",
+    "properties": {
+
+      "controllers": {
+        "type": "array",
+        "title": "UniFi Access Controllers",
+
+        "items": {
+          "type": "object",
+          "title": "UniFi Access Controller",
+          "properties": {
+
+            "address": {
+              "type": "string",
+              "title": "Controller Address",
+              "required": true,
+              "format": "hostname",
+              "placeholder": "e.g. 1.2.3.4",
+              "description": "Hostname or IP address of your UniFi Access controller."
+            },
+
+            "mqttTopic": {
+              "type": "string",
+              "title": "MQTT Base Topic",
+              "required": false,
+              "placeholder": "e.g. unifi/access",
+              "description": "The base MQTT topic to publish to. Default: unifi/access."
+            },
+
+            "mqttUrl": {
+              "type": "string",
+              "title": "MQTT Broker URL",
+              "required": false,
+              "format": "uri",
+              "placeholder": "e.g. mqtt://1.2.3.4",
+              "description": "URL for the MQTT broker you'd like to publish event messages to. Default: None."
+            },
+
+            "name": {
+              "type": "string",
+              "title": "Controller Name",
+              "required": false,
+              "placeholder": "e.g. UNVR",
+              "description": "Name for this UniFi Access controller to be used for logging purposes. Default: Defined by the controller."
+            },
+
+            "password": {
+              "type": "string",
+              "title": "Controller Password",
+              "required": true,
+              "placeholder": "e.g. unifi-access-password",
+              "description": "UniFi Access password for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
+            },
+
+            "username": {
+              "type": "string",
+              "title": "Controller Username",
+              "required": true,
+              "placeholder": "e.g. some-unifi-access-user",
+              "description": "UniFi Access username for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
+            }
+          }
+        }
+      },
+
+      "name": {
+
+        "type": "string",
+        "title": "Plugin Name",
+        "required": true,
+        "default": "UniFi Access",
+        "description": "Name to use for Homebridge logging purposes. Default: UniFi Access."
+      },
+
+      "options": {
+
+        "type": "array",
+        "title": "Feature Options",
+
+        "items": {
+          "type": "string",
+          "title": "Feature Option",
+          "required": false,
+          "description": "Enter only one option per entry. See the plugin documentation for the complete list of available options or use the feature options webUI tab above.",
+          "placeholder": "e.g. Disable.Device"
+        }
+      },
+
+      "ringDelay": {
+
+        "type": "integer",
+        "title": "Doorbell Ring Delay (seconds)",
+        "required": false,
+        "minimum": 0,
+        "maximum": 60,
+        "placeholder": "e.g. 5",
+        "description": "Delay between doorbell rings. Setting this to a non-zero value will prevent multiple rings of a doorbell over the specified duration.  Default: 0."
+      }
+    }
+  },
+
+  "layout": [
+    {
+      "type": "section",
+      "title": "UniFi Access Controllers",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        {
+
+          "key": "controllers",
+          "type": "array",
+          "name": " ",
+          "description": "Provide the IP address and login details of your UniFi Access controllers.",
+          "orderable": false,
+          "buttonText": "Add UniFi Access Controller",
+          "items": [
+
+            "controllers[].address",
+            "controllers[].username",
+            "controllers[].password",
+
+            {
+              "key": "controllers[]",
+              "type": "section",
+              "title": "Optional Settings",
+              "expandable": true,
+              "expanded": false,
+              "items": [
+                {
+                  "description": "These settings are optional. The defaults work well for almost everyone.",
+                  "items": [
+                    "controllers[].name"
+                  ]
+                }
+              ]
+            },
+            {
+              "key": "controllers[]",
+              "type": "section",
+              "title": "MQTT Settings",
+              "expandable": true,
+              "expanded": false,
+              "items": [
+                {
+                  "description": "MQTT support will only be enabled if an MQTT broker URL is specified below.",
+                  "items": [
+                    "controllers[].mqttUrl",
+                    "controllers[].mqttTopic"
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+
+    {
+      "type": "section",
+      "title": "Plugin Feature Options (Optional)",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        {
+          "key": "options",
+          "type": "array",
+          "name": " ",
+          "description": "Feature options allow you to further customize the behavior of this plugin such as the ability to show or hide devices. You can use the the feature options tab above (recommended) to customize these settings or enter them manually below.",
+          "orderable": false,
+          "buttonText": "Add Feature Option",
+          "items": [
+            "options[]"
+          ]
+        }
+      ]
+    },
+
+    {
+      "type": "section",
+      "title": "Additional Settings (Optional)",
+      "expandable": true,
+      "expanded": false,
+      "items": [
+        {
+          "description": "These settings should be rarely used or needed by most people. Use these with caution.",
+          "items": [
+            "name"
+          ]
+        }
+      ]
+    }
+  ]
+}

package/dist/access-controller.d.ts

@@ -0,0 +1,41 @@
+import type { PlatformAccessory } from "homebridge";
+import { AccessApi, type AccessControllerConfig, type AccessDeviceConfig } from "unifi-access";
+import { type HomebridgePluginLogging, MqttClient, type Nullable } from "homebridge-plugin-utils";
+import type { AccessControllerOptions } from "./access-options.js";
+import type { AccessDevice } from "./access-device.js";
+import { AccessEvents } from "./access-events.js";
+import type { AccessPlatform } from "./access-platform.js";
+export declare class AccessController {
+    private api;
+    config: AccessControllerOptions;
+    private deviceRemovalQueue;
+    readonly configuredDevices: Record<string, AccessDevice | undefined>;
+    events: AccessEvents;
+    private hap;
+    logApiErrors: boolean;
+    readonly log: HomebridgePluginLogging;
+    mqtt: MqttClient | null;
+    private name;
+    platform: AccessPlatform;
+    uda: AccessControllerConfig;
+    udaApi: AccessApi;
+    private bootstrapRefreshTimer;
+    private unsupportedDevices;
+    constructor(platform: AccessPlatform, accessOptions: AccessControllerOptions);
+    private bootstrapController;
+    login(): Promise<void>;
+    private addAccessDevice;
+    private discoverDevices;
+    addHomeKitDevice(device: AccessDeviceConfig): boolean;
+    private discoverAndSyncAccessories;
+    private cleanupDevices;
+    private resolveDeviceName;
+    private resolveDeviceModel;
+    removeHomeKitDevice(accessory: PlatformAccessory, noRemovalDelay?: boolean): void;
+    resetControllerConnection(): Promise<void>;
+    deviceLookup(deviceId: string): AccessDevice | null;
+    getFeatureFloat(option: string): Nullable<number | undefined>;
+    getFeatureNumber(option: string): Nullable<number | undefined>;
+    hasFeature(option: string, device?: AccessControllerConfig | AccessDeviceConfig): boolean;
+    get id(): string | undefined;
+}