-
-
Notifications
You must be signed in to change notification settings - Fork 13.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
50 changed files
with
866 additions
and
354 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6529,6 +6529,13 @@ | |
githubId = 46724898; | ||
name = "Erik Backman"; | ||
}; | ||
erikeah = { | ||
email = "[email protected]"; | ||
github = "erikeah"; | ||
githubId = 11900869; | ||
keys = [ { fingerprint = "4142 0380 C7F8 BCDA CC9E 7ABA 0FF3 076B 71F2 5DEF"; } ]; | ||
name = "Erik Alonso"; | ||
}; | ||
erikryb = { | ||
email = "[email protected]"; | ||
github = "erikryb"; | ||
|
@@ -7877,6 +7884,17 @@ | |
githubId = 15957973; | ||
name = "Jeffry Molanus"; | ||
}; | ||
gileri = { | ||
email = "[email protected]"; | ||
github = "gileri"; | ||
githubId = 493438; | ||
name = "Éric Gillet"; | ||
keys = [ | ||
{ | ||
fingerprint = "E478 85DC 8F33 FA86 D3FC 183D 80A8 14DB 8ED5 70BC"; | ||
} | ||
]; | ||
}; | ||
gilice = { | ||
email = "[email protected]"; | ||
github = "gilice"; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,190 @@ | ||
{ | ||
config, | ||
lib, | ||
pkgs, | ||
... | ||
}: | ||
|
||
let | ||
cfg = config.services.kmonad; | ||
|
||
# Per-keyboard options: | ||
keyboard = | ||
{ name, ... }: | ||
{ | ||
options = { | ||
name = lib.mkOption { | ||
type = lib.types.str; | ||
example = "laptop-internal"; | ||
description = "Keyboard name."; | ||
}; | ||
|
||
device = lib.mkOption { | ||
type = lib.types.path; | ||
example = "/dev/input/by-id/some-dev"; | ||
description = "Path to the keyboard's device file."; | ||
}; | ||
|
||
extraGroups = lib.mkOption { | ||
type = lib.types.listOf lib.types.str; | ||
default = [ ]; | ||
description = '' | ||
Extra permission groups to attach to the KMonad instance for | ||
this keyboard. | ||
Since KMonad runs as an unprivileged user, it may sometimes | ||
need extra permissions in order to read the keyboard device | ||
file. If your keyboard's device file isn't in the input | ||
group you'll need to list its group in this option. | ||
''; | ||
}; | ||
|
||
defcfg = { | ||
enable = lib.mkEnableOption '' | ||
Automatically generate the defcfg block. | ||
When this is option is set to true the config option for | ||
this keyboard should not include a defcfg block. | ||
''; | ||
|
||
compose = { | ||
key = lib.mkOption { | ||
type = lib.types.nullOr lib.types.str; | ||
default = "ralt"; | ||
description = "The (optional) compose key to use."; | ||
}; | ||
|
||
delay = lib.mkOption { | ||
type = lib.types.int; | ||
default = 5; | ||
description = "The delay (in milliseconds) between compose key sequences."; | ||
}; | ||
}; | ||
|
||
fallthrough = lib.mkEnableOption "Re-emit unhandled key events."; | ||
|
||
allowCommands = lib.mkEnableOption "Allow keys to run shell commands."; | ||
}; | ||
|
||
config = lib.mkOption { | ||
type = lib.types.lines; | ||
description = "Keyboard configuration."; | ||
}; | ||
}; | ||
|
||
config = { | ||
name = lib.mkDefault name; | ||
}; | ||
}; | ||
|
||
# Create a complete KMonad configuration file: | ||
mkCfg = | ||
keyboard: | ||
let | ||
defcfg = '' | ||
(defcfg | ||
input (device-file "${keyboard.device}") | ||
output (uinput-sink "kmonad-${keyboard.name}") | ||
${ | ||
lib.optionalString (keyboard.defcfg.compose.key != null) '' | ||
cmp-seq ${keyboard.defcfg.compose.key} | ||
cmp-seq-delay ${toString keyboard.defcfg.compose.delay} | ||
'' | ||
} | ||
fallthrough ${lib.boolToString keyboard.defcfg.fallthrough} | ||
allow-cmd ${lib.boolToString keyboard.defcfg.allowCommands} | ||
) | ||
''; | ||
in | ||
pkgs.writeTextFile { | ||
name = "kmonad-${keyboard.name}.cfg"; | ||
text = lib.optionalString keyboard.defcfg.enable (defcfg + "\n") + keyboard.config; | ||
checkPhase = "${cfg.package}/bin/kmonad -d $out"; | ||
}; | ||
|
||
# Build a systemd path config that starts the service below when a | ||
# keyboard device appears: | ||
mkPath = | ||
keyboard: | ||
let | ||
name = "kmonad-${keyboard.name}"; | ||
in | ||
lib.nameValuePair name { | ||
description = "KMonad trigger for ${keyboard.device}"; | ||
wantedBy = [ "paths.target" ]; | ||
pathConfig = { | ||
Unit = "${name}.service"; | ||
PathExists = keyboard.device; | ||
}; | ||
}; | ||
|
||
# Build a systemd service that starts KMonad: | ||
mkService = | ||
keyboard: | ||
let | ||
cmd = [ | ||
(lib.getExe cfg.package) | ||
"--input" | ||
''device-file "${keyboard.device}"'' | ||
] ++ cfg.extraArgs ++ [ "${mkCfg keyboard}" ]; | ||
in | ||
lib.nameValuePair "kmonad-${keyboard.name}" { | ||
description = "KMonad for ${keyboard.device}"; | ||
script = lib.escapeShellArgs cmd; | ||
unitConfig = { | ||
# Control rate limiting. | ||
# Stop the restart logic if we restart more than | ||
# StartLimitBurst times in a period of StartLimitIntervalSec. | ||
StartLimitIntervalSec = 2; | ||
StartLimitBurst = 5; | ||
}; | ||
serviceConfig = { | ||
Restart = "always"; | ||
# Restart at increasing intervals from 2s to 1m | ||
RestartSec = 2; | ||
RestartSteps = 30; | ||
RestartMaxDelaySec = "1min"; | ||
Nice = -20; | ||
DynamicUser = true; | ||
User = "kmonad"; | ||
Group = "kmonad"; | ||
SupplementaryGroups = [ | ||
# These ensure that our dynamic user has access to the device node | ||
config.users.groups.input.name | ||
config.users.groups.uinput.name | ||
] ++ keyboard.extraGroups; | ||
}; | ||
}; | ||
in | ||
{ | ||
options.services.kmonad = { | ||
enable = lib.mkEnableOption "KMonad: An advanced keyboard manager."; | ||
|
||
package = lib.mkPackageOption pkgs "kmonad" { }; | ||
|
||
keyboards = lib.mkOption { | ||
type = lib.types.attrsOf (lib.types.submodule keyboard); | ||
default = { }; | ||
description = "Keyboard configuration."; | ||
}; | ||
|
||
extraArgs = lib.mkOption { | ||
type = lib.types.listOf lib.types.str; | ||
default = [ ]; | ||
example = [ | ||
"--log-level" | ||
"debug" | ||
]; | ||
description = "Extra arguments to pass to KMonad."; | ||
}; | ||
}; | ||
|
||
config = lib.mkIf cfg.enable { | ||
hardware.uinput.enable = true; | ||
|
||
systemd = { | ||
paths = lib.mapAttrs' (_: mkPath) cfg.keyboards; | ||
services = lib.mapAttrs' (_: mkService) cfg.keyboards; | ||
}; | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.