Handle charger unavailability and increase testing to fail under 90%

custom_components/ocpp/api.py

@@ -6,7 +6,7 @@
 from typing import Dict
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import TIME_MINUTES
+from homeassistant.const import STATE_OK, STATE_UNAVAILABLE, TIME_MINUTES
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers import device_registry, entity_component, entity_registry
 import voluptuous as vol
@@ -163,6 +163,7 @@ async def on_connect(self, websocket, path: str):
         except Exception as e:
             _LOGGER.info(f"Exception occurred:\n{e}")
         finally:
+            self.charge_points[self.cpid].status = STATE_UNAVAILABLE
             _LOGGER.info(f"Charger {cp_id} disconnected from {self.host}:{self.port}.")
 
     def get_metric(self, cp_id: str, measurand: str):
@@ -183,6 +184,12 @@ def get_extra_attr(self, cp_id: str, measurand: str):
             return self.charge_points[cp_id].get_extra_attr(measurand)
         return None
 
+    def get_available(self, cp_id: str):
+        """Return whether the charger is available."""
+        if cp_id in self.charge_points:
+            return self.charge_points[cp_id].status == STATE_OK
+        return False
+
     async def set_charger_state(
         self, cp_id: str, service_name: str, state: bool = True
     ):
@@ -260,10 +267,14 @@ async def post_connect(self):
         # Define custom service handles for charge point
         async def handle_clear_profile(call):
             """Handle the clear profile service call."""
+            if self.status == STATE_UNAVAILABLE:
+                return
             await self.clear_profile()
 
         async def handle_set_charge_rate(call):
             """Handle the set charge rate service call."""
+            if self.status == STATE_UNAVAILABLE:
+                return
             lim_A = call.data.get("limit_amps")
             lim_W = call.data.get("limit_watts")
             if lim_A is not None and lim_W is not None:
@@ -277,24 +288,29 @@ async def handle_set_charge_rate(call):
 
         async def handle_update_firmware(call):
             """Handle the firmware update service call."""
+            if self.status == STATE_UNAVAILABLE:
+                return
             url = call.data.get("firmware_url")
             delay = int(call.data.get("delay_hours", 0))
             await self.update_firmware(url, delay)
 
         async def handle_configure(call):
             """Handle the configure service call."""
+            if self.status == STATE_UNAVAILABLE:
+                return
             key = call.data.get("ocpp_key")
             value = call.data.get("value")
             await self.configure(key, value)
-            return
 
         async def handle_get_configuration(call):
             """Handle the get configuration service call."""
+            if self.status == STATE_UNAVAILABLE:
+                return
             key = call.data.get("ocpp_key")
             await self.get_configuration(key)
-            return
 
         try:
+            self.status = STATE_OK
             await self.get_supported_features()
             if om.feature_profile_remote.value in self._features_supported:
                 await self.trigger_boot_notification()
@@ -649,7 +665,11 @@ async def start(self):
     async def reconnect(self, connection):
         """Reconnect charge point."""
         self._connection = connection
-        await self.start()
+        try:
+            self.status = STATE_OK
+            await super().start()
+        except websockets.exceptions.ConnectionClosed as e:
+            _LOGGER.debug(e)
 
     async def async_update_device_info(self, boot_info: dict):
         """Update device info asynchronuously."""
@@ -719,31 +739,31 @@ def process_phases(self, data):
     @on(Action.MeterValues)
     def on_meter_values(self, connector_id: int, meter_value: Dict, **kwargs):
         """Request handler for MeterValues Calls."""
+        m = om.measurand.value
         for bucket in meter_value:
             unprocessed = bucket[om.sampled_value.name]
             processed_keys = []
             for idx, sv in enumerate(bucket[om.sampled_value.name]):
-                if om.measurand.value in sv and om.phase.value not in sv:
-                    self._metrics[sv[om.measurand.value]] = round(
-                        float(sv[om.value.value]), 1
-                    )
+                if m in sv and om.phase.value not in sv:
+                    self._metrics[sv[m]] = round(float(sv[om.value.value]), 1)
                     if om.unit.value in sv:
                         if sv[om.unit.value] == DEFAULT_POWER_UNIT:
-                            self._metrics[sv[om.measurand.value]] = (
-                                float(sv[om.value.value]) / 1000
-                            )
-                            self._units[sv[om.measurand.value]] = HA_POWER_UNIT
+                            self._metrics[sv[m]] = float(sv[om.value.value]) / 1000
+                            self._units[sv[m]] = HA_POWER_UNIT
                         if sv[om.unit.value] == DEFAULT_ENERGY_UNIT:
-                            self._metrics[sv[om.measurand.value]] = (
-                                float(sv[om.value.value]) / 1000
-                            )
-                            self._units[sv[om.measurand.value]] = HA_ENERGY_UNIT
+                            self._metrics[sv[m]] = float(sv[om.value.value]) / 1000
+                            self._units[sv[m]] = HA_ENERGY_UNIT
                     processed_keys.append(idx)
                 if len(sv.keys()) == 1:  # for backwards compatibility
                     self._metrics[DEFAULT_MEASURAND] = float(sv[om.value.value]) / 1000
                     self._units[DEFAULT_MEASURAND] = HA_ENERGY_UNIT
                     processed_keys.append(idx)
-                self._extra_attr[sv[om.location.value]] = sv.get(om.location.value)
+                if m in sv and om.location.value in sv:
+                    if self._extra_attr.get(sv[m]) is None:
+                        self._extra_attr[sv[m]] = {}
+                    self._extra_attr[sv[m]][om.location.value] = sv.get(
+                        om.location.value
+                    )
             for idx in sorted(processed_keys, reverse=True):
                 unprocessed.pop(idx)
             # _LOGGER.debug("Meter data not yet processed: %s", unprocessed)

