xref: /openbmc/phosphor-fan-presence/docs/monitor/set_func_on_present.md (revision a3584bd2559e291cf329ff6b4f179ad92b7aeaa0)
1# set_func_on_present
2
3## Description
4If the fan FRU and contained rotors should be set to functional immediately on
5presence being detected.  Any faults will be re-detected.  This attribute is
6optional and defaults to false, meaning a newly inserted fan will need to spin
7up before being set back to functional, and if it never spins up, there won't
8be additional errors.
9
10## Attribute Value(s)
11bool (default = false)
12
13## Example
14<pre><code>
15{
16  "fans": [
17    {
18      "inventory": "/system/chassis/motherboard/fan0",
19      "allowed_out_of_range_time": 30,
20      "functional_delay": 5,
21      "deviation": 15,
22      "num_sensors_nonfunc_for_fan_nonfunc": 1,
23      "monitor_start_delay": 30,
24      "fan_missing_error_delay": 20,
25      "nonfunc_rotor_error_delay": 0,
26      <b><i>"set_func_on_present": true</i></b>,
27      "sensors": [
28        {
29          "name": "fan0_0",
30          "has_target": true
31        },
32        {
33          "name": "fan0_1",
34          "has_target": false,
35          "factor": 1.45,
36          "offset": -909
37        }
38      ]
39    }
40  ]
41}
42</code></pre>
43