-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathconfig.schema.json
202 lines (180 loc) · 6.2 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
{
"pluginAlias": "UniFi Access",
"pluginType": "platform",
"headerDisplay": "Full HomeKit support UniFi Access devices. See the [homebridge-unifi-access](https://github.com/hjdhjd/homebridge-unifi-access) developer page for detailed documentation.",
"singular": true,
"customUi": true,
"schema": {
"type": "object",
"properties": {
"controllers": {
"type": "array",
"title": "UniFi Access Controllers",
"items": {
"type": "object",
"title": "UniFi Access 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 Access controller."
},
"mqttTopic": {
"type": "string",
"title": "MQTT Base Topic",
"required": false,
"placeholder": "e.g. unifi/access",
"description": "The base MQTT topic to publish to. Default: unifi/access."
},
"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 Access controller to be used for logging purposes. Default: Defined by the controller."
},
"password": {
"type": "string",
"title": "Controller Password",
"required": true,
"placeholder": "e.g. unifi-access-password",
"description": "UniFi Access password for this controller. Creating a homebridge-specific local user is strongly encouraged for security and sanity."
},
"username": {
"type": "string",
"title": "Controller Username",
"required": true,
"placeholder": "e.g. some-unifi-access-user",
"description": "UniFi Access 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,
"default": "UniFi Access",
"description": "Name to use for Homebridge logging purposes. Default: UniFi Access."
},
"options": {
"type": "array",
"title": "Feature Options",
"items": {
"type": "string",
"title": "Feature Option",
"required": false,
"description": "Enter only one option per entry. See the plugin documentation for the complete list of available options or use the feature options webUI tab above.",
"placeholder": "e.g. Disable.Device"
}
},
"ringDelay": {
"type": "integer",
"title": "Doorbell Ring Delay (seconds)",
"required": false,
"minimum": 0,
"maximum": 60,
"placeholder": "e.g. 5",
"description": "Delay between doorbell rings. Setting this to a non-zero value will prevent multiple rings of a doorbell over the specified duration. Default: 0."
}
}
},
"layout": [
{
"type": "section",
"title": "UniFi Access Controllers",
"expandable": true,
"expanded": false,
"items": [
{
"key": "controllers",
"type": "array",
"name": " ",
"description": "Provide the IP address and login details of your UniFi Access controllers.",
"orderable": false,
"buttonText": "Add UniFi Access Controller",
"items": [
"controllers[].address",
"controllers[].username",
"controllers[].password",
{
"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"
]
}
]
},
{
"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 devices. You can use the the feature options tab above (recommended) to customize these settings or enter them manually below.",
"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"
]
}
]
}
]
}