Skip to content

Commit c1f6059

Browse files
committed
Improve documentation about sign convention and units
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 10be8c0 commit c1f6059

File tree

1 file changed

+54
-18
lines changed

1 file changed

+54
-18
lines changed

src/frequenz/client/microgrid/_component_data.py

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,30 @@ class MeterData(ComponentData):
7070
"""A wrapper class for holding meter data."""
7171

7272
active_power: float
73-
"""The 3-phase active power, in Watts, represented in the passive sign convention.
74-
+ve current means consumption, away from the grid.
75-
-ve current means supply into the grid.
73+
"""The total active 3-phase AC power, in Watts (W).
74+
75+
Represented in the passive sign convention.
76+
77+
* Positive means consumption from the grid.
78+
* Negative means supply into the grid.
7679
"""
7780

7881
active_power_per_phase: tuple[float, float, float]
79-
"""The AC active power for phase/line 1,2 and 3 respectively."""
82+
"""The per-phase AC active power for phase 1, 2, and 3 respectively, in Watt (W).
83+
84+
Represented in the passive sign convention.
85+
86+
* Positive means consumption from the grid.
87+
* Negative means supply into the grid.
88+
"""
8089

8190
current_per_phase: tuple[float, float, float]
8291
"""AC current in Amperes (A) for phase/line 1,2 and 3 respectively.
83-
+ve current means consumption, away from the grid.
84-
-ve current means supply into the grid.
92+
93+
Represented in the passive sign convention.
94+
95+
* Positive means consumption from the grid.
96+
* Negative means supply into the grid.
8597
"""
8698

8799
voltage_per_phase: tuple[float, float, float]
@@ -241,18 +253,30 @@ class InverterData(ComponentData): # pylint: disable=too-many-instance-attribut
241253
"""A wrapper class for holding inverter data."""
242254

243255
active_power: float
244-
"""The 3-phase active power, in Watts, represented in the passive sign convention.
245-
+ve current means consumption, away from the grid.
246-
-ve current means supply into the grid.
256+
"""The total active 3-phase AC power, in Watts (W).
257+
258+
Represented in the passive sign convention.
259+
260+
* Positive means consumption from the grid.
261+
* Negative means supply into the grid.
247262
"""
248263

249264
active_power_per_phase: tuple[float, float, float]
250-
"""The AC active power for phase/line 1, 2 and 3 respectively."""
265+
"""The per-phase AC active power for phase 1, 2, and 3 respectively, in Watt (W).
266+
267+
Represented in the passive sign convention.
268+
269+
* Positive means consumption from the grid.
270+
* Negative means supply into the grid.
271+
"""
251272

252273
current_per_phase: tuple[float, float, float]
253274
"""AC current in Amperes (A) for phase/line 1, 2 and 3 respectively.
254-
+ve current means consumption, away from the grid.
255-
-ve current means supply into the grid.
275+
276+
Represented in the passive sign convention.
277+
278+
* Positive means consumption from the grid.
279+
* Negative means supply into the grid.
256280
"""
257281

258282
voltage_per_phase: tuple[float, float, float]
@@ -363,18 +387,30 @@ class EVChargerData(ComponentData): # pylint: disable=too-many-instance-attribu
363387
"""A wrapper class for holding ev_charger data."""
364388

365389
active_power: float
366-
"""The 3-phase active power, in Watts, represented in the passive sign convention.
367-
+ve current means consumption, away from the grid.
368-
-ve current means supply into the grid.
390+
"""The total active 3-phase AC power, in Watts (W).
391+
392+
Represented in the passive sign convention.
393+
394+
* Positive means consumption from the grid.
395+
* Negative means supply into the grid.
369396
"""
370397

371398
active_power_per_phase: tuple[float, float, float]
372-
"""The AC active power for phase/line 1,2 and 3 respectively."""
399+
"""The per-phase AC active power for phase 1, 2, and 3 respectively, in Watt (W).
400+
401+
Represented in the passive sign convention.
402+
403+
* Positive means consumption from the grid.
404+
* Negative means supply into the grid.
405+
"""
373406

374407
current_per_phase: tuple[float, float, float]
375408
"""AC current in Amperes (A) for phase/line 1,2 and 3 respectively.
376-
+ve current means consumption, away from the grid.
377-
-ve current means supply into the grid.
409+
410+
Represented in the passive sign convention.
411+
412+
* Positive means consumption from the grid.
413+
* Negative means supply into the grid.
378414
"""
379415

380416
voltage_per_phase: tuple[float, float, float]

0 commit comments

Comments
 (0)