monitor: Update example YAML

Update the YAML documentation with sensor
trust information.

Change-Id: Ia5407b079b5dcfbd4063cec8dbba032fefa11b6b
Signed-off-by: Matt Spinler <spinler@us.ibm.com>

1 files changed, 21 insertions, 1 deletions

diff --git a/monitor/example/monitor.yaml b/monitor/example/monitor.yaml
index b3dd306..67feaab 100644
--- a/monitor/example/monitor.yaml
+++ b/monitor/example/monitor.yaml
@@ -4,7 +4,8 @@
 #properties that define how much slack is allowed in the actual
 #tach value as compared to the target tach value.
 
-#- inventory:
+#fans:
+# - inventory:
 #    [The system inventory location for the fan]
 #  allowed_out_of_range_time:
 #    [Time (in secs) actual speed can be outside of deviation of
@@ -18,14 +19,29 @@
 #    - name [The name of the fan sensor]
 #      has_target [true|false  If this sensor has a Target property for
 #                  setting a fan speed (otherwise just for reads)]
+#
+#sensor_trust_groups:
+# - class: [Group class name
+#           Available classes:
+#           * NonzeroSpeed - Only trust if at least one sensor in the group
+#                            has a nonzero speed.]
+#   sensors:
+#     - name [The name of the fan sensor in this group]
 
 #The code uses these parameters as follows:
 #  After a speed reading of a sensor is outside of the allowed deviation of
 #  the target speed for the allowed out of range time, if at least
 #  num_sensors_nonfunc_for_fan_nonfunc sensors meet this condition,
 #  the fan will be set to nonfunctional in the inventory.
+#
+#  Sensor trust groups are used to specify that the speed values for the
+#  sensors in a group cannot be trusted based on some condition, where
+#  the condition is based on the class used to implement the group.  All
+#  sensors in the group go in and out of trust together.  This section
+#  is optional.
 
 #Example entries for 1 fan system:
+#fans:
 #  - inventory: /system/chassis/motherboard/fan0
 #    allowed_out_of_range_time: 15
 #    deviation: 15
@@ -33,3 +49,7 @@
 #    sensors:
 #      - name: fan0
 #        has_target: true
+#sensor_trust_groups:
+# - class: NonzeroSpeed
+#    sensors:
+#      - name: fan0_0