From bcf9a24332a04ddcef154b792697320d40829820 Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Mon, 1 Jan 2024 16:18:45 -0800 Subject: [PATCH 1/6] handheld-daemon: init at 0.2.7 --- .../manual/release-notes/rl-2405.section.md | 2 + nixos/modules/module-list.nix | 1 + .../services/hardware/handheld-daemon.nix | 43 +++++++++++++++ pkgs/by-name/ha/handheld-daemon/package.nix | 54 +++++++++++++++++++ 4 files changed, 100 insertions(+) create mode 100644 nixos/modules/services/hardware/handheld-daemon.nix create mode 100644 pkgs/by-name/ha/handheld-daemon/package.nix diff --git a/nixos/doc/manual/release-notes/rl-2405.section.md b/nixos/doc/manual/release-notes/rl-2405.section.md index f4434fd6b94c..3ddc2f781bd9 100644 --- a/nixos/doc/manual/release-notes/rl-2405.section.md +++ b/nixos/doc/manual/release-notes/rl-2405.section.md @@ -22,6 +22,8 @@ In addition to numerous new and upgraded packages, this release has the followin +- [Handheld Daemon](https://github.com/hhd-dev/hhd), support for gaming handhelds like the Legion Go, ROG Ally, and GPD Win. Available as [services.handheldDaemon](#opt-services.handheldDaemon.enable). + - [Guix](https://guix.gnu.org), a functional package manager inspired by Nix. Available as [services.guix](#opt-services.guix.enable). - [maubot](https://github.com/maubot/maubot), a plugin-based Matrix bot framework. Available as [services.maubot](#opt-services.maubot.enable). diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index 00e6240f531d..154fd8df2ce0 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -532,6 +532,7 @@ ./services/hardware/fancontrol.nix ./services/hardware/freefall.nix ./services/hardware/fwupd.nix + ./services/hardware/handheld-daemon.nix ./services/hardware/hddfancontrol.nix ./services/hardware/illum.nix ./services/hardware/interception-tools.nix diff --git a/nixos/modules/services/hardware/handheld-daemon.nix b/nixos/modules/services/hardware/handheld-daemon.nix new file mode 100644 index 000000000000..a513ed7ddf8e --- /dev/null +++ b/nixos/modules/services/hardware/handheld-daemon.nix @@ -0,0 +1,43 @@ +{ config +, lib +, pkgs +, ... +}: +with lib; let + cfg = config.services.handheldDaemon; +in +{ + options.services.handheldDaemon = { + enable = mkEnableOption "Enable Handheld Daemon"; + + user = mkOption { + type = types.str; + description = lib.mdDoc '' + The user to run Handheld Daemon with. + ''; + }; + }; + + config = mkIf cfg.enable { + environment.systemPackages = [ pkgs.handheld-daemon ]; + services.udev.packages = [ pkgs.handheld-daemon ]; + systemd.packages = [ pkgs.handheld-daemon ]; + + systemd.services.handheldDaemon = { + description = "Handheld Daemon"; + + wantedBy = [ "multi-user.target" ]; + + restartIfChanged = true; + + serviceConfig = { + ExecStart = "${ pkgs.handheld-daemon }/bin/hhd --user ${ cfg.user }"; + Nice = "-12"; + Restart = "on-failure"; + RestartSec = "10"; + }; + }; + }; + + meta.maintainers = [ maintainers.appsforartists ]; +} diff --git a/pkgs/by-name/ha/handheld-daemon/package.nix b/pkgs/by-name/ha/handheld-daemon/package.nix new file mode 100644 index 000000000000..b8b14d85f45b --- /dev/null +++ b/pkgs/by-name/ha/handheld-daemon/package.nix @@ -0,0 +1,54 @@ +{ config +, fetchFromGitHub +, hidapi +, lib +, python3 +, +}: +python3.pkgs.buildPythonApplication rec { + pname = "handheld-daemon"; + version = "0.2.7"; + format = "pyproject"; + + src = fetchFromGitHub { + owner = "hhd-dev"; + repo = "hhd"; + rev = "ccae6b207cadfbdaef292270c4fc6c855f71ba03"; + hash = "sha256-+tyiXOvZXLbomhgFRKUNKGbkkkOxQKdk/kjeWZ4pvO0="; + }; + + pythonPath = with python3.pkgs; [ + evdev + pyyaml + rich + ]; + + nativeBuildInputs = with python3.pkgs; [ + setuptools + ]; + + propagatedBuildInputs = [ + hidapi + ]; + + # handheld-daemon contains a fork of the python module `hid`, so this hook + # is borrowed from the `hid` derivation. + postPatch = '' + hidapi=${ hidapi }/lib/ + test -d $hidapi || { echo "ERROR: $hidapi doesn't exist, please update/fix this build expression."; exit 1; } + sed -i -e "s|libhidapi|$hidapi/libhidapi|" src/hhd/controller/lib/hid.py + ''; + + postInstall = '' + install -Dm644 $src/usr/lib/udev/rules.d/83-hhd.rules -t $out/lib/udev/rules.d/ + ''; + + meta = with lib; { + homepage = "https://github.com/hhd-dev/hhd/"; + description = "Linux support for gaming handhelds"; + platforms = platforms.linux; + license = licenses.mit; + maintainers = with maintainers; [ appsforartists ]; + mainProgram = "hhd"; + }; +} From 52f22bfc57dff00a93343e30a42e434b68062196 Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Wed, 17 Jan 2024 09:52:06 -0800 Subject: [PATCH 2/6] handheld-daemon: 0.27 -> 1.0.8 --- pkgs/by-name/ha/handheld-daemon/package.nix | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/pkgs/by-name/ha/handheld-daemon/package.nix b/pkgs/by-name/ha/handheld-daemon/package.nix index b8b14d85f45b..f590665a8292 100644 --- a/pkgs/by-name/ha/handheld-daemon/package.nix +++ b/pkgs/by-name/ha/handheld-daemon/package.nix @@ -3,18 +3,17 @@ , hidapi , lib , python3 -, }: python3.pkgs.buildPythonApplication rec { pname = "handheld-daemon"; - version = "0.2.7"; + version = "1.0.8"; format = "pyproject"; src = fetchFromGitHub { owner = "hhd-dev"; repo = "hhd"; - rev = "ccae6b207cadfbdaef292270c4fc6c855f71ba03"; - hash = "sha256-+tyiXOvZXLbomhgFRKUNKGbkkkOxQKdk/kjeWZ4pvO0="; + rev = "6cb83a9833eebc81bd27bed57eb68ece15cdd7a6"; + hash = "sha256-YfBi5UKaB+v+eDI8rcvqkogAYRU2kTc0NqvakhKxBOE="; }; pythonPath = with python3.pkgs; [ From f571033ce013a416c744bd3d3ffc0fe525dbe3a9 Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Sat, 20 Jan 2024 17:56:44 -0800 Subject: [PATCH 3/6] handheld-daemon: use kebab-case instead of camelCase for service name --- nixos/doc/manual/release-notes/rl-2405.section.md | 2 +- nixos/modules/services/hardware/handheld-daemon.nix | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/nixos/doc/manual/release-notes/rl-2405.section.md b/nixos/doc/manual/release-notes/rl-2405.section.md index 3ddc2f781bd9..994f64215461 100644 --- a/nixos/doc/manual/release-notes/rl-2405.section.md +++ b/nixos/doc/manual/release-notes/rl-2405.section.md @@ -22,7 +22,7 @@ In addition to numerous new and upgraded packages, this release has the followin -- [Handheld Daemon](https://github.com/hhd-dev/hhd), support for gaming handhelds like the Legion Go, ROG Ally, and GPD Win. Available as [services.handheldDaemon](#opt-services.handheldDaemon.enable). +- [Handheld Daemon](https://github.com/hhd-dev/hhd), support for gaming handhelds like the Legion Go, ROG Ally, and GPD Win. Available as [services.handheld-daemon](#opt-services.handheld-daemon.enable). - [Guix](https://guix.gnu.org), a functional package manager inspired by Nix. Available as [services.guix](#opt-services.guix.enable). diff --git a/nixos/modules/services/hardware/handheld-daemon.nix b/nixos/modules/services/hardware/handheld-daemon.nix index a513ed7ddf8e..81859bf5b122 100644 --- a/nixos/modules/services/hardware/handheld-daemon.nix +++ b/nixos/modules/services/hardware/handheld-daemon.nix @@ -4,10 +4,10 @@ , ... }: with lib; let - cfg = config.services.handheldDaemon; + cfg = config.services.handheld-daemon; in { - options.services.handheldDaemon = { + options.services.handheld-daemon = { enable = mkEnableOption "Enable Handheld Daemon"; user = mkOption { @@ -23,7 +23,7 @@ in services.udev.packages = [ pkgs.handheld-daemon ]; systemd.packages = [ pkgs.handheld-daemon ]; - systemd.services.handheldDaemon = { + systemd.services.handheld-daemon = { description = "Handheld Daemon"; wantedBy = [ "multi-user.target" ]; From f939675e04ac34d91b2d549a105de4b7b1446255 Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Mon, 22 Jan 2024 11:13:15 -0800 Subject: [PATCH 4/6] handheld-daemon: 1.0.8 -> 1.1.0 --- pkgs/by-name/ha/handheld-daemon/package.nix | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/pkgs/by-name/ha/handheld-daemon/package.nix b/pkgs/by-name/ha/handheld-daemon/package.nix index f590665a8292..e037c4da7086 100644 --- a/pkgs/by-name/ha/handheld-daemon/package.nix +++ b/pkgs/by-name/ha/handheld-daemon/package.nix @@ -1,19 +1,21 @@ { config , fetchFromGitHub , hidapi +, kmod , lib , python3 +, toybox }: python3.pkgs.buildPythonApplication rec { pname = "handheld-daemon"; - version = "1.0.8"; + version = "1.1.0"; format = "pyproject"; src = fetchFromGitHub { owner = "hhd-dev"; repo = "hhd"; - rev = "6cb83a9833eebc81bd27bed57eb68ece15cdd7a6"; - hash = "sha256-YfBi5UKaB+v+eDI8rcvqkogAYRU2kTc0NqvakhKxBOE="; + rev = "abe34c6841476f5b41afe30ee18ff3e510402d68"; + hash = "sha256-ovLC1BQ98jUaDEMPBzWma4TYSzTF+yE/cMemFdJmqlE="; }; pythonPath = with python3.pkgs; [ @@ -22,12 +24,11 @@ python3.pkgs.buildPythonApplication rec { rich ]; - nativeBuildInputs = with python3.pkgs; [ - setuptools - ]; - - propagatedBuildInputs = [ + propagatedBuildInputs = with python3.pkgs; [ hidapi + kmod + setuptools + toybox ]; # handheld-daemon contains a fork of the python module `hid`, so this hook From 3bfa7c5710fd06ba32bf844ca2d414a87308ebea Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Mon, 29 Jan 2024 17:11:48 -0800 Subject: [PATCH 5/6] handheld-daemon: touchup package description --- pkgs/by-name/ha/handheld-daemon/package.nix | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkgs/by-name/ha/handheld-daemon/package.nix b/pkgs/by-name/ha/handheld-daemon/package.nix index e037c4da7086..7df459cc9add 100644 --- a/pkgs/by-name/ha/handheld-daemon/package.nix +++ b/pkgs/by-name/ha/handheld-daemon/package.nix @@ -45,7 +45,7 @@ python3.pkgs.buildPythonApplication rec { meta = with lib; { homepage = "https://github.com/hhd-dev/hhd/"; - description = "Linux support for gaming handhelds"; + description = "Linux support for handheld gaming devices like the Legion Go, ROG Ally, and GPD Win"; platforms = platforms.linux; license = licenses.mit; maintainers = with maintainers; [ appsforartists ]; From b960a217bd351378b01a27f37df9d4b0028570b0 Mon Sep 17 00:00:00 2001 From: Brenton Simpson Date: Mon, 22 Jan 2024 11:12:04 -0800 Subject: [PATCH 6/6] handheld-daemon: touchup code style to better match nixpkgs Co-authored-by: h7x4 Co-authored-by: Luke Granger-Brown Co-authored-by: Bruno BELANYI --- .../services/hardware/handheld-daemon.nix | 9 +++++---- pkgs/by-name/ha/handheld-daemon/package.nix | 16 ++++++++-------- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/nixos/modules/services/hardware/handheld-daemon.nix b/nixos/modules/services/hardware/handheld-daemon.nix index 81859bf5b122..e8a7a39f441d 100644 --- a/nixos/modules/services/hardware/handheld-daemon.nix +++ b/nixos/modules/services/hardware/handheld-daemon.nix @@ -9,6 +9,7 @@ in { options.services.handheld-daemon = { enable = mkEnableOption "Enable Handheld Daemon"; + package = mkPackageOption pkgs "handheld-daemon" { }; user = mkOption { type = types.str; @@ -19,9 +20,9 @@ in }; config = mkIf cfg.enable { - environment.systemPackages = [ pkgs.handheld-daemon ]; - services.udev.packages = [ pkgs.handheld-daemon ]; - systemd.packages = [ pkgs.handheld-daemon ]; + environment.systemPackages = [ cfg.package ]; + services.udev.packages = [ cfg.package ]; + systemd.packages = [ cfg.package ]; systemd.services.handheld-daemon = { description = "Handheld Daemon"; @@ -31,7 +32,7 @@ in restartIfChanged = true; serviceConfig = { - ExecStart = "${ pkgs.handheld-daemon }/bin/hhd --user ${ cfg.user }"; + ExecStart = "${ lib.getExe cfg.package } --user ${ cfg.user }"; Nice = "-12"; Restart = "on-failure"; RestartSec = "10"; diff --git a/pkgs/by-name/ha/handheld-daemon/package.nix b/pkgs/by-name/ha/handheld-daemon/package.nix index 7df459cc9add..bb0c9d65bfe1 100644 --- a/pkgs/by-name/ha/handheld-daemon/package.nix +++ b/pkgs/by-name/ha/handheld-daemon/package.nix @@ -9,28 +9,28 @@ python3.pkgs.buildPythonApplication rec { pname = "handheld-daemon"; version = "1.1.0"; - format = "pyproject"; + pyproject = true; src = fetchFromGitHub { owner = "hhd-dev"; repo = "hhd"; - rev = "abe34c6841476f5b41afe30ee18ff3e510402d68"; + rev = "v${version}"; hash = "sha256-ovLC1BQ98jUaDEMPBzWma4TYSzTF+yE/cMemFdJmqlE="; }; - pythonPath = with python3.pkgs; [ - evdev - pyyaml - rich - ]; - propagatedBuildInputs = with python3.pkgs; [ + evdev hidapi kmod + pyyaml + rich setuptools toybox ]; + # This package doesn't have upstream tests. + doCheck = false; + # handheld-daemon contains a fork of the python module `hid`, so this hook # is borrowed from the `hid` derivation. postPatch = ''