ESPHome 语音助手唤醒词项目启动与配置教程

1. 项目的目录结构及介绍

本项目是基于ESPHome框架的语音助手唤醒词项目，其目录结构如下：

wake-word-voice-assistants/
├── examples/             # 示例项目目录，包含不同语音助手的配置示例
├── integrations/         # 集成目录，包含各种语音助手的集成代码
├── tests/                # 测试目录，用于存放单元测试代码
├── docs/                 # 文档目录，存放项目文档
├── src/                  # 源代码目录，包含项目的核心代码
│   ├── main.cpp          # 主程序文件
│   ├── config.h          # 配置头文件
│   ├── secrets.h         # 存放敏感信息的头文件
│   └── ...
├── .gitignore            # 指定git应该忽略的文件
├── CMakeLists.txt        # CMake构建文件
├── README.md             # 项目说明文件
└── ...

• examples/：包含了一些配置示例，可以参考这些示例来设置自己的项目。
• integrations/：包含了与不同语音助手集成的代码，例如Google Assistant、Amazon Alexa等。
• tests/：用于存放项目的单元测试代码，以确保代码的稳定性和可靠性。
• docs/：存放项目文档，包括用户指南、开发文档等。
• src/：项目的核心代码存放位置，包含了主程序文件、配置文件等。
• .gitignore：指定了在版本控制中应该忽略的文件，比如编译产生的临时文件等。
• CMakeLists.txt：用于配置CMake构建系统，管理编译过程。
• README.md：项目的说明文件，介绍了项目的相关信息。

2. 项目的启动文件介绍

项目的启动文件位于src/main.cpp。这个文件包含了程序的入口点，通常包含了以下内容：

• 包含必要的头文件。
• 初始化硬件和软件组件。
• 设置网络连接。
• 配置语音助手识别唤醒词。
• 进入主循环，等待用户输入或唤醒词触发。

#include "config.h"
#include "secrets.h"
#include <ESPHome.h>

void setup() {
  // 初始化硬件和软件组件
  // ...
}

void loop() {
  // 主循环
  // ...
}

3. 项目的配置文件介绍

项目的配置文件包括config.h和secrets.h。

• config.h：这个文件包含了项目的基本配置，如硬件设置、网络配置等。开发者可以根据自己的需求来修改这些配置。

#define WIFI_SSID "your_SSID"
#define WIFI_PASSWORD "your_PASSWORD"
#define MY_IP_ADDRESS "192.168.1.100"
// 其他配置...

• secrets.h：这个文件用于存放敏感信息，如API密钥、认证令牌等。由于这些信息敏感，因此不应该在版本控制中公开。

#define API_KEY "your_API_KEY"
#define AUTH_TOKEN "your_AUTH_TOKEN"
// 其他敏感信息...

确保在开始项目之前正确配置这些文件，以保证项目能够顺利运行。