Skip to content

This is mirror of the official repository on GitLab. Please go there for reporting issues and requesting new features.

License

Notifications You must be signed in to change notification settings

codifryed/coolercontrol

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CoolerControl
CoolerControl



CoolerControl is a feature-rich cooling device control and monitoring application for Linux.


✨ Features

  • A highly configurable control GUI with dashboards
  • A system daemon that runs in the background
  • Control any device based on any temperature or combination of temperatures
  • Auto detection of hwmon/sysfs and liquidctl devices
  • Enhanced liquidctl device support (AIOs, USB Fan hubs, LCD screens, RGB lighting, etc)
  • Fan control support for most NVidia and AMD GPUs
  • Fully customizable speed Profiles like Fixed, Graph(Curve), and Mix that can be applied to multiple fans
  • Functions to control how a Profile is applied with hysteresis, threshold, directional, and response time control
  • System-wide cooling Modes to adjust all your devices at once
  • Create your own Custom Sensors based on a File or on a combination of temperature sensors
  • Multiple Dashboards with filters to view your system's sensor data
  • Alerts to notify you of unexpected changes to temperatures or fans
  • Re-applies settings after waking from sleep
  • External monitoring and GUI support
  • Headless server support with an available Web UI
  • Comprehensive REST API for extensions

📦 Packages

CoolerControl is made up of several sub-packages:

  1. coolercontrold (required) - The system service that handles controlling your hardware.
  2. coolercontrol-liqctld (optional) - Service integration for liquidctl device support (AIOs, USB fan hubs, etc.).
  3. coolercontrol (optional) - the standalone Desktop Application. (alternatively you can access the Web UI in your browser)

*Note: You can control the daemon using its config file, but that is not officially supported.

🧰 Hardware Support

CoolerControl depends on Hwmon kernel drivers and liquidctl to access and control supported hardware. Note that your hardware is not guaranteed to be supported, as this depends on open-source drivers and contributors. The following are the steps you should take to maximize hardware coverage:

  • Install lm-sensors and run sudo sensors-detect. For more details see the Arch Wiki. Additionally, you can check out the official lm-sensors repository for tips on manually loading unofficial kernel modules for hardware that isn't supported out-of-the-box yet.
  • For newer motherboards and cards, it's best to install the latest available kernel for your distribution which includes the latest Hwmon drivers and kernel modules.
  • Check the liquidctl hardware support list for the state of support for USB devices like fan hubs and AIOs.
  • Nvidia GPUs - Fan control has been tested working on most cards with the Nvidia proprietary drivers. CoolerControl automatically uses NVML and the CLI tools nvidia-settings and nvidia-smi as a fallback.
  • AMD GPUs
    • Older cards: <=6000 series work out of the box.
    • Newer cards: 7000, 9000 series and above have different firmwares that require an extra step to enable fan control:
      • Linux kernel >=6.12 is required for fan control on these newer cards.
      • You can enable all features including fan control by setting the following kernel boot option: amdgpu.ppfeaturemask=0xffffffff.
      • ⚠️ Depending on your installed kernel version and specific model of your card, be aware that sometimes there is a minimum temperature limit at which the fans will spin up.
      • See the CoolerControl AMDGPU Docs page for more detailed info.
  • Laptops - ThinkPads, some ASUS, and some HP Laptops are known to have supported linux drivers, but not all. If your laptop has a hwmon kernel driver, then CoolerControl will use it automatically. Otherwise, fan control for your laptop is most likely not supported.
  • In general, CoolerControl will detect supported devices and available capabilities automatically. If needed, the GUI will also prompt you for any additional steps. There are some situations where the kernel drivers are not yet mature enough to offer full fan control functionality, in which case you will get an error when attempting to apply changes.

❔ Problem or Question

If you are experiencing an issue or have a feature request, please open up an issue in GitLab and use one of the provided templates. When submitting a bug daemon logs are invaluable to determining the cause. If you have a general question, please join the Discord channel where community members can also help.

🚀 Contributing

❤️ CoolerControl is in need of help with the following areas:

  • Packaging
  • Website
  • Spreading the word

If you have an idea or want to submit some changes, it's usually best to either submit an Issue first or get on Discord to discuss it. For general information, please read the contributing guidelines.

⭐ Acknowledgements

  • Major thanks is owed to the python API of liquidctl
  • Thanks to all the many contributors of HWMon
  • A big inspiration is GKraken written by Roberto Leinardi.

📝 License

This program is licensed under GPLv3+

🗒️ Related Projects

  • liquidctl
    Cross-platform tool and drivers for liquid coolers and other devices.

  • fan2go
    A daemon to control the fans of your computer.

  • thinkfan
    A simple, lightweight fan control program. (ThinkPads)

  • OpenRGB
    Graphical interface to control many different types of RGB devices.

  • FanControl
    A focused and highly customizable fan controlling software for Windows.

About

This is mirror of the official repository on GitLab. Please go there for reporting issues and requesting new features.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published