1LIQUIDCTL(8)                System Manager's Manual               LIQUIDCTL(8)
2
3
4

NAME

6       liquidctl - monitor and control liquid coolers and other devices
7

SYNOPSIS

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

DESCRIPTION

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
25       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
31       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
36       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
42       liquidctl status displays the status of all devices that match the pro‐
43       vided filtering options.
44
45       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
49       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
54       •      hexadecimal RGB with or without prefix '0x': ff7f3f;
55
56       •      decimal RGB triple, R,G,B ∊ [0, 255]: rgb(255,127,63);
57
58       •      hue-saturation-value HSV triple, H ∊ [0, 360], S,V ∊  [0,  100]:
59              hsv(20,75,100);
60
61       •      hue-saturation-lightness  HSL  triple,  H  ∊ [0, 360], S,L ∊ [0,
62              100]: hsl(20,100,62).
63
64       liquidctl set channel screen allows  the  user  to  configure  the  LCD
65       screen integrated into some AIO models.
66
67
68       liquidctl  automatically  detects  when a kernel driver is bound to the
69       device and, whenever possible, uses it instead  of  directly  accessing
70       the  device.   Alternatively, direct access to the device can be forced
71       with --direct-access.
72

OPTIONS

74   Device selection options
75       Devices can be selected using one or more values taken from list --ver‐
76       bose.
77
78       -m substring, --match=substring
79              Filter  devices by case insensitive substring of device descrip‐
80              tion.
81
82       -n number, --pick=number
83              Pick among many results for a given filter.
84
85       --vendor=id
86              Filter devices by hexadecimal vendor id.
87
88       --product=id
89              Filter devices by hexadecimal product id.
90
91       --release=number
92              Filter devices by hexadecimal release number.
93
94       --serial=number
95              Filter devices by serial number.
96
97       --bus=bus
98              Filter devices by bus.
99
100       --address=address
101              Filter devices by address in bus.
102
103       --usb-port=port
104              Filter devices by USB port in bus.
105
106       -d index, --device=index
107              (Deprecated), select device by listing index.
108
109   Animation options
110       Some devices and animation modes support additional options.
111
112       --speed=value
113              Abstract animation speed (device/mode specific).
114
115       --time-per-color=value
116              Time to wait on each color (seconds).
117
118       --time-off=value
119              Time to wait with the LED turned off (seconds).
120
121       --alert-threshold=number
122              Threshold temperature for a visual alert (degrees Celsius).
123
124       --alert-color=color
125              Color used by the visual high temperature alert.
126
127       --direction=string
128              If the pattern should move forward or backward.
129
130       --start-led=number
131              The first led to start the effect at.
132
133       --maximum-leds=number
134              The number of LED's the effect should apply to.
135
136   Other options
137       --fan-mode=channel:mode[,...]
138              Set the fan modes.
139
140       --single-12v-ocp
141              Enable single rail +12V OCP.
142
143       --pump-mode=mode
144              Set the pump mode.
145
146       --temperature-sensor=number
147              The temperature sensor number for the Commander Pro.
148
149       --legacy-690lc
150              Use Asetek 690LC in legacy mode (old Krakens).
151
152       --non-volatile
153              Store on non-volatile controller memory.
154
155       --direct-access
156              Directly access the device despite kernel drivers.
157
158       --unsafe=features
159              Comman-separated bleeding-edge features to enable.
160
161       -v, --verbose
162              Output additional information.
163
164       -g, --debug
165              Show debug information on stderr.
166
167       --json Output machine-readable JSON.  Only  supported  with  list, ini‐
168              tialize and status.
169
170       --version
171              Display the version number.
172
173       --help Show the embedded help.
174

EXIT STATUS

176       1 if there was an error, 0 otherwise.
177

ENVIRONMENT

179       If  LANG  is set to C, non-ASCII characters are escaped from the output
180       of --json.
181

FILES

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

EXAMPLE

187       liquidctl list --verbose
188       liquidctl initialize all
189       liquidctl --match kraken set pump speed 90
190       liquidctl --product 170e set led color fading 350017 ff2608
191       liquidctl status
192

DEVICE SPECIFICS

