feat(homebridge): add support for fans (#94)

Author: smockle

api/location.ts

@@ -43,6 +43,7 @@ export class RingDevice {
   zid = this.initialData.zid
   id = this.zid
   deviceType = this.initialData.deviceType
+  categoryId = this.initialData.categoryId
 
   constructor(
     private initialData: RingDeviceData,

api/ring-types.ts

@@ -14,6 +14,7 @@ export enum RingDeviceType {
   CoAlarm = 'alarm.co',
   SmokeCoListener = 'listener.smoke-co',
   MultiLevelSwitch = 'switch.multilevel',
+  Fan = 'switch.multilevel',
   MultiLevelBulb = 'switch.multilevel.bulb',
   Switch = 'switch',
   BeamsMotionSensor = 'motion-sensor.beams',
@@ -22,6 +23,11 @@ export enum RingDeviceType {
   BeamsTransformerSwitch = 'switch.transformer.beams'
 }
 
+export enum RingDeviceCategory {
+  Fan = 17,
+  MultiLevelSwitch = 2
+}
+
 export enum RingCameraKind {
   doorbot = 'doorbot',
   doorbell = 'doorbell',
@@ -123,6 +129,7 @@ export interface RingDeviceData {
   zid: string
   name: string
   deviceType: RingDeviceType
+  categoryId: number
   batteryLevel?: number
   batteryStatus: 'full' | 'charged' | 'ok' | 'low' | 'none' | 'charging'
   batteryBackup?: 'charged' | 'charging' | 'inUse'

homebridge/README.md

@@ -1,14 +1,15 @@
 # homebridge-ring
- 
+
 [![CircleCI](https://circleci.com/gh/dgreif/ring.svg?style=svg)](https://circleci.com/gh/dgreif/ring)
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=HD9ZPB34FY428&currency_code=USD&source=url)
- 
+
 This [Homebridge](https://github.com/nfarina/homebridge) plugin provides a platform for
 [Ring Doorbells](https://shop.ring.com/pages/doorbell-cameras),
 [Ring Cameras](https://shop.ring.com/pages/security-cameras),
 the [Ring Alarm System](https://shop.ring.com/pages/security-system),
 [Ring Smart Lighting](https://shop.ring.com/pages/smart-lighting),
 and third party devices that connect to the Ring Alarm System.
+
 
 ## Installation
 
@@ -82,8 +83,8 @@ Option | Default | Explanation
 `hideCameraSirenSwitch` | `false` | If `true`, hides the siren switch for Ring cameras in HomeKit.
 `hideAlarmSirenSwitch` | `false` | If you have a Ring Alarm, you will see both the alarm and a "Siren" switch in HomeKit.  The siren switch can sometimes get triggered by Siri commands by accident, which is loud and annoying.  Set this option to `true` to hide the siren switch.
 `cameraStatusPollingSeconds` | `20` | How frequently to poll for updates to your cameras.  Information like light/siren status do not update in real time and need to be requested periodically.
-`cameraDingsPollingSeconds` | `2` | How frequently to poll for new events from your cameras.  These include motion and doorbell presses. 
-`locationIds` | All Locations | Use this option if you only want a subset of your locations to appear in HomeKit. If this option is not included, all of your locations will be added to HomeKit (which is what most users will want to do).  
+`cameraDingsPollingSeconds` | `2` | How frequently to poll for new events from your cameras.  These include motion and doorbell presses.
+`locationIds` | All Locations | Use this option if you only want a subset of your locations to appear in HomeKit. If this option is not included, all of your locations will be added to HomeKit (which is what most users will want to do).
 
 ### Camera Setup
 
@@ -92,7 +93,7 @@ Don't worry, it's really easy. Due to homebridge/HAP limitations, the cameras ca
 Configure the homebridge plugin like normal, then click on the "+" in the upper right in
 the Home app, then "Don't have a Code or Can't Scan?", then you should see the cameras listed as individual devices which
 which you can add.  The code that you need for each is the same code you used when setting up homebridge.  It should be in
-the output when you start homebridge, or in your homebridge `config.json` file. 
+the output when you start homebridge, or in your homebridge `config.json` file.
 Walk through the setup pages and when you are done, you should see several devices related to the camera:
 
   * Camera Feed
@@ -115,7 +116,7 @@ If you turn on notifications for the motion sensors, or for any doorbell camera,
 HomeKit with a snapshot from the camera
 
 If you are having issues with your cameras in the Home app, please see the [Camera Troubleshooting Wiki](https://github.com/dgreif/ring/wiki/Camera-Troubleshooting)
-  
+
 ### Supported Devices via Ring Alarm and Ring Smart Lighting Hubs
   * Security Panel
     * This is a software device that represents the alarm for a Ring location
@@ -145,6 +146,9 @@ If you are having issues with your cameras in the Home app, please see the [Came
   * Carbon Monoxide Alarm
   * Smoke/Carbon Monoxide Listener
   * Smart Locks
+  * Fans
+    * On/Off
+    * Speed
   * Lights/Switches
     * On/Off
     * Brightness Level (if applicable)
@@ -165,7 +169,7 @@ Entry delays and bypassed sensors (ex. for Home mode) are all controlled in the
 These settings will automatically be used by HomeKit.
 
 **Note**: Using `Night` mode in HomeKit will activate `Home` mode on the Ring alarm.
-HomeKit should immediately switch to `Home` to match.  
+HomeKit should immediately switch to `Home` to match.
 
 ### Siri Commands for Alarm
 

homebridge/fan.ts

@@ -0,0 +1,48 @@
+import { BaseDeviceAccessory } from './base-device-accessory'
+import { RingDevice } from '../api'
+import { HAP, hap } from './hap'
+import { RingPlatformConfig } from './config'
+
+export class Fan extends BaseDeviceAccessory {
+  constructor(
+    public readonly device: RingDevice,
+    public readonly accessory: HAP.Accessory,
+    public readonly logger: HAP.Log,
+    public readonly config: RingPlatformConfig
+  ) {
+    super()
+
+    const { Characteristic, Service } = hap
+    const { data: initialData } = this.device
+
+    this.registerCharacteristic(
+      Characteristic.On,
+      Service.Fan,
+      data => Boolean(data.on),
+      value => this.setOnState(value)
+    )
+
+    if (initialData.level !== undefined) {
+      this.registerLevelCharacteristic(
+        Characteristic.RotationSpeed,
+        Service.Fan,
+        data => (data.level && !isNaN(data.level) ? 100 * data.level : 0),
+        value => this.setLevelState(value)
+      )
+    }
+  }
+
+  setOnState(on: boolean) {
+    this.logger.info(`Turning ${this.device.name} ${on ? 'On' : 'Off'}`)
+
+    return this.device.setInfo({ device: { v1: { on } } })
+  }
+
+  setLevelState(level: number) {
+    this.logger.info(`Setting speed of ${this.device.name} to ${level}%`)
+
+    return this.device.setInfo({
+      device: { v1: { level: level / 100 } }
+    })
+  }
+}

homebridge/ring-platform.ts

@@ -1,4 +1,10 @@
-import { RingApi, RingCamera, RingDevice, RingDeviceType } from '../api'
+import {
+  RingApi,
+  RingCamera,
+  RingDevice,
+  RingDeviceType,
+  RingDeviceCategory
+} from '../api'
 import { HAP, hap } from './hap'
 import { SecurityPanel } from './security-panel'
 import { BaseStation } from './base-station'
@@ -12,6 +18,7 @@ import { SmokeCoListener } from './smoke-co-listener'
 import { RingPlatformConfig } from './config'
 import { Beam } from './beam'
 import { MultiLevelSwitch } from './multi-level-switch'
+import { Fan } from './fan'
 import { Switch } from './switch'
 import { Camera } from './camera'
 import { RingAuth } from '../api/rest-client'
@@ -48,6 +55,10 @@ function getAccessoryClass(device: RingDevice | RingCamera) {
     case RingDeviceType.BeamsLightGroupSwitch:
       return Beam
     case RingDeviceType.MultiLevelSwitch:
+      return device instanceof RingDevice &&
+        device.categoryId === RingDeviceCategory.Fan
+        ? Fan
+        : MultiLevelSwitch
     case RingDeviceType.MultiLevelBulb:
       return MultiLevelSwitch
     case RingDeviceType.Switch: