Scroll to navigation

LIQUIDCTL(8) System Manager's Manual LIQUIDCTL(8)

NAME

liquidctl - monitor and control liquid coolers and other devices

SYNOPSIS

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

DESCRIPTION

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:

  • hexadecimal RGB with or without prefix '0x': ff7f3f;
  • decimal RGB triple, R,G,B ∊ [0, 255]: rgb(255,127,63);
  • hue-saturation-value HSV triple, H ∊ [0, 360], S,V ∊ [0, 100]: hsv(20,75,100);
  • hue-saturation-lightness HSL triple, H ∊ [0, 360], S,L ∊ [0, 100]: hsl(20,100,62).

OPTIONS

Device selection options

Devices can be selected using one or more values taken from list --verbose.

Filter devices by case insensitive substring of device description.
Pick among many results for a given filter.
Filter devices by hexadecimal vendor id.
Filter devices by hexadecimal product id.
Filter devices by hexadecimal release number.
Filter devices by serial number.
Filter devices by bus.
Filter devices by address in bus.
Filter devices by USB port in bus.
Select device by listing ID.

Animation options

Some devices and animation modes support additional options.

Abstract animation speed (device/mode specific).
Time to wait on each color (seconds).
Time to wait with the LED turned off (seconds).
Threshold temperature for a visual alert (degrees Celsius).
Color used by the visual high temperature alert.
If the pattern should move forward or backwards. [default: forward].
The first led to start the effect at.
The number of LED's the effect should apply to.

Other options

Enable single rail +12V OCP.
Set the pump mode.
The temperature sensor number for the Commander Pro.
Use Asetek 690LC in legacy mode (old Krakens).
Store on non-volatile controller memory.
Comman-separated bleeding-edge features to enable.
Output additional information.
Show debug information on stderr.
Display the version number.
Show the embedded help.

EXIT STATUS

1 if there was an error, 0 otherwise.

FILES

$XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*, /tmp/liquidctl/*
Internal data used by some drivers.

EXAMPLE

liquidctl list --verbose
liquidctl initialize all
liquidctl --match kraken set pump speed 90
liquidctl --product 170e set led color fading 350017 ff2608
liquidctl status

DEVICE SPECIFICS

Corsair Commander Pro

Corsair Lighting Node Pro

Cooling channels: sync, fan[1-5]. (Commander Pro only)

Lighting channels: led1, led2.

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.

Corsair H80i GT, H100i GTX, H110i GTX

Corsair H80i v2, H100i v2, H115i

EVGA CLC 120 (CL12), 240, 280, 360

Cooling channels: pump, fan.

Lighting channels: logo.

Mode #colors notes
rainbow 0 only availble 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.

Corsair H100i Platinum, H100i Platinum SE, H115i Platinum

Corsair H100i Pro XT, H115i Pro XT

Fan channels: fan, fan[1–2].

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

NZXT Kraken X40, X60

NZXT Kraken X31, X41, X61

Supports the same modes and options as a Corsair H80i GT (or similar), but requires --legacy-690lc to be passed on all invocations.

NZXT Kraken M22

NZXT Kraken X42, X52, X62, X72

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.

NZXT Kraken X53, X63, X73

NZXT Kraken Z63, Z73

Cooling channels: pump; (only Z63, Z73:) fan.

Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.

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.

Corsair HX750i, HX850i, HX1000i, HX1200i

Corsair RM650i, RM750i, RM850i, RM1000i

Fan 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.

NZXT E500, E650, E850

Fan channels: none (feature not supported yet).

Lighting channels: none.

NZXT Grid+ V3

Fan channels: fan[1–6], sync.

Lighting channels: none.

NZXT Smart Device (V1)

Fan 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.

NZXT Smart Device V2

NZXT RGB & Fan Controller

NZXT HUE 2

NZXT HUE 2 Ambient

Fan channels (only Smart Device V2 and RGB & Fan Controller): fan[1–3].

Lighting channels: led[1–2], sync.

Additional lighting channels (only HUE 2): led[3–4].

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.

ASUS Strix RTX 2080 Ti OC

Fan channels: none.

Lighting channels: led.

Mode #colors
off 0
fixed 1
flash 1
breathing 1
rainbow 0

Corsair Vengeance RGB

Fan 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.

Gigabyte RGB Fusion 2.0 5702 Controller

Gigabyte RGB Fusion 2.0 8297 Controller

Fan 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.

EVGA GTX 1080 FTW

Fan channels: none.

Lighting channels: led.

Mode #colors
off 0
fixed 1
breathing 1
rainbow 0

SEE ALSO

The complete documentation is available in the project's sources and homepage.

2021-01-25 liquidctl