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

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.

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.2.tar.gz (18.9 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.2-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yafi-0.2.tar.gz
Algorithm Hash digest
SHA256 7ccb3c7037f4753fb1c78a93a14cd8cc68b6707b6b582c743d2b5fe0e2673994
MD5 b3b2efc9e5cfcdf055b2c935a2aaab83
BLAKE2b-256 e6870b8006a9f95d8c97b81ee43700c86eb95b10f171b5b8a324adbd08643112

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for yafi-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 eff4fd8e519bf84742aedcedd06f2befd0caeb0cbf79bd797ae94d7cdcf46f4f
MD5 da2cd6a038ab8f4ccf74a3e21bc60498
BLAKE2b-256 1ac205d5fb3e1184c59af1bf916657248b1a5cad9ad50091c5dfacff5e87a9aa

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