Skip to main content

Yet Another Framework Interface

Project description

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 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.

There are builds for Flatpak, and PyInstaller for portable execution on Linux or Windows.

YAFI is also available on Flathub: 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 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 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.

Currently the PawnIO driver does not support Framework 13 mainboards with 11th, 12th, or 13th Gen Intel CPUs.

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:

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 and installing YAFI via pip, but it can be complicated and is therefore not recommended.

Screenshots

Fan Control and Temperature Monitoring

Thermals Page

LED Control

LEDs Page

Battery Statistics

Battery Page

Battery Limiting

Battery Limiter Page

Battery Extender

Battery Extender

Hardware Info

Hardware Page

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 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, and comes with no warranty or guarantee of any kind. Use at your own risk.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yafi-0.7.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yafi-0.7-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file yafi-0.7.tar.gz.

File metadata

  • Download URL: yafi-0.7.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for yafi-0.7.tar.gz
Algorithm Hash digest
SHA256 c9cfeb7c3974adf403cb742c55ea6d9c6dc1ae9498f95ee28ed175a2441a66bc
MD5 d3d78163378a6a310099ef2d94c69d8a
BLAKE2b-256 e6bc68ce43148bc033ca7ab917dda4a3582a33188c85b5c51c2d3e033c3cbb8f

See more details on using hashes here.

File details

Details for the file yafi-0.7-py3-none-any.whl.

File metadata

  • Download URL: yafi-0.7-py3-none-any.whl
  • Upload date:
  • Size: 30.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for yafi-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 df14059a1d6e87bf56ff7ec1fcfe640bc747bd6b897769a1e03ccd7987c35b22
MD5 1f90a7e851792c21a1c28452faec6630
BLAKE2b-256 6980185cc12986bb1896c1e8d631dec9b3ce7d98506129729d3bea9863433e00

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page