微信小程序 JavaScript SDK

更新时间:2024-08-30 07:50:19下载pdf

涂鸦提供一个微信小程序的 JavaScript SDK,包括常用的设备管理、设备控制和 OTA 升级等能力。基于此 SDK,您可以高效地开发出设备管理和设备控制功能。

JavaScript SDK 是以 npm 依赖包的方式提供,不限于技术框架。您可以将其引入到使用原生代码开发的项目中,也可以引入到使用 Ray(已集成)、Taro、uni-app 等跨端框架开发的项目中。

安装

使用 npm 安装。

npm install @ray-js/wechat

或者使用 Yarn 安装。

yarn add @ray-js/wechat

使用

以获取设备信息为例。

  1. 在文件头部引入 getDeviceInfo API。

  2. onLoad 中获取设备信息。

    import { getDeviceInfo } from '@ray-js/wechat';
    
    Page({
        onLoad() {
            getDeviceInfo({deviceId: '123456'}).then(devInfo => {
                    this.setData({devInfo: devInfo});
            })
        }
    })
    
    

能力

此 SDK 提供基础能力、用户管理、家庭管理、设备管理、设备控制和设备 OTA 等能力。

模块 说明
基础能力 主要为一些提供基础能力的 API
用户管理 提供了一些用于维护用户信息的 API,如登录、登出、修改信息等
家庭管理 提供了管理家庭、家庭房间、房间设备关系的 API
设备管理与控制 提供了设备信息的获取、设备数据变化事件的处理、下发指令、OTA 等 API