blob: f8069f3151dee66a8a4c5e70f44ea5f2ed9fc12b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
#pragma once
#include "hwmonio.hpp"
#include "sensorset.hpp"
#include "types.hpp"
#include <chrono>
#include <gpioplus/handle.hpp>
#include <memory>
#include <unordered_set>
namespace sensor
{
struct valueAdjust
{
double gain = 1.0;
int offset = 0;
std::unordered_set<int> rmRCs;
};
/** @class Sensor
* @brief Sensor object based on a SensorSet container's key type
* @details Sensor object to create and modify an associated device's sensor
* attributes based on the key type of each sensor in the set provided by the
* device.
*/
class Sensor
{
public:
Sensor() = delete;
Sensor(const Sensor&) = delete;
Sensor(Sensor&&) = default;
Sensor& operator=(const Sensor&) = delete;
Sensor& operator=(Sensor&&) = default;
~Sensor() = default;
/**
* @brief Constructs Sensor object
*
* @param[in] sensor - A pair of sensor indentifiers
* @param[in] ioAccess - Hwmon sysfs access
* @param[in] devPath - Device sysfs path
*/
explicit Sensor(const SensorSet::key_type& sensor,
const hwmonio::HwmonIOInterface* ioAccess,
const std::string& devPath);
/**
* @brief Adds any sensor removal return codes for the sensor
* @details Add all return codes defined within a device's config file
* for the entire device or for the specific sensor.
*
* @param[in] rcList - List of return codes found for the sensor
*/
void addRemoveRCs(const std::string& rcList);
/**
* @brief Get the adjustments struct for the sensor
*
* @return - Sensor adjustment struct
*/
inline const valueAdjust& getAdjusts()
{
return _sensorAdjusts;
}
/**
* @brief Adjusts a sensor value
* @details Adjusts the value given by any gain and/or offset defined
* for this sensor object and returns that adjusted value.
*
* @param[in] value - Value to be adjusted
*
* @return - Adjusted sensor value
*/
SensorValueType adjustValue(SensorValueType value);
/**
* @brief Add value interface and value property for sensor
* @details When a sensor has an associated input file, the Sensor.Value
* interface is added along with setting the Value property to the
* corresponding value found in the input file.
*
* @param[in] retryIO - Hwmon sysfs file retry constraints
* (number of and delay between)
* @param[in] info - Sensor object information
*
* @return - Shared pointer to the value object
*/
std::shared_ptr<ValueObject> addValue(const RetryIO& retryIO,
ObjectInfo& info);
/**
* @brief Add status interface and functional property for sensor
* @details When a sensor has an associated fault file, the
* OperationalStatus interface is added along with setting the
* Functional property to the corresponding value found in the
* fault file.
*
* @param[in] info - Sensor object information
*
* @return - Shared pointer to the status object
*/
std::shared_ptr<StatusObject> addStatus(ObjectInfo& info);
/**
* @brief Unlock the gpio, set to high if relevant.
*/
void unlockGpio();
/**
* @brief Lock the gpio, set to low if relevant.
*/
void lockGpio();
/**
* @brief Get the scale from the sensor.
*
* @return - Scale value
*/
inline int64_t getScale(void)
{
return _scale;
}
private:
/** @brief Sensor object's identifiers */
SensorSet::key_type _sensor;
/** @brief Hwmon sysfs access. */
const hwmonio::HwmonIOInterface* _ioAccess;
/** @brief Physical device sysfs path. */
const std::string& _devPath;
/** @brief Structure for storing sensor adjustments */
valueAdjust _sensorAdjusts;
/** @brief Optional pointer to GPIO handle. */
std::unique_ptr<gpioplus::HandleInterface> _handle;
/** @brief default pause after unlocking gpio. */
static constexpr std::chrono::milliseconds _pause{500};
/** @brief sensor scale from configuration. */
int64_t _scale;
};
} // namespace sensor
|
