Update README with new battery thresholds feature

auto-cpufreq-installer

@@ -55,12 +55,12 @@ function setup_venv {
 
     source "${venv_dir}/bin/activate"
     python3 -m pip install --upgrade pip wheel
-    python3 -m pip install -r requirements.txt
 }
 
 # tool install
 function install {
-  python3 setup.py install --record files.txt
+  git config --global --add safe.directory $(pwd)
+  python -m pip install .
   mkdir -p /usr/local/share/auto-cpufreq/
   cp -r scripts/ /usr/local/share/auto-cpufreq/
   cp -r images/ /usr/local/share/auto-cpufreq/
@@ -119,7 +119,7 @@ function manual_install {
 
 	-----
 
-	python3 setup.py install --record files.txt
+	pip3 install .
 	mkdir -p /usr/local/share/auto-cpufreq/
 	cp -r scripts/ /usr/local/share/auto-cpufreq/
 
@@ -208,7 +208,7 @@ fi
 }
 
 function tool_remove {
-  files="files.txt"
+  # files="files.txt"
   share_dir="/usr/local/share/auto-cpufreq/"
 
   srv_install="/usr/local/bin/auto-cpufreq-install"
@@ -249,7 +249,7 @@ function tool_remove {
   fi
 
   # remove auto-cpufreq and all its supporting files
-  [ -f $files ] && cat $files | xargs sudo rm -rf && rm -f $files
+  # [ -f $files ] && cat $files | xargs sudo rm -rf && rm -f $files
   [ -d $share_dir ] && rm -rf $share_dir
 
   # files cleanup

auto-cpufreq.conf-example

@@ -4,6 +4,9 @@
 # preferred governor.
 governor = performance
 
+# EPP: see available preferences by running: cat /sys/devices/system/cpu/cpu0/cpufreq/energy_performance_available_preferences
+energy_performance_preference = performance
+
 # minimum cpu frequency (in kHz)
 # example: for 800 MHz = 800000 kHz --> scaling_min_freq = 800000
 # see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
@@ -25,6 +28,9 @@ turbo = auto
 # preferred governor
 governor = powersave
 
+# EPP: see available preferences by running: cat /sys/devices/system/cpu/cpu0/cpufreq/energy_performance_available_preferences
+energy_performance_preference = power
+
 # minimum cpu frequency (in kHz)
 # example: for 800 MHz = 800000 kHz --> scaling_min_freq = 800000
 # see conversion info: https://www.rapidtables.com/convert/frequency/mhz-to-hz.html
@@ -39,3 +45,17 @@ governor = powersave
 
 # turbo boost setting. possible values: always, auto, never
 turbo = auto
+
+# experimental 
+
+# Add battery charging threshold (currently only available to Lenovo)
+# checkout README.md for more info
+
+# enable thresholds true or false
+#enable_thresholds = true
+#
+# start threshold (defaults to 0 ) can be 0 - 100
+#start_threshold = 0
+#
+# stop threshold (defaults to 100) this value must be greater or equal to 65
+#stop_threshold = 100

auto_cpufreq/battery_scripts/battery.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python3
+import subprocess
+from auto_cpufreq.core import get_config, root_check
+
+from auto_cpufreq.battery_scripts.thinkpad import *
+from auto_cpufreq.battery_scripts.ideapad import *
+
+
+def lsmod(module):
+    output = subprocess.run(['lsmod'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+    if module in output.stdout:
+        return True
+    else:
+        return False
+
+
+def battery_start_threshold():
+    conf = get_config()
+    if conf.has_option("battery", "start_threshold"):
+        start_threshold = conf["battery"]["start_threshold"]
+        return int(start_threshold)
+    else:
+        return 0
+
+
+def battery_stop_threshold():
+    conf = get_config()
+    if conf.has_option("battery", "stop_threshold"):
+        stop_threshold = conf["battery"]["stop_threshold"]
+        return int(stop_threshold)
+    else:
+        return 100
+
+
+def battery_setup():
+    root_check()
+    conf = get_config()
+    if conf.has_option("battery", "enable_thresholds"):
+        if conf["battery"]["enable_thresholds"] == "true":
+            if lsmod("thinkpad_acpi"):
+                thinkpad_setup(battery_start_threshold(), battery_stop_threshold())
+            elif lsmod("ideapad_acpi"):
+                ideapad_setup(battery_start_threshold(), battery_stop_threshold())
+            else:
+                pass
+        else:
+            pass
+    else:
+        pass
+
+
+def battery_get_thresholds():
+    conf = get_config()
+    if conf.has_option("battery", "enable_thresholds"):
+        if conf["battery"]["enable_thresholds"] == "true":
+            print("-" * 30 )
+            if lsmod("thinkpad_acpi"):
+                thinkpad_print_thresholds()
+            elif lsmod("ideapad_acpi"):
+                ideapad_print_thresholds()
+            else:
+                pass
+        else:
+            return
+    else:
+        return

auto_cpufreq/battery_scripts/ideapad.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+import os
+from auto_cpufreq.core import root_check
+
+
+def ideapad_setup(start_threshold, stop_threshold):
+    root_check()
+    # this path is specific to ideapads
+    path_to_bats = '/sys/class/power_supply/'
+    # gets the numb of batteries
+    battery_count = len([name for name in os.listdir(path_to_bats) if name.startswith('BAT')])
+
+    for b in range(battery_count):
+
+        try:
+            with open(f'{path_to_bats}BAT{b}/charge_start_threshold', 'w') as f:
+                f.write(str(start_threshold) + '\n')
+                f.close()
+
+            with open(f'{path_to_bats}BAT{b}/charge_stop_threshold', 'w') as f:
+                f.write(str(stop_threshold) + '\n')
+                f.close()
+
+        except Exception:
+            pass
+
+
+def ideapad_print_thresholds():
+    root_check()
+    path_to_bats = '/sys/class/power_supply/'
+    battery_count = len([name for name in os.listdir(path_to_bats) if name.startswith('BAT')])
+    print(f"number of batteries = {battery_count}")
+    for b in range(battery_count):
+        try:
+            with open(f'{path_to_bats}BAT{b}/charge_start_threshold', 'r') as f:
+                print(f'battery{b} start threshold is set to {f.read()}')
+                f.close()
+
+            with open(f'{path_to_bats}BAT{b}/charge_stop_threshold', 'r') as f:
+                print(f'battery{b} stop threshold is set to {f.read()}')
+                f.close()
+
+        except Exception as e:
+            print(f"Error reading battery thresholds: {e}")

auto_cpufreq/battery_scripts/thinkpad.py

@@ -0,0 +1,51 @@
+#!/usr/bin/env python3
+import os
+from auto_cpufreq.core import root_check
+
+
+def thinkpad_setup(start_threshold, stop_threshold):
+    root_check()
+    # this path is specific to thinkpads
+    path_to_bats = '/sys/class/power_supply/'
+    # gets the numb of batteries
+    battery_count = len([name for name in os.listdir(path_to_bats) if name.startswith('BAT')])
+
+    for b in range(battery_count):
+
+        try:
+            with open(f'{path_to_bats}BAT{b}/charge_start_threshold', 'w') as f:
+                f.write(str(start_threshold) + '\n')
+                f.close()
+        except Exception as e:
+            print(f"could not write to BAT{b} start threshold")
+            print(e)
+
+        try:
+            with open(f'{path_to_bats}BAT{b}/charge_stop_threshold', 'w') as f:
+                f.write(str(stop_threshold) + '\n')
+                f.close()
+
+        except Exception as e:
+            print(f"could not write to BAT{b} stop threshold you might be setting it too low try < 65")
+            print(e)
+            pass
+
+
+def thinkpad_print_thresholds():
+    root_check()
+    # this path is specific to thinkpads
+    path_to_bats = '/sys/class/power_supply/'
+    battery_count = len([name for name in os.listdir(path_to_bats) if name.startswith('BAT')])
+    print(f"number of batteries = {battery_count}")
+    for b in range(battery_count):
+        try:
+            with open(f'{path_to_bats}BAT{b}/charge_start_threshold', 'r') as f:
+                print(f'battery{b} start threshold is set to {f.read()}')
+                f.close()
+
+            with open(f'{path_to_bats}BAT{b}/charge_stop_threshold', 'r') as f:
+                print(f'battery{b} stop threshold is set to {f.read()}')
+                f.close()
+
+        except Exception as e:
+            print(f"Error reading battery thresholds: {e}")

bin/auto-cpufreq → auto_cpufreq/bin/auto_cpufreq.py

@@ -10,10 +10,10 @@
 from click import UsageError
 from subprocess import call, run
 
-sys.path.append("../")
+# sys.path.append("../")
 from auto_cpufreq.core import *
 from auto_cpufreq.power_helper import *
-
+from auto_cpufreq.battery_scripts.battery import *
 # cli
 @click.command()
 @click.option("--monitor", is_flag=True, help="Monitor and see suggestions for CPU optimizations")
@@ -34,9 +34,10 @@
 @click.option("--debug", is_flag=True, help="Show debug info (include when submitting bugs)")
 @click.option("--version", is_flag=True, help="Show currently installed version")
 @click.option("--donate", is_flag=True, help="Support the project")
+@click.option("--completions", is_flag=False, help="Enables shell completions for bash, zsh and fish.\n Possible values bash|zsh|fish")
 @click.option("--log", is_flag=True, hidden=True)
 @click.option("--daemon", is_flag=True, hidden=True)
-def main(config, daemon, debug, update, install, remove, live, log, monitor, stats, version, donate, force, get_state):
+def main(config, daemon, debug, update, install, remove, live, log, monitor, stats, version, donate, force, get_state, completions):
 
     # display info if config file is used
     def config_info_dialog():
@@ -50,7 +51,6 @@ def config_info_dialog():
         set_override(force) # Calling set override, only if force has some values
 
     if len(sys.argv) == 1:
-
         print("\n" + "-" * 32 + " auto-cpufreq " + "-" * 33 + "\n")
         print("Automatic CPU speed & power optimizer for Linux")
 
@@ -67,6 +67,7 @@ def config_info_dialog():
             if os.getenv("PKG_MARKER") == "SNAP" and dcheck == "enabled":
                 gnome_power_detect_snap()
                 tlp_service_detect_snap()
+                battery_setup()
                 while True:
                     footer()
                     gov_check()
@@ -78,6 +79,7 @@ def config_info_dialog():
             elif os.getenv("PKG_MARKER") != "SNAP":
                 gnome_power_detect()
                 tlp_service_detect()
+                battery_setup()
                 while True:
                     footer()
                     gov_check()
@@ -94,6 +96,8 @@ def config_info_dialog():
             config_info_dialog()
             root_check()
             print('\nNote: You can quit monitor mode by pressing "ctrl+c"')
+            battery_setup()
+            battery_get_thresholds()
             if os.getenv("PKG_MARKER") == "SNAP":
                 gnome_power_detect_snap()
                 tlp_service_detect_snap()
@@ -248,7 +252,9 @@ def config_info_dialog():
             elif subprocess.run(["bash", "-c", "command -v pacman >/dev/null 2>&1"]).returncode == 0 and subprocess.run(["bash", "-c", "pacman -Q auto-cpufreq >/dev/null 2>&1"]).returncode == 0:
                 print("Arch-based distribution with AUR support detected. Please refresh auto-cpufreq using your AUR helper.")
             else:
-                verify_update()
+                is_new_update = check_for_update()
+                if not is_new_update:
+                    return
                 ans = input("Do you want to update auto-cpufreq to the latest release? [Y/n]: ").strip().lower()
                 if not os.path.exists(custom_dir):
                     os.makedirs(custom_dir)
@@ -265,5 +271,22 @@ def config_info_dialog():
                 else:
                     print("Aborted")
 
+        elif completions:
+            if completions == "bash":
+                print("Run the below command in your current shell!\n")
+                print("echo 'eval \"$(_AUTO_CPUFREQ_COMPLETE=bash_source auto-cpufreq)\"' >> ~/.bashrc")
+                print("source ~/.bashrc")
+            elif completions == "zsh":
+                print("Run the below command in your current shell!\n")
+                print("echo 'eval \"$(_AUTO_CPUFREQ_COMPLETE=zsh_source auto-cpufreq)\"' >> ~/.zshrc")
+                print("source ~/.zshrc")
+            elif completions == "fish":
+                print("Run the below command in your current shell!\n")
+                print("echo '_AUTO_CPUFREQ_COMPLETE=fish_source auto-cpufreq | source' > ~/.config/fish/completions/auto-cpufreq.fish")
+            else:
+                print("Invalid Option, try bash|zsh|fish as argument to --completions")
+
+
+
 if __name__ == "__main__":
     main()

bin/auto-cpufreq-gtk → auto_cpufreq/bin/auto_cpufreq_gtk.py

@@ -10,9 +10,13 @@
 from gi.repository import Gtk, GLib
 from auto_cpufreq.gui.app import ToolWindow
 
-if __name__ == "__main__":
+def main():
+    GLib.set_prgname("auto-cpufreq")
     win = ToolWindow()
     win.connect("destroy", Gtk.main_quit)
     win.show_all()
-    GLib.set_prgname("auto-cpufreq")
-    Gtk.main()
+    win.handle_update()
+    Gtk.main()
+
+if __name__ == "__main__":
+    main()