xiaozhi-sdk 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

xiaozhi_sdk/utils/__init__.py

@@ -0,0 +1,57 @@
+import ctypes.util
+import os
+import platform
+import wave
+
+
+def get_wav_info(file_path):
+    with wave.open(file_path, "rb") as wav_file:
+        return wav_file.getframerate(), wav_file.getnchannels()
+
+
+def read_audio_file(file_path):
+    """
+    读取音频文件并通过yield返回PCM流
+
+    Args:
+        file_path (str): 音频文件路径
+
+    Yields:
+        bytes: PCM音频数据块
+    """
+    with wave.open(file_path, "rb") as wav_file:
+        while True:
+            pcm = wav_file.readframes(960)  # 每次读取960帧（60ms的音频数据）
+            if not pcm:
+                break
+            yield pcm
+
+
+def setup_opus():
+
+    def fake_find_library(name):
+        current_dir = os.path.dirname(os.path.abspath(__file__))
+        if name == "opus":
+            system = platform.system().lower()
+            machine = platform.machine().lower()
+
+            # 检测架构
+            if machine in ["x86_64", "amd64", "x64"]:
+                arch = "x64"
+            elif machine in ["arm64", "aarch64"]:
+                arch = "arm64"
+            else:
+                # 默认使用x64作为回退
+                arch = "x64"
+
+            if system == "darwin":  # macOS
+                return f"{current_dir}/../../file/opus/macos-{arch}-libopus.dylib"
+            elif system == "windows":  # Windows
+                return f"{current_dir}/../../file/opus/windows-opus.dll"
+            elif system == "linux":  # Linux
+                return f"{current_dir}/../../file/opus/linux-{arch}-libopus.so"
+            else:
+                # 默认情况，尝试系统查找
+                return ctypes.util.find_library(name)
+
+    ctypes.util.find_library = fake_find_library

xiaozhi_sdk/utils/mcp_tool.py

