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       --json Output machine-readable JSON.  Only  supported  with  list, ini‐
153              tialize and status.
154
155       --version
156              Display the version number.
157
158       --help Show the embedded help.
159

EXIT STATUS

161       1 if there was an error, 0 otherwise.
162

ENVIRONMENT

164       If  LANG  is set to C, non-ASCII characters are escaped from the output
165       of --json.
166

FILES

168       $XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*, /tmp/liquidctl/*
169              Internal data used by some drivers.
170

EXAMPLE

172       liquidctl list --verbose
173       liquidctl initialize all
174       liquidctl --match kraken set pump speed 90
175       liquidctl --product 170e set led color fading 350017 ff2608
176       liquidctl status
177

DEVICE SPECIFICS

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

SEE ALSO

463       The complete documentation is available in the  project's  sources  and
464       homepage ⟨https://github.com/liquidctl/liquidctl⟩.
465
466
467
468liquidctl                         2021-07-06                      LIQUIDCTL(8)
Impressum