nao-websocket-bridge-client 0.1.0__tar.gz

nao_websocket_bridge_client-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,53 @@
+name: CI
+
+# Publish nao-websocket-bridge-protocol to PyPI before the first run of this workflow.
+# pip installs that dependency from PyPI, not from a sibling checkout.
+
+on:
+  push:
+    branches: [main]
+    tags: ["v?[0-9]+.[0-9]+.[0-9]+"]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Install and test
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .
+          python -m unittest discover -s tests -v
+
+  publish:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - name: Build
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check --strict dist/*
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          if [ -z "$TWINE_PASSWORD" ]; then
+            echo "Add the repository secret PYPI_API_TOKEN (a PyPI API token)."
+            exit 1
+          fi
+          python -m twine upload --non-interactive dist/*

nao_websocket_bridge_client-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.venv-wsl
+.venv312
+
+# Test / tooling
+.pytest_cache/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+
+# Editor
+.idea/
+.vscode/
+*.swp

nao_websocket_bridge_client-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 iCampus Wildau - Valentin Schröter Bonk
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nao_websocket_bridge_client-0.1.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.5
+Name: nao-websocket-bridge-client
+Version: 0.1.0
+Summary: Laptop client for the NAO WebSocket bridge.
+Author-email: Valentin Schröter Bonk <vasc9380@th-wildau.de>
+Maintainer-email: Valentin Schröter Bonk <vasc9380@th-wildau.de>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: nao-websocket-bridge-protocol
+Requires-Dist: websockets>=13
+Description-Content-Type: text/markdown
+
+# nao-websocket-bridge-client
+
+Laptop client for the process that runs on the NAO. It speaks `nao-websocket-bridge-protocol`: a format announcement, binary PCM, and periodic status.
+
+This package does not talk to NAOqi and does not know about Pipecat. Speech, motion, and buttons stay on port 9559 through `naoqi-control`. The bridge is the realtime stream.
+
+```python
+from nao_websocket_bridge_client import iter_bridge_messages, websocket_url
+
+url = websocket_url("192.168.2.50", 8765, token="")
+async for kind, payload in iter_bridge_messages(url):
+    ...
+```
+
+`tcp_accepts` and `wait_until_tcp_accepts` probe the bridge port. `next_reconnect_delay` is the backoff for a socket that drops as soon as it connects.
+
+`python -m nao_websocket_bridge_client --url ws://ROBOT:8765` prints RMS for each PCM chunk.

nao_websocket_bridge_client-0.1.0/README.md

@@ -0,0 +1,17 @@
+# nao-websocket-bridge-client
+
+Laptop client for the process that runs on the NAO. It speaks `nao-websocket-bridge-protocol`: a format announcement, binary PCM, and periodic status.
+
+This package does not talk to NAOqi and does not know about Pipecat. Speech, motion, and buttons stay on port 9559 through `naoqi-control`. The bridge is the realtime stream.
+
+```python
+from nao_websocket_bridge_client import iter_bridge_messages, websocket_url
+
+url = websocket_url("192.168.2.50", 8765, token="")
+async for kind, payload in iter_bridge_messages(url):
+    ...
+```
+
+`tcp_accepts` and `wait_until_tcp_accepts` probe the bridge port. `next_reconnect_delay` is the backoff for a socket that drops as soon as it connects.
+
+`python -m nao_websocket_bridge_client --url ws://ROBOT:8765` prints RMS for each PCM chunk.

nao_websocket_bridge_client-0.1.0/nao_websocket_bridge_client/__init__.py

@@ -0,0 +1,31 @@
+"""Laptop client for the NAO WebSocket bridge."""
+
+from nao_websocket_bridge_client.reconnect import (
+    RECONNECT_BASE_SECS,
+    RECONNECT_STABLE_SECS,
+    next_reconnect_delay,
+    tcp_accepts,
+    wait_until_tcp_accepts,
+)
+from nao_websocket_bridge_client.stream import iter_bridge_messages
+from nao_websocket_bridge_protocol import (
+    CHANNELS,
+    SAMPLE_RATE,
+    SAMPLE_WIDTH_BYTES,
+    validate_audio_format,
+    websocket_url,
+)
+
+__all__ = [
+    "CHANNELS",
+    "SAMPLE_RATE",
+    "SAMPLE_WIDTH_BYTES",
+    "RECONNECT_BASE_SECS",
+    "RECONNECT_STABLE_SECS",
+    "iter_bridge_messages",
+    "next_reconnect_delay",
+    "tcp_accepts",
+    "validate_audio_format",
+    "wait_until_tcp_accepts",
+    "websocket_url",
+]

nao_websocket_bridge_client-0.1.0/nao_websocket_bridge_client/__main__.py

@@ -0,0 +1,80 @@
+"""Print RMS for each PCM chunk from a NAO bridge.
+
+Example:
+    uv run python -m nao_websocket_bridge_client --url ws://192.168.2.50:8765
+"""
+
+from __future__ import annotations
+
+import argparse
+import asyncio
+import math
+import sys
+from array import array
+
+from nao_websocket_bridge_client.stream import iter_bridge_messages
+
+PCM16_FULL_SCALE = 32768.0
+
+
+def calculate_rms(pcm: bytes) -> tuple[float, float]:
+    if not pcm:
+        return 0.0, -math.inf
+    samples = array("h")
+    samples.frombytes(pcm)
+    if sys.byteorder != "little":
+        samples.byteswap()
+    mean_square = sum(sample * sample for sample in samples) / len(samples)
+    rms = math.sqrt(mean_square)
+    normalized_rms = rms / PCM16_FULL_SCALE
+    dbfs = 20.0 * math.log10(max(normalized_rms, 1e-12))
+    return rms, dbfs
+
+
+async def stream_audio(url: str) -> None:
+    print(f"Connecting to {url} ...")
+    async for kind, payload in iter_bridge_messages(url):
+        if kind == "format":
+            audio_format = payload
+            assert isinstance(audio_format, dict)
+            print(
+                "Connected: "
+                f"{audio_format['sample_rate']} Hz, "
+                f"{audio_format['channels']} channel, "
+                f"{audio_format['encoding']}"
+            )
+            continue
+        if kind == "text":
+            print(f"Control message: {payload}")
+            continue
+        assert isinstance(payload, bytes)
+        rms, dbfs = calculate_rms(payload)
+        normalized_rms = rms / PCM16_FULL_SCALE
+        print(
+            f"RMS: {rms:8.1f} | "
+            f"normalized: {normalized_rms:.4f} | "
+            f"dBFS: {dbfs:6.1f} | "
+            f"bytes: {len(payload)}"
+        )
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(description="Listen to the NAO WebSocket bridge")
+    parser.add_argument(
+        "--url",
+        default="ws://192.168.2.50:8765",
+        help="Bridge WebSocket URL (default: ws://192.168.2.50:8765)",
+    )
+    args = parser.parse_args()
+    try:
+        asyncio.run(stream_audio(args.url))
+    except KeyboardInterrupt:
+        print("\nStopped.")
+    except Exception as exc:
+        print(f"Audio bridge client failed: {exc}", file=sys.stderr)
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

nao_websocket_bridge_client-0.1.0/nao_websocket_bridge_client/reconnect.py

@@ -0,0 +1,59 @@
+"""TCP probe and reconnect delay for the bridge socket."""
+
+from __future__ import annotations
+
+import asyncio
+import time
+
+_PROBE_INTERVAL_SECS = 0.5
+_PROBE_TIMEOUT_SECS = 0.3
+
+RECONNECT_BASE_SECS = 0.5
+RECONNECT_MAX_SECS = 8.0
+RECONNECT_STABLE_SECS = 2.0
+
+
+def next_reconnect_delay(previous: float, held_secs: float) -> float:
+    """Back off when the bridge socket dies as soon as it connects.
+
+    A stable drop retries quickly. A socket that lived only a moment is the
+    other side of a replace-and-reconnect fight, so the wait doubles.
+    """
+    if held_secs >= RECONNECT_STABLE_SECS:
+        return RECONNECT_BASE_SECS
+    return min(max(previous, RECONNECT_BASE_SECS) * 2.0, RECONNECT_MAX_SECS)
+
+
+async def tcp_accepts(
+    host: str,
+    port: int,
+    timeout: float = _PROBE_TIMEOUT_SECS,
+) -> bool:
+    """True when ``host:port`` accepts a TCP connection."""
+    try:
+        _reader, writer = await asyncio.wait_for(
+            asyncio.open_connection(host, port),
+            timeout=timeout,
+        )
+    except Exception:
+        return False
+    writer.close()
+    try:
+        await writer.wait_closed()
+    except Exception:
+        pass
+    return True
+
+
+async def wait_until_tcp_accepts(host: str, port: int, delay: float) -> None:
+    """Wait up to ``delay`` seconds, returning early once the port accepts."""
+    if delay <= 0:
+        return
+    deadline = time.monotonic() + delay
+    while True:
+        if await tcp_accepts(host, port):
+            return
+        remaining = deadline - time.monotonic()
+        if remaining <= 0:
+            return
+        await asyncio.sleep(min(_PROBE_INTERVAL_SECS, remaining))

nao_websocket_bridge_client-0.1.0/nao_websocket_bridge_client/stream.py

@@ -0,0 +1,32 @@
+"""Read format, status, and PCM frames from a bridge WebSocket."""
+
+from __future__ import annotations
+
+import json
+from collections.abc import AsyncIterator
+
+import websockets
+
+from nao_websocket_bridge_protocol import validate_audio_format
+
+
+async def iter_bridge_messages(url: str) -> AsyncIterator[tuple[str, object]]:
+    """Yield ``("format", dict)``, ``("text", dict)``, and ``("pcm", bytes)``.
+
+    The first frame must be the audio format announcement. Later text frames
+    are status or other JSON. Binary frames are PCM S16LE.
+    """
+    async with websockets.connect(url, max_size=None) as websocket:
+        first = await websocket.recv()
+        if not isinstance(first, str):
+            raise RuntimeError("Expected audio format JSON as first WebSocket frame")
+        yield ("format", validate_audio_format(json.loads(first)))
+
+        async for message in websocket:
+            if isinstance(message, str):
+                yield ("text", json.loads(message))
+                continue
+            payload = bytes(message)
+            if len(payload) % 2:
+                raise RuntimeError("PCM S16LE frame has an odd byte count")
+            yield ("pcm", payload)

nao_websocket_bridge_client-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "nao-websocket-bridge-client"
+version = "0.1.0"
+description = "Laptop client for the NAO WebSocket bridge."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Valentin Schröter Bonk", email = "vasc9380@th-wildau.de" }]
+maintainers = [{ name = "Valentin Schröter Bonk", email = "vasc9380@th-wildau.de" }]
+dependencies = [
+    "nao-websocket-bridge-protocol",
+    "websockets>=13",
+]
+
+[tool.uv.sources]
+nao-websocket-bridge-protocol = { path = "../nao-websocket-bridge-protocol", editable = true }
+
+[tool.hatch.build.targets.wheel]
+packages = ["nao_websocket_bridge_client"]

nao_websocket_bridge_client-0.1.0/tests/test_reconnect.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+import unittest
+
+from nao_websocket_bridge_client import next_reconnect_delay, websocket_url
+
+
+class ReconnectTests(unittest.TestCase):
+    def test_stable_drop_retries_quickly(self) -> None:
+        self.assertEqual(next_reconnect_delay(0.5, 10.0), 0.5)
+
+    def test_instant_drop_backs_off(self) -> None:
+        self.assertEqual(next_reconnect_delay(0.5, 0.02), 1.0)
+        self.assertEqual(next_reconnect_delay(4.0, 0.02), 8.0)
+
+    def test_url_comes_from_the_protocol(self) -> None:
+        self.assertEqual(
+            websocket_url("10.0.0.5", 8765, "booth-secret"),
+            "ws://10.0.0.5:8765/booth-secret",
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()