liquidctl man page

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.  Most devices must be initialized after every boot.  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–duty curves, or both.

liquidctl set channel color allows the user to configure and set lighting modes.  Each color is specified in hexadecimal RGB, without prefixes (e.g. ff2608).  Supported modes and additional options vary by device and are listed in later sections of this manual.

Options

Device selection options

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

-m substring--match=substring

Filter devices by case insensitive substring of device description.

-n number--pick=number

Pick among many results for a given filter.

--vendor=id

Filter devices by vendor id.

--product=id

Filter devices by product id.

--release=number

Filter devices by release number.

--serial=number

Filter devices by serial number.

--bus=bus

Filter devices by bus.

--address=address

Filter devices by address in bus.

--usb-port=port

Filter devices by USB port in bus.

-d id--device=id

Select device by listing ID.

Animation options

Some devices and animation modes support additional options.

--speed=value

Abstract animation speed (device/mode specific).

--time-per-color=value

Time to wait on each color (seconds).

--time-off=value

Time to wait with the LED turned off (seconds).

--alert-threshold=number

Threshold temperature for a visual alert (degrees Celsius).

--alert-color=color

Color used by the visual high temperature alert.

Other options

-v, --verbose

Output additional information.

-g, --debug

Show debug information on stderr.

--hid=module

Override API for USB HIDs: usb, hid or hidraw.

--legacy-690lc

Use Asetek 690LC in legacy mode (old Krakens).

--single-12v-ocp

Enable single rail +12V OCP.

--version

Display the version number.

--help

Show the embedded help.

Exit Status

1 if there was an error, 0 otherwise.

Files

$XDG_RUNTIME_DIR/liquidctl/*/var/run/liquidctl/*

Internal data used by some drivers.

Example

liquidctllist --verbose
liquidctlinitialize all
liquidctl--match kraken set pump speed 90
liquidctl--product 0x170e set led color fading 350017 ff2608
liquidctlstatus

Device Specifics

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#colorsnotes
rainbow0only availble on EVGA coolers
fading2
blinking1
fixed1
blackout0no 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.

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.

Modelogoring#colors
offyesyes0
fixedyesyes1
super-fixedyesyes1–9
fadingyesyes2–8
(backwards-)?spectrum-waveyesyes0
(backwards-)?super-wavenoyes1–8
(backwards-)?marquee-[3-6]noyes1
covering-(backwards-)?marqueenoyes1–8
alternatingnoyes2
(backwards-)?moving-alternatingnoyes2
breathingyesyes1–8
super-breathingyesyes1–9
pulseyesyes1–8
tai-chinoyes2
water-coolernoyes0
loadingnoyes1
wingsnoyes1

When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slow, normal, fast, fastest.

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

Lighting channels: none.

NZXT Smart Device (V1)

Fan channels: fan[1–3].

Lighting channels: led.

Mode#colors
off0
fixed1
super-fixed1–40
fading2–8
(backwards-)?spectrum-wave0
(backwards-)?super-wave1–40
(backwards-)?marquee-[3-6]1
covering-(backwards-)?marquee1–8
alternating2
(backwards-)?moving-alternating2
breathing1–8
super-breathing1–40
pulse1–8
candle1
wings1

When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slow, normal, fast, fastest.

NZXT Hue 2

NZXT HUE 2 Ambient

NZXT Smart Device V2

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

Lighting channels: led[1–2].

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

Mode#colors
off0
fixed1
super-fixed1–40
fading2–8
(backwards-)?spectrum-wave0
(backwards-)?marquee-[3-6]1
covering-(backwards-)?marquee1–8
alternating-[3-6]2
(backwards-)?moving-alternating-[3-6]2
pulse1–8
breathing1–8
super-breathing1–40
candle1
starry-night1
(backwards-)?rainbow-flow0
(backwards-)?super-rainbow0
(backwards-)?rainbow-pulse0
wings1

When applicable the animation speed can be set with --speed=value, where the allowed values are: slowest, slow, normal, fast, fastest.

See Also

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

Info

2019-11-17 System Manager's Manual