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