PY-XIAOZHI

Appearance

配置说明 ​

项目基础配置 ​

配置文件说明 ​

项目使用两种配置方式：初始配置模板和运行时配置文件。

  1. 初始配置模板

    • 位置：/src/utils/config_manager.py
    • 作用：提供默认配置模板，首次运行时会自动生成配置文件
    • 使用场景：首次运行或需要重置配置时修改此文件

  2. 运行时配置文件

    • 位置：/config/config.json
    • 作用：存储实际运行时的配置信息
    • 使用场景：日常使用时修改此文件

配置项说明 ​

  • 需要什么加什么配置通过config_manager去获取就行了，参考websocket或iot\things\temperature_sensor.py
  • 例如获取 "MQTT_INFO"的"endpoint" , 通过这样 config.get_config("SYSTEM_OPTIONS.NETWORK.MQTT_INFO.endpoint")就能拿到endpoint
json
{
  "SYSTEM_OPTIONS": {
    "CLIENT_ID": "",  // 自动生成的客户端ID
    "DEVICE_ID": "",                     // 设备MAC地址
    "NETWORK": {
      "OTA_VERSION_URL": "https://api.tenclass.net/xiaozhi/ota/",  // OTA更新地址
      "WEBSOCKET_URL": "ws://192.168.31.232:8000/xiaozhi/v1/",     // WebSocket服务器地址
      "WEBSOCKET_ACCESS_TOKEN": "test-token",                      // 访问令牌
      "MQTT_INFO": {
        "endpoint": "",                             // MQTT服务器地址
        "client_id": "",               // MQTT客户端ID
        "username": "", // MQTT用户名
        "password": "",                // MQTT密码
        "publish_topic": "",                          // 发布主题
        "subscribe_topic": ""             // 订阅主题
      }
    }
  },
  "WAKE_WORD_OPTIONS": {
    "USE_WAKE_WORD": false,                                // 是否启用语音唤醒
    "MODEL_PATH": "models/vosk-model-small-cn-0.22",       // 唤醒模型路径
    "WAKE_WORDS": [                                         // 唤醒词列表
      "小智",
      "小美"
    ]
  },
  "TEMPERATURE_SENSOR_MQTT_INFO": {
    "endpoint": "你的Mqtt连接地址",                          // MQTT服务器地址
    "port": 1883,                                          // MQTT服务器端口
    "username": "admin",                                   // MQTT用户名
    "password": "123456",                                  // MQTT密码
    "publish_topic": "sensors/temperature/command",        // 发布主题
    "subscribe_topic": "sensors/temperature/device_001/state" // 订阅主题
  },
  "CAMERA": {
    "camera_index": 0,                                     // 摄像头索引
    "frame_width": 640,                                    // 画面宽度
    "frame_height": 480,                                   // 画面高度
    "fps": 30,                                             // 帧率
    "Loacl_VL_url": "https://open.bigmodel.cn/api/paas/v4/", // 智普API地址
    "VLapi_key": "你自己的key",                              // 智普视觉大模型API密钥
    "models": "glm-4v-plus"                                // 使用的视觉模型
  }
}

配置修改指南 ​

  1. 首次使用配置

    • 直接运行程序，系统会自动生成默认配置文件
    • 如需修改默认值，可编辑 config_manager.py 中的 DEFAULT_CONFIG

  2. 更换服务器配置

    • 打开 /config/config.json
    • 修改 SYSTEM_OPTIONS.NETWORK.WEBSOCKET_URL 为新的服务器地址
    • 示例：
      json
      "SYSTEM_OPTIONS": {
  "NETWORK": {
    "WEBSOCKET_URL": "ws://你的服务器地址:端口号/"
  }
}

  3. 启用语音唤醒

    • 修改 WAKE_WORD_OPTIONS.USE_WAKE_WORD 为 true
    • 可在 WAKE_WORD_OPTIONS.WAKE_WORDS 数组中添加或修改唤醒词

  4. 配置摄像头与视觉识别

    • 修改 CAMERA 部分的相关配置
    • 将 VLapi_key 设置为你从智普AI平台获取的API密钥
    • 可以根据需要调整分辨率和帧率

注意事项 ​

  • 修改配置文件后需要重启程序才能生效
  • WebSocket URL 必须以 ws:// 或 wss:// 开头
  • 首次运行时会自动生成 CLIENT_ID，建议不要手动修改
  • DEVICE_ID 默认使用设备MAC地址，可按需修改
  • 配置文件使用 UTF-8 编码，请使用支持 UTF-8 的编辑器修改
  • 请妥善保管API密钥等敏感信息