@camera.ui/sdk / sensor / SecuritySystem

Class: SecuritySystem<TStorage>

Defined in: sensor/securitySystem.ts:57

Security system control. Override setTargetState() to drive hardware and call await super.setTargetState(value) once the hardware confirms — the base implementation updates both targetState and currentState.

Extends

• Sensor<SecuritySystemProperties, TStorage, string>

Type Parameters

TStorage

TStorage extends object = Record<string, any>

Constructors

Constructor

new SecuritySystem<TStorage>(name?): SecuritySystem<TStorage>

Defined in: sensor/securitySystem.ts:61

Parameters

name?

string = 'Security System'

Returns

SecuritySystem<TStorage>

Overrides

Sensor.constructor

Properties

_requiresFrames?

optional _requiresFrames?: boolean

Defined in: sensor/base.ts:223

Inherited from

Sensor._requiresFrames

---

category

readonly category: Control = SensorCategory.Control

Defined in: sensor/securitySystem.ts:59

Overrides

Sensor.category

---

id

readonly id: string

Defined in: sensor/base.ts:190

Inherited from

Sensor.id

---

name

readonly name: string

Defined in: sensor/base.ts:189

Inherited from

Sensor.name

---

onAssignmentChanged

readonly onAssignmentChanged: Observable<boolean>

Defined in: sensor/base.ts:209

Inherited from

ClipDetectorSensor.onAssignmentChanged

---

onCapabilitiesChanged

readonly onCapabilitiesChanged: Observable<string[]>

Defined in: sensor/base.ts:200

Observable for capability changes. Emits the full capabilities array when capabilities change.

Inherited from

Sensor.onCapabilitiesChanged

---

onPropertyChanged

readonly onPropertyChanged: Observable<PropertyChangeOf<SecuritySystemProperties>>

Defined in: sensor/base.ts:198

Observable for property changes. Emits { property, value, timestamp } when any property changes.

Inherited from

Sensor.onPropertyChanged

---

type

readonly type: SecuritySystem = SensorType.SecuritySystem

Defined in: sensor/securitySystem.ts:58

Overrides

Sensor.type

Accessors

cameraId

Get Signature

get cameraId(): string

Defined in: sensor/base.ts:257

Camera ID this sensor belongs to. Throws if sensor not yet added to a camera.

Returns

string

Inherited from

ClipDetectorSensor.cameraId

---

capabilities

Get Signature

get capabilities(): TCapability[]

Defined in: sensor/base.ts:277

Optional feature flags advertised by this sensor (e.g., PTZ pan/tilt/zoom)

Returns

TCapability[]

Set Signature

set capabilities(value): void

Defined in: sensor/base.ts:282

Set capabilities and notify the backend. Automatically deduplicates.

Parameters

value

TCapability[]

Returns

void

Inherited from

Sensor.capabilities

---

currentState

Get Signature

get currentState(): SecuritySystemState

Defined in: sensor/securitySystem.ts:70

Returns

SecuritySystemState

---

displayName

Get Signature

get displayName(): string

Defined in: sensor/base.ts:233

Returns

string

Inherited from

Sensor.displayName

---

isAssigned

Get Signature

get isAssigned(): boolean

Defined in: sensor/base.ts:252

Whether this sensor has been assigned to a camera in the backend

Returns

boolean

Inherited from

ClipDetectorSensor.isAssigned

---

pluginId

Get Signature

get pluginId(): string | undefined

Defined in: sensor/base.ts:264

Returns

string | undefined

Inherited from

Sensor.pluginId

---

props

Get Signature

get protected props(): Readonly<TProperties>

Defined in: sensor/base.ts:295

Read-only access to the internal property store. Subclasses use this to read current state when implementing semantic methods (e.g., if (this.blocked) return).

Returns

Readonly<TProperties>

Inherited from

Sensor.props

---

storage

Get Signature

get storage(): DeviceStorage<TStorage>

Defined in: sensor/base.ts:269

Per-sensor persistent storage. Throws if sensor not yet added to a camera.

Returns

DeviceStorage<TStorage>

Inherited from

Sensor.storage

---

storageSchema

Get Signature

get storageSchema(): JsonSchema[]

Defined in: sensor/base.ts:216

Override to provide a JSON schema for per-sensor storage settings UI

Returns

JsonSchema[]

Inherited from

