🔌 Plugins (beta)

Plugins extend CoolerControl's functionality by adding support for new devices or integrating with external services.

Below is a list of available plugins.

INFO

If you have developed a plugin that is not listed here, please open an issue to have it added.

CoolerControl Developed Plugins

Custom Devices

The custom-device plugin provides a simple way to define custom shell commands for reading and writing device channels.

---

cctv

cctv is a CLI tool for CoolerControl that enables integration with your own scripts and automation workflows. Registering it as a plugin allows CoolerControl to automatically start and manage it as a service. Create a plugin manifest for it:

sudo mkdir -p /etc/coolercontrol/plugins/cctv/
sudo sh -c "cat > /etc/coolercontrol/plugins/cctv/manifest.toml" <<-EOF
id = "cctv"
type = "integration"
description = "My cctv plugin service for custom Alert handling."
# Replace with your installation path
executable = "/home/your_user/.cargo/bin/cctv"
args = "--daemonize"
envs = "CCTV_CONFIG_FILEPATH=/home/your_username/.config/coolercontrol/cctv.json"
privileged = false
EOF
sudo systemctl restart coolercontrold

---

Connect to Other CoolerControl Daemons

You can connect to CoolerControl daemons running on other machines. The remote daemon must be exposed and accessible over the network, and be running version 3.1.0 or higher. Create a plugin manifest for it and restart your local daemon.

Adjust the my_server name and IP address to match your remote machine:

sudo mkdir -p /etc/coolercontrol/plugins/my_server/
sudo sh -c "cat > /etc/coolercontrol/plugins/my_server/manifest.toml" <<-EOF
id = "my_server"
type = "device"
description = "My CoolerControl server instance."
address = "192.168.1.100:11988"
EOF
sudo systemctl restart coolercontrold

2nd Party (Trusted) Plugins

coolerdash

coolerdash enables you to monitor (display) real-time telemetry data from sensors on an AIO liquid cooler with an integrated LCD display. It extends the LCD functionality of CoolerControl.

3rd Party Plugins (Unverified)

Coming soon.

Plugin Development

For full documentation on creating plugins, including the gRPC API specification, UI integration, and templates:

→ cc-plugins repository