openbmc/phosphor-hwmon/sensor.hpp

17 namespace sensor  namespace
29 /** @brief Custom exception for async sensor reading timeout
35                      "Async sensor read timed out")  in AsyncSensorReadTimeOut()
39 /** @class Sensor
40  *  @brief Sensor object based on a SensorSet container's key type
41  *  @details Sensor object to create and modify an associated device's sensor
42  *  attributes based on the key type of each sensor in the set provided by the
45 class Sensor  class
48     Sensor() = delete;
49     Sensor(const Sensor&) = delete;
50     Sensor(Sensor&&) = default;
51     Sensor& operator=(const Sensor&) = delete;
52     Sensor& operator=(Sensor&&) = default;
53     ~Sensor() = default;
56      * @brief Constructs Sensor object
58      * @param[in] sensor - A pair of sensor identifiers
62     explicit Sensor(const SensorSet::key_type& sensor,
67      * @brief Adds any sensor removal return codes for the sensor
69      * for the entire device or for the specific sensor.
71      * @param[in] rcList - List of return codes found for the sensor
76      * @brief Get the adjustments struct for the sensor
78      * @return - Sensor adjustment struct
86      * @brief Adjusts a sensor value
88      * for this sensor object and returns that adjusted value.
92      * @return - Adjusted sensor value
97      * @brief Add value interface and value property for sensor
98      * @details When a sensor has an associated input file, the Sensor.Value
104      * @param[in] info - Sensor object information
114      * @brief Add status interface and functional property for sensor
120      * @param[in] info - Sensor object information
127      * @brief Add Accuracy interface and accuracy property for sensor
128      * @details Accuracy interface is the accuracy range (+/-) of the sensor
131      * @param[in] info     - Sensor object information
132      * @param[in] accuracy - The accuracy value for sensor readings
143      * @param[in] info     - Sensor object information
144      * @param[in] priority - The priority level for the sensor
153      * @brief Get the scale from the sensor.
163      * @brief Get the GPIO handle from the sensor.
173      * @brief Get whether the sensor has a fault file or not.
175      * @return - Boolean on whether the sensor has a fault file
183     /** @brief Sensor object's identifiers */
192     /** @brief Structure for storing sensor adjustments */
198     /** @brief sensor scale from configuration. */
201     /** @brief Tracks whether the sensor has a fault file or not. */
225  * @brief Asynchronously read a sensor with timeout defined by
228  * @param[in] sensorSetKey - Sensor object's identifiers
236  * @param[in] sensor - The hwmon sensor (ex. input).
246     const std::string& type, const std::string& id, const std::string& sensor,
248 } // namespace sensor