xiaozhi-sdk 0.1.0__tar.gz → 0.2.0__tar.gz

xiaozhi_sdk-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dairoot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xiaozhi_sdk-0.2.0/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+recursive-include file *
+recursive-exclude file *.pyc
+recursive-exclude file __pycache__

xiaozhi_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: xiaozhi-sdk
+Version: 0.2.0
+Summary: 一个用于连接和控制小智智能设备的Python SDK，支持实时音频通信、MCP工具集成和设备管理功能。
+Author-email: dairoot <623815825@qq.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dairoot/xiaozhi-sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: websockets>=15.0.1
+Requires-Dist: aiohttp
+Requires-Dist: av
+Requires-Dist: opuslib
+Requires-Dist: requests
+Requires-Dist: sounddevice
+Requires-Dist: python-socks
+Requires-Dist: click
+Requires-Dist: colorlog
+Requires-Dist: soundfile>=0.13.1
+Requires-Dist: pydub>=0.25.1
+Requires-Dist: pillow>=11.3.0
+Dynamic: license-file
+
+# 小智SDK (XiaoZhi SDK)
+
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![PyPI](https://img.shields.io/badge/pypi-xiaozhi--sdk-blue.svg)](https://pypi.org/project/xiaozhi-sdk/)
+
+基于虾哥的 [小智esp32 websocket 通讯协议](https://github.com/78/xiaozhi-esp32/blob/main/docs/websocket.md) 实现的 Python SDK。
+
+一个用于连接和控制小智设备的 Python SDK。支持以下功能：
+- 实时音频通信
+- MCP 工具集成
+- 设备管理与控制
+
+---
+
+## 📦 安装
+
+```bash
+pip install xiaozhi-sdk
+```
+
+---
+
+## 🚀 快速开始
+
+### 1. 终端使用
+
+最简单的方式是通过终端直接连接设备：
+
+#### 查看帮助信息
+
+```bash
+python -m xiaozhi_sdk --help
+```
+
+#### 连接设备（需要提供 MAC 地址）
+
+```bash
+python -m xiaozhi_sdk 00:22:44:66:88:00
+```
+
+### 2. 编程使用 (高阶用法)
+参考 [examples](examples/) 文件中的示例代码，可以快速开始使用 SDK。
+
+
+---
+
+## ✅ 运行测试
+
+```bash
+# 安装开发依赖
+uv sync --group dev
+
+# 运行测试
+uv run pytest
+```
+
+
+---
+
+## 🫡 致敬
+
+- 🫡 虾哥的 [xiaozhi-esp32](https://github.com/78/xiaozhi-esp32) 项目

xiaozhi_sdk-0.2.0/README.md

@@ -0,0 +1,63 @@
+# 小智SDK (XiaoZhi SDK)
+
+[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+[![PyPI](https://img.shields.io/badge/pypi-xiaozhi--sdk-blue.svg)](https://pypi.org/project/xiaozhi-sdk/)
+
+基于虾哥的 [小智esp32 websocket 通讯协议](https://github.com/78/xiaozhi-esp32/blob/main/docs/websocket.md) 实现的 Python SDK。
+
+一个用于连接和控制小智设备的 Python SDK。支持以下功能：
+- 实时音频通信
+- MCP 工具集成
+- 设备管理与控制
+
+---
+
+## 📦 安装
+
+```bash
+pip install xiaozhi-sdk
+```
+
+---
+
+## 🚀 快速开始
+
+### 1. 终端使用
+
+最简单的方式是通过终端直接连接设备：
+
+#### 查看帮助信息
+
+```bash
+python -m xiaozhi_sdk --help
+```
+
+#### 连接设备（需要提供 MAC 地址）
+
+```bash
+python -m xiaozhi_sdk 00:22:44:66:88:00
+```
+
+### 2. 编程使用 (高阶用法)
+参考 [examples](examples/) 文件中的示例代码，可以快速开始使用 SDK。
+
+
+---
+
+## ✅ 运行测试
+
+```bash
+# 安装开发依赖
+uv sync --group dev
+
+# 运行测试
+uv run pytest
+```
+
+
+---
+
+## 🫡 致敬
+
+- 🫡 虾哥的 [xiaozhi-esp32](https://github.com/78/xiaozhi-esp32) 项目

xiaozhi_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xiaozhi-sdk"
+dynamic = ["version"]
+description = "一个用于连接和控制小智智能设备的Python SDK，支持实时音频通信、MCP工具集成和设备管理功能。"
+readme = "README.md"
+authors = [{name = "dairoot", email = "623815825@qq.com"}]
+license = "MIT"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy",
+    "websockets>=15.0.1",
+    "aiohttp",
+    "av",
+    "opuslib",
+    "requests",
+    "sounddevice",
+    "python-socks",
+    "click",
+    "colorlog",
+    "soundfile>=0.13.1",
+    "pydub>=0.25.1",
+    "pillow>=11.3.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/dairoot/xiaozhi-sdk"
+
+[tool.setuptools.dynamic]
+version = {attr = "xiaozhi_sdk.__version__"}
+
+[tool.setuptools.packages.find]
+include = ["xiaozhi_sdk*"]
+
+[tool.setuptools.package-data]
+xiaozhi_sdk = ["../file/**/*"]
+
+[tool.uv]
+dev-dependencies = [
+    "black>=24.8.0",
+    "flake8>=5.0.4",
+    "flake8-bugbear",
+    "flake8-comprehensions",
+    "isort>=5.13.2",
+    "mypy>=1.14.1",
+    "types-requests",
+    "pre-commit>=3.5.0",
+    "pytest>=8.3.5",
+    "pytest-asyncio",
+    "pytest-cov",
+    "build>=0.10",
+]
+
+# 保留现有的工具配置
+[tool.coverage.run]
+omit = [
+    "xiaozhi_sdk/__main__.py",
+    "xiaozhi_sdk/cli.py",
+    "tests/*",
+]

xiaozhi_sdk-0.2.0/tests/test_iot.py

@@ -0,0 +1,28 @@
+import asyncio
+import json
+import os
+import sys
+import uuid
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from xiaozhi_sdk.iot import OtaDevice
+
+
+async def iot_main():
+    serial_number = ""
+    license_key = ""
+    mac_address = "00:22:44:66:88:14"
+    ota_url = "http://localhost:3080/api/ota"
+    ota_url = None
+    ota = OtaDevice(mac_addr=mac_address, client_id=str(uuid.uuid4()), serial_number=serial_number, ota_url=ota_url)
+    res = await ota.activate_device()
+    print(json.dumps(res["mqtt"]))
+
+    # if not res.get("activation"):
+    #     return
+    # await ota.check_activate(res["activation"]["challenge"], license_key)
+
+
+if __name__ == "__main__":
+    asyncio.run(iot_main())

{xiaozhi_sdk-0.1.0 → xiaozhi_sdk-0.2.0}/tests/test_pic.py

@@ -1,15 +1,15 @@
-import aiohttp
 import asyncio
 
+import aiohttp
+
 
 async def explain_image():
-    url = "http://api.xiaozhi.me/mcp/vision/explain"
+    url = "http://api.xiaozhi.me/vision/explain"
     question = "这个图片里有什么？"
-    image_path = "./file/leijun.jpg"
+    image_path = "./file/image/leijun.jpg"
 
     boundary = "----ESP32_CAMERA_BOUNDARY"
     headers = {
-
         "Content-Type": f"multipart/form-data; boundary={boundary}",
         # 不设置Transfer-Encoding，aiohttp自动处理
     }
@@ -42,5 +42,6 @@ async def explain_image():
             text = await resp.text()
             print("Response:", text)
 
+
 if __name__ == "__main__":
     asyncio.run(explain_image())

xiaozhi_sdk-0.2.0/tests/test_wake_word.py

@@ -0,0 +1,31 @@
+import asyncio
+import os
+import sys
+
+import pytest
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from xiaozhi_sdk import XiaoZhiWebsocket
+
+
+MAC_ADDR = "00:22:44:66:88:00"
+ota_url = None
+URL = None
+
+
+@pytest.mark.asyncio
+async def test_main():
+    is_end = asyncio.Event()
+    async def message_handler_callback(message):
+        if message.get("state") == "stop":
+            is_end.set()
+        print("message received:", message)
+
+    xiaozhi = XiaoZhiWebsocket(message_handler_callback, url=URL, ota_url=ota_url)
+    await xiaozhi.init_connection(MAC_ADDR)
+
+    await xiaozhi.send_wake_word("你是")
+
+    await asyncio.wait_for(is_end.wait(), timeout=20.0)
+    await xiaozhi.close()

xiaozhi_sdk-0.2.0/tests/test_xiaozhi.py

@@ -0,0 +1,106 @@
+import asyncio
+import os
+import sys
+import time
+
+import numpy as np
+import pytest
+import sounddevice as sd
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), ".."))
+
+from xiaozhi_sdk import XiaoZhiWebsocket
+from xiaozhi_sdk.utils import read_audio_file
+
+
+async def assistant_audio_play(audio_queue, wait_time=5):
+    # 创建一个持续播放的流
+    stream = sd.OutputStream(samplerate=16000, channels=1, dtype=np.int16)
+    stream.start()
+    last_time = int(time.time())
+    while True:
+        if not audio_queue:
+            await asyncio.sleep(0.01)
+            if last_time and time.time() - last_time > wait_time:
+                break
+
+            continue
+
+        pcm_data = audio_queue.popleft()
+
+        # 将字节数据转换为 numpy int16 数组
+        audio_array = pcm_data
+
+        stream.write(audio_array)
+        last_time = time.time()
+
+    stream.stop()
+    stream.close()
+
+
+def mcp_tool_func():
+    def mcp_take_photo(data) -> tuple[bytes, bool]:
+        with open("./file/image/leijun.jpg", "rb") as f:
+            return f.read(), False
+
+    def mcp_get_device_status(data) -> tuple[dict, bool]:
+        data = {
+            "audio_speaker": {"volume": 80},
+            "screen": {"brightness": 75, "theme": "light"},
+            "network": {"type": "wifi", "ssid": "wifi名称", "signal": "strong"},
+        }
+        return data, False
+
+    def mcp_set_volume(data) -> tuple[dict, bool]:
+        return {}, False
+
+    from xiaozhi_sdk.utils.mcp_tool import take_photo, get_device_status, set_volume
+
+    take_photo["tool_func"] = mcp_take_photo
+    get_device_status["tool_func"] = mcp_get_device_status
+    set_volume["tool_func"] = mcp_set_volume
+
+    return [take_photo, get_device_status, set_volume]
+
+
+async def message_handler_callback(message):
+    print("message received:", message)
+    if message["type"] == "music":
+        print("music:", message["text"])
+
+
+MAC_ADDR = "00:22:44:66:88:00"
+
+ota_url = None
+URL = None
+
+
+# URL = None
+
+
+@pytest.mark.asyncio
+async def test_main():
+    xiaozhi = XiaoZhiWebsocket(message_handler_callback, url=URL, ota_url=ota_url)
+
+    await xiaozhi.set_mcp_tool(mcp_tool_func())
+    await xiaozhi.init_connection(MAC_ADDR)
+
+    # # say hellow
+    for pcm in read_audio_file("./file/audio/say_hello.wav"):
+        await xiaozhi.send_audio(pcm)
+    await xiaozhi.send_silence_audio()
+    await assistant_audio_play(xiaozhi.output_audio_queue)
+
+    # say take photo
+    for pcm in read_audio_file("./file/audio/take_photo.wav"):
+        await xiaozhi.send_audio(pcm)
+    await xiaozhi.send_silence_audio()
+    await assistant_audio_play(xiaozhi.output_audio_queue, 5)
+
+    # play music
+    # for pcm in read_audio_file("./file/audio/play_music.wav"):
+    #     await xiaozhi.send_audio(pcm)
+    # await xiaozhi.send_silence_audio()
+    # await assistant_audio_play(xiaozhi.output_audio_queue, 500)
+
+    await xiaozhi.close()

xiaozhi_sdk-0.2.0/xiaozhi_sdk/__init__.py

@@ -0,0 +1,3 @@
+__version__ = "0.2.0"
+
+from xiaozhi_sdk.core import XiaoZhiWebsocket  # noqa

xiaozhi_sdk-0.2.0/xiaozhi_sdk/__main__.py

@@ -0,0 +1,11 @@
+import logging
+
+from xiaozhi_sdk.cli import main
+
+logger = logging.getLogger("xiaozhi_sdk")
+
+if __name__ == "__main__":
+    try:
+        main()
+    except KeyboardInterrupt:
+        logger.debug("Stopping...")