Adding Device Support โ
Support for new devices requires help from the community. CoolerControl is essentially a frontend for various "backend" libraries. This means CoolerControl does not interact with the devices directly, but through the API of other systems or libraries. The two currently supported backends are liquidctl and hwmon. Adding support for more devices generally means being supported in one of these backends first. These are the steps to take to add support for your device in CoolerControl:
Is your device supported by liquidctl?
- Go here and see if your device is listed.
- Yes -> make a feature request for CoolerControl to add support for that device.
- No -> continue
- Go here and see if your device is listed.
Is your device supported by hwmon?
- Check here to see if you can find your device and/or follow the hwmon support guide to see if you see your device is listed in the
sensor
command output.- Yes -> you should see the supported controls once you've enabled HWMon support. If your device doesn't work as expected make a feature request to add or fix support for it.
- No -> continue
- Check here to see if you can find your device and/or follow the hwmon support guide to see if you see your device is listed in the
Not supported by the above? There are still some options:
- See if another library does support communicating with the device and make a feature request to have CoolerControl integrate support for it.
- Support development of a driver for the device by contributing: see liquidctl docs or the lm-sensors repo.
Once support has been added:
- please report any bugs you notice using the device, real world device testing and feedback is invaluable.