Skip to content

Commit ddb3147

Browse files
Add Power message and make Energy message broader (#267)
This PR addresses #261 and #262 by generalising the documentation of the`Energy` Message and adding a `Power` message (so Power can be represented in MW).
2 parents de93bc0 + d7bc47f commit ddb3147

File tree

3 files changed

+40
-6
lines changed

3 files changed

+40
-6
lines changed

RELEASE_NOTES.md

+4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Update of the `PaginationParams` struct.
1212

1313
- Additional information for energy metric
1414

15+
- Generalize Energy message documentation for broader market use
16+
17+
- Add Power message to represent Power in MW
18+
1519
## Bug Fixes
1620

1721
- Fix a dependency issue by pinning the `grpcio` version and related libraries.

proto/frequenz/api/common/v1/market/energy.proto

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Frequenz definitions of energy for electricity trading.
1+
// Frequenz definitions of energy.
22
//
33
// Copyright 2023 Frequenz Energy-as-a-Service GmbH
44
//
@@ -14,11 +14,11 @@ import "frequenz/api/common/v1/types/decimal.proto";
1414
// Represents a single unit of electricity.
1515
//
1616
// !!! note
17-
// In these trading orders, the unit of energy is denominated in MWh
18-
// (Megawatt-hours) as opposed to MW (Megawatts). MWh is a unit of energy
19-
// representing total output over a period, while MW is a unit of power that
20-
// represents the rate of energy production or consumption.
17+
// The unit of energy is denominated in MWh, which is a unit of energy
18+
// representing total output over a period.(Megawatt-hours). This differs
19+
// from MW (Megawatts), a unit of power representing the rate of energy
20+
// production or consumption.
2121
message Energy {
22-
// Represents energy unit in Megawatthours (MWh).
22+
// Energy unit in Megawatthours (MWh).
2323
frequenz.api.common.v1.types.Decimal mwh = 1;
2424
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Frequenz definitions of power.
2+
//
3+
// Copyright 2024 Frequenz Energy-as-a-Service GmbH
4+
//
5+
// Licensed under the MIT License (the "License");
6+
// you may not use this file except in compliance with the License.
7+
8+
syntax = "proto3";
9+
10+
package frequenz.api.common.v1.market;
11+
12+
import "frequenz/api/common/v1/types/decimal.proto";
13+
14+
// Represents a single unit of power.
15+
//
16+
// !!! note
17+
// The power unit is denominated in MW (Megawatts), which is a unit of
18+
// power representing the rate of energy production or consumption at any
19+
// given moment. This differs from MWh (Megawatt-hours), which measures
20+
// the total amount of energy delivered or consumed over a period.
21+
//
22+
// Example:
23+
// A power plant running at 10 MW for 1 hour generates 10 MWh of energy.
24+
//
25+
// This message standardizes the representation of power in MW across all
26+
// market applications.
27+
message Power {
28+
// Power amount in Megawatts (MW).
29+
frequenz.api.common.v1.types.Decimal mw = 1;
30+
}

0 commit comments

Comments
 (0)