summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..619d414
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+This code can be used to access data from Pollin's weather station [0]. It
+probably supports more weather stations, but that has not been tested. The
+repository provides 3 parts:
+
+ * a C library using libusb to access the weather station
+ * a VAPI file for the C library to be used by valac
+ * a small demo program written in vala, which outputs the current data log entry
+
+To build the code you need to install libusb (the 0.1 branch) and its header
+files. On Debian/Ubuntu you get it by installing 'libusb-dev'. Just type 'make
+library' in the project's directory to get the library. You can optionally call
+'make demo' to compile the demo binary, if you have valac installed.
+
+You can find documentation for the chip inside the weather station on [1].
+
+[0] http://www.pollin.de/shop/dt/NzE2OTYxOTk-/Haustechnik/Wetterstation/Funk_Wetterstation_WS_0101.html
+[1] http://site.ambientweatherstore.com/easyweather/ws_1080_2080_protocol.zip