python-mobius 0.8.0__tar.gz → 0.8.1__tar.gz

{python_mobius-0.8.0 → python_mobius-0.8.1}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.8.1
+
+- Added `get_pump_reverse(primitive_type, params)`: whether a pump
+  schedule point's MaxSpeed/MinSpeed value currently encodes reverse
+  rotation. Only AlpacaV1 pumps support this -- every other primitive
+  type always returns None.
+- Added `reboot_all()`: soft-reboots every device on the mesh at
+  once, matching the app's own "Restart all Devices" tank setting.
+
 ## 0.8.0
 
 - Added `supported_pump_modes(primitive_type, closed_loop=None)`: the

{python_mobius-0.8.0 → python_mobius-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: python-mobius
-Version: 0.8.0
+Version: 0.8.1
 Summary: Reverse-engineered Python client for the Mobius BLE protocol (EcoTech Marine VorTech/Radion, AquaIllumination, Neptune Systems, NYOS)
 Project-URL: Homepage, https://code.r3pek.org/r3pek/python-mobius
 Project-URL: Documentation, https://code.r3pek.org/r3pek/python-mobius/src/branch/main/documentation

{python_mobius-0.8.0 → python_mobius-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-mobius"
-version = "0.8.0"
+version = "0.8.1"
 description = "Reverse-engineered Python client for the Mobius BLE protocol (EcoTech Marine VorTech/Radion, AquaIllumination, Neptune Systems, NYOS)"
 readme = "README.md"
 license = { text = "GPL-2.0-only" }

{python_mobius-0.8.0 → python_mobius-0.8.1}/src/mobius/__init__.py

@@ -28,6 +28,7 @@ from .constants import (
     SceneID, OperationState, FsciStatus,
     PumpMode, PumpOverrideMode, RampType, PumpParam, PUMP_PARAM_SIZE, PUMP_MODE_PARAMS,
     supported_pump_modes,
+    get_pump_reverse,
     FirmwareType, FIRMWARE_TYPE_LABELS_ETM, HardwareInfo,
     Color, COLOR_LABELS, RadioType, RADIO_TYPE_LABELS,
     MotorType, MOTOR_TYPE_LABELS, ProductType, PRODUCT_TYPE_LABELS,
@@ -81,7 +82,7 @@ from .mob import (
     MAX_PUMP_PRIMITIVE_SIZE,
 )
 
-__version__ = "0.8.0"
+__version__ = "0.8.1"
 
 __all__ = [
     "__version__",
@@ -103,6 +104,7 @@ __all__ = [
     "SceneID", "OperationState", "FsciStatus",
     "PumpMode", "PumpOverrideMode", "RampType", "PumpParam", "PUMP_PARAM_SIZE", "PUMP_MODE_PARAMS",
     "supported_pump_modes",
+    "get_pump_reverse",
     "FirmwareType", "FIRMWARE_TYPE_LABELS_ETM", "HardwareInfo",
     "Color", "COLOR_LABELS", "RadioType", "RADIO_TYPE_LABELS",
     "MotorType", "MOTOR_TYPE_LABELS", "ProductType", "PRODUCT_TYPE_LABELS",

{python_mobius-0.8.0 → python_mobius-0.8.1}/src/mobius/constants.py

@@ -819,6 +819,35 @@ def supported_pump_modes(
     return _PUMP_SUPPORTED_MODES.get(primitive_type, [])
 
 
+def get_pump_reverse(primitive_type: PrimitiveType, params: dict[PumpParam, int]) -> bool | None:
+    """Whether this point's own MaxSpeed/MinSpeed value currently
+    encodes reverse rotation -- ported from the decompiled app's own
+    PumpPrimitive.getReverse(), which checks each of a primitive's own
+    params for one whose slider settings say supportsReverse, then
+    reports whether that param's raw (unabs'd) value is negative.
+
+    Confirmed directly from the app's own PumpParameterEntry.sliderSettings():
+    MaxSpeed and MinSpeed both only ever set supportsReverse=true when
+    primitive_type is AlpacaV1 -- every other primitive type
+    (VorTechV1, PumpV1, TurtleV1, CoffeeV1, VectraV1) never supports
+    reverse at all, regardless of mode or the value's own sign. This
+    always returns None for those, same as the app's own getReverse()
+    falling through to null when no param on the primitive supports
+    it.
+
+    parse()/schedule_to_dict() already report MaxSpeed/MinSpeed as
+    signed ints as-is (see PumpPrimitiveValue.parse()'s own comment),
+    so this just checks their sign -- it doesn't change what those
+    functions themselves return.
+    """
+    if primitive_type != PrimitiveType.AlpacaV1:
+        return None
+    for param in (PumpParam.MaxSpeed, PumpParam.MinSpeed):
+        if param in params:
+            return params[param] < 0
+    return None
+
+
 class RampType(IntEnum):
     Sinusoidal = 1
     Logarithmic = 2

{python_mobius-0.8.0 → python_mobius-0.8.1}/src/mobius/device.py

@@ -1296,6 +1296,28 @@ class MobiusDevice:
         """
         await self.set_attribute(C2Attribute.Reset, bytes([ResetType.Soft]))
 
+    async def reboot_all(self) -> None:
+        """
+        Soft-reboots every device on this mesh at once -- what the
+        app's own "Restart all Devices" (tank settings screen) does.
+
+        Confirmed from the app's own SettingsFragment.reboot(): this
+        is NOT a loop of individual reboot() calls against every
+        device. It's the exact same single Set as reboot() (Reset=Soft),
+        just with the frame's own reserved-byte "group" field set to 1
+        (see make_reserved()) instead of left at 0 -- one write to
+        this device, propagated to the rest of the mesh the same way
+        set_time_to_now()/start_scene(broadcast=True) already do.
+        group=1 specifically (not the app's own client-side, per-tank
+        group number, which isn't something this library has any way
+        to discover) matches set_time_to_now()'s own confirmed-working
+        value, and the same real-hardware caveats apply here: not
+        guaranteed reliable across every mesh topology or under
+        real-world conditions where a peer is briefly unreachable when
+        the write's own propagation happens.
+        """
+        await self.set_attribute(C2Attribute.Reset, bytes([ResetType.Soft]), reserved=make_reserved(group=1))
+
     # ---- scenes -----------------------------------------------------------
 
     async def start_scene(self, scene_id: int, duration_seconds: int = 0, broadcast: bool = True) -> None:

{python_mobius-0.8.0 → python_mobius-0.8.1}/tests/test_device_control.py

@@ -1,9 +1,10 @@
 """
-Tests for device control write operations -- currently just reboot().
-Confirmed wire format (attribute ID, single-byte value, no reserved-byte
-group involved) via the app's own source, which sends exactly this for
-its own "Restart" button. NOT confirmed: this specific write against real
-hardware, direct or relayed -- see reboot()'s own docstring.
+Tests for device control write operations -- reboot() and
+reboot_all(). Confirmed wire format via the app's own source, which
+sends exactly this for its own "Restart" button and "Restart all
+Devices" tank setting respectively. NOT confirmed: these specific
+writes against real hardware, direct or relayed -- see each method's
+own docstring.
 """
 
 import pytest
@@ -63,6 +64,49 @@ async def test_reboot_propagates_a_write_failure():
         await device.reboot()
 
 
+@pytest.mark.asyncio
+async def test_reboot_all_writes_reset_soft_with_group_1_reserved_byte():
+    """Confirmed via the app's own SettingsFragment.reboot() (the
+    "Restart all Devices" tank-settings option): the exact same Reset
+    Set as reboot(), but with the frame's own reserved-byte group
+    field set to 1 instead of left ungrouped -- one write to this
+    device propagates to the rest of the mesh, matching
+    set_time_to_now()'s own already-confirmed group=1 behavior."""
+    device = MobiusDevice(_fake_ble_device())
+    captured = {}
+
+    async def fake_set_attribute(attr_id, value, index=0, reserved=b"\x00\x00"):
+        captured["attr_id"] = attr_id
+        captured["value"] = value
+        captured["reserved"] = reserved
+
+    device.set_attribute = fake_set_attribute
+    await device.reboot_all()
+
+    assert captured["attr_id"] == C2Attribute.Reset
+    assert captured["value"] == bytes([ResetType.Soft])
+    assert captured["reserved"] == make_reserved(group=1)
+    # Distinct from reboot()'s own ungrouped reserved bytes -- this is
+    # the whole point of the two methods being separate.
+    assert captured["reserved"] != b"\x00\x00"
+
+
+@pytest.mark.asyncio
+async def test_reboot_all_propagates_a_write_failure():
+    """Same reasoning as reboot()'s own equivalent test -- a caller
+    acting on a silently-swallowed failure here would wrongly believe
+    every device on the mesh actually rebooted."""
+    device = MobiusDevice(_fake_ble_device())
+
+    async def fake_set_attribute(attr_id, value, index=0, reserved=b"\x00\x00"):
+        raise IOError("device returned FSCI status Failed setting attribute 6")
+
+    device.set_attribute = fake_set_attribute
+
+    with pytest.raises(IOError, match="Failed setting attribute 6"):
+        await device.reboot_all()
+
+
 # --------------------------------------------------------------------------
 # set_attribute_multi() -- writing several elements of one attribute in
 # a single request (used by set_light_schedule()/set_pump_schedule()).

python_mobius-0.8.1/tests/test_pump_reverse.py

@@ -0,0 +1,52 @@
+"""
+Tests for get_pump_reverse() -- ported from the decompiled app's own
+PumpPrimitive.getReverse(). Confirmed against the app's own
+PumpParameterEntry.sliderSettings(): MaxSpeed and MinSpeed only ever
+set supportsReverse=true when primitive_type is AlpacaV1 -- every
+other primitive type never supports reverse rotation at all,
+regardless of mode or the value's own sign.
+"""
+
+from mobius import PrimitiveType, PumpParam, get_pump_reverse
+
+
+def test_alpacav1_negative_max_speed_is_reverse():
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {PumpParam.MaxSpeed: -420}) is True
+
+
+def test_alpacav1_positive_max_speed_is_not_reverse():
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {PumpParam.MaxSpeed: 420}) is False
+
+
+def test_alpacav1_negative_min_speed_is_reverse():
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {PumpParam.MinSpeed: -100}) is True
+
+
+def test_alpacav1_checks_max_speed_before_min_speed_when_both_present():
+    # Matches the app's own getReverse() -- it stops at the first
+    # param on the primitive whose slider settings support reverse,
+    # which for AlpacaV1 is MaxSpeed before MinSpeed in params() order.
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {PumpParam.MaxSpeed: -420, PumpParam.MinSpeed: 100}) is True
+
+
+def test_non_alpaca_primitive_types_never_support_reverse_even_with_a_negative_value():
+    """The genuinely important case -- confirmed straight from the
+    app's own sliderSettings(): a negative value on any other
+    primitive type isn't a real, meaningful reverse-rotation signal,
+    since the concept doesn't apply there at all."""
+    for primitive in (
+        PrimitiveType.VorTechV1,
+        PrimitiveType.PumpV1,
+        PrimitiveType.TurtleV1,
+        PrimitiveType.CoffeeV1,
+        PrimitiveType.VectraV1,
+    ):
+        assert get_pump_reverse(primitive, {PumpParam.MaxSpeed: -420}) is None
+
+
+def test_returns_none_when_neither_speed_param_is_present():
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {PumpParam.PhaseShift: 180}) is None
+
+
+def test_returns_none_for_an_empty_params_dict():
+    assert get_pump_reverse(PrimitiveType.AlpacaV1, {}) is None