1LIQUIDCTL(8) System Manager's Manual LIQUIDCTL(8)
2
6 liquidctl - monitor and control liquid coolers and other devices
7
9 liquidctl [options] list
10 liquidctl [options] initialize [all]
11 liquidctl [options] status
12 liquidctl [options] set channel speed (temperature percentage) ...
13 liquidctl [options] set channel speed percentage
14 liquidctl [options] set channel color mode [color ...]
15 liquidctl --version
16 liquidctl --help
17
19 liquidctl is a utility for overseeing and controlling some hardware
20 monitoring devices not yet supported at the kernel level. Because liq‐
21 uidctl directly accesses the hardware devices, root privileges are gen‐
22 erally required, though this can be avoided with appropriate udev
23 rules.
24 liquidctl list outputs all compatible devices found on the system. In
26 case more than one device is found, the desired one can be selected for
27 later invocations with --match=substring, where substring matches part
28 of the desired device's description using a case insensitive compari‐
29 son.
30 liquidctl list --verbose enables the display of additional identifiers
32 and addresses that can also be used to select specific devices. These
33 can be better suited for certain use cases, such as non-interactive
34 scripts.
35 liquidctl initialize prepares a device for later commands, and most de‐
37 vices must be initialized after every boot or when resuming from a sus‐
38 pended state. Unless finer control is required, all devices can be
39 initialized at once with liquidctl initialize all. Some devices may
40 output some information at this stage.
41 liquidctl status displays the status of all devices that match the pro‐
43 vided filtering options.
44 liquidctl set channel speed allows the user to set fan and pump speeds.
46 These, depending on the device, can be set to fixed duty values, vari‐
47 able temperature\[u2013]duty curves, or both.
48 liquidctl set channel color allows the user to configure and set light‐
50 ing modes. Supported lighting modes and additional options vary by de‐
51 vice and are listed in later sections of this manual. Each color can
52 be specified as:
53 • hexadecimal RGB with or without prefix '0x': ff7f3f;
55 • decimal RGB triple, R,G,B ∊ [0, 255]: rgb(255,127,63);
57 • hue-saturation-value HSV triple, H ∊ [0, 360], S,V ∊ [0, 100]:
59 hsv(20,75,100);
60 • hue-saturation-lightness HSL triple, H ∊ [0, 360], S,L ∊ [0,
62 100]: hsl(20,100,62).
63 liquidctl automatically detects when a kernel driver is bound to the
66 device and, whenever possible, uses it instead of directly accessing
67 the device. Alternatively, direct access to the device can be forced
68 with --direct-access.
69
71 Device selection options
72 Devices can be selected using one or more values taken from list --ver‐
73 bose.
74 -m substring, --match=substring
76 Filter devices by case insensitive substring of device descrip‐
77 tion.
78 -n number, --pick=number
80 Pick among many results for a given filter.
81 --vendor=id
83 Filter devices by hexadecimal vendor id.
84 --product=id
86 Filter devices by hexadecimal product id.
87 --release=number
89 Filter devices by hexadecimal release number.
90 --serial=number
92 Filter devices by serial number.
93 --bus=bus
95 Filter devices by bus.
96 --address=address
98 Filter devices by address in bus.
99 --usb-port=port
101 Filter devices by USB port in bus.
102 -d index, --device=index
104 (Deprecated), select device by listing index.
105 Animation options
107 Some devices and animation modes support additional options.
108 --speed=value
110 Abstract animation speed (device/mode specific).
111 --time-per-color=value
113 Time to wait on each color (seconds).
114 --time-off=value
116 Time to wait with the LED turned off (seconds).
117 --alert-threshold=number
119 Threshold temperature for a visual alert (degrees Celsius).
120 --alert-color=color
122 Color used by the visual high temperature alert.
123 --direction=string
125 If the pattern should move forward or backward.
126 --start-led=number
128 The first led to start the effect at.
129 --maximum-leds=number
131 The number of LED's the effect should apply to.
132 Other options
134 --single-12v-ocp
135 Enable single rail +12V OCP.
136 --pump-mode=mode
138 Set the pump mode.
139 --temperature-sensor=number
141 The temperature sensor number for the Commander Pro.
142 --legacy-690lc
144 Use Asetek 690LC in legacy mode (old Krakens).
145 --non-volatile
147 Store on non-volatile controller memory.
148 --direct-access
150 Directly access the device despite kernel drivers.
151 --unsafe=features
153 Comman-separated bleeding-edge features to enable.
154 -v, --verbose
156 Output additional information.
157 -g, --debug
159 Show debug information on stderr.
160 --json Output machine-readable JSON. Only supported with list, ini‐
162 tialize and status.
163 --version
165 Display the version number.
166 --help Show the embedded help.
168
170 1 if there was an error, 0 otherwise.
171
173 If LANG is set to C, non-ASCII characters are escaped from the output
174 of --json.
175
177 $XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*, /tmp/liquidctl/*
178 Internal data used by some drivers.
179
181 liquidctl list --verbose
182 liquidctl initialize all
183 liquidctl --match kraken set pump speed 90
184 liquidctl --product 170e set led color fading 350017 ff2608
185 liquidctl status
186
188 Corsair Commander Core
189 Cooling channels: pump, fans, fan[1-6].
190 Corsair Commander Pro
192 Corsair Lighting Node Pro
193 Corsair Lighting Node Core
194 Corsair Obsidian 1000D
195 Cooling channels (only Commander Pro and Obsidian 1000D): sync,
196 fan[1-5].
197 Lighting channels: (only Lighting Node Core:) led; (only Commander Pro
199 and Lighting Node Pro:) sync, led[1-2].
200 Mode #colors
202 ──────────────────────────
203 clear 0
204 off 0
205 fixed 1
206 color_shift 2
207 color_pulse 2
208 color_wave 2
209 visor 2
210 blink 2
211 marquee 1
212 sequential 1
213 rainbow 0
214 rainbow2 0
215 When applicable the animation speed can be set with --speed=value,
217 where the allowed values are: fast, medium, slow.
218 The animation direction can be set with --direction=value, where the
220 allowed values are: forward or backward. --start-led=number, the first
221 LED that the lighting effect should be for. --start-led=number, the
222 first LED that the lighting effect should be for. --maximum-led=num‐
223 ber, the number of LEDs that the lighting effect should applied to.
224 --temperature-sensor=number, The temperature sensor that should be used
225 to control the fan curves, probe 1 by default.
226 Corsair Hydro H80i GT, H100i GTX, H110i GTX
228 Corsair Hydro H80i v2, H100i v2, H115i
229 EVGA CLC 120 (CL12), 240, 280, 360
230 Cooling channels: pump, fan.
231 Lighting channels: logo.
233 Mode #colors notes
235 ───────────────────────────────────────────────────
236 rainbow 0 only availble on EVGA coolers
237 fading 2
238 blinking 1
239 fixed 1
240 blackout 0 no high-temperature alerts
241 The rainbow mode speed can be configured with --speed=[1–6]. The speed
243 of the other modes is instead customized with --time-per-color (fad‐
244 ing and blinking) and --time-off (blinking only).
245 All modes except blackout support a visual high-temperature alert con‐
247 figured with --alert-threshold and --alert-color.
248 All current settings can be saved on non-volatile on-board memory by
250 passing --non-volatile to any write command. However, since write-cy‐
251 cles are limited, this option should be used sparingly.
252 Corsair H100i Pro, H115i Pro, H150i Pro
254 Fan channels: fan, fan[1–2]; (only H150i Pro:) fan3.
255 Pump mode (initialize --pump-mode mode): quiet, balanced (default),
257 performance.
258 Lighting channel: logo.
260 Mode #colors
262 ───────────────────
263 alert 3
264 shift 2–4
266 pulse 1–4
267 blinking 1–4
268 fixed 1
269 Corsair Hydro H100i Platinum, H100i Platinum SE, H115i Platinum
271 Corsair Hydro H60i Pro XT, H100i Pro XT, H115i Pro XT, H150i Pro XT
272 Fan channels: fan, fan[1–2]; (only H150i Pro XT:) fan3.
273 Pump mode (initialize --pump-mode mode): quiet, balanced (default), ex‐
275 treme.
276 Lighting channels: sync, led.
278 Channel Mode #colors (Platinum) #colors (Pro XT) #colors (Platinum SE)
280 ──────────────────────────────────────────────────────────────────────────────────────
281 led off 0 0 0
282 led fixed 1 1 1
283 led super-fixed 24 16 48
284 NZXT Kraken X40, X60
286 NZXT Kraken X31, X41, X61
287 Supports the same modes and options as a Corsair Hydro H80i GT (or sim‐
288 ilar), but requires --legacy-690lc to be passed on all invocations.
289 NZXT Kraken M22
291 NZXT Kraken X42, X52, X62, X72
292 Cooling channels (only X42, X52, X62, X72): pump, fan.
293 Lighting channels: logo, ring, sync.
295 Mode logo ring #colors
297 ────────────────────────────────────────
298 off yes yes 0
299 fixed yes yes 1
300 super-fixed yes yes 1–9
301 fading yes yes 2–8
302 alternating no yes 2
303 breathing yes yes 1–8
304 super-breathing yes yes 1–9
305 pulse yes yes 1–8
306 tai-chi no yes 2
307 water-cooler no yes 0
308 loading no yes 1
309 wings no yes 1
310 When applicable the animation speed can be set with --speed=value,
312 where the allowed values are: slowest, slower, normal, faster, fastest.
313 The animation direction can be set with --direction=value, where the
314 allowed values are: forward or backward.
315 NZXT Kraken X53, X63, X73
317 NZXT Kraken Z53, Z63, Z73
318 Cooling channels: pump; (only Z53, Z63, Z73:) fan.
319 Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
321 Mode #colors
323 ────────────────────────────────────
324 off 0
325 fixed 1
326 fading 2–8
327 super-fixed 1–40
328 alternating-[3-6] 1–2
329 pulse 1–8
330 breathing 1–8
332 super-breathing 1–40
333 candle 1
334 starry-night 1
335 loading 1
336 tai-chi 1–2
337 water-cooler 2
338 wings 1
339 When applicable the animation speed can be set with --speed=value,
341 where the allowed values are: slowest, slower, normal, faster, fastest.
342 The animation direction can be set with --direction=value, where the
343 allowed values are: forward or backward.
344 Corsair HX750i, HX850i, HX1000i, HX1200i
346 Corsair RM650i, RM750i, RM850i, RM1000i
347 Fan channels: fan.
348 Lighting channels: none.
350 Setting a fixed fan speed changes the fan mode to software control. To
352 revert back to hardware control, run initialize again.
353 (Experimental feature) The +12V rails normally function in multiple-
355 rail mode. Single-rail mode can be selected by passing --sin‐
356 gle-12v-ocp to initialize. To revert back to multiple-rail mode, run
357 initialize again without that flag.
358 NZXT E500, E650, E850
360 Fan channels: none (feature not supported yet).
361 Lighting channels: none.
363 NZXT Grid+ V3
365 Fan channels: fan[1–6], sync.
366 Lighting channels: none.
368 NZXT Smart Device (V1)
370 Fan channels: fan[1–3], sync.
371 Lighting channels: led.
373 Mode #colors
375 ──────────────────────────────────
376 off 0
377 fixed 1
378 super-fixed 1–40
379 fading 2–8
380 alternating 2
381 breathing 1–8
382 super-breathing 1–40
383 pulse 1–8
384 candle 1
385 wings 1
386 When applicable the animation speed can be set with --speed=value,
388 where the allowed values are: slowest, slower, normal, faster, fastest.
389 The animation direction can be set with --direction=value, where the
390 allowed values are: forward or backward.
391 NZXT Smart Device V2
393 NZXT RGB & Fan Controller
394 NZXT HUE 2
395 NZXT HUE 2 Ambient
396 Fan channels (only Smart Device V2 and RGB & Fan Controller): fan[1–3].
397 Lighting channels: led[1–2], sync.
399 Additional lighting channels (only HUE 2): led[3–4].
401 Mode #colors
403 ────────────────────────────────────
404 off 0
405 fixed 1
406 super-fixed 1–40
407 fading 2–8
408 alternating-[3-6] 2
409 pulse 1–8
410 breathing 1–8
411 super-breathing 1–40
412 candle 1
413 starry-night 1
414 wings 1
415 When applicable the animation speed can be set with --speed=value,
417 where the allowed values are: slowest, slower, normal, faster, fastest.
418 The animation direction can be set with --direction=value, where the
419 allowed values are: forward or backward.
420 ASUS Strix GTX 1050 OC
422 ASUS Strix GTX 1050 Ti OC
423 ASUS Strix GTX 1060 6GB
424 ASUS Strix GTX 1060 OC 6GB
425 ASUS Strix GTX 1070
426 ASUS Strix GTX 1070 OC
427 ASUS Strix GTX 1070 Ti
428 ASUS Strix GTX 1070 Ti Advanced
429 ASUS Strix GTX 1080
430 ASUS Strix GTX 1080 Advanced
431 ASUS Strix GTX 1080 OC
432 ASUS Strix GTX 1080 Ti
433 ASUS Strix GTX 1080 Ti OC
434 ASUS Strix GTX 1650 Super OC
435 ASUS Strix GTX 1660 Super OC
436 ASUS Strix GTX 1660 Ti OC
437 ASUS Strix RTX 2060 Evo
438 ASUS Strix RTX 2060 Evo OC
439 ASUS Strix RTX 2060 OC
440 ASUS Strix RTX 2060 Super
441 ASUS Strix RTX 2060 Super Advanced
442 ASUS Strix RTX 2060 Super Evo Advanced
443 ASUS Strix RTX 2060 Super OC
444 ASUS Strix RTX 2070
445 ASUS Strix RTX 2070 Advanced
446 ASUS Strix RTX 2070 OC
447 ASUS Strix RTX 2070 Super Advanced
448 ASUS Strix RTX 2070 Super OC
449 ASUS Strix RTX 2080 OC
450 ASUS Strix RTX 2080 Super Advanced
451 ASUS Strix RTX 2080 Super OC
452 ASUS Strix RTX 2080 Ti
453 ASUS Strix RTX 2080 Ti OC
454 ASUS TUF RTX 3060 Ti OC
455 Fan channels: none.
456 Lighting channels: led.
458 Mode #colors
460 ────────────────────────────
461 off 0
462 fixed 1
463 flash 1
464 breathing 1
466 rainbow 0
467 Corsair Vengeance RGB
469 Fan channels: none.
470 Lighting channels: led.
472 Mode #colors
474 ────────────────────────────
475 off 0
476 fixed 1
477 breathing 1–7
478 fading 2–7
479 When applicable the animation speed can be set with --speed=value,
481 where the allowed values are: slowest, slower, normal, faster, fastest.
482 Gigabyte RGB Fusion 2.0 5702 Controller
484 Gigabyte RGB Fusion 2.0 8297 Controller
485 Fan channels: none.
486 Lighting channels: led[1–8], sync.
488 Mode #colors
490 ──────────────────────────────────
491 off 0
492 fixed 1
493 pulse 1
494 (double-)?flash 1
495 color-cycle 0
496 When applicable the animation speed can be set with --speed=value,
498 where the allowed values are: slowest, slower, normal, faster, fastest,
499 ludicrous.
500 EVGA GTX 1070 FTW
502 EVGA GTX 1070 FTW DT Gaming
503 EVGA GTX 1070 FTW Hybrid
504 EVGA GTX 1070 Ti FTW2
505 EVGA GTX 1080 FTW
506 Fan channels: none.
507 Lighting channels: led.
509 Mode #colors
511 ────────────────────────────
512 off 0
513 fixed 1
514 breathing 1
515 rainbow 0
516
518 The complete documentation is available in the project's sources and
519 homepage ⟨https://github.com/liquidctl/liquidctl⟩.
520liquidctl 2022-04-05 LIQUIDCTL(8)