xref: /openbmc/phosphor-fan-presence/docs/monitor/group.md (revision 6d3e18c0ba31a99f31ff053809918c2c4fa304b2)
157caa923SMatthew Barth# group
257caa923SMatthew Barth
357caa923SMatthew Barth## Description
4a49e3f19SPatrick Williams
5a49e3f19SPatrick WilliamsA list of sensor object names to include in determining trust of their values
6a49e3f19SPatrick Williamsbased on the configured [`class`](class.md). These sensors are what's included
7a49e3f19SPatrick Williamsin the group that then has all of their current values trusted or not for
8a49e3f19SPatrick Williamsmonitoring based on algorithm of the [`class`](class.md).
957caa923SMatthew Barth
1057caa923SMatthew Barth## Attribute Value(s)
11a49e3f19SPatrick Williams
12a49e3f19SPatrick Williams- `name` - string
13a49e3f19SPatrick Williams  - The name of the fan tach sensor located under the
14a49e3f19SPatrick Williams    `/xyz/openbmc_project/sensros/fan_tach` D-Bus path.
15a49e3f19SPatrick Williams- `in_trust` - boolean (Optional)
16a49e3f19SPatrick Williams  - By default, the sensor is included in determining trust of the group.
1725b15a99SMatthew Barth    However this can be used to cancel/restart monitoring of a fan tach sensor
1825b15a99SMatthew Barth    but not have it included in the determination of trust.
1957caa923SMatthew Barth
2057caa923SMatthew Barth## Example
21a49e3f19SPatrick Williams
22*6d3e18c0SGeorge Liu```json
2325b15a99SMatthew Barth{
2425b15a99SMatthew Barth  "sensor_trust_groups": [
2525b15a99SMatthew Barth    {
2625b15a99SMatthew Barth      "class": "NonzeroSpeed",
27*6d3e18c0SGeorge Liu      "group": [
2825b15a99SMatthew Barth        {
2925b15a99SMatthew Barth          "name": "fan0_0"
3025b15a99SMatthew Barth        },
3125b15a99SMatthew Barth        {
3225b15a99SMatthew Barth          "name": "fan1_0"
3325b15a99SMatthew Barth        },
3425b15a99SMatthew Barth        {
3525b15a99SMatthew Barth          "name": "fan2_0",
3625b15a99SMatthew Barth          "in_trust": false
3725b15a99SMatthew Barth        }
38*6d3e18c0SGeorge Liu      ]
3925b15a99SMatthew Barth    }
4025b15a99SMatthew Barth  ]
4125b15a99SMatthew Barth}
42*6d3e18c0SGeorge Liu```
43