metrics
frequenz.client.assets.metrics ¤
Metrics for the electrical component.
Classes¤
frequenz.client.assets.metrics.Bounds
dataclass
¤
A set of lower and upper bounds for any metric.
The lower bound must be less than or equal to the upper bound.
The units of the bounds are always the same as the related metric.
Source code in frequenz/client/assets/metrics/_bounds.py
Attributes¤
lower
class-attribute
instance-attribute
¤
lower: float | None = None
The lower bound.
If None
, there is no lower bound.
upper
class-attribute
instance-attribute
¤
upper: float | None = None
The upper bound.
If None
, there is no upper bound.
Functions¤
__post_init__ ¤
Validate these bounds.
Source code in frequenz/client/assets/metrics/_bounds.py
frequenz.client.assets.metrics.Metric ¤
Bases: Enum
List of supported metrics.
AC energy metrics information
-
This energy metric is reported directly from the component, and not a result of aggregations in our systems. If a component does not have this metric, this field cannot be populated.
-
Components that provide energy metrics reset this metric from time to time. This behaviour is specific to each component model. E.g., some components reset it on UTC 00:00:00.
-
This energy metric does not specify the start time of the accumulation period,and therefore can be inconsistent.
Source code in frequenz/client/assets/metrics/_metric.py
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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
|
Attributes¤
AC_CURRENT
class-attribute
instance-attribute
¤
The alternating current current.
AC_CURRENT_PHASE_1
class-attribute
instance-attribute
¤
The alternating current current in phase 1.
AC_CURRENT_PHASE_2
class-attribute
instance-attribute
¤
The alternating current current in phase 2.
AC_CURRENT_PHASE_3
class-attribute
instance-attribute
¤
The alternating current current in phase 3.
AC_ENERGY_ACTIVE
class-attribute
instance-attribute
¤
The alternating current active energy.
AC_ENERGY_ACTIVE_CONSUMED
class-attribute
instance-attribute
¤
The alternating current active energy consumed.
AC_ENERGY_ACTIVE_CONSUMED_PHASE_1
class-attribute
instance-attribute
¤
The alternating current active energy consumed in phase 1.
AC_ENERGY_ACTIVE_CONSUMED_PHASE_2
class-attribute
instance-attribute
¤
The alternating current active energy consumed in phase 2.
AC_ENERGY_ACTIVE_CONSUMED_PHASE_3
class-attribute
instance-attribute
¤
The alternating current active energy consumed in phase 3.
AC_ENERGY_ACTIVE_DELIVERED
class-attribute
instance-attribute
¤
The alternating current active energy delivered.
AC_ENERGY_ACTIVE_DELIVERED_PHASE_1
class-attribute
instance-attribute
¤
The alternating current active energy delivered in phase 1.
AC_ENERGY_ACTIVE_DELIVERED_PHASE_2
class-attribute
instance-attribute
¤
The alternating current active energy delivered in phase 2.
AC_ENERGY_ACTIVE_DELIVERED_PHASE_3
class-attribute
instance-attribute
¤
The alternating current active energy delivered in phase 3.
AC_ENERGY_ACTIVE_PHASE_1
class-attribute
instance-attribute
¤
The alternating current active energy in phase 1.
AC_ENERGY_ACTIVE_PHASE_2
class-attribute
instance-attribute
¤
The alternating current active energy in phase 2.
AC_ENERGY_ACTIVE_PHASE_3
class-attribute
instance-attribute
¤
The alternating current active energy in phase 3.
AC_ENERGY_APPARENT
class-attribute
instance-attribute
¤
The alternating current apparent energy.
AC_ENERGY_APPARENT_PHASE_1
class-attribute
instance-attribute
¤
The alternating current apparent energy in phase 1.
AC_ENERGY_APPARENT_PHASE_2
class-attribute
instance-attribute
¤
The alternating current apparent energy in phase 2.
AC_ENERGY_APPARENT_PHASE_3
class-attribute
instance-attribute
¤
The alternating current apparent energy in phase 3.
AC_ENERGY_REACTIVE
class-attribute
instance-attribute
¤
The alternating current reactive energy.
AC_ENERGY_REACTIVE_PHASE_1
class-attribute
instance-attribute
¤
The alternating current reactive energy in phase 1.
AC_ENERGY_REACTIVE_PHASE_2
class-attribute
instance-attribute
¤
The alternating current reactive energy in phase 2.
AC_ENERGY_REACTIVE_PHASE_3
class-attribute
instance-attribute
¤
The alternating current reactive energy in phase 3.
AC_FREQUENCY
class-attribute
instance-attribute
¤
The alternating current frequency.
AC_POWER_ACTIVE
class-attribute
instance-attribute
¤
The alternating current active power.
AC_POWER_ACTIVE_PHASE_1
class-attribute
instance-attribute
¤
The alternating current active power in phase 1.
AC_POWER_ACTIVE_PHASE_2
class-attribute
instance-attribute
¤
The alternating current active power in phase 2.
AC_POWER_ACTIVE_PHASE_3
class-attribute
instance-attribute
¤
The alternating current active power in phase 3.
AC_POWER_APPARENT
class-attribute
instance-attribute
¤
The alternating current apparent power.
AC_POWER_APPARENT_PHASE_1
class-attribute
instance-attribute
¤
The alternating current apparent power in phase 1.
AC_POWER_APPARENT_PHASE_2
class-attribute
instance-attribute
¤
The alternating current apparent power in phase 2.
AC_POWER_APPARENT_PHASE_3
class-attribute
instance-attribute
¤
The alternating current apparent power in phase 3.
AC_POWER_FACTOR
class-attribute
instance-attribute
¤
The alternating current power factor.
AC_POWER_FACTOR_PHASE_1
class-attribute
instance-attribute
¤
The alternating current power factor in phase 1.
AC_POWER_FACTOR_PHASE_2
class-attribute
instance-attribute
¤
The alternating current power factor in phase 2.
AC_POWER_FACTOR_PHASE_3
class-attribute
instance-attribute
¤
The alternating current power factor in phase 3.
AC_POWER_REACTIVE
class-attribute
instance-attribute
¤
The alternating current reactive power.
AC_POWER_REACTIVE_PHASE_1
class-attribute
instance-attribute
¤
The alternating current reactive power in phase 1.
AC_POWER_REACTIVE_PHASE_2
class-attribute
instance-attribute
¤
The alternating current reactive power in phase 2.
AC_POWER_REACTIVE_PHASE_3
class-attribute
instance-attribute
¤
The alternating current reactive power in phase 3.
AC_TOTAL_HARMONIC_DISTORTION_CURRENT
class-attribute
instance-attribute
¤
The alternating current total harmonic distortion current.
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1
class-attribute
instance-attribute
¤
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1 = (
METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1
)
The alternating current total harmonic distortion current in phase 1.
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2
class-attribute
instance-attribute
¤
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2 = (
METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2
)
The alternating current total harmonic distortion current in phase 2.
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3
class-attribute
instance-attribute
¤
AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3 = (
METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3
)
The alternating current total harmonic distortion current in phase 3.
AC_VOLTAGE
class-attribute
instance-attribute
¤
The alternating current electric potential difference.
AC_VOLTAGE_PHASE_1_N
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 1 and neutral.
AC_VOLTAGE_PHASE_1_PHASE_2
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 1 and phase 2.
AC_VOLTAGE_PHASE_2_N
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 2 and neutral.
AC_VOLTAGE_PHASE_2_PHASE_3
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 2 and phase 3.
AC_VOLTAGE_PHASE_3_N
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 3 and neutral.
AC_VOLTAGE_PHASE_3_PHASE_1
class-attribute
instance-attribute
¤
The alternating current electric potential difference between phase 3 and phase 1.
BATTERY_CAPACITY
class-attribute
instance-attribute
¤
The capacity of the battery.
BATTERY_SOC_PCT
class-attribute
instance-attribute
¤
The state of charge of the battery as a percentage.
BATTERY_TEMPERATURE
class-attribute
instance-attribute
¤
The temperature of the battery.
DC_CURRENT
class-attribute
instance-attribute
¤
The direct current current.
DC_VOLTAGE
class-attribute
instance-attribute
¤
The direct current voltage.
EV_CHARGER_TEMPERATURE
class-attribute
instance-attribute
¤
The temperature of the EV charger.
INVERTER_TEMPERATURE
class-attribute
instance-attribute
¤
The temperature of the inverter.
INVERTER_TEMPERATURE_CABINET
class-attribute
instance-attribute
¤
The temperature of the inverter cabinet.
INVERTER_TEMPERATURE_HEATSINK
class-attribute
instance-attribute
¤
The temperature of the inverter heatsink.
INVERTER_TEMPERATURE_TRANSFORMER
class-attribute
instance-attribute
¤
The temperature of the inverter transformer.
SENSOR_AIR_PRESSURE
class-attribute
instance-attribute
¤
The air pressure measured.
SENSOR_DEW_POINT
class-attribute
instance-attribute
¤
The dew point measured.
SENSOR_IRRADIANCE
class-attribute
instance-attribute
¤
The irradiance measured.
SENSOR_RELATIVE_HUMIDITY
class-attribute
instance-attribute
¤
The relative humidity measured.
SENSOR_TEMPERATURE
class-attribute
instance-attribute
¤
The temperature measured.
SENSOR_WIND_DIRECTION
class-attribute
instance-attribute
¤
The direction of the wind measured.
SENSOR_WIND_SPEED
class-attribute
instance-attribute
¤
The speed of the wind measured.
UNSPECIFIED
class-attribute
instance-attribute
¤
The metric is unspecified (this should not be used).