KeenPlus

03. 设备 API 速查

常用接口目录与调用注意事项

文档加载失败

请确认文档文件存在。

函数调用关系(给 AI/开发者)

以下为常用 API 调用链模板,建议在生成代码时一并带上。

ui.show_screen

core

调用链:ui.set_theme → ui.render → ui.bind_events

标签:ui / navigation

说明:页面切换前应先设置主题与状态,最后再绑定交互事件。

audio.play

core

调用链:audio.set_output → audio.decode → audio.start

标签:audio / latency

说明:建议在低电量时降级码率,并记录首帧时延。

audio.record.start

recommended

调用链:mic.request_permission → audio.record.init → audio.record.flush_chunk

标签:audio / recorder

说明:录音应按块落盘,异常退出时保证已录数据可恢复。

net.request

core

调用链:net.connect → net.set_timeout → net.read → net.retry_if_needed

标签:network / retry

说明:失败路径必须包含超时与指数退避重试。

storage.write_file

recommended

调用链:storage.ensure_dir → storage.open → storage.write_chunk → storage.flush

标签:storage / file

说明:大文件建议分块写入,避免阻塞 UI。

AI 任务模板(可直接喂给模型)

复制模板并补充你的业务参数,可提升一次生成成功率。

录音 -> 转写 -> 上传

目标:实现设备端录音、上传到云端并返回转写结果。

带入 AI Studio

上下文

  • 目标芯片:ESP32-S3 / BK7258
  • 语言:MicroPython
  • 网络波动场景需要可恢复

实现步骤

  1. 初始化录音模块并申请麦克风权限
  2. 按 chunk 写入本地文件并计算时长
  3. 网络可用时上传并携带校验信息
  4. 收到转写结果后更新 UI 与本地缓存

验收标准

  • 10 分钟录音无崩溃
  • 上传失败可重试且不丢文件
  • 转写结果可追溯到录音片段
音频播放离线降级

目标:在线流媒体失败时自动切换本地缓存或低码率源。

带入 AI Studio

上下文

  • 目标芯片:ESP32-S3 / P4
  • 场景:弱网、间歇断网

实现步骤

  1. 播放前检测网络状态与缓存命中
  2. 在线请求失败后触发 fallback
  3. 统一上报播放来源与首帧时延

验收标准

  • 网络波动下连续播放不中断
  • 首帧时延可观测
  • 回退路径无卡死
提交审核前自检

目标:让应用满足后台审核要求并减少驳回。

带入 AI Studio

上下文

  • 目标:应用市场上架
  • 状态流转:draft -> pending -> approved

实现步骤

  1. 补齐 title/description/version/change_notes
  2. 执行核心路径回归与异常测试
  3. 准备审核说明与已知限制

验收标准

  • 无阻断级 bug
  • 文档与版本一致
  • 一次审核通过率提升