@camera.ui/sdk / sensor / LockControl

Class: LockControl<TStorage>

Defined in: sensor/lock.ts:57

Lock control. Override setTargetState() to drive hardware and call await super.setTargetState(value) once the hardware confirms. The base implementation updates both targetState and currentState to the new value.

For asymmetric flows (long-running unlock with intermediate state) override setTargetState and write currentState separately when transitions complete.

Extends

• Sensor<LockControlProperties, TStorage, string>

Type Parameters

TStorage

TStorage extends object = Record<string, any>

Constructors

Constructor

new LockControl<TStorage>(name?, options?): LockControl<TStorage>

Defined in: sensor/lock.ts:61

Parameters

name?

string = 'Lock'

options?

SensorOptions

Returns

LockControl<TStorage>

Overrides

Sensor.constructor

Properties

category

readonly category: Control = SensorCategory.Control

Defined in: sensor/lock.ts:59

Overrides

Sensor.category

---

name

readonly name: string

Defined in: sensor/base.ts:223

Inherited from

Sensor.name

---

onAssignmentChanged

readonly onAssignmentChanged: Observable<readonly string[]>

Defined in: sensor/base.ts:250

Inherited from

Sensor.onAssignmentChanged

---

onCapabilitiesChanged

readonly onCapabilitiesChanged: Observable<string[]>

Defined in: sensor/base.ts:242

Inherited from

Sensor.onCapabilitiesChanged

---

onConnectedChanged

readonly onConnectedChanged: Observable<boolean>

Defined in: sensor/base.ts:252

Inherited from

Sensor.onConnectedChanged

---

onPropertyChanged

readonly onPropertyChanged: Observable<PropertyChangeOf<LockControlProperties>>

Defined in: sensor/base.ts:240

Inherited from

Sensor.onPropertyChanged

---

type

readonly type: Lock = SensorType.Lock

Defined in: sensor/lock.ts:58

Overrides

Sensor.type

Accessors

assignedCameraIds

Get Signature

get assignedCameraIds(): readonly string[]

Defined in: sensor/base.ts:293

Returns

readonly string[]

Inherited from

Sensor.assignedCameraIds

---

assignmentLocked

Get Signature

get assignmentLocked(): boolean

Defined in: sensor/base.ts:297

Returns

boolean

Inherited from

Sensor.assignmentLocked

---

capabilities

Get Signature

get capabilities(): TCapability[]

Defined in: sensor/base.ts:316

Returns

TCapability[]

Set Signature

set capabilities(value): void

Defined in: sensor/base.ts:321

Set capabilities, deduplicated, and notify backend plus local listeners.

Parameters

value

TCapability[]

Returns

void

Inherited from

Sensor.capabilities

---

connected

Get Signature

get connected(): boolean

Defined in: sensor/base.ts:289

Returns

boolean

Inherited from

Sensor.connected

---

currentState

Get Signature

get currentState(): LockState

Defined in: sensor/lock.ts:70

Returns

LockState

---

displayName

Get Signature

get displayName(): string

Defined in: sensor/base.ts:281

Returns

string

Inherited from

Sensor.displayName

---

id

Get Signature

get id(): string

Defined in: sensor/base.ts:269

Returns

string

Inherited from

Sensor.id

---

isAssigned

Get Signature

get isAssigned(): boolean

Defined in: sensor/base.ts:285

Returns

boolean

Inherited from

VibrationSensor.isAssigned

---

nativeId

Get Signature

get nativeId(): string | undefined

Defined in: sensor/base.ts:273

Returns

string | undefined

Inherited from

Sensor.nativeId

---

origin

Get Signature

get origin(): string | undefined

Defined in: sensor/base.ts:277

Returns

string | undefined

Inherited from

VibrationSensor.origin

---

pluginId

Get Signature

get pluginId(): string | undefined

Defined in: sensor/base.ts:301

Returns

string | undefined

