aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVolker Hoffmann <volker@cheleb.net>2016-04-21 16:41:05 +0200
committerVolker Hoffmann <volker@cheleb.net>2016-04-25 10:38:20 +0200
commit52919e3976ab2082c011af42ac83871fc009ae01 (patch)
treefdcfaa0aa5ee6a54d73b406e06bc9731d1b1eeec /README.md
initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3d7ed01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Simple Home Dashboard, Collector Module
+
+## Overview
+
+This is a collection of Python scripts to poll your environmental data from a [Netatmo](http://netatmo.com) device and then upload it to an instance of [InfluxDB](https://influxdb.com/). You can then use something like [Grafana](http://www.grafana.org) to visualise the measurements.
+
+## Usage
+
+- Generate a API token for Netatmo by [Creating an Application](https://dev.netatmo.com/dev/createapp).
+- Put your Netatmo access data in the *userpass_netatmo* file. See also the *userpass_netatmo_example* file.
+- Put your InfluxDB access data in the *userpass_influx* file. See also *userpass_influx_example*.
+- Modify your station and module names in *Common/sensors.py*.
+- Run *python ./ticker.py*. If it works, stick it in a Cronjob.
+
+## Contact
+
+Questions, comments, rants should be sent to [volker@cheleb.net](mailto:volker@cheleb.net).