PowerTelemetry.h File

PMBus rail power telemetry. More...

Included Headers

#include <chrono> #include <cstdint> #include <memory> #include <string> #include <vector>

Namespaces Index

namespace	simaai
namespace	neat

Classes Index

struct	PowerRailConfig
	Configuration for one PMBus rail exposed by a paged PMIC. More...
struct	PowerFieldReading
	One scalar rail field read from a PMIC. More...
struct	PowerRailReading
	Snapshot for one rail. More...
struct	PowerSnapshot
	Point-in-time board power snapshot. More...
struct	PowerMonitorOptions
	Options for a PowerMonitor. More...
struct	PowerFieldSummary
	Summary statistics for one scalar rail field. More...
struct	PowerRailSummary
	Summary statistics for one rail. More...
struct	PowerSummary
	Aggregated power monitor result. More...
class	PowerMonitor
	Background SOM power sampler. More...

Description

PMBus rail power telemetry.

File Listing

The file content with the documentation metadata removed is:

1

6#pragma once

7

8#include <chrono>

9#include <cstdint>

10#include <memory>

11#include <string>

12#include <vector>

13

14namespace simaai::neat {

15

20enum class PowerMonitorProfile {

21 Auto,

22 ModalixSom,

23 ModalixDvt,

24 Custom,

25};

26

35struct PowerRailConfig {

36 std::string name;

37 int i2c_bus = 3;

38 std::uint8_t i2c_addr = 0;

39 std::uint8_t page = 0;

40 int vout_exponent = -8;

41 int iout_exponent = -6;

42 int pout_exponent = -5;

43};

44

49struct PowerFieldReading {

50 bool available = false;

51 std::uint8_t raw = 0;

52 double value = 0.0;

53 std::string error;

54};

55

64struct PowerRailReading {

65 PowerRailConfig config;

66 PowerFieldReading voltage_v;

67 PowerFieldReading current_a;

68 PowerFieldReading power_w;

69};

70

75struct PowerSnapshot {

76 std::chrono::steady_clock::time_point timestamp{};

77 std::vector<PowerRailReading> rails;

78 double total_watts = 0.0;

79 std::uint64_t rails_with_power = 0;

80};

81

86struct PowerMonitorOptions {

87 bool enabled = false;

88 int sample_interval_ms = 100;

89 PowerMonitorProfile profile =

90 PowerMonitorProfile::Auto;

91 std::vector<PowerRailConfig>

92 rails;

93};

94

99struct PowerFieldSummary {

100 std::uint64_t samples = 0;

101 std::uint64_t errors = 0;

102 double avg = 0.0;

103 double min = 0.0;

104 double max = 0.0;

105};

106

111struct PowerRailSummary {

112 PowerRailConfig config;

113 PowerFieldSummary voltage_v;

114 PowerFieldSummary current_a;

115 PowerFieldSummary power_w;

116};

117

122struct PowerSummary {

123 bool enabled = false;

124 std::uint64_t samples = 0;

125 double duration_seconds = 0.0;

126 double total_avg_watts = 0.0;

127 double total_min_watts = 0.0;

128 double total_max_watts = 0.0;

129 double energy_joules = 0.0;

130 std::vector<PowerRailSummary> rails;

131};

132

137std::vector<PowerRailConfig> default_modalix_som_power_rails();

138

146std::vector<PowerRailConfig> default_modalix_dvt_power_rails();

147

152PowerMonitorProfile detect_default_power_monitor_profile();

153

158std::string power_monitor_profile_name(PowerMonitorProfile profile);

159

164std::vector<PowerRailConfig> power_rails_for_profile(PowerMonitorProfile profile);

165

170PowerMonitorOptions

171board_power_monitor_options(int sample_interval_ms = 100,

172 PowerMonitorProfile profile = PowerMonitorProfile::Auto);

173

178PowerMonitorOptions modalix_som_power_monitor_options(int sample_interval_ms = 100);

179

184PowerMonitorOptions modalix_dvt_power_monitor_options(int sample_interval_ms = 100);

185

190PowerSnapshot read_power_snapshot(const PowerMonitorOptions& options);

191

196std::string format_power_summary(const PowerSummary& summary);

197

202std::string power_summary_to_json(const PowerSummary& summary, int indent = 2);

203

212class PowerMonitor {

213public:

214 explicit PowerMonitor(PowerMonitorOptions options = {});

215 ~PowerMonitor();

216

217 PowerMonitor(const PowerMonitor&) = delete;

218 PowerMonitor& operator=(const PowerMonitor&) = delete;

219

220 PowerMonitor(PowerMonitor&&) noexcept;

221 PowerMonitor& operator=(PowerMonitor&&) noexcept;

222

224 void start();

226 void stop();

228 void sample_once();

230 PowerSummary summary() const;

232 bool running() const;

233

234private:

235 class Impl;

236 std::unique_ptr<Impl> impl_;

237};

238

239} // namespace simaai::neat

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.1.