v.1.1.7

This version Changes naming for DC Chargers and adds some bugfixes on DC Chargers. It also changes how `Sigen Plant Daily Grid Import Energy` and `Sigen Plant Daily Grid Export Energy` read energy so they are calculated from the total and not incremented.

* Enhance DC Charger naming logic, and add debug logging in coordinator
* Add section for community add-ons and tools in README.md
* Update DC Charger naming from "DC Charger" to "DC Charging"
* Remove 'keep_existing' option and related logic from config flow and strings
* Handle None value in safe_decimal function by returning Decimal(0.0)
* Change daily energy sensors to get diffrence from total. As proposed in #170
* Add support for third-party inverter energy in daily sensor calculations
* Refactor daily energy calculation to streamline lifetime data retrieval and enhance parameter handling
* Add dynamic source entity ID construction and improve daily energy calculation logic
* Enhance source entity ID construction to support explicit device context and improve fallback logic for plant-level sensors
* Revert version number to 1.1.7 in manifest.json for release

Author: TypQxQ

custom_components/sigen/calculated_sensor.py

@@ -79,7 +79,6 @@ def generate_sigen_entity(
             else:
                 sensor_id = f"{device_name} DC Charger"
             sensor_name = f"{sensor_id} {description.name}"
-            # Keep device_type as DEVICE_TYPE_DC_CHARGER, don't change it to DEVICE_TYPE_INVERTER
         else:
             sensor_name = f"{device_name} {description.name}"
             sensor_id = sensor_name
@@ -266,6 +265,8 @@ def safe_float(value: Any, precision: int = 6) -> Optional[float]:
 def safe_decimal(value: Any) -> Optional[Decimal]:
     """Convert to Decimal only if possible, else None."""
     try:
+        if value is None:
+            return Decimal(0.0)
         return Decimal(str(value))
     except (InvalidOperation, TypeError, ValueError):
         _LOGGER.warning("Could not convert value %s (type %s) to Decimal", value, type(value).__name__)

custom_components/sigen/common.py

@@ -47,7 +47,6 @@
     CONF_PARENT_PLANT_ID,
     CONF_INVERTER_HAS_DCCHARGER,
     CONF_READ_ONLY,
-    CONF_KEEP_EXISTING,
     CONF_REMOVE_DEVICE,
     CONF_SCAN_INTERVAL,
     DEVICE_TYPE_NEW_PLANT,
@@ -56,7 +55,6 @@
     DEVICE_TYPE_DC_CHARGER,
     DEVICE_TYPE_PLANT,
     DEVICE_TYPE_UNKNOWN,
-    LEGACY_SENSOR_MIGRATION_MAP,
     STEP_DHCP_PLANT_CONFIG,
     STEP_DEVICE_TYPE,
     STEP_PLANT_CONFIG,
@@ -108,7 +106,6 @@ def generate_plant_schema(
         user_input,
         discovered_ip = "",
         use_inverter_device_id = False,
-        keep_existing_alternative = False,
         display_update_frq = False
     ) -> vol.Schema:
     """Dynamically create schema using the determined prefill_host
@@ -117,7 +114,6 @@ def generate_plant_schema(
         user_input (_type_, optional): _description_. Defaults to None.
         discovered_ip (str, optional): _description_. Defaults to "".
         use_inverter_device_id (bool, optional): _description_. Defaults to False.
-        keep_existing_alternative (bool, optional): _description_. Defaults to False.
         display_update_frq (bool, optional): _description_. Defaults to False.
 
     Returns:
@@ -135,9 +131,6 @@ def generate_plant_schema(
     validation_schema[vol.Required(CONF_READ_ONLY,
                                    default=user_input.get(CONF_READ_ONLY, DEFAULT_READ_ONLY))] = bool
 
-    if keep_existing_alternative:
-        validation_schema[vol.Required(CONF_KEEP_EXISTING,
-                                       default=user_input.get(CONF_KEEP_EXISTING, False))] = bool
     if display_update_frq:
         validation_schema[vol.Required(CONF_SCAN_INTERVAL,
                                        default=user_input.get(CONF_SCAN_INTERVAL,DEFAULT_SCAN_INTERVAL))] = vol.All(vol.Coerce(int))
@@ -285,20 +278,7 @@ async def async_step_dhcp_plant_config(
         errors = {}
 
         # Check if the accumulated energy consumption sensor exists
-        keep_existing = self.hass.states.get(next(iter(LEGACY_SENSOR_MIGRATION_MAP.values())))
-        if keep_existing:
-            _LOGGER.debug(
-            "Found old yaml integration."
-            )
-            # Give an error that it is recommended to remove the old integration.
-        else:
-            _LOGGER.debug("Old yaml integration does not exist.")
-
-        validation_schema = {vol.Required(CONF_READ_ONLY, default=DEFAULT_READ_ONLY): bool}
-        if keep_existing:
-            validation_schema[vol.Required(CONF_KEEP_EXISTING, default=False)] = bool
-
-        schema = vol.Schema(validation_schema)
+        schema = vol.Schema({vol.Required(CONF_READ_ONLY, default=DEFAULT_READ_ONLY): bool})
 
         if user_input is None:
             return self.async_show_form(
@@ -307,10 +287,6 @@ async def async_step_dhcp_plant_config(
                 description_placeholders={"ip_address": self._discovered_ip},
             )
 
-        # Check if keep_existing is set to True, if so and the user has not approved to continue, throw an error.
-        if keep_existing and not user_input.get(CONF_KEEP_EXISTING, False):
-            errors[CONF_KEEP_EXISTING] = "old_config_found"
-
         if errors:
             return self.async_show_form(
                 step_id=STEP_DHCP_PLANT_CONFIG,
@@ -457,21 +433,9 @@ async def async_step_plant_config(
         errors = {}
         has_dc_charger = False
 
-        # Check if the accumulated energy consumption sensor exists
-        legacy_yaml_present = self.hass.states.get(next(iter(LEGACY_SENSOR_MIGRATION_MAP.values())))
-        if legacy_yaml_present:
-            _LOGGER.debug(
-            "Found old yaml integration."
-            )
-            # Store or use accumulatedEnergyState.state if needed for setup logic
-        else:
-            _LOGGER.debug("Old yaml integration does not exist.")
-
-
         if user_input is None:
             schema = generate_plant_schema(DEFAULT_PLANT_CONNECTION,
                                            discovered_ip=self._discovered_ip or "",
-                                           keep_existing_alternative=bool(legacy_yaml_present),
                                            use_inverter_device_id=True,
                                            display_update_frq=True
             )
@@ -481,10 +445,6 @@ async def async_step_plant_config(
                 data_schema=schema,
             )
 
-        # Check if keep_existing is set to True, if so and the user has not approved to continue, throw an error.
-        if legacy_yaml_present and not user_input.get(CONF_KEEP_EXISTING, False):
-            errors[CONF_KEEP_EXISTING] = "old_config_found"
-
         # Process and validate inverter ID
         try:
             inverter_id = int(user_input[CONF_INVERTER_SLAVE_ID])
@@ -511,7 +471,6 @@ async def async_step_plant_config(
                 step_id=STEP_PLANT_CONFIG,
                 data_schema=generate_plant_schema(user_input,
                                                   discovered_ip=self._discovered_ip or "",
-                                                  keep_existing_alternative=bool(legacy_yaml_present),
                                                   use_inverter_device_id=True,
                                                   display_update_frq=True
                                                   ),
@@ -522,6 +481,7 @@ async def async_step_plant_config(
         new_plant_connection = DEFAULT_PLANT_CONNECTION.copy()
         new_plant_connection[CONF_HOST] = user_input[CONF_HOST]
         new_plant_connection[CONF_PORT] = user_input[CONF_PORT]
+        new_plant_connection[CONF_SLAVE_ID] = DEFAULT_PLANT_SLAVE_ID
         new_plant_connection[CONF_SCAN_INTERVAL] = user_input[CONF_SCAN_INTERVAL]
         self._data[CONF_PLANT_CONNECTION] = new_plant_connection
 

custom_components/sigen/config_flow.py

@@ -23,7 +23,6 @@
 CONF_DC_CHARGER_CONNECTIONS = "dc_charger_connections"
 CONF_DEVICE_TYPE = "device_type"
 CONF_PARENT_DEVICE_ID = "parent_device_id"
-CONF_KEEP_EXISTING = "keep_existing"
 CONF_VALUES_TO_INIT = "values_to_initialize"
 STEP_ACCUMULATED_ENERGY_CONFIG = "accumulated_energy_config"
 

custom_components/sigen/const.py

@@ -3,7 +3,7 @@
   "name": "Sigenergy ESS",
   "codeowners": ["@TypQxQ"],
   "config_flow": true,
-  "dependencies": ["modbus", "integration"],
+  "dependencies": ["modbus", "integration", "recorder"],
   "dhcp": [
     {
       "macaddress": "0C47A99*",
@@ -21,5 +21,5 @@
   "loggers": ["custom_components.sigen"],
   "quality_scale": "custom",
   "requirements": ["pymodbus>=3.8.3"],
-  "version": "1.1.6"
+  "version": "1.1.7"
 }

custom_components/sigen/manifest.json

@@ -897,7 +897,7 @@ async def async_read_plant_data(self) -> Dict[str, Any]:
                         **{name: reg for name, reg in PLANT_PARAMETER_REGISTERS.items()
                            if reg.register_type != RegisterType.WRITE_ONLY}
                     }
-                    _LOGGER.debug("Attempting to probe plant registers...")
+                    _LOGGER.debug("Attempting to probe plant registers on %s...", plant_info)
                     self.plant_register_intervals = await self.async_probe_registers(
                         plant_info, all_plant_registers
                     )
@@ -951,7 +951,7 @@ async def async_read_inverter_data(self, inverter_name: str) -> Dict[str, Any]:
                         **{name: reg for name, reg in INVERTER_PARAMETER_REGISTERS.items()
                            if reg.register_type != RegisterType.WRITE_ONLY}
                     }
-                    _LOGGER.debug("Attempting to probe inverter '%s' registers...", inverter_name)
+                    _LOGGER.debug("Attempting to probe inverter '%s' registers on %s...", inverter_name, inverter_info)
                     self.inverter_register_intervals[inverter_name] = await self.async_probe_registers(
                         inverter_info, all_inverter_registers
                     )
@@ -1001,7 +1001,7 @@ async def async_read_dc_charger_data(self, inverter_name: str) -> Dict[str, Any]
                         **{name: reg for name, reg in DC_CHARGER_PARAMETER_REGISTERS.items()
                            if reg.register_type != RegisterType.WRITE_ONLY}
                     }
-                    _LOGGER.debug("Attempting to probe DC charger '%s' registers...", inverter_name)
+                    _LOGGER.debug("Attempting to probe DC charger '%s' registers on %s...", inverter_name, inverter_info)
                     self.dc_charger_register_intervals[inverter_name] = await self.async_probe_registers(
                         inverter_info, all_dc_charger_registers
                     )

custom_components/sigen/modbus.py

@@ -9,7 +9,6 @@
     SensorDeviceClass,
     SensorEntity,
     SensorEntityDescription,
-    SensorStateClass,
 )
 from homeassistant.config_entries import (  # pylint: disable=syntax-error
     ConfigEntry,
@@ -31,11 +30,11 @@
     SigenergyCalculations as SC,
     SigenergyCalculatedSensors as SCS,
     SigenergyIntegrationSensor,
+    SigenergyLifetimeDailySensor,
 )
 from .static_sensor import StaticSensors as SS
 from .static_sensor import COORDINATOR_DIAGNOSTIC_SENSORS # Import the new descriptions
 from .common import generate_sigen_entity, generate_device_id, SigenergySensorEntityDescription, SensorEntityDescription
-import inspect
 from .const import (
     DOMAIN,
     DEVICE_TYPE_PLANT,
@@ -63,7 +62,8 @@ async def async_setup_entry(
     entities_to_add = []
 
     # Helper to add entities to the list
-    def add_entities_for_device(device_name, device_conn, entity_descriptions, entity_class, device_type, **kwargs):
+    def add_entities_for_device(device_name, device_conn,
+                                entity_descriptions, entity_class, device_type, **kwargs):
         entities_to_add.extend(
             generate_sigen_entity(
                 plant_name,
@@ -79,7 +79,13 @@ def add_entities_for_device(device_name, device_conn, entity_descriptions, entit
 
     # Plant Sensors
     add_entities_for_device(None, None, SS.PLANT_SENSORS, SigenergySensor, DEVICE_TYPE_PLANT)
-    add_entities_for_device(None, None, SCS.PLANT_SENSORS, SigenergySensor, DEVICE_TYPE_PLANT)
+    
+    # Add calculated plant sensors (all use regular SigenergySensor class)
+    add_entities_for_device(None, None, SCS.PLANT_SENSORS, SigenergySensor, DEVICE_TYPE_PLANT, hass=hass)
+    
+    # Add lifetime-based daily sensors with the special sensor class
+    add_entities_for_device(None, None, SCS.PLANT_LIFETIME_DAILY_SENSORS, SigenergyLifetimeDailySensor, DEVICE_TYPE_PLANT, hass=hass)
+    
     add_entities_for_device(None, None, SCS.PLANT_INTEGRATION_SENSORS, SigenergyIntegrationSensor, DEVICE_TYPE_PLANT, hass=hass)
     add_entities_for_device(None, None, list(COORDINATOR_DIAGNOSTIC_SENSORS), CoordinatorDiagnosticSensor, DEVICE_TYPE_PLANT)
 
@@ -113,7 +119,10 @@ def add_entities_for_device(device_name, device_conn, entity_descriptions, entit
 
         # DC Charger
         if device_conn.get(CONF_INVERTER_HAS_DCCHARGER, False):
-            dc_name = f"{device_name} DC Charger"
+            if "dc charger" not in device_name.lower():
+                dc_name = f"{device_name} DC Charger"
+            else:
+                dc_name = device_name
             parent_inverter_id = f"{coordinator.hub.config_entry.entry_id}_{generate_device_id(device_name)}"
             dc_id = f"{parent_inverter_id}_dc_charger"
             dc_device_info = DeviceInfo(

custom_components/sigen/sensor.py

@@ -1668,47 +1668,47 @@ class StaticSensors:
     DC_CHARGER_SENSORS = [
         SigenergySensorEntityDescription(
             key="dc_charger_vehicle_battery_voltage",
-            name="DC Charger Vehicle Battery Voltage",
+            name="Vehicle Battery Voltage",
             device_class=SensorDeviceClass.VOLTAGE,
             native_unit_of_measurement=UnitOfElectricPotential.VOLT,
             state_class=SensorStateClass.MEASUREMENT,
             icon="mdi:car-battery",
         ),
         SigenergySensorEntityDescription(
             key="dc_charger_charging_current",
-            name="DC Charger Charging Current",
+            name="Charging Current",
             device_class=SensorDeviceClass.CURRENT,
             native_unit_of_measurement=UnitOfElectricCurrent.AMPERE,
             state_class=SensorStateClass.MEASUREMENT,
             icon="mdi:car-electric",
         ),
         SigenergySensorEntityDescription(
             key="dc_charger_output_power",
-            name="DC Charger Output Power",
+            name="Output Power",
             device_class=SensorDeviceClass.POWER,
             native_unit_of_measurement=UnitOfPower.KILO_WATT,
             state_class=SensorStateClass.MEASUREMENT,
             icon="mdi:ev-plug-ccs2",
         ),
         SigenergySensorEntityDescription(
             key="dc_charger_vehicle_soc",
-            name="DC Charger Vehicle SOC",
+            name="Vehicle SOC",
             device_class=SensorDeviceClass.BATTERY,
             native_unit_of_measurement=PERCENTAGE,
             state_class=SensorStateClass.MEASUREMENT,
             icon="mdi:battery",
         ),
         SigenergySensorEntityDescription(
             key="dc_charger_current_charging_capacity",
-            name="DC Charger Current Charging Capacity (Single Time)",
+            name="Current Charging Capacity (Single Time)",
             device_class=SensorDeviceClass.ENERGY,
             native_unit_of_measurement=UnitOfEnergy.KILO_WATT_HOUR,
             state_class=SensorStateClass.TOTAL,
             icon="mdi:car-electric",
         ),
         SigenergySensorEntityDescription(
             key="dc_charger_current_charging_duration",
-            name="DC Charger Current Charging Duration (Single Time)",
+            name="Current Charging Duration (Single Time)",
             icon="mdi:timer",
             state_class=SensorStateClass.MEASUREMENT,
         ),

custom_components/sigen/static_sensor.py

@@ -9,12 +9,10 @@
         "title": "Configure Sigenergy Plant",
         "description": "A new Sigenergy device was discovered at {ip_address}. Select your configuration options:",
         "data": {
-          "read_only": "Read-Only Mode",
-          "keep_existing": "Keep Existing Sensors (and potentially rename new ones)"
+          "read_only": "Read-Only Mode"
         },
         "data_description": {
-          "read_only": "(Prevents Home Assistant from making changes to the Sigenergy system. Recommended for initial setup. Can be changed later in device settings.)",
-          "keep_existing": "If you have previous configurations for this device, adding it again might create duplicate or numbered sensors (e.g., `sensor_name_2`).\n\nRECOMMENDED PATH: Leave this unchecked and manually delete any old Sigenergy YAML configuration and related sensor entities in Home Assistant *before* submitting. This ensures new sensors use standard names.\n\nALTERNATIVE PATH: Check this box to keep existing sensors. No cleanup is needed beforehand, but new sensors with conflicting names will be automatically numbered. You can manage/rename sensors later in device settings."
+          "read_only": "(Prevents Home Assistant from making changes to the Sigenergy system. Recommended for initial setup. Can be changed later in device settings.)"
         }
       },
       "device_type": {
@@ -36,12 +34,10 @@
           "scan_interval": "Scan Interval (seconds)",
           "migrate_yaml": "Migrate legacy YAML sensor values",
           "migrate_yaml_description": "If enabled, initial sensor values will be imported from the legacy YAML configuration (if present).",
-          "read_only": "Read-Only Mode",
-          "keep_existing": "Keep Existing Sensors (and potentially rename new ones)"
+          "read_only": "Read-Only Mode"
         },
         "data_description": {
-          "read_only": "(Prevents Home Assistant from making changes to the Sigenergy system. Recommended for initial setup. Can be changed later in device settings.)",
-          "keep_existing": "If you have previous configurations for this device, adding it again might create duplicate or numbered sensors (e.g., `sensor_name_2`).\n\nRECOMMENDED PATH: Leave this unchecked and manually delete any old Sigenergy YAML configuration and related sensor entities in Home Assistant *before* submitting. This ensures new sensors use standard names.\n\nALTERNATIVE PATH: Check this box to keep existing sensors. No cleanup is needed beforehand, but new sensors with conflicting names will be automatically numbered. You can manage/rename sensors later in device settings."
+          "read_only": "(Prevents Home Assistant from making changes to the Sigenergy system. Recommended for initial setup. Can be changed later in device settings.)"
         }
       },
       "select_plant": {
@@ -105,8 +101,7 @@
       "cannot_be_lower_than_high": "Cannot be lower than the high interval.",
       "cannot_be_lower_than_medium": "Cannot be lower than the medium interval.",
       "invalid_host": "Invalid host address provided.",
-      "invalid_port": "Invalid port number. Must be between 1 and 65535.",
-      "old_config_found": "Please approve potential sensor renaming (check the box) or delete the old configuration before continuing."
+      "invalid_port": "Invalid port number. Must be between 1 and 65535."
     },
     "abort": {
       "already_configured": "This Sigenergy system is already configured.",

custom_components/sigen/strings.json

@@ -110,8 +110,8 @@ class SigenergySwitchEntityDescription(SwitchEntityDescription):
 
 DC_CHARGER_SWITCHES: list[SigenergySwitchEntityDescription] = [
     SigenergySwitchEntityDescription(
-        key="dc_charger_start_stop",
-        name="DC Charger",
+        key="dc_charging",
+        name="DC Charging",
         icon="mdi:ev-station",
         is_on_fn=lambda data, identifier: data.get("dc_chargers", {}).get(identifier, {}).get("dc_charger_output_power", 0) > 0,
         turn_on_fn=lambda coordinator, identifier: coordinator.async_write_parameter("dc_charger", identifier, "dc_charger_start_stop", 0),
@@ -131,7 +131,8 @@ async def async_setup_entry(
     entities_to_add = []
 
     # Helper to add entities to the list
-    def add_entities_for_device(device_name, device_conn, entity_descriptions, device_type, **kwargs):
+    def add_entities_for_device(device_name, device_conn,
+                                entity_descriptions, device_type, **kwargs):
         entities_to_add.extend(
             generate_sigen_entity(
                 plant_name,