ghelper for linux — Simplifying battery management for…

Pitch

Description

Comments

About this project

ghelper-for-linux is a terminal UI alternative to GHelper tailored for ASUS ROG and TUF laptops running Linux. With features like battery charge limits, live stats, and persistent configurations, it ensures optimal battery health while providing detailed system insights, all without a graphical interface.

ghelper-for-linux provides a terminal user interface (TUI) alternative to the popular GHelper tool for ASUS ROG and TUF laptops running Linux distributions such as Pop!_OS, Ubuntu, and Arch. This project is designed to enhance the management of battery performance while providing essential system metrics directly within a terminal, ensuring an efficient user experience tailored for Linux.

Key Features

Battery Charge Cap: Set a charge limit between 20% and 100% to maximize battery lifespan and health. This feature is vital for maintaining battery performance over time, preventing unnecessary wear from constant full charges.
Persistent Limits: Automatically maintain your selected charge limit across reboots through a combination of systemd services and udev rules, ensuring user preferences stay intact without repeated configuration.
Live System Statistics: Access real-time metrics such as current voltage, power draw, time to full or empty, cycle count, and health percentage of the battery, allowing users to monitor battery status effectively.
Comprehensive System Info: View CPU and GPU temperatures along with memory usage and thermal zone information, providing a holistic view of laptop performance.
Keyboard-Navigable: Fully operable through keyboard commands, facilitating fast navigation without the need for a mouse.
Lightweight Design: A compact static binary of approximately 800 KB that operates seamlessly without the need for a graphical desktop environment.

Requirements

Compatible with various Linux distributions including Pop!_OS, Ubuntu 22.04+, Arch, and Fedora.
Designed specifically for ASUS ROG, TUF, or VivoBook laptops with the necessary kernel module (asus-nb-wmi) loaded.
Requires Linux kernel version 5.4 or later for optimal functionality.

Usage

Once installed, ghelper-for-linux can be launched via the terminal. Users can customize the charge limit using keyboard shortcuts, access detailed battery and system information, and effortlessly manage settings right from the command line.

Example Commands

To start using ghelper, simply enter:

ghelper        # If installed globally
ghelper-linux  # If installed via Cargo

Keybindings Overview

Key	Action
`Tab`	Focus sidebar or content
`j` / `k` or `↑` / `↓`	Navigate the sidebar
`↵` or `→`	Enter options from sidebar
`Esc`	Return to sidebar
`←` / `→`	Adjust charge limit in battery tab
`Shift+←` / `Shift+→`	Adjust limit by ±5%
`1` / `2` / `3`	Apply preset limits (60% / 80% / 100%)
`a` or `↵`	Confirm charge limit change
`s`	Setup persistence for limits
`r`	Refresh the display
`q`	Exit the application

The mechanism behind the battery charge limiting utilizes the Linux kernel's sysfs interface, leveraging the capabilities built into ASUS hardware for effective battery management.

With several features on the roadmap, including fan curve control and performance mode switching, ghelper-for-linux aims to provide robust tools for enhancing user experience on ASUS laptops. Contributing to this project is encouraged, with open invitations for PRs and suggestions for additional functionalities.