@camera.ui/sdk 0.0.22 → 0.0.25

package/dist/sensor/ptz.js

@@ -1,9 +1,13 @@
 import { Sensor, SensorCategory, SensorType } from './base.js';
+import { defineSensor } from './meta.js';
 /** Optional capabilities for PTZ controls. Add to `capabilities` to enable features. */
 export var PTZCapability;
 (function (PTZCapability) {
+    /** Camera supports panning (horizontal movement) */
     PTZCapability["Pan"] = "pan";
+    /** Camera supports tilting (vertical movement) */
     PTZCapability["Tilt"] = "tilt";
+    /** Camera supports zoom */
     PTZCapability["Zoom"] = "zoom";
     /** Camera supports named position presets */
     PTZCapability["Presets"] = "presets";
@@ -35,6 +39,8 @@ export var PTZProperty;
     PTZProperty["TargetPreset"] = "targetPreset";
     /** Relative displacement move command (write-only) */
     PTZProperty["RelativeMove"] = "relativeMove";
+    /** Move to the home position (write-only command, carries no state) */
+    PTZProperty["Home"] = "home";
 })(PTZProperty || (PTZProperty = {}));
 /**
  * Pan-tilt-zoom camera control. Override `setPosition()` / `setVelocity()` /
@@ -175,7 +181,7 @@ export class PTZControl extends Sensor {
      * Cross-process consumer entry point. Dispatches writable properties
      * to semantic methods so plugin overrides (hardware actions) are honored.
      * `moving` and `presets` are observed/discovered state and not externally writable;
-     * only `Position`, `Velocity`, `TargetPreset`, and `RelativeMove` may be set.
+     * only `Position`, `Velocity`, `TargetPreset`, `RelativeMove` and `Home` may be set.
      *
      * @param property - Property name to write.
      *
@@ -197,7 +203,20 @@ export class PTZControl extends Sensor {
             case PTZProperty.RelativeMove:
                 await this.setRelativeMove(value);
                 return;
+            case PTZProperty.Home:
+                await this.goHome();
+                return;
         }
         // Unknown / non-writable property (incl. moving, presets) — ignored.
     }
 }
+/** Registry metadata for {@link PTZControl}. */
+export const ptzMeta = defineSensor({
+    type: SensorType.PTZ,
+    category: SensorCategory.Control,
+    assignmentKey: 'ptz',
+    multiProvider: false,
+    isDetectionType: false,
+    properties: Object.values(PTZProperty),
+    semantics: null,
+});

package/dist/sensor/registry.js

@@ -0,0 +1,64 @@
+import { audioMeta } from './audio.js';
+import { batteryMeta } from './battery.js';
+import { classifierMeta } from './classifier.js';
+import { clipMeta } from './clip.js';
+import { contactMeta } from './contact.js';
+import { doorbellMeta } from './doorbell.js';
+import { faceMeta } from './face.js';
+import { garageMeta } from './garage.js';
+import { humidityMeta } from './humidity.js';
+import { leakMeta } from './leak.js';
+import { licensePlateMeta } from './licensePlate.js';
+import { lightMeta } from './light.js';
+import { lockMeta } from './lock.js';
+import { motionMeta } from './motion.js';
+import { objectMeta } from './object.js';
+import { occupancyMeta } from './occupancy.js';
+import { ptzMeta } from './ptz.js';
+import { securitySystemMeta } from './securitySystem.js';
+import { sirenMeta } from './siren.js';
+import { smokeMeta } from './smoke.js';
+import { switchMeta } from './switch.js';
+import { temperatureMeta } from './temperature.js';
+/** Every sensor's metadata. A new sensor type adds its meta here. */
+export const SENSOR_META = [
+    audioMeta,
+    batteryMeta,
+    classifierMeta,
+    clipMeta,
+    contactMeta,
+    doorbellMeta,
+    faceMeta,
+    garageMeta,
+    humidityMeta,
+    leakMeta,
+    licensePlateMeta,
+    lightMeta,
+    lockMeta,
+    motionMeta,
+    objectMeta,
+    occupancyMeta,
+    ptzMeta,
+    securitySystemMeta,
+    sirenMeta,
+    smokeMeta,
+    switchMeta,
+    temperatureMeta,
+];
+const _everySensorHasMeta = true;
+void _everySensorHasMeta;
+/**
+ * Looks up a sensor's metadata by its type.
+ *
+ * @param type - The sensor type value.
+ *
+ * @returns The metadata, or `undefined` if no sensor declares that type.
+ *
+ * @example
+ * ```ts
+ * const meta = sensorMeta(SensorType.Light);
+ * ```
+ */
+export function sensorMeta(type) {
+    return SENSOR_META.find((meta) => meta.type === type);
+}

