docs/config_file/README.md

1 # phosphor-power-sequencer Configuration File
5 - [Overview](#overview)
6 - [Data Format](#data-format)
7 - [Name](#name)
8 - [Contents](#contents)
9 - [Installation](#installation)
13 The `phosphor-power-sequencer` configuration file (config file) contains
21 The config file is optional. If no file is found, the application will log a
22 general error when a pgood fault occurs. No specific rail will be identified.
33 A config file is normally system-specific. Each system type usually has a
36 The system type is obtained from a D-Bus Chassis object created by the
37 [Entity Manager](https://github.com/openbmc/entity-manager) application. The
42 system types. The types are ordered from most specific to least specific.
46 - `com.acme.Hardware.Chassis.Model.MegaServer4CPU`
47 - `com.acme.Hardware.Chassis.Model.MegaServer`
48 - `com.acme.Hardware.Chassis.Model.Server`
50 The `phosphor-power-sequencer` application searches for a config file name that
51 matches one of these compatible system types. It searches from most specific to
52 least specific. The first config file found, if any, will be used.
54 For each compatible system type, the application will look for two config file
57 - The complete compatible system type plus a '.json' suffix
58 - The last node of the compatible system type plus a '.json' suffix
62 - `com.acme.Hardware.Chassis.Model.MegaServer4CPU.json`
63 - `MegaServer4CPU.json`
72 The config file is installed in the `/usr/share/phosphor-power-sequencer`