Skip to content
On this page

Scripting and Custom Automation โ€‹

CoolerControl has an extensive REST API that the UI uses to communicate with the Daemon.

Scripts and other programs can also use this API to extend or automate certain flows as the user sees fit. In the future there may be a more official CLI program, but until then there is a basic Python script cc.py to apply basic settings and help users to create their own.

Install โ€‹

Download the script and make it executable:

bash
wget https://gitlab.com/coolercontrol/coolercontrol/-/raw/main/scripts/cc.py?ref_type=heads&inline=false -O cc.py
chmod +x ./cc.py

You need to have the Python3 requests library installed. It might already be installed but if not then there are several ways to do this depending on your distribution.

  1. Install the system package, which is often called: python3-requests
  2. Or install using pip: python3 -m pip install requests

Examples โ€‹

To list all devices, channels, and modes:

bash
./cc.py -l

To apply LCD screen image:

bash
./cc.py -m kraken -c lcd --image /home/user/pictures/images.gif

To apply a Mode:

bash
./cc.py --mode "Gaming"

View the cc.py python documentation for more examples and information.

Released under the GPLv3+ License.