nix-community/plasma-manager
1
1
Fork 0
mirror of https://github.com/nix-community/plasma-manager.git synced 2024-11-29 15:03:49 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add battery options for powerdevil module (#291)
Some checks are pending
GitHub Pages / publish (ubuntu-latest) (push) Waiting to run
Details

Browse Source
This commit is contained in:
magnouvean 2024-07-31 14:22:50 +02:00 committed by GitHub
parent 110d50c34f
commit 43ad09dbd6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 129 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
modules/powerdevil.nix
View File

@ -16,93 +16,146 @@ let
sleep = null; sleep = null;
shutDown = 8; shutDown = 8;
}; };
in
{
config.assertions = [
{
assertion = (cfg.powerdevil.autoSuspend.action != autoSuspendActions.nothing || cfg.powerdevil.autoSuspend.idleTimeout == null);
message = "Setting programs.plasma.powerdevil.autoSuspend.idleTimeout for autosuspend-action \"nothing\" is not supported.";
}
{
assertion = (cfg.powerdevil.turnOffDisplay.idleTimeout != -1 || cfg.powerdevil.turnOffDisplay.idleTimeoutWhenLocked == null);
message = "Setting programs.plasma.powerdevil.turnOffDisplay.idleTimeoutWhenLocked for when idleTimeout is \"never\" is not supported.";
}
];
options = { # Since AC and battery allows the same options we create a function here which
programs.plasma.powerdevil = { # can generate the options by just specifying the type (i.e. "AC" or
powerButtonAction = lib.mkOption { # "battery").
type = with lib.types; nullOr (enum (builtins.attrNames powerButtonActions)); createPowerDevilOptions = type: {
powerButtonAction = lib.mkOption {
type = with lib.types; nullOr (enum (builtins.attrNames powerButtonActions));
default = null;
example = "nothing";
description = ''
The action, when on ${type}, to perform when the power button is pressed.
'';
apply = action: if (action == null) then null else powerButtonActions."${action}";
};
autoSuspend = {
action = lib.mkOption {
type = with lib.types; nullOr (enum (builtins.attrNames autoSuspendActions));
default = null; default = null;
example = "nothing"; example = "nothing";
description = '' description = ''
The action to perform when the power button is pressed. The action, when on ${type}, to perform after a certain period of inactivity.
''; '';
apply = action: if (action == null) then null else powerButtonActions."${action}"; apply = action: if (action == null) then null else autoSuspendActions."${action}";
}; };
autoSuspend = { idleTimeout = lib.mkOption {
action = lib.mkOption { type = with lib.types; nullOr (ints.between 60 600000);
type = with lib.types; nullOr (enum (builtins.attrNames autoSuspendActions)); default = null;
default = null; example = 600;
example = "nothing"; description = ''
description = '' The duration (in seconds), when on ${type}, the computer must be idle
The action to perform after a certain period of inactivity. until the auto-suspend action is executed.
''; '';
apply = action: if (action == null) then null else autoSuspendActions."${action}";
};
idleTimeout = lib.mkOption {
type = with lib.types; nullOr (ints.between 60 600000);
default = null;
example = 600;
description = ''
The duration (in seconds) the computer must be idle until the
auto-suspend action is executed.
'';
};
}; };
turnOffDisplay = { };
idleTimeout = lib.mkOption { turnOffDisplay = {
type = with lib.types; nullOr (either (enum [ "never" ]) (ints.between 30 600000)); idleTimeout = lib.mkOption {
default = null; type = with lib.types; nullOr (either (enum [ "never" ]) (ints.between 30 600000));
example = 300; default = null;
description = '' example = 300;
The duration (in seconds) the computer must be idle (when unlocked) description = ''
until the display turns off. The duration (in seconds), when on ${type}, the computer must be idle
''; (when unlocked) until the display turns off.
apply = timeout: '';
if (timeout == null) then null else apply = timeout:
if (timeout == "never") then -1 if (timeout == null) then null else
else timeout; if (timeout == "never") then -1
}; else timeout;
idleTimeoutWhenLocked = lib.mkOption {
type = with lib.types; nullOr (either (enum [ "whenLockedAndUnlocked" "immediately" ]) (ints.between 20 600000));
default = null;
example = 60;
description = ''
The duration (in seconds) the computer must be idle (when locked)
until the display turns off.
'';
apply = timeout:
if (timeout == null) then null else
if (timeout == "whenLockedAndUnlocked") then -2 else
if (timeout == "immediately") then 0
else timeout;
};
}; };
idleTimeoutWhenLocked = lib.mkOption {
type = with lib.types; nullOr (either (enum [ "whenLockedAndUnlocked" "immediately" ]) (ints.between 20 600000));
default = null;
example = 60;
description = ''
The duration (in seconds), when on ${type}, the computer must be idle
(when locked) until the display turns off.
'';
apply = timeout:
if (timeout == null) then null else
if (timeout == "whenLockedAndUnlocked") then -2 else
if (timeout == "immediately") then 0
else timeout;
};
};
dimDisplay = {
enable = lib.mkOption {
type = with lib.types; nullOr bool;
default = null;
example = false;
description = "Enable or disable screen dimming.";
};
idleTimeOut = lib.mkOption {
type = with lib.types; nullOr (ints.between 20 600000);
default = null;
example = 300;
description = ''
The duration (in seconds), when on ${type}, the computer must be idle
until the display starts dimming.
'';
};
};
};
# By the same logic as createPowerDevilOptions, we can generate the
# configuration. cfgSectName is here the name of the section in powerdevilrc,
# while optionsName is the name of the "namespace" where we should draw the
# options from (i.e. powerdevil.AC or powerdevil.battery).
createPowerDevilConfig = cfgSectName: optionsName: {
"${cfgSectName}/SuspendAndShutdown" = {
PowerButtonAction = cfg.powerdevil.${optionsName}.powerButtonAction;
AutoSuspendAction = cfg.powerdevil.${optionsName}.autoSuspend.action;
AutoSuspendIdleTimeoutSec = cfg.powerdevil.${optionsName}.autoSuspend.idleTimeout;
};
"${cfgSectName}/Display" = {
TurnOffDisplayIdleTimeoutSec = cfg.powerdevil.${optionsName}.turnOffDisplay.idleTimeout;
TurnOffDisplayIdleTimeoutWhenLockedSec = cfg.powerdevil.${optionsName}.turnOffDisplay.idleTimeoutWhenLocked;
DimDisplayWhenIdle =
if (cfg.powerdevil.${optionsName}.dimDisplay.enable != null) then
cfg.powerdevil.${optionsName}.dimDisplay.enable
else if (cfg.powerdevil.${optionsName}.dimDisplay.idleTimeOut != null) then
true
else
null;
DimDisplayIdleTimeoutSec = cfg.powerdevil.${optionsName}.dimDisplay.idleTimeOut;
};
};
in
{
imports = [
(lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "powerButtonAction" ] [ "programs" "plasma" "powerdevil" "AC" "powerButtonAction" ])
(lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "autoSuspend" ] [ "programs" "plasma" "powerdevil" "AC" "autoSuspend" ])
(lib.mkRenamedOptionModule [ "programs" "plasma" "powerdevil" "turnOffDisplay" ] [ "programs" "plasma" "powerdevil" "AC" "turnOffDisplay" ])
];
config.assertions =
let
createAssertions = type: [
{
assertion = (cfg.powerdevil.${type}.autoSuspend.action != autoSuspendActions.nothing || cfg.powerdevil.${type}.autoSuspend.idleTimeout == null);
message = "Setting programs.plasma.powerdevil.${type}.autoSuspend.idleTimeout for autosuspend-action \"nothing\" is not supported.";
}
{
assertion = (cfg.powerdevil.${type}.turnOffDisplay.idleTimeout != -1 || cfg.powerdevil.${type}.turnOffDisplay.idleTimeoutWhenLocked == null);
message = "Setting programs.plasma.powerdevil.${type}.turnOffDisplay.idleTimeoutWhenLocked for idleTimeout \"never\" is not supported.";
}
{
assertion = (cfg.powerdevil.${type}.dimDisplay.enable != false || cfg.powerdevil.${type}.dimDisplay.idleTimeOut == null);
message = "Cannot set programs.plasma.powerdevil.${type}.dimDisplay.idleTimeOut when programs.plasma.powerdevil.${type}.dimDisplay.enable is disabled.";
}
];
in
(createAssertions "AC") ++ (createAssertions "battery");
options = {
programs.plasma.powerdevil = {
AC = (createPowerDevilOptions "AC");
battery = (createPowerDevilOptions "battery");
}; };
}; };
config.programs.plasma.configFile = lib.mkIf cfg.enable { config.programs.plasma.configFile = lib.mkIf cfg.enable {
powerdevilrc = lib.filterAttrs (k: v: v != null) { powerdevilrc = lib.filterAttrs (k: v: v != null) ((createPowerDevilConfig "AC" "AC") // (createPowerDevilConfig "Battery" "battery"));
"AC/SuspendAndShutdown" = {
PowerButtonAction = cfg.powerdevil.powerButtonAction;
AutoSuspendAction = cfg.powerdevil.autoSuspend.action;
AutoSuspendIdleTimeoutSec = cfg.powerdevil.autoSuspend.idleTimeout;
};
"AC/Display" = {
TurnOffDisplayIdleTimeoutSec = cfg.powerdevil.turnOffDisplay.idleTimeout;
TurnOffDisplayIdleTimeoutWhenLockedSec = cfg.powerdevil.turnOffDisplay.idleTimeoutWhenLocked;
};
};
}; };
} }