0.2.1-beta • Published 2 months ago
wowoja-js-sdk v0.2.1-beta
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;
}
属性
属性名称 | 数据类型 | 说明 |
---|---|---|
version | String | sdk 版本号 |
PID | String | 产品 id |
productName | String | 产品名称 |
aId | String | 设备唯一标识 |
deviceName | String | 设备名称 |
deviceStatus | Number | 设备状态 |
siteId | String | 场所 id |
siteName | String | 场所名称 |
locId | String | 位置 id |
locName | String | 位置名称 |
locList | locInfo[] | 位置列表 |
userInfo.uid | String | 用户 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进制