commit 849c40b5f5071617db0c7bbaa1d3438dd616420d · pyrox.dev/nixpkgs

+68 -10

nixos/modules/services/misc/klipper.nix

···

       35
        
               description = lib.mdDoc "Path of the API socket to create.";

     

       36
        
             };

     

       37
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       38
        
             octoprintIntegration = mkOption {

     

       39
        
               type = types.bool;

     

       40
        
               default = false;

     
···

       62
        
             };

     

       63
        
       

     

       64
        
             settings = mkOption {

     

       65
       -
               type = format.type;

     

       66
       -
               default = { };

     

       67
        
               description = lib.mdDoc ''

     

       68
        
                 Configuration for Klipper. See the [documentation](https://www.klipper3d.org/Overview.html#configuration-and-tuning-guides)

     

       69
        
                 for supported values.

     
···

       80
        
                       building of firmware and addition of klipper-flash tools for manual flashing.

     

       81
        
                       This will add `klipper-flash-$mcu` scripts to your environment which can be called to flash the firmware.

     

       82
        
                     '');

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       83
        
                     configFile = mkOption {

     

       84
        
                       type = path;

     

       85
        
                       description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";

     
···

       95
        
           assertions = [

     

       96
        
             {

     

       97
        
               assertion = cfg.octoprintIntegration -> config.services.octoprint.enable;

     

       98
       -
               message = "Option klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it.";

     

       99
        
             }

     

       100
        
             {

     

       101
        
               assertion = cfg.user != null -> cfg.group != null;

     

       102
       -
               message = "Option klipper.group is not set when a user is specified.";

     

       103
        
             }

     

       104
        
             {

     

       105
       -
               assertion = foldl (a: b: a && b) true (mapAttrsToList (mcu: _: mcu != null -> (hasAttrByPath [ "${mcu}" "serial" ] cfg.settings)) cfg.firmwares);

     

       106
       -
               message = "Option klipper.settings.$mcu.serial must be set when klipper.firmware.$mcu is specified";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       107
        
             }

     

       108
        
           ];

     

       109
        
       

     

       110
       -
           environment.etc."klipper.cfg".source = format.generate "klipper.cfg" cfg.settings;

     

       0
        
       
     

       0
        
       
     

       111
        
       

     

       112
        
           services.klipper = mkIf cfg.octoprintIntegration {

     

       113
        
             user = config.services.octoprint.user;

     
···

       118
        
             let

     

       119
        
               klippyArgs = "--input-tty=${cfg.inputTTY}"

     

       120
        
                 + optionalString (cfg.apiSocket != null) " --api-server=${cfg.apiSocket}";

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       121
        
             in

     

       122
        
             {

     

       123
        
               description = "Klipper 3D Printer Firmware";

     

       124
        
               wantedBy = [ "multi-user.target" ];

     

       125
        
               after = [ "network.target" ];

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       126
        
       

     

       127
        
               serviceConfig = {

     

       128
       -
                 ExecStart = "${cfg.package}/lib/klipper/klippy.py ${klippyArgs} /etc/klipper.cfg";

     

       129
        
                 RuntimeDirectory = "klipper";

     

       0
        
       
     

       130
        
                 SupplementaryGroups = [ "dialout" ];

     

       131
        
                 WorkingDirectory = "${cfg.package}/lib";

     

       132
        
                 OOMScoreAdjust = "-999";

     
···

       134
        
                 CPUSchedulingPriority = 99;

     

       135
        
                 IOSchedulingClass = "realtime";

     

       136
        
                 IOSchedulingPriority = 0;

     

       0
        
       
     

       137
        
               } // (if cfg.user != null then {

     

       138
        
                 Group = cfg.group;

     

       139
        
                 User = cfg.user;

     
···

       146
        
           environment.systemPackages =

     

       147
        
             with pkgs;

     

       148
        
             let

     

       0
        
       
     

       149
        
               firmwares = filterAttrs (n: v: v!= null) (mapAttrs

     

       150
       -
                 (mcu: { enable, configFile }: if enable then pkgs.klipper-firmware.override {

     

       151
        
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       152
        
                   firmwareConfig = configFile;

     

       153
        
                 } else null)

     
···

       156
        
                 (mcu: firmware: pkgs.klipper-flash.override {

     

       157
        
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       158
        
                   klipper-firmware = firmware;

     

       159
       -
                   flashDevice = cfg.settings."${mcu}".serial;

     

       160
        
                   firmwareConfig = cfg.firmwares."${mcu}".configFile;

     

       161
        
                 })

     

       162
        
                 firmwares;

     

       163
        
             in

     

       164
        
             [ klipper-genconf ] ++ firmwareFlasher ++ attrValues firmwares;

     

       165
        
         };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       166
        
       }

···

       35
        
               description = lib.mdDoc "Path of the API socket to create.";

     

       36
        
             };

     

       37
        
       

     

       38
       +
             mutableConfig = mkOption {

     

       39
       +
               type = types.bool;

     

       40
       +
               default = false;

     

       41
       +
               example = true;

     

       42
       +
               description = lib.mdDoc ''

     

       43
       +
                 Whether to copy the config to a mutable directory instead of using the one directly from the nix store.

     

       44
       +
                 This will only copy the config if the file at `services.klipper.mutableConfigPath` doesn't exist.

     

       45
       +
               '';

     

       46
       +
             };

     

       47
       +
       

     

       48
       +
             mutableConfigFolder = mkOption {

     

       49
       +
               type = types.path;

     

       50
       +
               default = "/var/lib/klipper";

     

       51
       +
               description = lib.mdDoc "Path to mutable Klipper config file.";

     

       52
       +
             };

     

       53
       +
       

     

       54
       +
             configFile = mkOption {

     

       55
       +
               type = types.nullOr types.path;

     

       56
       +
               default = null;

     

       57
       +
               description = lib.mdDoc ''

     

       58
       +
                 Path to default Klipper config.

     

       59
       +
               '';

     

       60
       +
             };

     

       61
       +
       

     

       62
        
             octoprintIntegration = mkOption {

     

       63
        
               type = types.bool;

     

       64
        
               default = false;

     
···

       86
        
             };

     

       87
        
       

     

       88
        
             settings = mkOption {

     

       89
       +
               type = types.nullOr format.type;

     

       90
       +
               default = null;

     

       91
        
               description = lib.mdDoc ''

     

       92
        
                 Configuration for Klipper. See the [documentation](https://www.klipper3d.org/Overview.html#configuration-and-tuning-guides)

     

       93
        
                 for supported values.

     
···

       104
        
                       building of firmware and addition of klipper-flash tools for manual flashing.

     

       105
        
                       This will add `klipper-flash-$mcu` scripts to your environment which can be called to flash the firmware.

     

       106
        
                     '');

     

       107
       +
                     serial = mkOption {

     

       108
       +
                       type = types.nullOr path;

     

       109
       +
                       description = lib.mdDoc "Path to serial port this printer is connected to. Leave `null` to derive it from `service.klipper.settings`.";

     

       110
       +
                     };

     

       111
        
                     configFile = mkOption {

     

       112
        
                       type = path;

     

       113
        
                       description = lib.mdDoc "Path to firmware config which is generated using `klipper-genconf`";

     
···

       123
        
           assertions = [

     

       124
        
             {

     

       125
        
               assertion = cfg.octoprintIntegration -> config.services.octoprint.enable;

     

       126
       +
               message = "Option services.klipper.octoprintIntegration requires Octoprint to be enabled on this system. Please enable services.octoprint to use it.";

     

       127
        
             }

     

       128
        
             {

     

       129
        
               assertion = cfg.user != null -> cfg.group != null;

     

       130
       +
               message = "Option services.klipper.group is not set when services.klipper.user is specified.";

     

       131
        
             }

     

       132
        
             {

     

       133
       +
               assertion = cfg.settings != null -> foldl (a: b: a && b) true (mapAttrsToList (mcu: _: mcu != null -> (hasAttrByPath [ "${mcu}" "serial" ] cfg.settings)) cfg.firmwares);

     

       134
       +
               message = "Option services.klipper.settings.$mcu.serial must be set when settings.klipper.firmware.$mcu is specified";

     

       135
       +
             }

     

       136
       +
             {

     

       137
       +
               assertion = (cfg.configFile != null) != (cfg.settings != null);

     

       138
       +
               message = "You need to either specify services.klipper.settings or services.klipper.defaultConfig.";

     

       139
        
             }

     

       140
        
           ];

     

       141
        
       

     

       142
       +
           environment.etc = mkIf (!cfg.mutableConfig) {

     

       143
       +
             "klipper.cfg".source = if cfg.settings != null then format.generate "klipper.cfg" cfg.settings else cfg.configFile;

     

       144
       +
           };

     

       145
        
       

     

       146
        
           services.klipper = mkIf cfg.octoprintIntegration {

     

       147
        
             user = config.services.octoprint.user;

     
···

       152
        
             let

     

       153
        
               klippyArgs = "--input-tty=${cfg.inputTTY}"

     

       154
        
                 + optionalString (cfg.apiSocket != null) " --api-server=${cfg.apiSocket}";

     

       155
       +
               printerConfigPath =

     

       156
       +
                 if cfg.mutableConfig

     

       157
       +
                 then cfg.mutableConfigFolder + "/printer.cfg"

     

       158
       +
                 else "/etc/klipper.cfg";

     

       159
       +
               printerConfigFile =

     

       160
       +
                 if cfg.settings != null

     

       161
       +
                 then format.generate "klipper.cfg" cfg.settings

     

       162
       +
                 else cfg.configFile;

     

       163
        
             in

     

       164
        
             {

     

       165
        
               description = "Klipper 3D Printer Firmware";

     

       166
        
               wantedBy = [ "multi-user.target" ];

     

       167
        
               after = [ "network.target" ];

     

       168
       +
               preStart = ''

     

       169
       +
                 mkdir -p ${cfg.mutableConfigFolder}

     

       170
       +
                 ${lib.optionalString (cfg.mutableConfig) ''

     

       171
       +
                   [ -e ${printerConfigPath} ] || {

     

       172
       +
                     cp ${printerConfigFile} ${printerConfigPath}

     

       173
       +
                     chmod +w ${printerConfigPath}

     

       174
       +
                   }

     

       175
       +
                 ''}

     

       176
       +
                 mkdir -p ${cfg.mutableConfigFolder}/gcodes

     

       177
       +
               '';

     

       178
        
       

     

       179
        
               serviceConfig = {

     

       180
       +
                 ExecStart = "${cfg.package}/lib/klipper/klippy.py ${klippyArgs} ${printerConfigPath}";

     

       181
        
                 RuntimeDirectory = "klipper";

     

       182
       +
                 StateDirectory = "klipper";

     

       183
        
                 SupplementaryGroups = [ "dialout" ];

     

       184
        
                 WorkingDirectory = "${cfg.package}/lib";

     

       185
        
                 OOMScoreAdjust = "-999";

     
···

       187
        
                 CPUSchedulingPriority = 99;

     

       188
        
                 IOSchedulingClass = "realtime";

     

       189
        
                 IOSchedulingPriority = 0;

     

       190
       +
                 UMask = "0002";

     

       191
        
               } // (if cfg.user != null then {

     

       192
        
                 Group = cfg.group;

     

       193
        
                 User = cfg.user;

     
···

       200
        
           environment.systemPackages =

     

       201
        
             with pkgs;

     

       202
        
             let

     

       203
       +
               default = a: b: if a != null then a else b;

     

       204
        
               firmwares = filterAttrs (n: v: v!= null) (mapAttrs

     

       205
       +
                 (mcu: { enable, configFile, serial }: if enable then pkgs.klipper-firmware.override {

     

       206
        
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       207
        
                   firmwareConfig = configFile;

     

       208
        
                 } else null)

     
···

       211
        
                 (mcu: firmware: pkgs.klipper-flash.override {

     

       212
        
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       213
        
                   klipper-firmware = firmware;

     

       214
       +
                   flashDevice = default cfg.firmwares."${mcu}".serial cfg.settings."${mcu}".serial;

     

       215
        
                   firmwareConfig = cfg.firmwares."${mcu}".configFile;

     

       216
        
                 })

     

       217
        
                 firmwares;

     

       218
        
             in

     

       219
        
             [ klipper-genconf ] ++ firmwareFlasher ++ attrValues firmwares;

     

       220
        
         };

     

       221
       +
         meta.maintainers = [

     

       222
       +
           maintainers.cab404

     

       223
       +
         ];

     

       224
        
       }