feat(smart-plug,powerstream): Add button to trigger full-sync

Corrects the max/min charge level for the powerstream to 0-100%

relates-to: #704, #758, #560, #469

Author: mucer

README.md

@@ -1029,7 +1029,7 @@ For information on how to add, remove, and configure devices, please refer to th
 
 </p></details>
 
-<details><summary> POWERSTREAM <i>(sensors: 63, switches: 1, sliders: 2, boxes: 1, selects: 1)</i> </summary>
+<details><summary> POWERSTREAM <i>(sensors: 63, switches: 1, sliders: 2, boxes: 1, selects: 1, buttons: 1)</i> </summary>
 <p>
 
 *Sensors*
@@ -1110,6 +1110,9 @@ For information on how to add, remove, and configure devices, please refer to th
 *Selects*
 - Power supply mode 
 
+*Buttons*
+- Trigger Full Sync
+
 </p></details>
 
 <details><summary> GLACIER <i>(sensors: 29, binary_sensors: 4, switches: 3, sliders: 3)</i> </summary>
@@ -1272,7 +1275,7 @@ For information on how to add, remove, and configure devices, please refer to th
 </p></details>
 
 
-<details><summary> SMART_PLUG <i>(sensors: 5, switches: 1, sliders: 2)</i> </summary>
+<details><summary> SMART_PLUG <i>(sensors: 5, switches: 1, sliders: 2, buttons: 1)</i> </summary>
 <p>
 
 *Sensors*
@@ -1289,6 +1292,9 @@ For information on how to add, remove, and configure devices, please refer to th
 - Brightness
 - Max Power
 
+*Buttons*
+- Trigger Full Sync
+
 </p></details>
 
 <details><summary> STREAM_AC <i>(sensors: 39)</i> </summary>

custom_components/ecoflow_cloud/button.py

@@ -22,17 +22,15 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry, async_add_e
         async_add_entities([ReconnectButtonEntity(client, device)])
 
 
-class EnabledButtonEntity(BaseButtonEntity):
+class SetMessageButtonEntity(BaseButtonEntity):
     def press(self, **kwargs: Any) -> None:
         if self._command:
             self.send_set_message(0, self.command_dict(0))
 
-
-class DisabledButtonEntity(BaseButtonEntity):
-    async def async_press(self, **kwargs: Any) -> None:
+class GetMessageButtonEntity(BaseButtonEntity):
+    def press(self, **kwargs: Any) -> None:
         if self._command:
-            self.send_set_message(0, self.command_dict(0))
-
+            self.send_get_message(self.command_dict(0))
 
 class ReconnectButtonEntity(ButtonEntity, EcoFlowAbstractEntity):
     def __init__(self, client: EcoflowApiClient, device):

custom_components/ecoflow_cloud/devices/const.py

@@ -261,6 +261,7 @@
 MODE_AC2_ON = "AC 2 On"
 BRIGHTNESS = "Brightness"
 BEEPER = "Beeper"
+TRIGGER_FULL_SYNC = "Trigger Full Sync"
 USB_ENABLED = "USB Enabled"
 AC_ENABLED = "AC Enabled"
 BYPASS_AC = "Bypass AC auto start"

custom_components/ecoflow_cloud/devices/internal/glacier.py

@@ -7,7 +7,7 @@
 from homeassistant.components.switch import SwitchEntity
 
 from custom_components.ecoflow_cloud.api import EcoflowApiClient
