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.

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.1.tar.gz (21.1 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.1-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for yafi-0.1.tar.gz
Algorithm Hash digest
SHA256 9e0d637ee2ee61f04f0b6d572771067dc9f2846d39fe27f3a3b5fd73fb01b35f
MD5 dd43223667a7f7e24d4ca4e87800ce4b
BLAKE2b-256 01c387c0c0501837fcb2635b68bb595ae44660002521270bfd80f5298113096f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yafi-0.1-py3-none-any.whl
  • Upload date:
  • Size: 27.7 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 34063be781b5c005c2a50728d2408b2cc937d7f9747d217c6166196f390025f2
MD5 96efce2ce51772b101b9115dfd60ecde
BLAKE2b-256 ad06c11c9aa6d48471ef1f6ecbe942e86c5b232759ce49d5a1151d183e1e7adf

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