doc(unitproc/.../sleepRand.py): Add comments

[BK-2020-03.git] / unitproc / bktemp-timeUntilNextHour

diff --git a/unitproc/bktemp-timeUntilNextHour b/unitproc/bktemp-timeUntilNextHour
index c43cd5a6b1228dc7f0a249fa2adf8374830227b9..6b56424bfeff32861aaee01852497bb06c1d91fd 100644 (file)
--- a/unitproc/bktemp-timeUntilNextHour
+++ b/unitproc/bktemp-timeUntilNextHour
@@ -8,27 +8,27 @@ die() { yell "$*"; exit 111; }
 try() { "$@" || die "cannot $*"; }
 timeUntilNextHour(){
     # Desc: Report seconds until next hour
 try() { "$@" || die "cannot $*"; }
 timeUntilNextHour(){
     # Desc: Report seconds until next hour

-    # Version 1.0.0
+    # Version 1.0.1

     # Output: stdout: integer seconds until next hour
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextHour
     # Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi
     
     # Output: stdout: integer seconds until next hour
     # Output: exit code 0 if stdout > 0; 1 if stdout = 0; 2 if stdout < 0
     # Usage: timeUntilNextHour
     # Usage: if ! myTTL="$(timeUntilNextHour)"; then yell "ERROR in if statement"; exit 1; fi
     

-    local returnState TIME_CURRENT TIME_NEXT_HOUR SECONDS_UNTIL_NEXT_HOUR
-    TIME_CURRENT="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second.
-    TIME_NEXT_HOUR="$(date -d "$TIME_CURRENT next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second.
-    SECONDS_UNTIL_NEXT_HOUR="$(( $(date +%s -d "$TIME_NEXT_HOUR") - $(date +%s -d "$TIME_CURRENT") ))"; # Calculate seconds until next hour (res. 1 second).
-    if [[ "$SECONDS_UNTIL_NEXT_HOUR" -gt 0 ]]; then
+    local returnState timeCurrent timeNextHour secondsUntilNextHour
+    timeCurrent="$(date --iso-8601=seconds)"; # Produce `date`-parsable current timestamp with resolution of 1 second.
+    timeNextHour="$(date -d "$timeCurrent next hour" --iso-8601=hours)"; # Produce `date`-parsable current time stamp with resolution of 1 second.
+    secondsUntilNextHour="$(( $(date +%s -d "$timeNextHour") - $(date +%s -d "$timeCurrent") ))"; # Calculate seconds until next hour (res. 1 second).
+    if [[ "$secondsUntilNextHour" -gt 0 ]]; then

        returnState="true";
        returnState="true";

-    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -eq 0 ]]; then
+    elif [[ "$secondsUntilNextHour" -eq 0 ]]; then

        returnState="warning_zero";
        yell "WARNING:Reported time until next hour exactly zero.";
        returnState="warning_zero";
        yell "WARNING:Reported time until next hour exactly zero.";

-    elif [[ "$SECONDS_UNTIL_NEXT_HOUR" -lt 0 ]]; then
+    elif [[ "$secondsUntilNextHour" -lt 0 ]]; then

        returnState="warning_negative";
        yell "WARNING:Reported time until next hour is negative.";
        returnState="warning_negative";
        yell "WARNING:Reported time until next hour is negative.";

-    fi
+    fi;

 
 

-    try echo "$SECONDS_UNTIL_NEXT_HOUR"; # Report
+    try echo "$secondsUntilNextHour"; # Report

     
     # Determine function return code
     if [[ "$returnState" = "true" ]]; then
     
     # Determine function return code
     if [[ "$returnState" = "true" ]]; then


@@ -37,7 +37,7 @@ timeUntilNextHour(){
        return 1;
     elif [[ "$returnState" = "warning_negative" ]]; then
        return 2;
        return 1;
     elif [[ "$returnState" = "warning_negative" ]]; then
        return 2;

-    fi
+    fi;

 } # Report seconds until next hour
 #===END Declare local script functions===
 #==END Define script parameters==
 } # Report seconds until next hour
 #===END Declare local script functions===
 #==END Define script parameters==