@koush/ring-client-api/homebridge/lock.ts

Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting

import { BaseDeviceAccessory } from './base-device-accessory'
import { RingDevice, RingDeviceData } from '../api'
import { distinctUntilChanged } from 'rxjs/operators'
import { hap } from './hap'
import { RingPlatformConfig } from './config'
import { Logging, PlatformAccessory } from 'homebridge'

function getCurrentState({ locked }: RingDeviceData) {
  const {
    Characteristic: { LockCurrentState: State },
  } = hap

  switch (locked) {
    case 'unlocked':
      return State.UNSECURED
    case 'locked':
      return State.SECURED
    case 'jammed':
      return State.JAMMED
    default:
      return State.UNKNOWN
  }
}

export class Lock extends BaseDeviceAccessory {
  private targetState: any

  constructor(
    public readonly device: RingDevice,
    public readonly accessory: PlatformAccessory,
    public readonly logger: Logging,
    public readonly config: RingPlatformConfig
  ) {
    super()

    const { Characteristic, Service } = hap

    this.device.onData
      .pipe(distinctUntilChanged((a, b) => a.locked === b.locked))
      .subscribe((data) => {
        this.targetState = this.getTargetState(data)
      })

    this.registerCharacteristic({
      characteristicType: Characteristic.LockCurrentState,
      serviceType: Service.LockMechanism,
      getValue: (data) => {
        const state = getCurrentState(data)

        if (state === this.targetState) {
          this.targetState = undefined
        }

        return state
      },
    })

    this.registerCharacteristic({
      characteristicType: Characteristic.LockTargetState,
      serviceType: Service.LockMechanism,
      getValue: (data) => this.getTargetState(data),
      setValue: (value) => this.setTargetState(value),
    })
  }

  setTargetState(state: any) {
    const {
        Characteristic: { LockTargetState: State },
      } = hap,
      command = state === State.SECURED ? 'lock' : 'unlock'

    this.targetState =
      state === getCurrentState(this.device.data) ? undefined : state

    return this.device.sendCommand(`lock.${command}`)
  }

  getTargetState(data: RingDeviceData) {
    return this.targetState || getCurrentState(data)
  }
}