客户端配置
797字约3分钟
2024-11-7
配置项可以告诉 ESP-AI 硬件库如何运行，比如：wifi 账号密码、服务端地址、唤醒方式、麦克风扬声器引脚、音量大小等。
debug 调试模式
调试模式会输出更多日志信息,方便开发调试。
使用案例
bool debug = true;
esp_ai.begin({ debug });WiFi配置 ESP_AI_wifi_config
配置WiFi连接参数。当 wifi_name、wifi_pwd 设置为空字符串时，会自动启动配网服务
连接设备热点后，打开 192.168.4.1 即可打开配网页面。
这个网页在串口也会输出。你也可以使用 onAPInfo 实例方法来监听到这个配网地址。
使用案例
ESP_AI_wifi_config wifi_config = {
.wifi_name = "MyWiFi",
.wifi_pwd = "12345678",
.ap_name = "ESP-AI"
};
// 自定义配网页面(可选)
char html_str[] = "<html><body>配网页面</body></html>";
wifi_config.html_str = html_str;
esp_ai.begin({ debug, wifi_config });自定义配网页面
可以参考仓库代码 client\esp-ai\src\webServer\index.html。
配网时可以可以将wifi信息和一些其他业务数据一并存入硬件中。只需要将自定义字段提交到接口接口。目前支持自定义存储五个业务字段，
分别是：ext1 | ext2 | ext3 | ext4 | ext5 | ext6| ext7, 存储起来后你可以使用 getLocalData("ext1") 这种方式来获取某一个值。
ESP-AI 怎么存储这些数据并不是你需要关心的，你只需要在配网页面将这些数据传给 ESP-AI 配网服务提供的接口即可。
服务器配置 ESP_AI_server_config
配置服务器连接参数。可不设置，只需要在配网页面的 api_key 中输入开放平台的超体 api_key 即可自动完成服务对接。
注意： protocol 为 https 时，必须设置 443 或者您的 https 服务端口
.params 参数的用途：如果你私有化部署了服务，连接你服务需要参数时，可以用 params 传递，服务端使用 auth 接收。
使用案例
ESP_AI_server_config server_config = {
.protocol = "http"
.ip = "192.168.1.100",
.port = 8080,
.params = "key1=value1&key2=value2",
.path = "/api/v1"
};
esp_ai.begin({ debug, server_config });唤醒配置 ESP_AI_wake_up_config
配置设备的唤醒方式。这个配置是必须手动配置的。
使用案例
ESP_AI_wake_up_config wake_up_config = {};
// 方式1: 语音唤醒(天问模块)
strcpy(wake_up_config.wake_up_scheme, "asrpro");
strcpy(wake_up_config.str, "你好小明");
// 方式2: 引脚唤醒
strcpy(wake_up_config.wake_up_scheme, "pin_high");
wake_up_config.pin = 10;
// 方式3: 串口唤醒
strcpy(wake_up_config.wake_up_scheme, "serial");
strcpy(wake_up_config.str, "start");
esp_ai.begin({ debug, wake_up_config });麦克风配置[可选] ESP_AI_i2s_config_mic
配置麦克风的I2S接口引脚。
使用案例
ESP_AI_i2s_config_mic i2s_config_mic = {
.bck_io_num = 4, // BCK引脚
.ws_io_num = 5, // WS引脚
.data_in_num = 6 // DATA输入引脚
};
esp_ai.begin({ debug, i2s_config_mic });扬声器配置[可选] ESP_AI_i2s_config_speaker
配置扬声器的I2S接口引脚和采样率。
使用案例
ESP_AI_i2s_config_speaker i2s_config_speaker = {
.bck_io_num = 16, // BCK引脚
.ws_io_num = 17, // WS引脚
.data_in_num = 15, // DATA输入引脚
.sample_rate = 16000 // 采样率
};
esp_ai.begin({ debug, i2s_config_speaker });音量配置[可选] ESP_AI_volume_config
配置音量控制相关参数。把电位器接好线，然后设置引脚即可完成音量控制。
使用案例
// 默认配置如下，无特殊情况不建议更改
ESP_AI_volume_config volume_config = {
.input_pin = 7, // 输入引脚， 默认 7
.max_val = 4096, // 最大输出值
.volume = 0.5, // 默认音量
.enable = true // 启用电位器
};
esp_ai.begin({ debug, volume_config });