Improve config documentation #1

Closed
opened 2020-03-01 19:05:58 +01:00 by terence · 6 comments

Hi, I'm coming from lm_sensors fancontrol and I'm having a hard time understanding how the configuration works.

Would it be possible to:

  • Put a top comment in config-example.yaml to know what this particular example does in practice.
  • Explain the configuration structure i.e. what thermal zones are, what pid achieves and how to configure it.
  • Write a small explanation for all the different options (loglevel, interval, factor, target, source...).
Hi, I'm coming from lm_sensors `fancontrol` and I'm having a hard time understanding how the configuration works. Would it be possible to: - Put a top comment in config-example.yaml to know what this particular example does in practice. - Explain the configuration structure i.e. what thermal zones are, what pid achieves and how to configure it. - Write a small explanation for all the different options (loglevel, interval, factor, target, source...).
Owner

I agree the sample config is little documented. I'm gonna revisit that and add comments.

I agree the sample config is little documented. I'm gonna revisit that and add comments.
Owner

Done, please have a look. I'm no expert in PID control mechanism, but I tried my best.

If you feel something is not quite right I'm happy to accept a pull request as well.

Done, please have a look. I'm no expert in PID control mechanism, but I tried my best. If you feel something is not quite right I'm happy to accept a pull request as well.
Author

Much better indeed :) This allowed me to configure it correctly, thanks!

I didn't know what PID was before so that's ok. Maybe you could in the README propose 3 different PID settings explaning what will they do differently?

Also in the README, you might want to briefly explain that you configure "thermal_zones", that is, how certain fans behave based on one temperature source. So if you want some fans to react differently with another temperature source, you need to create a new thermal_zone

One nitpick: shoudln't fan be renamed to fans as there can be multiple, like thermalzones ?

Much better indeed :) This allowed me to configure it correctly, thanks! I didn't know what PID was before so that's ok. Maybe you could in the README propose 3 different PID settings explaning what will they do differently? Also in the README, you might want to briefly explain that you configure "thermal_zones", that is, how certain fans behave based on one temperature source. So if you want some fans to react differently with another temperature source, you need to create a new thermal_zone One nitpick: shoudln't `fan` be renamed to `fans` as there can be multiple, like `thermalzones` ?
Author

Oh and also mention that interval is in seconds.

Oh and also mention that `interval` is in seconds.
Author

One weird thing: I see fans do a lot of ups and downs (going from 1500 RPM to 1200 RPM to 1500 RPM in 2 seconds) when the temp is at 57 and the target is 50:
image

I set the fans like so:

- it8665/pwm2: [90, 255]
- it8665/pwm3: [100, 255]

Does this mean I need to tweak the PID values? And is so what can I try?

Another thing: I notice the RPM is almost exactly the same for fan2 and fan3 but shouldn't it be different because of the different min value set for pwm?

One weird thing: I see fans do a lot of ups and downs (going from 1500 RPM to 1200 RPM to 1500 RPM in 2 seconds) when the temp is at 57 and the target is 50: ![image](/attachments/2b658ee2-219f-463d-bde9-55b496431007) I set the fans like so: ``` - it8665/pwm2: [90, 255] - it8665/pwm3: [100, 255] ``` Does this mean I need to tweak the PID values? And is so what can I try? Another thing: I notice the RPM is almost exactly the same for fan2 and fan3 but shouldn't it be different because of the different min value set for pwm?
562 KiB
Owner

Can you open a seperate issue for that? I'm closing this for now, since its more or less done. Maybe I write up a proper man page later, if I find time, but this should be enough for now.

Can you open a seperate issue for that? I'm closing this for now, since its more or less done. Maybe I write up a proper man page later, if I find time, but this should be enough for now.
Sign in to join this conversation.
No Label
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anonfunc/PyFan#1
No description provided.