Merge branch 'main' into dependabot/pip/dot-github/workflows/black-22.12.0

Author: lbbrhzn

.github/workflows/constraints.txt

@@ -3,9 +3,9 @@ pip>=8.0.3,<22.4
 pre-commit==2.20.0
 bandit==1.7.4
 black==22.12.0
-flake8==5.0.4
+flake8==6.0.0
 isort==5.10.1
 pre-comit-hooks==4.1.0
-pyupgrade==3.2.0
+pyupgrade==3.3.1
 reorder-python-imports==3.9.0
 sqlalchemy>=1.4.23

custom_components/ocpp/button.py

@@ -59,6 +59,7 @@ async def async_setup_entry(hass, entry, async_add_devices):
 class ChargePointButton(ButtonEntity):
     """Individual button for charge point."""
 
+    _attr_has_entity_name = True
     entity_description: OcppButtonDescription
 
     def __init__(
@@ -74,14 +75,11 @@ def __init__(
         self._attr_unique_id = ".".join(
             [BUTTON_DOMAIN, DOMAIN, self.cp_id, self.entity_description.key]
         )
-        self._attr_name = ".".join([self.cp_id, self.entity_description.name])
+        self._attr_name = self.entity_description.name
         self._attr_device_info = DeviceInfo(
             identifiers={(DOMAIN, self.cp_id)},
             via_device=(DOMAIN, self.central_system.id),
         )
-        self.entity_id = (
-            BUTTON_DOMAIN + "." + "_".join([self.cp_id, self.entity_description.key])
-        )
 
     @property
     def available(self) -> bool:

custom_components/ocpp/const.py

@@ -1,5 +1,6 @@
 """Define constants for OCPP integration."""
 import homeassistant.components.input_number as input_number
+from homeassistant.components.sensor import SensorDeviceClass
 import homeassistant.const as ha
 
 from ocpp.v16.enums import Measurand, UnitOfMeasure
@@ -95,21 +96,31 @@
 
 # Where a HA unit does not exist use Ocpp unit
 UNITS_OCCP_TO_HA = {
-    UnitOfMeasure.wh: ha.ENERGY_WATT_HOUR,
-    UnitOfMeasure.kwh: ha.ENERGY_KILO_WATT_HOUR,
+    UnitOfMeasure.wh: ha.UnitOfEnergy.WATT_HOUR,
+    UnitOfMeasure.kwh: ha.UnitOfEnergy.KILO_WATT_HOUR,
     UnitOfMeasure.varh: UnitOfMeasure.varh,
     UnitOfMeasure.kvarh: UnitOfMeasure.kvarh,
-    UnitOfMeasure.w: ha.POWER_WATT,
-    UnitOfMeasure.kw: ha.POWER_KILO_WATT,
-    UnitOfMeasure.va: ha.POWER_VOLT_AMPERE,
+    UnitOfMeasure.w: ha.UnitOfPower.WATT,
+    UnitOfMeasure.kw: ha.UnitOfPower.KILO_WATT,
+    UnitOfMeasure.va: ha.UnitOfApparentPower.VOLT_AMPERE,
     UnitOfMeasure.kva: UnitOfMeasure.kva,
     UnitOfMeasure.var: UnitOfMeasure.var,
     UnitOfMeasure.kvar: UnitOfMeasure.kvar,
-    UnitOfMeasure.a: ha.ELECTRIC_CURRENT_AMPERE,
-    UnitOfMeasure.v: ha.ELECTRIC_POTENTIAL_VOLT,
-    UnitOfMeasure.celsius: ha.TEMP_CELSIUS,
-    UnitOfMeasure.fahrenheit: ha.TEMP_FAHRENHEIT,
-    UnitOfMeasure.k: ha.TEMP_KELVIN,
+    UnitOfMeasure.a: ha.UnitOfElectricCurrent.AMPERE,
+    UnitOfMeasure.v: ha.UnitOfElectricPotential.VOLT,
+    UnitOfMeasure.celsius: ha.UnitOfTemperature.CELSIUS,
+    UnitOfMeasure.fahrenheit: ha.UnitOfTemperature.FAHRENHEIT,
+    UnitOfMeasure.k: ha.UnitOfTemperature.KELVIN,
     UnitOfMeasure.percent: ha.PERCENTAGE,
-    UnitOfMeasure.hertz: ha.FREQUENCY_HERTZ,
+    UnitOfMeasure.hertz: ha.UnitOfFrequency.HERTZ,
+}
+
+# Where an occp unit is not reported and only one possibility assign HA unit on device class
+DEFAULT_CLASS_UNITS_HA = {
+    SensorDeviceClass.CURRENT: ha.UnitOfElectricCurrent.AMPERE,
+    SensorDeviceClass.VOLTAGE: ha.UnitOfElectricPotential.VOLT,
+    SensorDeviceClass.FREQUENCY: ha.UnitOfFrequency.HERTZ,
+    SensorDeviceClass.BATTERY: ha.PERCENTAGE,
+    SensorDeviceClass.POWER: ha.UnitOfPower.KILO_WATT,
+    SensorDeviceClass.ENERGY: ha.UnitOfEnergy.KILO_WATT_HOUR,
 }

custom_components/ocpp/number.py

@@ -10,6 +10,7 @@
     NumberEntityDescription,
     RestoreNumber,
 )
+from homeassistant.const import ELECTRIC_CURRENT_AMPERE
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity import DeviceInfo
@@ -37,12 +38,13 @@ class OcppNumberDescription(NumberEntityDescription):
 NUMBERS: Final = [
     OcppNumberDescription(
         key="maximum_current",
-        name="Maximum_Current",
+        name="Maximum Current",
         icon=ICON,
         initial_value=DEFAULT_MAX_CURRENT,
         native_min_value=0,
         native_max_value=DEFAULT_MAX_CURRENT,
         native_step=1,
+        native_unit_of_measurement=ELECTRIC_CURRENT_AMPERE,
     ),
 ]
 

custom_components/ocpp/sensor.py

@@ -18,7 +18,15 @@
 from homeassistant.helpers.entity import DeviceInfo, EntityCategory
 
 from .api import CentralSystem
-from .const import CONF_CPID, DATA_UPDATED, DEFAULT_CPID, DOMAIN, ICON, Measurand
+from .const import (
+    CONF_CPID,
+    DATA_UPDATED,
+    DEFAULT_CLASS_UNITS_HA,
+    DEFAULT_CPID,
+    DOMAIN,
+    ICON,
+    Measurand,
+)
 from .enums import HAChargerDetails, HAChargerSession, HAChargerStatuses
 
 
@@ -27,6 +35,7 @@ class OcppSensorDescription(SensorEntityDescription):
     """Class to describe a Sensor entity."""
 
     scale: int = 1  # used for rounding metric
+    metric: str | None = None
 
 
 async def async_setup_entry(hass, entry, async_add_devices):
@@ -41,14 +50,16 @@ async def async_setup_entry(hass, entry, async_add_devices):
         SENSORS.append(
             OcppSensorDescription(
                 key=metric.lower(),
-                name=metric,
+                name=metric.replace(".", " "),
+                metric=metric,
             )
         )
     for metric in list(HAChargerStatuses) + list(HAChargerDetails):
         SENSORS.append(
             OcppSensorDescription(
                 key=metric.lower(),
-                name=metric,
+                name=metric.replace(".", " "),
+                metric=metric,
                 entity_category=EntityCategory.DIAGNOSTIC,
             )
         )
@@ -83,7 +94,7 @@ def __init__(
         self.central_system = central_system
         self.cp_id = cp_id
         self.entity_description = description
-        self.metric = self.entity_description.name
+        self.metric = self.entity_description.metric
         self._hass = hass
         self._extra_attr = {}
         self._last_reset = homeassistant.util.dt.utc_from_timestamp(0)
@@ -182,6 +193,10 @@ def native_unit_of_measurement(self):
         value = self.central_system.get_ha_unit(self.cp_id, self.metric)
         if value is not None:
             self._attr_native_unit_of_measurement = value
+        else:
+            self._attr_native_unit_of_measurement = DEFAULT_CLASS_UNITS_HA.get(
+                self.device_class
+            )
         return self._attr_native_unit_of_measurement
 
     async def async_added_to_hass(self) -> None:

custom_components/ocpp/switch.py

@@ -36,7 +36,7 @@ class OcppSwitchDescription(SwitchEntityDescription):
 SWITCHES: Final = [
     OcppSwitchDescription(
         key="charge_control",
-        name="Charge_Control",
+        name="Charge Control",
         icon=ICON,
         on_action=HAChargerServices.service_charge_start.name,
         off_action=HAChargerServices.service_charge_stop.name,

docs/supported-devices.md

@@ -8,6 +8,7 @@ All OCPP 1.6j compatible devices should be supported, but not every device offer
 ## [Alfen - Eve Single Pro-line](https://alfen.com/en/ev-charge-points/alfen-product-range)
 ## [Alfen - Eve Single S-line](https://alfen.com/en/ev-charge-points/alfen-product-range)
 ## [CTEK Chargestorm Connected 2](https://www.ctek.com/uk/ev-charging/chargestorm%C2%AE-connected-2)
+[Jonas Karlsson](https://github.com/jonasbkarlsson) has written a [getting started guide](https://github.com/jonasbkarlsson/ocpp/wiki/CTEK-Chargestorm-Connected-2) for connecting CTEK Chargestorm Connected 2.
 ## [EVBox Elvi](https://evbox.com/en/ev-chargers/elvi)
 ## [EVLink Wallbox Plus](https://www.se.com/ww/en/product/EVH3S22P0CK/evlink-wallbox-plus---t2-attached-cable---3-phase---32a-22kw/)
 ## [Evnex E Series & X Series Charging Stations](https://www.evnex.com/) 

docs/user-guide.md

@@ -90,6 +90,28 @@ The Grizzl-E updates these metrics every 30s during charging sessions:
 * `Availability` (ON when charger is idle. OFF during active charging session, or when something causes a problem)
 * `Maximum Current` (sets maximum charging current available. Reverts to value set by charger's internal DIP switch following reboots; tweak slider to reload)
 
+## Useful Entities for Vestel EVC-04 Wallboxes
+
+### Metrics
+
+* `Energy Active Import Register` (cumulative energy supplied to EV during charging session. Resets to zero at start of each session)
+* `Energy Active Import Interval` (in case you need the energy spent in total for the current charging session)
+* `Power Active Import` (instantaneous charging power)
+* `Current Import`
+* `Time Session` (elapsed time from start of charging session)
+
+### Diagnostics
+
+* `Status Connector` (shows the current state of available/preparing/charging/finishing/suspended etc)
+* `Stop Reason` (reason the charging session was stopped)
+
+### Controls
+
+* `Charge Control`
+* `Availability` (must be set to ON before EV is plugged in)
+* `Maximum Current` (sets maximum charging current available)
+* `Reset`
+
 ### OCPP Compatibility Issues
 
 Grizzl-E firmware has a few OCPP-compliance defects, including responding to certain OCPP server messages with invalid JSON. Symptoms of this problem include repeated reboots of the charger. By editing the OCPP server source code, one can avoid these problematic messages and obtain useful charger behaviour. ChargeLabs (the company working on the Grizzl-E firmware) expects to release version 6 of the firmware in early 2023, which may fix these problems.

requirements.txt

@@ -1,3 +1,3 @@
-homeassistant>=2021.12.0
+homeassistant>=2023.1.0b1
 ocpp==0.15.0
 websockets==10.4