Skip to content

Commit 7bfd808

Browse files
committed
Add a Component Graph entry in the glossary
Signed-off-by: Sahas Subramanian <[email protected]>
1 parent b35023e commit 7bfd808

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/user-guide/glossary.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,20 @@ of type `int`.
158158

159159
For example, a battery with a component ID of **5**.
160160

161+
### Component Graph
162+
163+
A [graph](https://en.wikipedia.org/wiki/Graph_(abstract_data_type))
164+
representation of the configuration in which the electrical components in a
165+
microgrid are connected with each other. Some of the ways in which the SDK uses
166+
the component graph are:
167+
168+
- figure out how to calculate high level metrics like
169+
[`grid_power`][frequenz.sdk.timeseries.logical_meter.LogicalMeter.grid_power],
170+
[`consumer_power`][frequenz.sdk.timeseries.logical_meter.LogicalMeter.consumer_power],
171+
etc. for a microgrid, using the available components.
172+
- identify the available batteries or ev chargers at a site that can be
173+
controlled.
174+
161175
### Island
162176

163177
A [microgrid](#microgrid) that is not connected to the public electricity

0 commit comments

Comments
 (0)