phosphor-regulators/src/dbus_sensor.hpp

23 #include <xyz/openbmc_project/Sensor/Value/server.hpp>
38  * xyz.openbmc_project.Sensor.Value interface.
40 using ValueInterface = sdbusplus::xyz::openbmc_project::Sensor::server::Value;
73  * valid sensor Unit values on D-Bus.
75 using Unit = sdbusplus::xyz::openbmc_project::Sensor::server::Value::Unit;
90  * This class represents a voltage regulator sensor on D-Bus.
92  * Each voltage rail in the system may provide multiple types of sensor data,
113      * @param name sensor name
114      * @param type sensor type
115      * @param value sensor value
116      * @param rail voltage rail associated with this sensor
128      * Disable this sensor.
130      * Updates the sensor properties on D-Bus to indicate it is no longer
139      * Return the last time this sensor was updated.
149      * Return the sensor name.
151      * @return sensor name
159      * Return the voltage regulator rail associated with this sensor.
169      * Return the sensor type.
171      * @return sensor type
179      * Set this sensor to the error state.
181      * Updates the sensor properties on D-Bus to indicate an error occurred and
182      * the sensor value could not be read.
187      * Set the value of this sensor.
190      * indicate the sensor has been disabled or is in the error state.  Call the
194      * @param value new sensor value
200      * Sensor value update policy.
202      * Determines whether a new sensor value should replace the current value on
210          * The sensor value will only be updated if the new value differs from
219          * The sensor value will only be updated if the new value is higher than
227          * When the sensor is read from the regulator, the regulator will often
229          * value.  For this reason, the D-Bus sensor value is set to the highest
232          * The D-Bus sensor value is cleared when the sensor is disabled.  This
234          * sensor value is normally the highest value read since the system was
242          * The sensor value will only be updated if the new value is lower than
250          * When the sensor is read from the regulator, the regulator will often
252          * value.  For this reason, the D-Bus sensor value is set to the lowest
255          * The D-Bus sensor value is cleared when the sensor is disabled.  This
257          * sensor value is normally the lowest value read since the system was
264      * Get the D-Bus associations to create for this sensor.
276      * Get sensor properties that are based on the sensor type.
280      * Also initializes some data members whose value is based on the sensor
283      * @param objectPath returns the object path of this sensor
284      * @param unit returns the D-Bus unit for the sensor value
285      * @param minValue returns the minimum sensor value
286      * @param maxValue returns the maximum sensor value
292      * Set the last time this sensor was updated.
300      * Set the sensor value on D-Bus to NaN.
305      * Returns whether to update the sensor value on D-Bus with the specified
308      * @param value new sensor value
319      * Sensor name.
324      * Sensor type.
329      * Voltage regulator rail associated with this sensor.
334      * Sensor value update policy.
352      * Last time this sensor was updated.