forked from hjdhjd/homebridge-unifi-protect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.schema.json
300 lines (271 loc) · 9.94 KB
/
config.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
{
"pluginAlias": "UniFi Protect",
"pluginType": "platform",
"headerDisplay": "Full HomeKit support UniFi Protect devices. See the [homebridge-unifi-protect](https://github.com/hjdhjd/homebridge-unifi-protect) developer page for detailed documentation.",
"footerDisplay": "A working **ffmpeg** installation is required for this plugin to work. For audio support, make sure your version of ffmpeg is compiled with support for **fdk-aac**.",
"singular": true,
"schema": {
"type": "object",
"properties": {
"controllers": {
"type": "array",
"title": "UniFi Protect Controllers",
"items": {
"type": "object",
"title": "UniFi Protect Controller",
"properties": {
"address": {
"type": "string",
"title": "Controller Address",
"required": true,
"format": "hostname",
"placeholder": "e.g. 1.2.3.4",
"description": "Hostname or IP address of your UniFi Protect controller."
},
"doorbellMessages": {
"type": "array",
"title": "Doorbell Messages",
"items": {
"type": "object",
"title": "Message Entry Object",
"properties": {
"duration": {
"type": "integer",
"title": "Message Duration (seconds)",
"required": false,
"minimum": 0,
"placeholder": "e.g. 60",
"description": "Length of time to display the message on your doorbell. Use 0 to display the message indefinitely. Default: 60."
},
"message": {
"type": "string",
"title": "Message Name",
"required": false,
"maxLength": 30,
"placeholder": "e.g. I'll be there soon.",
"description": "Message to display on your doorbell. Default: None."
}
}
}
},
"mqttTopic": {
"type": "string",
"title": "MQTT Base Topic",
"required": false,
"placeholder": "e.g. unifi/protect",
"description": "The base MQTT topic to publish to. Default: unifi/protect."
},
"mqttUrl": {
"type": "string",
"title": "MQTT Broker URL",
"required": false,
"format": "uri",
"placeholder": "e.g. mqtt://1.2.3.4",
"description": "URL for the MQTT broker you'd like to publish event messages to. Default: None."
},
"name": {
"type": "string",
"title": "Controller Name",
"required": false,
"placeholder": "e.g. UNVR",
"description": "Name for this UniFi Protect controller to be used for logging purposes. password. Default: Defined by the controller."
},
"password": {
"type": "string",
"title": "Controller Password",
"required": true,
"placeholder": "e.g. unifi-protect-password",
"description": "UniFi Protect password for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
},
"refreshInterval": {
"type": "integer",
"title": "Controller Refresh Interval (seconds)",
"required": false,
"minimum": 2,
"maximum": 30,
"placeholder": "e.g. 10",
"description": "Refresh interval to check for cameras that have been added or removed to a controller. For UCK Gen2+ devices only, this is also the interval used to check for motion events. Default: 5 seconds for UCK Gen2+, 10 seconds for UniFI OS."
},
"username": {
"type": "string",
"title": "Controller Username",
"required": true,
"placeholder": "e.g. some-unifi-protect-user",
"description": "UniFi Protect username for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
}
}
}
},
"name": {
"type": "string",
"title": "Plugin Name",
"required": true,
"placeholder": "UniFi Protect",
"description": "Name to use for Homebridge logging purposes. Default: UniFi Protect."
},
"options": {
"type": "array",
"title": "Feature Options",
"items": {
"type": "string",
"title": "Feature Option",
"required": false,
"description": "Enter only one option per entry. See project page for the complete list of available options.",
"placeholder": "e.g. Disable.Stream.High"
}
},
"motionDuration": {
"type": "integer",
"title": "Motion Event Duration (seconds)",
"required": false,
"minimum": 5,
"maximum": 20,
"placeholder": "e.g. 10",
"description": "Duration of a single motion event. Setting this too low will potentially cause a lot of excess notifications. Default: 10."
},
"ringDuration": {
"type": "integer",
"title": "Ring Event Duration (seconds)",
"required": false,
"minimum": 3,
"maximum": 10,
"placeholder": "e.g. 3",
"description": "Duration of a single ring event. Default: 3."
},
"verboseFfmpeg": {
"type": "boolean",
"title": "Verbose FFmpeg Logging",
"required": false,
"description": "Enable additional logging for FFmpeg. This will create a lot of logging when video streams are running. Default: false."
},
"videoEncoder": {
"type": "string",
"title": "Video Encoder",
"required": false,
"placeholder": "e.g. h264_omx",
"description": "FFmpeg video encoder to use for transcoding. Useful for hardware-accelerated video encoding such as on a Raspberry Pi. Default: libx264."
},
"videoProcessor": {
"type": "string",
"title": "Video Processor",
"required": false,
"placeholder": "e.g. ffmpeg",
"description": "Location of ffmpeg or your preferred video processor. Default: builtin or in your local path."
}
}
},
"layout": [
{
"type": "section",
"title": "UniFi Protect Controllers",
"expandable": true,
"expanded": false,
"items": [
{
"key": "controllers",
"type": "array",
"name": " ",
"description": "Provide the IP address and login details of your UniFi Protect controllers.",
"orderable": false,
"buttonText": "Add UniFi Protect Controller",
"items": [
"controllers[].address",
"controllers[].username",
"controllers[].password",
{
"key": "controllers[]",
"type": "section",
"title": "Doorbell Message Presets",
"expandable": true,
"expanded": false,
"items": [
{
"key": "controllers[].doorbellMessages",
"type": "array",
"name": " ",
"description": "Create additional message presets to display on your UniFi Protect Doorbell.",
"orderable": false,
"buttonText": "Add Doorbell Message",
"items": [
"controllers[].doorbellMessages[].message",
"controllers[].doorbellMessages[].duration"
]
}
]
},
{
"key": "controllers[]",
"type": "section",
"title": "Optional Settings",
"expandable": true,
"expanded": false,
"items": [
{
"description": "These settings are optional. The defaults work well for almost everyone.",
"items": [
"controllers[].name",
"controllers[].refreshInterval"
]
}
]
},
{
"key": "controllers[]",
"type": "section",
"title": "MQTT Settings",
"expandable": true,
"expanded": false,
"items": [
{
"description": "MQTT support will only be enabled if an MQTT broker URL is specified below.",
"items": [
"controllers[].mqttUrl",
"controllers[].mqttTopic"
]
}
]
}
]
}
]
},
{
"type": "section",
"title": "Plugin Feature Options (Optional)",
"expandable": true,
"expanded": false,
"items": [
{
"key": "options",
"type": "array",
"name": " ",
"description": "Feature options allow you to further customize the behavior of this plugin such as the ability to show or hide cameras or specify stream quality.",
"orderable": false,
"buttonText": "Add Feature Option",
"items": [
"options[]"
]
}
]
},
{
"type": "section",
"title": "Additional Settings (Optional)",
"expandable": true,
"expanded": false,
"items": [
{
"description": "These settings should be rarely used or needed by most people. Use these with caution.",
"items": [
"name",
"videoProcessor",
"videoEncoder",
"verboseFfmpeg",
"motionDuration",
"ringDuration"
]
}
]
}
]
}