Inherited from

Sensor.pluginId

---

props

Get Signature

get protected props(): Readonly<TProperties>

Defined in: sensor/base.ts:546

Returns

Readonly<TProperties>

Inherited from

Sensor.props

---

storage

Get Signature

get storage(): DeviceStorage<TStorage>

Defined in: sensor/base.ts:305

Returns

DeviceStorage<TStorage>

Inherited from

Sensor.storage

---

storageSchema

Get Signature

get storageSchema(): JsonSchema[]

Defined in: sensor/base.ts:312

Returns

JsonSchema[]

Inherited from

VibrationSensor.storageSchema

---

targetState

Get Signature

get targetState(): LockState

Defined in: sensor/lock.ts:74

Returns

LockState

Methods

getValue()

Call Signature

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

Defined in: sensor/base.ts:345

Get the current value of a sensor property. Calling the generic overload with a property enum value gives a properly typed result.

Type Parameters

K

K extends keyof LockControlProperties

Parameters

property

K

Returns

LockControlProperties[K] | undefined

Inherited from

Sensor.getValue

Call Signature

getValue(property): unknown

Defined in: sensor/base.ts:346

Get the current value of a sensor property. Calling the generic overload with a property enum value gives a properly typed result.

Parameters

property

string

Returns

unknown

Inherited from

Sensor.getValue

---

getValues()

getValues(): Readonly<TProperties>

Defined in: sensor/base.ts:362

Get a read-only snapshot of all property values.

Returns

Readonly<TProperties>

Shallow copy 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:388

Check whether the sensor advertises a capability.

Parameters

capability

string

Capability flag to look for.

Returns

boolean

True if the sensor currently advertises it.

Example

const dimmable = sensor.hasCapability('brightness');

Inherited from

Sensor.hasCapability

---

onStart()

protected onStart(): void | Promise<void>

Defined in: sensor/base.ts:651

Lifecycle hook, called once the sensor is registered and live (storage and RPC are wired up). Override it to start work whose lifetime matches the sensor's: polling loops, event subscriptions, timers.

Errors thrown here are swallowed, not logged. Handle failures inside the override. Paired 1:1 with onStop, which runs on removal, plugin shutdown or cleanup.

Returns

void | Promise<void>

Example

protected override onStart(): void {
  this._timer = setInterval(() => this.poll(), 5_000);
}

Inherited from

Sensor.onStart

---

onStop()

protected onStop(): void | Promise<void>

Defined in: sensor/base.ts:664

Counterpart of onStart: tear down whatever it started, such as timers, subscriptions and external resources.

Returns

void | Promise<void>

Example

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

Inherited from

Sensor.onStop

---

setCurrentState()

setCurrentState(value): void

Defined in: sensor/lock.ts:112

Publish the actual lock state. Use it when the physical state diverges from the requested target: motorized locks that take time to rotate (publish Unknown while moving), or hardware reporting an out-of-band state change. Read-only from cross-process consumers (updateValue ignores it).

Parameters

value

LockState

Current physical lock state from the LockState enum.

Returns

void

Example

import { LockState } from '@camera.ui/sdk';
lock.setCurrentState(LockState.Unknown);

---

setDisplayName()

setDisplayName(value): void

Defined in: sensor/base.ts:337

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/lock.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

LockState

Desired lock state from the LockState enum.

Returns

Promise<void>

Example

import { LockState } from '@camera.ui/sdk';
await lock.setTargetState(LockState.Secured);

---

updateModelSpec()

updateModelSpec(): void

Defined in: sensor/base.ts:565

Re-announces the model spec, e.g. once the models finished loading.

The spec a detector reports at registration is what it knows at that moment: models that load in the background are missing from it. Call this after loading, the server replaces its copy.

Returns

void

Example

async onStart(): Promise<void> {
  await this.loadModel();
  this.updateModelSpec();
}

Inherited from

Sensor.updateModelSpec