Move all electrical component types to a single file (#380)

This commit moves all the electrical component types from their
individual files into `electrical_components.proto`.

closes #377

Author: tiyash-basu-frequenz

RELEASE_NOTES.md

@@ -36,6 +36,7 @@
             + `ComponentCategoryMetadataVariant.metadata.grid` to `ElectricalComponentCategorySpecificInfo.kind.grid_connection_point`
         * `InverterType.INVERTER_TYPE_SOLAR` to `InverterType.INVERTER_TYPE_PV` (to align with the more colloquial term "PV inverter")
         * `ComponentCategory.COMPONENT_CATEGORY_RELAY` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_BREAKER` (to better align with the common terminology used in electrical engineering).
+        * All contents of all the files in the `electrical_components` directory (previously `components`) are now moved into the `electrical_components.proto` file.
 
     + `microgrid.sensors`:
 

proto/frequenz/api/common/v1alpha7/microgrid/electrical_components/battery.proto

@@ -13,14 +13,6 @@ package frequenz.api.common.v1alpha7.microgrid.electrical_components;
 
 import "frequenz/api/common/v1alpha7/metrics/bounds.proto";
 import "frequenz/api/common/v1alpha7/metrics/metrics.proto";
-import "frequenz/api/common/v1alpha7/microgrid/electrical_components/battery.proto";
-import
-  "frequenz/api/common/v1alpha7/microgrid/electrical_components/ev_charger.proto";
-import "frequenz/api/common/v1alpha7/microgrid/electrical_components/fuse.proto";
-import "frequenz/api/common/v1alpha7/microgrid/electrical_components/grid.proto";
-import "frequenz/api/common/v1alpha7/microgrid/electrical_components/inverter.proto";
-import
-  "frequenz/api/common/v1alpha7/microgrid/electrical_components/transformer.proto";
 import "frequenz/api/common/v1alpha7/microgrid/lifetime.proto";
 
 import "google/protobuf/timestamp.proto";
@@ -447,6 +439,137 @@ enum ElectricalComponentDiagnosticCode {
   ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_INVERTER_DC_OVERVOLTAGE = 81;
 }
 
+// Enumerated battery types.
+enum BatteryType {
+  // Unspecified.
+  BATTERY_TYPE_UNSPECIFIED = 0;
+
+  // Li-ion batteries.
+  BATTERY_TYPE_LI_ION = 1;
+
+  // Sodium-ion batteries
+  BATTERY_TYPE_NA_ION = 2;
+}
+
+// A representation of a battery.
+message Battery {
+  // The battery type.
+  BatteryType type = 1;
+}
+
+// Enumerated EV charger types.
+enum EvChargerType {
+  // Default type.
+  EV_CHARGER_TYPE_UNSPECIFIED = 0;
+
+  // The EV charging station supports AC charging only.
+  EV_CHARGER_TYPE_AC = 1;
+
+  // The EV charging station supports DC charging only.
+  EV_CHARGER_TYPE_DC = 2;
+
+  // The EV charging station supports both AC and DC.
+  EV_CHARGER_TYPE_HYBRID = 3;
+}
+
+// A representation of an EV charging station.
+message EvCharger {
+  // The EV charger type.
+  EvChargerType type = 1;
+}
+
+// A representation of a fuse.
+// The fuse component represents a fuse in the microgrid. It is used to protect
+// components from overcurrents.
+message Fuse {
+  // The rated current of the fuse in amperes.
+  // This is the maximum current that the fuse can withstand for a long time.
+  // This limit applies to currents both flowing in or out of each of the 3
+  // phases individually.
+  //
+  // In other words, a current _i_ A at one of the phases of the node must
+  // comply with the following constraint:
+  // `-rated_fuse_current <= i <= rated_fuse_current`
+  uint32 rated_current = 1;
+}
+
+// A representation of a grid connection point. This is the point where a
+// microgrid connects to the grid.
+//
+// The terms "Grid Connection Point" and "Point of Common Coupling" (PCC) are
+// commonly used in the context.
+//
+// While both terms describe a connection point to the grid, the
+// `GridConnectionPoint` is specifically the physical connection point of the
+// generation facility to the grid, often concerned with the technical and
+// ownership aspects of the connection.
+//
+// In contrast, the PCC is is more specific in terms of electrical engineering.
+// It refers to the point where a customer's local electrical system (such as a
+// microgrid) connects to the utility distribution grid in such a way that it
+// can affect other customers’ systems connected to the same network. It is the
+// point where the grid and customer's electrical systems interface and where
+// issues like power quality and supply regulations are assessed.
+//
+// The term `GridConnectionPoint` is used to make it clear that what is referred
+// to here is the physical connection point of the local facility to the grid.
+// Note that this may also be the PCC in some cases.
+message GridConnectionPoint {
+  // This refers to the maximum amount of electrical current, in amperes, that a
+  // fuse at the grid connection point is designed to safely carry under normal
+  // operating conditions.
+  //
+  // This limit applies to currents both flowing in or out of each of the 3
+  // phases individually.
+  //
+  // In other words, a current _i_ A at one of the phases of the grid connection
+  // point must comply with the following constraint:
+  // `-rated_fuse_current <= i <= rated_fuse_current`
+  uint32 rated_fuse_current = 1;
+}
+
+// Enumerated inverter types.
+enum InverterType {
+  // Unspecified.
+  INVERTER_TYPE_UNSPECIFIED = 0;
+
+  // Battery inverter.
+  INVERTER_TYPE_BATTERY = 1;
+
+  // PV (photovoltaic) inverter.
+  INVERTER_TYPE_PV = 2;
+
+  // Hybrid inverter.
+  INVERTER_TYPE_HYBRID = 3;
+
+  // Wind turbine inverter.
+  INVERTER_TYPE_WIND_TURBINE = 4;
+}
+
+// A representation of an inverter.
+// The inverter metadata.
+message Inverter {
+  // The inverter type.
+  InverterType type = 1;
+}
+
+// A representation of a voltage transformer.
+// Voltage transformers are used to step up or step down the voltage, keeping
+// the power somewhat constant by increasing or decreasing the current.
+// If voltage is stepped up, current is stepped down, and vice versa.
+// Note that voltage transformers have efficiency losses, so the output power
+// is always less than the input power.
+message VoltageTransformer {
+  // The primary voltage of the transformer.
+  // This is the input voltage that is stepped up or down.
+  float primary = 1;
+
+  // The secondary voltage of the transformer.
+  // This is the output voltage that is the result of stepping the primary
+  // voltage up or down.
+  float secondary = 2;
+}
+
 // MetricConfigBounds describes a set of limits for a specific metric consisting
 // of a lower and upper bound for said metric.
 //
@@ -464,19 +587,16 @@ message MetricConfigBounds {
   frequenz.api.common.v1alpha7.metrics.Bounds config_bounds = 2;
 }
 
-// Metadata specific to a microgrid component.
+// Information specific to a microgrid electrical component, based upon its
+// category.
 message ElectricalComponentCategorySpecificInfo {
   oneof kind {
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.Battery battery = 1;
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.EvCharger
-      ev_charger = 2;
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.Fuse fuse = 3;
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.GridConnectionPoint
-      grid_connection_point = 4;
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.Inverter
-      inverter = 5;
-    frequenz.api.common.v1alpha7.microgrid.electrical_components.VoltageTransformer
-      voltage_transformer = 6;
+    Battery battery = 1;
+    EvCharger ev_charger = 2;
+    Fuse fuse = 3;
+    GridConnectionPoint grid_connection_point = 4;
+    Inverter inverter = 5;
+    VoltageTransformer voltage_transformer = 6;
   }
 }