# sfe_share_box

**Repository Path**: i3cloud/sfe_share_box

## Basic Information

- **Project Name**: sfe_share_box
- **Description**: 舜风洱共享柜接口文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-21
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 舜风洱共享柜接口文档
版本:
 
版本 | 日期      |操作人
--- |---|---
v1.0  | 2020-10-01|Ting

## MQTT服务器

### 设备连接 
MQTT地址：xxx.xx.xx.xx:1883

用户名密码：null

keeplive：10秒

ClidentID命名规则：sfe_设备ID

设备订阅TOPIC： sfe/设备ID/device/get

设备发布TOPIC： sfe/设备ID/device/post

消息主体格式：JSON

###  设备端--接收

#### 设备端--接收--消息内容

方法      |  设备ID  |消息ID       |时间戳     |data     |
---------|---------|-----------|-----------|---------|
action   |device_id |message_id |timestamp  |请求内容  |

#### 设备端接收--示例

```
{
    "action":"open_door",
    "device_id":"xxxxxxxx",
    "message_id":"12345678",
    "timestamp":"1603184736000",
    "data":[
        {
            "box_num":"10"
        }
    ]
}
```

#### 设备端--接收--方法列表

方法名称|请求内容|说明|
------------|------------|-----------|
status|[]|请求所有柜门状态|
open_door|[{"box_num":"10"}]|打开柜门 box_num 为柜子内部编号|
open_door_item|[{"box_num":["1","3","5","9"]}]|批量打开柜门 box_num 为柜子内部编号|
open_all|[]|开启机器所有柜门|
clean_door|[{"box_num":"10"}]|清除柜门 box_num 为柜子内部编号|
clean_door_item|[{"box_num":["1","3","5","9"]}]|批量清除柜门 box_num 为柜子内部编号|
clean_all|[]|清除机器所有柜门|
lend_door|[{"box_num":"5","pwd":"123456","face":"xxxxxx"}]|租用柜门 box_num 为柜子内部编号 pwd 为开箱密码 face 为人脸特征码(选填)|
fix_pwd|[{"box_num":"5"}]|修改柜门密码 box_num 为柜子内部编号|

###  设备端--发送

#### 设备端--发送--消息内容

状态码  |方法      |  设备ID   |消息ID(接收原样返回)   |时间戳      |data     |
-------|---------|-----------|--------------------|-----------|---------|
code  |action   |device_id  |message_id          |timestamp  |请求内容  |

#### 设备端--发送--示例

```
{
	"code":"0",
    "action":"open_door",
    "device_id":"xxxxxxxx",
    "message_id":"12345678",
    "timestamp":"1603184736000",
    "data":[]
}
```
#### 设备端--接收--方法列表

方法名称|请求内容|说明|
------------|------------|-----------|
status|[{"box_1":"userd"},{"box_2":"empty"}...]|返回所有柜门状态|
open_door|[{"box_num":"10"}]|打开柜门 box_num 为柜子内部编号|
open_door_item|[{"box_num":["1","3","5","9"]}]|批量打开柜门 box_num 为柜子内部编号|
open_all|[]|开启机器所有柜门|
clean_door|[{"box_num":"10"}]|清除柜门 box_num 为柜子内部编号|
clean_door_item|[{"box_num":["1","3","5","9"]}]|批量清除柜门 box_num 为柜子内部编号|
clean_all|[]|清除机器所有柜门|
lend_door|[{"box_num":"5","pwd":"123456"}]|租用柜门 box_num 为柜子内部编号 pwd 为开箱密码|
fix_pwd|[{"box_num":"5"}]|修改柜门密码 box_num 为柜子内部编号|

## 1、设备升级检测接口
### 1.1接口url
#### 前缀/api/sfe/v1/ota/check



### 1.2请求方式
MQTT HTTP

### 1.3请求头
 
参数      |类型     |是否必传 |说明       | 示例     |
-------- |---------|--------|----------|---------|


### 1.4参数说明
 
参数             |类型      |是否必传  |说明                  | 示例     |
----------------|----------|------- |----------------------|---------|
device_id       | string   |是      |设备ID                 |xxxxxxxx|
ver             | string   |是      |当前版本号              |1.1.0 | 

 
### 1.5返回结果
```
{
    "code": 0,
    "version": "1.2.1",
    "md5": "xxxxxxxxxxxxxxxx",
    "url": "http://xxx.com/ota_1_2_1.apk"
}
```

### 1.6返回说明
code - 0 有更新 1无更新

md5 - 文件校验值

url - 更新文件下载地址