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.   Most
37       devices  must be initialized after every boot.  Unless finer control is
38       required, all devices can be initialized at once  with  liquidctl  ini‐
39       tialize all.  Some devices may output some information at this stage.
40
41       liquidctl status displays the status of all devices that match the pro‐
42       vided filtering options.
43
44       liquidctl set channel speed allows the user to set fan and pump speeds.
45       These,  depending on the device, can be set to fixed duty values, vari‐
46       able temperature\[u2013]duty curves, or both.
47
48       liquidctl set channel color allows the user to configure and set light‐
49       ing  modes.   Each  color is specified in hexadecimal RGB, without pre‐
50       fixes (e.g. ff2608).  Supported modes and additional  options  vary  by
51       device and are listed in later sections of this manual.
52

OPTIONS

54   Device selection options
55       Devices can be selected using one or more values taken from list --ver‐
56       bose.
57
58       -m substring, --match=substring
59              Filter devices by case insensitive substring of device  descrip‐
60              tion.
61
62       -n number, --pick=number
63              Pick among many results for a given filter.
64
65       --vendor=id
66              Filter devices by vendor id.
67
68       --product=id
69              Filter devices by product id.
70
71       --release=number
72              Filter devices by release number.
73
74       --serial=number
75              Filter devices by serial number.
76
77       --bus=bus
78              Filter devices by bus.
79
80       --address=address
81              Filter devices by address in bus.
82
83       --usb-port=port
84              Filter devices by USB port in bus.
85
86       -d id, --device=id
87              Select device by listing ID.
88
89   Animation options
90       Some devices and animation modes support additional options.
91
92       --speed=value
93              Abstract animation speed (device/mode specific).
94
95       --time-per-color=value
96              Time to wait on each color (seconds).
97
98       --time-off=value
99              Time to wait with the LED turned off (seconds).
100
101       --alert-threshold=number
102              Threshold temperature for a visual alert (degrees Celsius).
103
104       --alert-color=color
105              Color used by the visual high temperature alert.
106
107   Other options
108       -v, --verbose
109              Output additional information.
110
111       -g, --debug
112              Show debug information on stderr.
113
114       --hid=module
115              Override API for USB HIDs: usb, hid or hidraw.
116
117       --legacy-690lc
118              Use Asetek 690LC in legacy mode (old Krakens).
119
120       --single-12v-ocp
121              Enable single rail +12V OCP.
122
123       --version
124              Display the version number.
125
126       --help Show the embedded help.
127

EXIT STATUS

129       1 if there was an error, 0 otherwise.
130

FILES

132       $XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*
133              Internal data used by some drivers.
134

EXAMPLE

136       liquidctl list --verbose
137       liquidctl initialize all
138       liquidctl --match kraken set pump speed 90
139       liquidctl --product 0x170e set led color fading 350017 ff2608
140       liquidctl status
141

DEVICE SPECIFICS

