openbmc/dbus-sensors/README.md

1 # dbus-sensors
3 dbus-sensors is a collection of sensor applications that provide the
5 from hwmon, d-bus, or direct driver access to provide readings. Some advance
6 non-sensor features such as fan presence, pwm control, and automatic cpu
11 - runtime re-configurable from d-bus (entity-manager or the like)
13 - isolated: each sensor type is isolated into its own daemon, so a bug in one
14   sensor is unlikely to affect another, and single sensor modifications are
17 - async single-threaded: uses sdbusplus/asio bindings
19 - multiple data inputs: hwmon, d-bus, direct driver access
23 A typical dbus-sensors object support the following dbus interfaces:
38 [here](https://github.com/openbmc/phosphor-dbus-interfaces/tree/master/yaml/xyz/openbmc_project/Sen…
41 [Redfish](https://github.com/openbmc/bmcweb/blob/master/redfish-core/lib/sensors.hpp),
42 [Phosphor-Pid-Control](https://github.com/openbmc/phosphor-pid-control),
43 [IPMI SDR](https://github.com/openbmc/phosphor-host-ipmid/blob/master/dbus-sdr/sensorcommands.cpp).
47 dbus-sensor daemons are [reactors](https://github.com/openbmc/entity-manager)
51 Using asio timers and async calls, dbus-sensor daemons read sensor values and
57 [here](https://github.com/openbmc/entity-manager/blob/master/docs/my_first_sensors.md).
64 [schema](https://github.com/openbmc/entity-manager/blob/master/schemas/legacy.json)
69 - [ExternalSensor](https://github.com/openbmc/docs/blob/master/designs/external-sensor.md)
86 "adc1" section in the aspeed-g6.dtsi file. These are disabled by default so in
87 your system-specific dts you would enable and configure what you want with
91 iio-hwmon {
92     compatible = "iio-hwmon";
93     io-channels = <&adc0 0>;
111 You will then create an entity-manager configuration file that is of type "ADC"
123 subsystem (/sys/class/hwmon/hwmonX). The adcsensor application will scan d-bus
124 for any ADC entity-manager objects, look up their "Index" value, and try to
126 a d-bus sensor under the xyz.openbmc_project.ADCSensor service. The sensor will