forked from bloomkd46/homebridge-iRobot
-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.schema.json
375 lines (375 loc) · 10.6 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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
{
"pluginAlias": "iRobotPlatform",
"pluginType": "platform",
"singular": true,
"customUi": true,
"headerDisplay": "<p align=\"center\"><img width=\"60%\" src=\"https://user-images.githubusercontent.com/75853497/143301930-e2f3bc9a-9f0d-4e03-95f8-c69769712ca5.png\"></p><p align=\"center\">For help and support please visit the <a href=\"https://github.com/taurgis/homebridge-iRobot-v2/wiki\">GitHub Wiki</a>. I hope you find this plugin useful!</p>",
"schema": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "For logging purposes",
"type": "string",
"required": true,
"default": "iRobot"
},
"email": {
"title": "Email",
"type": "string",
"required": true,
"placeholder": "[email protected]",
"format": "email",
"condition": {
"functionBody": "return !model.manualDiscovery"
}
},
"password": {
"title": "Password",
"type": "string",
"required": true,
"x-schema-form": {
"type": "password"
},
"condition": {
"functionBody": "return !model.manualDiscovery"
}
},
"roombas": {
"title": "Roomba's",
"type": "array",
"buttonText": "Add Roomba",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Device Name",
"description": "Name to display in custom ui and Homekit",
"type": "string",
"required": true,
"placeholder": "Roomba"
},
"blid": {
"title": "Blid",
"description": "Your roomba's blid/username (Hint: if you enter your iRobot credentials above you can find your roomba's blid/username in the devices tab above)",
"type": "string",
"required": true
},
"password": {
"title": "Password",
"description": "Your roomba's password (Hint: if you enter your iRobot credentials above you can find your roomba's password in the devices tab above)",
"required": true,
"type": "string"
},
"autoConfig": {
"title": "Automatic Configuration",
"description": "Disable this to manually enter roomba credentials (IP, model, etc)",
"type": "boolean",
"default": true,
"required": true
},
"ip": {
"title": "IP Address",
"description": "Your roomba's ip address (Hint: if you enter your iRobot credentials above you can find your roomba's ip address in the devices tab above)",
"type": "string",
"format": "ipv4",
"required": true,
"condition": {
"functionBody": "return !model.roombas[arrayIndices].autoConfig"
}
},
"model": {
"title": "Model",
"description": "Your roomba's model (Hint: if you enter your iRobot credentials above you can find your roomba's model in the devices tab above)",
"type": "string",
"required": true,
"condition": {
"functionBody": "return !model.roombas[arrayIndices].autoConfig"
}
},
"multiRoom": {
"title": "Room-By-Room Support",
"description": "Does your roomba support room-by-room cleaning",
"type": "boolean",
"required": true,
"condition": {
"functionBody": "return !model.roombas[arrayIndices].autoConfig"
}
},
"info": {
"title": "Additional Information",
"type": "object",
"properties": {
"sw": {
"title": "Software Version",
"description": "Your Roomba's software version",
"type": "string",
"required": false
},
"serialNum": {
"title": "Serial Number",
"description": "Your Roomba's serial number",
"type": "string",
"required": false
},
"mac": {
"title": "Mac Address",
"description": "Your Roomba's mac address",
"type": "string",
"required": false
},
"ver": {
"title": "Protocol Version",
"description": "Your Roomba's protocol version (defualt 2)",
"type": "number",
"default": 2,
"max": 3,
"min": 1,
"required": false
},
"sku": {
"title": "sku",
"description": "Your Roomba's sku",
"type": "string",
"required": false
}
},
"condition": {
"functionBody": "return !model.roombas[arrayIndices].autoConfig"
}
}
}
},
"condition": {
"functionBody": "return model.manualDiscovery"
}
},
"manualDiscovery": {
"title": "Manual Configuration",
"description": "Select this to manually configure your roomba's instead of using an email & password",
"type": "boolean",
"default": false,
"required": true
},
"lowBattery": {
"title": "Low Battery Warning",
"type": "integer",
"required": false,
"minimum": 0,
"maximum": 100,
"default": 20,
"description": "At What Percent Should Homekit Display Low Battery Warning"
},
"offAction": {
"title": "Off Action",
"type": "string",
"default": "pause:dock",
"oneOf": [
{
"title": "Pause And Dock",
"enum": [
"pause:dock"
]
},
{
"title": "Stop And Dock",
"enum": [
"stop:dock"
]
},
{
"title": "Pause And Find",
"enum": [
"pause:find"
]
},
{
"title": "Stop And Find",
"enum": [
"stop:find"
]
},
{
"title": "Pause",
"enum": [
"pause:none"
]
},
{
"title": "Stop",
"enum": [
"stop:none"
]
}
],
"required": true,
"description": "What To Do When You Set The Switch To Off"
},
"status": {
"title": "Homekit Active",
"type": "string",
"default": "cycle:clean",
"oneOf": [
{
"title": "Job Active",
"enum": [
"cycle:clean"
]
},
{
"title": "Running",
"enum": [
"phase:run"
]
},
{
"title": "Not Charging",
"enum": [
"inverted:phase:charge"
]
},
{
"title": "Always Off",
"enum": [
false
]
},
{
"title": "Always On",
"enum": [
true
]
}
],
"required": true,
"description": "What To Make Homekit Display As Active"
},
"eveStatus": {
"title": "Eve Inactive",
"type": "string",
"default": "inverted:cycle:clean",
"oneOf": [
{
"title": "No Job Active",
"enum": [
"inverted:cycle:clean"
]
},
{
"title": "Not Cleaning",
"enum": [
"inverted:phase:run"
]
},
{
"title": "Stopped",
"enum": [
"phase:stop"
]
},
{
"title": "Charging",
"enum": [
"phase:charge"
]
},
{
"title": "Docking",
"enum": [
"cycle:dock"
]
},
{
"title": "Stuck",
"enum": [
"phase:stuck"
]
},
{
"title": "Always Inactive",
"enum": [
false
]
}
],
"required": true,
"description": "What To Make Eve Display As Inactive"
},
"bin": {
"title": "Roomba Bin",
"type": "string",
"default": "filter:contact",
"oneOf": [
{
"title": "Filter, Contact, And Motion",
"enum": [
"filter:contact:motion"
]
},
{
"title": "Filter And Contact",
"enum": [
"filter:contact"
]
},
{
"title": "Filter And Motion",
"enum": [
"filter:motion"
]
},
{
"title": "Contact And Motion",
"enum": [
"contact:motion"
]
},
{
"title": "Filter",
"enum": [
"filter"
]
},
{
"title": "Contact",
"enum": [
"contact"
]
},
{
"title": "Motion",
"enum": [
"motion"
]
},
{
"title": "None",
"enum": [
"none"
]
}
],
"required": true,
"description": "What To Use To Display If The Roomba's Bin Is Full \n(Filters only show up in eve,\n Contact Sensors give you a notification when the bin is full and when you empty it,\n Motion Sensors only notify you if the bin is full.)"
},
"ignoreMultiRoomBin": {
"title": "Ignore Bin On Multi-Room Roomba's",
"type": "boolean",
"default": true,
"required": true
},
"hideStuckSensor": {
"title": "Hide Stuck Sensor",
"type": "boolean",
"required": true,
"default": false
},
"disableMultiRoom": {
"title": "Disable Multi-Room Support",
"type": "boolean",
"required": true,
"default": false
}
}
}
}