IoT协议

对接IoT平台协议


设备上报

<h4>简要描述</h4> <ul> <li>设备上报</li> </ul> <h4>请求URL</h4> <ul> <li><code>http://&amp;lt;service&amp;gt;/api/device/report</code></li> </ul> <h4>请求方式</h4> <ul> <li>POST</li> </ul> <h4>请求示例</h4> <pre><code> { &amp;quot;deviceId&amp;quot;: &amp;quot;SZ3127197000002&amp;quot;, &amp;quot;imei&amp;quot;: &amp;quot;868777059994610&amp;quot;, &amp;quot;iccid&amp;quot;: &amp;quot;89860116831014024277&amp;quot;, &amp;quot;network&amp;quot;: { &amp;quot;mcc&amp;quot;: 460, &amp;quot;mnc&amp;quot;: 1, &amp;quot;lac&amp;quot;: 23836, &amp;quot;cid&amp;quot;: 186506775, &amp;quot;signal&amp;quot;: 66 }, &amp;quot;wlan&amp;quot;: { &amp;quot;mac&amp;quot;: &amp;quot;E8-49-43-01-53-7B&amp;quot;, &amp;quot;ssid&amp;quot;: &amp;quot;XP-UFI_537B&amp;quot;, &amp;quot;key&amp;quot;: &amp;quot;MTIzNDU2Nzg=&amp;quot;, &amp;quot;status&amp;quot;: 1 }, &amp;quot;slotCurr&amp;quot;: 0, &amp;quot;slotNum&amp;quot;: 0, &amp;quot;connNum&amp;quot;: 0, &amp;quot;lastTs&amp;quot;: 25, &amp;quot;monthTs&amp;quot;: 94 }</code></pre> <h4>请求参数说明</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">accessToken</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>接入token</td> </tr> <tr> <td style="text-align: left;">deviceId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>设备ID</td> </tr> <tr> <td style="text-align: left;">imei</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>设备IMEI</td> </tr> <tr> <td style="text-align: left;">iccid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>SIM 卡ICCID</td> </tr> <tr> <td style="text-align: left;">network</td> <td style="text-align: left;">是</td> <td style="text-align: left;">object</td> <td>4G网络信息</td> </tr> <tr> <td style="text-align: left;">network.mcc</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td>国家代码,460:中国</td> </tr> <tr> <td style="text-align: left;">network.mnc</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td>网络类型</td> </tr> <tr> <td style="text-align: left;">network.lac</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td>位置区域码</td> </tr> <tr> <td style="text-align: left;">network.cid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td>Cellid 基站号</td> </tr> <tr> <td style="text-align: left;">network.signal</td> <td style="text-align: left;">是</td> <td style="text-align: left;">number</td> <td>信号强度指示</td> </tr> <tr> <td style="text-align: left;">wlan</td> <td style="text-align: left;">否</td> <td style="text-align: left;">object</td> <td>WiFi信息</td> </tr> <tr> <td style="text-align: left;">wlan.mac</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>WiFi Mac地址,格式A1-B2-C3-D4-E5-F6</td> </tr> <tr> <td style="text-align: left;">wlan.ssid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>WiFi 名称,UTF-8 编码</td> </tr> <tr> <td style="text-align: left;">wlan.key</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>WiFi 密码,Base64 编码</td> </tr> <tr> <td style="text-align: left;">wlan.status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>WiFi 状态,0:关闭,1:打开</td> </tr> <tr> <td style="text-align: left;">battery</td> <td style="text-align: left;">否</td> <td style="text-align: left;">object</td> <td>电池信息</td> </tr> <tr> <td style="text-align: left;">battery.status</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>电池状态,0:无电池,1:放电中,2:充电中</td> </tr> <tr> <td style="text-align: left;">battery.level</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>电池电量,百分比</td> </tr> <tr> <td style="text-align: left;">slotCurr</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>当前使用的卡槽号,0 开始</td> </tr> <tr> <td style="text-align: left;">slotNum</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>SIM 卡槽总数</td> </tr> <tr> <td style="text-align: left;">connNum</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>客户连接数</td> </tr> <tr> <td style="text-align: left;">lastTs</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>上报间隔使用流量,单位:KB</td> </tr> <tr> <td style="text-align: left;">monthTs</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>本月使用总流量,单位:KB</td> </tr> <tr> <td style="text-align: left;">dataLimit</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>当前限速,单位:Kbps</td> </tr> <tr> <td style="text-align: left;">deviceKey</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>设备webui登陆密码,Base64 编码</td> </tr> <tr> <td style="text-align: left;">nextReport</td> <td style="text-align: left;">否</td> <td style="text-align: left;">number</td> <td>下次上报间隔,单位:秒</td> </tr> </tbody> </table> <h4>返回示例</h4> <pre><code> { &amp;quot;cmdName&amp;quot;: &amp;quot;switch&amp;quot;, &amp;quot;cmdParam&amp;quot;: { &amp;quot;slot&amp;quot;: 1 } }</code></pre> <h4>返回参数说明</h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdName</td> <td style="text-align: left;">string</td> <td>下发指令名称</td> </tr> <tr> <td style="text-align: left;">cmdParam</td> <td style="text-align: left;">object</td> <td>下发指令参数</td> </tr> </tbody> </table> <h4>下发指令说明</h4> <ul> <li> <h6>reboot 指令,功能:重启设备</h6> <p>无参数</p> </li> <li> <h6>restore 指令,功能:复位出厂</h6> <p>无参数</p> </li> <li> <h6>update 指令,功能:FOTA升级</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.url</td> <td style="text-align: left;">string</td> <td>版本地址</td> </tr> </tbody> </table> <ul> <li> <h6>switch 指令,功能:切卡</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.slot</td> <td style="text-align: left;">number</td> <td>卡槽号,0 开始</td> </tr> <tr> <td style="text-align: left;">cmdParam.mode</td> <td style="text-align: left;">number</td> <td>切卡模式,0:硬切卡, 1:智能切卡</td> </tr> </tbody> </table> <ul> <li> <h6>setint 指令,功能:设置上报间隔</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.timer</td> <td style="text-align: left;">number</td> <td>时间间隔,单位:秒</td> </tr> </tbody> </table> <ul> <li> <h6>setlimit 指令,功能:限速</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.speed</td> <td style="text-align: left;">number</td> <td>速度,单位:Kbps</td> </tr> </tbody> </table> <ul> <li> <h6>setnet 指令,功能:设置网络模式</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.mode</td> <td style="text-align: left;">number</td> <td>0:关闭数据转发,1:打开数据转发</td> </tr> </tbody> </table> <ul> <li> <h6>setwifi 指令,功能:设置WiFi参数</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.ssid</td> <td style="text-align: left;">string</td> <td>WiFi 名称,UTF-8 编码</td> </tr> <tr> <td style="text-align: left;">cmdParam.key</td> <td style="text-align: left;">string</td> <td>WiFi 密码</td> </tr> <tr> <td style="text-align: left;">cmdParam.status</td> <td style="text-align: left;">number</td> <td>0:关闭,1:打开</td> </tr> </tbody> </table> <ul> <li> <h6>setdevice 指令,功能:设置设备参数</h6> </li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">cmdParam.key</td> <td style="text-align: left;">string</td> <td>设备webui 登陆密码</td> </tr> </tbody> </table> <h4>备注</h4> <ul> <li>如果设备支持WiFi,上报有WiFi信息</li> <li>如果设备支持电池,上报有电池信息</li> <li>如果平台不需要下发指令,返回参数可以为空</li> </ul>

页面列表

ITEM_HTML