liquidctl − monitor and control liquid coolers and other devices
|
liquidctl |
[options] list |
|||
|
liquidctl |
[options] initialize [all] |
|||
|
liquidctl |
[options] status |
|||
|
liquidctl |
[options] set channel speed (temperature percentage) ... |
|||
|
liquidctl |
[options] set channel speed percentage |
|||
|
liquidctl |
[options] set channel color mode [color ...] |
|||
|
liquidctl |
−−version |
|||
|
liquidctl |
−−help |
liquidctl is a utility for overseeing and controlling some hardware monitoring devices not yet supported at the kernel level. Because liquidctl directly accesses the hardware devices, root privileges are generally required, though this can be avoided with appropriate udev rules.
liquidctl list outputs all compatible devices found on the system. In case more than one device is found, the desired one can be selected for later invocations with --match=substring, where substring matches part of the desired device’s description using a case insensitive comparison.
liquidctl list −−verbose enables the display of additional identifiers and addresses that can also be used to select specific devices. These can be better suited for certain use cases, such as non-interactive scripts.
liquidctl initialize prepares a device for later commands, and most devices must be initialized after every boot or when resuming from a suspended state. Unless finer control is required, all devices can be initialized at once with liquidctl initialize all. Some devices may output some information at this stage.
liquidctl status displays the status of all devices that match the provided filtering options.
liquidctl set channel speed allows the user to set fan and pump speeds. These, depending on the device, can be set to fixed duty values, variable temperatureâduty curves, or both.
liquidctl set channel color allows the user to configure and set lighting modes. Supported lighting modes and additional options vary by device and are listed in later sections of this manual. Each color can be specified as:
|
• |
hexadecimal RGB with or without prefix ’0x’: ff7f3f; | ||
|
• |
decimal RGB triple, R,G,B â [0, 255]: rgb(255,127,63); | ||
|
• |
hue−saturation−value HSV triple, H â [0, 360], S,V â [0, 100]: hsv(20,75,100); | ||
|
• |
hue−saturation−lightness HSL triple, H â [0, 360], S,L â [0, 100]: hsl(20,100,62). |
liquidctl set channel screen allows the user to configure the LCD screen integrated into some AIO models.
liquidctl automatically detects when a kernel driver is bound to the device and, whenever possible, uses it instead of directly accessing the device. Alternatively, direct access to the device can be forced with −−direct−access.
Devices can be
selected using one or more values taken from list
−−verbose.
−m substring, −−match=substring
Filter devices by case insensitive substring of device description.
−n number, −−pick=number
Pick among many results for a given filter.
−−vendor=id
Filter devices by hexadecimal vendor id.
−−product=id
Filter devices by hexadecimal product id.
−−release=number
Filter devices by hexadecimal release number.
−−serial=number
Filter devices by serial number.
−−bus=bus
Filter devices by bus.
−−address=address
Filter devices by address in bus.
−−usb−port=port
Filter devices by USB port in bus.
−d index, −−device=index
(Deprecated), select device by listing index.
Some devices and
animation modes support additional options.
−−speed=value
Abstract animation speed (device/mode specific).
−−time−per−color=value
Time to wait on each color (seconds).
−−time−off=value
Time to wait with the LED turned off (seconds).
−−alert−threshold=number
Threshold temperature for a visual alert (degrees Celsius).
−−alert−color=color
Color used by the visual high temperature alert.
−−direction=string
If the pattern should move forward or backward.
−−start−led=number
The first led to start the effect at.
−−maximum−leds=number
The number of LED’s the effect should apply to.
−−fan−mode=channel:mode[,...]
Set the fan modes.
−−single−12v−ocp
Enable single rail +12V OCP.
−−pump−mode=mode
Set the pump mode.
−−temperature−sensor=number
The temperature sensor number for the Commander Pro.
−−legacy−690lc
Use Asetek 690LC in legacy mode (old Krakens).
−−non−volatile
Store on non−volatile controller memory.
−−direct−access
Directly access the device despite kernel drivers.
−−unsafe=features
Comman-separated bleeding-edge features to enable.
−v, −−verbose
Output additional information.
−g, −−debug
Show debug information on stderr.
|
−−json |
Output machine-readable JSON. Only supported with list, initialize and status. |
−−version
Display the version number.
|
−−help |
Show the embedded help. |
1 if there was an error, 0 otherwise.
If LANG is set to C, non-ASCII characters are escaped from the output of −−json.
$XDG_RUNTIME_DIR/liquidctl/*, /var/run/liquidctl/*, /tmp/liquidctl/*
Internal data used by some drivers.
|
liquidctl |
list −−verbose |
|||
|
liquidctl |
initialize all |
|||
|
liquidctl |
−−match kraken set pump speed 90 |
|||
|
liquidctl |
−−product 170e set led color fading 350017 ff2608 |
|||
|
liquidctl |
status |
Cooling channels: (D5 Next): fan, pump; (Octo): fan[1−8]; (Quadro:) fan[1−4]; (Farbwerk 360:) not applicable.
Lighting channels: not yet supported.
Cooling channels: fans, fan[1−6]; (only non-XT/Elite Capellix:) pump.
Lighting channels: not yet supported.
Cooling channels (only Commander Pro and Obsidian 1000D): sync, fan[1−6].
Where the fan connection types can be set with −−fan−mode=channel:mode[,...], where the allowed modes are: off, dc, pwm.
Lighting channels: (only Lighting Node Core:) led; (only Commander Pro and Lighting Node Pro:) sync, led[1−2].
When applicable the animation speed can be set with −−speed=value, where the allowed values are: fast, medium, slow.
The animation direction can be set with −−direction=value, where the allowed values are: forward or backward. −−start−led=number, the first LED that the lighting effect should be for. −−start−led=number, the first LED that the lighting effect should be for. −−maximum−led=number, the number of LEDs that the lighting effect should applied to. −−temperature−sensor=number, The temperature sensor that should be used to control the fan curves, probe 1 by default.
Cooling channels: pump, fan.
Lighting channels: logo.
The rainbow mode speed can be configured with −−speed=[1–6]. The speed of the other modes is instead customized with −−time−per−color (fading and blinking) and −−time−off (blinking only).
All modes except blackout support a visual high-temperature alert configured with −−alert−threshold and −−alert−color.
All current settings can be saved on non−volatile on−board memory by passing −−non−volatile to any write command. However, since write−cycles are limited, this option should be used sparingly.
Cooling channels: fan, fan[1–2]; (only H150i Pro:) fan3.
Pump mode (initialize −−pump−mode mode): quiet, balanced (default), performance.
Lighting channel: logo.
Cooling channels: fan, fan[1–2]; (only H150i Pro XT/Elite RGB:) fan3.
Pump mode (initialize −−pump−mode mode): quiet, balanced (default), extreme.
Lighting channels: sync, led.
Supports the same modes and options as a Corsair Hydro H80i GT (or similar), but requires −−legacy−690lc to be passed on all invocations.
Cooling channels (only X42, X52, X62, X72): pump, fan.
Lighting channels: logo, ring, sync.
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with −−direction=value, where the allowed values are: forward or backward.
Cooling channels: pump; (only Z53, Z63, Z73:) fan.
Lighting channels: external; (only X53, X63, X73:) ring, logo, sync.
LCD screens (only Z53, Z63, Z73): lcd.
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with −−direction=value, where the allowed values are: forward or backward.
Cooling channels: fan.
Lighting channels: none.
Setting a fixed fan speed changes the fan mode to software control. To revert back to hardware control, run initialize again.
(Experimental feature) The +12V rails normally function in multiple-rail mode. Single-rail mode can be selected by passing −−single−12v−ocp to initialize. To revert back to multiple-rail mode, run initialize again without that flag.
Cooling channels: none (feature not supported yet).
Lighting channels: none.
Cooling channels: fan[1–6], sync.
Lighting channels: none.
Cooling channels: fan[1–3], sync.
Lighting channels: led.
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with −−direction=value, where the allowed values are: forward or backward.
Cooling channels (only Smart Device V2, RGB & Fan Controller and H1 V2): fan[1–3].
Lighting channels (all but H1 V2): led[1–2], sync.
Additional lighting channels (HUE 2): led[3–4].
Additional lighting channels (RGB & Fan Controller (3+6 channels)): led[3–6].
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest. The animation direction can be set with −−direction=value, where the allowed values are: forward or backward.
Cooling channels: none.
Lighting channels: led.
Cooling channels: none.
Lighting channels: led.
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest.
Cooling channels: none.
Lighting channels: led[1–4], sync.
Cooling channels: none.
Lighting channels: led[1–8], sync.
When applicable the animation speed can be set with −−speed=value, where the allowed values are: slowest, slower, normal, faster, fastest, ludicrous.
Cooling channels: none.
Lighting channels: led.
The complete documentation is available in the project’s sources and homepage.