Merge pull request #56 from zeronounours/add_support_for_non_grid

Add support for non grid source type (Gas, Water, Return to Grid)

Author: zeronounours

README.md

@@ -48,14 +48,15 @@ The main difference is the addition of `price` and `price_entity` options:
 
 **price** _float (optional)_
 
-The static price of the tariff (in currency/kWh)
+The static price of the tariff (in currency per source unit, e.g. USD/kWh or
+USD/m³)
 
 ---
 
 **price_entity** _string (optional)_
 
-The entity ID of a sensor giving the current price of the tariff (in
-currency/kWh)
+The entity ID of a sensor giving the current price of the tariff (in currency
+per source unit, e.g. USD/kWh or USD/m³)
 
 ---
 
@@ -67,6 +68,30 @@ Only one of `price` or `price_entity` should be given. If both are given,
 `price_entity` would have precedence. If none is defined, this integration will
 act as a basic utility meter, with no cost tracking.
 
+### Energy cost type (Gas, Water, Return to grid)
+
+The configuration can contain the optional `source_type` option to define the
+type of energy being monitored:
+
+---
+
+**source_type** _string (optional)_
+
+The type of energy being followed as source. These are the same as the builtin
+energy dashboard. It can be of 4 types:
+
+- `from_grid`: this is the default. To be used if source tracks grid
+  consumption.
+- `to_grid`: to be used if source tracks energy returned to grid.
+- `gas`: to be used if source tracks gas consumption.
+- `water`: to be used if source tracks water consumption.
+
+---
+
+Keep in mind that depending on the time, the allowed units for the source will
+differ. `from_grid` and `to_grid` needs an electrical energy, while `gas` and
+`water` expect a volume.
+
 ### Energy cost sensor only
 
 If the use of utility meter is unwanted and you only want energy costs, it is
@@ -108,6 +133,16 @@ energy_meter:
     source: sensor.energy
     price: 0.20
     create_utility_meter: false
