generated from homebridge/homebridge-plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
config.schema.json
201 lines (200 loc) · 6.39 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
{
"pluginAlias": "Flo-by-Moen",
"pluginType": "platform",
"singular": true,
"footerDisplay": "Flo Module Configuration",
"schema": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": true,
"default": "Flo-by-Moen",
"placeholder": "e.g. Flo By Moen"
},
"auth": {
"title": "Authorization",
"type": "object",
"properties": {
"username": {
"title": "Flo Username",
"type": "string",
"required": true,
"x-schema-form": {
"type": "username"
}
},
"password": {
"title": "Flo Password",
"type": "string",
"required": true,
"x-schema-form": {
"type": "password"
}
}
}
},
"disableCache": {
"title": "Disable Caching of Flo Token",
"type": "boolean",
"default": false
},
"showTemperatureAndHumidity": {
"title": "Show Water Sensor Temperature and Humidity in HomeKit",
"type": "boolean",
"default": true,
"description": "Display Water Sensor(s) area temperature and humidity in HomeKit."
},
"enableValveControl": {
"title": "Enable Valve Control in HomeKit",
"type": "boolean",
"default": false,
"description": "Enable or disable Smart Water Shutoff within HomeKit."
},
"showHealthTestSwitch": {
"title": "Run Health Test from HomeKit",
"type": "boolean",
"default": false,
"description": "Display a Health Test switch button to start a manual Health Test in Flo."
},
"showAuxSwitch": {
"title": "Create additional switch for turning on/off the water valve",
"type": "boolean",
"default": false,
"description": "Display an auxiliary water on/off switch. This is useful in Apple's Home application, other Homekit applications such as Eve exposes the Flo valve for automation."
},
"treatWarningAsCritical": {
"title": "Treat Warning as Critical Events",
"type": "boolean",
"default": false,
"description": "This option allows <i>Warning</i> to be treated as <i>Critical</i> events thus trigging the alarm."
},
"clearOnNoLeak": {
"title": "Auto Clear Leak Detection",
"type": "boolean",
"default": false,
"description": "By default the leak event remain active until it is clear within the flo system, this option allows the plug-in to auto clear when water is no longer detected."
},
"deviceRefresh": {
"title": "Device Refresh Interval (seconds)",
"type": "integer",
"default": 90,
"description": "Poll interval to obtain device updates in seconds. <b>Please note:</b> A very low value may cause lockout to your account and/or API errors.",
"minimum": 15,
"maximum": 3600
},
"pingRefresh": {
"title": "Periodically Force Refresh",
"type": "integer",
"description": "Force a cloud refresh of devices at a regular interval. This option should only be used if devices do not seems to updates for multiple hours.",
"minimum": 1,
"maximum": 24
},
"offlineTimeLimit": {
"title": "Offline Time Limit (hours)",
"type": "integer",
"description": "Number of house with no refresh before considering device offline.",
"default": 4,
"minimum": 2,
"maximum": 24
},
"sleepRevertMinutes": {
"title": "Sleep Time",
"type": "integer",
"default": 120,
"description": "Sleep Mode is a system mode that quiets all monitoring and alerting, effectively putting the Flo System to sleep. This value represents the length of time to place the system in sleep mode.",
"oneOf": [{
"title": "2 Hours",
"enum": [
120
]
},
{
"title": "24 Hours",
"enum": [
1440
]
},
{
"title": "72 Hours",
"enum": [
4320
]
}
]
},
"excludedDevices": {
"type": "array",
"items": {
"type": "string",
"description": "Serial Number"
}
},
"retryErrorDisplay": {
"title": "Maximum number of refresh error before alerting in log.",
"type": "integer",
"default": 3,
"description": "At times the plug-in reports a 502 error. This is a communication error with the Flo server. An occasional error will not effect operations but can fill up log. This value define number of consecutive failure before logging.",
"minimum": 3
},
"showFloTemperature": {
"title": "Show the temperature of Flo value.",
"type": "boolean",
"default": true
},
"showGPMPSIasLight": {
"title": "Show the current Gallons Per Minute (GPM) and Water Pressure (PSI) value as lux sensors.",
"type": "boolean",
"default": false
}
}
},
"layout": [{
"type": "fieldset",
"items": [
"name",
"auth.username",
"auth.password",
"deviceRefresh",
"sleepRevertMinutes",
"showTemperatureAndHumidity",
"showHealthTestSwitch",
"enableValveControl",
"showAuxSwitch",
"offlineTimeLimit"
]
},
{
"type": "fieldset",
"expandable": true,
"title": "Advanced Options",
"items": [
"showFloTemperature",
"showGPMPSIasLight",
"treatWarningAsCritical",
"clearOnNoLeak",
{
"key": "disableCache",
"description": "Disabled the storage of Flo access token to local Homebridge server. Refresh token at start-up."
},
{
"key": "excludedDevices",
"title": "Excluded Devices",
"description": "A list of devices to exclude from HomeKit. Users device serial number which can be found in the Flo app.",
"add": "Add Another Device",
"type": "array",
"items": [
{
"type": "fieldset",
"items": [
"excludedDevices[]"
]
}
]
},
"retryErrorDisplay"
]
}
]
}