mirror of
https://github.com/Steve-Tech/YAFI.git
synced 2026-04-19 16:50:36 +00:00
101 lines
3.6 KiB
Markdown
101 lines
3.6 KiB
Markdown
# Yet Another Framework Interface
|
|
|
|
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`](https://github.com/Steve-Tech/CrOS_EC_Python) library to communicate with the EC.
|
|
|
|
It has support for fan control, temperature monitoring, LED control, and battery limiting.
|
|
|
|
## Installation
|
|
|
|
You can download the latest release from the [Releases page](https://github.com/Steve-Tech/YAFI/releases).
|
|
|
|
There are builds for Flatpak, and PyInstaller for portable execution on Linux or Windows.
|
|
|
|
YAFI is also available on [Flathub](https://flathub.org/en/apps/au.stevetech.yafi): `flatpak install flathub au.stevetech.yafi`.
|
|
|
|
### Linux
|
|
|
|
To allow YAFI to communicate with the EC, you will need to enable user access to the `/dev/cros_ec` device. You can do this by running `echo KERNEL==\"cros_ec\", TAG+=\"uaccess\" | sudo tee /etc/udev/rules.d/60-yafi.rules`, and then reload the rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`.
|
|
|
|
You can also do this by running `curl -Lfs yafi.stevetech.au/udev.sh | sudo sh` which will run the [`add-udev-rules.sh`](add-udev-rules.sh) script.
|
|
|
|
### Windows
|
|
|
|
If your Laptop's BIOS supports Framework's EC driver, there is no need to install any third-party drivers. YAFI should also work without administrator privileges.
|
|
|
|
Otherwise, YAFI supports the [PawnIO](https://pawnio.eu/) driver, and will be automatically used if installed and there is no Framework driver available. YAFI will need to be run as administrator to communicate with the driver.
|
|
|
|
## Building
|
|
|
|
### 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
|
|
|
|
This project requires PyGObject, and the introspection data for GTK4 and Adwaita.
|
|
On Debian/Ubuntu, you can install these with:
|
|
|
|
```bash
|
|
sudo apt install python3-gi gir1.2-gtk-4.0 gir1.2-adw-1
|
|
```
|
|
|
|
#### Install
|
|
|
|
Install the package with `pip install yafi`.
|
|
|
|
Pipx is also supported.
|
|
|
|
### Windows
|
|
|
|
It is possible to run YAFI on Windows using [gvsbuild](https://github.com/wingtk/gvsbuild/) and installing YAFI via pip, but it can be complicated and is therefore not recommended.
|
|
|
|
## Screenshots
|
|
|
|
### Fan Control and Temperature Monitoring
|
|
|
|
|
|
|
|
### LED Control
|
|
|
|
|
|
|
|
### Battery Statistics
|
|
|
|
|
|
|
|
### Battery Limiting
|
|
|
|
|
|
|
|
#### Battery Extender
|
|
|
|
|
|
|
|
### Hardware Info
|
|
|
|
|
|
|
|
## Troubleshooting
|
|
|
|
### `[Errno 13] Permission denied: '/dev/cros_ec'`
|
|
|
|
This error occurs when the udev rules are not installed or not working. Make sure you have installed the udev rules as described in the [Linux Installation](#linux) section.
|
|
|
|
### `Could not auto detect device, check you have the required permissions, or specify manually.`
|
|
|
|
This error occurs when `/dev/cros_ec` is not found, and the `CrOS_EC_Python` library also cannot talk over LPC.
|
|
You can either update your kernel to have a working `cros_ec_dev` driver, or run YAFI as root.
|
|
|
|
It can also occur if you do not have a CrOS EC, like on non Framework laptops.
|
|
|
|
## Disclaimer
|
|
|
|
YAFI is not affiliated with Framework Computer Inc. in any way.
|
|
|
|
YAFI is licensed under the [GPL-2.0-or-later license](COPYING), and comes with no warranty or guarantee of any kind. Use at your own risk.
|