Skip to content

README.zh_CN.md

Latest commit

 

History

History
115 lines (82 loc) · 3.12 KB

README.zh_CN.md

File metadata and controls

115 lines (82 loc) · 3.12 KB
Raw

English | 中文README

OneSDK: 面向端侧提供的统一AI接入SDK

目录

项目介绍

OneSDK是一个面向AI应用的端侧集成开发套件，提供包括大模型语音对话、文本对话、智能体等大模型LLM能力，同时也提供设备管理，支持通过MQTT协议与物联网平台进行交互。SDK基于libwebsockets实现HTTP，Websocket，MQTT等协议，支持在嵌入式平台，如乐鑫ESP32，FreeRTOS，uc-OS2等，也支持在通用平台如Linux、MacOS、Windows等平台上运行。

功能特性

整体架构

alt text

功能清单

  • 设备智能
    • 文本对话：支持大模型文本对话（包含stream和非stream）
    • 图片生成：支持大模型图片识别、文生图
    • 语音对话智能体：支持多种语音对话智能体，集成Realtime实时（WebSocket）API
  • 设备运维
    • OTA升级支持
      • 全包升级
      • 差分包升级
    • 设备管理
      • Token配额：可从云控制台查询当前配额使用情况
    • SSH: 支持控制台ssh链接
    • 日志: 支持设备操作日志上传
  • 设备安全
    • 支持设备端"一机一秘钥"与"一型一秘钥"身份认证
    • 支持设备证书

快速开始

前提条件

CMake版本要求：

  • 最低版本: CMake 3.10
  • 推荐版本: CMake 3.26.x
  • 不兼容版本: CMake 4.x（可能导致cJSON兼容性问题）

详细的CMake安装说明请参考 CMake版本要求。

快速版本检查：

# Linux/macOS
./scripts/check_cmake_version.sh

# Windows PowerShell
.\scripts\check_cmake_version.ps1

支持平台：

  • 乐鑫ESP32
  • RTOS(freertos/uc-OS2)
  • Linux（amd64/arm64)
  • MacOS(apple silicon/intel)
  • Windows (x64/x86)

安装、编译、运行

Linux/MacOS

参考 开发指导

Windows

参考 Windows开发指导 获取详细的Windows环境搭建和构建说明。

Windows快速构建：

# 克隆仓库
git clone --recursive https://github.com/volcengine/onesdk.git
cd onesdk

# 使用Visual Studio构建（推荐）
build.bat

# 或使用MinGW-w64构建
mkdir build
cd build
cmake -G "MinGW Makefiles" ..
mingw32-make

Note: 对于中文商业化客户，建议参考 边缘智能-OneSDK集成说明 构建编译和运行

贡献

请查看Contributing 获取更多细节。

开源协议

本项目采用Apache-2.0 License协议.

Security and privacy

This project takes security seriously. For vulnerability reporting and supported versions, see SECURITY.md