summaryrefslogtreecommitdiffstats
path: root/collectors/node.d.plugin/stiebeleltron/README.md
blob: 80adc86b9f140f9711ca7c5f8c881a98111a99aa (plain)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
# stiebel eltron

This module collects metrics from the configured heat pump and hot water installation from Stiebel Eltron ISG web.

**Requirements**

-   Configuration file `stiebeleltron.conf` in the node.d Netdata config dir (default: `/etc/netdata/node.d/stiebeleltron.conf`)
-   Stiebel Eltron ISG web with network access (http), without password login

The charts are configurable, however, the provided default configuration collects the following:

1.  **General**

    -   Outside temperature in C
    -   Condenser temperature in C
    -   Heating circuit pressure in bar
    -   Flow rate in l/min
    -   Output of water and heat pumps in %

2.  **Heating**

    -   Heat circuit 1 temperature in C (set/actual)
    -   Heat circuit 2 temperature in C (set/actual)
    -   Flow temperature in C (set/actual)
    -   Buffer temperature in C (set/actual)
    -   Pre-flow temperature in C

3.  **Hot Water**

    -   Hot water temperature in C (set/actual)

4.  **Room Temperature**

    -   Heat circuit 1 room temperature in C (set/actual)
    -   Heat circuit 2 room temperature in C (set/actual)

5.  **Eletric Reheating**

    -   Dual Mode Reheating temperature in C (hot water/heating)

6.  **Process Data**

    -   Remaining compressor rest time in s

7.  **Runtime**

    -   Compressor runtime hours (hot water/heating)
    -   Reheating runtime hours (reheating 1/reheating 2)

8.  **Energy**

    -   Compressor today in kWh (hot water/heating)
    -   Compressor Total in kWh (hot water/heating)

## configuration

If no configuration is given, the module will be disabled. Each `update_every` is optional, the default is `10`.

---

