sensors: Align source structure away from anti-patterns
The anti-patterns document comments on source structure, specifically
on placing internal headers in a parallel subtree[1]. dbus-sensors is an
example of violating this anti-pattern, so fix it.
[1]: https://github.com/openbmc/docs/blob/master/anti-patterns.md#placing-internal-headers-in-a-parallel-subtree
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: I50ecaddd53fa9c9b7a0441af9de5e60bd94e47c6
diff --git a/src/PSUSensor.hpp b/src/PSUSensor.hpp
new file mode 100644
index 0000000..379b9d9
--- /dev/null
+++ b/src/PSUSensor.hpp
@@ -0,0 +1,71 @@
+#pragma once
+
+#include "PwmSensor.hpp"
+#include "Thresholds.hpp"
+#include "sensor.hpp"
+
+#include <boost/asio/random_access_file.hpp>
+#include <sdbusplus/asio/object_server.hpp>
+
+#include <array>
+#include <memory>
+#include <string>
+#include <utility>
+
+class PSUSensor : public Sensor, public std::enable_shared_from_this<PSUSensor>
+{
+ public:
+ PSUSensor(const std::string& path, const std::string& objectType,
+ sdbusplus::asio::object_server& objectServer,
+ std::shared_ptr<sdbusplus::asio::connection>& conn,
+ boost::asio::io_service& io, const std::string& sensorName,
+ std::vector<thresholds::Threshold>&& thresholds,
+ const std::string& sensorConfiguration,
+ const PowerState& powerState, const std::string& sensorUnits,
+ unsigned int factor, double max, double min, double offset,
+ const std::string& label, size_t tSize, double pollRate);
+ ~PSUSensor() override;
+ void setupRead(void);
+
+ private:
+ // Note, this buffer is a shared_ptr because during a read, its lifetime
+ // might have to outlive the PSUSensor class if the object gets destroyed
+ // while in the middle of a read operation
+ std::shared_ptr<std::array<char, 128>> buffer;
+ sdbusplus::asio::object_server& objServer;
+ boost::asio::random_access_file inputDev;
+ boost::asio::steady_timer waitTimer;
+ std::string path;
+ unsigned int sensorFactor;
+ double sensorOffset;
+ thresholds::ThresholdTimer thresholdTimer;
+ void restartRead();
+ void handleResponse(const boost::system::error_code& err, size_t bytesRead);
+ void checkThresholds(void) override;
+ unsigned int sensorPollMs = defaultSensorPollMs;
+
+ static constexpr size_t warnAfterErrorCount = 10;
+
+ public:
+ static constexpr double defaultSensorPoll = 1.0;
+ static constexpr unsigned int defaultSensorPollMs =
+ static_cast<unsigned int>(defaultSensorPoll * 1000);
+};
+
+class PSUProperty
+{
+ public:
+ PSUProperty(std::string name, double max, double min, unsigned int factor,
+ double offset) :
+ labelTypeName(std::move(name)),
+ maxReading(max), minReading(min), sensorScaleFactor(factor),
+ sensorOffset(offset)
+ {}
+ ~PSUProperty() = default;
+
+ std::string labelTypeName;
+ double maxReading;
+ double minReading;
+ unsigned int sensorScaleFactor;
+ double sensorOffset;
+};