Skip to content

Commit 931c8e8

Browse files
Add a message describing microgrids
This commit adds the following definition: `Microgrid`: A microgrid is a localized grouping of electricity generation, energy storage, and loads that normally operates connected to a traditional centralized grid. Each microgrid has a unique identifier and is associated with an enterprise account. A key feature is that it has a physical location and is situated in a delivery area. Signed-off-by: Tiyash Basu <[email protected]>
1 parent 2fd47e2 commit 931c8e8

File tree

2 files changed

+66
-0
lines changed

2 files changed

+66
-0
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@
5555

5656
- Added a message `DeliveryArea` to represent a market contract delivery area.
5757

58+
- Added a message `Microgrid` to represent a microgrid.
59+
5860
## New Features
5961

6062
<!-- Here goes the main new features and examples or instructions on how to use them -->
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Frequenz microgrid definition.
2+
//
3+
// Copyright 2023 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.microgrid;
11+
12+
import "frequenz/api/common/v1/grid.proto";
13+
import "frequenz/api/common/v1/location.proto";
14+
15+
import "google/protobuf/timestamp.proto";
16+
17+
// MicrogridStatus defines the possible statuses for a microgrid.
18+
enum MicrogridStatus {
19+
// The status is unspecified. This should not be used.
20+
MICROGRID_STATUS_UNSPECIFIED = 0;
21+
22+
// The microgrid is active.
23+
MICROGRID_STATUS_ACTIVE = 1;
24+
25+
// The microgrid is inactive.
26+
MICROGRID_STATUS_INACTIVE = 2;
27+
}
28+
29+
// Microgrid contains details of a specific microgrid. A microgrid is a
30+
// localized grouping of electricity generation, energy storage, and loads that
31+
// normally operates connected to a traditional centralized grid. Each microgrid
32+
// has a unique identifier and is associated with an enterprise account. A key
33+
// feature is that it has a physical location and is situated in a delivery
34+
// area.
35+
//
36+
// !!! info "Key Concepts"
37+
// - `Physical Location`: Geographical coordinates specify the exact
38+
// physical location of the microgrid.
39+
// - `Delivery Area`: Each microgrid is part of a broader delivery area,
40+
// which is crucial for energy trading and compliance.
41+
//
42+
message Microgrid {
43+
// Unique identifier of the microgrid.
44+
uint64 id = 1;
45+
46+
// Unique identifier linking this microgrid to its parent enterprise account.
47+
uint64 enterprise_id = 2;
48+
49+
// Name of the microgrid.
50+
string name = 3;
51+
52+
// The delivery area where the microgrid is located, as identified by a
53+
// specific code.
54+
frequenz.api.common.v1.grid.DeliveryArea delivery_area = 4;
55+
56+
// Physical location of the microgrid, in geographical co-ordinates.
57+
frequenz.api.common.v1.location.Location location = 5;
58+
59+
// The current status of the microgrid.
60+
MicrogridStatus status = 6;
61+
62+
// The UTC timestamp indicating when the microgrid was initially created.
63+
google.protobuf.Timestamp create_timestamp = 7;
64+
}

0 commit comments

Comments
 (0)