读头标品HTTP&TCP协议文档（Vbar版本）

# 1、格式
## 1.1 请求数据格式
vgdecoderesult=`xxx`&&devicenumber=`xxx`&&otherparams=
<table>
<thead>
  <tr>
    <th>字段</th>
    <th>描述</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult</td>
    <td>解码/身份证结果/刷卡数据字符串</td>
  </tr>
  <tr>
    <td>devicenumber</td>
    <td>扫码器设备号</td>
  </tr>
  <tr>
    <td>otherparams</td>
    <td>预留字段</td>
  </tr>
</tbody>
</table>

## 1.2 应答数据格式
code=`xxxx `结果码，数据内容用`&&`间隔，格式为key=val
### 1.2.1 结果码
0000~0008 成功、语音，执行成功行为，其他动作执行失败行为

|结果码|描述|动作|
|--|--|--|
|0000|成功|成功|
|00ff|http协议下升级|失败|
|01ff|获取配置|失败|
|02ff|显示UI信息|失败|
|03ff|http协议下升级（仅带语音或UI设备支持）|失败|
|0001|5/9.wav（仅带语音设备支持）|成功|
|----|.... （仅带语音设备支持）|成功|
|0008|12/16.wav（仅带语音设备支持）|成功|

## 1.3 HTTP请求头
{
"Content-Length": "89",
  	   "Content-Type": "text/html; charset=UTF-8",
          "Accept": "*/*",
          "Host": "mock.uutool.cn"         
}

# 2、TCP/HTTP协议指令
## 2.1 传输成功/失败行为(带UI设备支持)

<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=0000</td>
    <td>设备配置的传输成功或失败行为</td>
  </tr>
</tbody>
</table>

## 2.2 播放音频（带语音设备支持）
<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=0001</td>
    <td>播放9.wav音频</td>
  </tr>
</tbody>
</table>

<font color='red'>注</font>：根据服务器的响应内容，code=0001-code=0008，对应播放9.wav~16.wav
## 2.3 固件升级

<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=00ff&amp;&amp;url=升级包下载地址（不加双引号）&amp;&amp;reboot=1</td>
    <td>下载升级包，设备升级并重启</td>
  </tr>
</tbody>
</table>

## 2.4 输出配置信息

<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=01ff</td>
    <td>将设备配置信息以请求的方式<br>发送到服务器</td>
  </tr>
</tbody>
</table>

## 2.5 UI屏显示信息（带UI设备支持）
<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=02ff&amp;&amp;msg="message"</td>
    <td>UI屏显示信息</td>
  </tr>
</tbody>
</table>

## 2.6 音频升级（带语音或UI设备支持）

<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=03ff&amp;&amp;url=音频包下载地址&amp;&amp;reboot=1</td>
    <td>下载音频包，设备升级并重启</td>
  </tr>
</tbody>
</table>

## 2.7 UI屏弹窗（带UI设备支持）
<table>
<thead>
  <tr>
    <th>Reader-&gt;PC</th>
    <th>PC-&gt;Reader</th>
    <th>设备动作</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>vgdecoderesult=`xxx`&amp;&amp;devicenumber=`xxx`<br>&amp;&amp;otherparams=</td>
    <td>code=0000&amp;&amp;desc=json<br>&amp;&amp;{"msg":"message"}<br> </td>
    <td>UI屏显示信息</td>
  </tr>
</tbody>
</table>

## 2.8 UI\音频\验证结果
`如:code=0000&&desc=json&&{"resultCode":"0000","wavFileName":"0","msg":"message","msgTimeout":2000}`
json 支持字段如下表

| 参数名      | 说 明        | 类 型   | 必 须 | 备 注      |
| :----------: | :-----------: | :------: | :----: | :---------------------------|
| msg        | 提示信息    | String  | 否   | 当设备支持UI时将弹窗显示此信息 |
| msgTimeout | 提示时间 | Int     | 否   | 单位:`ms`，当设备支持UI时，UI显示`msg`的时间<br>此项不存在默认显示时间:`1500ms` |
| wavFileName | 音频文件名    | String  | 否   | 此项不存在播放默认语音<br>此项存在则播放对应名称的语音<br>如`"wavFileName":"9"`则播放`9.wav`<br>注：若此项存在需关闭网络传输行为中的`播报语音`       |
| resultCode | 结果码     | String   | 否   | 若此项存在且不等于`"0000"`如`"resultCode":"0001"`<br>设备将不执行成功动作（继电器不会动作） |

#3、修改记录表
<table>
<thead>
  <tr>
    <th colspan="5">修改记录表</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>版本号</td>
    <td>修改内容</td>
    <td>修改人</td>
    <td>修改日期</td>
    <td>备注</td>
  </tr>
  <tr>
    <td>v1.0</td>
    <td>TCP/HTTP初版</td>
    <td>李迎</td>
    <td>23/7/13</td>
    <td> </td>
  </tr>
    <tr>
    <td>v1.0</td>
    <td>TCP/HTTP初版</td>
    <td>洛凤亚</td>
    <td>24/3/11</td>
    <td> </td>
  </tr>
  <tr>
    <td>v1.0</td>
    <td>修改固件升级和音频升级时，值的形式。（不加双引号）</td>
    <td>陈闻成</td>
    <td>25/3/11</td>
    <td> </td>
  </tr>
    <tr>
    <td>v1.0</td>
    <td>去除了固件升级和音频升级时，临时下载字段download_path。（不加双引号）</td>
    <td>陈闻成</td>
    <td>25/5/19</td>
    <td> </td>
  </tr>
</tbody>
</table>