commit 6f435e54b5fa853027d01f11d88b0c4102970eaf · pyrox.dev/nixpkgs

+66 -22

nixos/modules/services/misc/klipper.nix

···

       5
        
         format = pkgs.formats.ini {

     

       6
        
           # https://github.com/NixOS/nixpkgs/pull/121613#issuecomment-885241996

     

       7
        
           listToValue = l:

     

       8
       -
             if builtins.length l == 1 then generators.mkValueStringDefault {} (head l)

     

       9
        
             else lib.concatMapStrings (s: "\n  ${generators.mkValueStringDefault {} s}") l;

     

       10
       -
           mkKeyValue = generators.mkKeyValueDefault {} ":";

     

       11
        
         };

     

       12
        
       in

     

       13
        
       {

     
···

       69
        
                 for supported values.

     

       70
        
               '';

     

       71
        
             };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       72
        
           };

     

       73
        
         };

     

       74
        
       

     
···

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

     

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

     

       85
        
             }

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       86
        
           ];

     

       87
        
       

     

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

     
···

       92
        
             group = config.services.octoprint.group;

     

       93
        
           };

     

       94
        
       

     

       95
       -
           systemd.services.klipper = let

     

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

     

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

     

       98
       -
           in {

     

       99
       -
             description = "Klipper 3D Printer Firmware";

     

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

     

       101
       -
             after = [ "network.target" ];

     

       0
        
       
     

       0
        
       
     

       102
        
       

     

       103
       -
             serviceConfig = {

     

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

     

       105
       -
               RuntimeDirectory = "klipper";

     

       106
       -
               SupplementaryGroups = [ "dialout" ];

     

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

     

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

     

       109
       -
               Group = cfg.group;

     

       110
       -
               User = cfg.user;

     

       111
       -
             } else {

     

       112
       -
               DynamicUser = true;

     

       113
       -
               User = "klipper";

     

       114
       -
             });

     

       115
       -
           };

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       116
        
         };

     

       117
        
       }

···

       5
        
         format = pkgs.formats.ini {

     

       6
        
           # https://github.com/NixOS/nixpkgs/pull/121613#issuecomment-885241996

     

       7
        
           listToValue = l:

     

       8
       +
             if builtins.length l == 1 then generators.mkValueStringDefault { } (head l)

     

       9
        
             else lib.concatMapStrings (s: "\n  ${generators.mkValueStringDefault {} s}") l;

     

       10
       +
           mkKeyValue = generators.mkKeyValueDefault { } ":";

     

       11
        
         };

     

       12
        
       in

     

       13
        
       {

     
···

       69
        
                 for supported values.

     

       70
        
               '';

     

       71
        
             };

     

       72
       +
       

     

       73
       +
             firmwares = mkOption {

     

       74
       +
               description = "Firmwares klipper should manage";

     

       75
       +
               default = { };

     

       76
       +
               type = with types; attrsOf

     

       77
       +
                 (submodule {

     

       78
       +
                   options = {

     

       79
       +
                     enable = mkEnableOption ''

     

       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
       +
                     '';

     

       83
       +
                     configFile = mkOption {

     

       84
       +
                       type = path;

     

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

     

       86
       +
                     };

     

       87
       +
                   };

     

       88
       +
                 });

     

       89
       +
             };

     

       90
        
           };

     

       91
        
         };

     

       92
        
       

     
···

       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";

     

       107
       +
             }

     

       108
        
           ];

     

       109
        
       

     

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

     
···

       114
        
             group = config.services.octoprint.group;

     

       115
        
           };

     

       116
        
       

     

       117
       +
           systemd.services.klipper =

     

       118
       +
             let

     

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

     

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

     

       121
       +
             in

     

       122
       +
             {

     

       123
       +
               description = "Klipper 3D Printer Firmware";

     

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

     

       125
       +
               after = [ "network.target" ];

     

       126
        
       

     

       127
       +
               serviceConfig = {

     

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

     

       129
       +
                 RuntimeDirectory = "klipper";

     

       130
       +
                 SupplementaryGroups = [ "dialout" ];

     

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

     

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

     

       133
       +
                 Group = cfg.group;

     

       134
       +
                 User = cfg.user;

     

       135
       +
               } else {

     

       136
       +
                 DynamicUser = true;

     

       137
       +
                 User = "klipper";

     

       138
       +
               });

     

       139
       +
             };

     

       140
       +
       

     

       141
       +
           environment.systemPackages =

     

       142
       +
             with pkgs;

     

       143
       +
             let

     

       144
       +
               firmwares = filterAttrs (n: v: v!= null) (mapAttrs

     

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

     

       146
       +
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       147
       +
                   firmwareConfig = configFile;

     

       148
       +
                 } else null)

     

       149
       +
                 cfg.firmwares);

     

       150
       +
               firmwareFlasher = mapAttrsToList

     

       151
       +
                 (mcu: firmware: pkgs.klipper-flash.override {

     

       152
       +
                   mcu = lib.strings.sanitizeDerivationName mcu;

     

       153
       +
                   klipper-firmware = firmware;

     

       154
       +
                   flashDevice = cfg.settings."${mcu}".serial;

     

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

     

       156
       +
                 })

     

       157
       +
                 firmwares;

     

       158
       +
             in

     

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

     

       160
        
         };

     

       161
        
       }

