Control: Documentaion

[msbarth]

Create basic documentation for how phosphor-fan-presence fan control is configured and works based on configured events.

[nguyenchanh2201]

Great! Current, I'm hard to understand the configuration in YAML event file.

Hi @msbarth, Do you have any document to describe clearly fan control is configured and works?

[msbarth]

At this time, I do not. There's a strategic direction change to move to JSON configuration files in place of YAML which is what I'm working on currently. The best option to understand the configuration in the events.yaml file would be to look at the example yaml file (https://github.com/openbmc/phosphor-fan-presence/blob/master/control/example/events.yaml) and the witherspoon machine configuration that's using fan control (https://github.com/openbmc/openbmc/blob/master/meta-ibm/recipes-phosphor/fans/phosphor-fan-control-events-config/witherspoon/events.yaml)

You can also see the other fan application configurations for the witherspoon machine under (https://github.com/openbmc/openbmc/blob/master/meta-ibm/recipes-phosphor/fans/).

[msbarth]

My plan is to get some documentation out after the conversion to using JSON configuration files is complete. The documentation will only reflect on the use of JSON configuration files which are planned to replace the use of YAML files.

[msbarth]

Current state of documentation for each fan application -> https://github.com/openbmc/phosphor-fan-presence/blob/master/README.md

The fan control application is still undergoing its support of using JSON configuration files and the documentation will be updated to reflect that once complete. The other fan apps have been converted and the use of JSON configuration files has been documented in the readme.

[williamspatrick]

I was looking at docs/control/README.md (after being pointed there by the root README.md) and it is a whole bunch of TBD. It looks like the only examples are over in openbmc/openbmc?