package/dist/sensor/securitySystem.js

@@ -1,4 +1,5 @@
 import { Sensor, SensorType, SensorCategory } from './base.js';
+import { defineSensor, SensorDomain } from './meta.js';
 /** Security system arm/disarm states (HomeKit-compatible values) */
 export var SecuritySystemState;
 (function (SecuritySystemState) {
@@ -101,3 +102,27 @@ export class SecuritySystem extends Sensor {
         // Unknown / non-writable property (incl. currentState) — ignored.
     }
 }
+/** Registry metadata for {@link SecuritySystem}. */
+export const securitySystemMeta = defineSensor({
+    type: SensorType.SecuritySystem,
+    category: SensorCategory.Control,
+    assignmentKey: 'securitySystem',
+    multiProvider: true,
+    isDetectionType: false,
+    properties: Object.values(SecuritySystemProperty),
+    shortcutable: true,
+    cascadeTrigger: { property: SecuritySystemProperty.CurrentState, value: 4, sustained: true },
+    virtual: { properties: { [SecuritySystemProperty.CurrentState]: 3, [SecuritySystemProperty.TargetState]: 3 } },
+    semantics: {
+        domain: SensorDomain.Alarm,
+        stateProperty: SecuritySystemProperty.CurrentState,
+        commandProperty: SecuritySystemProperty.TargetState,
+        states: {
+            armed_home: SecuritySystemState.StayArm,
+            armed_away: SecuritySystemState.AwayArm,
+            armed_night: SecuritySystemState.NightArm,
+            disarmed: SecuritySystemState.Disarmed,
+            triggered: SecuritySystemState.AlarmTriggered,
+        },
+    },
+});

package/dist/sensor/siren.js

@@ -1,8 +1,9 @@
 import { Sensor, SensorType, SensorCategory } from './base.js';
+import { defineSensor, SensorDomain } from './meta.js';
 /** Optional capabilities for siren controls */
 export var SirenCapability;
 (function (SirenCapability) {
-    /** Siren supports volume adjustment (0–100) */
+    /** Siren supports volume adjustment (0-100) */
     SirenCapability["Volume"] = "volume";
 })(SirenCapability || (SirenCapability = {}));
 /**
@@ -14,7 +15,7 @@ export var SirenProperty;
 (function (SirenProperty) {
     /** Whether the siren is currently active */
     SirenProperty["Active"] = "active";
-    /** Volume level (0–100) */
+    /** Volume level (0-100) */
     SirenProperty["Volume"] = "volume";
 })(SirenProperty || (SirenProperty = {}));
 /**
@@ -67,7 +68,7 @@ export class SirenControl extends Sensor {
      * Set volume. Override to drive hardware and call `await super.setVolume(value)`
      * after success. The default implementation clamps the value to [0, 100].
      *
-     * @param value - Volume level in the range 0–100.
+     * @param value - Volume level in the range 0-100.
      *
      * @example
      * ```ts
@@ -103,3 +104,21 @@ export class SirenControl extends Sensor {
         // Unknown / non-writable property — ignored.
     }
 }
+/** Registry metadata for {@link SirenControl}. */
+export const sirenMeta = defineSensor({
+    type: SensorType.Siren,
+    category: SensorCategory.Control,
+    assignmentKey: 'siren',
+    multiProvider: true,
+    isDetectionType: false,
+    properties: Object.values(SirenProperty),
+    shortcutable: true,
+    cascadeTrigger: { property: SirenProperty.Active, value: true, sustained: true },
+    propertyCapabilities: { [SirenProperty.Volume]: SirenCapability.Volume },
+    virtual: { properties: { [SirenProperty.Active]: false, [SirenProperty.Volume]: 100 }, capabilities: [SirenCapability.Volume] },
+    semantics: {
+        domain: SensorDomain.Siren,
+        stateProperty: SirenProperty.Active,
+        commandProperty: SirenProperty.Active,
+    },
+});

