forked from lukasroegner/homebridge-dyson-pure-cool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.schema.json
185 lines (185 loc) · 11.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
{
"pluginAlias": "DysonPureCoolPlatform",
"pluginType": "platform",
"headerDisplay": "This plugin supports the Dyson Pure Cool (DP04, TP04, TP06, TP07, TP09), Dyson Pure Cool Link (DP01, TP02), Dyson Hot+Cool (HP02, HP04, HP06, HP07, HP09) and Dyson Pure Humidify+Cool (PH01, PH02, PH03, PH04) devices.",
"footerDisplay": "For help please visit the [GitHub repository](https://github.com/lukasroegner/homebridge-dyson-pure-cool).",
"schema": {
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"title": "Device",
"type": "object",
"properties": {
"ipAddress": {
"title": "IP Address",
"type": "string",
"required": true,
"placeholder": "XXX.XXX.XXX.XXX",
"format": "ipv4",
"description": "Local IP address of the device. Leave out leading zeros (e.g. 192.168.0.1 instead of 192.168.000.001)."
},
"serialNumber": {
"title": "Serial",
"type": "string",
"required": true,
"default": "XXX-EU-XXXXXXXX",
"description": "Serial number of the device."
},
"credentials": {
"title": "Credentials",
"type": "string",
"required": true,
"description": "The credentials for connecting to the device. They can be retrieved via the credentials generator (website), please consult the README on how to retrieve the credentials."
},
"useFahrenheit": {
"title": "Use Fahrenheit for thermostat",
"type": "boolean",
"default": false,
"description": "If set to true, it will use Fahrenheit for temperature scale in the Home app."
},
"enableAutoModeWhenActivating": {
"title": "Enable Auto Mode",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, the Auto mode is enabled when you activate the device in the Home app."
},
"enableOscillationWhenActivating": {
"title": "Activate with Oscillation",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, oscillation is enabled when you activate the device."
},
"enableNightModeWhenActivating": {
"title": "Enable Night Mode",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, night mode is enabled when you activate the device."
},
"isNightModeEnabled": {
"title": "Expose Night Mode",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a switch is exposed for the night mode."
},
"isJetFocusEnabled": {
"title": "Expose Jet Focus",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a switch is exposed for the jet focus. DP01, TP02 and HP02 are not supported."
},
"isContinuousMonitoringEnabled": {
"title": "Expose Continuous Monitoring",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a switch is exposed for the continuous monitoring."
},
"isTemperatureSensorEnabled": {
"title": "Expose Temperature Sensor",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a separate temperature sensor is exposed. Only used for non-heating devices. If set to false, the temperature is added as characteristic to the air purifier (does not show up in the Apple Home app)."
},
"isTemperatureIgnored": {
"title": "Ignore Temperature",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, the temperature measurement is completely ignored and not exposed. Can only used for non-heating devices."
},
"temperatureOffset": {
"title": "Temperature Offset",
"type": "number",
"default": 0.0,
"description": "Negatively or positively offset the value reported by the temperature sensor before exposing it to HomeKit. Provide the value in degree Celsius."
},
"isHumiditySensorEnabled": {
"title": "Expose Humidity Sensor",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a separate humidity sensor is exposed. If set to false, the humidity is added as characteristic to the air purifier (supported in the Apple Home app)."
},
"isHumidityIgnored": {
"title": "Ignore Humidity",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, the humidity measurement is completely ignored and not exposed. Can only used for non-humidifier devices."
},
"humidityOffset": {
"title": "Humidity Offset",
"type": "number",
"default": 0.0,
"description": "Negatively or positively offset the value reported by the humidity sensor before exposing it to HomeKit. Provide the value in degree Celsius."
},
"isAirQualitySensorEnabled": {
"title": "Expose Air Quality Sensor",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, a separate air quality sensor is exposed. If set to false, the air quality is added as characteristic to the air purifier (supported in the Apple Home app)."
},
"isAirQualityIgnored": {
"title": "Ignore Air Quality",
"type": "boolean",
"default": false,
"required": true,
"description": "If set to true, the air quality measurements are completely ignored and not exposed."
},
"isSingleSensorAccessoryModeEnabled": {
"title": "Single Sensor Accessory Mode",
"type": "boolean",
"default": false,
"description": "If set to true, all sensors are exposed to HomeKit in a single accessory instead of multiple accessories. Only has an effect if the previous settings for enabling sensors are set to true."
},
"isSingleAccessoryModeEnabled": {
"title": "Single Accessory Mode",
"type": "boolean",
"default": false,
"description": "If set to true, all services are exposed to HomeKit in a single accessory instead of multiple accessories. If set to true, the single sensor accessory mode has no effect. Use this mode if you are using a third-party HomeKit app and want all services grouped into a single accessory."
},
"isFullRangeHumidity": {
"title": "Full Range Humidity",
"type": "boolean",
"default": false,
"description": "Only for PH01/PH02/PH03/PH04. If set to true, the range of the target humidity control will be from 0% to 100% instead of translating it to the allowed range (30% to 70%) of the Dyson."
},
"isHeatingDisabled": {
"title": "Disable Heating",
"type": "boolean",
"default": false,
"description": "Only for HP02/HP04/HP06/HP07/HP09. If set to true, the heating controls are not exposed to HomeKit."
},
"isHeatingSafetyIgnored": {
"title": "Heating Safety Behavior Ignored",
"type": "boolean",
"default": false,
"description": "Only for HP02/HP04/HP06/HP07/HP09. If set to true, this overrides the default safety feature to allow heat to be turned on along with the fan if the fan was heating when last turned off. By default, the heat is disabled when turning on the fan in the Dyson app."
}
}
}
},
"updateInterval": {
"title": "Update Interval",
"type": "integer",
"placeholder": "60000",
"description": "The interval (in milliseconds) at which updates of the sensors are requested from the Dyson devices."
},
"credentialsGeneratorPort": {
"title": "Port number for Credentials Generator",
"type": "integer",
"placeholder": "48000",
"description": "The port number for the (credentials generator) website. Only change this setting in case of a port collision."
}
}
}
}