Update README.md

- Add a few screenshots
- Remove note about crappy logo
- Add links to Storeman, Openrepos page and Sailfish OS forum
This commit is contained in:
Matti Viljanen 2022-08-28 02:12:42 +03:00 committed by GitHub
parent 9a95cef222
commit e9e9c2b9f2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,8 +1,13 @@
# harbour-batterybuddy
<img src="https://github.com/direc85/harbour-batterybuddy/raw/master/screenshot1.jpg?raw=true" alt="Screenshot 1" style="width: 270px; height: 480px;"> <img src="https://github.com/direc85/harbour-batterybuddy/raw/master/screenshot4.jpg?raw=true" alt="Screenshot 4" style="width: 270px; height: 480px;">
Battery Buddy is a Sailfish OS application that pauses and resumes charging at set percentage values, or alerts the user when the battery charge level gets too high or too low. This helps in increasing the battery lifespan. There are a *lot* of research material on this, the numbers I pulled into the application as a reference were pulled from [Battery Universe online article BU-808](https://batteryuniversity.com/learn/article/how_to_prolong_lithium_based_batteries).
The application logo is a 5 minute craft at the moment, and can be considered a permanent temporary solution. It doesn't look nice in the notification view. If you have the skills to make a better logo using the same idea (a heart inside the battery) and are willing to spend a little time for this project, please feel free to send a new logo to me.
The application consist of three parts: the GUI, the monitoring daemon and the filesystem permission daemon. The filesystem daemon, `harbour-batterybuddy-oneshot.service`, always starts when the device boots. Its sole purpose is to set correct permissions for the charger control file of the device, so that everything else can be started as user `defaultuser` (or `nemo`), minimizing security impact. The monitoring daemon, `harbour-batterybuddy.service`, actually sends the notifications and pauses/resumes charging.
The application consist of three parts: the GUI, the monitoring daemon and the filesystem permission daemon. The filesystem daemon, `harbour-batterybuddy-oneshot.service`, always starts when the device boots. Its sole purpose is to set correct permissions for the charger control file of the device, so that everything else can be started as user `nemo`, minimizing security impact. The monitoring daemon, `harbour-batterybuddy.service`, actually sends the notifications and pauses/resumes charging.
There's a logging feature, too, which writes to a simple text log. Depending on the log level it can log percentage changes, temperature changes and momentary device current draw. Note that the measurement can only be done when the device is not in deep sleep mode, so the power draw reading can never reflect the true lowest possible values.
You can download Battery Buddy using [Storeman](https://openrepos.net/content/olf/storeman-installer), or directly from [Openrepos](https://openrepos.net/content/direc85/battery-buddy). For support, open a ticket or check out the [Battery Buddy support thread](https://forum.sailfishos.org/t/battery-buddy-support-thread/12580/47) over at Sailfish OS forum!
Keep your battery healthy and help our dying planet, even if it is just for a tiny little bit!