[Stiebel Eltron Heat pump system with ISG](https://www.stiebel-eltron.com/en/home/products-solutions/renewables/controller_energymanagement/internet_servicegateway/isg_web.html)

Original author: BrainDoctor (github)

The module supports any metrics that are parseable with RegEx. There is no API that gives direct access to the values (AFAIK), so the "workaround" is to parse the HTML output of the ISG.

### Testing

This plugin has been tested within the following environment:

-   ISG version: 8.5.6
-   MFG version: 12
-   Controller version: 9
-   July (summer time, not much activity)
-   Interface language: English
-   login- and password-less ISG web access (without HTTPS it's useless anyway)
-   Heatpump model: WPL 25 I-2
-   Hot water boiler model: 820 WT 1

So, if the language is set to english, copy the following configuration into `/etc/netdata/node.d/stiebeleltron.conf` and change the `url`s.

In my case, the ISG is relatively slow with responding (at least 1s, but also up to 4s). Collecting metrics every 10s is more than enough for me.

### How to update the config

-   The dimensions support variable digits, the default is `1`. Most of the values printed by ISG are using 1 digit, some use 2.
-   The dimensions also support the `multiplier` and `divisor` attributes, however the divisor gets overridden by `digits`, if specified. Default is `1`.
-   The test string for the regex is always the whole HTML output from the url. For each parameter you need to have a regular expression that extracts the value from the HTML source in the first capture group.
    Recommended: [regexr.com](https://regexr.com/) for testing and matching, [freeformatter.com](https://www.freeformatter.com/json-escape.html) for escaping the newly created regex for the JSON config.

The charts are being generated using the configuration below. So if your installation is in another language or has other metrics, just adapt the structure or regexes.

### Configuration template

```json
{
    "enable_autodetect": false,
    "update_every": 10,
    "pages": [
        {
            "name": "System",
            "id": "system",
            "url": "http://machine.ip.or.dns/?s=1,0",
            "update_every": 10,
            "categories": [ 
		{
                    "id": "eletricreheating",
                    "name": "electric reheating",
                    "charts": [
                        {
                            "title": "Dual Mode Reheating Temperature",
                            "id": "reheatingtemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Heating",
                                    "id": "dualmodeheatingtemp",
                                    "regex": "DUAL MODE TEMP HEATING<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                },
                                {
                                    "name": "Hot Water",
                                    "id" : "dualmodehotwatertemp",
                                    "regex": "DUAL MODE TEMP DHW<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "roomtemp",
                    "name": "room temperature",
                    "charts": [
                        {
                            "title": "Heat Circuit 1",
                            "id": "hc1",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "<tr class=\"even\">\\s*<td.*>ACTUAL TEMPERATURE HC 1<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "<tr class=\"odd\">\\s*<td.*>SET TEMPERATURE HC 1<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                }
                            ]
                        },
                        {
                            "title": "Heat Circuit 2",
                            "id": "hc2",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 2,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "<tr class=\"even\">\\s*<td.*>ACTUAL TEMPERATURE HC 2<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "<tr class=\"odd\">\\s*<td.*>SET TEMPERATURE HC 2<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                }
                            ]
                        }
                    ]
                },
		{
                    "id": "heating",
                    "name": "heating",
                    "charts": [
                        {
                            "title": "Heat Circuit 1",
                            "id": "hc1",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "<tr class=\"odd\">\\s*<td.*>ACTUAL TEMPERATURE HC 1<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "<tr class=\"even\">\\s*<td.*>SET TEMPERATURE HC 1<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                }
                            ]
                        },
                        {
                            "title": "Heat Circuit 2",
                            "id": "hc2",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 2,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "<tr class=\"odd\">\\s*<td.*>ACTUAL TEMPERATURE HC 2<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "<tr class=\"even\">\\s*<td.*>SET TEMPERATURE HC 2<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                }
                            ]
                        },
                        {
                            "title": "Flow Temperature",
                            "id": "flowtemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 3,
                            "dimensions": [
                                {
                                    "name": "Heating",
                                    "id": "heating",
                                    "regex": "ACTUAL FLOW TEMPERATURE WP<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                },
                                {
                                    "name": "Reheating",
                                    "id" : "reheating",
                                    "regex": "ACTUAL FLOW TEMPERATURE NHZ<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        },
                        {
                            "title": "Buffer Temperature",
                            "id": "buffertemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 4,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "ACTUAL BUFFER TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "SET BUFFER TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        },
                        {
                            "title": "Fixed Temperature",
                            "id": "fixedtemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 5,
                            "dimensions": [
                                {
                                    "name": "Set",
                                    "id" : "setfixed",
                                    "regex": "SET FIXED TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        },
                        {
                            "title": "Pre-flow Temperature",
                            "id": "preflowtemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 6,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actualreturn",
                                    "regex": "ACTUAL RETURN TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        }
                    ]
                },
		{
                    "id": "hotwater",
                    "name": "hot water",
                    "charts": [
			{
                            "title": "Hot Water Temperature",
                            "id": "hotwatertemp",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Actual",
                                    "id": "actual",
                                    "regex": "ACTUAL TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                },
                                {
                                    "name": "Set",
                                    "id" : "set",
                                    "regex": "SET TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        }
                    ]
                },
		{
                    "id": "general",
                    "name": "general",
                    "charts": [
                        {
                            "title": "Outside Temperature",
                            "id": "outside",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Outside temperature",
                                    "id": "outsidetemp",
                                    "regex": "OUTSIDE TEMPERATURE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>\\s*<\\\/tr>"
                                }
                            ]
                        },
                        {
                            "title": "Condenser Temperature",
                            "id": "condenser",
                            "unit": "Celsius",
                            "type": "line",
                            "prio": 2,
                            "dimensions": [
                                {
                                    "name": "Condenser",
                                    "id": "condenser",
                                    "regex": "CONDENSER TEMP\\.<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        },
			{
                            "title": "Heating Circuit Pressure",
                            "id": "heatingcircuit",
                            "unit": "bar",							
                            "type": "line",
                            "prio": 3,
                            "dimensions": [
                                {
                                    "name": "Heating Circuit",
                                    "id": "heatingcircuit",
				    "digits": 2,
                                    "regex": "PRESSURE HTG CIRC<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]*).*<\\\/td>"
                                }
                            ]
                        },
			{
                            "title": "Flow Rate",
                            "id": "flowrate",
                            "unit": "liters/min",
                            "type": "line",
                            "prio": 4,
                            "dimensions": [
                                {
                                    "name": "Flow Rate",
                                    "id": "flowrate",
				    "digits": 2,
                                    "regex": "FLOW RATE<\\\/td>\\s*<td.*>(-?[0-9]+,[0-9]+).*<\\\/td>"
                                }
                            ]
                        },
			{
                            "title": "Output",
                            "id": "output",
                            "unit": "%",
                            "type": "line",
                            "prio": 5,
                            "dimensions": [
                                {
                                    "name": "Heat Pump",
                                    "id": "outputheatpump",
                                    "regex": "OUTPUT HP<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*).*<\\\/td>"
                                },
				{
                                    "name": "Water Pump",
                                    "id": "intpumprate",
                                    "regex": "INT PUMP RATE<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*).*<\\\/td>"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
	{
            "name": "Heat Pump",
            "id": "heatpump",
            "url": "http://machine.ip.or.dns/?s=1,1",
            "update_every": 10,
            "categories": [
		{
                    "id": "runtime",
                    "name": "runtime",
                    "charts": [
                        {
                            "title": "Compressor",
                            "id": "compressor",
                            "unit": "h",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Heating",
                                    "id": "heating",
                                    "regex": "RNT COMP 1 HEA<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                },
                                {
                                    "name": "Hot Water",
                                    "id" : "hotwater",
                                    "regex": "RNT COMP 1 DHW<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                }
                            ]
                        },
			{
                            "title": "Reheating",
                            "id": "reheating",
                            "unit": "h",
                            "type": "line",
                            "prio": 2,
                            "dimensions": [
                                {
                                    "name": "Reheating 1",
                                    "id": "rh1",
                                    "regex": "BH 1<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                },
                                {
                                    "name": "Reheating 2",
                                    "id" : "rh2",
                                    "regex": "BH 2<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                }
                            ]
                        }
                    ]
                },
		{
                    "id": "processdata",
                    "name": "process data",
                    "charts": [
                        {
                            "title": "Remaining Compressor Rest Time",
                            "id": "remaincomp",
                            "unit": "s",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Timer",
                                    "id": "timer",
                                    "regex": "COMP DLAY CNTR<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                }
                            ]
                        }
                    ]
                },
		{
                    "id": "energy",
                    "name": "energy",
                    "charts": [
                        {
                            "title": "Compressor Today",
                            "id": "compressorday",
                            "unit": "kWh",
                            "type": "line",
                            "prio": 1,
                            "dimensions": [
                                {
                                    "name": "Heating",
                                    "id": "heating",
				    "digits": 3,
                                    "regex": "COMPRESSOR HEATING DAY<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                },
				{
                                    "name": "Hot Water",
                                    "id": "hotwater",
				    "digits": 3,
                                    "regex": "COMPRESSOR DHW DAY<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                }
                            ]
                        },
			{
                            "title": "Compressor Total",
                            "id": "compressortotal",
                            "unit": "MWh",
                            "type": "line",
                            "prio": 2,
                            "dimensions": [
                                {
                                    "name": "Heating",
                                    "id": "heating",
				    "digits": 3,
                                    "regex": "COMPRESSOR HEATING TOTAL<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                },
				{
                                    "name": "Hot Water",
                                    "id": "hotwater",
				    "digits": 3,
                                    "regex": "COMPRESSOR DHW TOTAL<\\\/td>\\s*<td.*>(-?[0-9]+,?[0-9]*)"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
```

[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fnode.d.plugin%2Fstiebeleltron%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)