Merge branch 'master' of github.com:dpavlin/air-quality
[air-quality] / README
diff --git a/README b/README
index aa1c861..65b31d5 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,8 @@
 Experiments with air quality sensors
 
-Scripts in this directory talk to sensors and store data into influxdb.
+Scripts in this directory read from sensor serial port output (which
+is 3.3V serial connected to usb serial dongle) and store data to
+influxdb using curl.
 
 When receiving data from sensors, they check  header and checksum to
 avoid sending garbage data. This also helps when you select wrong
@@ -10,3 +12,24 @@ network latency to influxdb (which is somewhere in the cloud, and
 latency can vary just enough to create empty vertical stripes in
 graphs which is ugly and incorrect).
 
+
+Exception to that rule is dsm501.pl which is general serial to
+influx bridge used by helper shell scripts to handle sensors
+which require 5V by connecting them to Arduino-like mcu.
+Example of that is:
+
+mq7.sh
+
+which uses https://github.com/dpavlin/mq7-co-monitor/
+
+on Arduino to produce output which is then fed to dsm501.pl.
+
+
+Another strage one is audio2influx.sh which doesn't require
+any external hardware but instead report sox info about 1s
+or audio to influxdb. I'm using this to passivly monitor
+fan rotation by connecting it directly to microphone input
+on netbook and adjusting input gain to prevent clipping
+using alsamixer.
+
+To make alsamixer work, I had to remove pulseaudio.