xref: /openbmc/phosphor-hwmon/README.md (revision 46a29b7f)
1# phosphor-hwmon
2
3Exposes generic hwmon entries as DBus objects. More information can be found at
4[Sensor Architecture](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md)
5
6## To Build
7
8To build this package, do the following steps:
9
101. meson setup build
112. ninja -C build
12
13To clean the repository run `rm -rf build`.
14
15## D-Bus bus names
16
17To enable the use of Linux features like cgroups prioritization and udev/systemd
18control, one instance of phosphor-hwmon is intended to be run per hwmon sysfs
19class 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 a meson configurable
24prefix (`BUSNAME_PREFIX=xyz.openbmc_project` by default), ID is either a
25`std::hash` of the `/sys/devices` path backing the hwmon class instance or
26provided suffix value from the command line, and N is the implemented
27phosphor-hwmon D-Bus API version.
28