homebridge-tado-smart-thermostat/config.schema.json at master · lukasroegner/homebridge-tado-smart-thermostat · GitHub

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
{
    "pluginAlias": "TadoPlatform",
    "pluginType": "platform",
    "headerDisplay": "This project is a homebridge plugin for Tado heating devices. Each zone (i.e. room) in the Tado app is exposed to HomeKit as a thermostat. Each hotwater zone in the Tado app is exposed to HomeKit as a switch.",
    "footerDisplay": "For help please visit the [GitHub repository](https://github.com/lukasroegner/homebridge-tado-smart-thermostat).",
    "schema": {
        "type": "object",
        "properties": {
            "username": {
                "title": "Username",
                "type": "string",
                "required": true,
                "placeholder": "YOUR-USER-NAME",
                "format": "email",
                "description": "The user name that you use for the app and the web app of Tado."
            },
            "password": {
                "title": "Password",
                "type": "string",
                "placeholder": "YOUR-PASSWORD",
                "required": true,
                "description": "The password that you use for the app and the web app of Tado."
            },
            "homeName": {
                "title": "Home Name",
                "type": "string",
                "placeholder": "YOUR-HOME-NAME",
                "required": true,
                "description": "The name of the home you want to expose to HomeKit as written in the Tado app. Has to be the exact same name as in the web app of Tado."
            },
            "areOccupancySensorsEnabled": {
                "title": "Occupancy Sensors",
                "type": "boolean",
                "default": false,
                "description": "Determines whether occupancy sensors are exposed for the Tado users."
            },
            "isGlobalHomeAwayEnabled": {
                "title": "Global Home/Away",
                "type": "boolean",
                "default": false,
                "description": "Determines whether the global Home/Away state is exposed as occupancy sensor with controls to HomeKit."
            },
            "isAutoAssistEnabled": {
                "title": "Auto Assist Enabled",
                "type": "boolean",
                "default": false,
                "description": "Determines whether you have the Tado 'Auto-Assist' for automatic geo-fencing booked and enabled. Only used when global Home/Away is enabled."
            },
            "areWindowSensorsHidden": {
                "title": "Window Sensors Hidden",
                "type": "boolean",
                "default": false,
                "description": "By default, windows sensors are shown if window detection is enabled for their zones. Use this settings to completely hide them."
            },
            "switchToAutoInNextTimeBlock": {
                "title": "Auto in Next Time Block",
                "type": "boolean",
                "default": false,
                "description": "If enabled, the state of the zone is switch back to AUTO in the next time block of the time table (same behavior as the zone setting for manual changes on the device itself)."
            },
            "isAlternativeStateLogicEnabled": {
                "title": "Alternative State Logic",
                "type": "boolean",
                "default": false,
                "description": "If enabled, a different logic is used for displaying the target state of the thermostate (AUTO, HEAT, OFF). This alternative logic shows the target state as OFF if the thermostat is set to OFF by Tado automation."
            },
            "zoneUpdateInterval": {
                "title": "Zone Update Interval",
                "type": "integer",
                "placeholder": "3600",
                "description": "The polling interval in seconds, at which the zone is updated (used for battery state updates). Defaults to 1 hour."
            },
            "stateUpdateInterval": {
                "title": "State Update Interval",
                "type": "integer",
                "placeholder": "60",
                "description": "The polling interval in seconds, at which the state of a thermostat is updated. Defaults to 60 seconds."
            },
            "occupancyUpdateInterval": {
                "title": "Occupancy Update Interval",
                "type": "integer",
                "placeholder": "60",
                "description": "The polling interval in seconds, at which the state of the occupancy sensors is updated. Only used when occupancy sensors are enabled. Defaults to 60 seconds."
            },
            "homeUpdateInterval": {
                "title": "Home Update Interval",
                "type": "integer",
                "placeholder": "60",
                "description": "The polling interval in seconds, at which the state of the home is updated. Only used when global Home/Away is enabled. Defaults to 60 seconds."
            },
            "isApiEnabled": {
              "type": "boolean",
              "title": "Enable API",
              "description": "Enables an HTTP API for controlling Tado zones. See API for more information."
            },
            "apiPort": {
              "type": "integer",
              "title": "API Port",
              "placeholder": "40810",
              "description": "The port that the API (if enabled) runs on. Defaults to 40810, please change this setting of the port is already in use."
            },
            "apiToken": {
              "type": "string",
              "title": "API Token",
              "description": "The token that has to be included in each request of the API. Is required if the API is enabled and has no default value."
            },
            "zones": {
                "type": "array",
                "items": {
                    "title": "Zone",
                    "type": "object",
                    "properties": {
                        "zoneId": {
                            "title": "Zone ID",
                            "type": "integer",
                            "required": true,
                            "placeholder": "ZONE-ID",
                            "description": "The zone IDs of all zones will be printed out in the logs upon startup."
                        },
                        "zoneName": {
                            "title": "Zone Name",
                            "type": "string",
                            "required": false,
                            "default": "ZONE-NAME",
                            "description": "Useful to remember which zone ID is which zone."
                        },
                        "terminationOption": {
                            "title": "Terminal Option",
                            "type": "string",
                            "description": "Can be 'auto', 'manual' or a number representing the number of minutes for the timer."
                        }
                    }
                }
            }
        }
    }
}