{"id":18612078,"url":"https://github.com/liquidctl/liquidtux","last_synced_at":"2025-04-06T06:12:02.661Z","repository":{"id":45251674,"uuid":"172545113","full_name":"liquidctl/liquidtux","owner":"liquidctl","description":"Linux kernel hwmon drivers for AIO liquid coolers and other devices","archived":false,"fork":false,"pushed_at":"2025-01-16T22:19:51.000Z","size":173,"stargazers_count":84,"open_issues_count":5,"forks_count":16,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-30T05:07:18.435Z","etag":null,"topics":["hwmon","linux","nzxt"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/liquidctl.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-25T16:45:45.000Z","updated_at":"2025-03-23T14:05:18.000Z","dependencies_parsed_at":"2024-01-19T14:58:50.270Z","dependency_job_id":"779b5952-4374-4d03-afe4-3611a09dbbfd","html_url":"https://github.com/liquidctl/liquidtux","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidctl%2Fliquidtux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidctl%2Fliquidtux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidctl%2Fliquidtux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/liquidctl%2Fliquidtux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/liquidctl","download_url":"https://codeload.github.com/liquidctl/liquidtux/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247441057,"owners_count":20939239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hwmon","linux","nzxt"],"created_at":"2024-11-07T03:15:57.409Z","updated_at":"2025-04-06T06:12:02.641Z","avatar_url":"https://github.com/liquidctl.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# liquidtux\n\n_Linux kernel hwmon drivers for AIO liquid coolers and other devices_\n\nThe goal of this project is to offer hardware monitoring drivers for\nclosed-loop liquid coolers and other devices supported by [liquidctl], making\ntheir sensor data available in `/sys/class/hwmon/hwmon*`.\n\nBy using the standard hwmon sysfs interface, `sensors`, tools using\n`libsensors`, as well as programs that read directly from the raw sysfs\ninterface can access these devices' sensors.  For more information, read the\ndocumentation of the [hwmon sysfs interface] and check the [lm-sensors]\nrepository.\n\n## Device support\n\nAs the drivers mature, they will be proposed to, and hopefully reach, the\nmainline kernel.\n\nThis is the current state of the drivers in regards to this process:\n\n| Device | Driver name | hwmon name | Upstream |\n| --- | --- | --- | --- |\n| NZXT Grid+ V3/Smart Device (V1) | `nzxt-grid3` | `smartdevice` | getting ready to submit | |\n| NZXT Kraken X42/X52/X62/X72 | `nzxt-kraken2` | `kraken2` | in Linux 5.13 ([patch][p-kraken2-v2]) |\n| NZXT Kraken X53/X63/X73, Z53/Z63/Z73, Kraken 2023 (standard, Elite) | `nzxt-kraken3` | `kraken3` | in Linux 6.9 ([patch][p-kraken3]), Kraken 2023 - in Linux 6.10 ([patch][p-kraken2023]) |\n| NZXT Smart Device V2/RGB \u0026 Fan Controller | `nzxt-smart2` | `nzxtsmart2` | in Linux 5.17 ([patch][p-smart2]) |\n\nThis repository contains the latest state of each driver, including features\nand bug fixes that are not yet submitted upstream.\n\n_Note: other hwmon drivers exist in the mainline kernel for devices that\nliquidctl also supports: [`corsair-cpro`], [`corsair-psu`]._\n\n## Installing with DKMS\n\nArchLinux users can try the\n[liquidtux-dkms-git\u003csup\u003eAUR\u003c/sup\u003e][liquidtux-dkms-git-aur]\npackage.  After the package is installed, manually load the desired drivers.\n\n```\n$ sudo modprobe nzxt-grid3              # NZXT Grid+ V3/Smart Device (V1)\n$ sudo modprobe nzxt-kraken2            # NZXT Kraken X42/X52/X62/X72\n$ sudo modprobe nzxt-kraken3            # NZXT Kraken X53/X63/X73, Z53/Z63/Z73, Kraken 2023 (standard, Elite)\n$ sudo modprobe nzxt-smart2             # NZXT Smart Device V2/RGB \u0026 Fan Controller\n```\n\nThose on other distros can install DKMS files using `dkms_install` `Makefile`\ntarget:\n\n```\n$ sudo make dkms_install\n```\n\nThen build and install the modules using:\n\n```\n$ sudo dkms install -m liquidtux -v $(./gitversion.sh)\n```\n\nAlso, `dkms_install` supports `DESTDIR` variable, so it could be used for\nbuilding distribution-specific packages.\n\n## Manually building, inserting and installing\n\nThe drivers should be built with the [kbuild system].\n\nA simple Makefile is provided that simplifies this in normal scenarios.  The\nbuilt modules can then be loaded with `insmod`.\n\n```\n$ make\n$ sudo insmod drivers/hwmon/nzxt-grid3.ko         # NZXT Grid+ V3/Smart Device (V1)\n$ sudo insmod drivers/hwmon/nzxt-kraken2.ko       # NZXT Kraken X42/X52/X62/X72\n$ sudo insmod drivers/hwmon/nzxt-kraken3.ko       # NZXT Kraken X53/X63/X73, Z53/Z63/Z73, Kraken 2023 (standard, Elite)\n$ sudo insmod drivers/hwmon/nzxt-smart2.ko        # NZXT Smart Device V2/RGB \u0026 Fan Controller\n```\n\nTo unload them, use `rmmod` or `modprobe -r`.\n\nIf testing was successful the modules can be installed to the system with the\n`modules_install` target:\n\n```\n$ sudo make modules_install\n```\n\n[`corsair-cpro`]: https://www.kernel.org/doc/html/latest/hwmon/corsair-cpro.html\n[`corsair-psu`]: https://www.kernel.org/doc/html/latest/hwmon/corsair-psu.html\n[dkms.conf]: dkms.conf\n[hwmon sysfs interface]: https://www.kernel.org/doc/Documentation/hwmon/sysfs-interface\n[kbuild system]: https://github.com/torvalds/linux/blob/master/Documentation/kbuild/modules.txt\n[liquidctl]: https://github.com/jonasmalacofilho/liquidctl\n[liquidtux-dkms-git-aur]: https://aur.archlinux.org/packages/liquidtux-dkms-git/\n[lm-sensors]: https://github.com/lm-sensors/lm-sensors\n[p-kraken2-v2]: https://patchwork.kernel.org/project/linux-hwmon/patch/20210319045544.416138-1-jonas@protocubo.io/\n[p-kraken3]: https://patchwork.kernel.org/project/linux-hwmon/patch/20240129111932.368232-1-savicaleksa83@gmail.com/\n[p-kraken2023]: https://patchwork.kernel.org/project/linux-hwmon/patch/20240428104812.14037-3-savicaleksa83@gmail.com/\n[p-smart2]: https://patchwork.kernel.org/project/linux-hwmon/patch/20211031033058.151014-1-mezin.alexander@gmail.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliquidctl%2Fliquidtux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliquidctl%2Fliquidtux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliquidctl%2Fliquidtux/lists"}