logical_meter
frequenz.sdk.timeseries.logical_meter
¤
A logical meter for calculating high level metrics for a microgrid.
Classes¤
frequenz.sdk.timeseries.logical_meter.LogicalMeter
¤
A logical meter for calculating high level metrics in a microgrid.
LogicalMeter provides methods for fetching power values from different points in the
microgrid. These methods return FormulaReceiver
objects, which can be used like
normal Receiver
s, but can also be composed to form higherorder formula streams.
Example
from frequenz.channels import Sender, Broadcast
from frequenz.sdk.actor import DataSourcingActor, ComponentMetricsResamplingActor
from frequenz.sdk.timeseries import ResamplerConfig
from frequenz.sdk.microgrid import initialize
from datetime import timedelta
channel_registry = ChannelRegistry(name="dataregistry")
# Create a channels for sending/receiving subscription requests
data_source_request_channel = Broadcast[ComponentMetricRequest]("datasource")
data_source_request_sender = data_source_request_channel.new_sender()
data_source_request_receiver = data_source_request_channel.new_receiver()
resampling_request_channel = Broadcast[ComponentMetricRequest]("resample")
resampling_request_sender = resampling_request_channel.new_sender()
resampling_request_receiver = resampling_request_channel.new_receiver()
# Instantiate a data sourcing actor
_data_sourcing_actor = DataSourcingActor(
request_receiver=data_source_request_receiver, registry=channel_registry
)
# Instantiate a resampling actor
async with ComponentMetricsResamplingActor(
channel_registry=channel_registry,
data_sourcing_request_sender=data_source_request_sender,
resampling_request_receiver=resampling_request_receiver,
config=ResamplerConfig(resampling_period=timedelta(seconds=1)),
):
await initialize(
"127.0.0.1",
50051,
ResamplerConfig(resampling_period=timedelta(seconds=1))
)
# Create a logical meter instance
logical_meter = LogicalMeter(
channel_registry,
resampling_request_sender,
)
# Get a receiver for a builtin formula
grid_power_recv = logical_meter.grid_power.new_receiver()
for grid_power_sample in grid_power_recv:
print(grid_power_sample)
# or compose formula receivers to create a new formula
net_power_recv = (
(
logical_meter.grid_power
 logical_meter.pv_power
)
.build("net_power")
.new_receiver()
)
for net_power_sample in net_power_recv:
print(net_power_sample)
Source code in /opt/hostedtoolcache/Python/3.11.5/x64/lib/python3.11/sitepackages/frequenz/sdk/timeseries/logical_meter/_logical_meter.py
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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 

Attributes¤
chp_consumption_power: FormulaEngine[Power]
property
¤
Fetch the CHP power consumption in the microgrid.
This formula produces positive values when consuming power and 0 otherwise.
If a formula engine to calculate CHP power consumption is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream CHP power consumption. 
chp_power: FormulaEngine[Power]
property
¤
Fetch the CHP power production in the microgrid.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate CHP power production is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream CHP power production. 
chp_production_power: FormulaEngine[Power]
property
¤
Fetch the CHP power production in the microgrid.
This formula produces positive values when producing power and 0 otherwise.
If a formula engine to calculate CHP power production is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream CHP power production. 
consumer_power: FormulaEngine[Power]
property
¤
Fetch the consumer power for the microgrid.
Under normal circumstances this is expected to correspond to the gross consumption of the site excluding active parts and battery.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate consumer power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream consumer power. 
grid_consumption_power: FormulaEngine[Power]
property
¤
Fetch the grid consumption power for the microgrid.
This formula produces positive values when consuming power and 0 otherwise.
If a formula engine to calculate grid consumption power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream grid consumption power. 
grid_current: FormulaEngine3Phase[Current]
property
¤
Fetch the grid power for the microgrid.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate grid current is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine3Phase[Current]

A FormulaEngine that will calculate and stream grid current. 
grid_power: FormulaEngine[Power]
property
¤
Fetch the grid power for the microgrid.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate grid power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream grid power. 
grid_production_power: FormulaEngine[Power]
property
¤
Fetch the grid production power for the microgrid.
This formula produces positive values when producing power and 0 otherwise.
If a formula engine to calculate grid production power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream grid production power. 
producer_power: FormulaEngine[Power]
property
¤
Fetch the producer power for the microgrid.
Under normal circumstances this is expected to correspond to the production of the sites active parts excluding ev chargers and batteries.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate producer power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream producer power. 
pv_consumption_power: FormulaEngine[Power]
property
¤
Fetch the PV power consumption in the microgrid.
This formula produces positive values when consuming power and 0 otherwise.
If a formula engine to calculate PV power consumption is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream PV power consumption. 
pv_power: FormulaEngine[Power]
property
¤
Fetch the PV power in the microgrid.
This formula produces values that are in the Passive Sign Convention (PSC).
If a formula engine to calculate PV power is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream PV total power. 
pv_production_power: FormulaEngine[Power]
property
¤
Fetch the PV power production in the microgrid.
This formula produces positive values when producing power and 0 otherwise.
If a formula engine to calculate PV power production is not already running, it will be started.
A receiver from the formula engine can be created using the new_receiver
method.
RETURNS  DESCRIPTION 

FormulaEngine[Power]

A FormulaEngine that will calculate and stream PV power production. 
Functions¤
__init__(channel_registry, resampler_subscription_sender)
¤
Create a LogicalMeter instance
.
PARAMETER  DESCRIPTION 

channel_registry 
A channel registry instance shared with the resampling actor.
TYPE:

resampler_subscription_sender 
A sender for sending metric requests to the resampling actor.
TYPE:

Source code in /opt/hostedtoolcache/Python/3.11.5/x64/lib/python3.11/sitepackages/frequenz/sdk/timeseries/logical_meter/_logical_meter.py
start_formula(formula, component_metric_id, *, nones_are_zeros=False)
¤
Start execution of the given formula.
Formulas can have Component IDs that are preceeded by a pound symbol("#"), and these operators: +, , *, /, (, ).
For example, the input string: "#20 + #5" is a formula for adding metrics from two components with ids 20 and 5.
PARAMETER  DESCRIPTION 

formula 
formula to execute.
TYPE:

component_metric_id 
The metric ID to use when fetching receivers from the resampling actor.
TYPE:

nones_are_zeros 
Whether to treat None values from the stream as 0s. If False, the returned value will be a None.
TYPE:

RETURNS  DESCRIPTION 

FormulaEngine[Quantity]

A FormulaEngine that applies the formula and streams values. 