This package has been deprecated

Author message:

WARNING: This plugin has been moved to homebridge-ring because it now covers all things Ring, not just alarm.

homebridge-ring-alarm

This Homebridge plugin provides a platform for Ring Doorbells, Ring Cameras, the Ring Alarm System, Ring Smart Lighting, and third party devices that connect to the Ring Alarm System.

## Installation

Assuming a global installation of homebridge:

npm i -g homebridge-ring-alarm

## Homebridge Configuration

Add the RingAlarm platform in your homebridge config.json file.

{
 "platforms": [
   {
     "platform": "RingAlarm",
     "email": "[e-mail]",
     "password": "abc123!#",
     
     // For 2fa accounts only.  See below for details
     "refreshToken": "TOKEN GENERATED FOR 2fa ACCOUNTS",
 
     // Optional. DO NOT INCLUDE UNLESS NEEDED.  See below for details
     "locationIds": ["488e4800-fcde-4493-969b-d1a06f683102", "4bbed7a7-06df-4f18-b3af-291c89854d60"],
     "alarmOnEntryDelay": false,
     "beamDurationSeconds": 60,
     "hideLightGroups": true,
     "hideDoorbellSwitch": true,
     "hideCameraMotionSensor": true,
     "hideAlarmSirenSwitch": true,
     "cameraStatusPollingSeconds": 20,
     "cameraDingsPollingSeconds": 1
   }
 ]
}

Optional Parameters

Only include an optional parameter if you actually need it. Default behavior without any of the optional parameters should be sufficient for most users.

locationIds: 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).

alarmOnEntryDelay: if true, HomeKit will register a delayed entry event as a triggered alarm.
There are some households where this is a nice feature as a heads up if you have other people who enter your house and you want an alert so that you can disable the alarm for them before it actually goes off. This works well if you automatically arm/disarm on leave/arrive (see setup instructions below)

beamDurationSeconds: Ring smart lighting has a default behavior of only staying on for 60 seconds when you turn on a light via the Ring app. To force a duration when the light is turned on from HomeKit, set this option to a specific number of seconds. If this option is not set, the lights will use the duration from the previous time the light was turned on in the Ring app. For light groups, this will default to 60 seconds. The maximum value is 32767, which is ~9.1 hours.

hideLightGroups: Ring smart lighting allows you to create lighting groups within the Ring app. These groups are convenient for detecting motion in an area of your yard and turning on/off all lights in the group. However, you may wish to group the lights differently in HomeKit and ignore the groups you have configured in Ring. If this option is true, your Ring groups (and their associated motion sensor) will be ignored and will not show up in HomeKit.

hideDoorbellSwitch: If you have a Ring video doorbell, you will see a Programmable Switch associated with it. This switch can be used to perform actions on when the doorbell is pressed using "Single Press" actions. If you do not care to perform actions when the doorbell is pressed, you can hide the Programmable Switch by setting this option to true. You will still be able to receive notifications from the doorbell even if the Programmable Switch is hidden (notifications can be configured in the settings for the doorbell camera in the Home app)

hideCameraMotionSensor: If true, hides the motion sensor for Ring cameras in HomeKit.

hideAlarmSirenSwitch: 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: 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. Defaults to 20

cameraDingsPollingSeconds: How frequently to poll for new events from your cameras. These include motion and doorbell presses. Defaults to every 1 second.

2-Factor Authentication (2fa)

If you have 2fa turned on for your Ring account, start by running the homebridge plugin with your email and password in config.json. You will be prompted to enter the 2fa code that you received via text message. Type the code into your terminal, and then press enter. Homebridge will exit with an error, but a message will log out your refreshToken. Copy this refresh token and in your homebridge config.json add "refreshToken": "REFERSH TOKEN LOGGED AFTER ENTERING YOUR 2fa CODE" to the RingPlatform config section. You can delete email and password as these will no longer be used.

Camera Setup

This plugin will connect all of your Ring cameras to homebridge, but they require a little extra work to get set up. Don't worry, it's really easy. Due to homebridge/HAP limitations, the cameras cannot be added through a bridge and must be added as individual devices. 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. Walk through the setup pages and when you are done, you should see several devices related to the camera:

