GithubHelp home page GithubHelp logo

codesteller86 / asusctl Goto Github PK

View Code? Open in Web Editor NEW

This project forked from flukejones/asusctl

0.0 0.0 0.0 13.19 MB

Daemon and tools to control your ASUS ROG laptop. Supersedes rog-core.

Home Page: https://asus-linux.org/

License: Mozilla Public License 2.0

Shell 0.07% Rust 99.10% Makefile 0.83%

asusctl's Introduction

asusctl for ASUS ROG

- Asus Linux Website

WARNING: Many features are developed in tandem with kernel patches. If you see a feature is missing you either need a patched kernel, or v6.1 which has all my work merged upstream.

asusd is a utility for Linux to control many aspects of various ASUS laptops but can also be used with non-asus laptops with reduced features.

Now includes a GUI, rog-control-center.

Kernel support

The minimum supported kernel version is 5.17

For TUF laptops, the minimum supported kernel version is 6.1

Goals

  1. To provide an interface for rootless control of some system functions most users wish to control such as fan speeds, keyboard LEDs, graphics modes.
  2. Enable third-party apps to use the above with dbus methods
  3. To make the above as easy as possible for new users
  4. Respect the users resources: be small, light, and fast

Point 3 means that the list of supported distros is very narrow - fedora is explicitly supported. All other distros are not supported (while asusd might still run fine on them). For best support use fedora 36+ Workstation.

Point 4? asusd currently uses a tiny fraction of cpu time, and less than 1Mb of ram, the way a system-level daemon should.

Discord

Discord server link

SUPPORTED LAPTOPS

Most ASUS gaming laptops that have a USB keyboard. If lsusb shows something similar to this:

Bus 001 Device 002: ID 0b05:1866 ASUSTek Computer, Inc. N-KEY Device

then it may work without tweaks. Technically all other functions except the LED and AniMe parts should work regardless of your latop make.

Implemented

  • System daemon
  • GUI app
  • User notifications daemon
  • Setting/modifying built-in LED modes
  • Per-key LED setting
  • Fancy LED modes (See examples) (currently being reworked)
  • Saving settings for reload
  • AniMatrix display on G14 models that include it
  • Set battery charge limit (with kernel supporting this)
  • Fan curve control on supported laptops (G14/G15, some TUF like FA507)
  • Toggle bios setting for boot/POST sound
  • Toggle GPU MUX (g-sync, or called MUX on 2022+ laptops)

GUI

A gui is now in the repo - ROG Control Center. At this time it is still a WIP, but it has almost all features in place already.

BUILDING

Requirements are rust >= 1.57 installed from rustup.io if the distro provided version is too old, and make.

Ubuntu (unsuported):

apt install libgtk-3-dev libpango1.0-dev libgdk-pixbuf-2.0-dev libglib2.0-dev cmake libclang-dev libudev-dev libayatana-appindicator3-1
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
make
sudo make install

popos (unsuported):

sudo apt install cmake libclang-dev libudev-dev libgtk-3-dev libclang-dev libglib2.0-dev libatkmm-1.6-dev libpangomm-1.4-dev librust-gdk-pixbuf-dev
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
make
sudo make install

fedora:

dnf install cmake clang-devel systemd-devel glib2-devel cairo-devel atkmm-devel pangomm-devel gdk-pixbuf2-devel gtk3-devel libappindicator-gtk3
make
sudo make install

openSUSE:

Works with KDE Plasma (without GTK packages)

zypper in -t pattern devel_basis
zypper in rustup make cmake systemd-devel clang-devel llvm-devel gdk-pixbuf-devel cairo-devel pango-devel freetype-devel gtk3-devel libexpat-devel libayatana-indicator3-7
make
sudo make install

Installing

=======

The default init method is to use the udev rule, this ensures that the service is started when the device is initialised and ready.

If you are upgrading from a previous installed version, you will need to restart the service or reboot.

$ systemctl daemon-reload && systemctl restart asusd

You may also need to activate the service for debian install. If running Pop!_OS, I suggest disabling system76-power gnome-shell extension and systemd service.

Uninstalling

Run sudo make uninstall in the source repo, and remove /etc/asusd/.

Contributing

See CONTRIBUTING.md. Additionally, also do cargo clean and cargo test on first checkout to ensure the commit hooks are used (via cargo-husky).

OTHER

Supporting more laptops

Please file a support request.

License & Trademarks

Mozilla Public License 2 (MPL-2.0)


ASUS and ROG Trademark is either a US registered trademark or trademark of ASUSTeK Computer Inc. in the United States and/or other countries.

Reference to any ASUS products, services, processes, or other information and/or use of ASUS Trademarks does not constitute or imply endorsement, sponsorship, or recommendation thereof by ASUS.

The use of ROG and ASUS trademarks within this website and associated tools and libraries is only to provide a recognisable identifier to users to enable them to associate that these tools will work with ASUS ROG laptops.


asusctl's People

Contributors

flukejones avatar aspann avatar mpiffault avatar asere avatar meumeu avatar pshem avatar alenpaulvarghese avatar herohtar avatar i-al-istannen avatar aqez avatar dragonnn avatar sonnyp avatar lordvicky avatar josephferano avatar kostard avatar papaj0e avatar pokkos avatar rushingalien avatar eigengravy avatar shoenig avatar necessary129 avatar tuxfanou avatar usersv4 avatar yarn avatar sad-soul-eater avatar mclang avatar saswatasarkar13 avatar jhyub avatar e1himself avatar herrwinfried avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.