Skip to content

Steve-Tech/YAFI

Repository files navigation

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

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.

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

Pipx is also supported.

Windows

It is possible to run YAFI on Windows using gvsbuild and installing YAFI via pip. You will also need to copy WinRing0x64.dll and WinRing0x64.sys to either the same directory as python.exe, or to C:\Windows\System32.

Screenshots

Fan Control and Temperature Monitoring

Thermals Page

LED Control

LEDs Page

Battery Limiting

Battery 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 copied the 60-cros_ec_python.rules file to /etc/udev/rules.d/ and reloaded the rules with sudo udevadm control --reload-rules && sudo udevadm trigger.

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.