xref: /openbmc/phosphor-hwmon/sensor.hpp (revision 35819381)
1 #pragma once
2 
3 #include "sensorset.hpp"
4 #include "mainloop.hpp"
5 
6 namespace sensor
7 {
8 
9 /**
10  * @brief Add status interface and functional property for sensor
11  * @details When a sensor has an associated fault file, the OperationalStatus
12  * interface is added along with setting the Functional property to the
13  * corresponding value found in the fault file.
14  *
15  * @param[in] sensor - Sensor identification data
16  * @param[in] ioAccess - I/O access to sysfs
17  * @param[in] devPath - Device path
18  * @param[in] info - Sensor object information
19  *
20  * @return - Shared pointer to the status object
21  */
22 std::shared_ptr<StatusObject> addStatus(
23         const SensorSet::key_type& sensor,
24         const hwmonio::HwmonIO& ioAccess,
25         const std::string& devPath,
26         ObjectInfo& info);
27 
28 } // namespace sensor
29