pyro/YAFI
1
0
Fork 0
mirror of https://github.com/Steve-Tech/YAFI.git synced 2026-04-19 16:50:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for pip again

Browse Source
This commit is contained in:
Stephen Horvath
2025-03-20 16:16:43 +10:00
parent 35e325b133
commit 754fbd868b
10 changed files with 57 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -3,7 +3,40 @@
YAFI is another GUI for the Framework Laptop Embedded Controller.
It is written in Python with a GTK4 Adwaita theme, and uses the `CrOS_EC_Python` library to communicate with the EC.
## Features
It has support for fan control, temperature monitoring, LED control, and battery limiting.
## Installation
### udev Rules (MUST READ)
To allow YAFI to communicate with the EC, you need to copy the [`60-cros_ec_python.rules`](https://github.com/Steve-Tech/YAFI/blob/main/60-cros_ec_python.rules) file to `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`.
### Flatpak
Build and install the Flatpak package with `flatpak-builder --install --user build au.stevetech.yafi.json`.
You can also create a flatpak bundle with `flatpak-builder --repo=repo build au.stevetech.yafi.json` and install it with `flatpak install --user repo au.stevetech.yafi.flatpak`.
### Pip
#### System Dependencies
The following system dependencies are required for `PyGObject`:
- `python3-dev`
- `libcairo2-dev`
- `libgirepository-2.0-dev`
- `gir1.2-adw-1`
There's probably more, but I happened to have them installed.
#### Install
Install the package with `pip install git+https://github.com/Steve-Tech/YAFI.git`.
Pipx is also supported.
## Screenshots
### Fan Control and Temperature Monitoring
@@ -24,15 +57,3 @@ It is written in Python with a GTK4 Adwaita theme, and uses the `CrOS_EC_Python`
### Hardware Info
![Hardware Page](docs/4-hardware.png)
## Installation
### udev Rules (MUST READ)
To allow YAFI to communicate with the EC, you need to copy the `60-cros_ec_python.rules` file to `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`.
### Flatpak
Build and install the Flatpak package with `flatpak-builder --install --user build au.stevetech.yafi.json`.
You can also create a flatpak bundle with `flatpak-builder --repo=repo build au.stevetech.yafi.json` and install it with `flatpak install --user repo au.stevetech.yafi.flatpak`.