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