From: Steven Baltakatei Sandoval <baltakatei@gmail.com>
Date: Sun, 25 Oct 2020 00:05:15 +0000 (+0000)
Subject: doc(temp/README):Initialize README for temperature logging
X-Git-Url: https://zdv2.bktei.com/gitweb/EVA-2020-02.git/commitdiff_plain/036dc86d5f4755d704161a1d3d5ebf34b7a41b9c?ds=inline;hp=-c

doc(temp/README):Initialize README for temperature logging

Add datasheet for digital one-wire sensor
---

036dc86d5f4755d704161a1d3d5ebf34b7a41b9c
diff --git a/doc/temperature/README.org b/doc/temperature/README.org
new file mode 100644
index 0000000..f48a44c
--- /dev/null
+++ b/doc/temperature/README.org
@@ -0,0 +1,61 @@
+#+TITLE: Ninfacyzga-1 Temperature Logging
+#+AUTHOR: Steven Baltakatei Sandoval
+#+EMAIL: baltakatei@gmail.com
+* Temperature Logging
+** About
+This document was created by Steven Baltakatei Sandoval on
+~2020-10-24T23:37Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It was
+updated by Steven Baltakatei Sandoval on ~2020-10-24T23:59Z~
+
+** Narrative
+The ~ninfacyzga-01~ device may log temperature readings from
+temperature sensors attached to it.
+
+Several types of temperature sensors may be equipped:
+
+- A model DS18B20 digital temperature sensor wired to one of the
+  Raspberry Pi Zero W's GPIO pins. Temperature readings may be read
+  via a ~python~ script.
+
+- An Ozzmaker BerryGPS-IMU temperature sensor (ex:
+  BMP388). Temperature readings may be read from a ~python~ script.
+
+- The Raspberry Pi Zero W's internal temperature CPU sensors
+
+Whatever the source, an associated ~python~ script should report the
+temperature in the form of JSON data sent to the script's standard
+output ("stdout") stream.
+
+In turn, this "stdout" is then piped into the ~bklog~ which takes care
+of packaging, encrypting, and appending the JSON data to a timestamped
+~tar~ file.
+
+~cron~ is used to call a single script which performs all of the above
+actions at regular time intervals.
+
+** Description
+*** Hardware
+- DS18B20 1-Wire Digital Thermometer
+- Raspberry Pi Zero W
+- Ozzmaker BerryGPS-IMU, Version 3 (see [[https://ozzmaker.com/berrygps-berrygps-imu-quick-start-guide/][ref]]).
+*** Software
+- [[https://www.raspberrypi.org/downloads/raspberry-pi-os/][Raspberry Pi OS]] : A GNU/Linux operating system derived from
+  Debian 10. This procedure was developed with version ~August 2020~.
+
+** Operating Procedures
+*** Initial Startup
+**** Perform initial setup.
+See [[file:../setup/README.org][Main Setup]] procedure.
+**** Install Hardware for temperature logging
+
+**** Install Software for temperature loggin
+
+***** Install packages via ~apt~
+Run the following command to install the required packages.
+: $ sudo apt install [fill me]
+
+*** Normal Startup
+*** Normal Operation
+*** Normal Shutdown
+*** Unscheduled Shutdown
+** Appendix A
diff --git a/doc/temperature/ref/DS18B20-Datasheet.pdf b/doc/temperature/ref/DS18B20-Datasheet.pdf
new file mode 100644
index 0000000..1a7cb13
Binary files /dev/null and b/doc/temperature/ref/DS18B20-Datasheet.pdf differ