From 942d45f74e994725c27d085a30c25d6615780bdc Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Sun, 18 Jul 2021 21:34:45 -0700 Subject: [PATCH 1/4] klipper: unstable-2021-01-31 -> unstable-2021-07-15 --- pkgs/servers/klipper/default.nix | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pkgs/servers/klipper/default.nix b/pkgs/servers/klipper/default.nix index 63ad531bbefe..f120454ac84a 100644 --- a/pkgs/servers/klipper/default.nix +++ b/pkgs/servers/klipper/default.nix @@ -5,14 +5,14 @@ , unstableGitUpdater }: stdenv.mkDerivation rec { - name = "klipper"; - version = "unstable-2021-01-31"; + pname = "klipper"; + version = "unstable-2021-07-15"; src = fetchFromGitHub { owner = "KevinOConnor"; repo = "klipper"; - rev = "ef4d9c3abd30ae8a485020fd9ff2fb4529a143b3"; - sha256 = "sha256-puAkSGL0DD0JUWejPdzr7zKIW2UP2soBBtgm2msUKzA="; + rev = "dafb74e3aba707db364ed773bb2135084ac0fffa"; + sha256 = "sha256-wF5I8Mo89ohhysBRDMtkCDbCW9SKWrdYdbifmxCPJBc="; }; # We have no LTO on i686 since commit 22284b0 @@ -51,7 +51,7 @@ stdenv.mkDerivation rec { meta = with lib; { description = "The Klipper 3D printer firmware"; homepage = "https://github.com/KevinOConnor/klipper"; - maintainers = with maintainers; [ lovesegfault ]; + maintainers = with maintainers; [ lovesegfault zhaofengli ]; platforms = platforms.linux; license = licenses.gpl3Only; }; From 94536fd6e33afaedab5ddfc36831cfc1c5b87508 Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Sun, 18 Jul 2021 21:34:45 -0700 Subject: [PATCH 2/4] nixos/klipper: Allow specifying arbitrary user/group This paves the way for alternative integrations such as Moonraker. --- nixos/modules/services/misc/klipper.nix | 45 +++++++++++++++++++++---- 1 file changed, 38 insertions(+), 7 deletions(-) diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index 2f04c011a650..df5b527a069a 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -17,6 +17,26 @@ in description = "Allows Octoprint to control Klipper."; }; + user = mkOption { + type = types.nullOr types.str; + default = null; + description = '' + User account under which Klipper runs. + + If null is specified (default), a temporary user will be created by systemd. + ''; + }; + + group = mkOption { + type = types.nullOr types.str; + default = null; + description = '' + Group account under which Klipper runs. + + If null is specified (default), a temporary user will be created by systemd. + ''; + }; + settings = mkOption { type = format.type; default = { }; @@ -30,13 +50,24 @@ in ##### implementation config = mkIf cfg.enable { - assertions = [{ - assertion = cfg.octoprintIntegration -> config.services.octoprint.enable; - message = "Option klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it."; - }]; + assertions = [ + { + assertion = cfg.octoprintIntegration -> config.services.octoprint.enable; + message = "Option klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it."; + } + { + assertion = cfg.user != null -> cfg.group != null; + message = "Option klipper.group is not set when a user is specified."; + } + ]; environment.etc."klipper.cfg".source = format.generate "klipper.cfg" cfg.settings; + services.klipper = mkIf cfg.octoprintIntegration { + user = config.services.octoprint.user; + group = config.services.octoprint.group; + }; + systemd.services.klipper = { description = "Klipper 3D Printer Firmware"; wantedBy = [ "multi-user.target" ]; @@ -47,9 +78,9 @@ in RuntimeDirectory = "klipper"; SupplementaryGroups = [ "dialout" ]; WorkingDirectory = "${package}/lib"; - } // (if cfg.octoprintIntegration then { - Group = config.services.octoprint.group; - User = config.services.octoprint.user; + } // (if cfg.user != null then { + Group = cfg.group; + User = cfg.user; } else { DynamicUser = true; User = "klipper"; From 11313bc65d5c7d15089caf7cef8ecfd037353639 Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Sun, 18 Jul 2021 21:34:45 -0700 Subject: [PATCH 3/4] nixos/klipper: Allow overriding the Klipper package --- nixos/modules/services/misc/klipper.nix | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index df5b527a069a..41f77da35480 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -2,7 +2,6 @@ with lib; let cfg = config.services.klipper; - package = pkgs.klipper; format = pkgs.formats.ini { mkKeyValue = generators.mkKeyValueDefault {} ":"; }; in { @@ -11,6 +10,12 @@ in services.klipper = { enable = mkEnableOption "Klipper, the 3D printer firmware"; + package = mkOption { + type = types.package; + default = pkgs.klipper; + description = "The Klipper package."; + }; + octoprintIntegration = mkOption { type = types.bool; default = false; @@ -74,10 +79,10 @@ in after = [ "network.target" ]; serviceConfig = { - ExecStart = "${package}/lib/klipper/klippy.py --input-tty=/run/klipper/tty /etc/klipper.cfg"; + ExecStart = "${cfg.package}/lib/klipper/klippy.py --input-tty=/run/klipper/tty /etc/klipper.cfg"; RuntimeDirectory = "klipper"; SupplementaryGroups = [ "dialout" ]; - WorkingDirectory = "${package}/lib"; + WorkingDirectory = "${cfg.package}/lib"; } // (if cfg.user != null then { Group = cfg.group; User = cfg.user; From 0c8307882586e3072be83d88302b4363dffef755 Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Sun, 18 Jul 2021 21:34:45 -0700 Subject: [PATCH 4/4] nixos/klipper: Allow configuring --input-tty and --api-server This also makes it easy for other modules to get the correct path to the virtual printer. --- nixos/modules/services/misc/klipper.nix | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/nixos/modules/services/misc/klipper.nix b/nixos/modules/services/misc/klipper.nix index 41f77da35480..4930648ba8e3 100644 --- a/nixos/modules/services/misc/klipper.nix +++ b/nixos/modules/services/misc/klipper.nix @@ -16,6 +16,19 @@ in description = "The Klipper package."; }; + inputTTY = mkOption { + type = types.path; + default = "/run/klipper/tty"; + description = "Path of the virtual printer symlink to create."; + }; + + apiSocket = mkOption { + type = types.nullOr types.path; + default = null; + example = "/run/klipper/api"; + description = "Path of the API socket to create."; + }; + octoprintIntegration = mkOption { type = types.bool; default = false; @@ -73,13 +86,16 @@ in group = config.services.octoprint.group; }; - systemd.services.klipper = { + systemd.services.klipper = let + klippyArgs = "--input-tty=${cfg.inputTTY}" + + optionalString (cfg.apiSocket != null) " --api-server=${cfg.apiSocket}"; + in { description = "Klipper 3D Printer Firmware"; wantedBy = [ "multi-user.target" ]; after = [ "network.target" ]; serviceConfig = { - ExecStart = "${cfg.package}/lib/klipper/klippy.py --input-tty=/run/klipper/tty /etc/klipper.cfg"; + ExecStart = "${cfg.package}/lib/klipper/klippy.py ${klippyArgs} /etc/klipper.cfg"; RuntimeDirectory = "klipper"; SupplementaryGroups = [ "dialout" ]; WorkingDirectory = "${cfg.package}/lib";