194   Aquacomputer D5 Next
195   Aquacomputer Farbwerk 360
196   Aquacomputer Octo
197   Aquacomputer Quadro
198       Cooling channels: (D5 Next): fan,  pump;  (Octo):  fan[1-8];  (Quadro:)
199       fan[1-4]; (Farbwerk 360:) not applicable.
200
201       Lighting channels: not yet supported.
202
203   Corsair iCUE Elite Capellix H100i, H115i, H150i
204   Corsair Commander Core
205   Corsair Commander Core XT
206   Corsair Commander ST
207       Cooling channels: fans, fan[1-6]; (only non-XT/Elite Capellix:) pump.
208
209       Lighting channels: not yet supported.
210
211   Corsair Commander Pro
212   Corsair Lighting Node Pro
213   Corsair Lighting Node Core
214   Corsair Obsidian 1000D
215       Cooling  channels  (only  Commander  Pro  and  Obsidian  1000D):  sync,
216       fan[1-6].
217
218       Where the  fan  connection  types  can  be  set  with  --fan-mode=chan‐
219       nel:mode[,...], where the allowed modes are: off, dc, pwm.
220
221       Lighting  channels: (only Lighting Node Core:) led; (only Commander Pro
222       and Lighting Node Pro:) sync, led[1-2].
223
224       Mode          #colors
225       ──────────────────────────
226       clear            0
227       off              0
228       fixed            1
229       color_shift      2
230       color_pulse      2
231       color_wave       2
232       visor            2
233       blink            2
234       marquee          1
235       sequential       1
236       rainbow          0
237       rainbow2         0
238
239       When applicable the animation speed  can  be  set  with  --speed=value,
240       where the allowed values are: fast, medium, slow.
241
242       The  animation  direction  can be set with --direction=value, where the
243       allowed values are: forward or backward.  --start-led=number, the first
244       LED  that  the  lighting effect should be for.  --start-led=number, the
245       first LED that the lighting effect should be  for.   --maximum-led=num‐
246       ber,  the  number  of  LEDs that the lighting effect should applied to.
247       --temperature-sensor=number, The temperature sensor that should be used
248       to control the fan curves, probe 1 by default.
249
250   Corsair Hydro H80i GT, H100i GTX, H110i GTX
251   Corsair Hydro H80i v2, H100i v2, H115i
252   EVGA CLC 120 (CL12), 240, 280, 360
253       Cooling channels: pump, fan.
254
255       Lighting channels: logo.
256
257       Mode       #colors               notes
258       ────────────────────────────────────────────────────
259       rainbow       0      only available on EVGA coolers
260       fading        2
261       blinking      1
262       fixed         1
263       blackout      0        no high-temperature alerts
264
265       The rainbow mode speed can be configured with --speed=[1–6].  The speed
266       of the other modes is instead customized  with  --time-per-color  (fad‐
267       ing and blinking) and --time-off (blinking only).
268
269       All  modes except blackout support a visual high-temperature alert con‐
270       figured with --alert-threshold and --alert-color.
271
272       All current settings can be saved on non-volatile  on-board  memory  by
273       passing  --non-volatile to any write command.  However, since write-cy‐
274       cles are limited, this option should be used sparingly.
275
276   Corsair H100i Pro, H115i Pro, H150i Pro
277       Cooling channels: fan, fan[1–2]; (only H150i Pro:) fan3.
278
279       Pump mode (initialize --pump-mode  mode):  quiet,  balanced  (default),
280       performance.
281
282       Lighting channel: logo.
283
284       Mode       #colors
285       ───────────────────
286       alert         3
287       shift        2–4
288       pulse        1–4
289       blinking     1–4
290       fixed         1
291
292   Corsair Hydro H100i Platinum, H100i Platinum SE, H115i Platinum
293   Corsair Hydro H60i Pro XT, H100i Pro XT, H115i Pro XT, H150i Pro XT
294   Corsair Hydro H100i, H150i Elite RGB
295       Cooling channels: fan, fan[1–2]; (only H150i Pro XT/Elite RGB:) fan3.
296
297       Pump mode (initialize --pump-mode mode): quiet, balanced (default), ex‐
298       treme.
299
300       Lighting channels: sync, led.
301
302       Channel   Mode          #colors (Platinum)   #colors (Pro XT/Elite RGB)   #colors (Platinum SE)
303       ────────────────────────────────────────────────────────────────────────────────────────────────
304       led       off                   0                        0                          0
305       led       fixed                 1                        1                          1
306       led       super-fixed           24                       16                        48
307
308   NZXT Kraken X40, X60
309   NZXT Kraken X31, X41, X61
310       Supports the same modes and options as a Corsair Hydro H80i GT (or sim‐
311       ilar), but requires --legacy-690lc to be passed on all invocations.
312
313   NZXT Kraken M22
314   NZXT Kraken X42, X52, X62, X72
315       Cooling channels (only X42, X52, X62, X72): pump, fan.
316
317       Lighting channels: logo, ring, sync.
318
319       Mode              logo   ring   #colors
320       ────────────────────────────────────────
321       off               yes    yes       0
322       fixed             yes    yes       1
323       super-fixed       yes    yes      1–9
324       fading            yes    yes      2–8
325       alternating        no    yes       2
326       breathing         yes    yes      1–8
327       super-breathing   yes    yes      1–9
328       pulse             yes    yes      1–8
329       tai-chi            no    yes       2
330       water-cooler       no    yes       0
331       loading            no    yes       1
332       wings              no    yes       1
333
334       When  applicable  the  animation  speed  can be set with --speed=value,
335       where the allowed values are: slowest, slower, normal, faster, fastest.
336       The  animation  direction  can be set with --direction=value, where the
337       allowed values are: forward or backward.
338
339   NZXT Kraken X53, X63, X73
340   NZXT Kraken Z53, Z63, Z73
341       Cooling channels: pump; (only Z53, Z63, Z73:) fan.
342
343       Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
344
345       LCD screens (only Z53, Z63, Z73): lcd.
346
347       Mode                #colors
348       ────────────────────────────────────
349       off                    0
350       fixed                  1
351       fading                2–8
352       super-fixed          1–40
353       alternating-[3-6]     1–2
354       pulse                 1–8
355       breathing             1–8
356       super-breathing      1–40
357       candle                 1
358       starry-night           1
359       loading                1
360       tai-chi               1–2
361       water-cooler           2
362       wings                  1
363
364       When applicable the animation speed  can  be  set  with  --speed=value,
365       where the allowed values are: slowest, slower, normal, faster, fastest.
366       The animation direction can be set with  --direction=value,  where  the
367       allowed values are: forward or backward.
368
369   Corsair HX750i, HX850i, HX1000i, HX1200i, HX1500i
370   Corsair RM650i, RM750i, RM850i, RM1000i
371       Cooling channels: fan.
372
373       Lighting channels: none.
374
375       Setting a fixed fan speed changes the fan mode to software control.  To
376       revert back to hardware control, run initialize again.
377
378       (Experimental feature) The +12V rails normally  function  in  multiple-
379       rail  mode.   Single-rail  mode  can  be  selected  by  passing  --sin‐
380       gle-12v-ocp to initialize.  To revert back to multiple-rail  mode,  run
381       initialize again without that flag.
382
383   NZXT E500, E650, E850
384       Cooling channels: none (feature not supported yet).
385
386       Lighting channels: none.
387
388   NZXT Grid+ V3
389       Cooling channels: fan[1–6], sync.
390
391       Lighting channels: none.
392
393   NZXT Smart Device (V1)
394       Cooling channels: fan[1–3], sync.
395
396       Lighting channels: led.
397
398       Mode              #colors
399       ──────────────────────────────────
400
401       off                  0
402       fixed                1
403       super-fixed        1–40
404       fading              2–8
405       alternating          2
406       breathing           1–8
407       super-breathing    1–40
408       pulse               1–8
409       candle               1
410       wings                1
411
412       When  applicable  the  animation  speed  can be set with --speed=value,
413       where the allowed values are: slowest, slower, normal, faster, fastest.
414       The  animation  direction  can be set with --direction=value, where the
415       allowed values are: forward or backward.
416
417   NZXT Smart Device V2
418   NZXT RGB & Fan Controller
419   NZXT RGB & Fan Controller (3+6 channels)
420   NZXT HUE 2
421   NZXT HUE 2 Ambient
422   NZXT H1 V2
423       Cooling channels (only Smart Device V2, RGB &  Fan  Controller  and  H1
424       V2): fan[1–3].
425
426       Lighting channels (all but H1 V2): led[1–2], sync.
427
428       Additional lighting channels (HUE 2): led[3–4].
429
430       Additional  lighting  channels  (RGB  & Fan Controller (3+6 channels)):
431       led[3–6].
432
433       Mode                #colors
434       ────────────────────────────────────
435       off                    0
436       fixed                  1
437       super-fixed          1–40
438       fading                2–8
439       alternating-[3-6]      2
440       pulse                 1–8
441       breathing             1–8
442       super-breathing      1–40
443       candle                 1
444       starry-night           1
445       wings                  1
446
447       When applicable the animation speed  can  be  set  with  --speed=value,
448       where the allowed values are: slowest, slower, normal, faster, fastest.
449       The animation direction can be set with  --direction=value,  where  the
450       allowed values are: forward or backward.
451
452   ASUS Strix GTX 1050 OC
453   ASUS Strix GTX 1050 Ti OC
454   ASUS Strix GTX 1060 6GB
455   ASUS Strix GTX 1060 OC 6GB
456   ASUS Strix GTX 1070
457   ASUS Strix GTX 1070 OC
458   ASUS Strix GTX 1070 Ti
459   ASUS Strix GTX 1070 Ti Advanced
460   ASUS Strix GTX 1080
461   ASUS Strix GTX 1080 Advanced
462   ASUS Strix GTX 1080 OC
463   ASUS Strix GTX 1080 Ti
464   ASUS Strix GTX 1080 Ti OC
465   ASUS Strix GTX 1650 Super OC
466   ASUS Strix GTX 1660 Super OC
467   ASUS Strix GTX 1660 Ti OC
468   ASUS Strix RTX 2060 Evo
469   ASUS Strix RTX 2060 Evo OC
470   ASUS Strix RTX 2060 OC
471   ASUS Strix RTX 2060 Super
472   ASUS Strix RTX 2060 Super Advanced
473   ASUS Strix RTX 2060 Super Evo Advanced
474   ASUS Strix RTX 2060 Super OC
475   ASUS Strix RTX 2070
476   ASUS Strix RTX 2070 Advanced
477   ASUS Strix RTX 2070 OC
478   ASUS Strix RTX 2070 Super Advanced
479   ASUS Strix RTX 2070 Super OC
480   ASUS Strix RTX 2080 OC
481   ASUS Strix RTX 2080 Super Advanced
482   ASUS Strix RTX 2080 Super OC
483   ASUS Strix RTX 2080 Ti
484   ASUS Strix RTX 2080 Ti OC
485   ASUS TUF RTX 3060 Ti OC
486       Cooling channels: none.
487
488       Lighting channels: led.
489
490       Mode        #colors
491       ────────────────────────────
492       off            0
493       fixed          1
494       flash          1
495       breathing      1
496       rainbow        0
497
498   Corsair Vengeance RGB
499       Cooling channels: none.
500
501       Lighting channels: led.
502
503       Mode        #colors
504       ────────────────────────────
505       off            0
506       fixed          1
507       breathing     1–7
508       fading        2–7
509
510       When  applicable  the  animation  speed  can be set with --speed=value,
511       where the allowed values are: slowest, slower, normal, faster, fastest.
512
513   ASUS Aura LED Controller
514       Cooling channels: none.
515
516       Lighting channels: led[1–4], sync.
517
518       Mode                        #colors
519       ────────────────────────────────────────────
520       off                            0
521       static                         1
522       breathing                      1
523       flashing                       1
524       spectrum_cycle                 0
525       rainbow                        0
526       spectrum_cycle_breathing       0
527       chase_fade                     1
528       spectrum_cycle_chase_fade      0
529       chase                          1
530       spectrum_cycle_chase           0
531       spectrum_cycle_wave            0
532       chase_rainbow_pulse            0
533       rainbow_flicker                0
534       gentle_transition              0
535       wave_propagation               0
536       wave_propagation_pause         0
537       red_pulse                      0
538
539   Gigabyte RGB Fusion 2.0 5702 Controller
540   Gigabyte RGB Fusion 2.0 8297 Controller
541       Cooling channels: none.
542
543       Lighting channels: led[1–8], sync.
544
545       Mode              #colors
546       ──────────────────────────────────
547       off                  0
548       fixed                1
549       pulse                1
550       (double-)?flash      1
551       color-cycle          0
552
553       When applicable the animation speed  can  be  set  with  --speed=value,
554       where the allowed values are: slowest, slower, normal, faster, fastest,
555       ludicrous.
556
557   EVGA GTX 1070 FTW
558   EVGA GTX 1070 FTW DT Gaming
559   EVGA GTX 1070 FTW Hybrid
560   EVGA GTX 1070 Ti FTW2
561   EVGA GTX 1080 FTW
562       Cooling channels: none.
563
564       Lighting channels: led.
565
566       Mode        #colors
567       ────────────────────────────
568       off            0
569       fixed          1
570       breathing      1
571       rainbow        0
572

SEE ALSO

574       The complete documentation is available in the  project's  sources  and
575       homepage ⟨https://github.com/liquidctl/liquidctl⟩.
576
577
578
579liquidctl                         2023-07-26                      LIQUIDCTL(8)
Impressum