Skip to content

jstubenrauch/homebridge-platform-ring-video-doorbell

 
 

Repository files navigation

homebridge-platform-ring-video-doorbell

A Ring Video Doorbell platform plugin for Homebridge.

Installation

Run these commands:

% sudo npm install -g homebridge
% sudo npm install -g homebridge-platform-ring-video-doorbell

On Linux, you might see this output for the second command:

npm ERR! pcap@2.0.0 install: node-gyp rebuild
npm ERR! Exit status 1
npm ERR!

If so, please try

% apt-get install libpcap-dev

and try

% sudo npm install -g homebridge-platform-ring-video-doorbell

again!

NB: If you install homebridge like this:

sudo npm install -g --unsafe-perm homebridge

Then all subsequent installations must be like this:

sudo npm install -g --unsafe-perm homebridge-platform-ring-video-doorbell

Configuration

Edit ~/.homebridge/config.json, inside "platforms": [ ... ] add:

{ "platform"  : "ring-video-doorbell"
, "name"      : "Doorbell"
, "username"  : "user@example.com"
, "password"  : "secret"

, "options"   : { "retries": 5, "ttl": 5, "verboseP" : false }
, "ringing"   : { "event": "single", "motion": false }
}

The options line contains defaults, so you may omit it.

The ringing line defines what events is generated when ringing occurs. The value for event is one of:

  • "single" (the default);

  • "double" (the default previous to version 0.9.0); or,

  • "long"

The value for motion is either true or false (the default) and indicates whether a second motion detector should be present to report doorbell rings.

HomeKit Appearance

Each doorbell appears as an appliance that is both a "programmable switch" and a "motion detector".

For example, as shown in the Eve App:

"Motion Detector" Notifications

Homekit allows you to enable notifications when motion is detected, e.g.,

To enable notifications, you must use Apple's iOS Home app, e.g.,

Whenever motion is detected, your reachable iOS devices will receive a notification, e.g.,

"Programmable Switch" Actions

HomeKit allows you to creates rules that make use of the ringing of a doorbell.

For example, going from "Scenes" to "Rules" in the Eve App:

Drill down to adding a "trigger" for the doorbell when it rings:

Optionally, the rule may be tailored to only fire when other "conditions" are met (e.g., during a certain time of day):

Once those "conditions" are set, you define a "scene" that tells HomeKit what to do when the "trigger" and "conditions" are met:

Camera Integration

Possibly soon.

Many Thanks

Many thanks to jeroenmoors author of php-ring-api.

Many thanks (also) to davglass author of doorbot.

About

A Ring Video Doorbell platform plugin for Homebridge

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%