0.2.1-beta • Published 2 months ago

wowoja-js-sdk v0.2.1-beta

Weekly downloads
-
License
ISC
Repository
-
Last release
2 months ago

wowoja 小程序 js-SDK

本项目为 wowoja 小程序的 panel 主框架页面的 js-SDK,为设备控制(panle)页面提供设备控制的通信方法、接收设备数据方法等

本项目采用typescript + axios框架编写项目代码

项目目录

    ├─.gitignore
    ├─.npmignore
    ├─ErrorEnum.ts
    ├─eventBus.ts
    ├─EventTypes.ts
    ├─index.d.ts
    ├─index.js
    ├─index.ts
    ├─package.json
    ├─README.md
    ├─style.css
    ├─tips.ts
    ├─tsconfig.json
    ├─util.ts
    ├─webpack.config.js
    ├─websocket.ts
    ├─wxJSBridge.js // 微信js,提供小程序的部分api
    ├─yarn.lock
    ├─API // 后台接口API
    |  ├─device.ts
    |  ├─http.ts
    |  ├─index.ts
    |  ├─location.ts
    |  ├─scene.ts
    |  ├─site.ts
    |  └user.ts

Install

安装项目依赖

Using npm:

npm install <package name>

Using yarn:

yarn add <package name>

API

数据结构

locInfo

interface locInfo {
  createTime?: string;
  id: string;
  name: string;
  updateTime?: null | string;
}

MSG

interface Msg {
  rsl: string;
  msgType: string;
  data: any;
  dataType: "string";
  from: string;
}

属性

属性名称数据类型说明
versionStringsdk 版本号
PIDString产品 id
productNameString产品名称
aIdString设备唯一标识
deviceNameString设备名称
deviceStatusNumber设备状态
siteIdString场所 id
siteNameString场所名称
locIdString位置 id
locNameString位置名称
locListlocInfo[]位置列表
userInfo.uidString用户 id

方法

goToDeviceDetailPage() => void

跳转设备详情页面

goToLocationList() => void

跳转当前场所的位置管理页面

goBack() => void

返回上一页

aId2Sel(aId: string) => string

aId转换成SEl格式,<mac>_SE<n>转换成@SE<n>.<mac>

sendMessage(msg: MSG, timeout = 1e4) => void

发送指令至设备端

onAeMessage(msgKey: string, callback: (...arg: any[]) => void) => void

接收websocket消息

onAeDestroy() => void

取消websocket消息接收事件

dec2Hex(dec: number) => string

10进制数字转16进制小端序字符串

strToHex(str: string) => string

字符串转16进制

0.2.1-beta

2 months ago

0.2.0

7 months ago

0.1.0

12 months ago