diff --git a/config-example.yaml b/config-example.yaml index 1dcda25..3ef24c3 100644 --- a/config-example.yaml +++ b/config-example.yaml @@ -1,14 +1,42 @@ +# This example configuration is creating two thermal zones, one with amdgpu/temp1_input as source, +# the other one with coretemp/temp1_input as source. +# Some options have additional comments for explanation. + +# Set target log level. If you have a problem or want to report an issue set this to DEBUG, +# otherwise INFO is a good value. loglevel: DEBUG + +# Set interval in which PyFan is checking your temp sources and adjusts PWM values. interval: 1 thermalzones: - name: GPU+SYSTEM + # This is your source temperature. source: amdgpu/temp1_input + # This is most likely 1000 for your temp sensor as well. + # If not, check what you sensor is outputing if you try to read form it. factor: 1000 + # Define all fans that this thermal zone is going to control. + # There is not limit how many fans one thermal zone can control. + # You can have different limitations on your fans, for example: + # - amdgpu/pwm1: 170 + # means your GPU fan's pwm is never getting set higher than 170, limiting its max. rpm value. + # You can specify an lower limit as well: + # - it8686/pwm1: [100, 200] + # means your fan's pwm is never under 100, and never over 200. fan: - it8686/pwm2 - amdgpu/pwm1: 170 + # This is your target temperature. This one of the main control knobs. Set it to what your thermal zone's temp input + # should be. Don't set this as high as its max temperature allowance, since pid is gonna allow some overshooting. + # This should be a comfortable temperature for your equipment. target: 60 + # For understanding PID please have a look at https://en.wikipedia.org/wiki/PID_controller. The forementioned page + # also explains what p, i and d stand for. These are the second main control knobs. + # Simplified you can view them as: + # p = how heavy should pid weight difference in temperature + # i = how heavy should pid weight difference in temperature over time + # d = how heavy should pid weight rate of chance in temperature pid: p: 1 i: 1