Skip to content

Commit

Permalink
clarifications and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mazunki committed Jun 28, 2024
1 parent 54ad6c6 commit efc0e52
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,9 @@ You can use Amdfan to monitor your AMD video cards using the `monitor` flag. Thi

## Configuration

Running `amdfan print-default --configuration` will dump out the default configuration that would get generated for `/etc/amdfan.yml` when you first run it as a service. Commented
Running `amdfan print-default --configuration` will dump out the default configuration that would get generated for `/etc/amdfan.yml` when you first run it as a service. If a value is not specified, it will use a default value if possible.

The following config is probably a reasonable setup:
``` bash
speed_matrix:
- [4, 4]
Expand All @@ -87,12 +88,13 @@ frequency: 5
# cards:
# - card0
```
You can use this to generate your configuration by doing `amdfan print-default --configuration | sudo tee amdfan.yml`, which you can manually edit.

`speed_matrix` (required): a list of thresholds [temperature, speed] which are interpolated to calculate the fan speed.
`threshold` (default `0`): allows for some leeway in temperatures, as to not constantly change fan speed
`frequency` (default `5`): how often (in seconds) we wait between updates
`cards` (required): a list of card names (from `/sys/class/drm`) which we want to control.
If a configuration file is not found, a default one will be generated. If you want to make any changes to the default config before running it the daemon first, run `amdfan print-default --configuration | sudo tee /etc/amdfan.yml` and do your changes from there.

- `speed_matrix` (required): a list of thresholds `[temperature, speed]` which are interpolated to calculate the fan speed.
- `threshold` (default `0`): allows for some leeway in temperatures, as to not constantly change fan speed
- `frequency` (default `5`): how often (in seconds) we wait between updates
- `cards` (required): a list of card names (from `/sys/class/drm`) which we want to control.

Note! You can send a SIGHUP signal to the daemon to request a reload of the config without restarting the whole service.

Expand Down

0 comments on commit efc0e52

Please sign in to comment.