Skip to content

Commit c98da90

Browse files
Mention DKMS package on AUR and cleanup the device statuses
1 parent e4decd2 commit c98da90

File tree

1 file changed

+24
-36
lines changed

1 file changed

+24
-36
lines changed

README.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
1-
# Linux hwmon kernel drivers for AIOs
1+
# Linux kernel hwmon drivers for AIO liquid coolers and other devices
22

33
The goal of this project is to offer hwmon drivers for closed-loop liquid
4-
coolers and other devices supported by [liquidctl], making all sensor data
4+
coolers and other devices supported by [liquidctl], making their sensor data
55
available in `/sys/class/hwmon/hwmon*`.
66

77
By using the standard hwmon sysfs interface, `sensors`, tools using
88
`libsensors`, as well as programs that read directly from the raw sysfs
9-
interface, will have access to the sensors without needing any specific
10-
knowledge of how the devices work. For more information, read the
9+
interface can access these devices' sensors. For more information, read the
1110
documentation of the [hwmon sysfs interface] and check the [lm-sensors]
1211
repository.
1312

14-
## Building, inserting and installing
13+
## Installing with DKMS
14+
15+
ArchLinux users can try the [liquidtux-dkms-git<sup>AUR</sup>][liquidtux-dkms-git-aur] package.
16+
After the package is installed, manually load the desired drivers:
17+
18+
```
19+
# modprobe krx62 # Kraken X42, X52, X62, X72
20+
# modprobe grdp3 # Smart Device (V1)
21+
```
22+
23+
Those on other distros can experiment with directly using the [dkms.conf] in
24+
that package. It should work with minimal modifications.
25+
26+
## Manually building, inserting and installing
1527

1628
The drivers should be built with the [kbuild
1729
system](https://github.com/torvalds/linux/blob/master/Documentation/kbuild/modules.txt).
@@ -41,41 +53,17 @@ _Note: presumably udev policies can affect that; still looking into this..._
4153

4254
## Device support
4355

44-
This is the current state of the out-of-tree drivers. As they mature they will
45-
be proposed to upstream.
56+
This is the current state of the out-of-tree drivers.
4657

47-
| Device | Summary | Parent | hwmon name |
58+
| Device | State | Parent | hwmon name |
4859
| --- | --- | --- | --- |
49-
| NZXT Kraken X (X42, X52, X62 or X72) | WIP | `hid_device` | `kraken` |
50-
| NZXT Smart Device | WIP | `hid_device` | `smart_device` |
51-
| EVGA CLC (120 CL12, 240 or 280) | enqueued | `usb_interface` ||
52-
53-
All available sensors will eventually be supported:
60+
| NZXT Kraken X42, X52, X62, X72 | hackish but using 24/7 | `hid_device` | `krakenx` |
61+
| NZXT Smart Device (V1) | hackish but using 24/7 | `hid_device` | `smart_device` |
5462

55-
| Device | `temp*` | `fan*` | `pwm*` | `in*` | `curr*` | `*_fault` |
56-
| --- | --- | --- | --- | --- | --- | --- |
57-
| NZXT Kraken X (X42, X52, X62 or X72) | testing | testing | to do ||| to do |
58-
| NZXT Smart Device || testing | to do | testing | testing ||
59-
60-
## Future devices
61-
62-
A few more devices are reasonably well understood and might be supported,
63-
but some help with testing and validation is necessary.
64-
65-
| Device | Summary | Notes |
66-
| --- | --- | --- |
67-
| NZXT Grid+ V3 | considering | similar to NZXT Smart Device |
68-
| Corsair Hydro (H80i v2, H100i v2, H115i) | considering | similar to EVGA CLC |
69-
| Corsair Hydro (H80i GT, H100i GTX, H110i GTX) | considering | might have limitations |
70-
71-
Finally, a few devices are unlikely to be supported:
72-
73-
| Device | Summary | Details |
74-
| --- | --- | --- |
75-
| NZXT Kraken X (X31, X41 or X61) | has quirks | can't read sensor data without changing settings |
76-
| NZXT Kraken M22 | wont add | exposes no sensors |
63+
Once the drivers are mature they will be proposed to upstream.
7764

7865
[liquidctl]: https://github.com/jonasmalacofilho/liquidctl
7966
[hwmon sysfs interface]: https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface
8067
[lm-sensors]: https://github.com/lm-sensors/lm-sensors
81-
68+
[liquidtux-dkms-git-aur]: https://aur.archlinux.org/packages/liquidtux-dkms-git/
69+
[dkms.conf]: https://aur.archlinux.org/cgit/aur.git/tree/dkms.conf?h=liquidtux-dkms-git

0 commit comments

Comments
 (0)