docs/monitor/README.md

5 - [Overview](#overview)
6 - [Data Format](#data-format)
7 - [Example](#example)
8 - [System Config Location](#system-config-location)
9 - [Contents](#contents)
10 - [Validation](#validation)
11 - [Firmware Updates](#firmware-updates)
12 - [Loading and Reloading](#loading-and-reloading)
16 The `phosphor-fan-monitor` application is controlled by a configuration file
22 non-functional due to fan hardware limitations.
34 ## System Config Location
40 `/usr/share/phosphor-fan-presence/monitor/`
42 The supported version of the config file is installed under this read-only
43 directory location as part of the firmware image install. This is where the
48 Where a single config file for 1-or-more system types can be used, the config
51 i.e.) `/usr/share/phosphor-fan-presence/monitor/config.json`
53 #### Compatible System Type Location
55 The config file location can also be based on a system type. This is necessary
56 where more than one type of machine is supported in a single BMC firmware image
57 and those system types can not share a common config file.
59 A system type sub-directory can be obtained from the
60 `Inventory.Decorator.Compatible` D-Bus interface's `Names` property. The
61 property holds a list of one or more compatible system types.
65 - `com.ampere.Hardware.Chassis.Model.MtJade`
66 - `com.ampere.Hardware.Chassis.Model.MtMitchell`
68 The `phosphor-fan-monitor` application then traverses the supported directory,
69 appending each compatible system type entry as a sub-directory on each config
74 1. `/usr/share/phosphor-fan-presence/monitor/com.ampere.Hardware.Chassis.Model.MtJade/`
75    - (directory/config file does not exist)
76 2. `/usr/share/phosphor-fan-presence/monitor/com.ampere.Hardware.Chassis.Model.MtMitchell/config.js…
77    - (config file found)
80 and `phosphor-fan-monitor` application terminates preventing the machine from
85 `/etc/phosphor-fan-presence/monitor/`
89 firmware image on the BMC when changing the configuration, such as for testing
95 `mkdir -p /etc/phosphor-fan-presence/monitor`
99 The `phosphor-fan-monitor` application will search for the config file at the
104    - Default location
105    - Compatible System Type location
113 includes creating error logs and/or powering off the system for a configured
144 - [inventory](inventory.md)
145 - [method](method.md) - \*Optional, default = "timebased"
146 - [deviation](deviation.md)
147 - [num_sensors_nonfunc_for_fan_nonfunc](num_sensors_nonfunc_for_fan_nonfunc.md) -
149 - [monitor_start_delay](monitor_start_delay.md) - Optional, default = 0
150 - [fan_missing_error_delay](fan_missing_error_delay.md) - Optional
151 - [nonfunc_rotor_error_delay](nonfunc_rotor_error_delay.md) - Optional
152 - [set_func_on_present](set_func_on_present.md) - Optional, default = false
153 - [sensors](sensors.md)
157 - [class](class.md)
158 - [group](group.md)
162 - [num_nonfunc_rotors_before_error](num_nonfunc_rotors_before_error.md) -
164 - [power_off_config](power_off_config.md) - Optional
166 \*-See attribute page for more details
184    "Fan monitoring configuration of X-number of fans",
186    "Faults create error logs and power off the system"
207     "comments": "Log errors and power off the system",
217 ## Firmware Updates
219 When a new firmware image is installed on the BMC, it will update the config
222 The override directory will **not** be modified by a firmware update. If a
229 The config file is loaded when the `phosphor-fan-monitor` application starts.
234 `systemctl kill -s HUP phosphor-fan-monitor@0.service`
238 `journalctl -u phosphor-fan-monitor@0.service | grep Loading`