百宝箱开放平台 ✖️ IoT 设备接入

45 阅读5分钟

本文将为 IoT 厂商介绍如何通过开放平台实现将 IOT 设备与百宝箱智能体进行集成。

说明:

当前 IoT 接入能力处于内测阶段,您可以点击此处发起试用申请,我们将在收到您需求后的 24 小时内,为您开通相关能力。

前置说明

  • 产品受众:IoT 厂商。
  • 适用设备:目前仅支持搭载乐鑫 ESP32 (包含最新的 ESP32 P4)作为主控芯片的设备。

前提条件

在执行下述操作前,请先完成百宝箱智能体应用的创建,并发布至 SDK 渠道,然后开启 IoT 设备以及智能体 SDK授权。应用发布的详细说明,请参见:发布应用

操作步骤

步骤一:设备接入

1. 安装 ESP IDF

ESP IDF(Espressif IoT Development Framework)是乐鑫信息科技为其ESP32、ESP32-S2、ESP32-C3等系列芯片开发的官方物联网(IoT)开发框架。它提供了一个自由且开放源代码的环境,用于开发基于这些芯片的应用程序。关于安装 ESP IDF 的详细说明,请参见:乐鑫科技官方快速入门,要求 IDF v5.4 及以上。

2. 下载 AI 对话 SDK 源码

为了便于厂商伙伴快速实现设备的接入,百宝箱提供 ESP32 设备端源码 baibaoxiang_iot_sdk.zip,其他开发板/硬件可参考调整。

注意

  • components/txp666__otto-emoji-gif-component/src/*.c 里的动画内容为百宝箱官方品牌资源,仅限技术演示目的,三方不可扩大使用范围。
  • 圆形屏 UI 定制可以参考 main/boards/mayi-s3-lcd/mayi_s3_lcd_display.cc 文件中的 MayiS3LCDDisplay 类实现。

说明: 离线源码请点击 📎baibaoxiang_iot_sdk.zip 下载。

3. 配置设备秘钥

为保证设备接入以及使用过程中的数据安全,百宝箱为每个账户都单独配备了唯一的设备秘钥,用于设备的鉴权。请厂商伙伴前往 IoT 后台 获取密钥(如下图),并将其填入到源码 >> main >> ota.h 中,填入方式可参考下方代码示例。

const std::string device_key = "请填入您在 https://www.tbox.cn/open/iot 得到的厂商维度设备密钥"; // 设备密钥

4. 工程配置

  1. 进入源码根目录,设置 esp32s3 为目标芯片,然后运行工程配置工具 menuconfig。命令行如下:
cd baibaoxiang_iot_sdk // 进入 ESP-IDF 项目根目录
idf.py set-target esp32s3 // 选择esp32s3 作为目标芯片
idf.py menuconfig

2. 系统将显示以下菜单,请在菜单中配置具体子项。

其中:

    • Connection Type 设置为 Websocket;
    • Default OTA URL 设置为 https://twebgwnet.tbox.cn/tdoraemonconsole/api/iot/ota

5. 编译并烧录工程

请执行以下命令,编译并烧录工程,烧录完成后,开发板将会复位,主应用开始运营。

idf.py build
idf.py flash

步骤二:设备配网

下文将以蚂蚁公仔(board: mayi-s3-lcd)为例,为开发者介绍终端用户的使用方式。

  1. 设备开机后,按提示用手机链接热点 “Mayi-xxxx”,之后在 WiFi 入网认证页面里输入可用的 WiFi 网络和密码,后续设备将用这个信息自主连网。
  2. 设备重启后,自动连接 1 中配置过的 WiFi。后续可通过唤醒词“蚂蚁蚂蚁”唤醒设备并与其对话。

步骤三: 设备绑定

1. 应用发布

在进行设备接入前,请先完成对话型应用的发布,并完成 SDK 服务下 IOT 设备的授权与启用。若无,请参见:发布应用,完成相关事项。

2. 绑定设备

  1. 开发者登录开放平台
  2. 在开放平台首页,点击左侧导航栏中的 IOT 设备 > 智能体视图,并找到目标智能体,再点击绑定
  3. 在设备绑定面板中,选择绑定方式,并进行设备信息的填入,完成后,点击确定。平台仅允许已完成绑定的设备访问 AI 对话服务。

说明: 当前每位开发者最多仅支持绑定 20 个设备,若需要绑定更多的设备,请与百宝箱取得联系

其中:

    • 上传 Excel 文件: 支持下载百宝箱提供的设备登记模板,完成内容填写后,再将文件上传给百宝箱,适用于批量设备的绑定。
    • 手动录入: 支持单条维护当前设备的信息。

设备绑定所需内容说明如下表。

字段是否必填说明
设备名称自定义设备名称,最多支持输入 20 个字。
MAC 地址指当前设备在当前网络下的唯一标识,通常在设备的说明书或设备本身的包装上体现,且需要满足 xx:xx:xx:xx:xx:xx的格式。

3. 启用设备

完成智能体与设备的绑定后,设备默认处于未启用的状态。开发者可以通过设备开机的方式,激活当前绑定,系统会自动将设备状态变为已启用。此时,将能够过通过 IOT 设备与智能体进行对话。

联系我们

若在使用 IoT 能力过程中有任何问题或者建议,都欢迎您扫描下方二维码加入百宝箱 IoT 能力官方服务群与我们取得联系。