package/dist/sensor/smoke.js

@@ -1,4 +1,5 @@
 import { Sensor, SensorType, SensorCategory } from './base.js';
+import { defineSensor, SensorDomain } from './meta.js';
 /**
  * Properties for smoke sensors
  *
@@ -50,3 +51,21 @@ export class SmokeSensor extends Sensor {
         // No-op — smoke state is reported by the plugin, not set externally.
     }
 }
+/** Registry metadata for {@link SmokeSensor}. */
+export const smokeMeta = defineSensor({
+    type: SensorType.Smoke,
+    category: SensorCategory.Sensor,
+    assignmentKey: 'smoke',
+    multiProvider: true,
+    isDetectionType: false,
+    properties: Object.values(SmokeProperty),
+    shortcutable: true,
+    cascadeTrigger: { property: SmokeProperty.Detected, value: true, sustained: true },
+    virtual: { properties: { [SmokeProperty.Detected]: false } },
+    semantics: {
+        domain: SensorDomain.Binary,
+        stateProperty: SmokeProperty.Detected,
+        commandProperty: SmokeProperty.Detected,
+        deviceClass: 'smoke',
+    },
+});

package/dist/sensor/switch.js

@@ -1,4 +1,5 @@
 import { Sensor, SensorType, SensorCategory } from './base.js';
+import { defineSensor, SensorDomain } from './meta.js';
 /**
  * Properties for switch controls
  *
@@ -70,3 +71,20 @@ export class SwitchControl extends Sensor {
         // Unknown / non-writable property — ignored.
     }
 }
+/** Registry metadata for {@link SwitchControl}. */
+export const switchMeta = defineSensor({
+    type: SensorType.Switch,
+    category: SensorCategory.Control,
+    assignmentKey: 'switch',
+    multiProvider: true,
+    isDetectionType: false,
+    properties: Object.values(SwitchProperty),
+    shortcutable: true,
+    cascadeTrigger: { property: SwitchProperty.On, value: true, sustained: true },
+    virtual: { properties: { [SwitchProperty.On]: false } },
+    semantics: {
+        domain: SensorDomain.Switch,
+        stateProperty: SwitchProperty.On,
+        commandProperty: SwitchProperty.On,
+    },
+});

package/dist/sensor/temperature.js

@@ -1,4 +1,5 @@
 import { Sensor, SensorType, SensorCategory } from './base.js';
+import { defineSensor, SensorDomain } from './meta.js';
 /**
  * Properties for temperature sensors
  *
@@ -50,3 +51,21 @@ export class TemperatureInfo extends Sensor {
         // No-op — temperature is reported by the plugin, not set externally.
     }
 }
+/** Registry metadata for {@link TemperatureInfo}. */
+export const temperatureMeta = defineSensor({
+    type: SensorType.Temperature,
+    category: SensorCategory.Info,
+    assignmentKey: 'temperature',
+    multiProvider: true,
+    isDetectionType: false,
+    properties: Object.values(TemperatureProperty),
+    shortcutable: true,
+    virtual: { properties: { [TemperatureProperty.Current]: 20 } },
+    semantics: {
+        domain: SensorDomain.Measurement,
+        stateProperty: TemperatureProperty.Current,
+        commandProperty: TemperatureProperty.Current,
+        deviceClass: 'temperature',
+        unit: '°C',
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.22",
+  "version": "0.0.25",
   "description": "camera.ui sdk",
   "exports": {
     ".": {