docs:monitor: Fill in nonfunc_rotor_error_delay details

The `nonfunc_rotor_error_delay` attribute contains the amount of time(in
seconds) to delay logging an error against the fan when any of its
se

docs:monitor: Fill in nonfunc_rotor_error_delay details

The `nonfunc_rotor_error_delay` attribute contains the amount of time(in
seconds) to delay logging an error against the fan when any of its
sensors are deemed nonfunctional. When this attribute is not given, and
the `fault_handling` configuration section does not exist, the default
is to not log an error for any nonfunctional fan sensors. If the
`fault_handling` section exists but this attribute is not given, then it
defaults to immediately log an error for any nonfunctional fan sensors.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Ia39f4ad0b987b2752d2b7820aab5025c1181ab7d

show more ...

docs:monitor: Fill in fan_missing_error_delay details

The `fan_missing_error_delay` attribute contains the amount of time(in
seconds) to delay logging an error against the fan when its not present.

docs:monitor: Fill in fan_missing_error_delay details

The `fan_missing_error_delay` attribute contains the amount of time(in
seconds) to delay logging an error against the fan when its not present.
When this attribute is not given, the default is no error being logged
when the fan is marked as not present.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I52a462e5f339e4404d3523c06695c010cb0de264

show more ...

docs:monitor: Fill in monitor_start_delay attribute details

The `monitor_start_delay` attribute contains the amount of time(in
seconds) to delay from monitoring the fan at the start of powering on
t

docs:monitor: Fill in monitor_start_delay attribute details

The `monitor_start_delay` attribute contains the amount of time(in
seconds) to delay from monitoring the fan at the start of powering on
the system. This defaults to 0, meaning the fan will immediately be
monitored according to its configuration at the start of power on.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Id190723589ee7ffe8bdcc591306c36e3d4554128

show more ...

docs:monitor: Fill in num_sensors_nonfunc_for_fan_nonfunc details

The `num_sensors_nonfunc_for_fan_nonfunc` attribute contains the number
of sensors that must be nonfunctional before the fan contain

docs:monitor: Fill in num_sensors_nonfunc_for_fan_nonfunc details

The `num_sensors_nonfunc_for_fan_nonfunc` attribute contains the number
of sensors that must be nonfunctional before the fan containing those
sensors are nonfunctional. This defaults to 0, meaning that the fan
enclosure's functional state will not be updated based on the functional
state of its sensors.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I0fc646a2819a40115e9d519cc00ecf2bc8aab3a1

show more ...

docs:monitor: Fill in method attribute details

The `method` attribute contains the method to use in monitoring a fan's
functional functional state of its sensors.

Signed-off-by: Matthew Barth <msba

docs:monitor: Fill in method attribute details

The `method` attribute contains the method to use in monitoring a fan's
functional functional state of its sensors.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I1e92b2d927ceee2ae7e5c3ca000b698228d1f814

show more ...

monitor: Deviation attribute details(docs) & enforce range

The `deviation` attribute contains the +/- percentage allowed for the
sensors to deviate from any requested target.

Also enforcing the `de

monitor: Deviation attribute details(docs) & enforce range

The `deviation` attribute contains the +/- percentage allowed for the
sensors to deviate from any requested target.

Also enforcing the `deviation` value provided in the JSON configuration
is between 0 and 100.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I3064e9b407c2edec7fb0fd36a2d1cd3f53d3e397

show more ...

docs:monitor: Fill in inventory attribute details

The `inventory` attribute contains a string of the relative path under
`/xyz/openbmc_project/inventory` where the fan's OperationalStatus
interface

docs:monitor: Fill in inventory attribute details

The `inventory` attribute contains a string of the relative path under
`/xyz/openbmc_project/inventory` where the fan's OperationalStatus
interface exists.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: I6be09429c940fadb28d194c2519cf5afb3d502d9

show more ...

docs:monitor: Configuration content outline

Fill in the fan monitor JSON configuration content and add syntax
detail markdown files for each attribute available. Each attribute's
syntax markdown fil

docs:monitor: Configuration content outline

Fill in the fan monitor JSON configuration content and add syntax
detail markdown files for each attribute available. Each attribute's
syntax markdown file will be completed in follow-up commits to provide
further details on the attribute within the configuration.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Ibe97080c8b993c67c54af9989e775191607314b7

show more ...

docs:presence: Configuration content and syntax

Fill in fan presence JSON configuration content and syntax documentation
for each attribute available in configuring how a fan is detected to be
prese

docs:presence: Configuration content and syntax

Fill in fan presence JSON configuration content and syntax documentation
for each attribute available in configuring how a fan is detected to be
present or not.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: Ie137031b76d956a352967339cd5553d1179bcfa5

show more ...

docs: Initial config details for each fan app

Created initial README.md files for each fan app to outline the details
and the framework of their configuration file(s). This was placed in a
`docs` di

docs: Initial config details for each fan app

Created initial README.md files for each fan app to outline the details
and the framework of their configuration file(s). This was placed in a
`docs` directory instead of each app's directory as the intention is to
have a `src` directory containing all the apps in the future. Additional
details to these READMEs will be added as each fan app solidifies on its
JSON configuration structure and usage.

*Note: A future commit will add all the details to fan presence's README
as the majority of its JSON configuration framework is complete.

*Note: A follow-on commit to this will create a fan monitor JSON
configuration example.

Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
Change-Id: If80a7567fb7a121e8e7dfee3eb0842a6931ecb6b

show more ...