+61

pkgs/servers/klipper/klipper-firmware.nix

···

       1
       +
       { stdenv

     

       2
       +
       , lib

     

       3
       +
       , pkg-config

     

       4
       +
       , pkgsCross

     

       5
       +
       , bintools-unwrapped

     

       6
       +
       , libffi

     

       7
       +
       , libusb1

     

       8
       +
       , wxGTK

     

       9
       +
       , python2

     

       10
       +
       , python3

     

       11
       +
       , gcc-arm-embedded

     

       12
       +
       , klipper

     

       13
       +
       , avrdude

     

       14
       +
       , stm32flash

     

       15
       +
       , mcu ? "mcu"

     

       16
       +
       , firmwareConfig ? ./simulator.cfg

     

       17
       +
       }: stdenv.mkDerivation rec {

     

       18
       +
         name = "klipper-firmware-${mcu}-${version}";

     

       19
       +
         version = klipper.version;

     

       20
       +
         src = klipper.src;

     

       21
       +
       

     

       22
       +
         nativeBuildInputs = [

     

       23
       +
           python2

     

       24
       +
           python3

     

       25
       +
           pkgsCross.avr.stdenv.cc

     

       26
       +
           gcc-arm-embedded

     

       27
       +
           bintools-unwrapped

     

       28
       +
           libffi

     

       29
       +
           libusb1

     

       30
       +
           avrdude

     

       31
       +
           stm32flash

     

       32
       +
           pkg-config

     

       33
       +
           wxGTK # Required for bossac

     

       34
       +
         ];

     

       35
       +
       

     

       36
       +
         preBuild = "cp ${firmwareConfig} ./.config";

     

       37
       +
       

     

       38
       +
         postPatch = ''

     

       39
       +
           patchShebangs .

     

       40
       +
         '';

     

       41
       +
       

     

       42
       +
         makeFlags = [

     

       43
       +
           "V=1"

     

       44
       +
           "KCONFIG_CONFIG=${firmwareConfig}"

     

       45
       +
         ];

     

       46
       +
       

     

       47
       +
         installPhase = ''

     

       48
       +
           mkdir -p $out

     

       49
       +
           cp ./.config $out/config

     

       50
       +
           cp -r out/* $out

     

       51
       +
         '';

     

       52
       +
       

     

       53
       +
         dontFixup = true;

     

       54
       +
       

     

       55
       +
         meta = with lib; {

     

       56
       +
           inherit (klipper.meta) homepage license;

     

       57
       +
           description = "Firmware part of Klipper";

     

       58
       +
           maintainers = with maintainers; [ vtuan10 ];

     

       59
       +
           platforms = platforms.linux;

     

       60
       +
         };

     

       61
       +
       }

+38

pkgs/servers/klipper/klipper-flash.nix

···

       1
       +
       { lib

     

       2
       +
       , writeShellApplication

     

       3
       +
       , gnumake

     

       4
       +
       , pkgsCross

     

       5
       +
       , klipper

     

       6
       +
       , klipper-firmware

     

       7
       +
       , python2

     

       8
       +
       , avrdude

     

       9
       +
       , stm32flash

     

       10
       +
       , mcu ? "mcu"

     

       11
       +
       , flashDevice ? "/dev/null"

     

       12
       +
       , firmwareConfig ? ./simulator.cfg

     

       13
       +
       }:

     

       14
       +
       let

     

       15
       +
         supportedArches = [ "avr" "stm32" "lpc176x" ];

     

       16
       +
         matchBoard = with builtins; match ''^.*CONFIG_BOARD_DIRECTORY="([a-zA-Z0-9_]+)".*$'' (readFile firmwareConfig);

     

       17
       +
         boardArch = if matchBoard == null then null else builtins.head matchBoard;

     

       18
       +
       in

     

       19
       +
       writeShellApplication {

     

       20
       +
         name = "klipper-flash-${mcu}";

     

       21
       +
         runtimeInputs = [

     

       22
       +
           python2

     

       23
       +
           pkgsCross.avr.stdenv.cc

     

       24
       +
           gnumake

     

       25
       +
         ] ++ lib.optionals (boardArch == "avr") [ avrdude ] ++ lib.optionals (boardArch == "stm32") [ stm32flash ];

     

       26
       +
         text = ''

     

       27
       +
           if ${lib.boolToString (!builtins.elem boardArch supportedArches)}; then

     

       28
       +
             printf "Flashing Klipper firmware to your board is not supported yet.\n"

     

       29
       +
             printf "Please use the compiled firmware at ${klipper-firmware} and flash it using the tools provided for your microcontroller."

     

       30
       +
             exit 1

     

       31
       +
           fi

     

       32
       +
           if ${lib.boolToString (boardArch == "stm32")}; then

     

       33
       +
             make -C ${klipper.src} FLASH_DEVICE="${toString flashDevice}" OUT="${klipper-firmware}/" KCONFIG_CONFIG="${klipper-firmware}/config" serialflash

     

       34
       +
           else

     

       35
       +
             make -C ${klipper.src} FLASH_DEVICE="${toString flashDevice}" OUT="${klipper-firmware}/" KCONFIG_CONFIG="${klipper-firmware}/config" flash

     

       36
       +
           fi

     

       37
       +
         '';

     

       38
       +
       }

+21

pkgs/servers/klipper/klipper-genconf.nix

···

       1
       +
       { writeShellApplication

     

       2
       +
       , klipper

     

       3
       +
       , python2

     

       4
       +
       , gnumake

     

       5
       +
       , pkgsCross

     

       6
       +
       }: writeShellApplication {

     

       7
       +
         name = "klipper-genconf";

     

       8
       +
         runtimeInputs = [

     

       9
       +
           python2

     

       10
       +
           pkgsCross.avr.stdenv.cc

     

       11
       +
           gnumake

     

       12
       +
         ];

     

       13
       +
         text = ''

     

       14
       +
           CURRENT_DIR=$(pwd)

     

       15
       +
           TMP=$(mktemp -d)

     

       16
       +
           make -C ${klipper.src} OUT="$TMP" KCONFIG_CONFIG="$CURRENT_DIR/config" menuconfig

     

       17
       +
           rm -rf "$TMP" config.old

     

       18
       +
           printf "\nYour firmware configuration for klipper:\n\n"

     

       19
       +
           cat config

     

       20
       +
         '';

     

       21
       +
       }

+23

pkgs/servers/klipper/simulator.cfg

···

       1
       +
       # CONFIG_LOW_LEVEL_OPTIONS is not set

     

       2
       +
       # CONFIG_MACH_AVR is not set

     

       3
       +
       # CONFIG_MACH_ATSAM is not set

     

       4
       +
       # CONFIG_MACH_ATSAMD is not set

     

       5
       +
       # CONFIG_MACH_LPC176X is not set

     

       6
       +
       # CONFIG_MACH_STM32 is not set

     

       7
       +
       # CONFIG_MACH_RP2040 is not set

     

       8
       +
       # CONFIG_MACH_PRU is not set

     

       9
       +
       # CONFIG_MACH_LINUX is not set

     

       10
       +
       CONFIG_MACH_SIMU=y

     

       11
       +
       CONFIG_BOARD_DIRECTORY="simulator"

     

       12
       +
       CONFIG_CLOCK_FREQ=20000000

     

       13
       +
       CONFIG_SERIAL=y

     

       14
       +
       CONFIG_SIMULATOR_SELECT=y

     

       15
       +
       CONFIG_SERIAL_BAUD=250000

     

       16
       +
       CONFIG_USB_VENDOR_ID=0x1d50

     

       17
       +
       CONFIG_USB_DEVICE_ID=0x614e

     

       18
       +
       CONFIG_USB_SERIAL_NUMBER="12345"

     

       19
       +
       CONFIG_HAVE_GPIO=y

     

       20
       +
       CONFIG_HAVE_GPIO_ADC=y

     

       21
       +
       CONFIG_HAVE_GPIO_SPI=y

     

       22
       +
       CONFIG_HAVE_GPIO_HARD_PWM=y

     

       23
       +
       CONFIG_INLINE_STEPPER_HACK=y

pkgs/top-level/all-packages.nix

···

       4073
        
       

     

       4074
        
         klipper = callPackage ../servers/klipper { };

     

       4075
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       4076
        
         klog = qt5.callPackage ../applications/radio/klog { };

     

       4077
        
       

     

       4078
        
         krapslog = callPackage ../tools/misc/krapslog { };

···

       4073
        
       

     

       4074
        
         klipper = callPackage ../servers/klipper { };

     

       4075
        
       

     

       4076
       +
         klipper-firmware = callPackage ../servers/klipper/klipper-firmware.nix { };

     

       4077
       +
       

     

       4078
       +
         klipper-flash = callPackage ../servers/klipper/klipper-flash.nix { };

     

       4079
       +
       

     

       4080
       +
         klipper-genconf = callPackage ../servers/klipper/klipper-genconf.nix { };

     

       4081
       +
       

     

       4082
        
         klog = qt5.callPackage ../applications/radio/klog { };

     

       4083
        
       

     

       4084
        
         krapslog = callPackage ../tools/misc/krapslog { };