From d9d22cbee8631814af29353a7c35a0bc58e48863 Mon Sep 17 00:00:00 2001 From: camille-bouvy-frequenz Date: Wed, 2 Oct 2024 17:38:24 +0200 Subject: [PATCH 1/3] Generalize Energy message documentation for broader market use Signed-off-by: camille-bouvy-frequenz --- proto/frequenz/api/common/v1/market/energy.proto | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/proto/frequenz/api/common/v1/market/energy.proto b/proto/frequenz/api/common/v1/market/energy.proto index 1dfe9564..9157f1e6 100644 --- a/proto/frequenz/api/common/v1/market/energy.proto +++ b/proto/frequenz/api/common/v1/market/energy.proto @@ -1,4 +1,4 @@ -// Frequenz definitions of energy for electricity trading. +// Frequenz definitions of energy. // // Copyright 2023 Frequenz Energy-as-a-Service GmbH // @@ -14,11 +14,11 @@ import "frequenz/api/common/v1/types/decimal.proto"; // Represents a single unit of electricity. // // !!! note -// In these trading orders, the unit of energy is denominated in MWh -// (Megawatt-hours) as opposed to MW (Megawatts). MWh is a unit of energy -// representing total output over a period, while MW is a unit of power that -// represents the rate of energy production or consumption. +// The unit of energy is denominated in MWh, which is a unit of energy +// representing total output over a period.(Megawatt-hours). This differs +// from MW (Megawatts), a unit of power representing the rate of energy +// production or consumption. message Energy { - // Represents energy unit in Megawatthours (MWh). + // Energy unit in Megawatthours (MWh). frequenz.api.common.v1.types.Decimal mwh = 1; } From f30840d9a6178197f2c9b57e848d03150f12082b Mon Sep 17 00:00:00 2001 From: camille-bouvy-frequenz Date: Wed, 2 Oct 2024 17:46:53 +0200 Subject: [PATCH 2/3] Add Power message to represent Power in MW Signed-off-by: camille-bouvy-frequenz --- .../frequenz/api/common/v1/market/power.proto | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 proto/frequenz/api/common/v1/market/power.proto diff --git a/proto/frequenz/api/common/v1/market/power.proto b/proto/frequenz/api/common/v1/market/power.proto new file mode 100644 index 00000000..a77308e7 --- /dev/null +++ b/proto/frequenz/api/common/v1/market/power.proto @@ -0,0 +1,30 @@ +// Frequenz definitions of power. +// +// Copyright 2024 Frequenz Energy-as-a-Service GmbH +// +// Licensed under the MIT License (the "License"); +// you may not use this file except in compliance with the License. + +syntax = "proto3"; + +package frequenz.api.common.v1.market; + +import "frequenz/api/common/v1/types/decimal.proto"; + +// Represents a single unit of power. +// +// !!! note +// The power unit is denominated in MW (Megawatts), which is a unit of +// power representing the rate of energy production or consumption at any +// given moment. This differs from MWh (Megawatt-hours), which measures +// the total amount of energy delivered or consumed over a period. +// +// Example: +// A power plant running at 10 MW for 1 hour generates 10 MWh of energy. +// +// This message standardizes the representation of power in MW across all +// market applications. +message Power { + // Power amount in Megawatts (MW). + frequenz.api.common.v1.types.Decimal mw = 1; +} From d7bc47f0b05460ffee6fcd3579e5bdea1a36c321 Mon Sep 17 00:00:00 2001 From: camille-bouvy-frequenz Date: Wed, 2 Oct 2024 17:48:06 +0200 Subject: [PATCH 3/3] Update Release Notes Signed-off-by: camille-bouvy-frequenz --- RELEASE_NOTES.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 00ce3d0f..d0012ff2 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -12,6 +12,10 @@ Update of the `PaginationParams` struct. - Additional information for energy metric +- Generalize Energy message documentation for broader market use + +- Add Power message to represent Power in MW + ## Bug Fixes - Fix a dependency issue by pinning the `grpcio` version and related libraries.