@@ -0,0 +1,185 @@
+import io
+import random
+
+import aiohttp
+import numpy as np
+
+
+async def async_search_custom_music(data) -> tuple[dict, bool]:
+    search_url = f"https://music-api.gdstudio.xyz/api.php?types=search&name={data['music_name']}&count=100&pages=1"
+
+    # 为搜索请求设置 10 秒超时
+    timeout = aiohttp.ClientTimeout(total=10)
+    async with aiohttp.ClientSession(timeout=timeout) as session:
+        async with session.get(search_url) as response:
+            response_json = await response.json()
+
+    music_list = []
+    first_music_list = []
+    other_music_list1 = []
+    other_music_list2 = []
+    for line in response_json:
+        if data.get("author_name") and data["author_name"] in line["artist"][0]:
+            first_music_list.append(line)
+        elif data.get("author_name") and (data["author_name"] in line["artist"] or data["author_name"] in line["name"]):
+            other_music_list1.append(line)
+        else:
+            other_music_list2.append(line)
+
+    if len(first_music_list) <= 10:
+        music_list = first_music_list
+        random.shuffle(other_music_list2)
+        music_list = music_list + other_music_list1[: 20 - len(music_list)]
+        music_list = music_list + other_music_list2[: 20 - len(music_list)]
+
+    # print(data)
+    # print("找到音乐，数量：", len(first_music_list), len(music_list))
+
+    if not music_list:
+        return {}, False
+    return {"message": "已找到歌曲", "music_list": music_list}, False
+
+
+async def _get_random_music_info(id_list: list) -> dict:
+    timeout = aiohttp.ClientTimeout(total=10)
+    async with aiohttp.ClientSession(timeout=timeout) as session:
+        random.shuffle(id_list)
+
+        for music_id in id_list:
+            url = f"https://music-api.gdstudio.xyz/api.php?types=url&id={music_id}&br=128"
+            async with session.get(url) as response:
+                res_json = await response.json()
+            if res_json.get("url"):
+                break
+
+    return res_json
+
+
+async def async_mcp_play_music(data) -> tuple[list, bool]:
+    try:
+        from pydub import AudioSegment
+    except ImportError:
+        return [], True
+
+    id_list = data["id_list"]
+    res_json = await _get_random_music_info(id_list)
+
+    if not res_json:
+        return [], False
+
+    pcm_list = []
+    buffer = io.BytesIO()
+    # 为下载音乐文件设置 60 秒超时（音乐文件可能比较大）
+    download_timeout = aiohttp.ClientTimeout(total=60)
+    async with aiohttp.ClientSession(timeout=download_timeout) as session:
+        async with session.get(res_json["url"]) as resp:
+            async for chunk in resp.content.iter_chunked(1024):
+                buffer.write(chunk)
+
+    buffer.seek(0)
+    audio = AudioSegment.from_mp3(buffer)
+    audio = audio.set_frame_rate(16000).set_channels(1).set_sample_width(2)  # 2 bytes = 16 bits
+    pcm_data = audio.raw_data
+
+    chunk_size = 960 * 2
+    for i in range(0, len(pcm_data), chunk_size):
+        chunk = pcm_data[i : i + chunk_size]
+
+        if chunk:  # 确保不添加空块
+            chunk = np.frombuffer(chunk, dtype=np.int16)
+            pcm_list.extend(chunk)
+
+    return pcm_list, False
+
+
+search_custom_music = {
+    "name": "search_custom_music",
+    "description": "Search music and get music IDs. Use this tool when the user asks to search or play music. This tool returns a list of music with their IDs, which are required for playing music. Args:\n  `music_name`: The name of the music to search\n  `author_name`: The name of the music author (optional)",
+    "inputSchema": {
+        "type": "object",
+        "properties": {"music_name": {"type": "string"}, "author_name": {"type": "string"}},
+        "required": ["music_name"],
+    },
+    "tool_func": async_search_custom_music,
+    "is_async": True,
+}
+
+play_custom_music = {
+    "name": "play_custom_music",
+    "description": "Play music using music IDs. IMPORTANT: You must call `search_custom_music` first to get the music IDs before using this tool. Use this tool after getting music IDs from search results. Args:\n  `id_list`: The id list of the music to play (obtained from search_custom_music results). The list must contain more than 2 music IDs, and the system will randomly select one to play.\n  `music_name`: The name of the music (obtained from search_custom_music results)",
+    "inputSchema": {
+        "type": "object",
+        "properties": {
+            "music_name": {"type": "string"},
+            "id_list": {"type": "array", "items": {"type": "string"}, "minItems": 3},
+        },
+        "required": ["music_name", "id_list"],
+    },
+    "tool_func": async_mcp_play_music,
+    "is_async": True,
+}
+
+stop_music = {
+    "name": "stop_music",
+    "description": "Stop playing music.",
+    "inputSchema": {"type": "object", "properties": {}},
+    "tool_func": None,
+}
+
+get_device_status = {
+    "name": "get_device_status",
+    "description": "Provides the real-time information of the device, including the current status of the audio speaker, screen, battery, network, etc.\nUse this tool for: \n1. Answering questions about current condition (e.g. what is the current volume of the audio speaker?)\n2. As the first step to control the device (e.g. turn up / down the volume of the audio speaker, etc.)",
+    "inputSchema": {"type": "object", "properties": {}},
+    "tool_func": None,
+}
+
+set_volume = {
+    "name": "set_volume",
+    "description": "Set the volume of the audio speaker. If the current volume is unknown, you must call `get_device_status` tool first and then call this tool.",
+    "inputSchema": {
+        "type": "object",
+        "properties": {"volume": {"type": "integer", "minimum": 0, "maximum": 100}},
+        "required": ["volume"],
+    },
+    "tool_func": None,
+}
+
+set_brightness = {
+    "name": "set_brightness",
+    "description": "Set the brightness of the screen.",
+    "inputSchema": {
+        "type": "object",
+        "properties": {"brightness": {"type": "integer", "minimum": 0, "maximum": 100}},
+        "required": ["brightness"],
+    },
+    "tool_func": None,
+}
+
+set_theme = {
+    "name": "set_theme",
+    "description": "Set the theme of the screen. The theme can be `light` or `dark`.",
+    "inputSchema": {"type": "object", "properties": {"theme": {"type": "string"}}, "required": ["theme"]},
+    "tool_func": None,
+}
+
+take_photo = {
+    "name": "take_photo",
+    "description": "Use this tool when the user asks you to look at something, take a picture, or solve a problem based on what is captured.\nArgs:\n`question`: A clear question or task you want to ask about the captured photo (e.g., identify objects, read text, explain content, or solve a math/logic problem).\nReturn:\n  A JSON object that provides the photo information, including answers, explanations, or problem-solving results if applicable.",
+    "inputSchema": {
+        "type": "object",
+        "properties": {"question": {"type": "string"}},
+        "required": ["question"],
+    },
+    "tool_func": None,
+}
+
+open_tab = {
+    "name": "open_tab",
+    "description": "Open a web page in the browser. 小智后台：https://xiaozhi.me",
+    "inputSchema": {
+        "type": "object",
+        "properties": {"url": {"type": "string"}},
+        "required": ["url"],
+    },
+    "tool_func": None,
+}

