From ecf1a15b9e8972121aba11c1ce03756521c0d864 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=8C=83=E9=B9=8F?= <fanpeng@star-lock.cn>
Date: Tue, 3 Dec 2024 14:35:22 +0800
Subject: [PATCH] feat: init

---
 miniprogram/doc/README.md | 140 ++++++++++++++++++++++++++++++++++++--
 1 file changed, 134 insertions(+), 6 deletions(-)

diff --git a/miniprogram/doc/README.md b/miniprogram/doc/README.md
index 29f4cae..b693e78 100644
--- a/miniprogram/doc/README.md
+++ b/miniprogram/doc/README.md
@@ -1,15 +1,143 @@
-# 插件文档标题
+## 星云SDK
 
-## 二级标题
+```json
+{
+  "plugins": {
+    "starCloud": {
+      "version": "1.0.0",
+      "provider": "wxf2c491f734bbf82f"
+    }
+  }
+}
+```
 
-### 三级标题
+```javascript
+const plugin = requirePlugin('starCloud')
 
-这个文件用于书写插件文档，引用图片时必须以**相对路径**引用 ***doc*** 目录下的本地图片，不能使用网络图片或非 ***doc*** 目录下的图片。以下是相对路径的引用示例：
+/**
+ * 初始化星云
+ * @param params
+ * @param {String} params.clientId 客户端Id
+ * @param {String} params.clientSecret 客户端密码
+ * @param {String} params.env 环境
+ * @param {Boolean} params.isReportLog 是否上报日志
+ */
+plugin.initStarCloud(params)
 
-![链接](./example.jpeg)
+// 注册,后续所有方法调用返回值均为code, data, message
+// code对应报错码有三部分组合构成，锁端报错码+星云服务端报错码+自定义报错码
+// Result类定义了所有自定义报错码，具体报错码请查看Result类
+const { code, data, message } = await plugin.register()
+if (code === Result.Success.code) {
+  // 逻辑代码   
+} else {
+  // 错误处理
+}
 
-使用编辑器下方的上传按钮可以上传插件文档，上传的内容包括 doc 目录下的 README.md 和图片。
+/**
+ * 退出登录
+ * @param params
+ * @param {Number} params.uid 用户ID
+ */
+const { code, data, message } = await plugin.logout(params)
 
+/**
+ * 选择锁
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {Number} params.lockId 锁ID
+ * @returns {Promise<Result>}
+ */
+const { code, data, message } = await plugin.selectLock(params)
 
+/**
+ * 开门
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {String} params.type 开门方式 close: 关门 open: 开门
+ * @param {Boolean} params.disconnect 操作后是否断开连接
+ * @returns {Promise<Result>}
+ */
+const { code, data, message } = await plugin.openDoor(params)
 
+/**
+ * 获取离线密码
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {OfflinePassword} params.password 密码信息
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.getOfflinePassword(params)
 
+/**
+ * 自定义密码
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {CustomPassword} params.password 密码信息
+ * @param {Boolean} params.disconnect 操作后是否断开连接
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.customPassword(params)
+
+/**
+ * 搜索蓝牙设备
+ */
+await plugin.searchDevice(searchDevice)
+const searchDevice = async result => {
+}
+
+/**
+ * 停止搜索
+ */
+await plugin.stopSearchDevice()
+
+/**
+ * 绑定设备
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {String} params.name 设备名称
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.bindDevice(params)
+
+/**
+ * 移除坏锁
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {List[int]} params.lockIds 锁Id列表
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.removeBadLock(params)
+
+/**
+ * 删除锁
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ */
+const data = await plugin.deleteLock(params)
+
+/**
+ * 修改管理员密码
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {String} params.adminPwd 管理员密码
+ * @param {Boolean} params.disconnect 操作后是否断开连接
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.updateAdminPassword(params)
+
+/**
+ * 同步全部开门记录
+ * @param params
+ * @param {AccountInfo} params.accountInfo 账号信息
+ * @param {Boolean} params.disconnect 操作后是否断开连接
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.syncAllOpenRecord(params)
+
+/**
+ * 获取服务器时间
+ * @returns {Promise<Result>}
+ */
+const data = await plugin.getServerTimestamp()
+```