pyrox.dev
lol
Merge pull request #157259 from bb2020/mbpfan
nixos/mbpfan: update documentation
authored by
Aaron Andersen
and committed by
GitHub
63f03d08
694898a7
+14
-8
nixos/modules/services/misc/mbpfan.nix
+14
-8
nixos/modules/services/misc/mbpfan.nix
···
6
6
cfg = config.services.mbpfan;
7
7
verbose = if cfg.verbose then "v" else "";
8
8
settingsFormat = pkgs.formats.ini {};
9
-
settingsFile = settingsFormat.generate "config.conf" cfg.settings;
9
+
settingsFile = settingsFormat.generate "mbpfan.ini" cfg.settings;
10
10
11
11
in {
12
12
options.services.mbpfan = {
···
36
36
freeformType = settingsFormat.type;
37
37
38
38
options.general.min_fan1_speed = mkOption {
39
-
type = types.int;
39
+
type = types.nullOr types.int;
40
40
default = 2000;
41
-
description = "The minimum fan speed.";
41
+
description = ''
42
+
The minimum fan speed. Setting to null enables automatic detection.
43
+
Check minimum fan limits with "cat /sys/devices/platform/applesmc.768/fan*_min".
44
+
'';
42
45
};
43
46
options.general.max_fan1_speed = mkOption {
44
-
type = types.int;
47
+
type = types.nullOr types.int;
45
48
default = 6199;
46
-
description = "The maximum fan speed.";
49
+
description = ''
50
+
The maximum fan speed. Setting to null enables automatic detection.
51
+
Check maximum fan limits with "cat /sys/devices/platform/applesmc.768/fan*_max".
52
+
'';
47
53
};
48
54
options.general.low_temp = mkOption {
49
55
type = types.int;
50
56
default = 55;
51
-
description = "The low temperature.";
57
+
description = "Temperature below which fan speed will be at minimum. Try ranges 55-63.";
52
58
};
53
59
options.general.high_temp = mkOption {
54
60
type = types.int;
55
61
default = 58;
56
-
description = "The high temperature.";
62
+
description = "Fan will increase speed when higher than this temperature. Try ranges 58-66.";
57
63
};
58
64
options.general.max_temp = mkOption {
59
65
type = types.int;
60
66
default = 86;
61
-
description = "The maximum temperature.";
67
+
description = "Fan will run at full speed above this temperature. Do not set it > 90.";
62
68
};
63
69
options.general.polling_interval = mkOption {
64
70
type = types.int;