camera-ui-aqara 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 2.0.0
+
+- Merged the former **camera-ui-aqara** (local RTSP) and **camera-ui-aqara-cloud** (Aqara Cloud) plugins into one plugin, with independent **Enable Local RTSP** / **Enable Aqara Cloud** toggles so either or both subsystems can run at once.
+- Fixed: local camera discovery used `discover()`; the SDK requires `onDiscoverCameras()`. The manual-add camera entry would not have appeared under the original method name.
+- Fixed: an invalid button `color: 'warning'` (now `'warn'`) on the doorbell-token regenerate button.
+- Fixed: four hidden cloud storage fields (persisted auth tokens) were missing the schema's required `description`.
+- Fixed: cloud sensor registration called `api.sensorManager.addSensor(...)`, which does not exist on the current SDK (`SensorManager` is read-only). Rewrote cloud doorbell/motion sensors to use the SDK's `SensorDiscoveryProvider` adoption flow — they're now adopted from the Sensors page instead of registering themselves automatically.
+- Bumped `@camera.ui/sdk` to `^1.2.38` and `@camera.ui/cli` to `^0.0.106`, the versions this release was verified against (full `tsc` type-check + an actual `cui bundle` run with contract validation).
+
+## Prior history
+
+- **camera-ui-aqara 1.0.0** — initial local RTSP plugin (video, snapshots, local doorbell webhook), adapted from [DTse/aqara-scrypted](https://github.com/DTse/aqara-scrypted).
+- **camera-ui-aqara-cloud 1.0.0** — initial Aqara Cloud plugin (Open API auth, HTTP push / bridge SSE, doorbell + motion sensors).

package/LICENSE.md

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 camera-ui-aqara contributors
+Merges the former camera-ui-aqara (local RTSP) and camera-ui-aqara-cloud (Aqara Cloud) plugins.
+Local RTSP subsystem based on aqara-scrypted (MIT) by DTse.
+
+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,114 @@
+# Aqara plugin for camera.ui
+
+Aqara integration for [camera.ui](https://github.com/seydx/camera.ui): local **RTSP LAN video** (tested against the **Aqara G410**) and **Aqara Cloud** doorbell/motion events, in one plugin with independent switches for each half.
+
+This replaces the two separate plugins, **camera-ui-aqara** (local) and **camera-ui-aqara-cloud** (cloud) — see [What changed](#what-changed-from-the-two-original-plugins) if you used either before.
+
+## Features
+
+| Feature | Source | Status |
+| --- | --- | --- |
+| Live video (main + substream) | Local | Yes |
+| Snapshots (from main stream) | Local | Yes |
+| Doorbell ring, via local HTTP webhook | Local | Yes |
+| Doorbell ring, via Aqara Cloud push | Cloud | Yes |
+| Motion sensor, via Aqara Cloud push | Cloud | Yes |
+| Two-way audio (talkback) | Local | Not yet (proprietary LAN protocol; planned) |
+
+## Architecture
+
+Two subsystems live in one plugin and run independently:
+
+- **Local** — adopts a camera by IP + RTSP credentials (`DiscoveryProvider`), gives it video sources, and can run a per-camera HTTP webhook that fires that camera's doorbell sensor.
+- **Cloud** — logs into the Aqara Open API, subscribes to resource events for your devices, and receives them via an HTTP push listener and/or an optional [aqara-rocketmq-bridge](https://github.com/Darkdragon14/aqara-rocketmq-bridge) SSE feed. Matching doorbell/motion sensors are offered for **adoption on the Sensors page**, same as any other externally-sourced sensor — see [Setup → Cloud](#2-cloud-aqara-open-api) below.
+
+Both are **on by default** and designed to run together: Local gives you video, Cloud fills in motion detection and a second, no-port-forwarding path to doorbell events. Two settings at the top of the plugin's page — **Enable Local RTSP** and **Enable Aqara Cloud** — let you turn either off independently without losing its configuration. Turning Local off pauses the per-camera doorbell/webhook management (already-configured video keeps streaming, since the host serves it directly from the URLs set at adoption, independent of the plugin process). Turning Cloud off stops the push listener/SSE client and the Aqara API calls; any sensors you'd already adopted stay in camera.ui but go quiet until you turn it back on.
+
+## Prerequisites
+
+### 1. Local (RTSP)
+
+1. The camera must be **hardwired** (RTSP does not work on battery-only models).
+2. In the **Aqara Home** app: open the camera → Settings → **RTSP LAN Preview** → enable, then copy the generated **username** and **password** and note the camera's LAN IP.
+
+### 2. Cloud (Aqara Open API)
+
+1. An [Aqara Developer](https://developer.aqara.com/) project with **App ID**, **Key ID**, **App Key**.
+2. Message Push enabled, **User-defined subscription mode**, channel **HTTP Push** (recommended) *or* **Message Queue** + [aqara-rocketmq-bridge](https://github.com/Darkdragon14/aqara-rocketmq-bridge).
+
+Both: camera.ui ≥ 2.1.4, Node ≥ 20.19.
+
+## Install
+
+```bash
+unzip camera-ui-aqara.zip
+cd camera-ui-aqara
+npm install
+npm run bundle
+```
+
+Install the resulting bundle into camera.ui (Plugins → Install from file / local package), or copy the `bundle/` output into your camera.ui plugins directory as documented for your install.
+
+## Setup
+
+### 1. Local (RTSP camera)
+
+1. Open **Plugins → Aqara**. Confirm **Enable Local RTSP** is on (it is by default).
+2. Use **Discover / Add device** and choose **Add Aqara Camera (manual)** — Aqara doesn't expose a LAN discovery protocol, so this is always a manual entry.
+3. Fill in Name, IP, RTSP username/password, and optional channels / webhook port. Confirm the live preview.
+
+The G410 exposes three RTSP channels on port **8554**: `ch1` (main/high-res), `ch2` (medium), `ch3` (sub/low bitrate). Pick main/sub channels when adopting or later in camera settings.
+
+**Doorbell webhook:** Aqara's LAN protocol doesn't expose ring events to third parties, so this uses the same webhook approach as the original Scrypted plugin:
+
+1. In the camera's settings, set **Webhook listen port** to a free port on the camera.ui host (e.g. `18789`).
+2. Note the **Doorbell webhook token** (or click **Regenerate doorbell token**).
+3. Point any trigger (Home Assistant `rest_command`, a Shortcut, curl) at `http://<camera.ui-host>:<webhookPort>/ring/<token>` — GET or POST both work.
+4. Or use **Test doorbell ring** in camera settings to fire it locally, no HTTP call needed.
+
+### 2. Cloud (Aqara Open API)
+
+1. Open **Plugins → Aqara**. Confirm **Enable Aqara Cloud** is on.
+2. Under **Cloud Account**, set **Region**, **App ID**, **Key ID**, **App Key**, **Aqara account**.
+3. Click **Request auth code** → enter the code from email/SMS into **Auth code** → **Complete login**.
+4. Click **Refresh devices & subscribe** (this also runs automatically after login and on every restart).
+5. Under **Cloud Ingress**: for HTTP Push, set **HTTP push port** (e.g. `18080`) and confirm the path (`/aqara/push` by default) — then in the Aqara Developer Console, set the push URL to a **publicly reachable** address pointing at that port (tunnel or port-forward as needed). For the bridge path instead, set **RocketMQ bridge URL** + **Bridge token**. Both can be enabled; events are merged.
+6. Go to camera.ui's **Sensors** page and **rescan** — a Doorbell and a Motion sensor will be offered for each cloud device found. Adopt the ones you want, then assign them to whichever camera(s) you like.
+
+This adoption step is how camera.ui handles any externally-sourced sensor (Home Assistant entities, vendor accounts, etc.) — sensors are never created automatically without you picking them, so they show up as candidates rather than appearing on their own.
+
+Default resource IDs: Doorbell `13.95.85` (face/recognition-style event on G410), Motion `3.21.85` + `3.51.85`. Override **Doorbell / Motion resource IDs** and **Extra subscribe resource IDs** under **Cloud Sensors** if your region/model uses different attributes.
+
+## Development
+
+```bash
+npm install
+npm run build        # tsc → dist/
+npm run bundle        # production bundle via @camera.ui/cli
+npm run bundle:dev    # development bundle
+npm run format         # prettier
+npm run lint            # eslint --fix
+```
+
+## What changed from the two original plugins
+
+This merge was checked against the real `@camera.ui/sdk` (verified at `1.2.38`) and `@camera.ui/cli` (`0.0.106`), including a full `npx tsc` type-check and an actual `cui bundle` run with contract validation. A few things surfaced and were fixed along the way — worth knowing if you had either plugin before:
+
+- **Local:** the discovery method was named `discover()`; the SDK expects `onDiscoverCameras()`. As originally written, the "Add Aqara Camera (manual)" entry would never have appeared. Renamed.
+- **Local:** the "Regenerate doorbell token" button used `color: 'warning'`, which isn't a valid value (`'success' | 'info' | 'warn' | 'danger'`). Changed to `'warn'`.
+- **Cloud:** four hidden storage fields (the persisted auth tokens) were missing the `description` the schema type requires. Added.
+- **Cloud, the bigger one:** sensor creation called `api.sensorManager.addSensor(...)`, which doesn't exist — `SensorManager` is read-only (history queries only). Standalone sensors can only be created through the SDK's `SensorDiscoveryProvider` adoption flow. This is now implemented properly: cloud doorbell/motion sensors are discoverable and adopted from the Sensors page (see [Setup → Cloud](#2-cloud-aqara-open-api), step 6) instead of registering themselves the moment a device is found. Functionally this is the same events → sensors pipeline, just routed through the adoption step the SDK actually requires.
+- Bumped the `@camera.ui/sdk` / `@camera.ui/cli` dev dependency versions to the ones this was verified against.
+
+If you had both original plugins installed: uninstall them, install this one, then re-adopt your local camera(s) (same RTSP credentials) and re-run the Cloud login + device refresh. Point your Aqara HTTP Push URL at this plugin's push port if it changed.
+
+## Credits
+
+- Local RTSP subsystem adapted from the Scrypted plugin [DTse/aqara-scrypted](https://github.com/DTse/aqara-scrypted).
+- Protocol notes from [absent42/aqara-doorbell](https://github.com/absent42/aqara-doorbell) and [Darkdragon14/ha-aqara-devices](https://github.com/Darkdragon14/ha-aqara-devices).
+- Optional SSE ingress compatible with [Darkdragon14/aqara-rocketmq-bridge](https://github.com/Darkdragon14/aqara-rocketmq-bridge).
+- camera.ui SDK: https://cameraui.github.io/sdk/
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,44 @@
+{
+  "displayName": "Aqara",
+  "name": "camera-ui-aqara",
+  "version": "2.0.0",
+  "description": "Aqara integration for camera.ui: local RTSP LAN video, snapshots, and a doorbell webhook (tested with G410), plus optional Aqara Cloud doorbell/motion sensors via the Open API. Merges the former camera-ui-aqara and camera-ui-aqara-cloud plugins into one, with independent Local/Cloud toggles so either or both can run at once.",
+  "author": "Adapted from DTse/aqara-scrypted for camera.ui",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "bundle": "npm run build && cui bundle",
+    "bundle:dev": "npm run build && cross-env MODE=development cui bundle",
+    "format": "prettier --write \"src/\" --ignore-unknown --no-error-on-unmatched-pattern",
+    "lint": "eslint --fix . || true"
+  },
+  "engines": {
+    "camera.ui": ">=2.1.4",
+    "node": ">=20.19.0"
+  },
+  "os": [],
+  "cpu": [],
+  "keywords": [
+    "camera-ui-plugin",
+    "aqara",
+    "g410",
+    "rtsp",
+    "doorbell",
+    "motion",
+    "cloud",
+    "open-api"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/donavanbecker/camera-ui-aqara"
+  },
+  "cameraui": {
+    "protocolLevel": 2
+  },
+  "files": [
+    "bundle.zip",
+    "CHANGELOG.md"
+  ]
+}