xiaozhi_sdk-0.2.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,25 @@
+file/audio/greet.wav,sha256=F60kKKFVQZyYh67_-9AJHMviuquSWHHqwGQewUSOAFg,32720
+file/audio/play_music.wav,sha256=uqUIKz-3bqViDsjEZ2n6g_7xsggbRY6JwdZTCGS8b2E,61772
+file/audio/say_hello.wav,sha256=RGo2MDUF7npGmjFPT4III0ibf7dIZ1c47jijrF0Yjaw,34146
+file/audio/take_photo.wav,sha256=_DNWg31Q8NIxN3eUS4wBC7mn4MZCWLCNPuKfKPv1ojQ,51412
+file/image/leijun.jpg,sha256=plhBvnB4O21RjLwH-HjNq0jH4Msy5ppA_IDWe5ieNg4,70814
+file/opus/linux-arm64-libopus.so,sha256=D2H5VDUomaYuLetejCvLwCgf-iAVP0isg1yGwfsuvEE,493032
+file/opus/linux-x64-libopus.so,sha256=FmXJqkxLpDzNFOHYkmOzmsp1hP0eIS5b6x_XfOs-IQA,623008
+file/opus/macos-arm64-libopus.dylib,sha256=H7wXwkrGwb-hesMMZGFxWb0Ri1Y4m5GWiKsd8CfOhE8,357584
+file/opus/macos-x64-libopus.dylib,sha256=MqyL_OjwSACF4Xs_-KrGbcScy4IEprr5Rlkk3ddZye8,550856
+file/opus/windows-opus.dll,sha256=kLfhioMvbJhOgNMAldpWk3DCZqC5Xd70LRbHnACvAnw,463360
+xiaozhi_sdk/__init__.py,sha256=EnDhE3nCihG1u1vq2yjaZLzlHRKoNmEC-eJSlD7BXxo,77
+xiaozhi_sdk/__main__.py,sha256=i0ZJdHUqAKg9vwZrK_w0TJkzdotTYTK8aUeSPcJc1ks,210
+xiaozhi_sdk/cli.py,sha256=CEpjXW-vnT8DieaK1MV0AYCG4bmK2_vpIz-9zhWHVgE,7001
+xiaozhi_sdk/config.py,sha256=h4mpMeBf2vT9qYAqCCbGVGmMemkgk98pcXP2Rh4TEFc,89
+xiaozhi_sdk/core.py,sha256=kTcENYV7s91kpVyb5-E72l3GMweBpC8bKVZQ_SHR1GU,9807
+xiaozhi_sdk/iot.py,sha256=VVAheynp1iV4GCaoPywQWpKtlyoACDLswH8yfV_JZgI,2699
+xiaozhi_sdk/mcp.py,sha256=YLZOj1F2ILwqhfevETVK2_K7pVweJGMnuMcdRmu6PJg,6558
+xiaozhi_sdk/opus.py,sha256=r3nnYg0ZKAJTreb_3nKgfHJh06MJiMvnNMPO1SWdoMM,2224
+xiaozhi_sdk/utils/__init__.py,sha256=XKSHWoFmuSkpwaIr308HybRzfFIXoT1Fd-eUKo_im6Y,1705
+xiaozhi_sdk/utils/mcp_tool.py,sha256=uxT8jUANGs1mDrTGVkIv1eO89k4qn8WAgXYzITBLObg,7251
+xiaozhi_sdk-0.2.0.dist-info/licenses/LICENSE,sha256=Vwgps1iODKl43cAtME_0dawTjAzNW-O2BWiN5BHggww,1085
+xiaozhi_sdk-0.2.0.dist-info/METADATA,sha256=PN5vqqocSqZEoQl30P_IO_QMfMY_cZo7YkboXP8SR3M,2121
+xiaozhi_sdk-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xiaozhi_sdk-0.2.0.dist-info/top_level.txt,sha256=nBpue4hU5Ykm5CtYPsAdxSa_yqbtZsIT_gF_EkBaJPM,12
+xiaozhi_sdk-0.2.0.dist-info/RECORD,,

