xiaozhi-sdk 0.0.2__tar.gz → 0.0.3__tar.gz

{xiaozhi_sdk-0.0.2/xiaozhi_sdk.egg-info → xiaozhi_sdk-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xiaozhi-sdk
-Version: 0.0.2
+Version: 0.0.3
 Summary: 一个用于连接和控制小智智能设备的Python SDK，支持实时音频通信、MCP工具集成和设备管理功能。
 Home-page: https://github.com/dairoot/xiaozhi-sdk
 Author: dairoot
@@ -71,9 +71,12 @@ positional arguments:
   device             你的小智设备的MAC地址 (格式: XX:XX:XX:XX:XX:XX)
 
 options:
-  -h, --help         显示帮助信息并退出
-  --url URL          小智服务 websocket 地址
-  --ota_url OTA_URL  小智 OTA 地址
+  -h, --help                    show this help message and exit
+  --url URL                     服务端websocket地址
+  --ota_url OTA_URL             OTA地址
+  --serial_number SERIAL_NUMBER 设备的序列号
+  --license_key LICENSE_KEY     设备的授权密钥
+
 ```
 
 #### 连接设备（需要提供 MAC 地址）

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/README.md

@@ -39,9 +39,12 @@ positional arguments:
   device             你的小智设备的MAC地址 (格式: XX:XX:XX:XX:XX:XX)
 
 options:
-  -h, --help         显示帮助信息并退出
-  --url URL          小智服务 websocket 地址
-  --ota_url OTA_URL  小智 OTA 地址
+  -h, --help                    show this help message and exit
+  --url URL                     服务端websocket地址
+  --ota_url OTA_URL             OTA地址
+  --serial_number SERIAL_NUMBER 设备的序列号
+  --license_key LICENSE_KEY     设备的授权密钥
+
 ```
 
 #### 连接设备（需要提供 MAC 地址）

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/setup.py

@@ -1,8 +1,19 @@
 import os
+import re
 
 from setuptools import find_packages, setup
 
 
+# 读取版本号
+def get_version():
+    with open(os.path.join("xiaozhi_sdk", "__init__.py"), "r", encoding="utf-8") as f:
+        content = f.read()
+        match = re.search(r'^__version__ = [\'"]([^\'"]*)[\'"]', content, re.M)
+        if match:
+            return match.group(1)
+        raise RuntimeError("Unable to find version string.")
+
+
 # 收集指定目录下的所有文件
 def get_data_files(*directories):
     data_files = []
@@ -18,7 +29,7 @@ def get_data_files(*directories):
 
 setup(
     name="xiaozhi-sdk",  # 包名
-    version="0.0.2",  # 版本号
+    version=get_version(),  # 版本号
     packages=find_packages(),  # 自动发现包
     package_data={
         "xiaozhi_sdk": ["../" + f for f in get_data_files("file")],  # 包含file目录下的所有文件

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/tests/test_iot.py

@@ -16,4 +16,6 @@ async def test_main():
     mac_address = "00:22:44:66:88:00"
     ota = OtaDevice(mac_addr=mac_address, client_id=str(uuid.uuid4()), serial_number=serial_number)
     res = await ota.activate_device()
+    if not res.get("activation"):
+        return
     await ota.check_activate(res["activation"]["challenge"], license_key)

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/xiaozhi_sdk/__init__.py

@@ -1,5 +1,8 @@
+__version__ = "0.0.3"
+
 import asyncio
 import json
+import logging
 import os
 import re
 import uuid
@@ -16,6 +19,8 @@ from xiaozhi_sdk.utils import get_wav_info, read_audio_file, setup_opus
 setup_opus()
 from xiaozhi_sdk.opus import AudioOpus
 
+logger = logging.getLogger("xiaozhi_sdk")
+
 
 class XiaoZhiWebsocket(McpTool):
 
@@ -75,7 +80,7 @@ class XiaoZhiWebsocket(McpTool):
         listen_message = {"session_id": self.session_id, "type": "listen", "state": "start", "mode": "realtime"}
         await self.websocket.send(json.dumps(listen_message))
 
-    async def _activate_iot_device(self, ota_info: Dict[str, Any]) -> None:
+    async def _activate_iot_device(self, license_key: str, ota_info: Dict[str, Any]) -> None:
         """激活IoT设备"""
         if not ota_info.get("activation"):
             return
@@ -88,7 +93,7 @@ class XiaoZhiWebsocket(McpTool):
         await asyncio.sleep(3)
 
         for _ in range(10):
-            if await self.ota.check_activate(challenge):
+            if await self.ota.check_activate(challenge, license_key):
                 break
             await asyncio.sleep(3)
 
@@ -114,20 +119,23 @@ class XiaoZhiWebsocket(McpTool):
 
     async def _handle_websocket_message(self, message: Any) -> None:
         """处理接受到的WebSocket消息"""
+
+        # audio data
         if isinstance(message, bytes):
             pcm_array = await self.audio_opus.opus_to_pcm(message)
             self.output_audio_queue.extend(pcm_array)
-        else:
-            data = json.loads(message)
-            message_type = data["type"]
+            return
 
-            if message_type == "hello":
-                self.hello_received.set()
-                self.session_id = data["session_id"]
-            elif message_type == "mcp":
-                await self.mcp(data)
-            elif self.message_handler_callback:
-                await self.message_handler_callback(data)
+        # json message
+        data = json.loads(message)
+        message_type = data["type"]
+        if message_type == "hello":
+            self.hello_received.set()
+            self.session_id = data["session_id"]
+        elif message_type == "mcp":
+            await self.mcp(data)
+        elif self.message_handler_callback:
+            await self.message_handler_callback(data)
 
     async def _message_handler(self) -> None:
         """消息处理器"""
@@ -144,7 +152,9 @@ class XiaoZhiWebsocket(McpTool):
         """设置MCP工具回调函数"""
         self.tool_func = tool_func
 
-    async def init_connection(self, mac_addr: str, aec: bool = False) -> None:
+    async def init_connection(
+        self, mac_addr: str, aec: bool = False, serial_number: str = "", license_key: str = ""
+    ) -> None:
         """初始化连接"""
         # 校验MAC地址格式 XX:XX:XX:XX:XX:XX
         mac_pattern = r"^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$"
@@ -152,8 +162,14 @@ class XiaoZhiWebsocket(McpTool):
             raise ValueError(f"无效的MAC地址格式: {mac_addr}。正确格式应为 XX:XX:XX:XX:XX:XX")
 
         self.mac_addr = mac_addr.lower()
-        self.ota = OtaDevice(self.mac_addr, self.client_id, self.ota_url)
+
+        self.ota = OtaDevice(self.mac_addr, self.client_id, self.ota_url, serial_number)
         ota_info = await self.ota.activate_device()
+        ws_url = ota_info["websocket"]["url"]
+        self.url = self.url or ws_url
+
+        if "tenclass.net" not in self.url and "xiaozhi.me" not in self.url:
+            logger.warning("[websocket] 检测到非官方服务器，请谨慎使用！当前链接地址: %s", self.url)
 
         headers = {
             "Authorization": "Bearer {}".format(ota_info["websocket"]["token"]),
@@ -161,13 +177,16 @@ class XiaoZhiWebsocket(McpTool):
             "Device-Id": self.mac_addr,
             "Client-Id": self.client_id,
         }
-        self.url = self.url or ota_info["websocket"]["url"]
-        self.websocket = await websockets.connect(uri=self.url, additional_headers=headers)
+        try:
+            self.websocket = await websockets.connect(uri=self.url, additional_headers=headers)
+        except websockets.exceptions.InvalidMessage as e:
+            logger.error("[websocket] 连接失败，请检查网络连接或设备状态。当前链接地址: %s, 错误信息：%s", self.url, e)
+            return
         self.message_handler_task = asyncio.create_task(self._message_handler())
 
         await self._send_hello(aec)
         await self._start_listen()
-        asyncio.create_task(self._activate_iot_device(ota_info))
+        asyncio.create_task(self._activate_iot_device(license_key, ota_info))
         await asyncio.sleep(0.5)
 
     async def send_audio(self, pcm: bytes) -> None:

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/xiaozhi_sdk/__main__.py

@@ -51,16 +51,22 @@ async def play_assistant_audio(audio_queue: deque[bytes]):
 class XiaoZhiClient:
     """小智客户端类"""
 
-    def __init__(self, mac_address: str, url: Optional[str] = None, ota_url: Optional[str] = None):
-        self.mac_address = mac_address
+    def __init__(
+        self,
+        url: Optional[str] = None,
+        ota_url: Optional[str] = None,
+    ):
         self.xiaozhi: Optional[XiaoZhiWebsocket] = None
         self.url = url
         self.ota_url = ota_url
 
-    async def start(self):
+    async def start(self, mac_address: str, serial_number: str = "", license_key: str = ""):
         """启动客户端连接"""
+        self.mac_address = mac_address
         self.xiaozhi = XiaoZhiWebsocket(handle_message, url=self.url, ota_url=self.ota_url)
-        await self.xiaozhi.init_connection(self.mac_address, aec=False)
+        await self.xiaozhi.init_connection(
+            self.mac_address, aec=False, serial_number=serial_number, license_key=license_key
+        )
         asyncio.create_task(play_assistant_audio(self.xiaozhi.output_audio_queue))
 
     def audio_callback(self, indata, frames, time, status):
@@ -83,19 +89,24 @@ class XiaoZhiClient:
 async def main():
     """主函数"""
     parser = argparse.ArgumentParser(description="小智SDK客户端")
-    parser.add_argument("device", help="小智设备的MAC地址 (格式: XX:XX:XX:XX:XX:XX)")
-    parser.add_argument("--url", help="小智服务websocket地址")
-    parser.add_argument("--ota_url", help="小智OTA地址")
+    parser.add_argument("device", help="设备的MAC地址 (格式: XX:XX:XX:XX:XX:XX)")
+    parser.add_argument("--url", help="服务端websocket地址")
+    parser.add_argument("--ota_url", help="OTA地址")
+
+    parser.add_argument("--serial_number", default="", help="设备的序列号")
+    parser.add_argument("--license_key", default="", help="设备的授权密钥")
 
     args = parser.parse_args()
     logger.info("Recording... Press Ctrl+C to stop.")
-
-    client = XiaoZhiClient(args.device, args.url, args.ota_url)
-    await client.start()
+    client = XiaoZhiClient(args.url, args.ota_url)
+    await client.start(args.device, args.serial_number, args.license_key)
 
     with sd.InputStream(callback=client.audio_callback, channels=1, samplerate=16000, blocksize=960):
         await client.process_audio_input()
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        logger.info("Stopping...")

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/xiaozhi_sdk/data.py

@@ -16,7 +16,7 @@ mcp_tool_conf: Dict[str, Dict[str, Any]] = {
         "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.",
+        "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}},

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/xiaozhi_sdk/iot.py

@@ -5,13 +5,13 @@ from typing import Any, Dict, Optional
 
 import aiohttp
 
+from xiaozhi_sdk import __version__
 from xiaozhi_sdk.config import OTA_URL
 
 # 常量定义
-DEFAULT_APPLICATION_VERSION = "1.0.0"
 BOARD_TYPE = "xiaozhi-sdk-box"
-USER_AGENT = "xiaozhi-sdk/{}".format(DEFAULT_APPLICATION_VERSION)
-BOARD_NAME = "xiaozhi-sdk-{}".format(DEFAULT_APPLICATION_VERSION)
+USER_AGENT = "xiaozhi-sdk/{}".format(__version__)
+BOARD_NAME = "xiaozhi-sdk-{}".format(__version__)
 
 
 class OtaDevice:
@@ -46,7 +46,7 @@ class OtaDevice:
         headers["serial-number"] = self.serial_number
 
         payload = {
-            "application": {"version": DEFAULT_APPLICATION_VERSION},
+            "application": {"version": __version__},
             "board": {
                 "type": BOARD_TYPE,
                 "name": BOARD_NAME,
@@ -65,11 +65,7 @@ class OtaDevice:
         hmac_instance = hmac.new(license_key.encode(), challenge.encode(), hashlib.sha256)
         hmac_result = hmac_instance.hexdigest()
 
-        payload = {
-            "serial_number": self.serial_number,
-            "challenge": challenge,
-            "hmac": hmac_result
-        }
+        payload = {"serial_number": self.serial_number, "challenge": challenge, "hmac": hmac_result}
 
         async with aiohttp.ClientSession() as session:
             async with session.post(url, headers=headers, data=json.dumps(payload)) as response:

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3}/xiaozhi_sdk/mcp.py

@@ -51,7 +51,7 @@ class McpTool(object):
         try:
             tool_res, is_error = tool_func(mcp_json["params"]["arguments"])
         except Exception as e:
-            logger.error("tool_func error: %s", e)
+            logger.error("[MCP] tool_func error: %s", e)
             return
 
         if tool_name == "take_photo":
@@ -76,7 +76,7 @@ class McpTool(object):
             pass
 
         elif method == "notifications/cancelled":
-            logger.error("MCP 工具加载失败")
+            logger.error("[MCP] 工具加载失败")
 
         elif method == "tools/list":
             mcp_tools_payload["id"] = payload["id"]
@@ -87,14 +87,16 @@ class McpTool(object):
                     mcp_tool_conf[name]["name"] = name
                     mcp_tools_payload["result"]["tools"].append(mcp_tool_conf[name])
             await self.websocket.send(self.get_mcp_json(mcp_tools_payload))
-            if tool_list:
-                logger.info("MCP 加载成功，当前可用工具列表为：%s", tool_list)
+            logger.info("[MCP] 加载成功，当前可用工具列表为：%s", tool_list)
 
         elif method == "tools/call":
             tool_name = payload["params"]["name"]
             if not self.tool_func.get(tool_name):
-                raise Exception("Tool not found")
+                logger.warning("[MCP] Tool not found: %s", tool_name)
+                return
+
             mcp_res = await self.mcp_tool_call(payload)
             await self.websocket.send(mcp_res)
+            logger.info("[MCP] Tool %s called", tool_name)
         else:
-            logger.warning("unknown method %s: %s", method, payload)
+            logger.warning("[MCP] unknown method %s: %s", method, payload)

{xiaozhi_sdk-0.0.2 → xiaozhi_sdk-0.0.3/xiaozhi_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xiaozhi-sdk
-Version: 0.0.2
+Version: 0.0.3
 Summary: 一个用于连接和控制小智智能设备的Python SDK，支持实时音频通信、MCP工具集成和设备管理功能。
 Home-page: https://github.com/dairoot/xiaozhi-sdk
 Author: dairoot
@@ -71,9 +71,12 @@ positional arguments:
   device             你的小智设备的MAC地址 (格式: XX:XX:XX:XX:XX:XX)
 
 options:
-  -h, --help         显示帮助信息并退出
-  --url URL          小智服务 websocket 地址
-  --ota_url OTA_URL  小智 OTA 地址
+  -h, --help                    show this help message and exit
+  --url URL                     服务端websocket地址
+  --ota_url OTA_URL             OTA地址
+  --serial_number SERIAL_NUMBER 设备的序列号
+  --license_key LICENSE_KEY     设备的授权密钥
+
 ```
 
 #### 连接设备（需要提供 MAC 地址）