feat: model name for cameras

dgreif · Jun 24, 2019 · 2b9f397 · 2b9f397
1 parent e2278c7
commit 2b9f397
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 14 deletions.
diff --git a/api/ring-camera.ts b/api/ring-camera.ts
@@ -3,6 +3,7 @@ import {
   CameraData,
   CameraHealth,
   HistoricalDingGlobal,
+  RingCameraModel,
   SnapshotTimestamp
 } from './ring-types'
 import { clientApi, RingRestClient } from './rest-client'
@@ -23,6 +24,7 @@ const maxSnapshotRefreshAttempts = 60,
 export class RingCamera {
   id = this.initialData.id
   deviceType = this.initialData.kind
+  model = RingCameraModel[this.initialData.kind] || 'Unknown Model'
   hasLight = this.initialData.led_status !== undefined
   hasSiren = this.initialData.siren_status !== undefined
 

diff --git a/api/ring-types.ts b/api/ring-types.ts
@@ -20,10 +20,48 @@ export enum RingDeviceType {
   BeamsTransformerSwitch = 'switch.transformer.beams'
 }
 
-// TODO: get all camera kinds
 export enum RingCameraKind {
-  DoorbellPro = 'lpd_v2',
-  Floodlight = 'hp_cam_v1'
+  doorbot = 'doorbot',
+  doorbell = 'doorbell',
+  doorbell_v3 = 'doorbell_v3',
+  doorbell_v4 = 'doorbell_v4',
+  doorbell_v5 = 'doorbell_v5',
+  doorbell_portal = 'doorbell_portal',
+  lpd_v1 = 'lpd_v1',
+  lpd_v2 = 'lpd_v2',
+  jbox_v1 = 'jbox_v1',
+  stickup_cam = 'stickup_cam',
+  stickup_cam_v3 = 'stickup_cam_v3',
+  stickup_cam_elite = 'stickup_cam_elite',
+  stickup_cam_lunar = 'stickup_cam_lunar',
+  spotlightw_v2 = 'spotlightw_v2',
+  hp_cam_v1 = 'hp_cam_v1',
+  hp_cam_v2 = 'hp_cam_v2',
+  stickup_cam_v4 = 'stickup_cam_v4',
+  floodlight_v1 = 'floodlight_v1',
+  floodlight_v2 = 'floodlight_v2'
+}
+
+export const RingCameraModel: { readonly [P in RingCameraKind]: string } = {
+  doorbot: 'Doorbell',
+  doorbell: 'Doorbell',
+  doorbell_v3: 'Doorbell',
+  doorbell_v4: 'Doorbell 2',
+  doorbell_v5: 'Doorbell 2',
+  doorbell_portal: 'Door View Cam',
+  lpd_v1: 'Doorbell Pro',
+  lpd_v2: 'Doorbell Pro',
+  jbox_v1: 'Doorbell Elite',
+  stickup_cam: 'Stick Up Cam',
+  stickup_cam_v3: 'Stick Up Cam',
+  stickup_cam_elite: 'Stick Up Cam',
+  stickup_cam_lunar: 'Stick Up Cam',
+  spotlightw_v2: 'Spotlight Cam',
+  hp_cam_v1: 'Floodlight Cam',
+  hp_cam_v2: 'Spotlight Cam',
+  stickup_cam_v4: 'Spotlight Cam',
+  floodlight_v1: 'Floodlight Cam',
+  floodlight_v2: 'Floodlight Cam'
 }
 
 export type AlarmMode = 'all' | 'some' | 'none'
@@ -190,7 +228,7 @@ export interface CameraData {
   battery_life: number | string // 4003 or "100"
   external_connection: boolean
   firmware_version: Firmware
-  kind: RingCameraKind | string
+  kind: RingCameraKind
   latitude: number
   longitude: number
   address: string
@@ -338,7 +376,7 @@ export interface ActiveDing {
   protocol: 'sip'
   doorbot_id: number
   doorbot_description: string
-  device_kind: RingCameraKind | string
+  device_kind: RingCameraKind
   motion: boolean
   snapshot_url: ''
   kind: DingKind

diff --git a/homebridge/base-accessory.ts b/homebridge/base-accessory.ts
@@ -12,6 +12,10 @@ export abstract class BaseAccessory<T extends RingDevice | RingCamera> {
   abstract readonly config: RingAlarmPlatformConfig
 
   getService(serviceType: HAP.Service, name = this.device.name) {
+    if (process.env.RING_DEBUG) {
+      name = 'TEST ' + name
+    }
+
     return (
       this.accessory.getService(serviceType) ||
       this.accessory.addService(serviceType, name)

diff --git a/homebridge/base-device-accessory.ts b/homebridge/base-device-accessory.ts
@@ -68,7 +68,7 @@ export abstract class BaseDeviceAccessory extends BaseAccessory<RingDevice> {
     this.registerCharacteristic(
       Characteristic.Manufacturer,
       Service.AccessoryInformation,
-      data => data.manufacturerName || 'ring'
+      data => data.manufacturerName || 'Ring'
     )
     this.registerCharacteristic(
       Characteristic.Model,
@@ -78,7 +78,7 @@ export abstract class BaseDeviceAccessory extends BaseAccessory<RingDevice> {
     this.registerCharacteristic(
       Characteristic.SerialNumber,
       Service.AccessoryInformation,
-      data => data.serialNumber || 'unknown'
+      data => data.serialNumber || 'Unknown'
     )
 
     if ('volume' in initialData && 'setVolume' in device) {

diff --git a/homebridge/camera.ts b/homebridge/camera.ts
@@ -68,12 +68,12 @@ export class Camera extends BaseAccessory<RingCamera> {
     this.registerCharacteristic(
       Characteristic.Manufacturer,
       Service.AccessoryInformation,
-      () => 'ring'
+      () => 'Ring'
     )
     this.registerCharacteristic(
       Characteristic.Model,
       Service.AccessoryInformation,
-      data => data.kind
+      data => `${device.model} (${data.kind})`
     )
     this.registerCharacteristic(
       Characteristic.SerialNumber,

diff --git a/homebridge/ring-alarm-platform.ts b/homebridge/ring-alarm-platform.ts
@@ -15,7 +15,10 @@ import { MultiLevelSwitch } from './multi-level-switch'
 import { Camera } from './camera'
 
 const pluginName = 'homebridge-ring-alarm',
-  platformName = 'RingAlarm'
+  platformName = 'RingAlarm',
+  debug = false
+
+process.env.RING_DEBUG = debug ? 'true' : ''
 
 function getAccessoryClass(device: RingDevice | RingCamera) {
   const { deviceType } = device
@@ -109,9 +112,10 @@ export class RingAlarmPlatform {
         allDevices.forEach(device => {
           const isCamera = device instanceof RingCamera,
             AccessoryClass = isCamera ? Camera : getAccessoryClass(device),
-            id = device.id,
+            debugPrefix = debug ? 'TEST ' : '',
             cameraIdDifferentiator = isCamera ? 'camera' : '', // this forces bridged cameras from old version of the plugin to be seen as "stale"
-            uuid = hap.UUIDGen.generate(id.toString() + cameraIdDifferentiator)
+            id = debugPrefix + device.id.toString() + cameraIdDifferentiator,
+            uuid = hap.UUIDGen.generate(id)
 
           if (
             !AccessoryClass ||
@@ -123,15 +127,16 @@ export class RingAlarmPlatform {
 
           const createHomebridgeAccessory = () => {
               const accessory = new hap.PlatformAccessory(
-                device.name,
+                debugPrefix + device.name,
                 uuid,
                 isCamera
                   ? hap.AccessoryCategories.CAMERA
                   : hap.AccessoryCategories.SECURITY_SYSTEM
               )
 
               this.log.info(
-                `Adding new accessory ${device.deviceType} ${device.name}`
+                `Adding new accessory ${device.deviceType} ${debugPrefix +
+                  device.name}`
               )
 
               if (isCamera) {