voxedge 0.0.2a0__tar.gz

voxedge-0.0.2a0/LICENSE

@@ -0,0 +1,191 @@
+                                 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 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, as submitted to the 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, "Contribution" includes any original work of
+      authorship, including any modifications or additions to an existing
+      work, that is intentionally submitted to the Licensor for inclusion
+      in the Work. A "Contribution" is included in the Work as submitted.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been submitted to the Licensor.
+
+      "Licensed Patents" shall mean patent claims licensable by a 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.
+
+      "Work" shall also mean the Contribution.
+
+      "Contributor Version" shall mean the combination of the Contributions
+      of others (if any) used by a Contributor and that Contributor's
+      Contribution.
+
+   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 any
+      Contribution incorporated within the Work constitutes patent 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, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, 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 license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is furnished to do so,
+      subject to the following conditions:
+
+   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 conditions of title,
+      MERCHANTIBILITY, NON-INFRINGEMENT, 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 exemplary 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 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 warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Harvest Su
+
+   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
+
+       http://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.

voxedge-0.0.2a0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: voxedge
+Version: 0.0.2a0
+Summary: Pipecat for the edge — edge-native, local-first real-time voice conversation library
+Author: Harvest Su
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Provides-Extra: rk
+Requires-Dist: rknn-toolkit-lite2>=2.0; platform_machine == "aarch64" and extra == "rk"
+Requires-Dist: rkvoice-stream>=0.1.1; platform_machine == "aarch64" and extra == "rk"
+Provides-Extra: sherpa
+Requires-Dist: sherpa-onnx>=1.10; extra == "sherpa"
+Requires-Dist: soundfile>=0.12; extra == "sherpa"
+Provides-Extra: jetson
+Requires-Dist: onnxruntime>=1.16; extra == "jetson"
+Requires-Dist: soundfile>=0.12; extra == "jetson"
+Requires-Dist: piper-phonemize>=1.1.0; platform_machine == "aarch64" and extra == "jetson"
+Requires-Dist: tokenizers>=0.15; extra == "jetson"
+Requires-Dist: webrtcvad>=2.0.10; extra == "jetson"
+Provides-Extra: translator
+Requires-Dist: ctranslate2>=4.0; extra == "translator"
+Requires-Dist: sentencepiece>=0.1.99; extra == "translator"
+Provides-Extra: text
+Provides-Extra: artifacts
+Requires-Dist: huggingface_hub>=0.20; extra == "artifacts"
+Provides-Extra: llm
+Requires-Dist: httpx>=0.24; extra == "llm"
+Dynamic: license-file
+
+# voxedge
+
+> **English** | [中文](README.zh-CN.md)
+
+<p align="center">
+  <img src="media/banner.png" alt="voxedge banner" width="100%">
+</p>
+
+[![PyPI](https://img.shields.io/pypi/v/voxedge)](https://pypi.org/project/voxedge)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/voxedge)](https://pypi.org/project/voxedge)
+
+**Native TensorRT · RKNN · sherpa-onnx voice pipelines for Jetson, Rockchip, and Raspberry Pi — fully on-device, verified on real hardware, zero cloud.**
+
+<!-- TODO: Add demo GIF — recommend a ~15s terminal recording showing ASR→TTS on Jetson Orin (place in media/demo.gif) -->
+
+## What is voxedge?
+
+voxedge is an embeddable Python library that drives real-time, on-device voice conversations by calling directly into each platform's native inference runtime — TensorRT on Jetson Orin, RKNN on RK3576/RK3588, sherpa-onnx on CPU. No cloud STT/TTS APIs, no internet at runtime, no intermediate abstraction overhead. The same `ConversationEngine` API works across all three backends; you swap only the backend constructor — N=2 concurrent sessions verified on Orin Nano 8 GB, byte-identical output, zero CUDA errors.
+
+voxedge is the open-core engine behind **[OpenVoiceStream](https://github.com/suharvest/openvoicestream)** — the deployable FastAPI/WebSocket server, device profiles, and agent gallery. Want a container? Start there. Want to embed real-time edge voice in your own app? You're in the right place.
+
+## Key Features
+
+- **Native runtimes, full performance** — calls directly into TensorRT (Jetson), RKNN (Rockchip), and sherpa-onnx (CPU); no wrapper overhead, no cross-platform abstraction tax
+- **Fully on-device** — no speech API key, no per-call bill, no internet dependency at runtime
+- **Verified on real hardware** — N=2 concurrent sessions on Orin Nano 8 GB: byte-identical output vs. single-stream, zero CUDA errors
+- **Streaming + barge-in** — partial + final ASR while the user speaks; sentence-level TTS streaming with first-audio latency low enough for live dialogue and cooperative barge-in
+- **Swap hardware, not code** — same `ConversationEngine` API across Jetson, Rockchip, and sherpa-onnx CPU; only the backend constructor changes
+- **Test on any machine** — mock backends require only numpy; the whole engine runs end-to-end on a Mac with no CUDA or GPU
+
+## Quickstart
+
+Runs on any machine — no GPU needed. Swap the backend constructors for a real device; the engine, transport, and event contract never change.
+
+```bash
+pip install voxedge
+```
+
+```python
+import asyncio
+from voxedge.engine import ConversationEngine
+from voxedge.transport import InProcessTransport
+from voxedge.backends.mock import MockASR, MockTTS, MockVAD
+
+engine = ConversationEngine(
+    backends={"asr": MockASR(transcript="hello world"), "tts": MockTTS(), "vad": MockVAD()},
+    multi_utterance=True,
+)
+
+async def main():
+    t = InProcessTransport()
+    await t.feed_audio(b"\x01\x02" * 8000)   # speech frames (int16 PCM)
+    await t.feed_audio(b"\x00\x00" * 8000)   # silence → VAD endpoints the utterance
+    t.end_input()
+    await engine.run(t)                       # drives ASR → (LLM) → TTS
+    for ev in t.drain_events_nowait():        # asr_final / tts_* / ...
+        print(ev["type"], ev.get("text", ""))
+
+asyncio.run(main())
+```
+
+On a real device, swap **only the backend constructors** — everything else is identical:
+
+```python
+# Jetson Orin — pip install voxedge[jetson]
+from voxedge.backends.jetson import (
+    TRTEdgeLLMASRBackend, TRTEdgeLLMASRConfig,
+    TRTEdgeLLMTTSBackend, TRTEdgeLLMTTSConfig,
+)
+
+engine = ConversationEngine(backends={
+    "asr": TRTEdgeLLMASRBackend(TRTEdgeLLMASRConfig(...)),   # Qwen3-ASR, native TRT
+    "tts": TRTEdgeLLMTTSBackend(TRTEdgeLLMTTSConfig(...)),   # Qwen3-TTS, streaming
+}, multi_utterance=True)
+```
+
+> `import voxedge` is **numpy-only** — TensorRT, RKNN, and sherpa-onnx are lazy-imported by their backend adapters and pulled in via extras. The example above imports cleanly on a Mac even though the TRT engine only runs on a Jetson.
+
+## Install
+
+```bash
+pip install voxedge            # pure-Python core (numpy only)
+pip install voxedge[sherpa]    # sherpa-onnx CPU ASR/TTS
+pip install voxedge[jetson]    # Jetson TensorRT backends (aarch64)
+pip install voxedge[rk]        # Rockchip RK3576/RK3588 NPU (aarch64)
+pip install voxedge[llm]       # OpenAI-compatible LLM backend (httpx)
+```
+
+The `jetson` / `rk` extras declare only pure-Python deps; the CUDA/TensorRT and RKNN runtime wheels ship from the platform (JetPack L4T / Rockchip NPU userspace) or the engine repos — you bring the platform runtime.
+
+## Architecture
+
+Four layers, all importable without CUDA.
+
+### Backends (`voxedge/backends/`)
+
+Clean ABCs in `backends/base.py` — every constructor takes explicit params only, no env coupling:
+
+- `ASRBackend` / `ASRStream` — streaming recognition
+- `TTSBackend` — `synthesize()` (batch) + `generate_streaming()` (sentence-level chunks, cooperative cancel via `cancel_token` for barge-in)
+- `VADBackend` / `VADSession` — voice-activity detection for speech / barge-in segmentation
+- `LLMBackend` / `LLMEvent` — token-streaming LLM for the conversation loop
+
+Concrete adapters live under `backends/{jetson,rk,sherpa}/` and import their heavy runtimes **lazily** (inside methods), so all modules import on any machine:
+
+| Backend | Platform | Models | Extra | Source engine |
+|---------|----------|--------|-------|---------------|
+| `backends/jetson/` | Jetson Orin (TensorRT) | Qwen3-ASR/TTS, Matcha, Kokoro, Paraformer, SenseVoice, MOSS-TTS-Nano | `voxedge[jetson]` aarch64 | [jetson-voice-engine](https://github.com/suharvest/qwen3-edgellm-jetson) |
+| `backends/rk/` | Rockchip RK3576/RK3588 (RKNN) | Qwen3-ASR, Matcha, Piper, Kokoro, Paraformer, SenseVoice | `voxedge[rk]` aarch64 | [rkvoice-stream](https://github.com/suharvest/rkvoice-stream) |
+| `backends/sherpa/` | CPU (any arch) | Paraformer, Zipformer, SenseVoice, Matcha, Kokoro ONNX | `voxedge[sherpa]` | — |
+| `backends/llm/` | Any | OpenAI-compatible LLM over httpx | `voxedge[llm]` | — |
+| `backends/mock.py` | Dev / CI | MockASR, MockTTS, MockVAD, MockLLM | core | — |
+
+### Transport (`voxedge/transport/`)
+
+`Transport` ABC + two implementations:
+
+- `InProcessTransport` — zero-IPC asyncio queues; default, used everywhere in tests
+- `WebSocketTransport` — duck-typed ws adapter with no FastAPI dependency; idle-watchdog timeout injected by caller, reads no env
+
+### Conversation Engine (`voxedge/engine/`)
+
+`ConversationEngine` + per-connection `Session` coordinator, split into focused collaborators: `audio_dispatcher` (VAD → speech / barge-in), `asr_loop`, `client_events`, `tts_sequencer` / `tts_buffer`, `session_state`, and the LLM↔tool loop — `llm_turn` over the provider-agnostic `turn_driver.run_turn` pump, with `tool_registry` (`@tool` → JSON schema) and `coordinator` / `concurrency_capability` for multi-stream concurrency.
+
+### Capabilities (`voxedge/capabilities/`)
+
+Optional, default-off, stateless add-ons (punctuation, speaker embedding) via sherpa-onnx. Opt in explicitly; byte-level no-op when off.
+
+## Design Constraints
+
+- **Pure Python core** — `import voxedge` is numpy-only. Heavy adapters live under `backends/{jetson,rk,sherpa}/` with deferred runtime imports.
+- **No env reads in the library** — all config injected as explicit params. Profiles and deployment knobs are the product's job ([OpenVoiceStream](https://github.com/suharvest/openvoicestream)).
+
+## Status
+
+In production — the open-core engine behind a shipped edge voice stack. ~270 mock-based tests; the whole engine runs end-to-end on a Mac with no CUDA.
+
+## Contributing
+
+Issues and PRs welcome. The mock backend suite runs on any machine with no hardware:
+
+```bash
+pip install voxedge
+uv run pytest
+```
+
+## Ecosystem
+
+voxedge is one layer in a family of repos:
+
+| Repo | Role | When to go there |
+|------|------|-----------------|
+| **voxedge** *(this repo)* | Embeddable Python engine | Embedding real-time voice in your own app |
+| [openvoicestream](https://github.com/suharvest/openvoicestream) | Deployable FastAPI/WebSocket server, Docker profiles, agent gallery | Deployed use-cases and end-to-end demos; ready-to-run containers |
+| [rkvoice-stream](https://github.com/suharvest/rkvoice-stream) | Rockchip NPU engine (`backends/rk/` wraps this) | RK3576/RK3588 model formats, RKNN perf numbers, TTS/ASR backend internals |
+| [jetson-voice-engine](https://github.com/suharvest/qwen3-edgellm-jetson) | Jetson TensorRT build scripts, model export, artifacts (`backends/jetson/` wraps this) | Jetson model conversion, TRT engine build, Orin-specific optimisations |
+
+## Acknowledgements
+
+- [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx) — CPU ASR/TTS runtime
+- [OpenVoiceStream](https://github.com/suharvest/openvoicestream) — the deployable server product built on this engine
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

voxedge-0.0.2a0/README.md

@@ -0,0 +1,166 @@
+# voxedge
+
+> **English** | [中文](README.zh-CN.md)
+
+<p align="center">
+  <img src="media/banner.png" alt="voxedge banner" width="100%">
+</p>
+
+[![PyPI](https://img.shields.io/pypi/v/voxedge)](https://pypi.org/project/voxedge)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/voxedge)](https://pypi.org/project/voxedge)
+
+**Native TensorRT · RKNN · sherpa-onnx voice pipelines for Jetson, Rockchip, and Raspberry Pi — fully on-device, verified on real hardware, zero cloud.**
+
+<!-- TODO: Add demo GIF — recommend a ~15s terminal recording showing ASR→TTS on Jetson Orin (place in media/demo.gif) -->
+
+## What is voxedge?
+
+voxedge is an embeddable Python library that drives real-time, on-device voice conversations by calling directly into each platform's native inference runtime — TensorRT on Jetson Orin, RKNN on RK3576/RK3588, sherpa-onnx on CPU. No cloud STT/TTS APIs, no internet at runtime, no intermediate abstraction overhead. The same `ConversationEngine` API works across all three backends; you swap only the backend constructor — N=2 concurrent sessions verified on Orin Nano 8 GB, byte-identical output, zero CUDA errors.
+
+voxedge is the open-core engine behind **[OpenVoiceStream](https://github.com/suharvest/openvoicestream)** — the deployable FastAPI/WebSocket server, device profiles, and agent gallery. Want a container? Start there. Want to embed real-time edge voice in your own app? You're in the right place.
+
+## Key Features
+
+- **Native runtimes, full performance** — calls directly into TensorRT (Jetson), RKNN (Rockchip), and sherpa-onnx (CPU); no wrapper overhead, no cross-platform abstraction tax
+- **Fully on-device** — no speech API key, no per-call bill, no internet dependency at runtime
+- **Verified on real hardware** — N=2 concurrent sessions on Orin Nano 8 GB: byte-identical output vs. single-stream, zero CUDA errors
+- **Streaming + barge-in** — partial + final ASR while the user speaks; sentence-level TTS streaming with first-audio latency low enough for live dialogue and cooperative barge-in
+- **Swap hardware, not code** — same `ConversationEngine` API across Jetson, Rockchip, and sherpa-onnx CPU; only the backend constructor changes
+- **Test on any machine** — mock backends require only numpy; the whole engine runs end-to-end on a Mac with no CUDA or GPU
+
+## Quickstart
+
+Runs on any machine — no GPU needed. Swap the backend constructors for a real device; the engine, transport, and event contract never change.
+
+```bash
+pip install voxedge
+```
+
+```python
+import asyncio
+from voxedge.engine import ConversationEngine
+from voxedge.transport import InProcessTransport
+from voxedge.backends.mock import MockASR, MockTTS, MockVAD
+
+engine = ConversationEngine(
+    backends={"asr": MockASR(transcript="hello world"), "tts": MockTTS(), "vad": MockVAD()},
+    multi_utterance=True,
+)
+
+async def main():
+    t = InProcessTransport()
+    await t.feed_audio(b"\x01\x02" * 8000)   # speech frames (int16 PCM)
+    await t.feed_audio(b"\x00\x00" * 8000)   # silence → VAD endpoints the utterance
+    t.end_input()
+    await engine.run(t)                       # drives ASR → (LLM) → TTS
+    for ev in t.drain_events_nowait():        # asr_final / tts_* / ...
+        print(ev["type"], ev.get("text", ""))
+
+asyncio.run(main())
+```
+
+On a real device, swap **only the backend constructors** — everything else is identical:
+
+```python
+# Jetson Orin — pip install voxedge[jetson]
+from voxedge.backends.jetson import (
+    TRTEdgeLLMASRBackend, TRTEdgeLLMASRConfig,
+    TRTEdgeLLMTTSBackend, TRTEdgeLLMTTSConfig,
+)
+
+engine = ConversationEngine(backends={
+    "asr": TRTEdgeLLMASRBackend(TRTEdgeLLMASRConfig(...)),   # Qwen3-ASR, native TRT
+    "tts": TRTEdgeLLMTTSBackend(TRTEdgeLLMTTSConfig(...)),   # Qwen3-TTS, streaming
+}, multi_utterance=True)
+```
+
+> `import voxedge` is **numpy-only** — TensorRT, RKNN, and sherpa-onnx are lazy-imported by their backend adapters and pulled in via extras. The example above imports cleanly on a Mac even though the TRT engine only runs on a Jetson.
+
+## Install
+
+```bash
+pip install voxedge            # pure-Python core (numpy only)
+pip install voxedge[sherpa]    # sherpa-onnx CPU ASR/TTS
+pip install voxedge[jetson]    # Jetson TensorRT backends (aarch64)
+pip install voxedge[rk]        # Rockchip RK3576/RK3588 NPU (aarch64)
+pip install voxedge[llm]       # OpenAI-compatible LLM backend (httpx)
+```
+
+The `jetson` / `rk` extras declare only pure-Python deps; the CUDA/TensorRT and RKNN runtime wheels ship from the platform (JetPack L4T / Rockchip NPU userspace) or the engine repos — you bring the platform runtime.
+
+## Architecture
+
+Four layers, all importable without CUDA.
+
+### Backends (`voxedge/backends/`)
+
+Clean ABCs in `backends/base.py` — every constructor takes explicit params only, no env coupling:
+
+- `ASRBackend` / `ASRStream` — streaming recognition
+- `TTSBackend` — `synthesize()` (batch) + `generate_streaming()` (sentence-level chunks, cooperative cancel via `cancel_token` for barge-in)
+- `VADBackend` / `VADSession` — voice-activity detection for speech / barge-in segmentation
+- `LLMBackend` / `LLMEvent` — token-streaming LLM for the conversation loop
+
+Concrete adapters live under `backends/{jetson,rk,sherpa}/` and import their heavy runtimes **lazily** (inside methods), so all modules import on any machine:
+
+| Backend | Platform | Models | Extra | Source engine |
+|---------|----------|--------|-------|---------------|
+| `backends/jetson/` | Jetson Orin (TensorRT) | Qwen3-ASR/TTS, Matcha, Kokoro, Paraformer, SenseVoice, MOSS-TTS-Nano | `voxedge[jetson]` aarch64 | [jetson-voice-engine](https://github.com/suharvest/qwen3-edgellm-jetson) |
+| `backends/rk/` | Rockchip RK3576/RK3588 (RKNN) | Qwen3-ASR, Matcha, Piper, Kokoro, Paraformer, SenseVoice | `voxedge[rk]` aarch64 | [rkvoice-stream](https://github.com/suharvest/rkvoice-stream) |
+| `backends/sherpa/` | CPU (any arch) | Paraformer, Zipformer, SenseVoice, Matcha, Kokoro ONNX | `voxedge[sherpa]` | — |
+| `backends/llm/` | Any | OpenAI-compatible LLM over httpx | `voxedge[llm]` | — |
+| `backends/mock.py` | Dev / CI | MockASR, MockTTS, MockVAD, MockLLM | core | — |
+
+### Transport (`voxedge/transport/`)
+
+`Transport` ABC + two implementations:
+
+- `InProcessTransport` — zero-IPC asyncio queues; default, used everywhere in tests
+- `WebSocketTransport` — duck-typed ws adapter with no FastAPI dependency; idle-watchdog timeout injected by caller, reads no env
+
+### Conversation Engine (`voxedge/engine/`)
+
+`ConversationEngine` + per-connection `Session` coordinator, split into focused collaborators: `audio_dispatcher` (VAD → speech / barge-in), `asr_loop`, `client_events`, `tts_sequencer` / `tts_buffer`, `session_state`, and the LLM↔tool loop — `llm_turn` over the provider-agnostic `turn_driver.run_turn` pump, with `tool_registry` (`@tool` → JSON schema) and `coordinator` / `concurrency_capability` for multi-stream concurrency.
+
+### Capabilities (`voxedge/capabilities/`)
+
+Optional, default-off, stateless add-ons (punctuation, speaker embedding) via sherpa-onnx. Opt in explicitly; byte-level no-op when off.
+
+## Design Constraints
+
+- **Pure Python core** — `import voxedge` is numpy-only. Heavy adapters live under `backends/{jetson,rk,sherpa}/` with deferred runtime imports.
+- **No env reads in the library** — all config injected as explicit params. Profiles and deployment knobs are the product's job ([OpenVoiceStream](https://github.com/suharvest/openvoicestream)).
+
+## Status
+
+In production — the open-core engine behind a shipped edge voice stack. ~270 mock-based tests; the whole engine runs end-to-end on a Mac with no CUDA.
+
+## Contributing
+
+Issues and PRs welcome. The mock backend suite runs on any machine with no hardware:
+
+```bash
+pip install voxedge
+uv run pytest
+```
+
+## Ecosystem
+
+voxedge is one layer in a family of repos:
+
+| Repo | Role | When to go there |
+|------|------|-----------------|
+| **voxedge** *(this repo)* | Embeddable Python engine | Embedding real-time voice in your own app |
+| [openvoicestream](https://github.com/suharvest/openvoicestream) | Deployable FastAPI/WebSocket server, Docker profiles, agent gallery | Deployed use-cases and end-to-end demos; ready-to-run containers |
+| [rkvoice-stream](https://github.com/suharvest/rkvoice-stream) | Rockchip NPU engine (`backends/rk/` wraps this) | RK3576/RK3588 model formats, RKNN perf numbers, TTS/ASR backend internals |
+| [jetson-voice-engine](https://github.com/suharvest/qwen3-edgellm-jetson) | Jetson TensorRT build scripts, model export, artifacts (`backends/jetson/` wraps this) | Jetson model conversion, TRT engine build, Orin-specific optimisations |
+
+## Acknowledgements
+
+- [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx) — CPU ASR/TTS runtime
+- [OpenVoiceStream](https://github.com/suharvest/openvoicestream) — the deployable server product built on this engine
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).