diff options
Diffstat (limited to 'collectors/node.d.plugin/stiebeleltron/README.md')
| -rw-r--r-- | collectors/node.d.plugin/stiebeleltron/README.md | 102 |
1 files changed, 57 insertions, 45 deletions
diff --git a/collectors/node.d.plugin/stiebeleltron/README.md b/collectors/node.d.plugin/stiebeleltron/README.md index 4aa5a43e8..80adc86b9 100644 --- a/collectors/node.d.plugin/stiebeleltron/README.md +++ b/collectors/node.d.plugin/stiebeleltron/README.md @@ -3,48 +3,56 @@ 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 + +- 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 % +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** -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 + - Heat circuit 1 room temperature in C (set/actual) + - Heat circuit 2 room temperature in C (set/actual) -3. **Hot Water** - * Hot water temperature in C (set/actual) +5. **Eletric Reheating** -4. **Room Temperature** - * Heat circuit 1 room temperature in C (set/actual) - * Heat circuit 2 room temperature in C (set/actual) + - Dual Mode Reheating temperature in C (hot water/heating) -5. **Eletric Reheating** - * Dual Mode Reheating temperature in C (hot water/heating) +6. **Process Data** -6. **Process Data** - * Remaining compressor rest time in s + - Remaining compressor rest time in s -7. **Runtime** - * Compressor runtime hours (hot water/heating) - * Reheating runtime hours (reheating 1/reheating 2) +7. **Runtime** -8. **Energy** - * Compressor today in kWh (hot water/heating) - * Compressor Total in kWh (hot water/heating) - - -### configuration + - 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`. @@ -57,15 +65,17 @@ 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 + +- 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. @@ -73,13 +83,15 @@ In my case, the ISG is relatively slow with responding (at least 1s, but also up ### 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 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, @@ -504,4 +516,4 @@ The charts are being generated using the configuration below. So if your install } ``` -[]() +[](<>) |