+
+  monthly_gas:
+    source: sensor.gas_consumption
+    name: Monthly Gas
+    cycle: monthly
+    price_entity: sensor.current_gas_price
+    source_type: gas
+    tariffs:
+      - peak
+      - offpeak
 ```
 
 Usually, source energy sensors shares the same price. In order to prevent

custom_components/energy_meter/__init__.py

@@ -3,6 +3,10 @@
 import logging
 
 # Third party libraries
+from homeassistant.components.energy.sensor import (
+    SOURCE_ADAPTERS,
+    SourceAdapter,
+)
 from homeassistant.components.select import DOMAIN as SELECT_DOMAIN
 from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
 from homeassistant.components.utility_meter import (
@@ -24,9 +28,11 @@
 import voluptuous as vol
 
 from .const import (
+    CONF_ADAPTER,
     CONF_CONF,
     CONF_PRICE,
     CONF_PRICE_ENTITY,
+    CONF_SOURCE_TYPE,
     CONF_UTILITY_METER,
     DATA_ENERGY_METER,
     DOMAIN,
@@ -36,6 +42,14 @@
 _LOGGER = logging.getLogger(__name__)
 
 
+SOURCE_TYPE_TO_SOURCE_ADAPTER = {
+    "from_grid": ("grid", "flow_from"),
+    "to_grid": ("grid", "flow_to"),
+    "gas": ("gas", None),
+    "water": ("water", None),
+}
+
+
 # update the default schema w/ new options
 ENERGY_METER_CONFIG_SCHEMA = vol.Schema(
     vol.All(
@@ -44,6 +58,9 @@
                 vol.Optional(CONF_PRICE): cv.positive_float,
                 vol.Optional(CONF_PRICE_ENTITY): cv.entity_id,
                 vol.Optional(CONF_UTILITY_METER): cv.boolean,
+                vol.Optional(CONF_SOURCE_TYPE): vol.Any(
+                    *SOURCE_TYPE_TO_SOURCE_ADAPTER.keys(),
+                ),
             },
         ),
         *METER_CONFIG_SCHEMA.schema.validators[1:],
@@ -92,11 +109,21 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
             #   - for fixed price, cost sensor is bound to the meter id
             #   - for entity price, cost sensor is bound to the entity
             #     price id
-            cache_key = conf_to_cost_sensor_id(meter, conf)
+            sensor_id = conf_to_cost_sensor_id(meter, conf)
+            if (adapter := get_energy_cost_sensor_adapter(conf)) is None:
+                # stop here as we cannot create a cost sensor
+                continue
+            cache_key = (sensor_id, adapter.entity_id_suffix)
             if cache_key in hass.data[DATA_ENERGY_METER]:
                 cost_entity = hass.data[DATA_ENERGY_METER][cache_key]
             else:
-                cost_entity = await setup_energy_cost_sensor(hass, config, meter, conf)
+                cost_entity = await setup_energy_cost_sensor(
+                    hass,
+                    config,
+                    meter,
+                    conf,
+                    adapter,
+                )
                 hass.data[DATA_ENERGY_METER][cache_key] = cost_entity
 
             if create_utility_meter:
@@ -108,17 +135,19 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
                 name = um_conf.get(CONF_NAME)
                 if not name:
                     name = meter.replace("_", " ")
-                um_conf[CONF_NAME] = f"{name} Cost"
+                um_conf[CONF_NAME] = f"{name} {adapter.name_suffix}"
 
                 # Prevent the reuse of the same unique_id as the
                 # utility_meter sensors
                 if um_conf.get(CONF_UNIQUE_ID):
-                    um_conf[CONF_UNIQUE_ID] = f"{um_conf[CONF_UNIQUE_ID]}_cost"
+                    um_conf[
+                        CONF_UNIQUE_ID
+                    ] = f"{um_conf[CONF_UNIQUE_ID]}_{adapter.entity_id_suffix}"
 
                 await setup_utility_meter_sensors(
                     hass,
                     config,
-                    f"{meter}_cost",
+                    f"{meter}_{adapter.entity_id_suffix}",
                     um_conf,
                     select_entity,
                 )
@@ -217,6 +246,7 @@ async def setup_energy_cost_sensor(
     config: ConfigType,
     meter: str,
     meter_conf: dict,
+    adapter: SourceAdapter,
 ):
     """Create a cost sensor to follow an energy sensor."""
     _LOGGER.debug(
@@ -229,8 +259,43 @@ async def setup_energy_cost_sensor(
             hass,
             SENSOR_DOMAIN,
             DOMAIN,
-            {CONF_METER: meter, CONF_CONF: meter_conf},
+            {CONF_METER: meter, CONF_CONF: meter_conf, CONF_ADAPTER: adapter},
             config,
         ),
     )
-    return f"sensor.{'_'.join(conf_to_cost_sensor_id(meter, meter_conf))}_cost"
+    # return the entity id
+    return (
+        f"sensor."
+        f"{'_'.join(conf_to_cost_sensor_id(meter, meter_conf))}"
+        f"_{adapter.entity_id_suffix}"
+    )
+
+
+def get_energy_cost_sensor_adapter(conf: dict):
+    """Resolve the SourceAdapter from config."""
+    # resolve source adapter from source_type
+    source_type = conf.get(CONF_SOURCE_TYPE, "from_grid")
+    _LOGGER.debug("Setup %s: setup energy cost sensor of type %s", DOMAIN, source_type)
+
+    if source_type not in SOURCE_TYPE_TO_SOURCE_ADAPTER:
+        # should never happen if config validation is correctly set
+        _LOGGER.error(
+            "Setup %s: Unknown source type configured: %s",
+            DOMAIN,
+            source_type,
+        )
+        return None
+
+    source_adapter = SOURCE_TYPE_TO_SOURCE_ADAPTER[source_type]
+
+    for adapter in SOURCE_ADAPTERS:
+        # find the right
+        if (adapter.source_type, adapter.flow_type) == source_adapter:
+            return adapter
+    # should not happened unless builtin adapter changes
+    _LOGGER.error(
+        "Setup %s: Failed to find an appropriate source adapter for type %s",
+        DOMAIN,
+        source_type,
+    )
+    return None

custom_components/energy_meter/const.py

@@ -3,9 +3,11 @@
 DOMAIN = "energy_meter"
 
 CONF_CONF = "conf"
+CONF_ADAPTER = "adapter"
 
 CONF_PRICE = "price"
 CONF_PRICE_ENTITY = "price_entity"
 CONF_UTILITY_METER = "create_utility_meter"
+CONF_SOURCE_TYPE = "source_type"
 
 DATA_ENERGY_METER = "energy_meter_data"

custom_components/energy_meter/sensor.py

@@ -18,7 +18,13 @@
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
-from .const import CONF_CONF, CONF_PRICE, CONF_PRICE_ENTITY
+from .const import (
+    CONF_ADAPTER,
+    CONF_CONF,
+    CONF_PRICE,
+    CONF_PRICE_ENTITY,
+    DOMAIN,
+)
 from .utils import conf_to_cost_sensor_id
 
 _LOGGER = logging.getLogger(__name__)
@@ -33,25 +39,29 @@ async def async_setup_platform(
     """Set up the cost sensor."""
     if discovery_info is None:
         _LOGGER.error(
-            "This platform is not available to configure "
+            "Setup %s: This platform is not available to configure "
             "from 'sensor:' in configuration.yaml",
+            DOMAIN,
         )
         return
 
     conf = discovery_info[CONF_CONF]
     meter = discovery_info[CONF_METER]
+    adapter = discovery_info[CONF_ADAPTER]
     source = conf[CONF_SOURCE_SENSOR]
     price = conf.get(CONF_PRICE)
     price_entity = conf.get(CONF_PRICE_ENTITY)
 
+    config = {
+        adapter.stat_energy_key: source,
+        adapter.total_money_key: None,
+        "entity_energy_price": price_entity,
+        "number_energy_price": price,
+    }
+
     async_add_entities(
         [
-            EnergyCostSensor(
-                source,
-                price,
-                price_entity,
-                conf_to_cost_sensor_id(meter, conf),
-            ),
+            EnergyCostSensor(adapter, config, conf_to_cost_sensor_id(meter, conf)),
         ],
     )
 
@@ -67,28 +77,12 @@ class EnergyCostSensor(BaseEnergyCostSensor):
 
     def __init__(
         self,
-        source_entity: str,
-        price: float | None,
-        price_entity: str | None,
+        adapter: SourceAdapter,
+        config: dict,
         sensor_id: tuple[str],
     ) -> None:
         """Initialize the sensor."""
-        super().__init__(
-            SourceAdapter(
-                source_type="grid",
-                flow_type="flow_from",
-                stat_energy_key="stat_energy_from",
-                total_money_key="stat_cost",
-                name_suffix="Cost",
-                entity_id_suffix="cost",
-            ),
-            {
-                "stat_energy_from": source_entity,
-                "stat_cost": None,
-                "entity_energy_price": price_entity,
-                "number_energy_price": price,
-            },
-        )
+        super().__init__(adapter, config)
         # override the entity_id
         self._sensor_id = sensor_id
         suggested_entity_id = (