2 files changed, 77 insertions, 0 deletions

diff --git a/control/example/fans.yaml b/control/example/fans.yaml
new file mode 100644
index 0000000..629c502
--- /dev/null
+++ b/control/example/fans.yaml
@@ -0,0 +1,28 @@
+#Example fan definitions for phosphor-fan-control
+
+#List all fans that need to be known to phosphor-fan-control.
+#For each fan, the inventory path, cooling zone, cooling zone
+#profile, and sensor name(s).
+
+#fans:
+# - inventory: [The system inventory location for the fan]
+#   cooling_zone: [The cooling zone number for the fan]
+#   cooling_profile: [The cooling profile for the fan]
+#   sensors: [The list of sensors for this fan]
+
+#The cooling zone, a number, and the cooling profile, a string,
+#have to match the corresponding values in the fan zone yaml
+#so the fans can be merged into the zone definition.
+
+#Example entries for 2 fan system:
+#fans:
+#  - inventory: /system/chassis/motherboard/fan0
+#    cooling_zone: 0
+#    cooling_profile: all
+#    sensors:
+#     - fan0
+#  - inventory: /system/chassis/motherboard/fan1
+#    cooling_zone: 0
+#    cooling_profile: air
+#    sensors:
+#     - fan1
diff --git a/control/example/zones.yaml b/control/example/zones.yaml
new file mode 100644
index 0000000..5f3b549
--- /dev/null
+++ b/control/example/zones.yaml
@@ -0,0 +1,49 @@
+#Example fan zone definitions for phosphor-fan-control
+
+#List the properties of the fan zones that are possible in the system.
+#The zones may be conditional based on certain conditions, such as
+#different chassis types or water cooled models.  The fans themselves
+#are not listed in this file.  They are in a separate YAML file so it
+#can be machine generated (i.e. from the MRW) if desired.
+
+#The general structure is a list of groups of zones, where a group
+#contains both the zones and the conditions required for the zones
+#to be valid
+
+#The cooling_profile is used along with the zone number to know
+#which fans in the fan yaml belong in this zone instance.  For
+#example, a fan may only be in zone 0 if it's the air cooled version
+#of the system, but not with the water cooled version.  In that
+#case, the fan yaml would have a cooling_profile of 'air' to match
+#the zone cooling profile.
+
+#- zone_conditions:
+#   - name: [Name of a condition, if any.  Valid names are TBD]
+#
+#  zones:
+#    - zone: [zone number]
+#      cooling_profiles:
+#        - [cooling profile]
+#      initial_speed: [Speed to set the zone to when app starts]
+
+#Example:
+#- zone_conditions:
+#  - name: air_cooled_chassis
+#
+#  zones:
+#    - zone: 0
+#      cooling_profiles:
+#      - air
+#      - all
+#      initial_speed: 10500
+#
+#- zone_conditions:
+#  - name: water_and_air_cooled_chassis
+#
+#  zones:
+#    - zone: 0
+#      cooling_profiles:
+#      - water
+#      - all
+#      initial_speed: 4000
+