blob: 8695774de5c81b1ac4247e504897f00251ca3b45 [file] [log] [blame]
Patrick Venturee6206562018-03-08 15:36:53 -08001# Sensor Config
2This program is only meant to control fans given thermal sensor readings.
3
4All sensors in phosphor-dbus-interfaces for OpenBMC use Sensor.Value as their
5accessor. This provides read-only access to information. The goal of the
6configuration is to specify how it can be read and if it's a fan, how the PID
7output can be written. Initially there'll only be sysfs and passive dbus
Patrick Venture69c51062019-02-11 09:46:03 -08008access. If a writePath for a sensor is a dbus path, then the system will need
Patrick Venturee6206562018-03-08 15:36:53 -08009to verify which Control.Fan* interfaces is registered and send values to the
10Target property of that interface.
11
12The min/max specified are to range a writePercent to the sensor. The current
13FanController object outputs the new fan speed goal as a PWM percentage. Other
14fan PID control objects may not, and they can leave the fields as 0 & 0.
15
16The only requirement for a sensor is that it isn't writeonly. Only fans are
Patrick Venture69c51062019-02-11 09:46:03 -080017expected to have a writePath set, and in this current version non-fan sensors
Patrick Venturee6206562018-03-08 15:36:53 -080018are assumed readonly.
19
20The sensor names are unique across all zones.
21
22# PID Config
23
Gunnar Mills08afbb22018-06-14 08:50:53 -050024The PID configuration is a list of PIDs per zone.
Patrick Venturee6206562018-03-08 15:36:53 -080025