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