docs/presence/README.md

1 # Fan Presence Configuration File
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-presence-tach` application is controlled by a configuration
18 `xyz.openbmc_project.Inventory.Item` interface for fan inventory objects. The
20 presence of each fan within a machine.
30 See [config.json](../../presence/example/config.json).
38 `/usr/share/phosphor-fan-presence/presence/`
40 The supported version of the config file is installed under this read-only
46 Where a single config file for 1-or-more system types can be used, the config
49 i.e.) `/usr/share/phosphor-fan-presence/presence/config.json`
57 A system type sub-directory can be obtained from the
58 `Inventory.Decorator.Compatible` D-Bus interface's `Names` property. The
63 - `com.ampere.Hardware.Chassis.Model.MtJade`
64 - `com.ampere.Hardware.Chassis.Model.MtMitchell`
66 The `phosphor-fan-presence-tach` application then traverses the supported
67 directory, appending each compatible system type entry as a sub-directory on
72 1. `/usr/share/phosphor-fan-presence/presence/com.ampere.Hardware.Chassis.Model.MtJade/`
73    - (directory/config file does not exist)
74 2. `/usr/share/phosphor-fan-presence/presence/com.ampere.Hardware.Chassis.Model.MtMitchell/config.j…
75    - (config file found)
78 and `phosphor-fan-presence-tach` application terminates preventing the machine
83 `/etc/phosphor-fan-presence/presence/`
93 `mkdir -p /etc/phosphor-fan-presence/presence`
97 The `phosphor-fan-presence-tach` application will search for the config file at
102    - Default location
103    - Compatible System Type location
109 The config file consists of an array of fan objects that define how their
110 presence is detected and the policy used to update its present state within
138 Fan object attributes: **(Required unless otherwise noted)**
140 - [name](name.md)
141 - [path](path.md)
142 - [methods](methods.md)
143 - [rpolicy](rpolicy.md)
144 - [eeprom](eeprom.md) _optional_
163       "First fan in the system",
164       "Uses two methods of presence detection"
170         "comments": "Use GPIO for presence detection",
177         "comments": "Also use the tach for presence detection",
205 fan presence configuration instead of the config file located under the
210 The config file is loaded when the `phosphor-fan-presence-tach` application
216 `systemctl kill -s HUP phosphor-fan-presence-tach@0.service`
220 `journalctl -u phosphor-fan-presence-tach@0.service | grep Loading`