about summary refs log tree commit diff
path: root/nixos/modules/programs/light.nix
blob: b1584a1b3d28c7ff43e4960891bb3a92c18ab6a0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{ config, lib, pkgs, ... }:

with lib;

let
  cfg = config.programs.light;

in
{
  options = {
    programs.light = {

      enable = mkOption {
        default = false;
        type = types.bool;
        description = ''
          Whether to install Light backlight control command
          and udev rules granting access to members of the "video" group.
        '';
      };

      brightnessKeys = {
        enable = mkOption {
          type = types.bool;
          default = false;
          description = ''
            Whether to enable brightness control with keyboard keys.

            This is mainly useful for minimalistic (desktop) environments. You
            may want to leave this disabled if you run a feature-rich desktop
            environment such as KDE, GNOME or Xfce as those handle the
            brightness keys themselves. However, enabling brightness control
            with this setting makes the control independent of X, so the keys
            work in non-graphical ttys, so you might want to consider using this
            instead of the default offered by the desktop environment.

            Enabling this will turn on {option}`services.actkbd`.
          '';
        };

        step = mkOption {
          type = types.int;
          default = 10;
          description = ''
            The percentage value by which to increase/decrease brightness.
          '';
        };

      };

    };
  };

  config = mkIf cfg.enable {
    environment.systemPackages = [ pkgs.light ];
    services.udev.packages = [ pkgs.light ];
    services.actkbd = mkIf cfg.brightnessKeys.enable {
      enable = true;
      bindings = let
        light = "${pkgs.light}/bin/light";
        step = toString cfg.brightnessKeys.step;
      in [
        {
          keys = [ 224 ];
          events = [ "key" ];
          # Use minimum brightness 0.1 so the display won't go totally black.
          command = "${light} -N 0.1 && ${light} -U ${step}";
        }
        {
          keys = [ 225 ];
          events = [ "key" ];
          command = "${light} -A ${step}";
        }
      ];
    };
  };
}