Initial commit

Author: jstevans

README.md

@@ -0,0 +1,45 @@
+# lighting-arduino
+
+## Background
+
+People have various preferences when it comes to their physical work
+environment, and it's common for these preferences to conflict. Unfortunately,
+in the matter of lighting, it's common for this conflict to manifest in the
+form of a war over the dimmer-switch, leading to fluctuations in lighting
+throughout the day -- which tends to give me a headache. 
+
+`lighting-arduino` seeks to use the [`SparkFun ESP32 Thing
+Plus`][sparkfun-thing-plus] and the [`SparkFun Ambient Light
+Sensor`][sparkfun-light-sensor] to measure and track workspace illuminance over
+time.
+
+OSHA [specifies a minimum illuminance of 30 foot-candles][osha-general-office]
+in general office settings, with a [recommendation of 20-50
+foot-candles][osha-monitors] when working with CRT monitors, and up to 73
+foot-candles when working with LED monitors (no minimum is set forth in this
+case).
+
+[sparkfun-thing-plus]:https://www.sparkfun.com/products/14689
+[sparkfun-light-sensor]:https://www.sparkfun.com/products/15436
+[osha-general-office]:https://www.osha.gov/laws-regs/regulations/standardnumber/1926/1926.56
+[osha-monitors]:https://www.osha.gov/SLTC/etools/computerworkstations/wkstation_enviro.html
+
+## Reading
+
+- [SparkFun Thing Plus][sparkfun-thing-plus]
+- [Serial comm on Linux][linux-serial-comm]
+
+[linux-serial-comm]:https://www.cyberciti.biz/hardware/5-linux-unix-commands-for-connecting-to-the-serial-console/
+[sparkfun-thing-plus]:https://learn.sparkfun.com/tutorials/esp32-thing-plus-hookup-guide
+
+## The plan
+
+- [ ] Serial output of the current illuminance, with support for configurable
+  linear backoff polling to conserve energy
+- [ ] Configuration for "acceptable min/max illuminance" and "LED behavior",
+  s.t. the on-board LED either turns on, turns off, or blinks when the light
+  level is acceptable (or unacceptable)
+- [ ] BLE server w/ real-time output
+- [ ] Storage of metrics (one datapoint at variable rates based on recency --
+  every sec for the last min, and every 15min after that) long-term trends
+- [ ] (Stretch goal) a way to output a graph from the metrics