Skip to content

Commit

Permalink
Update README with new battery thresholds feature (#644)
Browse files Browse the repository at this point in the history
* README: add battery threshold sections

* README: link to version
  • Loading branch information
shadeyg56 committed Feb 14, 2024
1 parent 1d7f12e commit 9b8e873
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ Example of `auto-cpufreq --stats` CLI output
* [Update - auto-cpufreq update](#update---auto-cpufreq-update)
* [Remove - auto-cpufreq daemon](#remove---auto-cpufreq-daemon)
* [stats](#stats)
* [Battery charging thresholds](#battery-charging-thresholds)
* [Supported Devices](#supported-devices)
* [Battery config](#battery-config)
* [Troubleshooting](#troubleshooting)
* [AUR](#aur)
* [Discussion](#discussion)
Expand Down Expand Up @@ -93,6 +96,7 @@ Only devices with an Intel, AMD, or ARM CPU are supported. This tool was develop
* CPU temperature in combination with CPU utilization/load (to prevent overheating)
* System load
* Automatic CPU & power optimization (temporary and persistent)
* Settings battery charging thresholds (limited support)

## Installing auto-cpufreq

Expand Down Expand Up @@ -465,6 +469,31 @@ If the daemon has been installed, live stats of CPU/system load monitoring and o

`auto-cpufreq --stats`

## Battery charging thresholds

As of [v2.2.0](https://github.com/AdnanHodzic/auto-cpufreq/releases/tag/v2.2.0), battery charging thresholds can be set in the config file. This enforces your battery to start and stop charging at defined values

### Supported devices

* **Lenovo ThinkPad** (thinkpad_acpi)*
* **Lenovo IdeaPad** (ideapad_acpi)*

***Please note, your laptop must have an installed ACPI kernel driver specific to the manufacturer.** To check if you have the correct module installed and loaded run `lsmod [module]`

**To request that your device be supported, please open an [issue](https://github.com/AdnanHodzic/auto-cpufreq/issues/new). In your issue, make us aware of the driver that works with your laptop**

### Battery config
Edit the config at `/etc/auto-cpufreq.conf`

Example config for battery
```
[battery]
enable_thresholds = true
start_threshold = 20
stop_threshold = 80
```


## Troubleshooting

**Q:** If after installing auto-cpufreq you're (still) experiencing:
Expand Down

0 comments on commit 9b8e873

Please sign in to comment.