diff options
| author | Lennart Weller <lhw@ring0.de> | 2017-07-27 09:55:47 +0000 |
|---|---|---|
| committer | Lennart Weller <lhw@ring0.de> | 2017-07-27 09:55:47 +0000 |
| commit | a133c9c3b637b1dbe7b5b053f7e2572c1950cead (patch) | |
| tree | 2207939a88e96bca329457f40a9d9d18ab659dc1 /node.d/README.md | |
| parent | New upstream version 1.6.0+dfsg (diff) | |
| download | netdata-a133c9c3b637b1dbe7b5b053f7e2572c1950cead.tar.xz netdata-a133c9c3b637b1dbe7b5b053f7e2572c1950cead.zip | |
New upstream version 1.7.0+dfsgupstream/1.7.0+dfsg
Diffstat (limited to 'node.d/README.md')
| -rw-r--r-- | node.d/README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/node.d/README.md b/node.d/README.md index e69de29bb..3c2977905 100644 --- a/node.d/README.md +++ b/node.d/README.md @@ -0,0 +1,63 @@ +# Disclaimer
+
+Module configurations are written in JSON and **node.js is required**.
+
+to be edited.
+
+---
+
+The following node.d modules are supported:
+
+# fronius
+
+This module collects metrics from the configured solar power installation from Fronius Symo.
+See `netdata/conf.d/node.d/fronius.conf.md` for more details.
+
+**Requirements**
+ * Configuration file `fronius.conf` in the node.d netdata config dir (default: `/etc/netdata/node.d/fronius.conf`)
+ * Fronius Symo with network access (http)
+
+It produces per server:
+
+1. **Power**
+ * Current power input from the grid (positive values), output to the grid (negative values), in W
+ * Current power input from the solar panels, in W
+ * Current power stored in the accumulator (if present), in W (in theory, untested)
+
+2. **Consumption**
+ * Local consumption in W
+
+3. **Autonomy**
+ * Relative autonomy in %. 100 % autonomy means that the solar panels are delivering more power than it is needed by local consumption.
+ * Relative self consumption in %. The lower the better
+
+4. **Energy**
+ * The energy produced during the current day, in kWh
+ * The energy produced during the current year, in kWh
+
+5. **Inverter**
+ * The current power output from the connected inverters, in W, one dimension per inverter. At least one is always present.
+
+
+### configuration
+
+Sample:
+
+```json
+{
+ "enable_autodetect": false,
+ "update_every": 5,
+ "servers": [
+ {
+ "name": "Symo",
+ "hostname": "symo.ip.or.dns",
+ "update_every": 5,
+ "api_path": "/solar_api/v1/GetPowerFlowRealtimeData.fcgi"
+ }
+ ]
+}
+```
+
+If no configuration is given, the module will be disabled. Each `update_every` is optional, the default is `5`.
+
+---
|