-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathschema.py
298 lines (252 loc) · 11.4 KB
/
schema.py
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
"""Voluptuous schemas for the Eltako integration."""
from abc import ABC
from typing import ClassVar
import voluptuous as vol
from numbers import Number, Real
import homeassistant.helpers.config_validation as cv
from eltakobus.eep import *
from .const import *
from .gateway import GatewayDeviceType
from homeassistant.components.binary_sensor import (
DEVICE_CLASSES_SCHEMA as BINARY_SENSOR_DEVICE_CLASSES_SCHEMA,
)
from homeassistant.components.cover import (
DEVICE_CLASSES_SCHEMA as COVER_DEVICE_CLASSES_SCHEMA,
)
from homeassistant.components.cover import (
DEVICE_CLASSES_SCHEMA as COVER_DEVICE_CLASSES_SCHEMA,
)
from homeassistant.const import (
CONF_DEVICE_CLASS,
CONF_ID,
CONF_NAME,
CONF_DEVICE,
CONF_DEVICES,
Platform,
CONF_TEMPERATURE_UNIT,
UnitOfTemperature,
CONF_LANGUAGE,
)
CONF_EEP_SUPPORTED_BINARY_SENSOR = [F6_01_01.eep_string,
F6_02_01.eep_string,
F6_02_02.eep_string,
F6_10_00.eep_string,
D5_00_01.eep_string,
A5_07_01.eep_string,
A5_08_01.eep_string,
A5_30_01.eep_string,
A5_30_03.eep_string]
CONF_EEP_SUPPORTED_SENSOR_ROCKER_SWITCH = [F6_02_01.eep_string, F6_02_02.eep_string]
def _get_sender_schema(supported_sender_eep) -> vol.Schema:
return vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(supported_sender_eep),
}
)
def _get_receiver_schema(supported_sender_eep) -> vol.Schema:
return _get_sender_schema(supported_sender_eep).extend({
vol.Optional(CONF_GATEWAY_ID, default=None): cv.Number,
})
class EltakoPlatformSchema(ABC):
"""Voluptuous schema for Eltako platform entity configuration."""
PLATFORM: ClassVar[Platform | str]
ENTITY_SCHEMA: ClassVar[vol.Schema]
@classmethod
def platform_node(cls) -> dict[vol.Optional, vol.All]:
"""Return a schema node for the platform."""
return {
vol.Optional(str(cls.PLATFORM)): vol.All(
cv.ensure_list, [cls.ENTITY_SCHEMA]
)
}
class GeneralSettings(EltakoPlatformSchema):
"""Voluptuous schema for general settings of this integration"""
PLATFORM = CONF_GERNERAL_SETTINGS
ENTITY_SCHEMA = vol.Schema({
vol.Optional(CONF_FAST_STATUS_CHANGE, default=False): cv.boolean,
vol.Optional(CONF_SHOW_DEV_ID_IN_DEV_NAME, default=False): cv.boolean,
})
@classmethod
def get_id(cls) -> str:
return cls.PLATFORM
@classmethod
def get_schema(cls) -> vol.Schema:
return cls.ENTITY_SCHEMA
class BinarySensorSchema(EltakoPlatformSchema):
"""Voluptuous schema for Eltako binary sensors."""
PLATFORM = Platform.BINARY_SENSOR
CONF_EEP = CONF_EEP
CONF_ID_REGEX = CONF_ID_REGEX
CONF_INVERT_SIGNAL = CONF_INVERT_SIGNAL
DEFAULT_NAME = "Binary sensor"
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_EEP_SUPPORTED_BINARY_SENSOR),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_DEVICE_CLASS): BINARY_SENSOR_DEVICE_CLASSES_SCHEMA,
vol.Optional(CONF_INVERT_SIGNAL, default=False): cv.boolean,
}
),
)
class LightSchema(EltakoPlatformSchema):
"""Voluptuous schema for Eltako lights."""
PLATFORM = Platform.LIGHT
CONF_EEP_SUPPORTED = [A5_38_08.eep_string, M5_38_08.eep_string]
CONF_SENDER_EEP_SUPPORTED = [A5_38_08.eep_string, F6_02_01.eep_string, F6_02_02.eep_string]
DEFAULT_NAME = "Light"
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_EEP_SUPPORTED),
vol.Required(CONF_SENDER): _get_sender_schema(CONF_SENDER_EEP_SUPPORTED),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
}
),
)
class SwitchSchema(EltakoPlatformSchema):
"""Voluptuous schema for Eltako switches."""
PLATFORM = Platform.SWITCH
CONF_EEP_SUPPORTED = [M5_38_08.eep_string, F6_02_01.eep_string, F6_02_02.eep_string]
CONF_SENDER_EEP_SUPPORTED = [F6_02_01.eep_string, F6_02_02.eep_string, A5_38_08.eep_string]
DEFAULT_NAME = "Switch"
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_EEP_SUPPORTED),
vol.Required(CONF_SENDER): _get_sender_schema(CONF_SENDER_EEP_SUPPORTED),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
}
),
)
class SensorSchema(EltakoPlatformSchema):
"""Voluptuous schema for Eltako sensors."""
PLATFORM = Platform.SENSOR
CONF_EEP_SUPPORTED = [A5_04_01.eep_string,
A5_04_02.eep_string,
A5_04_03.eep_string,
A5_06_01.eep_string,
A5_07_01.eep_string,
A5_08_01.eep_string,
A5_09_0C.eep_string,
A5_10_03.eep_string,
A5_10_06.eep_string,
A5_10_12.eep_string,
A5_12_01.eep_string,
A5_12_02.eep_string,
A5_12_03.eep_string,
A5_13_01.eep_string,
F6_10_00.eep_string,
]
DEFAULT_NAME = ""
DEFAULT_METER_TARIFFS = [1]
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_EEP_SUPPORTED),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_LANGUAGE, default="en"): vol.In([v for v in LANGUAGE_ABBREVIATION]),
vol.Optional(CONF_VOC_TYPE_INDEXES, default=[0]): vol.All(cv.ensure_list, [vol.In([v.index for v in VOC_SubstancesType])]),
vol.Optional(CONF_METER_TARIFFS, default=DEFAULT_METER_TARIFFS): vol.All(cv.ensure_list, [vol.All(vol.Coerce(int), vol.Range(min=1, max=16))]),
vol.Optional(CONF_DEVICE_CLASS): BINARY_SENSOR_DEVICE_CLASSES_SCHEMA,
}
),
)
class CoverSchema(EltakoPlatformSchema):
"""Voluptuous schema for Eltako covers."""
PLATFORM = Platform.COVER
CONF_EEP_SUPPORTED = [G5_3F_7F.eep_string]
CONF_SENDER_EEP_SUPPORTED = [H5_3F_7F.eep_string]
DEFAULT_NAME = "Cover"
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_EEP_SUPPORTED),
vol.Required(CONF_SENDER): _get_sender_schema(CONF_SENDER_EEP_SUPPORTED),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_DEVICE_CLASS): COVER_DEVICE_CLASSES_SCHEMA,
vol.Optional(CONF_TIME_CLOSES): vol.All(vol.Coerce(int), vol.Range(min=1, max=255)),
vol.Optional(CONF_TIME_OPENS): vol.All(vol.Coerce(int), vol.Range(min=1, max=255)),
vol.Optional(CONF_TIME_TILTS): vol.All(vol.Coerce(int), vol.Range(min=1, max=255)),
}
),
)
class ClimateSchema(EltakoPlatformSchema):
"""Schema for Eltako heating and cooling."""
PLATFORM = Platform.CLIMATE
CONF_CLIMATE_EEP = [A5_10_06.eep_string]
CONF_CLIMATE_SENDER_EEP = [A5_10_06.eep_string]
DEFAULT_NAME = "Climate"
DEFAULT_COOLING_SWITCH_NAME = "cooling mode switch"
DEFAULT_COOLING_SENDER_NAME = "cooling mode sender"
CONF_COOLING_MODE_SCHEMA = vol.Schema(
{
vol.Required(CONF_SENSOR): vol.Schema( # detects if heater is switch globally into cooling mode
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Optional(CONF_SWITCH_BUTTON, default=0): cv.byte,
}),
vol.Optional(CONF_SENDER): vol.Schema( # sends frequently a signal to stay in cooling mode if detect by cooling-mode-sensor
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In([F6_02_01.eep_string, F6_02_02.eep_string]),
vol.Optional(CONF_NAME, default=DEFAULT_COOLING_SENDER_NAME): cv.string,
vol.Optional(CONF_GATEWAY_ID, default=None): cv.matches_regex(CONF_ID_REGEX),
}),
})
ENTITY_SCHEMA = vol.All(
vol.Schema(
{
vol.Required(CONF_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Required(CONF_EEP): vol.In(CONF_CLIMATE_EEP),
vol.Required(CONF_SENDER): _get_sender_schema(CONF_CLIMATE_SENDER_EEP), # temperature controller command
vol.Required(CONF_TEMPERATURE_UNIT): vol.In([u.value for u in UnitOfTemperature]), # for display: "°C", "°F", "K"
vol.Optional(CONF_MIN_TARGET_TEMPERATURE, default=17): cv.Number,
vol.Optional(CONF_MAX_TARGET_TEMPERATURE, default=25): cv.Number,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_ROOM_THERMOSTAT): _get_sender_schema(CONF_CLIMATE_SENDER_EEP), # physical thermostat like FUTH
vol.Optional(CONF_COOLING_MODE): CONF_COOLING_MODE_SCHEMA # if not provided cooling is not supported
}
),
)
class GatewaySchema(EltakoPlatformSchema):
"""Voluptuous schema for bus gateway"""
PLATFORM = CONF_GATEWAY
ENTITY_SCHEMA = vol.Schema({
vol.Required(CONF_ID): cv.Number,
vol.Required(CONF_DEVICE_TYPE, default=GatewayDeviceType.GatewayEltakoFGW14USB.value): vol.In([g.value for g in GatewayDeviceType]),
vol.Required(CONF_BASE_ID): cv.matches_regex(CONF_ID_REGEX),
vol.Optional(CONF_NAME, default=""): cv.string,
vol.Optional(CONF_SERIAL_PATH): cv.string,
vol.Optional(CONF_GATEWAY_AUTO_RECONNECT, default=True): cv.boolean,
vol.Optional(CONF_GATEWAY_ADDRESS): cv.string,
vol.Optional(CONF_GATEWAY_MESSAGE_DELAY, default=0.01): cv.Number,
vol.Optional(CONF_GATEWAY_PORT, default=5100): cv.Number,
vol.Optional(CONF_DEVICES): vol.All(vol.Schema({
**BinarySensorSchema.platform_node(),
**LightSchema.platform_node(),
**SwitchSchema.platform_node(),
**SensorSchema.platform_node(),
**CoverSchema.platform_node(),
**ClimateSchema.platform_node(),
})),
})
@classmethod
def get_schema(cls) -> vol.Schema:
"""Return a schema."""
return cls.ENTITY_SCHEMA
CONFIG_SCHEMA = vol.Schema(
{
DOMAIN: vol.Schema({
vol.Optional(CONF_GERNERAL_SETTINGS): GeneralSettings.get_schema(),
vol.Optional(CONF_GATEWAY): vol.All(cv.ensure_list, [GatewaySchema.ENTITY_SCHEMA]),
})
},
extra=vol.ALLOW_EXTRA,
)