Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance battery pool documentation #425

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/frequenz/sdk/timeseries/battery_pool/battery_pool.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,9 @@ def capacity(self) -> MetricAggregator[CapacityMetrics]:
def power_bounds(self) -> MetricAggregator[PowerMetrics]:
"""Get receiver to receive new power bounds when they change.

Power bounds refer to the min and max power that a battery can
discharge or charge at and is also denoted as SoP.

Power bounds formulas are described in the receiver return type.
None will be send if there is no component to calculate metrics.

Expand Down