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.

Linux

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.

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.

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

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.5.tar.gz (23.0 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.5-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yafi-0.5.tar.gz
Algorithm Hash digest
SHA256 79c02ca4d2faeaf2bd75c278851e32af6e09a40ceb9c8a24a8db53c823a2d7e7
MD5 c4d24142ac7a17c8772409b61f1c0fc7
BLAKE2b-256 6bbec51a7d57e0207569bbffc4f6cd600c36a6621ce88faf7e6403ffe6aa8cd2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for yafi-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d1773b23740e7e6c4f15134846109d41cd201e829cdf73810fdcfe1b9061c399
MD5 27d4ccbd6706aedc5062ea64cae4c026
BLAKE2b-256 1c5d8875482d9577e7bf600bb911e34937ff7b850f3cfd46016fedabec4e58ad

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