homebridge-ring 11.0.4 → 11.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +45 -45
- package/lib/api/rest-client.js +1 -1
- package/lib/api/ring-camera.js +1 -0
- package/lib/homebridge/camera-source.js +4 -0
- package/package.json +21 -21
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [11.0.7](https://github.com/dgreif/ring/compare/v11.0.6...v11.0.7) (2022-07-10)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* hide errors from snapshot request timeouts ([f997e34](https://github.com/dgreif/ring/commit/f997e340ad3c579d059ae07c11ad82ddc5ceb181)), closes [#932](https://github.com/dgreif/ring/issues/932)
|
|
11
|
+
* update dependencies ([ce0bf2a](https://github.com/dgreif/ring/commit/ce0bf2aa81d55e629931f38ba2c6ca16a79fa0d2))
|
|
12
|
+
|
|
13
|
+
### [11.0.6](https://github.com/dgreif/ring/compare/v11.0.5...v11.0.6) (2022-06-29)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* update dependencies ([0c91c3e](https://github.com/dgreif/ring/commit/0c91c3e6e9c93883cde6275960be0adf930297cf))
|
|
19
|
+
|
|
20
|
+
### [11.0.5](https://github.com/dgreif/ring/compare/v11.0.4...v11.0.5) (2022-06-12)
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Bug Fixes
|
|
24
|
+
|
|
25
|
+
* update dependencies ([088271f](https://github.com/dgreif/ring/commit/088271febe1ccd77981f0586dea811206d11ca42))
|
|
26
|
+
|
|
5
27
|
### [11.0.4](https://github.com/dgreif/ring/compare/v11.0.3...v11.0.4) (2022-05-29)
|
|
6
28
|
|
|
7
29
|
|
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
[](https://www.npmjs.com/package/homebridge-ring)
|
|
9
9
|
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
|
|
10
10
|
[](https://plugins.hoobs.org/plugin/homebridge-ring)
|
|
11
|
-
[](https://discord.gg/
|
|
11
|
+
[](https://discord.gg/CXryEzNC)
|
|
12
12
|
[](https://www.paypal.me/dustingreif)
|
|
13
13
|
|
|
14
14
|
This [Homebridge](https://github.com/nfarina/homebridge) plugin provides a platform for
|
|
@@ -70,28 +70,28 @@ Only include an optional parameter if you actually need it. Default behavior wi
|
|
|
70
70
|
}
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
Option
|
|
74
|
-
|
|
75
|
-
`alarmOnEntryDelay`
|
|
76
|
-
`beamDurationSeconds`
|
|
77
|
-
`hideDeviceIds`
|
|
78
|
-
`hideLightGroups`
|
|
79
|
-
`hideDoorbellSwitch`
|
|
80
|
-
`hideCameraLight`
|
|
81
|
-
`hideCameraMotionSensor`
|
|
82
|
-
`hideCameraSirenSwitch`
|
|
83
|
-
`hideInHomeDoorbellSwitch`
|
|
84
|
-
`hideAlarmSirenSwitch`
|
|
85
|
-
`hideUnsupportedServices`
|
|
86
|
-
`showPanicButtons`
|
|
87
|
-
`nightModeBypassFor`
|
|
88
|
-
`avoidSnapshotBatteryDrain`
|
|
89
|
-
`cameraStatusPollingSeconds` | `20`
|
|
90
|
-
`locationModePollingSeconds` | `20`
|
|
91
|
-
`locationIds`
|
|
92
|
-
`onlyDeviceTypes`
|
|
93
|
-
`ffmpegPath`
|
|
94
|
-
`debug`
|
|
73
|
+
| Option | Default | Explanation |
|
|
74
|
+
| ---------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
75
|
+
| `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) |
|
|
76
|
+
| `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. |
|
|
77
|
+
| `hideDeviceIds` | `[]` | Allows you to hide specific devices by an array of ids. The id for each device is logged when homebridge starts. |
|
|
78
|
+
| `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. |
|
|
79
|
+
| `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) |
|
|
80
|
+
| `hideCameraLight` | `false` | If `true`, hides the light for Ring cameras in HomeKit. |
|
|
81
|
+
| `hideCameraMotionSensor` | `false` | If `true`, hides the motion sensor for Ring cameras in HomeKit. |
|
|
82
|
+
| `hideCameraSirenSwitch` | `false` | If `true`, hides the siren switch for Ring cameras in HomeKit. |
|
|
83
|
+
| `hideInHomeDoorbellSwitch` | `false` | If `true`, hides the switch for in-home doorbells in HomeKit. |
|
|
84
|
+
| `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. |
|
|
85
|
+
| `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. |
|
|
86
|
+
| `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. |
|
|
87
|
+
| `nightModeBypassFor` | no Night Mode | Allows you to use Night mode to "Bypass and Arm" a Ring Alarm. Can be set to `all` for Away or `some` for Home. If set and Night mode is activated from HomeKit, any open contact sensors will automatically be bypassed. |
|
|
88
|
+
| `avoidSnapshotBatteryDrain` | false | Causes snapshots for battery cameras to be fetched at a minimum 10 minute interval to avoid draining the battery. |
|
|
89
|
+
| `cameraStatusPollingSeconds` | `20` | How frequently to poll for updates to your cameras and chimes (in seconds). Information like light/siren/volume/snooze status do not update in real time and need to be requested periodically. |
|
|
90
|
+
| `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. Will hide Location Mode switch if set to `0` |
|
|
91
|
+
| `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). |
|
|
92
|
+
| `onlyDeviceTypes` | All Device Types | A subset of device types to be shown. If set, all other device types will be hidden in HomeKit. |
|
|
93
|
+
| `ffmpegPath` | Uses `ffmpeg-for-homebridge` | A custom path to the `ffmpeg` executable. By default, the static binaries built in [ffmpeg-for-homebridge](https://github.com/oznu/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`. |
|
|
94
|
+
| `debug` | false | Turns on additional logging. In particular, ffmpeg logging. |
|
|
95
95
|
|
|
96
96
|
### Cameras
|
|
97
97
|
|
|
@@ -202,28 +202,28 @@ Note: Although homebridge has support for HomeKit Secure Video (HKSV), I will no
|
|
|
202
202
|
|
|
203
203
|
### Alarm/Location Modes
|
|
204
204
|
|
|
205
|
-
HomeKit Mode | Ring Mode
|
|
206
|
-
|
|
207
|
-
Off
|
|
208
|
-
Home
|
|
209
|
-
Away
|
|
210
|
-
Night
|
|
205
|
+
| HomeKit Mode | Ring Mode |
|
|
206
|
+
| ------------ | ----------------------------------------------------------- |
|
|
207
|
+
| Off | Disarmed |
|
|
208
|
+
| Home | Home |
|
|
209
|
+
| Away | Away |
|
|
210
|
+
| Night | Hidden by default. Configurable with `nightModeBypassFor` |
|
|
211
211
|
|
|
212
212
|
Entry delays and bypassed sensors (ex. for Home mode) are all controlled in the Ring app.
|
|
213
213
|
These settings will automatically be used by HomeKit.
|
|
214
214
|
|
|
215
215
|
### Siri Commands for Alarm/Location Modes
|
|
216
216
|
|
|
217
|
-
Siri Command
|
|
218
|
-
|
|
219
|
-
`Set Ring Alarm to Away`
|
|
220
|
-
`Arm my security system`
|
|
221
|
-
`Set Ring Alarm to Stay`
|
|
222
|
-
`Arm my security system for stay` | Home mode activated
|
|
223
|
-
`Disarm Ring Alarm`
|
|
224
|
-
`Disarm my security system`
|
|
225
|
-
`Turn on Ring Alarm`
|
|
226
|
-
`Turn off Ring Alarm`
|
|
217
|
+
| Siri Command | Outcome |
|
|
218
|
+
| --------------------------------- | --------------------------------------------------------------- |
|
|
219
|
+
| `Set Ring Alarm to Away` | Away mode activated |
|
|
220
|
+
| `Arm my security system` | Away mode activated |
|
|
221
|
+
| `Set Ring Alarm to Stay` | Home mode activated |
|
|
222
|
+
| `Arm my security system for stay` | Home mode activated |
|
|
223
|
+
| `Disarm Ring Alarm` | Disarmed |
|
|
224
|
+
| `Disarm my security system` | Disarmed |
|
|
225
|
+
| `Turn on Ring Alarm` | Turns on Ring Alarm Siren (unless hideAlarmSirenSwitch is set) |
|
|
226
|
+
| `Turn off Ring Alarm` | Turns off Ring Alarm Siren (unless hideAlarmSirenSwitch is set) |
|
|
227
227
|
|
|
228
228
|
### Changes Modes on Arrive/Leave Home
|
|
229
229
|
|
|
@@ -252,9 +252,9 @@ can then use these dummy switches to trigger your other automation (e.g. Arm/Dis
|
|
|
252
252
|
|
|
253
253
|
#### Example Home Automations
|
|
254
254
|
|
|
255
|
-
Trigger
|
|
256
|
-
|
|
257
|
-
People Arrive
|
|
258
|
-
People Leave
|
|
259
|
-
"Arrived Home" turns on | Set Ring Alarm mode to Off
|
|
260
|
-
"Left Home" turns on
|
|
255
|
+
| Trigger | Action |
|
|
256
|
+
| ----------------------- | --------------------------- |
|
|
257
|
+
| People Arrive | Turn on "Arrived Home" |
|
|
258
|
+
| People Leave | Turn on "Left Home" |
|
|
259
|
+
| "Arrived Home" turns on | Set Ring Alarm mode to Off |
|
|
260
|
+
| "Left Home" turns on | Set Ring Alarm mode to Away |
|
package/lib/api/rest-client.js
CHANGED
|
@@ -282,7 +282,7 @@ class RingRestClient {
|
|
|
282
282
|
if (response.statusCode) {
|
|
283
283
|
(0, util_1.logError)(`Request to ${url} failed with status ${response.statusCode}. Response body: ${(0, util_1.stringify)(response.body)}`);
|
|
284
284
|
}
|
|
285
|
-
else {
|
|
285
|
+
else if (!options.allowNoResponse) {
|
|
286
286
|
(0, util_1.logError)(`Request to ${url} failed:`);
|
|
287
287
|
(0, util_1.logError)(e);
|
|
288
288
|
}
|
package/lib/api/ring-camera.js
CHANGED
|
@@ -356,6 +356,7 @@ class RingCamera extends subscribed_1.Subscribed {
|
|
|
356
356
|
headers: {
|
|
357
357
|
accept: 'image/jpeg',
|
|
358
358
|
},
|
|
359
|
+
allowNoResponse: true,
|
|
359
360
|
}), { responseTimestamp, timeMillis } = response, timestampAge = Math.abs(responseTimestamp - timeMillis);
|
|
360
361
|
this.lastSnapshotTimestamp = timeMillis;
|
|
361
362
|
this.lastSnapshotTimestampLocal = Date.now() - timestampAge;
|
|
@@ -294,6 +294,10 @@ class CameraSource {
|
|
|
294
294
|
catch (e) {
|
|
295
295
|
this.cachedSnapshot = undefined;
|
|
296
296
|
(0, util_1.logDebug)(`Failed to cache snapshot for ${this.ringCamera.name} (${getDurationSeconds(start)}s), The camera currently reports that it is ${this.ringCamera.isOffline ? 'offline' : 'online'}`);
|
|
297
|
+
// log additioanl snapshot error message if one is present
|
|
298
|
+
if (e.message.includes('Snapshot')) {
|
|
299
|
+
(0, util_1.logDebug)(e.message);
|
|
300
|
+
}
|
|
297
301
|
}
|
|
298
302
|
}
|
|
299
303
|
getCurrentSnapshot() {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "homebridge-ring",
|
|
3
|
-
"version": "11.0.
|
|
3
|
+
"version": "11.0.7",
|
|
4
4
|
"description": "Homebridge plugin for Ring doorbells, cameras, security alarm system and smart lighting",
|
|
5
5
|
"main": "lib/homebridge/index.js",
|
|
6
6
|
"bin": {
|
|
@@ -39,46 +39,46 @@
|
|
|
39
39
|
"author": "dgreif",
|
|
40
40
|
"license": "MIT",
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@eneris/push-receiver": "^3.0.
|
|
43
|
-
"@homebridge/camera-utils": "^2.1.
|
|
42
|
+
"@eneris/push-receiver": "^3.0.2",
|
|
43
|
+
"@homebridge/camera-utils": "^2.1.2",
|
|
44
44
|
"@homebridge/plugin-ui-utils": "^0.0.19",
|
|
45
|
-
"werift": "0.15.
|
|
45
|
+
"werift": "0.15.9",
|
|
46
46
|
"@types/socket.io-client": "1.4.36",
|
|
47
47
|
"colors": "^1.4.0",
|
|
48
48
|
"debug": "^4.3.4",
|
|
49
|
-
"got": "^11.8.
|
|
49
|
+
"got": "^11.8.5",
|
|
50
50
|
"rxjs": "^7.5.5",
|
|
51
51
|
"socket.io-client": "^2.4.0",
|
|
52
|
-
"systeminformation": "^5.11.
|
|
52
|
+
"systeminformation": "^5.11.24",
|
|
53
53
|
"uuid": "^8.3.2",
|
|
54
|
-
"ws": "^8.
|
|
54
|
+
"ws": "^8.8.0"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@swc-node/register": "^1.5.1",
|
|
58
58
|
"@types/debug": "4.1.7",
|
|
59
|
-
"@types/jest": "
|
|
60
|
-
"@types/node": "
|
|
59
|
+
"@types/jest": "28.1.4",
|
|
60
|
+
"@types/node": "18.0.3",
|
|
61
61
|
"@types/uuid": "8.3.4",
|
|
62
62
|
"@types/ws": "^8.5.3",
|
|
63
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
64
|
-
"@typescript-eslint/parser": "5.
|
|
65
|
-
"concurrently": "^7.2.
|
|
63
|
+
"@typescript-eslint/eslint-plugin": "5.30.5",
|
|
64
|
+
"@typescript-eslint/parser": "5.30.5",
|
|
65
|
+
"concurrently": "^7.2.2",
|
|
66
66
|
"conventional-github-releaser": "3.1.5",
|
|
67
67
|
"dotenv": "16.0.1",
|
|
68
|
-
"esbuild": "^0.14.
|
|
69
|
-
"eslint": "8.
|
|
68
|
+
"esbuild": "^0.14.49",
|
|
69
|
+
"eslint": "8.19.0",
|
|
70
70
|
"eslint-config-prettier": "8.5.0",
|
|
71
|
-
"eslint-plugin-jest": "26.
|
|
72
|
-
"eslint-plugin-prettier": "4.
|
|
71
|
+
"eslint-plugin-jest": "26.5.3",
|
|
72
|
+
"eslint-plugin-prettier": "4.2.1",
|
|
73
73
|
"express": "4.18.1",
|
|
74
|
-
"homebridge": "1.
|
|
75
|
-
"jest": "28.1.
|
|
76
|
-
"prettier": "2.
|
|
74
|
+
"homebridge": "1.5.0",
|
|
75
|
+
"jest": "28.1.2",
|
|
76
|
+
"prettier": "2.7.1",
|
|
77
77
|
"reflect-metadata": "0.1.13",
|
|
78
78
|
"rimraf": "3.0.2",
|
|
79
79
|
"standard-version": "9.5.0",
|
|
80
|
-
"ts-jest": "28.0.
|
|
81
|
-
"typescript": "4.7.
|
|
80
|
+
"ts-jest": "28.0.5",
|
|
81
|
+
"typescript": "4.7.4"
|
|
82
82
|
},
|
|
83
83
|
"engines": {
|
|
84
84
|
"node": "^16",
|