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
37 devices must be initialized after every boot or when resuming from a
38 suspended 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
51 device 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
65 Device selection options
66 Devices can be selected using one or more values taken from list --ver‐
67 bose.
68 -m substring, --match=substring
70 Filter devices by case insensitive substring of device descrip‐
71 tion.
72 -n number, --pick=number
74 Pick among many results for a given filter.
75 --vendor=id
77 Filter devices by hexadecimal vendor id.
78 --product=id
80 Filter devices by hexadecimal product id.
81 --release=number
83 Filter devices by hexadecimal release number.
84 --serial=number
86 Filter devices by serial number.
87 --bus=bus
89 Filter devices by bus.
90 --address=address
92 Filter devices by address in bus.
93 --usb-port=port
95 Filter devices by USB port in bus.
96 -d id, --device=id
98 Select device by listing ID.
99 Animation options
101 Some devices and animation modes support additional options.
102 --speed=value
104 Abstract animation speed (device/mode specific).
105 --time-per-color=value
107 Time to wait on each color (seconds).
108 --time-off=value
110 Time to wait with the LED turned off (seconds).
111 --alert-threshold=number
113 Threshold temperature for a visual alert (degrees Celsius).
114 --alert-color=color
116 Color used by the visual high temperature alert.
117 --direction=string
119 If the pattern should move forward or backwards. [default: for‐
120 ward].
121 --start-led=number
123 The first led to start the effect at.
124 --maximum-leds=number
126 The number of LED's the effect should apply to.
127 Other options
129 --single-12v-ocp
130 Enable single rail +12V OCP.
131 --pump-mode= mode
133 Set the pump mode.
134 --temperature-sensor= number
136 The temperature sensor number for the Commander Pro.
137 --legacy-690lc
139 Use Asetek 690LC in legacy mode (old Krakens).
140 --non-volatile
142 Store on non-volatile controller memory.
143 --unsafe= features
145 Comman-separated bleeding-edge features to enable.
146 -v, --verbose
148 Output additional information.
149 -g, --debug
151 Show debug information on stderr.
152 --version
154 Display the version number.
155 --help Show the embedded help.
157
159 1 if there was an error, 0 otherwise.
160
162 $XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*, /tmp/liquidctl/*
163 Internal data used by some drivers.
164
166 liquidctl list --verbose
167 liquidctl initialize all
168 liquidctl --match kraken set pump speed 90
169 liquidctl --product 170e set led color fading 350017 ff2608
170 liquidctl status
171
173 Corsair Commander Pro
174 Corsair Lighting Node Pro
175 Cooling channels: sync, fan[1-5]. (Commander Pro only)
176 Lighting channels: led1, led2.
178 Mode #colors
180 ──────────────────────────
181 clear 0
182 off 0
183 fixed 1
184 color_shift 2
185 color_pulse 2
186 color_wave 2
187 visor 2
188 blink 2
189 marquee 1
190 sequential 1
191 rainbow 0
192 rainbow2 0
193 When applicable the animation speed can be set with --speed=value,
195 where the allowed values are: fast, medium, slow.
196 The animation direction can be set with --direction=value, where the
198 allowed values are: forward or backward. --start-led=number, the first
199 LED that the lighting effect should be for. --start-led=number, the
200 first LED that the lighting effect should be for. --maximum-led=num‐
201 ber, the number of LEDs that the lighting effect should applied to.
202 --temperature-sensor=number, The temperature sensor that should be used
203 to control the fan curves, probe 1 by default.
204 Corsair H80i GT, H100i GTX, H110i GTX
206 Corsair H80i v2, H100i v2, H115i
207 EVGA CLC 120 (CL12), 240, 280, 360
208 Cooling channels: pump, fan.
209 Lighting channels: logo.
211 Mode #colors notes
213 ───────────────────────────────────────────────────
214 rainbow 0 only availble on EVGA coolers
215 fading 2
216 blinking 1
217 fixed 1
218 blackout 0 no high-temperature alerts
219 The rainbow mode speed can be configured with --speed=[1–6]. The speed
221 of the other modes is instead customized with --time-per-color (fad‐
222 ing and blinking) and --time-off (blinking only).
223 All modes except blackout support a visual high-temperature alert con‐
225 figured with --alert-threshold and --alert-color.
226 Corsair H100i Platinum, H100i Platinum SE, H115i Platinum
228 Corsair H100i Pro XT, H115i Pro XT
229 Fan channels: fan, fan[1–2].
230 Pump mode (initialize --pump-mode mode): quiet, balanced (default),
232 extreme.
233 Lighting channels: sync, led.
235 Channel Mode #colors (Platinum) #colors (Pro XT) #colors (Platinum SE)
237 ──────────────────────────────────────────────────────────────────────────────────────
238 led off 0 0 0
239 led fixed 1 1 1
240 led super-fixed 24 16 48
241 NZXT Kraken X40, X60
243 NZXT Kraken X31, X41, X61
244 Supports the same modes and options as a Corsair H80i GT (or similar),
245 but requires --legacy-690lc to be passed on all invocations.
246 NZXT Kraken M22
248 NZXT Kraken X42, X52, X62, X72
249 Cooling channels (only X42, X52, X62, X72): pump, fan.
250 Lighting channels: logo, ring, sync.
252 Mode logo ring #colors
254 ────────────────────────────────────────
255 off yes yes 0
256 fixed yes yes 1
257 super-fixed yes yes 1–9
258 fading yes yes 2–8
259 alternating no yes 2
260 breathing yes yes 1–8
261 super-breathing yes yes 1–9
262 pulse yes yes 1–8
263 tai-chi no yes 2
264 water-cooler no yes 0
265 loading no yes 1
266 wings no yes 1
267 When applicable the animation speed can be set with --speed=value,
269 where the allowed values are: slowest, slower, normal, faster, fastest.
270 The animation direction can be set with --direction=value, where the
271 allowed values are: forward or backward.
272 NZXT Kraken X53, X63, X73
274 NZXT Kraken Z63, Z73
275 Cooling channels: pump; (only Z63, Z73:) fan.
276 Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
278 Mode #colors
280 ────────────────────────────────────
281 off 0
282 fixed 1
283 fading 2–8
284 super-fixed 1–40
285 alternating-[3-6] 1–2
286 pulse 1–8
287 breathing 1–8
288 super-breathing 1–40
289 candle 1
290 starry-night 1
291 loading 1
292 tai-chi 1–2
293 water-cooler 2
294 wings 1
295 When applicable the animation speed can be set with --speed=value,
297 where the allowed values are: slowest, slower, normal, faster, fastest.
298 The animation direction can be set with --direction=value, where the
299 allowed values are: forward or backward.
300 Corsair HX750i, HX850i, HX1000i, HX1200i
302 Corsair RM650i, RM750i, RM850i, RM1000i
303 Fan channels: fan.
304 Lighting channels: none.
306 Setting a fixed fan speed changes the fan mode to software control. To
308 revert back to hardware control, run initialize again.
309 (Experimental feature) The +12V rails normally function in multiple-
311 rail mode. Single-rail mode can be selected by passing --sin‐
312 gle-12v-ocp to initialize. To revert back to multiple-rail mode, run
313 initialize again without that flag.
314 NZXT E500, E650, E850
316 Fan channels: none (feature not supported yet).
317 Lighting channels: none.
319 NZXT Grid+ V3
321 Fan channels: fan[1–6], sync.
322 Lighting channels: none.
324 NZXT Smart Device (V1)
326 Fan channels: fan[1–3], sync.
327 Lighting channels: led.
329 Mode #colors
331 ──────────────────────────────────
332 off 0
333 fixed 1
334 super-fixed 1–40
335 fading 2–8
337 alternating 2
338 breathing 1–8
339 super-breathing 1–40
340 pulse 1–8
341 candle 1
342 wings 1
343 When applicable the animation speed can be set with --speed=value,
345 where the allowed values are: slowest, slower, normal, faster, fastest.
346 The animation direction can be set with --direction=value, where the
347 allowed values are: forward or backward.
348 NZXT Smart Device V2
350 NZXT RGB & Fan Controller
351 NZXT HUE 2
352 NZXT HUE 2 Ambient
353 Fan channels (only Smart Device V2 and RGB & Fan Controller): fan[1–3].
354 Lighting channels: led[1–2], sync.
356 Additional lighting channels (only HUE 2): led[3–4].
358 Mode #colors
360 ────────────────────────────────────
361 off 0
362 fixed 1
363 super-fixed 1–40
364 fading 2–8
365 alternating-[3-6] 2
366 pulse 1–8
367 breathing 1–8
368 super-breathing 1–40
369 candle 1
370 starry-night 1
371 wings 1
372 When applicable the animation speed can be set with --speed=value,
374 where the allowed values are: slowest, slower, normal, faster, fastest.
375 The animation direction can be set with --direction=value, where the
376 allowed values are: forward or backward.
377 ASUS Strix RTX 2080 Ti OC
379 Fan channels: none.
380 Lighting channels: led.
382 Mode #colors
384 ────────────────────────────
385 off 0
386 fixed 1
387 flash 1
388 breathing 1
389 rainbow 0
390 Corsair Vengeance RGB
392 Fan channels: none.
393 Lighting channels: led.
395 Mode #colors
397 ────────────────────────────
398 off 0
399 fixed 1
400 breathing 1–7
401 fading 2–7
402 When applicable the animation speed can be set with --speed=value,
404 where the allowed values are: slowest, slower, normal, faster, fastest.
405 Gigabyte RGB Fusion 2.0 5702 Controller
407 Gigabyte RGB Fusion 2.0 8297 Controller
408 Fan channels: none.
409 Lighting channels: led[1–8], sync.
411 Mode #colors
413 ──────────────────────────────────
414 off 0
415 fixed 1
416 pulse 1
417 (double-)?flash 1
418 color-cycle 0
419 When applicable the animation speed can be set with --speed=value,
421 where the allowed values are: slowest, slower, normal, faster, fastest,
422 ludicrous.
423 EVGA GTX 1080 FTW
425 Fan channels: none.
426 Lighting channels: led.
428 Mode #colors
430 ────────────────────────────
431 off 0
432 fixed 1
433 breathing 1
434 rainbow 0
435
437 The complete documentation is available in the project's sources and
438 homepage ⟨https://github.com/liquidctl/liquidctl⟩.
439liquidctl 2021-01-25 LIQUIDCTL(8)