ESP-Brookesia Coze Agent
Overview
brookesia_agent_coze is a Coze agent implementation based on the ESP-Brookesia Agent Manager framework, providing:
- Coze API Integration: Real-time communication with the Coze platform via WebSocket, supporting voice conversations and text interactions.
- OAuth2 Authentication: Supports Coze platform's OAuth2 authentication mechanism with automatic access token acquisition and management.
- Multiple Robot Support: Supports configuring multiple robots with dynamic switching of the currently active robot.
- Audio Codec: Built-in audio codec support, defaulting to G711A format with 16kHz sample rate.
- Emote Support: Supports receiving and displaying emote events from the Coze platform.
- Event Handling: Supports listening and handling Coze platform events (such as insufficient credits balance, etc.).
- Persistent Storage: Optionally integrates with
brookesia_service_nvsservice for persistent storage of authentication information and robot configurations.
Table of Contents
How to Use
Development Environment Requirements
Before using this library, please ensure the following SDK development environment is installed:
- ESP-IDF:
>=5.5,<6
Note
For SDK installation instructions, please refer to ESP-IDF Programming Guide - Installation
Adding to Project
brookesia_agent_coze has been uploaded to the Espressif Component Registry. You can add it to your project in the following ways:
-
Using Command Line
Run the following command in your project directory:
idf.py add-dependency "espressif/brookesia_agent_coze" -
Modify Configuration File
Create or modify the idf_component.yml file in your project directory:
dependencies: espressif/brookesia_agent_coze: "*"
For detailed instructions, please refer to Espressif Documentation - IDF Component Manager.