SolixBLE 3.8.0__tar.gz → 3.9.0__tar.gz

{solixble-3.8.0 → solixble-3.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SolixBLE
-Version: 3.8.0
+Version: 3.9.0
 Summary: Python module for monitoring & controlling Bluetooth Anker Solix devices
 Author-email: Harvey Lelliott <harveylelliott@duck.com>
 License: MIT License
@@ -97,11 +97,13 @@ See the [support table](https://solixble.readthedocs.io/en/latest) in the docume
 - C1000(X)
 - C1000 Gen 2
 - F2000 (767 PowerHouse)
+- F2600
 - F3800
 - Solarbank 2
 - Solarbank 3
 - Prime Charger 160w
 - Prime Charger 250w
+- Prime MagGo 3in1 (A25X7)
 - Potentially more!
 
 

{solixble-3.8.0 → solixble-3.9.0}/README.md

@@ -48,11 +48,13 @@ See the [support table](https://solixble.readthedocs.io/en/latest) in the docume
 - C1000(X)
 - C1000 Gen 2
 - F2000 (767 PowerHouse)
+- F2600
 - F3800
 - Solarbank 2
 - Solarbank 3
 - Prime Charger 160w
 - Prime Charger 250w
+- Prime MagGo 3in1 (A25X7)
 - Potentially more!
 
 

{solixble-3.8.0 → solixble-3.9.0}/SolixBLE/__init__.py

@@ -12,8 +12,10 @@ from .devices import (
     C1000,
     C1000G2,
     F2000,
+    F2600,
     F3800,
     Generic,
+    MagGo3in1,
     PrimeCharger160w,
     PrimeCharger250w,
     PrimePowerBank20k,
@@ -41,12 +43,14 @@ __all__ = [
     "C1000",
     "C1000G2",
     "F2000",
+    "F2600",
     "F3800",
     "Solarbank2",
     "Solarbank3",
     "PrimeCharger160w",
     "PrimeCharger250w",
     "PrimePowerBank20k",
+    "MagGo3in1",
     "Generic",
     "ChargingStatus",
     "ChargingStatusF3800",

{solixble-3.8.0 → solixble-3.9.0}/SolixBLE/device.py

@@ -76,6 +76,7 @@ class SolixBLEDevice:
         self._state_changed_callbacks: list[Callable[[], None]] = []
         self._packet_futures: dict[bytes, list[asyncio.Future]] = {}
         self._auto_reconnect_task: asyncio.Task | None = None
+        self._keep_alive_task: asyncio.Task | None = None
         self._disconnect_event: asyncio.Event = asyncio.Event()
         self._connection_attempts: int = 0
         self._shared_secret: bytes | None = None
@@ -213,6 +214,10 @@ class SolixBLEDevice:
         if self._auto_reconnect_task is None:
             self._auto_reconnect_task = asyncio.create_task(self._auto_reconnect())
 
+        # Start a keep-alive task if its not running already
+        if self._keep_alive_task is None:
+            self._keep_alive_task = asyncio.create_task(self._keep_alive_fn())
+
         # Execute callbacks if enabled
         if run_callbacks:
             self._run_state_changed_callbacks()
@@ -230,6 +235,26 @@ class SolixBLEDevice:
         """
         pass
 
+    async def _keep_alive(self) -> int | None:
+        """Execute designated keep-alive command periodically after good negotiation.
+
+        Use this to execute code periodically that is needed to keep the
+        connection. For example some devices need a special keep alive command
+        to keep receiving telemetry updates that must be sent every ~10 seconds.
+
+        This is automatically executed in a task created by :meth:`connect` once
+        the encrypted session has been negotiated (so :meth:`_send_command`
+        may be used) and on every automatic reconnect, with it not being
+        executed when not connected or negotiated.
+
+        The default implementation does nothing; subclasses can override it to,
+        for example, send a subscribe command to keep a telemetry stream (see
+        :class:`~SolixBLE.devices.prime_charger_250w.PrimeCharger250w`).
+
+        :returns: Seconds to wait before calling again or None for not implemented.
+        """
+        return None
+
     async def disconnect(self) -> None:
         """Disconnect from device and reset internal state.
 
@@ -242,6 +267,10 @@ class SolixBLEDevice:
         if self._auto_reconnect_task is not None:
             self._auto_reconnect_task.cancel()
 
+        # Cancel the keep-alive task
+        if self._keep_alive_task is not None:
+            self._keep_alive_task.cancel()
+
         # If there is a client disconnect and throw it away
         if self._client is not None:
             await self._dispose_of_client()
@@ -1025,6 +1054,39 @@ class SolixBLEDevice:
         except Exception:
             _LOGGER.exception("Unexpected exception in automatic reconnect task!")
 
+
+    async def _keep_alive_fn(self) -> None:
+        """Task designed to be run in background to execute keep-alive.
+
+        This task is executed automatically when a successful connection
+        is made and will periodically execute the keep alive function if
+        one exists.
+
+        This background task is cancelled when the connection is lost.
+        """
+        try:
+            while self.negotiated:
+
+                try:
+                    _LOGGER.debug("Executing keep-alive...")
+                    result = await self._keep_alive()
+
+                    if result is None:
+                        _LOGGER.debug("No keep-alive task registered, stopping task...")
+                        return
+
+                    _LOGGER.debug(f"Executing keep-alive in {result}s")
+                    await asyncio.sleep(result)
+
+                except Exception:
+                    _LOGGER.exception("Exception raised executing keep-alive function!")
+
+        except asyncio.CancelledError:
+            _LOGGER.debug("Keep-alive task has been canceled/stopped")
+
+        except Exception:
+            _LOGGER.exception("Unexpected exception in keep-alive task!")
+
     def _disconnect_callback(self, client: BaseBleakClient) -> None:
         """Callback executed by bleak when the connection is lost.
 

{solixble-3.8.0 → solixble-3.9.0}/SolixBLE/devices/__init__.py

@@ -10,8 +10,10 @@ from .c800 import C800
 from .c1000 import C1000
 from .c1000g2 import C1000G2
 from .f2000 import F2000
+from .f2600 import F2600
 from .f3800 import F3800
 from .generic import Generic
+from .maggo_3in1 import MagGo3in1
 from .prime_charger_160w import PrimeCharger160w
 from .prime_charger_250w import PrimeCharger250w
 from .prime_power_bank_20k import PrimePowerBank20k
@@ -25,11 +27,13 @@ __all__ = [
     "C1000",
     "C1000G2",
     "F2000",
+    "F2600",
     "F3800",
     "Solarbank2",
     "Solarbank3",
     "PrimeCharger160w",
     "PrimeCharger250w",
     "PrimePowerBank20k",
+    "MagGo3in1",
     "Generic",
 ]

{solixble-3.8.0 → solixble-3.9.0}/SolixBLE/devices/c1000.py

@@ -186,6 +186,25 @@ class C1000(SolixBLEDevice):
         """
         return self._parse_int("b0", begin=1)
 
+    @property
+    def dc_output(self) -> PortStatus:
+        """DC Port Status.
+
+        PortStatus.NOT_CONNECTED signifies off.
+        PortStatus.OUTPUT signifies on.
+
+        :returns: Status of the DC output port.
+        """
+        return PortStatus(self._parse_int("b2", begin=1, end=2))
+
+    @property
+    def dc_power_out(self) -> int:
+        """DC Power Out.
+
+        :returns: DC power out or default int value.
+        """
+        return self._parse_int("b2", begin=2)
+
     @property
     def software_version(self) -> str:
         """Main software version.

{solixble-3.8.0 → solixble-3.9.0}/SolixBLE/devices/c300dc.py

@@ -13,8 +13,25 @@ from ..const import (
     DEFAULT_METADATA_STRING,
 )
 from ..device import SolixBLEDevice
-from ..states import ChargingStatus, LightStatus, PortStatus, TemperatureUnit, PortOverload
+from ..states import (
+    ChargingStatus,
+    DisplayTimeout,
+    LightStatus,
+    PortOverload,
+    PortStatus,
+    TemperatureUnit,
+)
+
+CMD_DC_OUTPUT = "404b"
+CMD_DISPLAY_ON_OFF = "4052"
+CMD_LIGHT_MODE = "404f"
+CMD_DISPLAY_TIMEOUT = "4046"
+CMD_DISPLAY_MODE = "404c"
 
+PAYLOAD_ON = "a10121a2020101"
+PAYLOAD_OFF = "a10121a2020100"
+PAYLOAD_LIGHT_MODE = "a10121a20201"
+PAYLOAD_TIMEOUT_TIME = "a10121a20302"
 
 class C300DC(SolixBLEDevice):
     """
@@ -381,3 +398,92 @@ class C300DC(SolixBLEDevice):
             if self._data is not None
             else DEFAULT_METADATA_BOOL
         )
+
+    async def turn_dc_on(self) -> None:
+        """Turn the DC output on.
+
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DC_OUTPUT), payload=bytes.fromhex(PAYLOAD_ON)
+        )
+
+    async def turn_dc_off(self) -> None:
+        """Turn the DC output off.
+
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DC_OUTPUT), payload=bytes.fromhex(PAYLOAD_OFF)
+        )
+
+    async def turn_display_on(self) -> None:
+        """Turn the display on.
+
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DISPLAY_ON_OFF), payload=bytes.fromhex(PAYLOAD_ON)
+        )
+
+    async def turn_display_off(self) -> None:
+        """Turn the display off.
+
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DISPLAY_ON_OFF), payload=bytes.fromhex(PAYLOAD_OFF)
+        )
+
+    async def set_light_mode(self, mode: LightStatus) -> None:
+        """Set the light mode of the LED bar.
+
+        :param mode: Mode to set light bar to.
+        :raises ValueError: If requested mode is invalid.
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        if mode is LightStatus.UNKNOWN:
+            raise ValueError("You cannot set the light status to unknown")
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_LIGHT_MODE),
+            payload=bytes.fromhex(PAYLOAD_LIGHT_MODE) + mode.value.to_bytes(),
+        )
+
+    async def set_display_timeout(self, timeout: DisplayTimeout) -> None:
+        """Set the status/mode of the LCD display.
+
+        :param mode: Mode/timeout to set display to (30s, 5m, 30m, etc).
+        :raises ValueError: If requested mode is invalid.
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+
+        if timeout is DisplayTimeout.UNKNOWN:
+            raise ValueError("You cannot set the display timeout to unknown")
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DISPLAY_TIMEOUT),
+            payload=bytes.fromhex(PAYLOAD_TIMEOUT_TIME)
+            + timeout.value.to_bytes(length=2, byteorder="little", signed=False),
+        )
+
+    async def set_display_mode(self, mode: LightStatus) -> None:
+        """Set the status/mode of the LCD display.
+
+        :param mode: Mode/status to set display to (off/low/med/high).
+        :raises ValueError: If requested mode is invalid.
+        :raises ConnectionError: If not connected to device.
+        :raises BleakError: If command transmission fails.
+        """
+        if mode is LightStatus.UNKNOWN:
+            raise ValueError("You cannot set the display brightness status to unknown")
+        if mode is LightStatus.SOS:
+            raise ValueError("You cannot set the display brightness status to SOS")
+        await self._send_command(
+            cmd=bytes.fromhex(CMD_DISPLAY_MODE),
+            payload=bytes.fromhex(PAYLOAD_LIGHT_MODE) + mode.value.to_bytes(),
+        )