homebridge-ring-hksv 14.3.1 → 14.3.2
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 +8 -0
- package/README.md +23 -47
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,11 @@
|
|
|
1
|
+
# homebridge-ring-hksv
|
|
2
|
+
|
|
3
|
+
## 14.3.2
|
|
4
|
+
|
|
5
|
+
### Main Changes
|
|
6
|
+
|
|
7
|
+
- [`b9dbe7e`](https://github.com/dgreif/ring/commit/b9dbe7e) Thanks [@dgreif](https://github.com/dgreif)! - This is the first version of homebridge-ring-hksv, which is a fork of homebridge-ring with support for HomeKit Secure Video (HKSV).
|
|
8
|
+
|
|
1
9
|
# homebridge-ring
|
|
2
10
|
|
|
3
11
|
## 14.3.0
|
package/README.md
CHANGED
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
[](https://plugins.hoobs.org/plugin/homebridge-ring-hksv)
|
|
11
11
|
[](https://buymeacoffee.com/trinityhades)
|
|
12
12
|
|
|
13
|
-
# homebridge-ring-hksv
|
|
14
13
|
|
|
15
14
|
`homebridge-ring-hksv` is a Homebridge platform plugin for Ring devices, with HomeKit Secure Video (HKSV) support.
|
|
16
15
|
|
|
@@ -18,40 +17,26 @@
|
|
|
18
17
|
|
|
19
18
|
This project is based on Dustin Greif's original Ring Homebridge ecosystem:
|
|
20
19
|
|
|
21
|
-
- Upstream plugin:
|
|
22
|
-
- Upstream API library:
|
|
20
|
+
- Upstream plugin: [dgreif/homebridge-ring](https://github.com/dgreif/homebridge-ring)
|
|
21
|
+
- Upstream API library: [dgreif/ring-client-api](https://github.com/dgreif/ring-client-api)
|
|
23
22
|
|
|
24
23
|
Big thanks to Dustin and all upstream contributors. This fork reuses and extends that foundation.
|
|
25
24
|
|
|
26
|
-
##
|
|
27
|
-
|
|
28
|
-
This plugin integrates Ring locations and devices into HomeKit via Homebridge, including:
|
|
29
|
-
|
|
30
|
-
- Ring cameras and doorbells
|
|
31
|
-
- Ring Alarm devices and sensors
|
|
32
|
-
- Ring chimes and intercoms
|
|
33
|
-
- Ring Smart Lighting and supported alarm-connected devices
|
|
34
|
-
- Thermostats, locks, outlets/switches, valves, and other supported accessory types
|
|
35
|
-
|
|
36
|
-
It also introduces HKSV-focused controls such as:
|
|
37
|
-
|
|
38
|
-
- `enableHksv`
|
|
39
|
-
- `disableHksvOnBattery`
|
|
40
|
-
- `hksvPrebufferLengthMs`
|
|
41
|
-
- `hksvFragmentLengthMs`
|
|
42
|
-
- `hksvMaxRecordingSeconds`
|
|
25
|
+
## Important Plugin Options
|
|
43
26
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
27
|
+
| Option | Purpose |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| `enableHksv` | Enables experimental HKSV support for eligible cameras |
|
|
30
|
+
| `disableHksvOnBattery` | Disables HKSV on battery cameras to reduce battery/network usage |
|
|
31
|
+
| `hksvPrebufferLengthMs` | HKSV prebuffer duration (minimum 4000ms) |
|
|
32
|
+
| `hksvFragmentLengthMs` | HKSV fragment duration target |
|
|
33
|
+
| `hksvMaxRecordingSeconds` | Optional safety cap for a recording session |
|
|
34
|
+
| `cameraVideoCodec` | Preferred H.264 encoder (`h264_videotoolbox` or `libx264`) |
|
|
35
|
+
| `hideDoorbellSwitch` / `hideCameraMotionSensor` / `hideCameraSirenSwitch` | Hides specific HomeKit-exposed services |
|
|
36
|
+
| `showPanicButtons` | Adds panic switches (use with caution) |
|
|
37
|
+
| `ffmpegPath` | Override FFmpeg binary path |
|
|
38
|
+
| `debug` | Enables additional logging |
|
|
39
|
+
| `disableLogs` | Disables plugin logging |
|
|
55
40
|
|
|
56
41
|
## Installation
|
|
57
42
|
|
|
@@ -81,31 +66,22 @@ Add a platform block with your Ring refresh token:
|
|
|
81
66
|
}
|
|
82
67
|
```
|
|
83
68
|
|
|
84
|
-
## Important Options
|
|
85
|
-
|
|
86
|
-
| Option | Purpose |
|
|
87
|
-
| --- | --- |
|
|
88
|
-
| `enableHksv` | Enables experimental HKSV support for eligible cameras |
|
|
89
|
-
| `disableHksvOnBattery` | Disables HKSV on battery cameras to reduce battery/network usage |
|
|
90
|
-
| `hksvPrebufferLengthMs` | HKSV prebuffer duration (minimum 4000ms) |
|
|
91
|
-
| `hksvFragmentLengthMs` | HKSV fragment duration target |
|
|
92
|
-
| `hksvMaxRecordingSeconds` | Optional safety cap for a recording session |
|
|
93
|
-
| `cameraVideoCodec` | Preferred H.264 encoder (`h264_videotoolbox` or `libx264`) |
|
|
94
|
-
| `hideDoorbellSwitch` / `hideCameraMotionSensor` / `hideCameraSirenSwitch` | Hides specific HomeKit-exposed services |
|
|
95
|
-
| `showPanicButtons` | Adds panic switches (use with caution) |
|
|
96
|
-
| `ffmpegPath` | Override FFmpeg binary path |
|
|
97
|
-
| `debug` | Enables additional logging |
|
|
98
|
-
| `disableLogs` | Disables plugin logging |
|
|
99
|
-
|
|
100
69
|
## HKSV Status
|
|
101
70
|
|
|
102
71
|
HKSV support is experimental and actively evolving. Behavior may vary by camera model, wired vs battery power, Ring API changes, and FFmpeg environment.
|
|
103
72
|
|
|
73
|
+
I currently am able to run 3 cameras with HKSV enabled on a Homebridge instance ran on a M4 Mac Mini 32GB of RAM.
|
|
74
|
+
Please report your experience and setup details to help improve support.
|
|
75
|
+
|
|
76
|
+
### Minimum specifications for HKSV:
|
|
77
|
+
[TBD - will be added as more users test and report their setups]
|
|
78
|
+
|
|
104
79
|
## Troubleshooting
|
|
105
80
|
|
|
106
81
|
For support and debugging:
|
|
107
82
|
|
|
108
83
|
- This repository issues: <https://github.com/trinityhades/homebridge-ring-hksv/issues>
|
|
84
|
+
|
|
109
85
|
- Upstream Ring wiki (token/auth/camera references): <https://github.com/dgreif/ring/wiki>
|
|
110
86
|
|
|
111
87
|
## Disclaimer
|
package/package.json
CHANGED