| LIQUIDCTL(8) | System Manager's Manual | LIQUIDCTL(8) |
liquidctl - monitor and control liquid coolers and other devices
liquidctl |
[options] list |
liquidctl |
[options] initialize [all] |
liquidctl |
[options] status |
liquidctl |
[options] set channel speed (temperature percentage) ... |
liquidctl |
[options] set channel speed percentage |
liquidctl |
[options] set channel color mode [color ...] |
liquidctl |
--version |
liquidctl |
--help |
liquidctl is a utility for overseeing and controlling some hardware monitoring devices not yet supported at the kernel level. Because liquidctl directly accesses the hardware devices, root privileges are generally required, though this can be avoided with appropriate udev rules.
liquidctl list outputs all compatible devices found on the system. In case more than one device is found, the desired one can be selected for later invocations with --match=substring, where substring matches part of the desired device's description using a case insensitive comparison.
liquidctl list --verbose enables the display of additional identifiers and addresses that can also be used to select specific devices. These can be better suited for certain use cases, such as non-interactive scripts.
liquidctl initialize prepares a device for later commands, and most devices must be initialized after every boot or when resuming from a suspended state. Unless finer control is required, all devices can be initialized at once with liquidctl initialize all. Some devices may output some information at this stage.
liquidctl status displays the status of all devices that match the provided filtering options.
liquidctl set channel speed allows the user to set fan and pump speeds. These, depending on the device, can be set to fixed duty values, variable temperature\[u2013]duty curves, or both.
liquidctl set channel color allows the user to configure and set lighting modes. Supported lighting modes and additional options vary by device and are listed in later sections of this manual. Each color can be specified as:
liquidctl set channel screen allows the user to configure the LCD screen integrated into some AIO models.
liquidctl automatically detects when a kernel driver is bound to the device and, whenever possible, uses it instead of directly accessing the device. Alternatively, direct access to the device can be forced with --direct-access.
Devices can be selected using one or more values taken from list --verbose.
Some devices and animation modes support additional options.
1 if there was an error, 0 otherwise.
If LANG is set to C, non-ASCII characters are escaped from the output of --json.
liquidctl |
list --verbose |
liquidctl |
initialize all |
liquidctl |
--match kraken set pump speed 90 |
liquidctl |
--product 170e set led color fading 350017 ff2608 |
liquidctl |
status |
Cooling channels: (D5 Next): fan, pump; (Octo): fan[1-8]; (Quadro:) fan[1-4]; (Farbwerk 360:) not applicable.
Lighting channels: not yet supported.
Cooling channels: fans, fan[1-6]; (only non-XT/Elite Capellix:) pump.
Lighting channels: not yet supported.
Cooling channels (only Commander Pro and Obsidian 1000D): sync, fan[1-6].
Where the fan connection types can be set with --fan-mode=channel:mode[,...], where the allowed modes are: off, dc, pwm.
Lighting channels: (only Lighting Node Core:) led; (only Commander Pro and Lighting Node Pro:) sync, led[1-2].
| Mode | #colors |
| clear | 0 |
| off | 0 |
| fixed | 1 |
| color_shift | 2 |
| color_pulse | 2 |
| color_wave | 2 |
| visor | 2 |
| blink | 2 |
| marquee | 1 |
| sequential | 1 |
| rainbow | 0 |
| rainbow2 | 0 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: fast, medium, slow.
The animation direction can be set with --direction=value, where the allowed values are: forward or backward. --start-led=number, the first LED that the lighting effect should be for. --start-led=number, the first LED that the lighting effect should be for. --maximum-led=number, the number of LEDs that the lighting effect should applied to. --temperature-sensor=number, The temperature sensor that should be used to control the fan curves, probe 1 by default.
Cooling channels: pump, fan.
Lighting channels: logo.
| Mode | #colors | notes |
| rainbow | 0 | only available on EVGA coolers |
| fading | 2 | |
| blinking | 1 | |
| fixed | 1 | |
| blackout | 0 | no high-temperature alerts |
The rainbow mode speed can be configured with --speed=[1–6]. The speed of the other modes is instead customized with --time-per-color (fading and blinking) and --time-off (blinking only).
All modes except blackout support a visual high-temperature alert configured with --alert-threshold and --alert-color.
All current settings can be saved on non-volatile on-board memory by passing --non-volatile to any write command. However, since write-cycles are limited, this option should be used sparingly.
Cooling channels: fan, fan[1–2]; (only H150i Pro:) fan3.
Pump mode (initialize --pump-mode mode): quiet, balanced (default), performance.
Lighting channel: logo.
| Mode | #colors |
| alert | 3 |
| shift | 2–4 |
| pulse | 1–4 |
| blinking | 1–4 |
| fixed | 1 |
Cooling channels: fan, fan[1–2]; (only H150i Pro XT:) fan3.
Pump mode (initialize --pump-mode mode): quiet, balanced (default), extreme.
Lighting channels: sync, led.
| Channel | Mode | #colors (Platinum) | #colors (Pro XT) | #colors (Platinum SE) |
| led | off | 0 | 0 | 0 |
| led | fixed | 1 | 1 | 1 |
| led | super-fixed | 24 | 16 | 48 |
Supports the same modes and options as a Corsair Hydro H80i GT (or similar), but requires --legacy-690lc to be passed on all invocations.
Cooling channels (only X42, X52, X62, X72): pump, fan.
Lighting channels: logo, ring, sync.
| Mode | logo | ring | #colors |
| off | yes | yes | 0 |
| fixed | yes | yes | 1 |
| super-fixed | yes | yes | 1–9 |
| fading | yes | yes | 2–8 |
| alternating | no | yes | 2 |
| breathing | yes | yes | 1–8 |
| super-breathing | yes | yes | 1–9 |
| pulse | yes | yes | 1–8 |
| tai-chi | no | yes | 2 |
| water-cooler | no | yes | 0 |
| loading | no | yes | 1 |
| wings | no | yes | 1 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with --direction=value, where the allowed values are: forward or backward.
Cooling channels: pump; (only Z53, Z63, Z73:) fan.
Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
LCD screens (only Z53, Z63, Z73): lcd.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| fading | 2–8 |
| super-fixed | 1–40 |
| alternating-[3-6] | 1–2 |
| pulse | 1–8 |
| breathing | 1–8 |
| super-breathing | 1–40 |
| candle | 1 |
| starry-night | 1 |
| loading | 1 |
| tai-chi | 1–2 |
| water-cooler | 2 |
| wings | 1 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with --direction=value, where the allowed values are: forward or backward.
Cooling channels: fan.
Lighting channels: none.
Setting a fixed fan speed changes the fan mode to software control. To revert back to hardware control, run initialize again.
(Experimental feature) The +12V rails normally function in multiple-rail mode. Single-rail mode can be selected by passing --single-12v-ocp to initialize. To revert back to multiple-rail mode, run initialize again without that flag.
Cooling channels: none (feature not supported yet).
Lighting channels: none.
Cooling channels: fan[1–6], sync.
Lighting channels: none.
Cooling channels: fan[1–3], sync.
Lighting channels: led.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| super-fixed | 1–40 |
| fading | 2–8 |
| alternating | 2 |
| breathing | 1–8 |
| super-breathing | 1–40 |
| pulse | 1–8 |
| candle | 1 |
| wings | 1 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with --direction=value, where the allowed values are: forward or backward.
Cooling channels (only Smart Device V2, RGB & Fan Controller and H1 V2): fan[1–3].
Lighting channels (all but H1 V2): led[1–2], sync.
Additional lighting channels (HUE 2): led[3–4].
Additional lighting channels (RGB & Fan Controller (3+6 channels)): led[3–6].
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| super-fixed | 1–40 |
| fading | 2–8 |
| alternating-[3-6] | 2 |
| pulse | 1–8 |
| breathing | 1–8 |
| super-breathing | 1–40 |
| candle | 1 |
| starry-night | 1 |
| wings | 1 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with --direction=value, where the allowed values are: forward or backward.
Cooling channels: none.
Lighting channels: led.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| flash | 1 |
| breathing | 1 |
| rainbow | 0 |
Cooling channels: none.
Lighting channels: led.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| breathing | 1–7 |
| fading | 2–7 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest.
Cooling channels: none.
Lighting channels: led[1–4], sync.
| Mode | #colors |
| off | 0 |
| static | 1 |
| breathing | 1 |
| flashing | 1 |
| spectrum_cycle | 0 |
| rainbow | 0 |
| spectrum_cycle_breathing | 0 |
| chase_fade | 1 |
| spectrum_cycle_chase_fade | 0 |
| chase | 1 |
| spectrum_cycle_chase | 0 |
| spectrum_cycle_wave | 0 |
| chase_rainbow_pulse | 0 |
| rainbow_flicker | 0 |
| gentle_transition | 0 |
| wave_propagation | 0 |
| wave_propagation_pause | 0 |
| red_pulse | 0 |
Cooling channels: none.
Lighting channels: led[1–8], sync.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| pulse | 1 |
| (double-)?flash | 1 |
| color-cycle | 0 |
When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slower, normal, faster, fastest, ludicrous.
Cooling channels: none.
Lighting channels: led.
| Mode | #colors |
| off | 0 |
| fixed | 1 |
| breathing | 1 |
| rainbow | 0 |
The complete documentation is available in the project's sources and homepage.
| 2023-01-08 | liquidctl |