Skip to content

Commit bffb950

Browse files
committed
Update documentation to use the new ResamperConfig2
We want to encourage new users to use the new wall clock timer, so it better to use the new config object in examples. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 1c4f740 commit bffb950

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

docs/tutorials/getting_started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import asyncio
3232

3333
from datetime import timedelta
3434
from frequenz.sdk import microgrid
35-
from frequenz.sdk.timeseries import ResamplerConfig
35+
from frequenz.sdk.timeseries import ResamplerConfig2
3636
```
3737

3838
## Create the application skeleton
@@ -49,7 +49,7 @@ async def run() -> None:
4949
# Initialize the microgrid
5050
await microgrid.initialize(
5151
server_url,
52-
ResamplerConfig(resampling_period=timedelta(seconds=1)),
52+
ResamplerConfig2(resampling_period=timedelta(seconds=1)),
5353
)
5454

5555
# Define your application logic here
@@ -100,7 +100,7 @@ import asyncio
100100

101101
from datetime import timedelta
102102
from frequenz.sdk import microgrid
103-
from frequenz.sdk.timeseries import ResamplerConfig
103+
from frequenz.sdk.timeseries import ResamplerConfig2
104104

105105
async def run() -> None:
106106
# This points to the default Frequenz microgrid sandbox
@@ -109,7 +109,7 @@ async def run() -> None:
109109
# Initialize the microgrid
110110
await microgrid.initialize(
111111
server_url,
112-
ResamplerConfig(resampling_period=timedelta(seconds=1)),
112+
ResamplerConfig2(resampling_period=timedelta(seconds=1)),
113113
)
114114

115115
# Define your application logic here

examples/battery_pool.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from frequenz.channels import merge
1212

1313
from frequenz.sdk import microgrid
14-
from frequenz.sdk.timeseries import ResamplerConfig
14+
from frequenz.sdk.timeseries import ResamplerConfig2
1515

1616
MICROGRID_API_URL = "grpc://microgrid.sandbox.api.frequenz.io:62060"
1717

@@ -24,7 +24,7 @@ async def main() -> None:
2424

2525
await microgrid.initialize(
2626
MICROGRID_API_URL,
27-
resampler_config=ResamplerConfig(resampling_period=timedelta(seconds=1.0)),
27+
resampler_config=ResamplerConfig2(resampling_period=timedelta(seconds=1.0)),
2828
)
2929

3030
battery_pool = microgrid.new_battery_pool(priority=5)

src/frequenz/sdk/timeseries/_voltage_streamer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ class VoltageStreamer:
3535
from datetime import timedelta
3636
3737
from frequenz.sdk import microgrid
38-
from frequenz.sdk.timeseries import ResamplerConfig
38+
from frequenz.sdk.timeseries import ResamplerConfig2
3939
4040
await microgrid.initialize(
4141
"grpc://127.0.0.1:50051",
42-
ResamplerConfig(resampling_period=timedelta(seconds=1))
42+
ResamplerConfig2(resampling_period=timedelta(seconds=1))
4343
)
4444
4545
# Get a receiver for the phase-to-neutral voltage.

src/frequenz/sdk/timeseries/consumer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ class Consumer:
3636
from datetime import timedelta
3737
3838
from frequenz.sdk import microgrid
39-
from frequenz.sdk.timeseries import ResamplerConfig
39+
from frequenz.sdk.timeseries import ResamplerConfig2
4040
4141
await microgrid.initialize(
4242
"grpc://127.0.0.1:50051",
43-
ResamplerConfig(resampling_period=timedelta(seconds=1.0))
43+
ResamplerConfig2(resampling_period=timedelta(seconds=1.0))
4444
)
4545
4646
consumer = microgrid.consumer()

src/frequenz/sdk/timeseries/grid.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ class Grid:
4646
from datetime import timedelta
4747
4848
from frequenz.sdk import microgrid
49-
from frequenz.sdk.timeseries import ResamplerConfig
49+
from frequenz.sdk.timeseries import ResamplerConfig2
5050
5151
await microgrid.initialize(
5252
"grpc://127.0.0.1:50051",
53-
ResamplerConfig(resampling_period=timedelta(seconds=1))
53+
ResamplerConfig2(resampling_period=timedelta(seconds=1))
5454
)
5555
5656
grid = microgrid.grid()

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ 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.timeseries import ResamplerConfig2
3737
from frequenz.client.microgrid import ComponentMetricId
3838
3939
4040
await microgrid.initialize(
4141
"grpc://microgrid.sandbox.api.frequenz.io:62060",
42-
ResamplerConfig(resampling_period=timedelta(seconds=1)),
42+
ResamplerConfig2(resampling_period=timedelta(seconds=1)),
4343
)
4444
4545
logical_meter = (

src/frequenz/sdk/timeseries/producer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ class Producer:
3636
from datetime import timedelta
3737
3838
from frequenz.sdk import microgrid
39-
from frequenz.sdk.timeseries import ResamplerConfig
39+
from frequenz.sdk.timeseries import ResamplerConfig2
4040
4141
await microgrid.initialize(
4242
"grpc://127.0.0.1:50051",
43-
ResamplerConfig(resampling_period=timedelta(seconds=1.0))
43+
ResamplerConfig2(resampling_period=timedelta(seconds=1.0))
4444
)
4545
4646
producer = microgrid.producer()

0 commit comments

Comments
 (0)