-from custom_components.ecoflow_cloud.button import EnabledButtonEntity
+from custom_components.ecoflow_cloud.button import SetMessageButtonEntity
 from custom_components.ecoflow_cloud.devices import BaseInternalDevice, const
 from custom_components.ecoflow_cloud.number import SetTempEntity
 from custom_components.ecoflow_cloud.sensor import (
@@ -168,21 +168,21 @@ def switches(self, client: EcoflowApiClient) -> list[SwitchEntity]:
 
     def buttons(self, client: EcoflowApiClient) -> list[ButtonEntity]:
         return [
-            EnabledButtonEntity(
+            SetMessageButtonEntity(
                 client,
                 self,
                 "smlice",
                 "Make Small Ice",
                 lambda value: {"moduleType": 1, "operateType": "iceMake", "params": {"enable": 1, "iceShape": 0}},
             ),
-            EnabledButtonEntity(
+            SetMessageButtonEntity(
                 client,
                 self,
                 "lrgice",
                 "Make Large Ice",
                 lambda value: {"moduleType": 1, "operateType": "iceMake", "params": {"enable": 1, "iceShape": 1}},
             ),
-            EnabledButtonEntity(
+            SetMessageButtonEntity(
                 client,
                 self,
                 "deice",

custom_components/ecoflow_cloud/devices/internal/powerstream.py

@@ -5,6 +5,7 @@
 
 from google.protobuf.json_format import MessageToDict
 from google.protobuf.message import Message as ProtoMessageRaw
+from homeassistant.components.button import ButtonEntity
 from homeassistant.components.number import NumberEntity
 from homeassistant.components.select import SelectEntity
 from homeassistant.components.sensor import SensorEntity
@@ -13,6 +14,7 @@
 
 from custom_components.ecoflow_cloud.api import EcoflowApiClient
 from custom_components.ecoflow_cloud.api.message import JSONDict, Message, PrivateAPIMessageProtocol
+from custom_components.ecoflow_cloud.button import GetMessageButtonEntity
 from custom_components.ecoflow_cloud.devices import BaseInternalDevice, const
 from custom_components.ecoflow_cloud.devices.data_holder import PreparedData
 from custom_components.ecoflow_cloud.devices.internal import to_lower_camel_case
@@ -69,6 +71,7 @@ def id(self) -> int:
     SET_BAT_UPPER = CommandFuncAndId(func=20, id=133)
     SET_BRIGHTNESS = CommandFuncAndId(func=20, id=135)
     SET_FEED_PROTECT = CommandFuncAndId(func=20, id=143)
+    GET_HEARTBEAT = CommandFuncAndId(func=0, id=0)
     RATED_POWER = CommandFuncAndId(func=20, id=146)
 
     PLATFORM_WATTH = CommandFuncAndId(func=254, id=32)
@@ -294,7 +297,7 @@ def numbers(self, client: EcoflowApiClient) -> Sequence[NumberEntity]:
                 self,
                 "20_1.upperLimit",
                 const.MAX_CHARGE_LEVEL,
-                50,
+                0,
                 100,
                 lambda value: PowerStreamCommandMessage(
                     device_sn=self.device_info.sn,
@@ -308,7 +311,7 @@ def numbers(self, client: EcoflowApiClient) -> Sequence[NumberEntity]:
                 "20_1.lowerLimit",
                 const.MIN_DISCHARGE_LEVEL,
                 0,
-                30,
+                100,
                 lambda value: PowerStreamCommandMessage(
                     device_sn=self.device_info.sn,
                     command=Command.SET_BAT_LOWER,
@@ -330,6 +333,21 @@ def numbers(self, client: EcoflowApiClient) -> Sequence[NumberEntity]:
             ).with_icon("mdi:transmission-tower-export"),
         ]
 
+    def buttons(self, client: EcoflowApiClient) -> list[ButtonEntity]:
+        return [
+            GetMessageButtonEntity(
+                client,
+                self,
+                "fullsync",
+                const.TRIGGER_FULL_SYNC,
+                lambda _: PowerStreamCommandMessage(
+                    device_sn=self.device_info.sn,
+                    command=Command.GET_HEARTBEAT,
+                    payload=None,
+                ),
+            ),
+        ]
+
     @override
     def _prepare_data(self, raw_data: bytes) -> dict[str, Any]:
         res: dict[str, Any] = {"params": {}}

custom_components/ecoflow_cloud/devices/internal/smart_plug.py

@@ -10,6 +10,7 @@
 import logging
 from typing import Any, override
 
+from homeassistant.components.button import ButtonEntity
 from homeassistant.components.number import NumberEntity
 from homeassistant.components.select import SelectEntity
 from homeassistant.components.sensor import SensorEntity
@@ -20,7 +21,9 @@
 
 from custom_components.ecoflow_cloud.api import EcoflowApiClient
 from custom_components.ecoflow_cloud.api.message import Message, PrivateAPIMessageProtocol
+from custom_components.ecoflow_cloud.button import GetMessageButtonEntity
 from custom_components.ecoflow_cloud.devices import BaseInternalDevice, const
+from custom_components.ecoflow_cloud.devices.data_holder import PreparedData
 from custom_components.ecoflow_cloud.number import BrightnessLevelEntity, MaxWattsEntity
 from custom_components.ecoflow_cloud.devices.internal.proto import AddressId
 import custom_components.ecoflow_cloud.devices.internal.proto.smartplug_pb2 as pb2
@@ -82,6 +85,23 @@ def switches(self, client: EcoflowApiClient) -> list[SwitchEntity]:
     def selects(self, client: EcoflowApiClient) -> list[SelectEntity]:
         return []
 
+    def buttons(self, client: EcoflowApiClient) -> list[ButtonEntity]:
+        return [
+            GetMessageButtonEntity(
+                client,
+                self,
+                "fullsync",
+                const.TRIGGER_FULL_SYNC,
+                lambda _: _create_heartbeat_message(),
+            ),
+        ]
+
+    def _prepare_data_get_reply_topic(self, raw_data: bytes) -> PreparedData:
+        data = self._prepare_data(raw_data)
+        if "params" in data:
+            return PreparedData(None, data, data)
+        return super()._prepare_data_get_reply_topic(raw_data)
+
     def _prepare_data(self, raw_data: bytes) -> dict[str, Any]:
         try:
             _LOGGER.debug(f"Processing {len(raw_data)} bytes of raw data")
@@ -132,12 +152,12 @@ def _parse_smartplug_packet(self, raw_data: bytes) -> dict[str, Any]:
         _LOGGER.debug(f"result: {result}")
         return result
 
-class SmartPlug3CommandMessage(PrivateAPIMessageProtocol):
+class SmartPlugCommandMessage(PrivateAPIMessageProtocol):
     """Message wrapper for SmartPlug protobuf commands."""
 
     def __init__(
         self,
-        payload: ProtoMessageRaw,
+        payload: ProtoMessageRaw | None,
         packet: pb2.SendSmartPlugHeaderMsg,
     ):
         self._packet = packet
@@ -149,13 +169,26 @@ def to_mqtt_payload(self):
 
     @override
     def to_dict(self) -> dict:
+        if self._payload is None:
+            return {}
+
         payload_dict = MessageToDict(self._payload, preserving_proto_field_name=True)
+        packet_dict = MessageToDict(self._packet, preserving_proto_field_name=True)
+
+        packet_dict["msg"][0]["pdata"] = {type(self._payload).__name__: payload_dict}
+        packet_dict["msg"][0].pop("seq", None)
+        return {type(self._packet).__name__: packet_dict}
 
-        result = MessageToDict(self._packet, preserving_proto_field_name=True)
-        result["msg"][0]["pdata"] = {type(self._payload).__name__: payload_dict}
-        result["msg"][0].pop("seq", None)
-        return {type(self._packet).__name__: result}
+def _create_heartbeat_message() -> SmartPlugCommandMessage:
+    packet = pb2.SendSmartPlugHeaderMsg()
+    msg = packet.msg.add()
+
+    msg.src = AddressId.APP
+    msg.dest = AddressId.APP
+    msg.seq = Message.gen_seq()
+    setattr(msg, "from", "Android")
 
+    return SmartPlugCommandMessage(None, packet)
 
 def _create_send_header_message(cmd_id: int, device_sn: str, payload: ProtoMessageRaw):
     packet = pb2.SendSmartPlugHeaderMsg()
@@ -171,7 +204,7 @@ def _create_send_header_message(cmd_id: int, device_sn: str, payload: ProtoMessa
     msg.seq = Message.gen_seq()
     msg.deviceSn = device_sn
 
-    return SmartPlug3CommandMessage(payload, packet)
+    return SmartPlugCommandMessage(payload, packet)
 
 
 def _create_change_switch_status_message(value: int, device_sn: str):

custom_components/ecoflow_cloud/entities/__init__.py

@@ -227,6 +227,9 @@ def command_dict(self, value: _CommandArg) -> dict[str, Any] | Message:
     def send_set_message(self, target_value: Any, command: dict | Message):
         self._client.send_set_message(self._device.device_info.sn, {self._mqtt_key_adopted: target_value}, command)
 
+    def send_get_message(self, command: dict | Message):
+        self._client.send_get_message(self._device.device_info.sn, command)
+
 
 class BaseNumberEntity(NumberEntity, EcoFlowBaseCommandEntity[int]):
     _attr_entity_category = EntityCategory.CONFIG