@ray-js/alipay-ap-sdk v1.0.6

支付宝wifi设备配网SDK使用说明

本文介绍了涂鸦 IoT 支付宝小程序AP-SDK，该 SDK 提供了一些UDP及WiFi模块功能性封装，方便支付宝小程序开发者更加快速地连接涂鸦生态中的智能硬件产品。您可以基于该 SDK 快速实现支付宝小程序环境下的wifi设备配网。

AP SDK

该 SDK 基于局域网协议提供高度封装的 API，方便小程序开发者快速实现支付宝小程序环境下WiFi设备配网。

安装SDK

使用npm包管理器下载SDK：

npm install @ray-js/alipay-ap-sdk

API调用

TuyaAPCloud

引入

import {TuyaAPCloud} from '@ray-js/alipay-ap-sdk'

TuyaAPCloud是一个实例对象，该实例维护了下文所提到的涂鸦服务登录、环境确认、wifi信息提交、ap设备配网、停止配网等API。

涂鸦服务登录

TuyaAPCloud.signIn({ticket,clientId})

• 参数说明

• 返回值：成功或错误信息

引入SDK后请在全局入口或首页调用此API作为你的SDK鉴权，客户端在进行接口请求时所必须携带的用户鉴权校验信息将通过临时票据进行校验和处理，我们将在SDK内部维护你的用户鉴权并在请求时主动塞入。

注意：同一个ticket无法二次消费调用。

环境确认

TuyaAPCloud.checkWeappEnv(wifiName)

• 参数说明

• 返回值：成功或错误信息

校验当前小程序是否为支付宝WiFi环境下。

提交家庭信息

TuyaAPCloud.setApGroup(gid)

• 参数说明

• 返回值：成功或错误信息

提交当前需要配网的家庭信息。

注意：家庭管理员唯一，创建homeid的uid为管理员即owner，仅owner有权限进行设备配网。

提交WiFi信息

TuyaAPCloud.submitWifiInfo({ssid, passwd})

• 参数说明

• 返回值：成功或错误信息

当前WiFi环境下的名称和密码将加密后向云端请求公钥作为后续设备配网发包的部分包体。

设备配网

TuyaAPCloud.distribution(wifiName)

• 参数说明

• 返回值：成功或错误信息

再次切换至设备热点后调用进行设备配网，客户端将持续发包并轮训获得配网结果。

停止ap配网

TuyaAPCloud.stopDistribution()

• 返回值：成功卸载

页面卸载时调用，避免socket损耗；停止ap配网，销毁各实例。

TuyaRequest

引入

import {TuyaRequest} from '@ray-js/alipay-ap-sdk'

TuyaRequest是一个请求封装，封装了包括签名、参数和安全处理。

• 调用规则可参考IoT云函数请求文档：https://developer.tuya.com/cn/docs/iot/device-manger?id=K9wj0vb68htna

• 示例：

  const getDeviceDetail = (device_id) => {
    return TuyaRequest({
      data: { 
      	action: 'device.details', 
        params: { device_id }
      }
    });
  };

  注意：若文档中传参携带access_token可传空或不传，SDK已在鉴权时维护。