Skip to content

Commit 249d4fe

Browse files
Update logical meter documentation (#986)
- **Remove logical_meter instance from FormulaEngine documentation** - **Update logical meter example**
2 parents 0e47f15 + 093ed81 commit 249d4fe

File tree

3 files changed

+12
-22
lines changed

3 files changed

+12
-22
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@
2727

2828
- Fixed a typing issue that occurs in some cases when composing formulas with constants.
2929
- Fixed a bug where sending tasks in the data sourcing actor might have not been properly awaited.
30+
- Updated the logical meter documentation to reflect the latest changes.

src/frequenz/sdk/timeseries/formula_engine/_formula_engine.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,6 @@ class FormulaEngine(
276276
```python
277277
from frequenz.sdk import microgrid
278278
279-
logical_meter = microgrid.logical_meter()
280279
battery_pool = microgrid.new_battery_pool(priority=5)
281280
ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
282281
grid = microgrid.grid()
@@ -473,7 +472,6 @@ class FormulaEngine3Phase(
473472
```python
474473
from frequenz.sdk import microgrid
475474
476-
logical_meter = microgrid.logical_meter()
477475
ev_charger_pool = microgrid.new_ev_charger_pool(priority=5)
478476
grid = microgrid.grid()
479477

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -33,32 +33,23 @@ class LogicalMeter:
3333
from datetime import timedelta
3434
3535
from frequenz.sdk import microgrid
36-
from frequenz.sdk.timeseries import ResamplerConfig
36+
from frequenz.sdk.actor import ResamplerConfig
37+
from frequenz.client.microgrid import ComponentMetricId
38+
3739
3840
await microgrid.initialize(
39-
"grpc://127.0.0.1:50051",
40-
ResamplerConfig(resampling_period=timedelta(seconds=1))
41+
"grpc://microgrid.sandbox.api.frequenz.io:62060",
42+
ResamplerConfig(resampling_period=timedelta(seconds=1)),
4143
)
4244
43-
logical_meter = microgrid.logical_meter()
44-
pv_pool = microgrid.new_pv_pool(priority=5)
45-
grid = microgrid.grid()
46-
47-
# Get a receiver for a builtin formula
48-
pv_power_recv = pv_pool.power.new_receiver()
49-
async for pv_power_sample in pv_power_recv:
50-
print(pv_power_sample)
51-
52-
# or compose formulas to create a new formula
53-
net_power_recv = (
54-
(
55-
grid.power - pv_pool.power
56-
)
57-
.build("net_power")
45+
logical_meter = (
46+
microgrid.logical_meter()
47+
.start_formula("#1001 + #1002", ComponentMetricId.ACTIVE_POWER)
5848
.new_receiver()
5949
)
60-
async for net_power_sample in net_power_recv:
61-
print(net_power_sample)
50+
51+
async for power in logical_meter:
52+
print(power.value)
6253
```
6354
"""
6455

0 commit comments

Comments
 (0)