README.md
1# phosphor-chassis-power
2
3## Overview
4
5The `phosphor-chassis-power` application monitors the GPIO's to determine the
6chassis presence and input power fault status.
7
8## Application
9
10`phosphor-chassis-power` is a single-threaded C++ executable. It is a daemon
11process that runs continually. It is launched by systemd when the BMC reaches
12the Ready state and before the system is powered on.
13
14`phosphor-chassis-power` is driven by a system-specific JSON configuration file.
15The config file is found and parsed when the app is started. The parsing process
16creates a collection of C++ objects. These objects represent the chassis, GPIOs,
17and fault checks to perform.
18
19## JSON configuration file
20
21`phosphor-chassis-power` is configured by a JSON configuration file. The
22configuration file defines the GPIOs in the system and how they should be
23monitored.
24
25JSON configuration files are system-specific and are stored in the
26[config_files](../config_files/) sub-directory.
27
28[Documentation](config_file/README.md) is available on the configuration file
29format.
30
31If no configuration file is found for the current system, the system can still
32be powered on/off, but `phosphor-chassis-power` would not monitor anything.
33