aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..879342b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Simple MQTT pusher for values from hydroponic sensors
+
+To compile, you need to make a `secrets.h` file with your credentials to services.
+```
+#define WIFI_SSID ""
+#define WIFI_PASSWORD ""
+#define MQTT_USERNAME ""
+#define MQTT_PASSWORD ""
+#define MQTT_BROKER ""
+```
+
+You can then either use the Arduino IDE, or run
+```
+make configure
+make
+```
+
+## Sensors
+- Temperature
+- EC *(Using these cheap analog ebay TDS meters)*