Skip to content

增加英文README文档 #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

增加英文README文档 #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
570a91c
增加英文README文档
Jul 17, 2025
28a902f
Update README.md
aaronchenzhihe Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
278 changes: 140 additions & 138 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,112 @@
# QuecPython 基于豆包 webRTC 的 AI 聊天机器人

## 目录

- [介绍](#介绍)
- [功能特性](#功能特性)
- [快速开始](#快速开始)
- [先决条件](#先决条件)
- [安装](#安装)
- [运行应用程序](#运行应用程序)
- [目录结构](#目录结构)
- [贡献](#贡献)
- [许可证](#许可证)
- [支持](#支持)

## 介绍

QuecPython 推出了基于豆包 webRTC 的 AI 聊天机器人解决方案。该方案基于火山的 RTC 库，并且只能使用支持 TiktokRTC 功能的固件。

支持该功能的模组型号如下：

| 系列 | 型号 |
| :----- | :----------------------------------------------------------- |
| EC600M | EC600MCN_LE |
| EC800M | EC800MCN_LE、EC800MCN_GB |
| EG810M | EG810MCN_GA_VOLTE |

## 功能特性

- 支持智能体切换。
- 支持音色切换。
- 支持ASR字幕。
- 支持TTS字幕。
- 支持语音中断/打断。
- 支持服务器地址切换。
- 支持语音唤醒。
- 使用 Python 语言，便于二次开发。

## 快速开始

### 先决条件

在开始之前，请确保您具备以下先决条件：

- **硬件：**
- [EC600MCNLE QuecPython 标准开发板](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html)（含天线、Type-C 数据线等）
> - 点击查看开发板的[原理图](https://images.quectel.com/python/2023/05/EC600X_EVB_V3.2-SCH.pdf)和[丝印图](https://images.quectel.com/python/2023/05/EC600X_EVB_V3.2-丝印.pdf)文档。
> - [移远商城购买链接](https://www.quecmall.com/goods-detail/2c90800c916a8eb501918d85528b017b)
- 电脑（Windows 7、Windows 10 或 Windows 11）
- LCD 显示屏
- 型号：ST7789
- 分辨率：240×240
- [移远商城购买链接](https://www.quecmall.com/goods-detail/2c90800b9488359c01951d6700700116)
- 喇叭
- 任意 2-5W 功率的喇叭即可
- [移远商城购买链接](https://www.quecmall.com/goods-detail/2c90800c94028da201948249e9f4012d)

- **软件：**
- QuecPython 模块的 USB 驱动：[QuecPython_USB_Driver_Win10_ASR](https://images.quectel.com/python/2023/04/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)
- 调试工具 [QPYcom](https://images.quectel.com/python/2022/12/QPYcom_V3.6.0.zip)
- QuecPython [固件](https://github.com/QuecPython/AIChatBot-Volcengine-webRTC/releases/download/v1.0.0/EC600MCNLER06A01M08_OCPU_QPY_TEST0213.zip)
- Python 文本编辑器（例如，[VSCode](https://code.visualstudio.com/)、[Pycharm](https://www.jetbrains.com/pycharm/download/)）

### 安装

1. **克隆仓库**：
```bash
git clone https://github.com/QuecPython/AIChatBot-Volcengine-webRTC.git
cd AIChatBot-Volcengine-webRTC
```
# QuecPython AI Chatbot Based on Douyin WebRTC

## Table of Contents

- [Introduction](#Introduction)
- [Features](#Features)
- [Quick_Start](#Quick_Start)
- [Prerequisites](#Prerequisites)
- [Installation](#Installation)
- [Running_ Application](#Running_Application)
- [Directory_Structure](#Directory_Structure)
- [Contributing](#Contributing)
- [License](#License)
- [Support](#Support)

## Introduction

QuecPython introduces an AI chatbot solution based on Douyin WebRTC. This solution utilizes the Volcano RTC library and requires firmware that supports TiktokRTC functionality.

The following module models support this feature:

| Series | Models |
| :----- | :----------------------- |
| EC600M | EC600MCN_LE |
| EC800M | EC800MCN_LE, EC800MCN_GB |
| EG810M | EG810MCN_GA_VOLTE |

## Features

- Supports agent switching.
- Supports voice tone switching.
- Supports ASR subtitles.
- Supports TTS subtitles.
- Supports voice interruption/barge-in.
- Supports server address switching.
- Supports voice wake-up.
- Uses Python for easy secondary development.

## Quick_Start

2. **安装 USB 驱动**
### Prerequisites

3. **烧录固件：**
按照[说明](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6)将固件烧录到开发板上。
Before you begin, ensure you have the following prerequisites:

> 注意：固件内火山对话 token 临时测试使用，随时可能取消，使用体验可以联系移远技术支持。
> 如果自己有火山 token，可以直接通过`tiktok.config`接口配置即可。
- **Hardware:**

### 运行应用程序
- [EC600MCNLE QuecPython Standard Development Board](https://python.quectel.com/doc/Getting_started/zh/evb/ec600x-evb.html) (including antenna, Type-C cable, etc.)

1. **连接硬件：**
按照下图进行硬件连接：
<img src="https://raw.githubusercontent.com/QuecPython/AIChatBot-Volcengine-webRTC/refs/heads/master/docs/zh/media/wire_connection.jpg" style="zoom:67%;" />
1. 将喇叭连接至图中标识有`SPK+`和`SPK-`的排针上。
2. 将 LCD 屏连接至标识有 `LCD` 字样的排针上。
3. 在图示位置插入可用的 Nano SIM 卡。
4. 将天线连接至标识有`LTE`字样的天线连接座上。
5. 使用 Type-C 数据线连接开发板和电脑。
> - View the development board's [schematic](https://images.quectel.com/python/2023/05/EC600X_EVB_V3.2-SCH.pdf) and [silkscreen](https://images.quectel.com/python/2023/05/EC600X_EVB_V3.2-丝印.pdf) documents.
> - [Purchase link on Quectel Mall](https://www.quecmall.com/goods-detail/2c90800c916a8eb501918d85528b017b)

2. **将代码下载到设备：**
- 启动 QPYcom 调试工具。
- 将数据线连接到计算机。
- 按下开发板上的 **PWRKEY** 按钮启动设备。
- 按照[说明](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E8%84%9A%E6%9C%AC)将 `code` 文件夹中的所有文件导入到模块的文件系统中，保留目录结构。
- Computer (Windows 7, Windows 10, or Windows 11)

- LCD Display

- Model: ST7789
- Resolution: 240×240
- [Purchase link on Quectel Mall](https://www.quecmall.com/goods-detail/2c90800b9488359c01951d6700700116)

- Speaker

- Any 2-5W power speaker will suffice
- [Purchase link on Quectel Mall](https://www.quecmall.com/goods-detail/2c90800c94028da201948249e9f4012d)

- **Software:**

- QuecPython module USB driver: [QuecPython_USB_Driver_Win10_ASR](https://images.quectel.com/python/2023/04/Quectel_Windows_USB_DriverA_Customer_V1.1.13.zip)
- Debugging tool [QPYcom](https://images.quectel.com/python/2022/12/QPYcom_V3.6.0.zip)
- QuecPython [firmware](https://github.com/QuecPython/AIChatBot-Volcengine-webRTC/releases/download/v1.0.0/EC600MCNLER06A01M08_OCPU_QPY_TEST0213.zip)
- Python text editor (e.g., [VSCode](https://code.visualstudio.com/), [Pycharm](https://www.jetbrains.com/pycharm/download/))

### Installation

1. **Clone the repository:**

```bash
git clone https://github.com/QuecPython/AIChatBot-Volcengine-webRTC.git
cd AIChatBot-Volcengine-webRTC
```

3. **运行应用程序：**
- 选择 `File` 选项卡。
- 选择 `ai_main.py` 脚本。
- 右键单击并选择 `Run` 或使用`运行`快捷按钮执行脚本。
2. **Install the USB driver.**

3. **Flash the firmware:**
Follow the [instructions](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E5%9B%BA%E4%BB%B6) to flash the firmware onto the development board.

> Note: The Volcano dialogue token in the firmware is for temporary testing and may be revoked at any time. For a better experience, contact Quectel technical support.
> If you have your own Volcano token, you can configure it directly using the `tiktok.config` interface.

### Running_Application

1. **Connect the hardware:**
Follow the diagram below for hardware connections:
<img src="docs/zh/media/wire_connection.jpg" style="zoom:67%;" />
1. Connect the speaker to the pins labeled `SPK+` and `SPK-`.
2. Connect the LCD screen to the pins labeled `LCD`.
3. Insert a usable Nano SIM card in the designated slot.
4. Connect the antenna to the antenna connector labeled `LTE`.
5. Use a Type-C cable to connect the development board to your computer.
2. **Download the code to the device:**
- Launch the QPYcom debugging tool.
- Connect the data cable to the computer.
- Press the **PWRKEY** button on the development board to power on the device.
- Follow the [instructions](https://python.quectel.com/doc/Application_guide/zh/dev-tools/QPYcom/qpycom-dw.html#%E4%B8%8B%E8%BD%BD%E8%84%9A%E6%9C%AC) to import all files from the `code` folder into the module's file system, preserving the directory structure.
3. **Run the application:**
- Select the `File` tab.
- Choose the `ai_main.py` script.
- Right-click and select `Run` or use the `Run` shortcut button to execute the script.
4. **Reference run log:**

4. **参考运行日志：**
```python
import example
>>> example.exec('/usr/ai_main.py')
Expand All @@ -108,72 +115,67 @@ volume: 6
>>> lte network normal
ai task running

# 按KEY1键进入智能体
# Press KEY1 to enter the agent
rtc_queue key event 1
start rtc
TIKTOK_RTC_EVENT_START
TIKTOK_RTC_EVENT_TTS_TEXT 你
TIKTOK_RTC_EVENT_TTS_TEXT 你好
TIKTOK_RTC_EVENT_TTS_TEXT 你好有
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以帮
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以帮到
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以帮到你
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以帮到你的
TIKTOK_RTC_EVENT_TTS_TEXT 你好有什么可以帮到你的吗

# 按KEY2键退出智能体
TIKTOK_RTC_EVENT_TTS_TEXT Hello
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how can
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how can I
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how can I help
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how can I help you
TIKTOK_RTC_EVENT_TTS_TEXT Hello, how can I help you today?

# Press KEY2 to exit the agent
rtc_queue key event 2
stop rtc
```

## 目录结构
## Directory_Structure

```plaintext
solution-AI/
├── code/
│   ├── ai_main.py
│   ├── datetime.py
│   ├── ...
│   └── img/
│      ├── battery/
│      │   ├── bat_00.png
│      │   ├── bat_01.png
│      │   └── ...
│      ├── signal/
│      │   ├── signal_00.png
│      │   ├── signal_01.png
│      │   └── ...
│      ├── image1.png
│      ├── image2.png
│      └── ...
│ ├── ai_main.py
│ ├── datetime.py
│ ├── ...
│ └── img/
│ ├── battery/
│ │ ├── bat_00.png
│ │ ├── bat_01.png
│ │ └── ...
│ ├── signal/
│ │ ├── signal_00.png
│ │ ├── signal_01.png
│ │ └── ...
│ ├── image1.png
│ ├── image2.png
│ └── ...
├── examples/
│   └── examples_ai.py
│ └── examples_ai.py
├── docs/zh/media/
│         └── wire_connection.jpg
│ └── wire_connection.jpg
├── EC600MCNLER06A01M08_OCPU_QPY_TEST0213.zip
├── LICENSE
├── readme.md
└── readme_zh.md
```

## 贡献
## Contributing

我们欢迎对本项目的改进做出贡献！请按照以下步骤进行贡献：
We welcome contributions to improve this project! Follow these steps to contribute:

1. Fork 此仓库。
2. 创建一个新分支（`git checkout -b feature/your-feature`）。
3. 提交您的更改（`git commit -m 'Add your feature'`）。
4. 推送到分支（`git push origin feature/your-feature`）。
5. 打开一个 Pull Request。
1. Fork this repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -m 'Add your feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Open a Pull Request.

## 许可证
## License

本项目使用 Apache 许可证。详细信息请参阅 [LICENSE](LICENSE) 文件。
This project is licensed under the Apache License. See the [LICENSE](https://license/) file for details.

## 支持
## Support

如果您有任何问题或需要支持，请参阅 [QuecPython 文档](https://python.quectel.com/doc) 或在本仓库中打开一个 issue。
If you have any questions or need support, refer to the [QuecPython documentation](https://python.quectel.com/doc) or open an issue in this repository.
Loading