Initial commit

1 files changed, 23 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..6110148
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+This is a simple munin plugin to monitor the values of a Ökofen Pellematic with
+a Pelletronic Touch Online.
+
+It's currently very limited as it doesnt' determine the attached Pellematics or
+heating circuits but fetches a hard coded list of items.
+
+To setup the plugin copy it to /etc/munin/plugins and set the address of your
+Pellematic:::
+
+    cat <<EOF > /etc/munin/plugin-conf.d/pellematic
+    [pellematic-*]
+    env.address 192.168.0.5
+    env.username foo
+    env.password bar
+
+Then test it via:
+
+    munin-run pellematic-temp
+
+You should now see the temperature values printed on stdout. If this works restart your
+munin node:
+
+    service munin-node restart