xref: /openbmc/phosphor-fan-presence/docs/monitor/class.md (revision 02e7836056816bdffad627b987f34ae773fecc60)
1 # class
2 
3 ## Description
4 A trust group determination class that implements a way to check a group of fan
5 sensors trust state. Each of these 'classes' override a required function that
6 determines if the group is trusted by checking each fan sensors listed within
7 the trust group against an algorithm that returns whether they can be trusted
8 or not.
9 
10 ## Attribute Value(s)
11 * `NonzeroSpeed`
12   * Determines if the group is trusted by checking if any sensors in the group
13   has a nonzero speed. If all sensors report zero, then no sensors in the group
14   are trusted and therefore monitoring of all the sensors in the group is
15   canceled.
16 
17 ## Example
18 <pre><code>
19 {
20   "sensor_trust_groups": [
21     {
22       <b><i>"class": "NonzeroSpeed"</i></b>,
23       "group": [
24         {
25           "name": "fan0_0"
26         },
27         {
28           "name": "fan1_0"
29         },
30         {
31           "name": "fan2_0",
32           "in_trust": false
33         }
34       ]
35     }
36   ]
37 }
38 </code></pre>
39