• Camera Feed
• Motion Sensor
• Light (if camera is equipped)
• Siren Switch (if camera is equipped)
• Programmable switch for doorbells (triggers Single Press actions)
  • Note: doorbell event notifications should be configured via settings on the camera feed
  • Can be hidden with hideDoorbellSwitch

Please Note - there is not a live feed, just snapshots from the camera. The snapshots work great for seeing who is at the door, or what's going on when motion is detected. Live feeds are much more complicated to implement and are not functional at this time. Please see https://github.com/dgreif/ring-alarm/issues/35 if you want more details.

"Video Doorbell" (aka doorbot_v3) Users - This particular camera model from Ring has some drawbacks. In particular, it only refreshes its snapshot image every 10 minutes or so. To avoid "No Response" messages from HomeKit while it waits several minutes for the snapshots to update, the homebridge plugin instead returns the last snapshot after 5 seconds of waiting. Snapshots that you see in Home and in notifications are most likely old, even if they say they are from "now". This is a limitation of the camera and I don't see any possible workarounds.

If you turn on notifications for the motion sensors, or for any doorbell camera, you will get rich notifications from HomeKit with a snapshot from the camera

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
  • Arm Home / Arm Away / Disarm alarm for Ring location.
  • Detect active burglar alarm
  • Sound/silence siren (shows as a "Ring Alarm Siren" switch, can be hidden with hideAlarmSirenSwitch)
• Base Station
  • Set Volume (Not currently supported in Home, but works in other apps like Eve)
  • Battery status
• Keypad
  • Set Volume (Not currently supported in Home, but works in other apps like Eve)
  • Battery status
• Contact Sensor
  • Detect if sensor is open or closed
  • Tamper status
  • Battery status
• Motion Sensor
  • Detect motion
  • Tamper status
  • Battery status
• Ring Smart Lights (Motion Detector, Flood/Path/Spot Lights, Transformer)
  • On/Off
  • Brightness Level
  • Detect motion
  • Battery Status
• Smoke Alarm
• Carbon Monoxide Alarm
• Smoke/Carbon Monoxide Listener
• Smart Locks
• Lights/Switches
  • On/Off
  • Brightness Level
  • Hue/Sat/Color Temp are possible, but currently not supported. Please open an issue if you have a device that you would be able to test these on.

Alarm Modes

Ring Mode	HomeKit Mode
Disarmed	Off
Home	Home
Away	Away
Home	Night

Entry delays and bypassed sensors (ex. for Home mode) are all controlled in the Ring app. 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.

Siri Commands for Alarm

Siri Command	Outcome
Set Ring Alarm to Away	Away mode activated
Arm my security system	Away mode activated
Set Ring Alarm to Stay	Home mode activated
Arm my security system for stay	Home mode activated
Disarm Ring Alarm	Disarmed
Disarm my security system	Disarmed
Turn on Ring Alarm	Turns on Ring Alarm Siren (unless hideAlarmSirenSwitch is set)
Turn off Ring Alarm	Turns off Ring Alarm Siren (unless hideAlarmSirenSwitch is set)

Changes Modes on Arrive/Leave Home

The Home app allows you to create an automation that runs when you arrive/leave home. If you include an accessory or scene that "allows access" to your home (e.g. Security System or Lock), the Home app will require you to manually verify that you actually want to run the automation every time it gets triggered. For anyone who wants to arm/disarm their Ring Alarm automatically, this manual verification can be quite annoying. To work around this issue, you can add two "dummy" switches to you homebridge setup using homebridge-dummy. You can then use these dummy switches to trigger your other automation (e.g. Arm/Disarm Ring Alarm).

Example Dummy Config

"accessories": [
    {
      "accessory": "DummySwitch",
      "name": "Arrived Home"
    },
    {
      "accessory": "DummySwitch",
      "name": "Left Home"
    }
]

Example Home Automations

Trigger	Action
People Arrive	Turn on "Arrived Home"
People Leave	Turn on "Left Home"
"Arrived Home" turns on	Set Ring Alarm mode to Off
"Left Home" turns on	Set Ring Alarm mode to Away