chore(TODO):Note need to create script to handle file encryption
[EVA-2020-02.git] / doc / temperature / README.org
CommitLineData
036dc86d
SBS
1#+TITLE: Ninfacyzga-1 Temperature Logging
2#+AUTHOR: Steven Baltakatei Sandoval
3#+EMAIL: baltakatei@gmail.com
4* Temperature Logging
5** About
6This document was created by Steven Baltakatei Sandoval on
7~2020-10-24T23:37Z~ under a [[https://creativecommons.org/licenses/by-sa/4.0/][Creative Commons BY-SA 4.0 license]]. It was
8updated by Steven Baltakatei Sandoval on ~2020-10-24T23:59Z~
9
10** Narrative
11The ~ninfacyzga-01~ device may log temperature readings from
12temperature sensors attached to it.
13
14Several types of temperature sensors may be equipped:
15
16- A model DS18B20 digital temperature sensor wired to one of the
17 Raspberry Pi Zero W's GPIO pins. Temperature readings may be read
18 via a ~python~ script.
19
20- An Ozzmaker BerryGPS-IMU temperature sensor (ex:
21 BMP388). Temperature readings may be read from a ~python~ script.
22
23- The Raspberry Pi Zero W's internal temperature CPU sensors
24
25Whatever the source, an associated ~python~ script should report the
26temperature in the form of JSON data sent to the script's standard
27output ("stdout") stream.
28
29In turn, this "stdout" is then piped into the ~bklog~ which takes care
30of packaging, encrypting, and appending the JSON data to a timestamped
31~tar~ file.
32
33~cron~ is used to call a single script which performs all of the above
34actions at regular time intervals.
35
36** Description
37*** Hardware
38- DS18B20 1-Wire Digital Thermometer
39- Raspberry Pi Zero W
40- Ozzmaker BerryGPS-IMU, Version 3 (see [[https://ozzmaker.com/berrygps-berrygps-imu-quick-start-guide/][ref]]).
41*** Software
42- [[https://www.raspberrypi.org/downloads/raspberry-pi-os/][Raspberry Pi OS]] : A GNU/Linux operating system derived from
43 Debian 10. This procedure was developed with version ~August 2020~.
44
45** Operating Procedures
46*** Initial Startup
47**** Perform initial setup.
48See [[file:../setup/README.org][Main Setup]] procedure.
49**** Install Hardware for temperature logging
50
51**** Install Software for temperature loggin
52
53***** Install packages via ~apt~
54Run the following command to install the required packages.
55: $ sudo apt install [fill me]
56
57*** Normal Startup
58*** Normal Operation
59*** Normal Shutdown
60*** Unscheduled Shutdown
61** Appendix A