diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 74429d34..cba778b8 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -22,6 +22,8 @@ - Added new message `CommunicationComponentDiagnostic` to represent warnings and errors in microgrid communication components. - Added new message `CommunicationComponentStateSnapshot` to represent the state of communication components. - Added new message definitions for streaming events (Deleted, Created, Updated) +- Remove unnecessary gap in numbering in the `ElectricalComponentCategory` enum. +- Renumber variants in the `Metric` enum to remove unnecessary gaps. ## Bug Fixes diff --git a/proto/frequenz/api/common/v1/metrics/metric_sample.proto b/proto/frequenz/api/common/v1/metrics/metric_sample.proto index dd9bc533..1f57c63e 100644 --- a/proto/frequenz/api/common/v1/metrics/metric_sample.proto +++ b/proto/frequenz/api/common/v1/metrics/metric_sample.proto @@ -139,8 +139,8 @@ enum Metric { METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_3 = 65; METRIC_AC_REACTIVE_ENERGY = 66; METRIC_AC_REACTIVE_ENERGY_PHASE_1 = 67; - METRIC_AC_REACTIVE_ENERGY_PHASE_2 = 69; - METRIC_AC_REACTIVE_ENERGY_PHASE_3 = 70; + METRIC_AC_REACTIVE_ENERGY_PHASE_2 = 68; + METRIC_AC_REACTIVE_ENERGY_PHASE_3 = 69; // AC harmonics METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT = 80; @@ -149,9 +149,9 @@ enum Metric { METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3 = 83; // General BMS metrics. - METRIC_BATTERY_CAPACITY = 101; - METRIC_BATTERY_SOC_PCT = 102; - METRIC_BATTERY_TEMPERATURE = 103; + METRIC_BATTERY_CAPACITY = 100; + METRIC_BATTERY_SOC_PCT = 101; + METRIC_BATTERY_TEMPERATURE = 102; // General inverter metrics. METRIC_INVERTER_TEMPERATURE = 120; @@ -164,12 +164,12 @@ enum Metric { // General sensor metrics METRIC_SENSOR_WIND_SPEED = 160; - METRIC_SENSOR_WIND_DIRECTION = 162; - METRIC_SENSOR_TEMPERATURE = 163; - METRIC_SENSOR_RELATIVE_HUMIDITY = 164; - METRIC_SENSOR_DEW_POINT = 165; - METRIC_SENSOR_AIR_PRESSURE = 166; - METRIC_SENSOR_IRRADIANCE = 167; + METRIC_SENSOR_WIND_DIRECTION = 161; + METRIC_SENSOR_TEMPERATURE = 162; + METRIC_SENSOR_RELATIVE_HUMIDITY = 163; + METRIC_SENSOR_DEW_POINT = 164; + METRIC_SENSOR_AIR_PRESSURE = 165; + METRIC_SENSOR_IRRADIANCE = 166; } // Representation of a sampled metric along with its value. diff --git a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto index b926061a..e1fe3726 100644 --- a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto +++ b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto @@ -48,20 +48,20 @@ enum ElectricalComponentCategory { ELECTRICAL_COMPONENT_CATEGORY_EV_CHARGER = 6; // A crypto miner. - ELECTRICAL_COMPONENT_CATEGORY_CRYPTO_MINER = 8; + ELECTRICAL_COMPONENT_CATEGORY_CRYPTO_MINER = 7; // An electrolyzer for converting water into hydrogen and oxygen. - ELECTRICAL_COMPONENT_CATEGORY_ELECTROLYZER = 9; + ELECTRICAL_COMPONENT_CATEGORY_ELECTROLYZER = 8; // A heat and power combustion plant (CHP stands for combined heat and power). - ELECTRICAL_COMPONENT_CATEGORY_CHP = 10; + ELECTRICAL_COMPONENT_CATEGORY_CHP = 9; // A relay. // Relays generally have two states: open (connected) and closed // (disconnected). // They are generally placed in front of a component, e.g., an inverter, to // control whether the component is connected to the grid or not. - ELECTRICAL_COMPONENT_CATEGORY_RELAY = 11; + ELECTRICAL_COMPONENT_CATEGORY_RELAY = 10; // A precharge module. // Precharging involves gradually ramping up the DC voltage to prevent any @@ -69,11 +69,11 @@ enum ElectricalComponentCategory { // While many inverters and batteries come equipped with in-built precharging // mechanisms, some may lack this feature. In such cases, we need to use // external precharging modules. - ELECTRICAL_COMPONENT_CATEGORY_PRECHARGER = 12; + ELECTRICAL_COMPONENT_CATEGORY_PRECHARGER = 11; // A fuse. // Fuses are used to protect electrical components from overcurrents. - ELECTRICAL_COMPONENT_CATEGORY_FUSE = 13; + ELECTRICAL_COMPONENT_CATEGORY_FUSE = 12; // A voltage transformer. // Voltage transformers are used to step up or step down the voltage, keeping @@ -81,10 +81,10 @@ enum ElectricalComponentCategory { // 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. - ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER = 14; + ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER = 13; // An HVAC (Heating, Ventilation, and Air Conditioning) system. - ELECTRICAL_COMPONENT_CATEGORY_HVAC = 15; + ELECTRICAL_COMPONENT_CATEGORY_HVAC = 14; } // ElectricalComponentStatus defines the possible statuses for a component.