From 3e36fb9979807ce432249f043757ccb25000451d Mon Sep 17 00:00:00 2001
From: "Scott C. MacCallum" <scm@sdf.org>
Date: Mon, 25 Nov 2024 15:14:09 -0500
Subject: [PATCH] More changes

---
 battery-monitor.sh | 29 ++++++++++++++++-------------
 1 file changed, 16 insertions(+), 13 deletions(-)

diff --git a/battery-monitor.sh b/battery-monitor.sh
index 7b18bac..f5f0cb3 100755
--- a/battery-monitor.sh
+++ b/battery-monitor.sh
@@ -2,10 +2,12 @@
 
 # battery-monitor.sh
 
-# This program lets the user know when the battery needs to be charged, and
-# suspends the computer once a user defined minimum is reached. It has been
-# tested to work on a Debian 12 GNU/Linux x86_64 default console
-# installation. The installation of bc is required.
+# Once a user defined minimum is reached, this program lets the user know
+# when the battery needs to be charged and suspends the computer.
+
+# This program has been verified to work on a Debian 12 GNU/Linux x86_64
+# default console installation, but the installation of the bc program is
+# required.
 
 # Copyright (c) 2024, Scott C. MacCallum (scott@scm-guru.live).
 
@@ -28,7 +30,7 @@
 # Change this variable to the group that should be informed of a need to
 # charge the battery. On GNU/Linux distributions users are often part of
 # a group that is the same as their login name, which works well if you only
-# want your user to be informed in the console.
+# want your user to be informed on the console.
 
 group="scm"
 
@@ -42,6 +44,8 @@ if (( minutes == 0 )); then
     exit 0
 fi
 
+# Calculate the state of the battery.
+
 charge=$(cat /sys/class/power_supply/$battery/charge_now)
 discharge=$(cat /sys/class/power_supply/$battery/current_now)
 hours=$(echo "scale=2; $charge / $discharge" | bc -l)
@@ -49,20 +53,19 @@ minutes=$(echo "scale=2; $hours * 60" | bc -l)
 
 # Change the minimum variable to the minimum amount of minutes that a battery
 # is estimated to have left before the group is informed to recharge it. When
-# I tested this and the battery-suspend.sh script, I was surprised to
-# discover that the computer turned off despite having reported that there
-# was 10 minutes left! I created the battery-status.sh script to aid in my
-# understanding of what was going on, and I discovered a variance of about 10
-# minutes plus/minus each time that I ran it, so the system is clearly making
-# an estimate. Keep the minus 10 minutes in mind when setting the minimum
-# value.
+# I tested this, I was surprised to discover that the computer turned off
+# despite having reported that there was 10 minutes left! I created the
+# battery-status.sh script to aid in my understanding of what was going on,
+# and I discovered a variance of minutes plus/minus each time that I ran it,
+# so the system is clearly making an estimate. Keep this in mind when setting
+# the minimum value.
 
 # Change this variable to you liking, but less than 40.00 is likely a bad
 # idea. YOU'VE BEEN WARNED!
 
 minimum=40.00
 
-If the minutes of charge are less that the minimum.
+If the minutes of charge are less than the minimum.
 
 if (( $(echo "$minutes < $minimum" | bc -l) )); then
     echo "Suspending the computer! Battery charge is needed!" | wall -g $group