mini_program_gizwits_sdk 2.0.9 → 3.0.0-beta-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/launch.json +19 -0
- package/.vscode/settings.json +3 -0
- package/README.md +93 -39
- package/dist/index.d.ts +6 -0
- package/dist/index.js +18 -12
- package/main.js +15 -0
- package/package.json +9 -5
- package/yarn.lock +0 -4182
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
// 使用 IntelliSense 了解相关属性。
|
|
3
|
+
// 悬停以查看现有属性的描述。
|
|
4
|
+
// 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
|
|
5
|
+
"version": "0.2.0",
|
|
6
|
+
"configurations": [
|
|
7
|
+
{
|
|
8
|
+
"type": "node",
|
|
9
|
+
"request": "launch",
|
|
10
|
+
"name": "Mocha Tests",
|
|
11
|
+
"url": "http://localhost:8080",
|
|
12
|
+
"webRoot": "${workspaceFolder}",
|
|
13
|
+
"skipFiles": [
|
|
14
|
+
"<node_internals>/**"
|
|
15
|
+
],
|
|
16
|
+
"program":"${workspaceFolder}/node_modules/mocha/bin/_mocha -r ts-node/register tests/bleConfig/sdk.ble.spec.ts -file ./tests/setup-wx.js -timeout 60s"
|
|
17
|
+
}
|
|
18
|
+
]
|
|
19
|
+
}
|
package/README.md
CHANGED
|
@@ -1,49 +1,103 @@
|
|
|
1
1
|
<a href='https://coveralls.io/github/gizwits/mini_program_gizwits_sdk?branch=master'><img src='https://coveralls.io/repos/github/gizwits/mini_program_gizwits_sdk/badge.svg?branch=master' alt='Coverage Status' /></a><img alt="npm" src="https://img.shields.io/npm/v/mini_program_gizwits_sdk">[](https://travis-ci.org/gizwits/mini_program_gizwits_sdk)
|
|
2
2
|
|
|
3
|
-
#
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
### 使用方法
|
|
10
|
-
|
|
11
|
-
```javascript
|
|
12
|
-
import GizwitsSdk, { errorCode } from 'mini_program_gizwits_sdk';
|
|
13
|
-
|
|
14
|
-
const sdk = new GizwitsSdk({
|
|
15
|
-
appID: '8f187b1deb9e44b6aa1374b8f13bccb1',
|
|
16
|
-
appSecret: 'd73fa6d6d7c04d37b6b2cc13a18a9f37',
|
|
17
|
-
specialProductKeys: ['00e7e327afa74a3d8ff1cc190bad78c0'],
|
|
18
|
-
specialProductKeySecrets: ['aa3d301fa291466fbed20e4204609abc'],
|
|
19
|
-
token: token,
|
|
20
|
-
uid: uid,
|
|
21
|
-
cloudServiceInfo: null,
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
try {
|
|
25
|
-
const data = await sdk.setDeviceOnboardingDeploy({
|
|
26
|
-
ssid: SSID,
|
|
27
|
-
password: password,
|
|
28
|
-
timeout: 60,
|
|
29
|
-
softAPSSIDPrefix: 'XPG-GAgent-',
|
|
30
|
-
});
|
|
31
|
-
} catch (error) {
|
|
32
|
-
console.log(error)
|
|
33
|
-
}
|
|
3
|
+
# 机智云小程序 SDK
|
|
4
|
+
|
|
5
|
+
## 🔧 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
yarn add mini_program_gizwits_sdk
|
|
34
9
|
```
|
|
35
10
|
|
|
36
|
-
|
|
11
|
+
## 🏍 初始化 Sdk
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import GizwitsSdk from 'mini_program_gizwits_sdk';
|
|
15
|
+
import { Component } from 'react';
|
|
16
|
+
import { View } from '@tarojs/components';
|
|
37
17
|
|
|
38
|
-
|
|
18
|
+
export default class Index extends Component {
|
|
19
|
+
private gizSdk: GizwitsSdk;
|
|
39
20
|
|
|
40
|
-
|
|
41
|
-
{
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
21
|
+
componentDidMount() {
|
|
22
|
+
this.gizSdk = new GizwitsSdk({
|
|
23
|
+
appID: 'appID',
|
|
24
|
+
appSecret: 'appSecret',
|
|
25
|
+
productInfo: [
|
|
26
|
+
{
|
|
27
|
+
productKey: 'productKey',
|
|
28
|
+
productSecrets: 'productSecrets',
|
|
29
|
+
},
|
|
30
|
+
],
|
|
31
|
+
uid: 'giz_uid',// 必填
|
|
32
|
+
token: 'giz_token', // 必填
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
render() {
|
|
37
|
+
return <View>hello</View>;
|
|
46
38
|
}
|
|
47
39
|
}
|
|
48
40
|
```
|
|
49
41
|
|
|
42
|
+
## 📖 API
|
|
43
|
+
|
|
44
|
+
### sdk.initBle()
|
|
45
|
+
|
|
46
|
+
初始化 sdk 蓝牙能力。
|
|
47
|
+
|
|
48
|
+
### sdk.addEventListener(type:K,func:TListenerType[K])
|
|
49
|
+
|
|
50
|
+
注册事件监听。事件种类见下表。
|
|
51
|
+
| 事件种类 type | 回调参数类型 | 回调参数描述 |
|
|
52
|
+
| ---------- | ------ | ------------------ |
|
|
53
|
+
| "OnScanListChange" | IDevice[] | 扫描设备列表 |
|
|
54
|
+
| "TDeviceStatusNotifications" | IDeviceStatusNoti | 设备状态变更通知 |
|
|
55
|
+
| "TDeviceAttrsNotifications" | IDeviceAttrsNoti | 设备数据点变更通知 |
|
|
56
|
+
| "OnBleHandleError" | IError | ble 错误通知 |
|
|
57
|
+
|
|
58
|
+
### sdk.removeEventListener(type:K,func:TListenerType[K])
|
|
59
|
+
销毁事件监听。
|
|
60
|
+
|
|
61
|
+
### sdk.scanBleDevice(delay:number)
|
|
62
|
+
|
|
63
|
+
搜索蓝牙设备。搜索到的蓝牙设备会被`OnScanListChange`监听。
|
|
64
|
+
|
|
65
|
+
#### 参数
|
|
66
|
+
|
|
67
|
+
- delay: 超时时间。
|
|
68
|
+
|
|
69
|
+
### sdk.deviceSafetyRegister(Object object)
|
|
70
|
+
|
|
71
|
+
安全注册目标设备，否则无法发起设备绑定。返回值中可以拿到注册结果。
|
|
72
|
+
|
|
73
|
+
#### 参数
|
|
74
|
+
|
|
75
|
+
- Object object
|
|
76
|
+
|
|
77
|
+
| 属性 | 类型 | 描述 |
|
|
78
|
+
| ---------- | ------ | ------------------ |
|
|
79
|
+
| mac | string | 待注册设备 mac |
|
|
80
|
+
| productKey | string | 待注册设备所属产品 |
|
|
81
|
+
|
|
82
|
+
### sdk.bindRemoteDevice(Object object)
|
|
83
|
+
|
|
84
|
+
绑定远程设备，否则无法发起设备订阅。返回值中可以拿到绑定结果。
|
|
85
|
+
|
|
86
|
+
#### 参数
|
|
87
|
+
|
|
88
|
+
- Object object
|
|
89
|
+
|
|
90
|
+
| 属性 | 类型 | 描述 |
|
|
91
|
+
| ---------- | ------ | ------------------ |
|
|
92
|
+
| mac | string | 待绑定设备 mac |
|
|
93
|
+
| productKey | string | 待绑定设备所属产品 |
|
|
94
|
+
|
|
95
|
+
### sdk.subscribe(device:IDevice)
|
|
96
|
+
|
|
97
|
+
订阅目标设备，订阅成功后可控制设备。返回值中可以拿到订阅结果。
|
|
98
|
+
### sdk.write(cmd:{[key]:value})
|
|
99
|
+
控制设备。 其中`key`为数据点名称，value为数据点的值。
|
|
100
|
+
|
|
101
|
+
### sdk.unSubscribe(device:IDevice)
|
|
102
|
+
|
|
103
|
+
取消订阅目标设备。蓝牙设备会断开连接。返回值中可拿到取消订阅结果。
|