nixos/modules/services/hardware/upower.nix

   1 # Upower daemon.
   2 { config, lib, pkgs, ... }:
   3 let
   4
   5   cfg = config.services.upower;
   6
   7 in
   8
   9 {
  10
  11   ###### interface
  12
  13   options = {
  14
  15     services.upower = {
  16
  17       enable = lib.mkOption {
  18         type = lib.types.bool;
  19         default = false;
  20         description = ''
  21           Whether to enable Upower, a DBus service that provides power
  22           management support to applications.
  23         '';
  24       };
  25
  26       package = lib.mkPackageOption pkgs "upower" { };
  27
  28       enableWattsUpPro = lib.mkOption {
  29         type = lib.types.bool;
  30         default = false;
  31         description = ''
  32           Enable the Watts Up Pro device.
  33
  34           The Watts Up Pro contains a generic FTDI USB device without a specific
  35           vendor and product ID. When we probe for WUP devices, we can cause
  36           the user to get a perplexing "Device or resource busy" error when
  37           attempting to use their non-WUP device.
  38
  39           The generic FTDI device is known to also be used on:
  40
  41           - Sparkfun FT232 breakout board
  42           - Parallax Propeller
  43         '';
  44       };
  45
  46       noPollBatteries = lib.mkOption {
  47         type = lib.types.bool;
  48         default = false;
  49         description = ''
  50           Don't poll the kernel for battery level changes.
  51
  52           Some hardware will send us battery level changes through
  53           events, rather than us having to poll for it. This option
  54           allows disabling polling for hardware that sends out events.
  55         '';
  56       };
  57
  58       ignoreLid = lib.mkOption {
  59         type = lib.types.bool;
  60         default = false;
  61         description = ''
  62           Do we ignore the lid state
  63
  64           Some laptops are broken. The lid state is either inverted, or stuck
  65           on or off. We can't do much to fix these problems, but this is a way
  66           for users to make the laptop panel vanish, a state that might be used
  67           by a couple of user-space daemons. On Linux systems, see also
  68           logind.conf(5).
  69         '';
  70       };
  71
  72       usePercentageForPolicy = lib.mkOption {
  73         type = lib.types.bool;
  74         default = true;
  75         description = ''
  76           Policy for warnings and action based on battery levels
  77
  78           Whether battery percentage based policy should be used. The default
  79           is to use the percentage, which
  80           should work around broken firmwares. It is also more reliable than
  81           the time left (frantically saving all your files is going to use more
  82           battery than letting it rest for example).
  83         '';
  84       };
  85
  86       percentageLow = lib.mkOption {
  87         type = lib.types.ints.unsigned;
  88         default = 20;
  89         description = ''
  90           When `usePercentageForPolicy` is
  91           `true`, the levels at which UPower will consider the
  92           battery low.
  93
  94           This will also be used for batteries which don't have time information
  95           such as that of peripherals.
  96
  97           If any value (of `percentageLow`,
  98           `percentageCritical` and
  99           `percentageAction`) is invalid, or not in descending
 100           order, the defaults will be used.
 101         '';
 102       };
 103
 104       percentageCritical = lib.mkOption {
 105         type = lib.types.ints.unsigned;
 106         default = 5;
 107         description = ''
 108           When `usePercentageForPolicy` is
 109           `true`, the levels at which UPower will consider the
 110           battery critical.
 111
 112           This will also be used for batteries which don't have time information
 113           such as that of peripherals.
 114
 115           If any value (of `percentageLow`,
 116           `percentageCritical` and
 117           `percentageAction`) is invalid, or not in descending
 118           order, the defaults will be used.
 119         '';
 120       };
 121
 122       percentageAction = lib.mkOption {
 123         type = lib.types.ints.unsigned;
 124         default = 2;
 125         description = ''
 126           When `usePercentageForPolicy` is
 127           `true`, the levels at which UPower will take action
 128           for the critical battery level.
 129
 130           This will also be used for batteries which don't have time information
 131           such as that of peripherals.
 132
 133           If any value (of `percentageLow`,
 134           `percentageCritical` and
 135           `percentageAction`) is invalid, or not in descending
 136           order, the defaults will be used.
 137         '';
 138       };
 139
 140       timeLow = lib.mkOption {
 141         type = lib.types.ints.unsigned;
 142         default = 1200;
 143         description = ''
 144           When `usePercentageForPolicy` is
 145           `false`, the time remaining in seconds at which
 146           UPower will consider the battery low.
 147
 148           If any value (of `timeLow`,
 149           `timeCritical` and `timeAction`) is
 150           invalid, or not in descending order, the defaults will be used.
 151         '';
 152       };
 153
 154       timeCritical = lib.mkOption {
 155         type = lib.types.ints.unsigned;
 156         default = 300;
 157         description = ''
 158           When `usePercentageForPolicy` is
 159           `false`, the time remaining in seconds at which
 160           UPower will consider the battery critical.
 161
 162           If any value (of `timeLow`,
 163           `timeCritical` and `timeAction`) is
 164           invalid, or not in descending order, the defaults will be used.
 165         '';
 166       };
 167
 168       timeAction = lib.mkOption {
 169         type = lib.types.ints.unsigned;
 170         default = 120;
 171         description = ''
 172           When `usePercentageForPolicy` is
 173           `false`, the time remaining in seconds at which
 174           UPower will take action for the critical battery level.
 175
 176           If any value (of `timeLow`,
 177           `timeCritical` and `timeAction`) is
 178           invalid, or not in descending order, the defaults will be used.
 179         '';
 180       };
 181
 182       criticalPowerAction = lib.mkOption {
 183         type = lib.types.enum [ "PowerOff" "Hibernate" "HybridSleep" ];
 184         default = "HybridSleep";
 185         description = ''
 186           The action to take when `timeAction` or
 187           `percentageAction` has been reached for the batteries
 188           (UPS or laptop batteries) supplying the computer
 189         '';
 190       };
 191
 192     };
 193
 194   };
 195
 196
 197   ###### implementation
 198
 199   config = lib.mkIf cfg.enable {
 200
 201     environment.systemPackages = [ cfg.package ];
 202
 203     services.dbus.packages = [ cfg.package ];
 204
 205     services.udev.packages = [ cfg.package ];
 206
 207     systemd.packages = [ cfg.package ];
 208
 209     environment.etc."UPower/UPower.conf".text = lib.generators.toINI {} {
 210       UPower = {
 211         EnableWattsUpPro = cfg.enableWattsUpPro;
 212         NoPollBatteries = cfg.noPollBatteries;
 213         IgnoreLid = cfg.ignoreLid;
 214         UsePercentageForPolicy = cfg.usePercentageForPolicy;
 215         PercentageLow = cfg.percentageLow;
 216         PercentageCritical = cfg.percentageCritical;
 217         PercentageAction = cfg.percentageAction;
 218         TimeLow = cfg.timeLow;
 219         TimeCritical = cfg.timeCritical;
 220         TimeAction = cfg.timeAction;
 221         CriticalPowerAction = cfg.criticalPowerAction;
 222       };
 223     };
 224   };
 225
 226 }