# 获取所有盒子状态 getAllBoxesState

● 接口函数

zwexplorer.PJGBox.getAllBoxesState

● 接口说明

获取文件柜里所有盒子的状态

● Typescript 类型参考

type BoxState = {
    boxNo: string,
    doorStatus: string,
    thingStatus: string,
}

type ReqBody = {}

type ResBody = {
    resultCode: number, resultMessage: string, data: Array<BoxState>
}

getAllBoxesState(data: ReqBody, callback?: (res: ResBody)=>void): Promise<ResBody>

● 返回数据

参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 接口返回的详细数据
res.data[x] Object 盒子状态对象
res.data[x].boxNo String 盒子编号(低 2 位表示柜子的盒子号,高位表示柜子地址。公式为=柜子号*100 + 盒子号。一个柜子最多 24 个盒子)
盒子编号如果返回值为 "101" , 对应的柜子物理号分别为1, 盒子物理号也为1, "212" 则柜子号为2, 盒子号为12
res.data[x].doorStatus String 盒子门锁状态("0"未锁,"1"已锁)
res.data[x].thingStatus String 盒子中物品状态("0"没物品,"1"有物品)
res.resultMessage String 接口消息

● 示例

zwexplorer.PJGBox.getAllBoxesState({}, (res) => {
    // 返回数据
});

# 获取指定盒子状态 getBoxState

● 接口函数

zwexplorer.PJGBox.getBoxState

● 接口说明

获取文件柜里指定的一个盒子的状态

● Typescript 类型参考

type BoxState = {
    boxNo: string,
    doorStatus: string,
    thingStatus: string,
}

type ReqBody = {
    cabinetNo: number,
    boxNo: number,
}

type ResBody = {
    resultCode: number, resultMessage: string, data: BoxState
}

zwexplorer.PJGBox.getBoxState(data: ReqBody, callback?: (res: ResBody)=>void): Promise<ResBody>

● 参数说明

参数 类型 必填 说明
data.cabinetNo Number 柜子物理号(控制板上的编号一致)
data.boxNo Number 盒子物理号(控制板上端口一致)

● 返回数据

参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 接口返回的详细数据
res.data.boxNo String 盒子编号(低 2 位表示柜子的盒子号,高位表示柜子地址。公式为=柜子号*100 + 盒子号。一个柜子最多 24 个盒子)
res.data.doorStatus String 盒子门锁状态("0"未锁,"1"已锁)
res.data.thingStatus String 盒子中物品状态("0"没物品,"1"有物品)
res.resultMessage String 接口消息

● 示例

zwexplorer.PJGBox.getBoxState(
  {
    cabinetNo: 1,
    boxNo: 1,
  },
  (res) => {
    // 返回数据
  }
);

# 打开指定盒子 pickLock

● 接口函数

zwexplorer.PJGBox.pickLock

● 接口说明

传入一个指定盒子的柜子号和盒子号,打开指定盒子

● Typescript 类型参考

type BoxState = {
    boxNo: string,
    doorStatus: string,
    thingStatus: string,
}

type ReqBody = {
    cabinetNo: number,
    boxNo: number,
}

type ResBody = {
    resultCode: number, resultMessage: string, data: BoxState
}

zwexplorer.PJGBox.pickLock(data: ReqBody, callback?: (res: ResBody)=>void): Promise<ResBody>

● 参数说明

参数 类型 必填 说明
cabinetNo Number 柜子物理号(控制板上的编号一致)
boxNo Number 盒子物理号(控制板上端口一致)

● 返回数据

参数 类型 必然存在 说明
res.resultCode Number 状态码,0 为正常,其它为异常 [状态码参考]
res.data Object 接口返回的详细数据
res.resultMessage String 接口消息

● 示例

zwexplorer.PJGBox.pickLock(
  {
    cabinetNo: 1,
    boxNo: 1,
  },
  (res) => {
    // 返回数据
  }
);