Skip to content

Commit 0e16518

Browse files
Guzz-TGuzz-T
committed
Improve inputs and holdings names and descriptions.
- Lower case for all names - Refactored "MK" to "mc" and "heating circuit" to "mixing circuit" - Unification of some descriptions
1 parent 49e75eb commit 0e16518

File tree

2 files changed

+184
-161
lines changed

2 files changed

+184
-161
lines changed

‎luxtronik/definitions/holdings.py‎

Lines changed: 78 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@
3535
"writeable": True,
3636
"range": {"min": 15, "max": 75},
3737
"since": "3.90.1",
38-
"description": "Desired target temperature for heating in °C",
38+
"description": "Desired target temperature in °C " \
39+
"for the heating function",
3940
},
4041
{
4142
"index": 2,
@@ -45,7 +46,8 @@
4546
"writeable": True,
4647
"range": {"min": 0, "max": 20},
4748
"since": "3.90.1",
48-
"description": "Temperature correction in Kelvin for heating",
49+
"description": "Temperature correction in Kelvin " \
50+
"for the heating function",
4951
},
5052
{
5153
"index": 3,
@@ -54,7 +56,8 @@
5456
"type": LevelMode,
5557
"writeable": True,
5658
"since": "3.92.0",
57-
"description": "Increase or decrease the temperature by the SHI-offsets-setting",
59+
"description": "Increase or decrease the heating temperature " \
60+
"using the SHI offset settings.",
5861
},
5962
{
6063
"index": 5,
@@ -73,7 +76,8 @@
7376
"writeable": True,
7477
"range": {"min": 30, "max": 75},
7578
"since": "3.90.1",
76-
"description": "Target temperature for hot water in °C",
79+
"description": "Desired target temperature in °C " \
80+
"for hot water",
7781
},
7882
{
7983
"index": 7,
@@ -83,7 +87,8 @@
8387
"writeable": True,
8488
"range": {"min": 0, "max": 20},
8589
"since": "3.90.1",
86-
"description": "Temperature correction in Kelvin for hot water",
90+
"description": "Temperature correction in Kelvin " \
91+
"for hot water",
8792
},
8893
{
8994
"index": 8,
@@ -92,213 +97,229 @@
9297
"type": LevelMode,
9398
"writeable": True,
9499
"since": "3.92.0",
95-
"description": "Increase or decrease the temperature by the SHI-offsets-setting",
100+
"description": "Increase or decrease the hot water temperature " \
101+
"using the SHI offset settings.",
96102
},
97103
{
98104
"index": 10,
99105
"count": 1,
100-
"names": ["MK1_heat_mode"],
106+
"names": ["mc1_heat_mode"],
101107
"type": ControlMode,
102108
"writeable": True,
103109
"since": "3.90.1",
104-
"description": "Operating mode for heating circuit 1",
110+
"description": "Operating mode for mixing circuit 1 in heating mode",
105111
},
106112
{
107113
"index": 11,
108114
"count": 1,
109-
"names": ["MK1_heat_setpoint"],
115+
"names": ["mc1_heat_setpoint"],
110116
"type": Celsius,
111117
"writeable": True,
112118
"range": {"min": 20, "max": 65},
113119
"since": "3.90.1",
114-
"description": "Target temperature for heating circuit 1 in °C",
120+
"description": "Desired target temperature in °C " \
121+
"for mixing circuit 1 in heating mode",
115122
},
116123
{
117124
"index": 12,
118125
"count": 1,
119-
"names": ["MK1_heat_offset"],
126+
"names": ["mc1_heat_offset"],
120127
"type": Kelvin,
121128
"writeable": True,
122129
"range": {"min": 0, "max": 5},
123130
"since": "3.90.1",
124-
"description": "Temperature correction in Kelvin for heating circuit 1",
131+
"description": "Temperature correction in Kelvin " \
132+
"for mixing circuit 1 in heating mode",
125133
},
126134
{
127135
"index": 13,
128136
"count": 1,
129-
"names": ["MK1_heat_level"],
137+
"names": ["mc1_heat_level"],
130138
"type": LevelMode,
131139
"writeable": True,
132140
"since": "3.92.0",
133-
"description": "Increase or decrease the temperature by the SHI-offsets-setting",
141+
"description": "Increase or decrease the mixing circuit 1 temperature " \
142+
"using the SHI offset settings.",
134143
},
135144
{
136145
"index": 15,
137146
"count": 1,
138-
"names": ["MK1_cool_mode"],
147+
"names": ["mc1_cool_mode"],
139148
"type": ControlMode,
140149
"writeable": True,
141150
"since": "3.90.1",
142-
"description": "Operating mode for cooling circuit 1",
151+
"description": "Operating mode for mixing circuit 1 in cooling mode",
143152
},
144153
{
145154
"index": 16,
146155
"count": 1,
147-
"names": ["MK1_cool_setpoint"],
156+
"names": ["mc1_cool_setpoint"],
148157
"type": Celsius,
149158
"writeable": True,
150159
"range": {"min": 5, "max": 25},
151160
"since": "3.90.1",
152-
"description": "Target temperature for cooling circuit 1 in °C",
161+
"description": "Desired target temperature in °C " \
162+
"for mixing circuit 1 in cooling mode",
153163
},
154164
{
155165
"index": 17,
156166
"count": 1,
157-
"names": ["MK1_cool_offset"],
167+
"names": ["mc1_cool_offset"],
158168
"type": Kelvin,
159169
"writeable": True,
160170
"range": {"min": 0, "max": 5},
161171
"since": "3.90.1",
162-
"description": "Temperature correction in Kelvin for cooling circuit 1",
172+
"description": "Temperature correction in Kelvin " \
173+
"for mixing circuit 1 in cooling mode",
163174
},
164175
{
165176
"index": 20,
166177
"count": 1,
167-
"names": ["MK2_heat_mode"],
178+
"names": ["mc2_heat_mode"],
168179
"type": ControlMode,
169180
"writeable": True,
170181
"since": "3.90.1",
171-
"description": "Operating mode for heating circuit 2",
182+
"description": "Operating mode for mixing circuit 2 in heating mode",
172183
},
173184
{
174185
"index": 21,
175186
"count": 1,
176-
"names": ["MK2_heat_setpoint"],
187+
"names": ["mc2_heat_setpoint"],
177188
"type": Celsius,
178189
"writeable": True,
179190
"range": {"min": 20, "max": 65},
180191
"since": "3.90.1",
181-
"description": "Target temperature for heating circuit 2 in °C",
192+
"description": "Desired target temperature in °C " \
193+
"for mixing circuit 2 in heating mode",
182194
},
183195
{
184196
"index": 22,
185197
"count": 1,
186-
"names": ["MK2_heat_offset"],
198+
"names": ["mc2_heat_offset"],
187199
"type": Kelvin,
188200
"writeable": True,
189201
"range": {"min": 0, "max": 5},
190202
"since": "3.90.1",
191-
"description": "Temperature correction in Kelvin for heating circuit 2",
203+
"description": "Temperature correction in Kelvin " \
204+
"for mixing circuit 2 in heating mode",
192205
},
193206
{
194207
"index": 23,
195208
"count": 1,
196-
"names": ["MK2_heat_level"],
209+
"names": ["mc2_heat_level"],
197210
"type": LevelMode,
198211
"writeable": True,
199212
"since": "3.92.0",
200-
"description": "Increase or decrease the temperature by the SHI-offsets-setting",
213+
"description": "Increase or decrease the mixing circuit 2 temperature " \
214+
"using the SHI offset settings.",
201215
},
202216
{
203217
"index": 25,
204218
"count": 1,
205-
"names": ["MK2_cool_mode"],
219+
"names": ["mc2_cool_mode"],
206220
"type": ControlMode,
207221
"writeable": True,
208222
"since": "3.90.1",
209-
"description": "Operating mode for cooling circuit 2",
223+
"description": "Operating mode for mixing circuit 2 in cooling mode",
210224
},
211225
{
212226
"index": 26,
213227
"count": 1,
214-
"names": ["MK2_cool_setpoint"],
228+
"names": ["mc2_cool_setpoint"],
215229
"type": Celsius,
216230
"writeable": True,
217231
"range": {"min": 5, "max": 25},
218232
"since": "3.90.1",
219-
"description": "Target temperature for cooling circuit 2 in °C",
233+
"description": "Desired target temperature in °C " \
234+
"for mixing circuit 2 in cooling mode",
220235
},
221236
{
222237
"index": 27,
223238
"count": 1,
224-
"names": ["MK2_cool_offset"],
239+
"names": ["mc2_cool_offset"],
225240
"type": Kelvin,
226241
"writeable": True,
227242
"range": {"min": 0, "max": 5},
228243
"since": "3.90.1",
229-
"description": "Temperature correction in Kelvin for cooling circuit 2",
244+
"description": "Temperature correction in Kelvin " \
245+
"for mixing circuit 2 in cooling mode",
230246
},
231247
{
232248
"index": 30,
233249
"count": 1,
234-
"names": ["MK3_heat_mode"],
250+
"names": ["mc3_heat_mode"],
235251
"type": ControlMode,
236252
"writeable": True,
237253
"since": "3.90.1",
238-
"description": "Operating mode for heating circuit 3",
254+
"description": "Operating mode for mixing circuit 3 in heating mode",
239255
},
240256
{
241257
"index": 31,
242258
"count": 1,
243-
"names": ["MK3_heat_setpoint"],
259+
"names": ["mc3_heat_setpoint"],
244260
"type": Celsius,
245261
"writeable": True,
246262
"range": {"min": 20, "max": 65},
247263
"since": "3.90.1",
248-
"description": "Target temperature for heating circuit 3 in °C",
264+
"description": "Desired target temperature in °C " \
265+
"for mixing circuit 3 in heating mode",
249266
},
250267
{
251268
"index": 32,
252269
"count": 1,
253-
"names": ["MK3_heat_offset"],
270+
"names": ["mc3_heat_offset"],
254271
"type": Kelvin,
255272
"writeable": True,
256273
"range": {"min": 0, "max": 5},
257274
"since": "3.90.1",
258-
"description": "Temperature correction in Kelvin for heating circuit 3",
275+
"description": "Temperature correction in Kelvin " \
276+
"for mixing circuit 3 in heating mode",
259277
},
260278
{
261279
"index": 33,
262280
"count": 1,
263-
"names": ["MK3_heat_level"],
281+
"names": ["mc3_heat_level"],
264282
"type": LevelMode,
265283
"writeable": True,
266284
"since": "3.92.0",
267-
"description": "Increase or decrease the temperature by the SHI-offsets-setting",
285+
"description": "Increase or decrease the mixing circuit 3 temperature " \
286+
"using the SHI offset settings.",
268287
},
269288
{
270289
"index": 35,
271290
"count": 1,
272-
"names": ["MK3_cool_mode"],
291+
"names": ["mc3_cool_mode"],
273292
"type": ControlMode,
274293
"writeable": True,
275294
"since": "3.90.1",
276-
"description": "Operating mode for cooling circuit 3",
295+
"description": "Operating mode for mixing circuit 3 in cooling mode",
277296
},
278297
{
279298
"index": 36,
280299
"count": 1,
281-
"names": ["MK3_cool_setpoint"],
300+
"names": ["mc3_cool_setpoint"],
282301
"type": Celsius,
283302
"writeable": True,
284303
"range": {"min": 5, "max": 25},
285304
"since": "3.90.1",
286-
"description": "Target temperature for cooling circuit 3 in °C",
305+
"description": "Desired target temperature in °C " \
306+
"for mixing circuit 3 in cooling mode",
287307
},
288308
{
289309
"index": 37,
290310
"count": 1,
291-
"names": ["MK3_cool_offset"],
311+
"names": ["mc3_cool_offset"],
292312
"type": Kelvin,
293313
"writeable": True,
294314
"range": {"min": 0, "max": 5},
295315
"since": "3.90.1",
296-
"description": "Temperature correction in Kelvin for cooling circuit 3",
316+
"description": "Temperature correction in Kelvin " \
317+
"for mixing circuit 3 in cooling mode",
297318
},
298319
{
299320
"index": 40,
300321
"count": 1,
301-
"names": ["LPC_mode"],
322+
"names": ["lpc_mode"],
302323
"type": LpcMode,
303324
"writeable": True,
304325
"since": "3.90.1",
@@ -307,7 +328,7 @@
307328
{
308329
"index": 41,
309330
"count": 1,
310-
"names": ["PC_limit"],
331+
"names": ["pc_limit"],
311332
"type": PowerLimit,
312333
"writeable": True,
313334
"range": {"min": 0, "max": 30},
@@ -321,7 +342,7 @@
321342
"type": LockMode,
322343
"writeable": True,
323344
"since": "3.92.0",
324-
"description": "Lock state for heating",
345+
"description": "Lock state for the heating function",
325346
},
326347
{
327348
"index": 51,
@@ -330,7 +351,7 @@
330351
"type": LockMode,
331352
"writeable": True,
332353
"since": "3.92.0",
333-
"description": "Lock state for hot water",
354+
"description": "Lock state for the hot water system",
334355
},
335356
{
336357
"index": 52,
@@ -339,7 +360,7 @@
339360
"type": LockMode,
340361
"writeable": True,
341362
"since": "3.90.1",
342-
"description": "Lock state for cooling",
363+
"description": "Lock state for the cooling function",
343364
},
344365
{
345366
"index": 53,
@@ -367,7 +388,8 @@
367388
"writeable": True,
368389
"range": {"min": 0, "max": 20},
369390
"since": "3.92.0",
370-
"description": "Temperature correction in Kelvin for all heating functions",
391+
"description": "Temperature correction in Kelvin " \
392+
"for all heating functions",
371393
},
372394
{
373395
"index": 67,
@@ -376,7 +398,8 @@
376398
"type": LevelMode,
377399
"writeable": True,
378400
"since": "3.92.0",
379-
"description": "Increase or decrease all temperatures by the SHI-offsets-setting",
401+
"description": "Increase or decrease all heating temperatures " \
402+
"using the SHI offset settings.",
380403
},
381404
{
382405
"index": 70,

0 commit comments

Comments
 (0)