Add support for River 3 devices, clean up sensor code (#6)

* Add support for River 3, clean up sensor code
* Add total input/output energy sensors to River 3
* Add convenience descriptors for updatable fields
* Take out common bt time commands into TimeCommands class
* Update all sensor callbacks on demand
* Fix black CI job

Author: GnoX

.github/workflows/validate-code-style.yaml

@@ -17,4 +17,4 @@ jobs:
       - run: python3 -m pip install black
 
       - name: Black style validation
-        run: black .
+        run: black --check .

README.md

@@ -10,6 +10,7 @@ number of EcoFlow devices through bluetooth and monitor their status / control p
 Recognized devices:
 * Smart Home Panel 2 (EF-HD3####, FW Version: 4.0.0.122, WiFi Version: 2.0.1.20)
 * Delta Pro Ultra (EF-YJ####, FW Version: 5.0.0.25, WiFi Version: 2.0.2.4)
+* River 3, River 3 Plus (EF-R3####, FW Version: 1.0.0.0)
 
 **NOTICE**: this integration utilizes Bluetooth LE of the EF device, which is supporting just one
 connection at a time - so if you want to manage the device through BLE from your phone, you will

custom_components/ef_ble/binary_sensor.py

@@ -3,15 +3,12 @@
 import logging
 
 from homeassistant.components.binary_sensor import BinarySensorDeviceClass
-
 from homeassistant.const import EntityCategory
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from . import DeviceConfigEntry
-from .sensor import SensorBase
-from .const import DOMAIN
+from .sensor import EcoflowSensor
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -26,21 +23,21 @@ async def async_setup_entry(
 
     new_sensors = []
     if hasattr(device, "error_happened"):
-        new_sensors.append(ErrorDetectedSensor(device))
+        new_sensors.append(ErrorDetectedSensor(device, "error_happened"))
 
     if new_sensors:
         async_add_entities(new_sensors)
 
 
-class ErrorDetectedSensor(SensorBase):
+class ErrorDetectedSensor(EcoflowSensor):
     """Represents that problem happened on device."""
 
     device_class = BinarySensorDeviceClass.PROBLEM
     _attr_entity_category = EntityCategory.DIAGNOSTIC
 
-    def __init__(self, device):
+    def __init__(self, device, sensor):
         """Initialize the sensor."""
-        super().__init__(device)
+        super().__init__(device, sensor)
 
         self._attr_unique_id = f"{self._device.name}_error"
         self._attr_name = "Error"

custom_components/ef_ble/config_flow.py

@@ -3,27 +3,24 @@
 from __future__ import annotations
 
 import logging
-
 from typing import Any
 
 import voluptuous as vol
-
 from homeassistant.components.bluetooth import (
     BluetoothServiceInfoBleak,
     async_discovered_service_info,
 )
 from homeassistant.config_entries import (
+    CONN_CLASS_LOCAL_PUSH,
     ConfigFlow,
     ConfigFlowResult,
     OptionsFlow,
-    CONN_CLASS_LOCAL_PUSH,
 )
 from homeassistant.const import CONF_ADDRESS
-from homeassistant.helpers import config_validation as cv
 from homeassistant.core import callback
 
 from . import eflib
-from .const import DOMAIN, CONF_USER_ID
+from .const import CONF_USER_ID, DOMAIN
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -78,6 +75,7 @@ async def async_step_bluetooth_confirm(
             data_schema=vol.Schema(
                 {
                     vol.Required(CONF_USER_ID): str,
+                    vol.Required(CONF_ADDRESS, default=device.address): str,
                 }
             ),
         )

custom_components/ef_ble/eflib/commands.py

@@ -0,0 +1,100 @@
+import asyncio
+from dataclasses import dataclass
+import logging
+import struct
+import time
+
+from .devicebase import DeviceBase
+from .packet import Packet
+from .pb import utc_sys_pb2_v4 as utc_sys_pb2
+
+_LOGGER = logging.getLogger(__name__)
+
+
+@dataclass
+class TimeCommands:
+    device: DeviceBase
+
+    async def sendUtcTime(self):
+        """Send UTC time as unix timestamp seconds through PB"""
+        _LOGGER.debug("%s: sendUtcTime", self.device.address)
+
+        utcs = utc_sys_pb2.SysUTCSync()
+        utcs.sys_utc_time = int(time.time())
+        payload = utcs.SerializeToString()
+        packet = Packet(0x21, 0x0B, 0x01, 0x55, payload, 0x01, 0x01, 0x13)
+
+        await self.device._conn.sendPacket(packet)
+
+    async def sendRTCRespond(self):
+        """Send RTC timestamp seconds and TZ as respond to device's request"""
+        _LOGGER.debug("%s: sendRTCRespond", self.device.address)
+
+        # Building payload
+        tz_offset = (
+            (time.timezone if (time.localtime().tm_isdst == 0) else time.altzone)
+            / 60
+            / 60
+            * -1
+        )
+        tz_maj = int(tz_offset)
+        tz_min = int((tz_offset - tz_maj) * 100)
+        time_sec = int(time.time())
+        payload = (
+            struct.pack("<L", time_sec)
+            + struct.pack("<b", tz_maj)
+            + struct.pack("<b", tz_min)
+        )
+
+        # Forming packet
+        packet = Packet(
+            0x21,
+            0x35,
+            0x01,
+            Packet.NET_BLE_COMMAND_CMD_SET_RET_TIME,
+            payload,
+            0x01,
+            0x01,
+            0x03,
+        )
+
+        await self.device._conn.sendPacket(packet)
+
+    async def sendRTCCheck(self):
+        """Send command to check RTC of the device"""
+        _LOGGER.debug("%s: sendRTCCheck", self.device.address)
+
+        # Building payload
+        tz_offset = (
+            (time.timezone if (time.localtime().tm_isdst == 0) else time.altzone)
+            / 60
+            / 60
+            * -1
+        )
+        tz_maj = int(tz_offset)
+        tz_min = int((tz_offset - tz_maj) * 100)
+        time_sec = int(time.time())
+        payload = (
+            struct.pack("<L", time_sec)
+            + struct.pack("<b", tz_maj)
+            + struct.pack("<b", tz_min)
+        )
+
+        # Forming packet
+        packet = Packet(
+            0x21,
+            0x35,
+            0x01,
+            Packet.NET_BLE_COMMAND_CMD_CHECK_RET_TIME,
+            payload,
+            0x01,
+            0x01,
+            0x03,
+        )
+
+        await self.device._conn.sendPacket(packet)
+
+    def async_send_all(self):
+        asyncio.create_task(self.sendUtcTime())
+        asyncio.create_task(self.sendRTCRespond())
+        asyncio.create_task(self.sendRTCCheck())