@hoobs/ring
Advanced tools
HOOBS plugin for Ring doorbells, cameras, security alarm system and smart lighting
This HOOBS 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.
First, generate a refreshToken using the instructions in the Refresh Tokens Wiki
{
"platforms": [
{
"platform": "Ring",
"refreshToken": "token generated with ring-auth-cli. See https://github.com/dgreif/ring/wiki/Refresh-Tokens"
}
]
}
Only include an optional parameter if you actually need it. Default behavior without any of the optional parameters should be sufficient for most users.
{
"alarmOnEntryDelay": true,
"beamDurationSeconds": 60,
"hideLightGroups": true,
"hideDoorbellSwitch": true,
"hideCameraMotionSensor": true,
"hideCameraSirenSwitch": true,
"hideInHomeDoorbellSwitch": true,
"hideAlarmSirenSwitch": true,
"hideUnsupportedServices": true,
"cameraStatusPollingSeconds": 20,
"cameraDingsPollingSeconds": 2,
"locationModePollingSeconds": 20,
"locationIds": ["488e4800-fcde-4493-969b-d1a06f683102", "4bbed7a7-06df-4f18-b3af-291c89854d60"]
}
| Option | Default | Explanation |
|---|---|---|
alarmOnEntryDelay | false | 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 | 60 for light groups, previous from Ring app for individual lights | 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 | false | 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 | false | 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 | false | If true, hides the motion sensor for Ring cameras in HomeKit. |
hideCameraSirenSwitch | false | If true, hides the siren switch for Ring cameras in HomeKit. |
hideInHomeDoorbellSwitch | false | If true, hides the switch for in-home doorbells 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. |
hideUnsupportedServices | false | If true, hides the alarm Base Station and Keypad devices in HomeKit. These are only supported by third-party HomeKit apps, not the native Home app. |
showPanicButtons | false | Creates a new Panic Buttons device in HomeKit with Burglar Alarm and Fire Alarm switches. Use these at your own risk. I do not guarantee functionality in case of emergency, nor do I take responsibility for any false alarms. These function just like the SOS sliders in the Ring app. |
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. |
locationModePollingSeconds | 20 | How frequently to poll for location mode updates (in seconds). This is only useful if you are using location modes to control camera settings and want to keep an up-to-date reference of the current mode for each location. Polling is automatically disabled for locations equipped with a Ring Alarm. |
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). |
ffmpegPath | Uses ffmpeg-for-homebridge | A custom path to the ffmpeg executable. By default, the static binaries built in ffmpeg-for-homebridge will be used. If you prefer to use your own version of ffmpeg, you can pass a complete path, or simply "ffmpeg" to use ffmpeg from your PATH. |
debug | false | Turns on additional logging. In particular, ffmpeg logging. |
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:
ffmpeg with libfdk_aac installed. See the FFmpeg wiki for details on audio support. Camera streams may not work on some networks with strict NAT settings.hideCameraMotionSensorhideCameraSirenSwitchhideInHomeDoorbellSwitchSingle Press actions)
hideDoorbellSwitchBattery Camera Limitations - There are limitations with how frequently battery cameras can take snapshots. See the Battery Cam Snapshots Wiki for details.
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
If you are having issues with your cameras in the Home app, please see the Camera Troubleshooting Wiki
hideAlarmSirenSwitch)hideUnsupportedServiceshideUnsupportedServicesshowPanicButtons: true in your configBurglar Alarm and Fire Alarm switches in a new Panic Buttons device in HomeKit| 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 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) |
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).
{
"accessories": [
{
"accessory": "DummySwitch",
"name": "Arrived Home"
},
{
"accessory": "DummySwitch",
"name": "Left Home"
}
]
}
| 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 |
FAQs
HOOBS plugin for Ring doorbells, cameras, security alarm system and smart lighting
We found that @hoobs/ring demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.
Security News
The Axios compromise shows how time-dependent dependency resolution makes exposure harder to detect and contain.
Research
A supply chain attack on Axios introduced a malicious dependency, plain-crypto-js@4.2.1, published minutes earlier and absent from the project’s GitHub releases.