Skip to content

Commit 8005099

Browse files
committed
Improve EVChargerPool documentation
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent 09f6ee0 commit 8005099

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,26 @@ class EVChargerData:
5353

5454

5555
class EVChargerPool:
56-
"""Interactions with EV Chargers."""
56+
"""An interface for interaction with pools of EV Chargers.
57+
58+
!!! note
59+
`EVChargerPool` instances are not meant to be created directly by users. Use the
60+
[`microgrid.ev_charger_pool`][frequenz.sdk.microgrid.ev_charger_pool] method for
61+
creating an instance.
62+
63+
Provides:
64+
- Aggregate [`power`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.power]
65+
and 3-phase
66+
[`current`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.current]
67+
measurements of the EV Chargers in the pool.
68+
- The
69+
[`component_data`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.component_data]
70+
method for fetching the 3-phase current and state of individual EV Chargers in
71+
the pool.
72+
- The
73+
[`set_bounds`][frequenz.sdk.timeseries.ev_charger_pool.EVChargerPool.set_bounds]
74+
method for limiting the max current of individual EV Chargers in the pool.
75+
"""
5776

5877
def __init__(
5978
self,
@@ -64,6 +83,11 @@ def __init__(
6483
) -> None:
6584
"""Create an `EVChargerPool` instance.
6685
86+
!!! note
87+
`EVChargerPool` instances are not meant to be created directly by users. Use
88+
the [`microgrid.ev_charger_pool`][frequenz.sdk.microgrid.ev_charger_pool]
89+
method for creating an instance.
90+
6791
Args:
6892
channel_registry: A channel registry instance shared with the resampling
6993
actor.

0 commit comments

Comments
 (0)