xiaozhi_sdk-0.2.0.dist-info/licenses/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/data.py

@@ -1,58 +0,0 @@
-mcp_initialize_payload = {
-    "jsonrpc": "2.0",
-    "id": 1,
-    "result": {
-        "protocolVersion": "2024-11-05",
-        "capabilities": {"tools": {}},
-        "serverInfo": {"name": "", "version": "0.0.1"},
-    },
-}
-
-mcp_tool_conf = {
-    "get_device_status": {
-        "description": "Provides the real-time information of the device, including the current status of the audio speaker, screen, battery, network, etc.\nUse this tool for: \n1. Answering questions about current condition (e.g. what is the current volume of the audio speaker?)\n2. As the first step to control the device (e.g. turn up / down the volume of the audio speaker, etc.)",
-        "inputSchema": {"type": "object", "properties": {}},
-    },
-    "set_volume": {
-        "description": "Set the volume of the audio speaker. If the current volume is unknown, you must call `self.get_device_status` tool first and then call this tool.",
-        "inputSchema": {
-            "type": "object",
-            "properties": {"volume": {"type": "integer", "minimum": 0, "maximum": 100}},
-            "required": ["volume"],
-        },
-    },
-    "set_brightness": {
-        "description": "Set the brightness of the screen.",
-        "inputSchema": {
-            "type": "object",
-            "properties": {"brightness": {"type": "integer", "minimum": 0, "maximum": 100}},
-            "required": ["brightness"],
-        },
-    },
-    "set_theme": {
-        "description": "Set the theme of the screen. The theme can be `light` or `dark`.",
-        "inputSchema": {"type": "object", "properties": {"theme": {"type": "string"}}, "required": ["theme"]},
-    },
-    "take_photo": {
-        "description": "Take a photo and explain it. Use this tool after the user asks you to see something.\nArgs:\n  `question`: The question that you want to ask about the photo.\nReturn:\n  A JSON object that provides the photo information.",
-        "inputSchema": {
-            "type": "object",
-            "properties": {"question": {"type": "string"}},
-            "required": ["question"],
-        },
-    },
-    "open_tab": {
-        "description": "Open a web page in the browser. 小智后台：https://xiaozhi.me",
-        "inputSchema": {
-            "type": "object",
-            "properties": {"url": {"type": "string"}},
-            "required": ["url"],
-        },
-    },
-}
-
-mcp_tools_payload = {
-    "jsonrpc": "2.0",
-    "id": 2,
-    "result": {"tools": []},
-}

