generated from homebridge/homebridge-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 4
/
config.schema.json
151 lines (150 loc) · 5.16 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
{
"pluginAlias": "Ondus",
"pluginType": "platform",
"singular": true,
"headerDisplay": "Ondus plugin for Grohe Sense Guard water control and Sense leakage detectors",
"footerDisplay": "For a detailed description, see the [wiki](https://github.com/faune/homebridge-plugin-ondus/wiki/Configuration) • Report an [issue](https://github.com/faune/homebridge-grohe-sense/issues/new)",
"schema": {
"type": "object",
"properties": {
"name": {
"description": "Plugin name as displayed in the HomeBridge log",
"type": "string",
"required": true,
"default": "Ondus"
},
"valve_control" : {
"title":"Control Sense Guard from HomeKit",
"description":"Only enable this checkbox if you really, really, REALLY think controlling your Sense Guard main water inlet valve from HomeKit is a good idea. If this option is left unchecked (or not configured in config.json) the default behavior is to simply display the current state of the valve. Requests to alter the valve state will be ignored.",
"type": "boolean",
"required": false,
"default": false
},
"refresh_token": {
"description":"Grohe Ondus API refresh token",
"type" : "string",
"required": false,
"default": "<Paste refresh token here>"
},
"username" : {
"description":"Optional username for Grohe Ondus for acquiring refresh token automatically",
"type": "string",
"required": false,
"default": ""
},
"password" : {
"description":"Optional password for Grohe Ondus for acquiring refresh token automatically",
"type": "string",
"required": false,
"default": ""
},
"refresh_interval" : {
"title":"How often (in seconds) to query the Ondus API for new Sense data",
"description":"Sense water leakage detectors will by default report sensor data once every 24 hours, unless a configured notification threshold has been exceeded. Default refresh value is by default 1 hour (3600 seconds). The Sense Guard main water inlet valve will always be queried in realtime when required.",
"type": "integer",
"required": false,
"default" : 3600,
"minimum" : 60,
"maximum" : 86400
},
"throttle_support" : {
"title":"Enable Ondus API throttling",
"description":"If you experience HTTP error \"Too Many Requests\" its time to enable Throttling! Note that this can slow you Homebridge instance down, so you need to play with the limits below to hit that special sweetspot for yourself.",
"type": "boolean",
"required": false,
"default": true
},
"throttle_rate" : {
"title":"Throttle rate",
"description":"How many requests can be sent every rate period. (default: 6)",
"type": "integer",
"required": false,
"default" : 6,
"minimum" : 1,
"maximum" : 40
},
"throttle_rateper" : {
"title":"Throttle rate period",
"description":"Number of msec in which rate requests may be sent. (default: 1000)",
"type": "integer",
"required": false,
"default" : 1000,
"minimum" : 100,
"maximum" : 10000
},
"throttle_concurrent" : {
"title":"Throttle concurrent requests",
"description":"How many requests can be sent concurrently. (default: 2)",
"type": "integer",
"required": false,
"default" : 2,
"minimum" : 1,
"maximum" : 10
},
"fakegato_support" : {
"title":"Enable Eve History support",
"description":"Export historical sensor data for temperature and humidity to HomeKit using the proprietary Elgato Eve protocol. This feature will only be available from the Eve app, and will not display anything in the default Home app.",
"type": "boolean",
"required": false,
"default": false
},
"shtf_mode" : {
"title":"SHTF Mode",
"description":"Shit happens. Nobody's perfect. So when you do smell it, please enable this and dump the log into a new issue using link in footer.",
"type": "boolean",
"required": false,
"default": false
}
}
},
"layout": [
{
"type": "flex",
"flex-flow": "row wrap",
"items": [
{
"type": "flex",
"flex-flow": "column",
"items": [
"name",
"valve_control"
]
}
]
},
{
"ref": "login",
"type": "fieldset",
"expandable": true,
"title": "Login Credentials",
"items": [
"refresh_token",
"username",
"password"
]
},
{
"ref": "network",
"type": "fieldset",
"expandable": true,
"title": "Network",
"items": [
"refresh_interval",
"throttle_support",
"throttle_rate",
"throttle_rateper",
"throttle_concurrent"
]
},
{
"ref": "advanced",
"type": "fieldset",
"expandable": true,
"title": "Advanced",
"items": [
"fakegato_support",
"shtf_mode"
]
}
]
}