Skip to content

Commit 84594af

Browse files
Apply suggestions from code review
More suggestions made by @daniel-zullo-frequenz. Co-authored-by: daniel-zullo-frequenz <[email protected]> Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 94431eb commit 84594af

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/intro/glossary.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Glossary
22

3-
This glossary provides definitions for common terminology used in the SDK,
4-
focusing on microgrid components, metrics, measurements, and power-related
5-
terms.
3+
This glossary provides definitions for common terminology used in the Frequenz SDK,
4+
focusing on microgrid components, metrics, measurements, and power-related terms.
65

76
## Common Acronyms
87

@@ -124,7 +123,7 @@ A device (of a particular [category](#component-category)) within a [microgrid](
124123

125124
### Component ID
126125

127-
A numeric identifier uniquely representing an instance of a [component](#component) in a particular[microgrid](#microgrid). It is always of type `int`.
126+
A numeric identifier uniquely representing an instance of a [component](#component) in a particular [microgrid](#microgrid). It is always of type `int`.
128127

129128
For example, a battery with a component ID of **5**.
130129

@@ -293,7 +292,7 @@ The level of charge of a [battery](#battery) relative to its capacity, expressed
293292

294293
### State of Power
295294

296-
The ratio of peak power to nominal power. Peak power is the maximum power that can be sustained for a specific duration without violating preset operational design limits on battery voltage, SsC, power, or current.
295+
The ratio of peak power to nominal power. Peak power is the maximum power that can be sustained for a specific duration without violating preset operational design limits on battery voltage, SoC, power, or current.
297296

298297
This indicator is crucial to ensure that charge or discharge power remains within specific limits, optimizing the battery's lifespan. It is particularly useful in peak power applications to define battery conditions for substantial charges or discharges.
299298

0 commit comments

Comments
 (0)