xiaozhi_sdk/utils.py

@@ -1,23 +0,0 @@
-import wave
-
-
-def get_wav_info(file_path):
-    with wave.open(file_path, "rb") as wav_file:
-        return wav_file.getframerate(), wav_file.getnchannels()
-
-def read_audio_file(file_path):
-    """
-    读取音频文件并通过yield返回PCM流
-    
-    Args:
-        file_path (str): 音频文件路径
-        
-    Yields:
-        bytes: PCM音频数据块
-    """
-    with wave.open(file_path, "rb") as wav_file:
-        while True:
-            pcm = wav_file.readframes(960)  # 每次读取960帧（60ms的音频数据）
-            if not pcm:
-                break
-            yield pcm

xiaozhi_sdk-0.1.0.dist-info/METADATA

@@ -1,58 +0,0 @@
-Metadata-Version: 2.4
-Name: xiaozhi-sdk
-Version: 0.1.0
-Summary: A short description of your package
-Home-page: https://github.com/dairoot/xiaozhi-sdk
-Author: dairoot
-Author-email: 623815825@qq.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: numpy
-Requires-Dist: requests>=2.32.1
-Requires-Dist: sounddevice>=0.4.2
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# 小智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/)
-
-一个用于连接和控制小智智能设备的Python SDK，支持实时音频通信、MCP工具集成和设备管理功能。
-
-
-## 📦 安装
-
-```bash
-pip install xiaozhi-sdk
-```
-
-
-## 🚀 快速开始
-
-### 命令行使用
-
-最简单的使用方式是通过命令行连接设备：
-
-```bash
-# 查看帮助信息
-python -m xiaozhi_sdk -h
-
-# 连接设备（需要提供MAC地址）
-python -m xiaozhi_sdk 00:11:22:33:44:55
-```
-
-### 编程使用
-...
-

xiaozhi_sdk-0.1.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-xiaozhi_sdk/__init__.py,sha256=2QA0vIcmJJ3kJdN9U-UKXVJZacYfG0trVztuEskxnVc,5860
-xiaozhi_sdk/__main__.py,sha256=lWMyMrVlTImZK9Kq5mosgwcaGjo3ynpTBstxXHxyz1g,2529
-xiaozhi_sdk/config.py,sha256=q4e_xmYzUB4_E5h-YftsyAhfeBSapwYD-ogx9ps1fIQ,189
-xiaozhi_sdk/data.py,sha256=Hc8dZXt5Cos3wusjsa8210neqgD9kEBC6_FevsB-RGU,2432
-xiaozhi_sdk/iot.py,sha256=Iz3vVSQgWHBNzqe47zjM1zcoNXjluBcD0uHCmEP8l3w,1630
-xiaozhi_sdk/mcp.py,sha256=jmgbGtzJkIRrEJxJxETSm9toJQS3c6D7_FZBWyD9sAk,2752
-xiaozhi_sdk/opus.py,sha256=6FPwttk6_CameFmLMrr9SkG8kq8gcco6hEeasKTqJWo,2322
-xiaozhi_sdk/utils.py,sha256=9hM_PBlprv8Kjq2EL6wQNzqP3Gk67NYnpkOnpaGJ1G0,594
-xiaozhi_sdk-0.1.0.dist-info/METADATA,sha256=mIit7LLw_YQBca3G2zEXMRrjdQ1fNQM0gdBqGbRSbUg,1455
-xiaozhi_sdk-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xiaozhi_sdk-0.1.0.dist-info/top_level.txt,sha256=nBpue4hU5Ykm5CtYPsAdxSa_yqbtZsIT_gF_EkBaJPM,12
-xiaozhi_sdk-0.1.0.dist-info/RECORD,,