From 202472bfbb0e59f453ac01330fa1e261d472f1be Mon Sep 17 00:00:00 2001
From: Skylar Grant <official.xian@gmail.com>
Date: Sat, 26 Nov 2022 20:56:04 -0500
Subject: [PATCH] TODOs and documenting

---
 main.js | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/main.js b/main.js
index 880bdc9..ac93d14 100644
--- a/main.js
+++ b/main.js
@@ -1,8 +1,12 @@
+// npm module for Raspberri Pi GPIO
 var gpio = require('rpi-gpio');
+// Module for importing environment variables
 var dotenv = require('dotenv').config();
 
+// Set up GPIO 4 (pysical pin 7) as output, then call cycleAuger()
 gpio.setup(7, gpio.DIR_OUT, cycleAuger);
 
+// Turns the auger on (Pin 7 high)
 function augerOn(err) {
     if (err) throw err;
     gpio.write(7, true, function(err) {
@@ -11,6 +15,7 @@ function augerOn(err) {
     });
 }
 
+// Turns the auger off (pin 7 low)
 function augerOff(err) {
     if (err) throw err;
     gpio.write(7, false, function(err) {
@@ -27,7 +32,8 @@ function augerOff(err) {
 // function augerOn() {
 //     console.log('Auger turned on.');
 // }
-  
+
+// Sleeps for any given milliseconds, call with await
 function sleep(ms) {
     return new Promise((resolve) => {
         setTimeout(resolve, ms);
@@ -35,8 +41,10 @@ function sleep(ms) {
     });
 }
 
+// Main function, turns the auger on, sleeps for the time given in environment variables, then turns the auger off, sleeps, repeats.
 async function cycleAuger(err) {
     if (err) throw err;
+    // TODO: Detect file 'pause', 'reload', 'quit'
     augerOn();
     await sleep(process.env.ONTIME);
     augerOff();