feat(bkgpslog): Append to daily tar

[EVA-2020-02.git] / exec / bkgpslog-plan.org

diff --git a/exec/bkgpslog-plan.org b/exec/bkgpslog-plan.org
new file mode 100644 (file)
index 0000000..bc98f9a
--- /dev/null
+++ b/exec/bkgpslog-plan.org
@@ -0,0 +1,35 @@
+* bkgpslog narrative
+** Initialize environment
+*** Init variables
+**** Save timeStart (YYYYmmddTHHMMSS±zz)
+*** Define Functions
+**** Define Debugging functions
+**** Define Argument Processing function
+**** Define Main function
+** Run Main Function
+*** Process Arguments
+*** Set output encryption and compression option strings
+*** Check that critical apps and dirs are available, displag missing ones.
+*** Set lifespans of script and buffer
+*** Init temp working dir ~DIR_TMP~
+Make temporary dir in tmpfs dir: ~/dev/shm/$(nonce)..bkgpslog/~ (~DIR_TMP~)
+*** Initialize ~tar~ archive
+**** Write ~bkgpslog~ version to ~$DIR_TMP/VERSION~
+**** Create empty ~tar~ archive in ~DIR_OUT~ at ~PATHOUT_TAR~
+
+Set output file name to:
+: PATHOUT_TAR="$DIR_OUT/YYYYmmdd..hostname_location.gz.age.tar"
+Usage: ~iso8601Period $timeStart $timeEnd~ 
+
+**** Append ~VERSION~ file to ~PATHOUT_TAR~
+
+Append ~$DIR_TMP/VERSION~ to ~PATHOUT_TAR~ via ~tar --append~
+
+*** Read/Write Loop (Record gps data until script lifespan ends)
+**** Determine output file paths
+**** Define GPS conversion commands
+**** Fill Bash variable buffer from ~gpspipe~
+**** Process bufferBash, save secured chunk set to ~DIR_TMP~
+**** Append each secured chunk to ~PATHOUT_TAR~
+: tar --append --directory=DIR_TMP --file=PATHOUT_TAR $(basename PATHOUT_{NMEA,GPX,KML} )
+**** Remove secured chunk from ~DIR_TMP~