python-mobius 0.4.0__tar.gz → 0.4.1__tar.gz

{python_mobius-0.4.0 → python_mobius-0.4.1}/.forgejo/workflows/release.yml

@@ -88,25 +88,30 @@ jobs:
         if: github.event_name == 'push'
         run: python3 .forgejo/scripts/extract_changelog_section.py "${{ github.ref_name }}"
 
-      # Both of the action's own README examples always set release-dir
-      # explicitly, even though it's documented as optional with a
-      # default -- confirmed via a real failure on this exact step
-      # ("tag v0.3.1 exists" / "curl: (26) Failed to open/read local
-      # data from file/application") that omitting it entirely doesn't
-      # work, the same bug already found and fixed the same way for
-      # ha-mobius's own release workflow. dist/ has the actual built
-      # wheel/sdist in it (from the Build package step above), but
-      # those are deliberately NOT what goes here -- PyPI stays the
-      # source of truth for the built artifacts, this step only creates
-      # the release entry with the extracted changelog section as its
-      # notes -- hence a separate, empty dist/release/ rather than
-      # pointing release-dir at dist/ itself.
-      - name: Ensure release-dir exists (empty -- no files attached)
-        if: github.event_name == 'push'
-        run: mkdir -p dist/release
-
-      # Same event-gating reason as the two steps above -- nothing to
-      # release against on a manual, non-tag run.
+      # Confirmed via direct comparison against ha-mobius's own release
+      # workflow (which has never hit this failure) exactly why an
+      # earlier version of this step kept failing on a real run ("tag
+      # vX.Y.Z exists" / "curl: (26) Failed to open/read local data from
+      # file/application") even after release-dir was set explicitly:
+      # the YAML here and in ha-mobius's version are structurally
+      # identical (same action, same inputs), but ha-mobius's
+      # release-dir always has at least one real file in it (a zip it
+      # builds beforehand for manual installers), while this repo's own
+      # release-dir was a directory that existed but was ALWAYS
+      # completely empty (deliberately, since PyPI is meant to be the
+      # source of truth here, not a Forgejo release asset). That's
+      # consistent with the action's own upload logic looping over
+      # release-dir's contents with an unquoted/unguarded shell glob:
+      # with zero matching files and no nullglob set, such a glob
+      # doesn't expand to nothing, it stays as the literal, unexpanded
+      # string -- and curl trying to read a file literally named
+      # "dist/release/*" produces exactly this error. Rather than an
+      # artificially empty directory, this points release-dir at dist/
+      # itself, which already has the actual built wheel/sdist in it
+      # from the Build package step above and is therefore never empty
+      # -- also means those get attached to the Forgejo release as a
+      # side effect, which is a reasonable thing to have anyway, not
+      # just a workaround.
       - name: Create Forgejo release
         if: github.event_name == 'push'
         uses: https://code.forgejo.org/actions/forgejo-release@v2
@@ -116,5 +121,5 @@ jobs:
           repo: r3pek/python-mobius
           token: ${{ secrets.GITHUB_TOKEN }}
           tag: ${{ github.ref_name }}
-          release-dir: dist/release
+          release-dir: dist
           release-notes-file: release_notes.md

{python_mobius-0.4.0 → python_mobius-0.4.1}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.4.1
+
+- Fixed `discover_tank()` sometimes reporting the connected device
+  twice in a tank's peer list.
+
 ## 0.4.0
 
 - **`mobius-scan`'s default now also connects to ONE device and dumps

