README.md
1# OpenBMC power supply monitoring application
2
3Design document:
4<https://github.com/openbmc/docs/blob/master/designs/psu-monitoring.md>
5
6## Compile Options
7
8To enable reading VPD data via PMBus commands to IBM common form factor power
9supplies (ibm-cffps), run meson with `-Dibm-vpd=true`.
10
11## D-Bus System Configuration
12
13Entity Manager provides information about the supported system configuration and
14the power supply connectors (IBMCFFPSConnector).
15
16The information is as follows:
17
18### Max Power Supplies
19
20Integer that indicates the maximum number of power supplies that should be
21present. This is exposed via the `MaxCount` property.
22
23### I2C Bus
24
25The I2C bus(es) that the power supply is on will be represented by the `I2CBus`
26property under the `xyz.openbmc_project.Configuration.IBMCFFPSConnector`
27interface(s).
28
29### I2C Address
30
31The I2C address(es) that the power supply is at will be represented by the
32`I2CAddress` property under the IBMCFFPSConnector interface(s).
33
34### Name
35
36The `Name` property under the IBMCFFPSConnector interface(s) will be used to
37create an inventory path for the power supply. This inventory path is used as
38part of the power supply presence detection, reading the `Present` property
39under this path.
40