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

OPTIONS

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

EXIT STATUS

158       1 if there was an error, 0 otherwise.
159

FILES

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

EXAMPLE

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

DEVICE SPECIFICS

172   Corsair Commander Pro
173   Corsair Lighting Node Pro
174   Corsair Lighting Node Core
175       Cooling channels (only Commander Pro): sync, fan[1-5].
176
177       Lighting channels: (only Lighting Node Core:) led; (only Commander  Pro
178       and and Lighting Node Pro:) sync, led[1-2].
179
180       Mode          #colors
181       ──────────────────────────
182       clear            0
183       off              0
184       fixed            1
185       color_shift      2
186       color_pulse      2
187       color_wave       2
188       visor            2
189       blink            2
190       marquee          1
191       sequential       1
192       rainbow          0
193       rainbow2         0
194
195       When  applicable  the  animation  speed  can be set with --speed=value,
196       where the allowed values are: fast, medium, slow.
197
198       The animation direction can be set with  --direction=value,  where  the
199       allowed values are: forward or backward.  --start-led=number, the first
200       LED that the lighting effect should be  for.   --start-led=number,  the
201       first  LED  that the lighting effect should be for.  --maximum-led=num‐
202       ber, the number of LEDs that the lighting  effect  should  applied  to.
203       --temperature-sensor=number, The temperature sensor that should be used
204       to control the fan curves, probe 1 by default.
205
206   Corsair Hydro H80i GT, H100i GTX, H110i GTX
207   Corsair Hydro H80i v2, H100i v2, H115i
208   EVGA CLC 120 (CL12), 240, 280, 360
209       Cooling channels: pump, fan.
210
211       Lighting channels: logo.
212
213       Mode       #colors               notes
214       ───────────────────────────────────────────────────
215       rainbow       0      only availble on EVGA coolers
216       fading        2
217       blinking      1
218       fixed         1
219       blackout      0       no high-temperature alerts
220
221       The rainbow mode speed can be configured with --speed=[1–6].  The speed
222       of  the  other  modes is instead customized with --time-per-color (fad‐
223       ing and blinking) and --time-off (blinking only).
224
225       All modes except blackout support a visual high-temperature alert  con‐
226       figured with --alert-threshold and --alert-color.
227
228   Corsair H100i Pro, H115i Pro, H150i Pro
229       Fan channels: fan, fan[1–2]; (only H150i Pro:) fan3.
230
231       Pump  mode  (initialize  --pump-mode  mode): quiet, balanced (default),
232       performance.
233
234       Lighting channel: logo.
235
236       Mode       #colors
237       ───────────────────
238       alert         3
239       shift        2–4
240       pulse        1–4
241       blinking     1–4
242       fixed         1
243
244   Corsair Hydro H100i Platinum, H100i Platinum SE, H115i Platinum
245   Corsair Hydro H100i Pro XT, H115i Pro XT , H150i Pro XT
246       Fan channels: fan, fan[1–2]; (only H150i Pro XT:) fan3.
247
248       Pump mode (initialize --pump-mode mode): quiet, balanced (default), ex‐
249       treme.
250
251       Lighting channels: sync, led.
252
253       Channel   Mode          #colors (Platinum)   #colors (Pro XT)   #colors (Platinum SE)
254       ──────────────────────────────────────────────────────────────────────────────────────
255       led       off                   0                   0                     0
256       led       fixed                 1                   1                     1
257       led       super-fixed           24                  16                   48
258
259   NZXT Kraken X40, X60
260   NZXT Kraken X31, X41, X61
261       Supports the same modes and options as a Corsair Hydro H80i GT (or sim‐
262       ilar), but requires --legacy-690lc to be passed on all invocations.
263
264   NZXT Kraken M22
265   NZXT Kraken X42, X52, X62, X72
266       Cooling channels (only X42, X52, X62, X72): pump, fan.
267
268       Lighting channels: logo, ring, sync.
269
270       Mode              logo   ring   #colors
271       ────────────────────────────────────────
272       off               yes    yes       0
273       fixed             yes    yes       1
274
275       super-fixed       yes    yes      1–9
276       fading            yes    yes      2–8
277       alternating        no    yes       2
278       breathing         yes    yes      1–8
279       super-breathing   yes    yes      1–9
280       pulse             yes    yes      1–8
281       tai-chi            no    yes       2
282       water-cooler       no    yes       0
283       loading            no    yes       1
284       wings              no    yes       1
285
286       When applicable the animation speed  can  be  set  with  --speed=value,
287       where the allowed values are: slowest, slower, normal, faster, fastest.
288       The animation direction can be set with  --direction=value,  where  the
289       allowed values are: forward or backward.
290
291   NZXT Kraken X53, X63, X73
292   NZXT Kraken Z63, Z73
293       Cooling channels: pump; (only Z63, Z73:) fan.
294
295       Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
296
297       Mode                #colors
298       ────────────────────────────────────
299       off                    0
300       fixed                  1
301       fading                2–8
302       super-fixed          1–40
303       alternating-[3-6]     1–2
304       pulse                 1–8
305       breathing             1–8
306       super-breathing      1–40
307       candle                 1
308       starry-night           1
309       loading                1
310       tai-chi               1–2
311       water-cooler           2
312       wings                  1
313
314       When  applicable  the  animation  speed  can be set with --speed=value,
315       where the allowed values are: slowest, slower, normal, faster, fastest.
316       The  animation  direction  can be set with --direction=value, where the
317       allowed values are: forward or backward.
318
319   Corsair HX750i, HX850i, HX1000i, HX1200i
320   Corsair RM650i, RM750i, RM850i, RM1000i
321       Fan channels: fan.
322
323       Lighting channels: none.
324
325       Setting a fixed fan speed changes the fan mode to software control.  To
326       revert back to hardware control, run initialize again.
327
328       (Experimental  feature)  The  +12V rails normally function in multiple-
329       rail  mode.   Single-rail  mode  can  be  selected  by  passing  --sin‐
330       gle-12v-ocp  to  initialize.  To revert back to multiple-rail mode, run
331       initialize again without that flag.
332
333   NZXT E500, E650, E850
334       Fan channels: none (feature not supported yet).
335
336       Lighting channels: none.
337
338   NZXT Grid+ V3
339       Fan channels: fan[1–6], sync.
340
341       Lighting channels: none.
342
343   NZXT Smart Device (V1)
344       Fan channels: fan[1–3], sync.
345
346       Lighting channels: led.
347
348       Mode              #colors
349       ──────────────────────────────────
350       off                  0
351       fixed                1
352       super-fixed        1–40
353       fading              2–8
354       alternating          2
355       breathing           1–8
356       super-breathing    1–40
357       pulse               1–8
358       candle               1
359       wings                1
360
361       When applicable the animation speed  can  be  set  with  --speed=value,
362       where the allowed values are: slowest, slower, normal, faster, fastest.
363       The animation direction can be set with  --direction=value,  where  the
364       allowed values are: forward or backward.
365
366   NZXT Smart Device V2
367   NZXT RGB & Fan Controller
368   NZXT HUE 2
369   NZXT HUE 2 Ambient
370       Fan channels (only Smart Device V2 and RGB & Fan Controller): fan[1–3].
371
372       Lighting channels: led[1–2], sync.
373
374       Additional lighting channels (only HUE 2): led[3–4].
375
376       Mode                #colors
377       ────────────────────────────────────
378       off                    0
379       fixed                  1
380       super-fixed          1–40
381       fading                2–8
382       alternating-[3-6]      2
383       pulse                 1–8
384       breathing             1–8
385       super-breathing      1–40
386       candle                 1
387       starry-night           1
388       wings                  1
389
390       When  applicable  the  animation  speed  can be set with --speed=value,
391       where the allowed values are: slowest, slower, normal, faster, fastest.
392       The  animation  direction  can be set with --direction=value, where the
393       allowed values are: forward or backward.
394
395   ASUS Strix GTX 1070
396   ASUS Strix RTX 2080 Ti OC
397       Fan channels: none.
398
399       Lighting channels: led.
400
401       Mode        #colors
402       ────────────────────────────
403       off            0
404       fixed          1
405       flash          1
406       breathing      1
407       rainbow        0
408
409   Corsair Vengeance RGB
410       Fan channels: none.
411
412       Lighting channels: led.
413
414       Mode        #colors
415       ────────────────────────────
416
417       off            0
418       fixed          1
419       breathing     1–7
420       fading        2–7
421
422       When applicable the animation speed  can  be  set  with  --speed=value,
423       where the allowed values are: slowest, slower, normal, faster, fastest.
424
425   Gigabyte RGB Fusion 2.0 5702 Controller
426   Gigabyte RGB Fusion 2.0 8297 Controller
427       Fan channels: none.
428
429       Lighting channels: led[1–8], sync.
430
431       Mode              #colors
432       ──────────────────────────────────
433       off                  0
434       fixed                1
435       pulse                1
436       (double-)?flash      1
437       color-cycle          0
438
439       When  applicable  the  animation  speed  can be set with --speed=value,
440       where the allowed values are: slowest, slower, normal, faster, fastest,
441       ludicrous.
442
443   EVGA GTX 1080 FTW
444       Fan channels: none.
445
446       Lighting channels: led.
447
448       Mode        #colors
449       ────────────────────────────
450       off            0
451       fixed          1
452       breathing      1
453       rainbow        0
454

SEE ALSO

456       The  complete  documentation  is available in the project's sources and
457       homepage ⟨https://github.com/liquidctl/liquidctl⟩.
458
459
460
461liquidctl                         2021-04-06                      LIQUIDCTL(8)
Impressum