ClipDetectorSensor.storageSchema

---

targetState

Get Signature

get targetState(): SecuritySystemState

Defined in: sensor/securitySystem.ts:74

Returns

SecuritySystemState

Methods

getValue()

Call Signature

getValue<K>(property): SecuritySystemProperties[K] | undefined

Defined in: sensor/base.ts:303

Get the current value of a sensor property. Type-safe via the generic overload — call with a property enum value to get a properly typed result.

Type Parameters

K

K extends keyof SecuritySystemProperties

Parameters

property

K

Returns

SecuritySystemProperties[K] | undefined

Inherited from

Sensor.getValue

Call Signature

getValue(property): unknown

Defined in: sensor/base.ts:304

Get the current value of a sensor property. Type-safe via the generic overload — call with a property enum value to get a properly typed result.

Parameters

property

string

Returns

unknown

Inherited from

Sensor.getValue

---

getValues()

getValues(): Readonly<TProperties>

Defined in: sensor/base.ts:320

Get a read-only snapshot of all property values.

Returns

Readonly<TProperties>

Frozen view of every property currently held by the sensor.

Example

const snapshot = sensor.getValues();
console.log(snapshot);

Inherited from

Sensor.getValues

---

hasCapability()

hasCapability(capability): boolean

Defined in: sensor/base.ts:423

Parameters

capability

string

Returns

boolean

Inherited from

Sensor.hasCapability

---

onAssigned()

protected onAssigned(): void | Promise<void>

Defined in: sensor/base.ts:473

Lifecycle hook: the sensor just became assigned to a camera. Override to start background work that should only run while this sensor is live — polling loops, event subscriptions, timers, external connections.

Called AFTER cameraId, storage, and RPC channels are wired up, so the override can safely access this.cameraId, this.storage, and publish properties via the semantic helper methods.

Errors thrown here are caught and logged — they will NOT break assignment bookkeeping. If your work can fail, handle it inside the override.

Paired 1:1 with onDeassigned — for every onAssigned call there is exactly one matching onDeassigned later (on deassignment or cleanup).

Default: no-op. Most sensors don't need lifecycle hooks.

Returns

void | Promise<void>

Example

protected override async onAssigned(): Promise<void> {
  this._timer = setInterval(() => this.poll(), 5_000);
}

Inherited from

Sensor.onAssigned

---

onDeassigned()

protected onDeassigned(): void | Promise<void>

Defined in: sensor/base.ts:493

Lifecycle hook: the sensor is being deassigned. Override to tear down whatever was started in onAssigned — clear timers, close subscriptions, release external resources.

Always called exactly once for each prior onAssigned. Also called from _cleanup if the sensor is being removed while still assigned, so you can rely on this as the single teardown point.

Default: no-op.

Returns

void | Promise<void>

Example

protected override onDeassigned(): void {
  if (this._timer) clearInterval(this._timer);
}

Inherited from

Sensor.onDeassigned

---

setCurrentState()

setCurrentState(value): void

Defined in: sensor/securitySystem.ts:113

Publish the actual security system state. Use this to drive transitions that diverge from the user-requested target — most notably the AlarmTriggered state when an intruder is detected, or arming-delay intermediate states. Read-only from cross-process consumers (updateValue ignores it).

Parameters

value

SecuritySystemState

Current security system state from SecuritySystemState.

Returns

void

Example

import { SecuritySystemState } from '@camera.ui/sdk';
alarm.setCurrentState(SecuritySystemState.AlarmTriggered);

---

setDisplayName()

setDisplayName(value): void

Defined in: sensor/base.ts:247

Set the display name (the only mutable identifier on a sensor).

Parameters

value

string

Human-readable label shown in the UI.

Returns

void

Example

sensor.setDisplayName('Front Door Motion');

Inherited from

Sensor.setDisplayName

---

setTargetState()

setTargetState(value): Promise<void>

Defined in: sensor/securitySystem.ts:91

Set the target state. Override to drive hardware and call await super.setTargetState(value) after success — the base implementation syncs both targetState and currentState to the new value.

Parameters

value

SecuritySystemState

Desired armed/disarmed state from SecuritySystemState.

Returns

Promise<void>

Example

import { SecuritySystemState } from '@camera.ui/sdk';
await alarm.setTargetState(SecuritySystemState.AwayArm);