{python_mobius-0.4.0 → python_mobius-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-mobius
-Version: 0.4.0
+Version: 0.4.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.4.0 → python_mobius-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-mobius"
-version = "0.4.0"
+version = "0.4.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.4.0 → python_mobius-0.4.1}/src/mobius/__init__.py

@@ -65,7 +65,7 @@ from .discovery import (
     discover_tank,
 )
 
-__version__ = "0.4.0"
+__version__ = "0.4.1"
 
 __all__ = [
     "__version__",

{python_mobius-0.4.0 → python_mobius-0.4.1}/src/mobius/device.py

@@ -709,12 +709,22 @@ class MobiusDevice:
         ShortAddressArray/SerialNumberArray/DeviceModelArray
         (3700/3701/3702, the same "get all elements" pattern used
         elsewhere in this library) from THIS connected device, acting as
-        a Thread mesh gateway, and returns every OTHER device it knows
-        about over the mesh -- not devices we necessarily have (or even
-        can have) a direct BLE connection to. See documentation/
+        a Thread mesh gateway, and returns what it reports about devices
+        over the mesh -- not devices we necessarily have (or even can
+        have) a direct BLE connection to. See documentation/
         09-thread-coap-relay.md for the full protocol trace this is
         based on.
 
+        Whether this includes the connected device's own entry
+        alongside others isn't confirmed either way -- unlike
+        discover_networked_thread_devices() (whose sibling docstring
+        this once matched, until a real capture disproved it there),
+        real hardware evidence specific to THIS older mechanism was
+        never gathered. Callers that also separately add the connected
+        device's own entry (e.g. mobius.discovery.discover_tank()) treat
+        this as a real possibility and deduplicate by serial regardless,
+        rather than assuming either way.
+
         **Confirmed via real hardware testing to be Cowboy-hub-specific.**
         These three arrays were originally found being fetched as part of
         the app's own network-setup logic for a dedicated Cowboy hub device,
@@ -789,9 +799,19 @@ class MobiusDevice:
         """
         Fetches MLPrefix (2128) plus NetworkedThreadDevices (1001, the
         same "get all elements" pattern used elsewhere in this library)
-        from THIS connected device, and returns every OTHER device it
-        knows about over the Thread mesh -- not devices we necessarily
-        have (or even can have) a direct BLE connection to.
+        from THIS connected device, and returns every device it knows
+        about over the Thread mesh -- not devices we necessarily have
+        (or even can have) a direct BLE connection to.
+
+        **Includes the connected device's own entry, not just others.**
+        An earlier version of this docstring claimed "every OTHER
+        device," an untested assumption rather than a confirmed one --
+        disproven by a real 4-device tank capture where a single
+        connected device's own NetworkedThreadDevices read returned all
+        4 real devices, necessarily including itself. Callers building
+        a peer list that also separately adds the connected device's own
+        entry (e.g. mobius.discovery.discover_tank()) need to
+        deduplicate by serial, or that device ends up listed twice.
 
         A second, better mesh-peer-discovery mechanism than
         discover_mesh_peers() -- confirmed via reverse engineering the

{python_mobius-0.4.0 → python_mobius-0.4.1}/src/mobius/discovery.py

@@ -193,12 +193,28 @@ async def discover_tank(mdevice) -> "Tank":
     (not just serial/model, the way advertisement-only grouping like
     group_by_pan_id() can offer).
 
-    Calls mdevice.discover_mesh_peers_auto() (which only ever reports
-    OTHER devices) plus get_own_mesh_address()/get_device_info() (to
-    include the connected device itself in the result -- otherwise a
-    single-device tank would come back with zero peers, which would look
-    identical to "this device supports none of the discovery mechanisms"
-    rather than "this device IS the whole tank").
+    Calls mdevice.discover_mesh_peers_auto() plus
+    get_own_mesh_address()/get_device_info() to build the connected
+    device's own entry directly. These are deliberately DEDUPLICATED by
+    serial before returning, keeping the directly-built own entry over
+    whatever discover_mesh_peers_auto() reported for the same serial --
+    confirmed via a real 4-device tank capture that
+    discover_networked_thread_devices() (the mechanism
+    discover_mesh_peers_auto() tries first) is self-INCLUSIVE, not
+    self-exclusive as an earlier version of this docstring claimed
+    (based on an untested assumption, not a confirmed one): all 4 real
+    devices came back from a single connected device's own
+    NetworkedThreadDevices read, necessarily including whichever one was
+    actually connected to. Without deduplication, that connected
+    device's own peer would appear twice in the result -- once from this
+    function's own direct build, once from discover_mesh_peers_auto()'s
+    own report of it as "just another peer" on its own network. Not
+    confirmed whether the OLDER discover_mesh_peers() mechanism
+    (discover_mesh_peers_auto()'s own fallback) shares this same
+    self-inclusive behavior or not -- the deduplication here is
+    unconditional specifically so it's correct either way, rather than
+    depending on getting that confirmation for every code path that
+    could produce peers.
 
     tank.prefix is None if this device didn't report a valid mesh
     address at all (unsupported, or not currently part of an active
@@ -240,5 +256,13 @@ async def discover_tank(mdevice) -> "Tank":
     other_peers = await mdevice.discover_mesh_peers_auto()
     prefix = mesh_local_prefix_from_own_address(own_address)
 
-    return Tank(prefix=prefix, peers=[own_peer] + other_peers)
+    # own_peer always wins over whatever discover_mesh_peers_auto()
+    # separately reported for the same serial -- see this function's
+    # own docstring for why that duplicate is a real, confirmed
+    # possibility, not just a defensive guard against a hypothetical.
+    deduplicated = [own_peer] + [
+        peer for peer in other_peers if peer.serial != own_peer.serial
+    ]
+
+    return Tank(prefix=prefix, peers=deduplicated)
 

{python_mobius-0.4.0 → python_mobius-0.4.1}/tests/test_mesh_discovery.py

@@ -13,7 +13,7 @@ from bleak.backends.device import BLEDevice
 
 from mobius import C2Attribute, Model, MeshPeer
 from mobius.device import MobiusDevice
-from mobius.mesh_address import build_rloc_address
+from mobius.mesh_address import build_rloc_address, extract_short_address
 
 
 def _fake_ble_device():
@@ -295,6 +295,77 @@ async def test_discover_tank_basic():
     assert tank.peers[1] is other_peer
 
 
+@pytest.mark.asyncio
+async def test_discover_tank_deduplicates_self_from_discover_mesh_peers_auto():
+    """
+    The actual real-hardware bug this guards against: a real 4-device
+    tank capture showed discover_networked_thread_devices() (the
+    mechanism discover_mesh_peers_auto() tries first) returning ALL 4
+    real devices from a single connected device's own read, including
+    itself -- disproving an earlier assumption that it only ever
+    reports OTHER devices (see device.py's own docstring for the full
+    correction). Without deduplication, discover_tank() would list the
+    connected device twice: once from its own direct
+    get_own_mesh_address()/get_device_info() build, once again from
+    whatever discover_mesh_peers_auto() separately reported for that
+    same serial. Confirms the fix: the connected device appears exactly
+    once, its own directly-built entry wins over the (here, identical)
+    one discover_mesh_peers_auto() reported for the same serial, and
+    genuinely different peers are unaffected.
+    """
+    device = MobiusDevice(_fake_ble_device())
+    own_serial = "76495221059019"
+    own_address = PREFIX + bytes.fromhex("000000fffe005786")
+
+    # What discover_mesh_peers_auto() reports for the connected device's
+    # OWN serial -- same identity, but constructed independently (a
+    # DIFFERENT MeshPeer object, not literally the same instance the
+    # real own_peer build produces), matching how two separate discovery
+    # paths reporting the same physical device would actually look.
+    self_reported_by_auto = MeshPeer(
+        serial=own_serial, model_raw=Model.VorTechMP40wG3QD.value,
+        model=Model.VorTechMP40wG3QD, short_address=extract_short_address(own_address),
+        address=own_address, age=14519,
+    )
+    genuinely_other_peer = MeshPeer(
+        serial="76517731952041", model_raw=Model.VorTechMP40wG3QD.value,
+        model=Model.VorTechMP40wG3QD, short_address=0x9a0b,
+        address=PREFIX + bytes.fromhex("000000fffe009a0b"), age=373,
+    )
+
+    async def fake_get_attribute(attr_id, index=0, count=1):
+        if attr_id == C2Attribute.MeshLocalAddresses:
+            return [own_address]
+        info_attrs = _device_info_attrs(Model.VorTechMP40wG3QD, own_serial)
+        if attr_id in info_attrs:
+            return info_attrs[attr_id]
+        raise Exception("FsciStatus.UnsupportedAttribute")
+
+    device.get_attribute = fake_get_attribute
+    device.discover_mesh_peers_auto = AsyncMock(
+        return_value=[self_reported_by_auto, genuinely_other_peer]
+    )
+
+    tank = await discover_tank(device)
+
+    # The actual point: 2 real devices total, not 3 -- the connected
+    # device isn't double-counted.
+    assert len(tank.peers) == 2
+    serials = [p.serial for p in tank.peers]
+    assert serials.count(own_serial) == 1
+    assert own_serial in serials
+    assert "76517731952041" in serials
+    # The connected device's own directly-built entry wins -- confirmed
+    # by checking it's the exact instance discover_tank() constructs
+    # itself (has no .age set, unlike self_reported_by_auto which does),
+    # not the one discover_mesh_peers_auto() separately reported.
+    own_in_result = next(p for p in tank.peers if p.serial == own_serial)
+    assert own_in_result is not self_reported_by_auto
+    assert own_in_result.age is None
+    # The genuinely different peer is untouched.
+    assert genuinely_other_peer in tank.peers
+
+
 @pytest.mark.asyncio
 async def test_discover_tank_no_own_address_returns_empty_tank():
     """No own address means no valid connection to this Thread network --