michael/battery
1
0
Fork 0
mirror of https://github.com/actuallymentor/battery.git synced 2026-02-03 14:03:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'main' into main

Browse Source
This commit is contained in:
Mentor Palokaj
2024-06-28 11:10:30 +02:00
committed by GitHub
parent 2a4ba9ff9f 43b369e6db
commit 9070edfa98
3 changed files with 142 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -10,15 +10,17 @@ This is an app for Apple Silicon Macs. It will not work on Intel macs. Do you ha
### Installation
- Option 1: install through brew with `brew install battery`
- Option 2: [You can download the latest app dmg version here](https://github.com/actuallymentor/battery/releases/).
- Option 3: command-line only installation (see section below)
- Option 1: install the app through brew with `brew install battery`
- Option 2: [download the app dmg version here](https://github.com/actuallymentor/battery/releases/)
- Option 3: install ONLY the command line interface (see section below)
When installing via brew or dmg, opening the macOS app is required to complete the installation.
The first time you open the app, it will ask for your administator password so it can install the needed components. Please note that the app:
- Discharges your battery until it reaches 80%, **even when plugged in**
- Disables charging when your battery is above 80% charged
- Enabled charging when your battery is under 80% charged
- Enables charging when your battery is under 80% charged
- Keeps the limit engaged even after rebooting
- Keeps the limit engaged even after closing the tray app
- Also automatically installs the `battery` command line tool. If you want a custom charging percentage, the CLI is the only way to do that.

2
app/modules/battery.js
View File

@@ -4,7 +4,7 @@ const { exec } = require( 'node:child_process' )
const { log, alert, wait, confirm } = require( './helpers' )
const { get_force_discharge_setting } = require( './settings' )
const { USER } = process.env
const path_fix = 'PATH=/bin:/usr/bin:/usr/local/bin:/usr/sbin:/opt/homebrew/bin:/opt/homebrew/sbin:/opt/homebrew'
const path_fix = 'PATH=/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin'
const battery = `${ path_fix } battery`
const shell_options = {
shell: '/bin/bash',

148
battery.sh
View File

@@ -7,7 +7,7 @@
BATTERY_CLI_VERSION="v1.1.5"
# Path fixes for unexpected environments
PATH=/bin:/usr/bin:/usr/local/bin:/usr/sbin:/opt/homebrew
PATH=/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
## ###############
## Variables
@@ -19,9 +19,16 @@ configfolder=$HOME/.battery
pidfile=$configfolder/battery.pid
logfile=$configfolder/battery.log
maintain_percentage_tracker_file=$configfolder/maintain.percentage
maintain_voltage_tracker_file=$configfolder/maintain.voltage
daemon_path=$HOME/Library/LaunchAgents/battery.plist
calibrate_pidfile=$configfolder/calibrate.pid
# Voltage limits
voltage_min="10.5"
voltage_max="12.6"
voltage_hyst_min="0.1"
voltage_hyst_max="2"
## ###############
## Housekeeping
## ###############
@@ -52,12 +59,18 @@ Usage:
output logs of the battery CLI and GUI
eg: battery logs 100
battery maintain LEVEL[1-100,stop]
battery maintain PERCENTAGE[1-100,stop]
reboot-persistent battery level maintenance: turn off charging above, and on below a certain value
it has the option of a --force-discharge flag that discharges even when plugged in (this does NOT work well with clamshell mode)
eg: battery maintain 80
eg: battery maintain stop
battery maintain VOLTAGE[${voltage_min}V-${voltage_max}V,stop] (HYSTERESIS[${voltage_hyst_min}V-${voltage_hyst_max}V])
reboot-persistent battery level maintenance: keep battery at a certain voltage
default hysteresis: 0.1V
eg: battery maintain 11.4V # keeps battery between 11.3V and 11.5V
eg: battery maintain 11.4V 0.3V # keeps battery between 11.1V and 11.7V
battery charging SETTING[on/off]
manually set the battery to (not) charge
eg: battery charging on
@@ -227,11 +240,21 @@ function get_remaining_time() {
echo "$time_remaining"
}
function get_charger_state() {
ac_attached=$(pmset -g batt | tail -n1 | awk '{ x=match($0, /AC attached/) > 0; print x }')
echo "$ac_attached"
}
function get_maintain_percentage() {
maintain_percentage=$(cat $maintain_percentage_tracker_file 2>/dev/null)
echo "$maintain_percentage"
}
function get_voltage() {
voltage=$(ioreg -l -n AppleSmartBattery -r | grep "\"Voltage\" =" | awk '{ print $3/1000 }' | tr ',' '.')
echo "$voltage"
}
## ###############
## Actions
## ###############
@@ -479,11 +502,14 @@ if [[ "$action" == "maintain_synchronous" ]]; then
# Keep track of status
is_charging=$(get_smc_charging_status)
ac_attached=$(get_charger_state)
if [[ "$battery_percentage" -ge "$setting" && "$is_charging" == "enabled" ]]; then
if [[ "$battery_percentage" -ge "$setting" && ( "$is_charging" == "enabled" || "$ac_attached" == "1" ) ]]; then
log "Charge above $setting"
disable_charging
if [[ "$is_charging" == "enabled" ]]; then
disable_charging
fi
change_magsafe_led_color "green"
elif [[ "$battery_percentage" -lt "$setting" && "$is_charging" == "disabled" ]]; then
@@ -504,6 +530,54 @@ if [[ "$action" == "maintain_synchronous" ]]; then
fi
# Maintain at voltage
if [[ "$action" == "maintain_voltage_synchronous" ]]; then
# Recover old maintain status if old setting is found
if [[ "$setting" == "recover" ]]; then
# Before doing anything, log out environment details as a debugging trail
log "Debug trail. User: $USER, config folder: $configfolder, logfile: $logfile, file called with 1: $1, 2: $2"
maintain_voltage=$(cat $maintain_voltage_tracker_file 2>/dev/null)
if [[ $maintain_voltage ]]; then
log "Recovering maintenance voltage $maintain_voltage"
setting=$(echo $maintain_voltage | awk '{print $1}')
subsetting=$(echo $maintain_voltage | awk '{print $2}')
else
log "No setting to recover, exiting"
exit 0
fi
fi
voltage=$(get_voltage)
lower_voltage=$(echo "$setting - $subsetting" | bc -l)
upper_voltage=$(echo "$setting + $subsetting" | bc -l)
log "Keeping voltage between ${lower_voltage}V and ${upper_voltage}V"
# Loop
while true; do
is_charging=$(get_smc_charging_status)
if (( $(echo "$voltage < $lower_voltage" | bc -l) )) && [[ "$is_charging" == "disabled" ]]; then
log "Battery at ${voltage}V"
enable_charging
fi
if (( $(echo "$voltage >= $upper_voltage" | bc -l) )) && [[ "$is_charging" == "enabled" ]]; then
log "Battery at ${voltage}V"
disable_charging
fi
sleep 60
voltage=$(get_voltage)
done
exit 0
fi
# Asynchronous battery level maintenance
if [[ "$action" == "maintain" ]]; then
@@ -529,8 +603,30 @@ if [[ "$action" == "maintain" ]]; then
exit 0
fi
# Check if setting is a voltage
is_voltage=false
if [[ "$setting" =~ ^[0-9]+(\.[0-9]+)?V$ ]]; then
setting="${setting//V}"
if [[ "$subsetting" =~ ^[0-9]+(\.[0-9]+)?V$ ]]; then
subsetting="${subsetting//V}"
else
subsetting="0.1"
fi
if (( $(echo "$setting < $voltage_min" | bc -l) || $(echo "$setting > $voltage_max" | bc -l) )); then
log "Error: ${setting}V is not a valid setting. Please use a value between ${voltage_min}V and ${voltage_max}V"
exit 1
fi
if (( $(echo "$subsetting < $voltage_hyst_min" | bc -l) || $(echo "$subsetting > $voltage_max" | bc -l) )); then
log "Error: ${subsetting}V is not a valid setting. Please use a value between ${voltage_hyst_min}V and ${voltage_hyst_max}V"
exit 1
fi
is_voltage=true
# Check if setting is value between 0 and 100
if ! [[ "$setting" =~ ^[0-9]+$ ]] || [[ "$setting" -lt 0 ]] || [[ "$setting" -gt 100 ]]; then
elif ! [[ "$setting" =~ ^[0-9]+$ ]] || [[ "$setting" -lt 0 ]] || [[ "$setting" -gt 100 ]]; then
log "Called with $setting $action"
# If non 0-100 setting is not a special keyword, exit with an error.
@@ -542,17 +638,32 @@ if [[ "$action" == "maintain" ]]; then
fi
# Start maintenance script
log "Starting battery maintenance at $setting% $subsetting"
nohup battery maintain_synchronous $setting $subsetting >>$logfile &
if [ "$is_voltage" = true ]; then
log "Starting battery maintenance at ${setting}V ±${subsetting}V"
nohup battery maintain_voltage_synchronous $setting $subsetting >>$logfile &
else
log "Starting battery maintenance at $setting% $subsetting"
nohup battery maintain_synchronous $setting $subsetting >>$logfile &
fi
# Store pid of maintenance process and setting
echo $! >$pidfile
pid=$(cat "$pidfile" 2>/dev/null)
if ! [[ "$setting" == "recover" ]]; then
log "Writing new setting $setting to $maintain_percentage_tracker_file"
echo $setting >$maintain_percentage_tracker_file
log "Maintaining battery at $setting%"
rm "$maintain_percentage_tracker_file" "$maintain_voltage_tracker_file" 2> /dev/null
if [[ "$is_voltage" = true ]]; then
log "Writing new setting $setting $subsetting to $maintain_voltage_tracker_file"
echo "$setting $subsetting" >$maintain_voltage_tracker_file
log "Maintaining battery at ${setting}V ±${subsetting}V"
else
log "Writing new setting $setting to $maintain_percentage_tracker_file"
echo $setting >$maintain_percentage_tracker_file
log "Maintaining battery at $setting%"
fi
fi
# Enable the daemon that continues maintaining after reboot
@@ -623,10 +734,16 @@ fi
# Status logger
if [[ "$action" == "status" ]]; then
log "Battery at $(get_battery_percentage)% ($(get_remaining_time) remaining), smc charging $(get_smc_charging_status)"
log "Battery at $(get_battery_percentage)% ($(get_remaining_time) remaining), $(get_voltage)V, smc charging $(get_smc_charging_status)"
if test -f $pidfile; then
maintain_percentage=$(cat $maintain_percentage_tracker_file 2>/dev/null)
log "Your battery is currently being maintained at $maintain_percentage%"
if [[ $maintain_percentage ]]; then
maintain_level="$maintain_percentage%"
else
maintain_level=$(cat $maintain_voltage_tracker_file 2>/dev/null)
maintain_level=$(echo "$maintain_level" | awk '{print $1 "V ±" $2 "V"}')
fi
log "Your battery is currently being maintained at $maintain_level"
fi
exit 0
@@ -642,6 +759,11 @@ fi
# launchd daemon creator, inspiration: https://www.launchd.info/
if [[ "$action" == "create_daemon" ]]; then
call_action="maintain_synchronous"
if test -f "$maintain_voltage_tracker_file"; then
call_action="maintain_voltage_synchronous"
fi
daemon_definition="
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">
@@ -652,7 +774,7 @@ if [[ "$action" == "create_daemon" ]]; then
<key>ProgramArguments</key>
<array>
<string>$binfolder/battery</string>
<string>maintain_synchronous</string>
<string>$call_action</string>
<string>recover</string>
</array>
<key>StandardOutPath</key>