Added readme

2021-10-20 10:26:01 +02:00
parent 3f91b6bb62
commit fd1d77b0e5
2 changed files with 18 additions and 0 deletions
@@ -0,0 +1,17 @@
+# Cure logger
+The aim of this project is to monitor the curing of cannabis flowers using the Aqara humidity, pressure and temperature sensor (WSDCGQ11LM).
+
+The ruby script subscribes topic of the sensors and when and saves the payload in a CSV file for further analysis.
+
+# Requirements
+- MQTT Broker handles the events from Zigbee2mqtt
+- Ruby 2.7 or better
+
+
+# Installation
+1. Clone the ropository `git clone https://github.com/gurix/cure_logger.git`
+2. Install dependencies `bundle install`
+3. Setup your sensors and configure address of your MQTT broker in `config.yaml`
+
+# Run the script
+Start the script with `ruby logger.rb` that produces console output when an event happens as well as it logs data into `data.csv`.