Expose Consumer component through the microgrid

Signed-off-by: Daniel Zullo <[email protected]>

Author: daniel-zullo-frequenz

src/frequenz/sdk/microgrid/__init__.py

@@ -68,8 +68,7 @@
 
 This is the main power consumer at the site of a microgrid, and often the
 {{glossary("load")}} the microgrid is built to support.  The power drawn by the consumer
-is available through
-[`consumer_power`][frequenz.sdk.timeseries.logical_meter.LogicalMeter.consumer_power]
+is available through [`consumer_power`][frequenz.sdk.timeseries.consumer.Consumer.power]
 
 In locations without a consumer, this method streams zero values.
 
@@ -126,6 +125,7 @@
 from . import _data_pipeline, client, component, connection_manager, metadata
 from ._data_pipeline import (
     battery_pool,
+    consumer,
     ev_charger_pool,
     frequency,
     grid,
@@ -150,6 +150,7 @@ async def initialize(host: str, port: int, resampler_config: ResamplerConfig) ->
     "initialize",
     "client",
     "component",
+    "consumer",
     "battery_pool",
     "ev_charger_pool",
     "grid",

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -46,6 +46,7 @@
     from ..timeseries.battery_pool._battery_pool_reference_store import (
         BatteryPoolReferenceStore,
     )
+    from ..timeseries.consumer import Consumer
     from ..timeseries.ev_charger_pool import EVChargerPool
     from ..timeseries.logical_meter import LogicalMeter
 
@@ -118,6 +119,7 @@ def __init__(
         self._power_managing_actor: _power_managing.PowerManagingActor | None = None
 
         self._logical_meter: LogicalMeter | None = None
+        self._consumer: Consumer | None = None
         self._grid: Grid | None = None
         self._ev_charger_pools: dict[frozenset[int], EVChargerPool] = {}
         self._battery_pools: dict[frozenset[int], BatteryPoolReferenceStore] = {}
@@ -169,6 +171,23 @@ def logical_meter(self) -> LogicalMeter:
             )
         return self._logical_meter
 
+    def consumer(self) -> Consumer:
+        """Return the consumer instance.
+
+        If a Consumer instance doesn't exist, a new one is created and returned.
+
+        Returns:
+            A Consumer instance.
+        """
+        from ..timeseries.consumer import Consumer
+
+        if self._consumer is None:
+            self._consumer = Consumer(
+                channel_registry=self._channel_registry,
+                resampler_subscription_sender=self._resampling_request_sender(),
+            )
+        return self._consumer
+
     def ev_charger_pool(
         self,
         ev_charger_ids: set[int] | None = None,
@@ -447,6 +466,11 @@ def logical_meter() -> LogicalMeter:
     return _get().logical_meter()
 
 
+def consumer() -> Consumer:
+    """Return the [`Consumption`][frequenz.sdk.timeseries.consumer.Consumer] measuring point."""
+    return _get().consumer()
+
+
 def ev_charger_pool(ev_charger_ids: set[int] | None = None) -> EVChargerPool:
     """Return the corresponding EVChargerPool instance for the given ids.