Merge pull request #130616 from zhaofengli/klipper-tweaks
nixos/klipper: Tweaks
This commit is contained in:
commit
eb5076a68e
@ -2,7 +2,6 @@
|
|||||||
with lib;
|
with lib;
|
||||||
let
|
let
|
||||||
cfg = config.services.klipper;
|
cfg = config.services.klipper;
|
||||||
package = pkgs.klipper;
|
|
||||||
format = pkgs.formats.ini { mkKeyValue = generators.mkKeyValueDefault {} ":"; };
|
format = pkgs.formats.ini { mkKeyValue = generators.mkKeyValueDefault {} ":"; };
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
@ -11,12 +10,51 @@ in
|
|||||||
services.klipper = {
|
services.klipper = {
|
||||||
enable = mkEnableOption "Klipper, the 3D printer firmware";
|
enable = mkEnableOption "Klipper, the 3D printer firmware";
|
||||||
|
|
||||||
|
package = mkOption {
|
||||||
|
type = types.package;
|
||||||
|
default = pkgs.klipper;
|
||||||
|
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 {
|
octoprintIntegration = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = "Allows Octoprint to control Klipper.";
|
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 {
|
settings = mkOption {
|
||||||
type = format.type;
|
type = format.type;
|
||||||
default = { };
|
default = { };
|
||||||
@ -30,26 +68,40 @@ in
|
|||||||
|
|
||||||
##### implementation
|
##### implementation
|
||||||
config = mkIf cfg.enable {
|
config = mkIf cfg.enable {
|
||||||
assertions = [{
|
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.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;
|
environment.etc."klipper.cfg".source = format.generate "klipper.cfg" cfg.settings;
|
||||||
|
|
||||||
systemd.services.klipper = {
|
services.klipper = mkIf cfg.octoprintIntegration {
|
||||||
|
user = config.services.octoprint.user;
|
||||||
|
group = config.services.octoprint.group;
|
||||||
|
};
|
||||||
|
|
||||||
|
systemd.services.klipper = let
|
||||||
|
klippyArgs = "--input-tty=${cfg.inputTTY}"
|
||||||
|
+ optionalString (cfg.apiSocket != null) " --api-server=${cfg.apiSocket}";
|
||||||
|
in {
|
||||||
description = "Klipper 3D Printer Firmware";
|
description = "Klipper 3D Printer Firmware";
|
||||||
wantedBy = [ "multi-user.target" ];
|
wantedBy = [ "multi-user.target" ];
|
||||||
after = [ "network.target" ];
|
after = [ "network.target" ];
|
||||||
|
|
||||||
serviceConfig = {
|
serviceConfig = {
|
||||||
ExecStart = "${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";
|
RuntimeDirectory = "klipper";
|
||||||
SupplementaryGroups = [ "dialout" ];
|
SupplementaryGroups = [ "dialout" ];
|
||||||
WorkingDirectory = "${package}/lib";
|
WorkingDirectory = "${cfg.package}/lib";
|
||||||
} // (if cfg.octoprintIntegration then {
|
} // (if cfg.user != null then {
|
||||||
Group = config.services.octoprint.group;
|
Group = cfg.group;
|
||||||
User = config.services.octoprint.user;
|
User = cfg.user;
|
||||||
} else {
|
} else {
|
||||||
DynamicUser = true;
|
DynamicUser = true;
|
||||||
User = "klipper";
|
User = "klipper";
|
||||||
|
@ -5,14 +5,14 @@
|
|||||||
, unstableGitUpdater
|
, unstableGitUpdater
|
||||||
}:
|
}:
|
||||||
stdenv.mkDerivation rec {
|
stdenv.mkDerivation rec {
|
||||||
name = "klipper";
|
pname = "klipper";
|
||||||
version = "unstable-2021-01-31";
|
version = "unstable-2021-07-15";
|
||||||
|
|
||||||
src = fetchFromGitHub {
|
src = fetchFromGitHub {
|
||||||
owner = "KevinOConnor";
|
owner = "KevinOConnor";
|
||||||
repo = "klipper";
|
repo = "klipper";
|
||||||
rev = "ef4d9c3abd30ae8a485020fd9ff2fb4529a143b3";
|
rev = "dafb74e3aba707db364ed773bb2135084ac0fffa";
|
||||||
sha256 = "sha256-puAkSGL0DD0JUWejPdzr7zKIW2UP2soBBtgm2msUKzA=";
|
sha256 = "sha256-wF5I8Mo89ohhysBRDMtkCDbCW9SKWrdYdbifmxCPJBc=";
|
||||||
};
|
};
|
||||||
|
|
||||||
# We have no LTO on i686 since commit 22284b0
|
# We have no LTO on i686 since commit 22284b0
|
||||||
@ -51,7 +51,7 @@ stdenv.mkDerivation rec {
|
|||||||
meta = with lib; {
|
meta = with lib; {
|
||||||
description = "The Klipper 3D printer firmware";
|
description = "The Klipper 3D printer firmware";
|
||||||
homepage = "https://github.com/KevinOConnor/klipper";
|
homepage = "https://github.com/KevinOConnor/klipper";
|
||||||
maintainers = with maintainers; [ lovesegfault ];
|
maintainers = with maintainers; [ lovesegfault zhaofengli ];
|
||||||
platforms = platforms.linux;
|
platforms = platforms.linux;
|
||||||
license = licenses.gpl3Only;
|
license = licenses.gpl3Only;
|
||||||
};
|
};
|
||||||
|
Loading…
Reference in New Issue
Block a user