nixpkgs/nixos/modules/services/hardware/openrgb.nix
Funkeleinhorn cf47cb7c10
openrgb: add startupProfile option to service
This commit adds a startupProfile option to the
openrgb service to make it easier to load own color profiles on boot.
2025-08-11 15:47:55 +02:00

79 lines
2.1 KiB
Nix

{
pkgs,
lib,
config,
...
}:
let
cfg = config.services.hardware.openrgb;
in
{
options.services.hardware.openrgb = {
enable = lib.mkEnableOption "OpenRGB server, for RGB lighting control";
package = lib.mkPackageOption pkgs "openrgb" { };
motherboard = lib.mkOption {
type = lib.types.nullOr (
lib.types.enum [
"amd"
"intel"
]
);
default =
if config.hardware.cpu.intel.updateMicrocode then
"intel"
else if config.hardware.cpu.amd.updateMicrocode then
"amd"
else
null;
defaultText = lib.literalMD ''
if config.hardware.cpu.intel.updateMicrocode then "intel"
else if config.hardware.cpu.amd.updateMicrocode then "amd"
else null;
'';
description = "CPU family of motherboard. Allows for addition motherboard i2c support.";
};
server.port = lib.mkOption {
type = lib.types.port;
default = 6742;
description = "Set server port of openrgb.";
};
startupProfile = lib.mkOption {
type = lib.types.nullOr (lib.types.str);
default = null;
description = "The profile file to load from \"/var/lib/OpenRGB\" at startup.";
};
};
config = lib.mkIf cfg.enable {
environment.systemPackages = [ cfg.package ];
services.udev.packages = [ cfg.package ];
boot.kernelModules = [
"i2c-dev"
]
++ lib.optionals (cfg.motherboard == "amd") [ "i2c-piix4" ]
++ lib.optionals (cfg.motherboard == "intel") [ "i2c-i801" ];
systemd.services.openrgb = {
description = "OpenRGB server daemon";
after = [ "network.target" ];
wants = [ "dev-usb.device" ];
wantedBy = [ "multi-user.target" ];
serviceConfig = {
StateDirectory = "OpenRGB";
WorkingDirectory = "/var/lib/OpenRGB";
ExecStart =
"${cfg.package}/bin/openrgb --server --server-port ${toString cfg.server.port}"
+ lib.optionalString (builtins.isString cfg.startupProfile) " --profile ${lib.escapeShellArg cfg.startupProfile}";
Restart = "always";
};
};
};
meta.maintainers = [ ];
}