Skip to content

Thinkfan

services.thinkfan.enable

Whether to enable thinkfan, a fan control program.

::: {.note} This module targets IBM/Lenovo thinkpads by default, for other hardware you will have configure it more carefully. :::

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.extraArgs

A list of extra command line arguments to pass to thinkfan. Check the thinkfan(1) manpage for available arguments.

Type: list of string

Default

[ ]

Example

["-b""0"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.fans

List of fans thinkfan will control.

::: {.note} This section slightly departs from the thinkfan.conf syntax. The type and path must be specified like this:

  type = "tpacpi";
  query = "/proc/acpi/ibm/fan";
instead of a single declaration like:
  - tpacpi: /proc/acpi/ibm/fan
:::

Type: list of (attribute set of (YAML value))

Default

[{query = "/proc/acpi/ibm/fan";type = "tpacpi";}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.fans.*.indices

A list of fans to pick in case multiple fans match the query.

::: {.note} Indices start from 0. :::

Type: null or (list of (unsigned integer, meaning >=0))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.fans.*.query

The query string used to match one or more fans: can be a fullpath to the temperature file (single fan) or a fullpath to a driver directory (multiple fans).

::: {.note} When multiple fans match, the query can be restricted using the {option}name or {option}indices options. :::

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.fans.*.type

The fan type, can be hwmon for standard fans,

atasmart to read the temperature via S.M.A.R.T (requires smartSupport to be enabled),

tpacpi for the legacy thinkpac_acpi driver, or

nvml for the (proprietary) nVidia driver.

Type: one of "hwmon", "atasmart", "tpacpi", "nvml"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.levels

[LEVEL LOW HIGH]

LEVEL is the fan level to use: it can be an integer (0-7 with thinkpad_acpi), "level auto" (to keep the default firmware behavior), "level full-speed" or "level disengaged" (to run the fan as fast as possible). LOW is the temperature at which to step down to the previous level. HIGH is the temperature at which to step up to the next level. All numbers are integers.

Type: list of (tuple of (unsigned integer, meaning >=0, or one of "level auto", "level full-speed", "level disengaged") (unsigned integer, meaning >=0) (unsigned integer, meaning >=0))

Default

[[0055][14860][25061][35263][65665][76085]["level auto"8032767]]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.sensors

List of temperature sensors thinkfan will monitor.

::: {.note} This section slightly departs from the thinkfan.conf syntax. The type and path must be specified like this:

  type = "tpacpi";
  query = "/proc/acpi/ibm/thermal";
instead of a single declaration like:
  - tpacpi: /proc/acpi/ibm/thermal
:::

Type: list of (attribute set of (YAML value))

Default

[{query = "/proc/acpi/ibm/thermal";type = "tpacpi";}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.sensors.*.correction

A list of values to be added to the temperature of each sensor, can be used to equalize small discrepancies in temperature ratings.

Type: null or (list of signed integer)

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.sensors.*.indices

A list of sensors to pick in case multiple sensors match the query.

::: {.note} Indices start from 0. :::

Type: null or (list of (unsigned integer, meaning >=0))

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.sensors.*.query

The query string used to match one or more sensors: can be a fullpath to the temperature file (single sensor) or a fullpath to a driver directory (multiple sensors).

::: {.note} When multiple sensors match, the query can be restricted using the {option}name or {option}indices options. :::

Type: string

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.sensors.*.type

The sensor type, can be hwmon for standard sensors,

atasmart to read the temperature via S.M.A.R.T (requires smartSupport to be enabled),

tpacpi for the legacy thinkpac_acpi driver, or

nvml for the (proprietary) nVidia driver.

Type: one of "hwmon", "atasmart", "tpacpi", "nvml"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.settings

Thinkfan settings. Use this option to configure thinkfan settings not exposed in a NixOS option or to bypass one. Before changing this, read the thinkfan.conf(5) manpage and take a look at the example config file at https://github.com/vmatare/thinkfan/blob/master/examples/thinkfan.yaml

Type: attribute set of (YAML value)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix

services.thinkfan.smartSupport

Whether to build thinkfan with S.M.A.R.T. support to read temperatures directly from hard disks.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/thinkfan.nix