143   Corsair H80i GT, H100i GTX, H110i GTX
144   Corsair H80i v2, H100i v2, H115i
145   EVGA CLC 120 (CL12), 240, 280, 360
146       Cooling channels: pump, fan.
147
148       Lighting channels: logo.
149
150       Mode       #colors               notes
151       ───────────────────────────────────────────────────
152       rainbow       0      only availble on EVGA coolers
153       fading        2
154       blinking      1
155       fixed         1
156       blackout      0       no high-temperature alerts
157
158       The rainbow mode speed can be configured with --speed=[1–6].  The speed
159       of the other modes is instead customized  with  --time-per-color  (fad‐
160       ing and blinking) and --time-off (blinking only).
161
162       All  modes except blackout support a visual high-temperature alert con‐
163       figured with --alert-threshold and --alert-color.
164
165   NZXT Kraken X40, X60
166   NZXT Kraken X31, X41, X61
167       Supports the same modes and options as a Corsair H80i GT (or  similar),
168       but requires --legacy-690lc to be passed on all invocations.
169
170   NZXT Kraken M22
171   NZXT Kraken X42, X52, X62, X72
172       Cooling channels (only X42, X52, X62, X72): pump, fan.
173
174       Lighting channels: logo, ring, sync.
175
176       Mode                              logo   ring   #colors
177       ────────────────────────────────────────────────────────
178       off                               yes    yes       0
179       fixed                             yes    yes       1
180       super-fixed                       yes    yes      1–9
181       fading                            yes    yes      2–8
182       (backwards-)?spectrum-wave        yes    yes       0
183       (backwards-)?super-wave            no    yes      1–8
184       (backwards-)?marquee-[3-6]         no    yes       1
185       covering-(backwards-)?marquee      no    yes      1–8
186       alternating                        no    yes       2
187       (backwards-)?moving-alternating    no    yes       2
188       breathing                         yes    yes      1–8
189       super-breathing                   yes    yes      1–9
190       pulse                             yes    yes      1–8
191       tai-chi                            no    yes       2
192       water-cooler                       no    yes       0
193       loading                            no    yes       1
194       wings                              no    yes       1
195
196       When  applicable  the  animation  speed  can be set with --speed=value,
197       where the allowed values are: slowest, slow, normal, fast, fastest.
198
199   Corsair HX750i, HX850i, HX1000i, HX1200i
200   Corsair RM650i, RM750i, RM850i, RM1000i
201       Fan channels: fan.
202
203       Lighting channels: none.
204
205       Setting a fixed fan speed changes the fan mode to software control.  To
206       revert back to hardware control, run initialize again.
207
208       (Experimental  feature)  The  +12V rails normally function in multiple-
209       rail  mode.   Single-rail  mode  can  be  selected  by  passing  --sin‐
210       gle-12v-ocp  to  initialize.  To revert back to multiple-rail mode, run
211       initialize again without that flag.
212
213   NZXT E500, E650, E850
214       Fan channels: none (feature not supported yet).
215
216       Lighting channels: none.
217
218   NZXT Grid+ V3
219       Fan channels: fan[1–6].
220
221       Lighting channels: none.
222
223   NZXT Smart Device (V1)
224       Fan channels: fan[1–3].
225
226       Lighting channels: led.
227
228       Mode                              #colors
229       ──────────────────────────────────────────────────
230       off                                  0
231       fixed                                1
232       super-fixed                        1–40
233       fading                              2–8
234       (backwards-)?spectrum-wave           0
235       (backwards-)?super-wave            1–40
236       (backwards-)?marquee-[3-6]           1
237       covering-(backwards-)?marquee       1–8
238       alternating                          2
239       (backwards-)?moving-alternating      2
240       breathing                           1–8
241       super-breathing                    1–40
242       pulse                               1–8
243       candle                               1
244       wings                                1
245
246       When applicable the animation speed  can  be  set  with  --speed=value,
247       where the allowed values are: slowest, slow, normal, fast, fastest.
248
249   NZXT HUE 2
250   NZXT HUE 2 Ambient
251   NZXT Smart Device V2
252       Fan channels (only Smart Device V2): fan[1–3].
253
254       Lighting channels: led[1–2].
255
256       Additional lighting channels (only HUE 2): led[3–4].
257
258       Mode                                    #colors
259       ────────────────────────────────────────────────────────
260       off                                        0
261       fixed                                      1
262       super-fixed                              1–40
263       fading                                    2–8
264       (backwards-)?spectrum-wave                 0
265       (backwards-)?marquee-[3-6]                 1
266       covering-(backwards-)?marquee             1–8
267       alternating-[3-6]                          2
268       (backwards-)?moving-alternating-[3-6]      2
269       pulse                                     1–8
270
271       breathing                                 1–8
272       super-breathing                          1–40
273       candle                                     1
274       starry-night                               1
275       (backwards-)?rainbow-flow                  0
276       (backwards-)?super-rainbow                 0
277       (backwards-)?rainbow-pulse                 0
278       wings                                      1
279
280       When  applicable  the  animation  speed  can be set with --speed=value,
281       where the allowed values are: slowest, slow, normal, fast, fastest.
282

SEE ALSO

284       The complete documentation is available in the  project's  sources  and
285       homepage ⟨https://github.com/jonasmalacofilho/liquidctl⟩.
286
287
288
289liquidctl                         2019-11-17                      LIQUIDCTL(8)
Impressum