Appearance
公共模块
说明：本文档包含微信小程序 SDK 的公共数据结构和返回码说明。
Result 方法的统一返回结构
说明：Result 类是所有有返回结果的方法的统一返回结构，以下接口文档的返回只列出 data 中的数据结构。
- 使用方式
javascript
const { Result } = requirePlugin('starCloud')
// Result.Success 中 code=0，message='成功'，data 根据不同方法返回不同数据，默认为 {}
const { code, data, message } = Result.Success
// 常用判断方式
if (code === Result.Success.code) {
// 逻辑代码
} else {
// 错误处理
}- 返回码说明
| code | 变量名 | 描述 |
|---|---|---|
| 0 | Success | 成功 |
| -1 | Fail | 失败 |
| -10 | NotMoreData | 没有更多数据 |
| -20 | NotAvailableBluetooth | 蓝牙尚未打开，请先打开蓝牙 |
| -21 | NotAvailableBluetoothPermission | 小程序蓝牙功能被禁用，请打开小程序蓝牙权限 |
| -22 | NotAvailableWeChatNearbyDevicesPermission | 蓝牙功能需要附近设备权限，请前往设置开启微信的附近设备权限后再试 |
| -23 | NotAvailableWeChatLocationPermission | 蓝牙功能需要定位权限，请前往设置开启微信的定位权限后再试 |
| -24 | NotAvailableWeChatNearbyDevicesEmpty | 蓝牙功能需要定位服务，请前往设置开启定位服务后再试 |
| -25 | NotAvailableWeChatBluetoothPermission | 微信的蓝牙权限被禁用，请前往设置开启微信的蓝牙权限后再试 |
| -30 | DeviceHasBeenReset | 设备已被重置 |
| 251 | ReadyHasPassword | 该密码已存在 |
AccountInfo 账号信息
| 名称 | 类型 | 描述 |
|---|---|---|
| uid | Number | 用户uid |
| username | String | 用户名 |
| password | String | 密码 |
LockInfo 锁信息
| 名称 | 类型 | 描述 |
|---|---|---|
| deviceId | String | 设备 ID |
| serviceId | String | 服务 ID |
| notifyCharacteristicId | String | 通知特征值 ID |
| writeCharacteristicId | String | 写入特征值 ID |
| pwdTimestamp | Number | 密码时间戳（毫秒） |
| featureValue | String | 功能值 |
| featureSettingValue | String | 功能设置值 |
| featureSettingParams | Array<Number> | 功能设置参数 |
| lockUserNo | Number | 锁用户编号 |
| lockId | Number | 锁 ID |
| keyId | Number | 钥匙 ID |
| adminPwd | String | 管理密码 |
| bluetooth | Bluetooth | 蓝牙信息 |
| lockConfig | LockConfig | 锁配置信息 |
Bluetooth 蓝牙信息
| 名称 | 类型 | 描述 |
|---|---|---|
| bluetoothDeviceId | String | 蓝牙设备 ID |
| bluetoothDeviceName | String | 蓝牙设备名称 |
| publicKey | Array<Number> | 公钥 |
| privateKey | Array<Number> | 私钥 |
| signKey | Array<Number> | 签名密钥 |
LockConfig 锁配置信息
| 名称 | 类型 | 描述 |
|---|---|---|
| vendor | String | 厂商 |
| product | Number | 产品号 |
| model | String | 型号 |
| fwVersion | String | 固件版本 |
| hwVersion | String | 硬件版本 |
| serialNum0 | String | 序列号 0 |
| serialNum1 | String | 序列号 1 |
| btDeviceName | String | 蓝牙设备名称 |
| electricQuantity | Number | 电量 |
| electricQuantityStandby | Number | 备用电量 |
| restoreCount | Number | 重置次数 |
| restoreDate | Number | 重置日期（时间戳秒） |
| icPartNo | String | 芯片型号 |
| indate | Number | 入网日期（时间戳秒） |
| mac | String | MAC 地址 |
| timezoneOffset | Number | 时区偏移（秒） |