custom_components/ocpp/const.py

@@ -1,7 +1,9 @@
 """Define constants for OCPP integration."""
 import homeassistant.const as ha
 
-from ocpp.v16.enums import Measurand, UnitOfMeasure
+from ocpp.v16.enums import ChargePointStatus, Measurand, UnitOfMeasure
+
+from .enums import HAChargerServices, HAChargerStatuses
 
 DOMAIN = "ocpp"
 CONF_METER_INTERVAL = "meter_interval"
@@ -63,26 +65,32 @@
 HA_ENERGY_UNIT = UnitOfMeasure.kwh.value
 HA_POWER_UNIT = UnitOfMeasure.kw.value
 
-# Additional conditions/states to monitor
-CONDITIONS = [
-    "Status",
-    "Heartbeat",
-    "Error.Code",
-    "Stop.Reason",
-    "FW.Status",
-    "Session.Time",  # in min
-    "Session.Energy",  # in kWh
-    "Meter.Start",  # in kWh
-]
-
-# Additional general information to report
-GENERAL = [
-    "ID",
-    "Model",
-    "Vendor",
-    "Serial",
-    "FW.Version",
-    "Features",
-    "Connectors",
-    "Transaction.Id",
-]
+# Switch configuration definitions
+# At a minimum define switch name and on service call, pulse used to call a service once such as reset
+# metric and condition combination can be used to drive switch state, use default to set initial state to True
+SWITCH_CHARGE = {
+    "name": "Charge_Control",
+    "on": HAChargerServices.service_charge_start.name,
+    "off": HAChargerServices.service_charge_stop.name,
+    "metric": HAChargerStatuses.status.value,
+    "condition": ChargePointStatus.charging.value,
+}
+SWITCH_AVAILABILITY = {
+    "name": "Availability",
+    "on": HAChargerServices.service_availability.name,
+    "off": HAChargerServices.service_availability.name,
+    "default": True,
+    "metric": HAChargerStatuses.status.value,
+    "condition": ChargePointStatus.available.value,
+}
+SWITCH_RESET = {
+    "name": "Reset",
+    "on": HAChargerServices.service_reset.name,
+    "pulse": True,
+}
+SWITCH_UNLOCK = {
+    "name": "Unlock",
+    "on": HAChargerServices.service_unlock.name,
+    "pulse": True,
+}
+SWITCHES = [SWITCH_CHARGE, SWITCH_RESET, SWITCH_UNLOCK, SWITCH_AVAILABILITY]

custom_components/ocpp/enums.py

@@ -5,7 +5,7 @@
 class HAChargerServices(str, Enum):
     """Charger status conditions to report in home assistant."""
 
-    """For HA service reference use .name for function to call use .value"""
+    """For HA service reference and for function to call use .value"""
 
     service_charge_start = "start_transaction"
     service_charge_stop = "stop_transaction"

custom_components/ocpp/sensor.py

@@ -67,6 +67,11 @@ def state(self):
         """Return the state of the sensor."""
         return self.central_system.get_metric(self.cp_id, self.metric)
 
+    @property
+    def available(self) -> bool:
+        """Return if switch is available."""
+        return self.central_system.get_available(self.cp_id)
+
     @property
     def unit_of_measurement(self):
         """Return the unit the value is expressed in."""

custom_components/ocpp/switch.py

@@ -3,39 +3,8 @@
 
 from homeassistant.components.switch import SwitchEntity
 
-from ocpp.v16.enums import ChargePointStatus
-
 from .api import CentralSystem
-from .const import CONF_CPID, DOMAIN, ICON
-from .enums import HAChargerServices, HAChargerStatuses
-
-# At a minimum define switch name and on service call, pulse used to call a service once such as reset
-# metric and condition combination can be used to drive switch state, use default to set initial state to True
-SWITCH_CHARGE = {
-    "name": "Charge_Control",
-    "on": HAChargerServices.service_charge_start.name,
-    "off": HAChargerServices.service_charge_stop.name,
-    "metric": HAChargerStatuses.status.value,
-    "condition": ChargePointStatus.charging.value,
-}
-SWITCH_AVAILABILITY = {
-    "name": "Availability",
-    "on": HAChargerServices.service_availability.name,
-    "off": HAChargerServices.service_availability.name,
-    "default": True,
-    "metric": HAChargerStatuses.status.value,
-    "condition": ChargePointStatus.available.value,
-}
-SWITCH_RESET = {
-    "name": "Reset",
-    "on": HAChargerServices.service_reset.name,
-    "pulse": True,
-}
-SWITCH_UNLOCK = {
-    "name": "Unlock",
-    "on": HAChargerServices.service_unlock.name,
-    "pulse": True,
-}
+from .const import CONF_CPID, DOMAIN, ICON, SWITCHES
 
 
 async def async_setup_entry(hass, entry, async_add_devices):
@@ -45,7 +14,7 @@ async def async_setup_entry(hass, entry, async_add_devices):
 
     entities = []
 
-    for ent in [SWITCH_CHARGE, SWITCH_AVAILABILITY, SWITCH_RESET, SWITCH_UNLOCK]:
+    for ent in SWITCHES:
         entities.append(ChargePointSwitch(central_system, cp_id, ent))
 
     async_add_devices(entities, False)
@@ -76,7 +45,7 @@ def unique_id(self):
     @property
     def available(self) -> bool:
         """Return if switch is available."""
-        return True  # type: ignore [no-any-return]
+        return self.central_system.get_available(self.cp_id)  # type: ignore [no-any-return]
 
     @property
     def is_on(self) -> bool:

setup.cfg

@@ -41,5 +41,5 @@ branch = False
 
 [coverage:report]
 show_missing = true
-fail_under = 80
+fail_under = 90