sky/starcloud-sdk-uniapp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat:更新1.0.7版本：增加uni文档说明、补充遗漏的人脸列表接口

Browse Source
This commit is contained in:
liyi 2025-03-10 14:51:39 +08:00
parent 76685ee6c9
commit f98df41071
4 changed files with 167 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
env.js
View File

@ -1,7 +1,7 @@
// uni版本号
export const uniVersion = '1.0.6'
export const uniVersion = '1.0.7'
// uni构建号
export const uniBuildNumber = 7
export const uniBuildNumber = 8
// web版本号
export const webVersion = '1.0.1'

13
star-cloud/generalExtend.js
View File

@ -9,7 +9,7 @@ import {
checkRepeatPalmVeinName,
checkRepeatRemoteName,
clearAllIcCard,
deleteIcCardRequest,
deleteIcCardRequest, getFaceListRequest,
getFingerprintListRequest,
getIcCardListRequest, getPalmVeinListRequest, getRemoteListRequest,
updateIcCardRequest
@ -535,4 +535,15 @@ export async function getPalmVeinList(params) {
*/
export async function getRemoteList(params) {
return await getRemoteListRequest(params)
}
/**
* 获取人脸列表
* @param params.lockId 锁id （必填）
* @param params.pageNo 页码（选填）
* @param params.pageSize 每页显示数（选填）
* @returns {Promise<unknown>}
*/
export async function getFaceList(params) {
return await getFaceListRequest(params)
}

176
uni.md
View File

@ -689,32 +689,47 @@ registerExtendedProducts(params)
**入参**
| 参数名称 | 数据类型 | 必须 | 描述 | 说明 |
|-------------------|---------------|----|----------|-----------------------------------------------------------------------------------------------------------------|
| type | String | Y | 功能类型 | ['card','fingerprint','face','remote','palmVein'] |
| keyId | String | Y | 钥匙 ID |
| uid | String | Y | 用户uid |
| userCountLimit | Number | Y | 使用次数限制 | 0xFFFF 表示不限次数 |
| operate | Number | Y | 操作类型 | 0: 注册, 1: 修改, 2: 删除, 3: 删除全部 |
| isAdmin | Number | Y | 是否管理员 | 1 表示是，0 表示否 |
| isForce | Number | Y | 是否胁迫 | 1 表示是，0 表示否 |
| isRound | Number | Y | 是否循环 | 1 表示是，0 表示否 |
| weekDays | Array<Number> | N | 循环周期 | 0 -- 6 置位分别代表周日 -- 周六；例如：循环星期一、星期二、星期四,对应为：[1，2，4] |
| startDate | Number | Y | 生效日期 | 时间戳，永久则填0 |
| endDate | Number | Y | 失效日期 | 时间戳，永久则填0 |
| startTime | String | N | 生效时间 | 例如：'00:00' |
| endTime | String | N | 失效时间 | 例如：'00:00' |
| cardId | Number | N | 卡片Id | 添加后由监听事件返回，仅当 type 为 'card' 且operate!=1 时需要 |
| cardNumber | Number | N | 卡片序号 | 仅当 type 为 'card' 时需要 |
| cardName | String | N | 卡片名称 | 仅当 type 为 'card' 时需要 |
| cardType | Number | N | 卡片类型 | 仅当 type 为 'card' 时需要，1:永久，2：期限，4:循环， |
| cardUserNo | Number | N | 卡UserNo | 仅当 type 为 'card' 时需要 （选填） |
| fingerprintId | Number | N | 指纹Id | 添加后由监听事件返回，仅当 type 为 'fingerprint' 且operate!=1 时需要 |
| fingerprintName | String | N | 指纹序号 | 仅当 type 为 'fingerprint' 时需要 |
| fingerprintNumber | Number | N | 指纹名称 | 仅当 type 为 'fingerprint' 时需要 |
| fingerprintType | Number | N | 指纹类型 | 仅当 type 为 'fingerprint' 时需要，1:永久，2：期限，3：单次，4:循环 |
| fingerprintUserNo | Number | N | 指纹UserNo | 仅当 type 为 'fingerprint' 时需要 （选填） |
| deleteType | Number | N | 删除方式 | 仅当 type 为 'fingerprint' 时需要 1:通过APP走蓝牙删除，必需先通过APP蓝牙删除后再调用该接口,2:通过网关或WiFi锁删除，如果是WiFi锁或有连接网关，则可以传2，直接调用该接口从锁里删除指纹 |
| 参数名称 | 数据类型 | 必须 | 描述 | 说明 |
|-------------------|---------------|----|-----------|-----------------------------------------------------------------------------------------------------------------|
| type | String | Y | 功能类型 | ['card','fingerprint','face','remote','palmVein']其中一个 |
| keyId | String | Y | 钥匙 ID |
| uid | String | Y | 用户uid |
| userCountLimit | Number | Y | 使用次数限制 | 0xFFFF 表示不限次数 |
| operate | Number | Y | 操作类型 | 0: 注册, 1: 修改, 2: 删除, 3: 删除全部 |
| isAdmin | Number | Y | 是否管理员 | 1 表示是，0 表示否 |
| isForce | Number | Y | 是否胁迫 | 1 表示是，0 表示否 |
| isRound | Number | Y | 是否循环 | 1 表示是，0 表示否 |
| weekDays | Array<Number> | N | 循环周期 | 0 -- 6 置位分别代表周日 -- 周六；例如：循环星期一、星期二、星期四,对应为：[1，2，4] |
| startDate | Number | Y | 生效日期 | 时间戳，永久则填0 |
| endDate | Number | Y | 失效日期 | 时间戳，永久则填0 |
| startTime | String | N | 生效时间 | 例如：'00:00' |
| endTime | String | N | 失效时间 | 例如：'00:00' |
| cardId | Number | N | 卡片Id | 添加后由监听事件返回，仅当 type 为 'card' 且operate!=1 时需要 |
| cardNumber | Number | N | 卡片序号 | 仅当 type 为 'card' 时需要 |
| cardName | String | N | 卡片名称 | 仅当 type 为 'card' 时需要 |
| cardType | Number | N | 卡片类型 | 仅当 type 为 'card' 时需要，1:永久，2：期限，4:循环， |
| cardUserNo | Number | N | 卡UserNo | 仅当 type 为 'card' 时需要 （选填） |
| fingerprintId | Number | N | 指纹Id | 添加后由监听事件返回，仅当 type 为 'fingerprint' 且operate!=1 时需要 |
| fingerprintName | String | N | 指纹序号 | 仅当 type 为 'fingerprint' 时需要 |
| fingerprintNumber | Number | N | 指纹名称 | 仅当 type 为 'fingerprint' 时需要 |
| fingerprintType | Number | N | 指纹类型 | 仅当 type 为 'fingerprint' 时需要，1:永久，2：期限，3：单次，4:循环 |
| fingerprintUserNo | Number | N | 指纹UserNo | 仅当 type 为 'fingerprint' 时需要 （选填） |
| deleteType | Number | N | 删除方式 | 仅当 type 为 'fingerprint' 时需要 1:通过APP走蓝牙删除，必需先通过APP蓝牙删除后再调用该接口,2:通过网关或WiFi锁删除，如果是WiFi锁或有连接网关，则可以传2，直接调用该接口从锁里删除指纹 |
| faceId | Number | N | 人脸Id | 添加后由监听事件返回，仅当 type 为 'face' 且operate!=1 时需要 |
| faceName | String | N | 人脸序号 | 仅当 type 为 'face' 时需要 |
| faceNumber | Number | N | 人脸名称 | 仅当 type 为 'face' 时需要 |
| faceType | Number | N | 人脸类型 | 仅当 type 为 'face' 时需要，1:永久，2：期限，4:循环 |
| faceUserNo | Number | N | 人脸UserNo | 仅当 type 为 'face' 时需要 （选填） |
| palmVeinId | Number | N | 掌静脉Id | 添加后由监听事件返回，仅当 type 为 'palmVein' 且operate!=1 时需要 |
| palmVeinName | String | N | 掌静脉序号 | 仅当 type 为 'palmVein' 时需要 |
| palmVeinNumber | Number | N | 掌静脉名称 | 仅当 type 为 'palmVein' 时需要 |
| palmVeinType | Number | N | 掌静脉类型 | 仅当 type 为 'palmVein' 时需要，1:永久，2：期限，4:循环 |
| palmVeinUserNo | Number | N | 掌静脉UserNo | 仅当 type 为 'palmVein' 时需要 （选填） |
| remoteId | Number | N | 遥控Id | 添加后由监听事件返回，仅当 type 为 'remote' 且operate!=1 时需要 |
| remoteName | String | N | 遥控序号 | 仅当 type 为 'remote' 时需要 |
| remoteNumber | Number | N | 遥控名称 | 仅当 type 为 'remote' 时需要 |
| remoteType | Number | N | 遥控类型 | 仅当 type 为 'remote' 时需要，1:永久，2：期限，4:循环 |
| remoteUserNo | Number | N | 遥控UserNo | 仅当 type 为 'remote' 时需要 （选填） |
**返回**
> Result 统一返回结果格式
@ -724,11 +739,15 @@ registerExtendedProducts(params)
**监听相关事件**
| 事件名 | 描述 | 返回值示例 |
|----------------------------|--------|-------------------------------------------------------|
| registerCardConfirm | 卡片注册成功 | {cardNumber:1,cardId:1} |
| registerFingerprintProcess | 指纹注册进度 | {status: 0,process: 0}；**process总步数在上方统一`Result`中返回** |
| registerFingerprintConfirm | 指纹注册成功 | {fingerprintNumber:1,fingerprintId:1} |
| 事件名 | 描述 | 返回值示例 |
|----------------------------|---------|-------------------------------------------------------|
| registerCardConfirm | 卡片注册成功 | {cardNumber:1,cardId:1} |
| registerFingerprintProcess | 指纹注册进度 | {status: 0,process: 0}；**process总步数在上方统一`Result`中返回** |
| registerFingerprintConfirm | 指纹注册成功 | {fingerprintNumber:1,fingerprintId:1} |
| registerFaceProcess | 人脸注册进度 | {faceNumber:1,faceId:1} |
| registerFaceConfirm | 人脸注册成功 | {faceNumber:1,faceId:1} |
| registerPalmVeinConfirm | 掌静脉注册成功 | {palmVeinNumber:1,palmVeinId:1} |
| registerRemoteConfirm | 遥控注册成功 | {remoteNumber:1,remoteId:1} |
**监听事件示例**
@ -747,7 +766,7 @@ uni.$on('registerFingerprintConfirm', async data => {
})
```
## 取消注册
## 取消操作
**调用方法**
@ -787,6 +806,7 @@ getIcCardList(params)
| pageSize | String | N | 每页显示数 |
**返回**
```json
{
"list": [],
@ -797,7 +817,6 @@ getIcCardList(params)
}
```
## 获取指纹列表
**调用方法**
@ -817,6 +836,97 @@ getFingerprintList(params)
| pageSize | String | N | 每页显示数 |
**返回**
```json
{
"list": [],
"pageNo": 1,
"pageSize": 0,
"pages": 0,
"total": 0
}
```
## 获取人脸列表
**调用方法**
```javascript
import {getFaceList} from 'star-cloud-web'
getFaceList(params)
```
**入参**
| 参数名称 | 数据类型 | 必须 | 描述 |
|----------|--------|----|-------|
| lockId | String | Y | 锁id | |
| pageNo | String | N | 页码 |
| pageSize | String | N | 每页显示数 |
**返回**
```json
{
"list": [],
"pageNo": 1,
"pageSize": 0,
"pages": 0,
"total": 0
}
```
## 获取掌静脉列表
**调用方法**
```javascript
import {getPalmVeinList} from 'star-cloud-web'
getPalmVeinList(params)
```
**入参**
| 参数名称 | 数据类型 | 必须 | 描述 |
|----------|--------|----|-------|
| lockId | String | Y | 锁id | |
| pageNo | String | N | 页码 |
| pageSize | String | N | 每页显示数 |
**返回**
```json
{
"list": [],
"pageNo": 1,
"pageSize": 0,
"pages": 0,
"total": 0
}
```
## 获取遥控列表
**调用方法**
```javascript
import {getRemoteList} from 'star-cloud-web'
getRemoteList(params)
```
**入参**
| 参数名称 | 数据类型 | 必须 | 描述 |
|----------|--------|----|-------|
| lockId | String | Y | 锁id | |
| pageNo | String | N | 页码 |
| pageSize | String | N | 每页显示数 |
**返回**
```json
{
"list": [],

10
uni/index.js
View File

@ -350,6 +350,16 @@ export const getFingerprintList = async params => {
return await starCloudInstance.getFingerprintList(params)
}
/**
* 获取人脸列表
* @param params.lockId 锁id （必填）
* @param params.pageNo 页码（选填）
* @param params.pageSize 每页显示数（选填）
*/
export const getFaceList = async params => {
return await starCloudInstance.getFaceList(params)
}
/**
* 获取掌静脉列表
* @param params.lockId 锁id （必填）