xref: /openbmc/phosphor-hwmon/README.md (revision c635e8609f5246224dfba7db57991de0b1c5327f)
1Exposes generic hwmon entries as DBus objects.
2
3## To Build
4```
5To build this package, do the following steps:
6
7    1. ./bootstrap.sh
8    2. ./configure ${CONFIGURE_FLAGS}
9    3. make
10
11To clean the repository run `./bootstrap.sh clean`.
12```
13
14## D-Bus bus names
15
16```
17To enable the use of Linux features like cgroups prioritization and
18udev/systemd control, one instance of phosphor-hwmon is intended to
19be run per hwmon sysfs class instance.
20
21This requires an algorithm for selecting a stable, well-known D-Bus busname.
22
23The algorithm is <PREFIX>-<ID>.Hwmon<N> where PREFIX is an autoconf
24configurable prefix (BUSNAME_PREFIX, xyz.openbmc_project by default),
25ID is a std::hash of the /sys/devices path backing the hwmon class
26instance, and N is the implemented phosphor-hwmon D-Bus API version.
27```
28