Klipper
services.klipper.apiSocket
Path of the API socket to create.
Type: null or path
Default
"/run/klipper/api"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.configFile
Path to default Klipper config.
Type: null or path
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.enable
Whether to enable Klipper, the 3D printer firmware.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.firmwares
Firmwares klipper should manage
Type: attribute set of (submodule)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.firmwares.<name>.configFile
Path to firmware config which is generated using klipper-genconf
Type: path
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.firmwares.<name>.enable
Whether to enable building of firmware for manual flashing
.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.firmwares.<name>.enableKlipperFlash
Whether to enable flashings scripts for firmware. This will add klipper-flash-$mcu
scripts to your environment which can be called to flash the firmware.
Please check the configs at klipper whether your board supports flashing via make flash
.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.firmwares.<name>.serial
Path to serial port this printer is connected to. Leave null
to derive it from service.klipper.settings
.
Type: null or path
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.group
Group account under which Klipper runs.
If null is specified (default), a temporary user will be created by systemd.
Type: null or string
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.inputTTY
Path of the virtual printer symlink to create.
Type: path
Default
"/run/klipper/tty"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.logFile
Path of the file Klipper should log to.
If null
, it logs to stdout, which is not recommended by upstream.
Type: null or path
Default
null
Example
"/var/lib/klipper/klipper.log"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.mutableConfig
Whether to copy the config to a mutable directory instead of using the one directly from the nix store.
This will only copy the config if the file at services.klipper.mutableConfigPath
doesn't exist.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.mutableConfigFolder
Path to mutable Klipper config file.
Type: path
Default
"/var/lib/klipper"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.octoprintIntegration
Allows Octoprint to control Klipper.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.package
The klipper package to use.
Type: package
Default
pkgs.klipper
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.settings
Configuration for Klipper. See the documentation for supported values.
Type: null or (attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string) or a non-empty list of them))
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix
services.klipper.user
User account under which Klipper runs.
If null is specified (default), a temporary user will be created by systemd.
Type: null or string
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/klipper.nix