GL-S10 用户手册¶
| 版本 | 日期 | 提交 |
|---|---|---|
| V2.0.3 | 2021-12-17 | - |
产品简介¶
产品介绍¶
GL-S10是一款支持BLE和Wi-Fi的物联网网关设备，为将BLE广播数据传输到云端提供了经济高效的解决方案。BLE支持GAP和GATT认证，可以作为Master或Slave与其他BLE设备连接和通信。GL-S10可以使用Wi-Fi作为站连接到父路由，也可以通过WAN端口连接到Internet。它有一个内置的标准MQTT客户机，可以连接到任何标准MQTT服务器，将传入的BLE消息转发到云服务器。
GL-S10理想部署在仓库、商场、机场、展厅、旅游景点等场景，用于人员管理、资产管理、环境监测、室内导航等。
产品特性¶
- 采用双核Xtensa®32位LX6微处理器，支持BLE、Wi-Fi、以太网
-
BLE支持BLE 4.2认证
-
BLE通信距离可达80m(在开放无干扰环境下)
-
支持多种加密方式
-
支持通过OTA和本地串口升级固件
-
支持MQTT，可集成多个服务器平台
-
包括用于配置自定义连接到Wi-Fi和MQTT服务器的应用程序
-
支持802.3at/af标准POE输入电源
技术规范¶
| 规格 | |
|---|---|
| CPU | ESP32-DOWD Dual-core Xtensa ® 32-bit LX6 microprocessor |
| Nor-Flash | 4MB |
| RAM | SRAM 520KB + PSRAM 8MB |
| BLE | 支持 BLE 4.2 认证 覆盖范围 80 米（在开放和无干扰环境中） 接收灵敏度 - 97dBm |
| WiFi | 802.11b/g/n 覆盖范围 80 米（在开放和无干扰的环境中） 发射功率 11n： 13dBm；11b：18.5dBm 速率 150Mbps |
| WAN | 1 个兆位以太网端口 |
| 按钮 | 1 重置按钮 按下按钮可进入配置模式、重置和 OTA 升级。 |
| LED | 3 LED 指示灯: 电源、BLE 和网络指示灯 |
| 供电 | 支持1x Micro USB, 5V/1A 输入 支持 802.3at/af standard POE 供电 注意: 同时使用两种方法充电可能会损坏设备。 |
| 功耗 | 正常运行: < 0.5W 满负荷运行: < 1.5W |
| 外壳尺寸 | 57 * 57 * 25mm(L * M * H) |
| 外壳材料 | ABS |
| 天线类型 | 外置天线 |
| 工作温度 | 0~40°C |
| 存贮温度 | -20~70°C |
| 工作湿度 | 5% ~ 90%, no condensation |
| 存贮湿度 | 5% ~ 95%, no condensation |
包裹清单¶
| Project | Quantity |
|---|---|
| GL-S10 网关 | 1 |
| BLE 信标 (可选配件) | 1 |
| 外置天线 | 1 |
| USB 电源线 | 1 |
| 用户手册 | 1 |
设备及应用程序安装¶
设备安装¶
将产品从包装中取出，如图所示连接外部天线。
注意:
-
请勿同时插入PoE电源和5V电源，否则可能对设备造成损坏。
-
安装天线前，请勿接入任何电源(包括PoE和5V电源)。
按钮功能列表¶
| 配对模式 | 恢复出厂设置 | OTA 升级 |
|---|---|---|
| 未连接任何电源时，插上电源线，按住“Reset”键。 | 在按“Reset”键的同时，打开电源，长按“Reset”键5秒后松开。 | 在按“Reset”键的同时，打开电源，长按“Reset”键10秒后松开。 |
LED 描述¶
| LED 灯 | 状态 | 恢复出厂设置 | 进入OTA 模式 | OTA 升级 过程 |
|---|---|---|---|---|
| 电源 (绿灯) |
灯亮：设备处于开启状态 灯灭：设备处于关闭状态 |
慢闪 | 快闪 | 交替闪烁 |
| BLE (绿灯) |
灯闪：配对模式（断开连接） 灯亮：配对模式（连接） 灯灭：扫描模式 |
慢闪 | 快闪 | 交替闪烁 |
| 网络 (白灯) |
灯闪：Wi-Fi 连接 灯亮：以太网连接 灯灭：无连接 |
慢闪 | 快闪 | 交替闪烁 |
BLE 信标¶
BLE信标是可选配件。用户可以购买带有信标的网关套件进行快速演示。信标还可用于室内定位、资产管理等场景。旋转底座使装置易于拆卸;底座有3M胶粘剂，很容易固定到位。
打开信标底部的BLE开关后，信标将以300ms的间隔广播BLE信号。选择GL-S10的过滤功能，通过信标底部打印的BLE MAC地址识别设备。
应用程序安装¶
在您的手机上下载并安装GL-S10工具应用程序，打开您的手机蓝牙功能(Android手机用户请打开蓝牙和GPS)，并按照本用户手册的说明配置GL-S10。
应用程序配置¶
设置配置模式¶
在使用app进行配置前，请在断电时按下GL-S10的Reset按钮，将GL-S10设置为对偶模式，然后打开电源。当看到中间的BLE指示灯闪烁时，松开按钮，GL-S10将进入配对模式。
应用程序语言¶
启动应用程序，选择应用语言，可以选择英文和简体中文。
连接 GL-S10¶
点击右上角的“扫描”按钮。扫描结果会自动过滤掉非gl - s10设备。如果扫描了多个GL-S10，请根据GL-S10外壳底部标签上的BLE MAC地址选择要连接的设备(如下所示)。
注意: WAN MAC地址是BLE MAC地址减1,WiFi MAC地址是BLE MAC地址减2
主页¶
选择GL-S10设备，进入“管理设备”界面，如下图所示
设备信息¶
单击，查看设备的详细信息，如下图所示
协议配置¶
要在WAN端口上使用协议建立上行连接，请单击“管理设备” > “协议” > “协议”。您可以配置“DHCP”和“静态IP”模式，然后单击“完成”保存设置，如下图所示。
Wi-Fi 配置¶
连接主网关，点击“管理设备” > “WiFi” > “连接WiFi” > “扫描WiFi”，选择您的WiFi SSID。也可以选择“无”、“WPA2”或“WPA2 Enterprise”模式。点击右上角的“完成”确认设置，如下图所示。如果要升级WPA2 ENTERPRISE证书，请单击“升级证书”。
MQTT 配置¶
要配置MQTT，请单击“管理设备”>“MQTT服务器”。在“Host”字段中输入MQTT代理的地址，填写端口号、用户名和密码。“TLS”选择在TSL/SSL链路和TCP链路之间切换。在“命令”栏输入订阅消息，在“回应主题”栏输入SUBACK确认消息。您也可以单击下面的“更新证书”来更新MQTT加密证书。点击右上角的“完成”保存设置。
上报配置¶
在“设备管理”界面点击“报表配置”，进入“报表配置”界面。
点击“报告间隔”、“主题”、“蓝牙RSSI阈值过滤”进入相关信息配置界面，填写好配置信息后，点击左上角返回上一页保存设置。
点击下方的“BLE MAC Filter”、“Complete Local Name Filter”或“Manufacturer Specific Data Filter”，输入相关信息激活过滤。
注意: 过滤规则说明
- MAC Filter:取值范围为0~f，小写，且必须包含冒号;字符串应该是完全匹配的。
-
完全本地名称过滤:字符区分大小写，字符串必须是完全匹配的;如有不确定的信息，请下载nFR连接软件进行查询。
-
制造商特定数据过滤器:取值范围为0~f/ f，字符区分大小写，按照正则表达式进行匹配。
如果您购买了带有BLE信标的网关套件，您还可以通过输入打印在信标底部的BLE MAC地址信息，在应用程序中为信标设置BLE MAC过滤规则。
点击“添加新规则”或“删除”编辑过滤器设置，点击右上角“完成”保存设置。
数据 & 时间配置¶
点击“管理设备”>“日期和时间”。选择您的时区，填写SNTP服务地址，然后单击左上角返回到上一页保存您的设置，如下所示。
自动重启配置¶
点击“管理设备”>“自动重启”。您可以每天安排一个时间来重新启动GL-S10。单击左上角返回到上一页保存设置，如下所示。
OTA 升级¶
点击“管理设备”>“OTA升级”。在“OTA URL”下，输入http服务器地址，点击右上角的“保存”。点击“升级OTA”保存URL路径，开始升级。点击“更新证书”，更新OTA加密证书，如下图所示。
请保持您的GL-S10连接互联网，在OTA升级期间不要关闭电源。OTA升级完成后，您的GL-S10将自动进入扫描模式，您的应用程序将无法搜索GL-S10。
重新启动设备¶
点击“管理设备”>“重新启动”，弹出窗口将要求重新启动确认。点击“确定”后，设备将重新启动。重新启动后，设备将自动进入扫描模式，您的应用程序将无法搜索GL-S10。
重置设备¶
点击“管理设备”>“重置”。弹出窗口将要求重置确认。单击“确定”后，所有设备配置将恢复为出厂默认设置。重置设备后，它将自动进入扫描模式，您的应用程序将能够搜索GL-S10。
MQTT 配置¶
当GL-S10连接到MQTT服务器时，您还可以使用MQTT API来配置GL-S10。
您可以使用第三方工具配置MQTT—MQTT X，可从 https://mqttx.app/。
默认的MQTT设置被配置为与测试版云平台连接。输入GL-S10和MQTT X客户端的配置以激活连接。测试版云平台仅用于测试，不用于其他用途。
网络配置¶
GL-S10支持有线传输和Wi-Fi连接到路由器或网关。设置步骤请参见3.6配置线缆和3.7配置Wi-Fi。
MQTT X 客户端配置¶
在进行MQTT X客户机配置之前，我们需要首先在S10上配置MQTT服务器的配置。在S10工具APP中找到MQTT服务器会话。
这里我们使用的是测试MQTT服务器: iot-s10-test.gl-inet.cn. 端口: 1884,所以我们需要设置如下图的主机: iot-s10-test.gl-inet.cn. 端口: 1884.
在windows版本的MQTT X客户机上，启动MQTT X软件并添加一个新连接。配置测试版云平台，输入URL: iot-s10-test.gl-inet.cn，端口号:1884。单击页面右上角进行连接。一个成功的连接如图33所示。
MQTT 消息编辑和与 S10 的通信¶
该固件默认命令主题为 GL-IoT/comTopic/{dev_MAC}, 命令回复主题为 GL-IoT/rspTopic/{dev_MAC} 。
我们在本例中使用的GL-S10设备的BLE MAC地址是: E8DB841E2B1E (BLE MAC地址打印在设备底部或应用程序中)。
在我们的测试中，MQTT X通过GL-IoT/comTopic/E8DB841E2B1E发送数据，并通过订阅GL-IoT/rspTopic/E8DB841E2B1E从GL-S10接收数据。
下面是如何设置数据(SET_DEV_MESSAGE)和从GL-S10 (GET_DEV_MESSAGE)获取数据的演示:
步骤1: 使用MQTT X订阅GL-IoT/rspTopic/E8DB841E2B1E主题。
步骤2: SET_WIFI_CONFIG
API 功能: 配置WIFI的SSID、PWD或WIFI WPA2的SSID、用户名、用户密码，并尝试连接相应的路由。
{
"jsonrpc": "2.0",
"method": "SET_WIFI_CONFIG",
"params": {
"type":0,
"ssid": "Test",
"pwd": "123456"
},
"id": 1
}
这里我们使用“Test”作为SSID，使用“123456”作为用户密码。
- 当“type”= 0时，可设置“SSID”、“PASSWORD”。
- 当type = 1时，可设置“SSID”、“USERNAME”、“USERPASSWORD”。
- SSID:路由名称，长度0 ~ 32个字符。
- PWD:路由密码，长度0 ~ 64个字符。
- USERNAME:用户名，长度0 ~ 32个字符。
- USERPWD:用户密码，长度为0 ~ 64个字符。
数据设置成功:
步骤3: GET_WIFI_CONFIG
API 功能: 获取WIFI的SSID、PWD或WIFI WPA2的SSID、用户名、用户密码
{
"jsonrpc" : "2.0" ,
"method" : "GET_WIFI_CONFIG" ,
"params" : {
"type" : 0
},
"id" : 2
}
- 当type = 0时，获取SSID、PASSWORD。
- 当type = 1时，获取SSID、USERNAME、USERPASSWORD
成功获取数据:
BLE 数据上传¶
连接成功后，GL-S10自动进入扫描模式，在启动过程中扫描BLE信号。如果MQTT服务器连接，BLE扫描数据将被打包并以JSON格式上传到“GL-IoT/dataTopic/{dev_MAC}”主题。({dev_MAC}为本地BLE MAC地址，本例中使用的GL-S10设备的BLE MAC地址为:E8DB841E2B1E)。
如上所示，JSON字段具有以下定义
- MAC:广播源地址
- rssi:广播源信号强度
- n:广播源设备名称(如果广播源没有名称，此字段将不显示)
- ad:广播数据advData
- ts:接收时间戳
如果您购买了带有BLE信标的网关套件，并根据3.9节添加了对信标BLE MAC地址的过滤规则，则此处查看的JSON信息就是信标广播的BLE信息。信标与GL-S10网关的距离不同(距离可达分米级别)，rssi(广播源信号强度)的值可能会因距离而波动。
GL-S10 配置 API¶
本章定义了使用MQTT方法配置GL-S10设备的命令。基于JSON_RPC 2.0标准开发，请遵循格式。
命令摘要表
命令摘要表¶
| 命令码 | 命令 | 是否需要参数 | 描述 |
|---|---|---|---|
| 0x01 | SET_WIFI_CONFIG | 是 | 设置Wi-Fi配置 |
| 0x02 | GET_WIFI_CONFIG | 否 | 获取Wi-Fi配置 |
| 0x03 | SET_NETWORK_CONFIG | 是 | 设置静态IP或动态IP |
| 0x04 | GET_NETWORK_CONFIG | 否 | 获取静态IP或动态IP |
| 0x05 | GET_NETWORK_STATE | 否 | 获取当前网络状态 |
| 0x07 | SET_MQTT_PARAMS | 是 | 设置MQTT URL |
| 0x08 | GET_MQTT_PARAMS | 否 | 获取MQTT URL |
| 0x0A | SET_MQTT_TOPIC | 是 | 设置MQTT主题名称 |
| 0x0B | GET_MQTT_TOPIC | 否 | 获取MQTT主题名称 |
| 0x0C | SET_MQTT_TI | 是 | 设置MQTT数据报告时间间隔 |
| 0x0D | GET_MQTT_TI | 否 | 获取MQTT数据报告时间间隔 |
| 0x0E | SET_SNTP_TZ | 是 | 设置SNTP服务器时区 |
| 0x0F | GET_SNTP_TZ | 否 | 获取SNTP服务器时区 |
| 0x10 | SET_SNTP_SERVER | 是 | 设置SNTP服务器 |
| 0x11 | GET_SNTP_SERVER | 否 | 获取SNTP服务器 |
| 0x12 | SET_AUTO_REBOOT | 是 | 设置自动重启时间 |
| 0x13 | GET_AUTO_REBOOT | 否 | 获取自动重启时间 |
| 0x14 | SET_MAC_FILTER | 是 | 添加和删除MAC过滤表项 |
| 0x15 | GET_MAC_FILTER | 是 | 获取MAC过滤表项 |
| 0x16 | SET_CLN_FILTER | 是 | 添加和删除BLE Complete Local Name过滤表项 |
| 0x17 | GET_CLN_FILTER | 否 | 获取BLE Complete Local Name过滤表项 |
| 0x18 | SET_MSD_FILTER | 是 | 添加和删除Manufacturer Specific Data过滤表项 |
| 0x19 | GET_MSD_FILTER | 否 | 获取Manufacturer Specific Data过滤表项 |
| 0x1A | UPDATE_MQTT_CERT | 是 | 更新MQTT加密证书 |
| 0x1B | UPDATE_WPA2_CERT | 是 | 更新Wi-Fi WPA2加密证书 |
| 0x1C | UPDATE_HTTPS_CERT | 是 | 更新HTTPS OTA加密证书 |
| 0x1D | SET_OTA_URL | 是 | 设置OTA服务器的URL |
| 0x1E | GET_OTA_URL | 否 | 获取OTA服务器的URL |
| 0x1F | OTA_STATUS | 否 | OTA升级状态通知 |
| 0x20 | GET_DEV_STATUS | 否 | 获取设备状态 |
| 0x21 | GET_DEV_MESSAGE | 否 | 获取设备消息 |
| 0x22 | RESTART_DEV | 否 | 重新启动设备 |
| 0x23 | RESET_DEV | 否 | 重置设备 |
| 0x24 | SET_BLE_RSSI_FILTER | 是 | 设置RSSI过滤阈值 |
| 0x25 | GET_BLE_RSSI_FILTER | 否 | 获取RSSI过滤器阈值 |
| 0x26 | GET_WiFi_AP_LIST | 否 | 获取周围Wi-Fi AP信息的列表 |
| 0x27 | SET_MQTT_CLIENT_ID | 是 | 设置mqtt客户端id |
| 0x28 | GET_MQTT_CLIENT_ID | 否 | 获取mqtt客户端id |
| 0x29 | SET_BLE_SCAN_PARAMS | 是 | 设置ble扫描参数 |
| 0x2A | GET_BLE_SCAN_PARAMS | 否 | 获取ble扫描参数 |
命令细节¶
SET_WIFI_CONFIG¶
API 功能: 配置WiFi的SSID和密码，或WiFi WPA2的SSID、用户名和密码，然后连接到路由器。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_WIFI_CONFIG",
"params": {
"type": x,
......
},
"id": 1
}
| ID | params | |
|---|---|---|
| 0x01 | ||
| "params":{"type":0,"ssid":"x","pwd":"x"} | ||
| "params":{"type":1,"ssid":"x","username":"x","userpwd":"x"} | ||
注意:
- 当“type”= 0x00时，“ssid”和“pwd”可配置。
-
当type = 0x01时，可以配置“ssid”、“username”、“userpwd”。
-
ssid:路由器的名称，最大长度为1 ~ 32个字符。
- pwd:路由器的密码，最大长度为8 ~ 64个字符。
- username:用户名，最大长度为1 ~ 32个字符。
- userpwd:用户密码，最大长度为1 ~ 64个字符。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 1
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 1
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_WiFi_CONFIG¶
API 功能:
获取Wi-Fi SSID和PWD，或Wi-Fi WPA2 SSID，用户名，用户密码
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_WIFI_CONFIG",
"params": {
"type": x
},
"id": 2
}
注意:
- 当“type”字段等于0x00时，获取SSID, PASSWORD。
- 当“type”字段等于0x01时，获取SSID, USERNAME, USERPASSWORD。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"type": x,
......
},
"id": 2
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 2
}
| ID | result | |
|---|---|---|
| 0x02 | ||
| "result":{"type":0,"ssid":"x","pwd":"x"} | ||
| "result":{"type":1,"ssid":"x","username":"x","userpwd":"x"} | ||
注意:
- 当“type”字段等于0x00时，获取SSID, PASSWORD。
- 当“type”字段等于0x01时，获取SSID, USERNAME, USERPASSWORD。
- ssid:路由器的名称，最大长度为1 ~ 32个字符。
- pwd:路由器的密码，最大长度为8 ~ 64个字符。
- username:用户名，长度为1 ~ 32个字符。
- userpwd:用户密码，长度为1 ~ 64个字符。
- error:包含错误码和消息的对象。
SET_NETWORK_CONFIG¶
API 功能:
设置静态IP或动态IP。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_NETWORK_CONFIG",
"params": {
"isdhcp": "x",
......
},
"id": 3
}
| ID | params | |
|---|---|---|
| 0x03 | ||
| "params":{"isdhcp":1} | ||
| "params":{"isdhcp":0,"ip":"x","netmask":"x","gw":"x"} | ||
注意:
- 当“isdhcp”字段的值为0x00时，表示设备设置为DHCP自动获取IP模式。
- 当“isdhcp”字段= 0x01时，表示将设备设置为静态IP模式，可设置IP、Netmask、Gw。
- ip:固定长度，xxx为0 ~ 255之间的数字，格式为xxx.xxx.xxx.xxx。
- netmask:固定长度，xxx为0 ~ 255之间的数字，格式为xxx.xxx.xxx.xxx。
- gw:固定长度，xxx表示0 ~ 255之间的数字，格式为xxx.xxx.xxx.xxx。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 3
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 3
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_NETWORK_CONFIG¶
API 功能:
获取静态IP或动态IP的网络配置。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_NETWORK_CONFIG",
"id": 4
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"isdhcp": x,
"ip": "x",
"netmask": "x",
"gw": "x"
},
"id": 4
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 4
}
注意:
- 当“isdhcp”字段值为0x00时，表示设备处于DHCP自动分配状态，后面的数据为空。
- 当“isdhcp”字段的值为0x01时，表示设备处于静态IP分配状态，可以接收IP、Netmask和Gw。
- ip:固定长度，xxx为0 ~ 255的数字，格式为xxx.xxx.xxx。
- netmask:固定长度，xxx为0 ~ 255之间的数字，格式为xxx.xxx.xxx.xxx。
- gw:固定长度，xxx表示0 ~ 255的数字，格式为xxx.xxx.xxx.xxx。
- error:包含错误码和消息的对象。
GET_NETWORK_STATE¶
API 功能:
获取当前网络状态:state, Mode, isDhcp, IP, SSID。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_NETWORK_STATE",
"id": 5
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"state": x,
"mode": "x",
"isdhcp": "x",
"ip": "x",
"ssid": "x"
},
"id": 5
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 5
}
注意:
- state:连接状态(MQTT服务器连接)，0表示已连接，1表示未连接，占用1字节。
- mode:连接方式，字符“0”表示通过Wi-Fi连接，字符“1”表示通过以太网连接，占用1字节。
- isdhcp:字符“0”表示自动分配，字符“1”表示非自动分配，占用1字节。
- ip:本地ip地址，xxx为0 ~ 255的数字，格式为xxx.xxx.xxx.xxx。
- ssid:接入路由器的ssid，长度为1 ~ 32个字符。
- error:包含错误码和消息的对象。
SET_MQTT_PARAMS¶
API 功能:
设置MQTT安全、主机、端口、用户名、密码。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MQTT_PARAMS",
"params": {
"safety": x,
"host": "x",
"port": x,
"username": "x",
"password": "x"
},
"id": 7
}
注意:
-
safety:表示mqtt是否通过TSL/SSL连接，0表示不连接，1表示连接。
-
host:主机名，长度7 ~ 128个字符
-
port:主机端口，取值范围0 ~ 65535
-
username:用户名，长度0 ~ 32个字符
-
password:用户密码，长度0 ~ 64个字符
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 7
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 7
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MQTT_PARAMS¶
API 功能:
获取MQTT安全、主机、端口、用户名、密码。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MQTT_PARAMS",
"id": 8
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"safety": x,
"host": "x",
"port": x,
"username": "x",
"password": "x"
},
"id": 8
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 8
}
注意:
- safety:表示mqtt是否通过TSL/SSL连接，0表示不连接，1表示连接。
- host:主机名，长度7 ~ 128个字符。
- port:主机端口，取值范围0 ~ 65535。
- username:用户名，长度0 ~ 32个字符。
- password:用户密码，长度0 ~ 64个字符。
- error:包含错误码和消息的对象。
SET_MQTT_TOPIC¶
API 功能:
配置comTopic、dataTopic和rspTopic主题。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MQTT_TOPIC",
"params": {
"comtopic": "x",
"datatopic": "x",
"rsptopic": "x"
},
"id": 10
}
注意:
- comtopic:订阅主题命令，不支持中文，长度1 ~ 128个字符。
- datatopic:发布主题，不支持中文，最大长度1 ~ 128个字符。
- rsptopic:取消主题，不支持中文，最大长度1 ~ 128个字符。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 8
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 8
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MQTT_TOPIC¶
API 功能:
获取comTopic, dataTopic和rspTopic主题。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MQTT_TOPIC",
"id": 11
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"comtopic": "x",
"datatopic": "x",
"rsptopic": "x"
},
"id": 11
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 11
}
注意:
- comtopic:订阅主题命令，不支持中文，长度1 ~ 128个字符
- datatopic:发布主题，不支持中文，最大长度1 ~ 128个字符
- rsptopic:取消主题，不支持中文，最大长度1 ~ 128个字符
- error:包含错误码和消息的对象。
SET_MQTT_TI¶
API 功能:
设置MQTT数据上传时间间隔。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MQTT_TI",
"params": {
"intervaltime": x
},
"id": 12
}
注意:
- intervaltime: MQTT数据报告时间间隔，1 ~ 2147483647秒。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 12
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 12
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MQTT_TI¶
API 功能:
获取MQTT数据上传间隔。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MQTT_TI",
"id": 13
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"intervaltime": "x"
},
"id": 13
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 13
}
注意:
- intervaltime: MQTT数据上报时间间隔，取值范围为1 ~ 2147483647秒。
- error:包含错误码和消息的对象。
SET_SNTP_TZ¶
API 功能:
设置设备时区。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_SNTP_TZ",
"params": {
"timezone": "x"
},
"id": 14
}
注意:
- timezone:时区格式，UTC+X或UTC-X (X范围0-12)，默认timezone = UTC+8。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 14
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 14
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_SNTP_TZ¶
API 功能:
获取设备时区。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_SNTP_TZ",
"id": 15
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"timezone": "x"
},
"id": 15
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 15
}
注意:
- timezone:时区格式，UTC+X或UTC-X (X范围0-12)，默认timezone = UTC-8。
- error:包含错误码和消息的对象。
SET_SNTP_SERVER¶
API 功能:
设置SNTP服务器地址。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_SNTP_SERVER",
"params": {
"serverurl": "x"
},
"id": 16
}
注意:
- serverurl: SNTP服务器URL设置，最大长度为1 ~ 128个字符。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 16
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 16
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_SNTP_SERVER¶
API 功能:
获取SNTP服务器地址。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_SNTP_SERVER",
"id": 17
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"serverurl": "x"
},
"id": 17
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 17
}
注意:
- serverurl: SNTP服务器URL设置，最大长度为1 ~ 128个字符。
- error:包含错误码和消息的对象。
SET_AUTO_REBOOT¶
API 功能:
设置自动重启时间和开关状态。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_AUTO_REBOOT",
"params": {
"rststate": x,
"rsttime": "x"
},
"id": 18
}
注意:
- rststate:是否开启每日重启，0表示开启，1表示关闭，占用1字节。
- rsttime:每天重启时间，格式为XX:XX 24小时，范围为00:00 ~ 23:59，占用5个字节。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 18
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 18
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_AUTO_REBOOT¶
API 功能:
获取自动重启时间和开关状态。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_AUTO_REBOOT",
"id": 19
}
注意:
- Data等于null。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"rststate": x,
"rsttime": "x"
},
"id": 19
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 19
}
注意:
- rststate:是否开启每日重启，0表示开启，1表示不开启，占用1字节。
- rsttime:每天重启时间，格式为XX:XX 24小时，范围为00:00 ~ 23:59，占用5个字节。
- error:包含错误码和消息的对象。
SET_MAC_FILTER¶
API 功能:
添加或删除MAC过滤表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MAC_FILTER",
"params": {
"mode": x,
"mac": "x"
},
"id": 20
}
注意:
- mode: 0x00表示添加模式，将MAC字段添加到设备的MAC表中;0x01表示删除模式，将MAC字段从MAC表中删除。
- mac:格式XX:XX:XX:XX:XX, XX范围[0-9a-fA-F]。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 20
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 20
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MAC_FILTER¶
API 功能:
获取MAC过滤表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MAC_FILTER",
"id": 21
}
注意:
- Data等于null。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": [
"x",
"x",
......
],
"id": 21
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 21
}
注意:
- result:数组形式，获取mac过滤表中的所有mac，格式单一:XX:XX:XX, XX范围[0-9a-fA-F]。
- error:包含错误码和消息的对象。
SET_CLN_FILTER¶
API 功能:
添加或删除BLE设备名称过滤表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_CLN_FILTER",
"params": {
"mode": x,
"cln": "x"
},
"id": 22
}
注意:
- mode: 0x00表示添加模式，将AddCLN字段添加到设备的BLE设备名表中;0x01是Delete模式，表示从BLE设备名表中删除AddCLN字段。
- cln:单个设备名称，长度1 ~ 32个字符。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 22
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 22
}
注意:
- result: 0x00表示执行成功;
- error:包含错误码和消息的对象。
GET_CLN_FILTER¶
API 功能:
获取BLE设备名称筛选表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_CLN_FILTER",
"id": 23
}
注意:
- Data等于null
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": [
"x",
"x",
......
],
"id": 23
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 23
}
注意:
- result:它是一个数组，它将获得CLN筛选表中的所有完整本地名称。
- error:包含错误码和消息的对象。
SET_MSD_FILTER¶
API 功能:
添加或删除BLE供应商自定义数据筛选表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MSD_FILTER",
"params": {
"mode": x,
"msd": "x",
},
"id": 24
}
注意:
- mode: 0x00表示添加模式，将AddMSD字段添加到设备的BLE供应商自定义数据表中;0x01是Delete模式，即从BLE供应商自定义数据表中删除AddMSD字段。
- msd:单个BLE厂商定义的数据，长度2 ~ 64个字符，长度必须是2的倍数，字符范围[0-9a-fA-F]。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 24
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 24
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MSD_FILTER¶
API 功能:
获取BLE供应商自定义数据筛选表项。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MSD_FILTER",
"id": 25
}
注意:
- Data等于null
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"addmsd0": "x",
"addmsd1": "x",
......
},
"id": 25
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 25
}
注意:
- result:是一个对象，而addmsd0、addmsd1是单个MSD, MSD过滤表中的所有数据将被打包一起发送。
- error:包含错误码和消息的对象。
UPDATE_MQTT_CERT¶
API 功能:
更新MQTT加密证书。
接收数据段:
{
"jsonrpc": "2.0",
"method": "UPDATE_MQTT_CERT",
"params": {
"mode": x,
"mqttcerturl": "x"
},
"id": 26
}
注意:
-
mode: 0x00立即更新证书，0x01只保存证书URL，不立即更新证书。
-
mqttcerturl: MQTT加密证书URL地址，长度为1 ~ 512个字符。
注: 如果Data段为空，MqttCertURL将恢复到默认配置，并更新证书。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 26
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 26
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
UPDATE_WPA2_CERT¶
API 功能:
更新Wi-Fi WPA2加密证书。
接收数据段:
{
"jsonrpc": "2.0",
"method": "UPDATE_WPA2_CERT",
"params": {
"mode": x,
"wpa2certurl": "x"
},
"id": 27
}
注意:
-
mode: 0x00立即更新证书，0x01只保存证书URL，不立即更新证书。占用1个字符。
-
wpa2certurl: WPA2加密证书的URL地址，长度为1 ~ 512个字符。
注: 如果Data段为空，则将Wpa2CertURL恢复为默认配置，并更新证书。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 27
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 27
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
UPDATE_HTTPS_CERT¶
API 功能:
更新HTTPS加密证书。
接收数据段:
{
"jsonrpc": "2.0",
"method": "UPDATE_HTTPS_CERT",
"params": {
"mode": x,
"httpscerturl": "x"
},
"id": 28
}
注意:
-
mode: 0x00立即更新证书，0x01只保存证书URL，不立即更新证书。占用1个字符。
-
httpscerturl: HTTPS加密证书URL地址，长度为1 ~ 512个字符。
注: 如果Data段为空，则将HttpsCertURL恢复为默认配置，并更新证书。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 28
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 28
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
SET_OTA_URL¶
API 功能:
设置OTA URL。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_OTA_URL",
"params": {
"updatenow": x,
"otaurl": "x"
},
"id": 29
}
注意:
- updatenow:是否立即升级OTA，占用1字节，0保存URL并立即升级，1只保存URL不升级。
- otaurl: OTA升级的服务器链接，长度为1 ~ 512个字符。
- 如果Data段为空，OtaURL会恢复为默认配置，但不会触发OTA。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 29
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 29
}
注意:
- result: 0x00 represent execution success; 0x01 represent execution fail.
- error: It is an object that will contain error codes and messages.
GET_OTA_URL¶
API 功能:
获取OTA URL。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_OTA_URL",
"id": 30
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"otaurl": "x"
},
"id": 30
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 30
}
注意:
- otaurl: OTA升级的服务器链接，长度为1 ~ 512个字符。
- error:包含错误码和消息的对象。
OTA_STATUS¶
API 功能:
OTA完成后的回复结果，OTA完成后由设备发起。
响应数据段:
{
"jsonrpc": "2.0",
"result": 0,
"id": 31
}
注意:
- Result: 0x00表示执行成功;0x01表示执行失败。
GET_DEV_STATUS¶
API 功能:
获取设备Wi-Fi RSSI，网络状态，服务器连接状态。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_DEV_STATUS",
"id": 32
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"wifirssi": x,
"isconnectnetwork": x,
"isconnectserver": x,
"wifimode": x
},
"id": 32
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 32
}
注意:
- wifirstsi:连接路由器的RSSI值，取值范围为-96 ~ 0。
- isconnectnetwork:网络连接状态0x00表示未连接;0x01表示已连接。
- isconnectserver: MQTT服务器连接状态0x00表示未连接;0x01表示已连接。
- wifimode: Wi-Fi连接模式 [0x00 -> 无密码] [0x01 -> wpa2 个人加密] [0x02 -> wpa2 企业加密]
- error:包含错误码和消息的对象。
GET_DEV_MESSAGE¶
API 功能:
获取设备的Wi-Fi MAC, BLE MAC, SN，设备ID，固件版本号。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_DEV_MESSAGE ",
"id": 33
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"wifimac": "x",
"blemac": "x",
"sn": "x",
"deviceid": "x",
"firmwareversion": "x",
"firmwaretype": x
},
"id": 33
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 33
}
注意:
- wifimac:格式XX:XX:XX:XX:XX, XX范围[0-9a-fA-F]。
- blemac:格式XX:XX:XX:XX:XX:XX, XX范围[0-9a-fA-F]。
- sn:设备序列号，长度为16个字符。
- deviceid:设备标识码，长度为7个字符。
- firmwareversion:固件版本号，长度为0 ~ 32个字符。
- firmwaretype: 0表示标准固件，1表示aws固件。
- error:包含错误码和消息的对象。
RESTART_DEV¶
API 功能:
重新启动设备。
接收数据段:
{
"jsonrpc": "2.0",
"method": "RESTART_DEV",
"id": 34
}
注意:
- Data等于null
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 34
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 34
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
RESET_DEV¶
API 功能:
重置设备。
接收数据段:
{
"jsonrpc": "2.0",
"method": "RESET_DEV",
"id": 35
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 35
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 35
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
SET_BLE_RSSI_FILTER¶
API 功能:
设置BLE_RSSI过滤阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_BLE_RSSI_FILTER",
"params": {
"blerssifilter": x
},
"id": 36
}
注意:
- blerssifilter:范围-100 ~ 0。默认值:-100
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 36
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 36
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_BLE_RSSI_FILTER¶
API 功能:
获取BLE_RSSI过滤器阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_BLE_RSSI_FILTER",
"id": 37
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"blerssifilter": x
},
"id": 37
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 37
}
注意:
- blerssifilter:取值范围-100 ~ 0。
- error:包含错误码和消息的对象。
GET_WiFi_AP_LIST¶
API 功能:
获取周围Wi-Fi AP信息的列表。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_WiFi_AP_LIST ",
"id": 38
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"WIFI_AP_LIST": [
{"SSID":"XXXX","RSSI":XXX,"authMode":X},
{"SSID":"XXXX","RSSI":XXX,"authMode":X},
{"SSID":"XXXX","RSSI":XXX,"authMode":X},
......
]
},
"id": 38
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 38
}
注意:
-
error:包含错误码和消息的对象。
-
SSID:路由器名称，字符串形式，有效长度0-32
-
RSSI:路由信号强度，数值型，有效范围-96 ~ 0。
- authMode:路由加密方式，数字类型，有效范围0 ~ 7。含义见下表。
| num | authMode |
|---|---|
| 0 | authenticate mode : open |
| 1 | authenticate mode : WEP |
| 2 | authenticate mode : WPA_PSK |
| 3 | authenticate mode : WPA2_PSK |
| 4 | authenticate mode : WPA_WPA2_PSK |
| 5 | authenticate mode : WPA2_ENTERPRISE |
| 6 | authenticate mode : WPA3_PS |
| 7 | authenticate mode : WPA2_WPA3_PSK |
| - | default |
SET_MQTT_CLIENT_ID¶
API 功能:
获取BLE_RSSI过滤器阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_MQTT_CLIENT_ID",
"params": {
"mqttclientid": "x"
}
"id": 39
}
注意:
- Mqttclientid:设备MQTT客户端id，有效长度为1 ~ 128字节。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 39
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 39
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_MQTT_CLIENT_ID¶
API 功能:
获取BLE_RSSI过滤器阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_MQTT_CLIENT_ID",
"id": 40
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"mqttclientid": "x"
},
"id": 40
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 40
}
注意:
- mqttclientid:设备MQTT客户端id，有效长度为1 ~ 128字节。
- error:包含错误码和消息的对象。
SET_BLE_SCAN_PARAMS¶
API 功能:
获取BLE_RSSI过滤器阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "SET_BLE_SCAN_PARAMS",
"params": {
"scantype": x,
"scaninterval": x,
"scanwindow": x
}
"id": 41
}
注意:
- scantype: 0表示被动扫描，1表示主动扫描。
- scaninterval:扫描间隔定义为从控制器开始最后一次LE扫描到后续LE扫描的时间。范围:4-16384，默认值:80 (50ms)，时间=N * 0.625 m，时间范围:2.5ms~10240ms。
- scanwindow:扫描窗口，LE扫描的持续时间。LE_扫描窗口应该小于或等于LE_扫描间隔。范围:4-16384，默认值:48 (30ms)，时间=N * 0.625 ms，时间范围:2.5 ms~10240ms。
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": 0,
"id": 41
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 41
}
注意:
- result: 0x00表示执行成功;0x01表示执行失败。
- error:包含错误码和消息的对象。
GET_BLE_SCAN_PARAMS¶
API 功能:
获取BLE_RSSI过滤器阈值。
接收数据段:
{
"jsonrpc": "2.0",
"method": "GET_BLE_SCAN_PARAMS",
"id": 42
}
响应数据段:
// success reply
{
"jsonrpc": "2.0",
"result": {
"scantype": x,
"scaninterval": x,
"scanwindow": x
},
"id": 42
}
// fail reply
{
"jsonrpc": "2.0",
"error": {
"code": x,
"message": "x"
},
"id": 42
}
注意:
- scantype: 0表示被动扫描，1表示主动扫描。
- scaninterval:扫描间隔定义为从控制器开始最后一次LE扫描到后续LE扫描的时间。范围:4-16384，默认值:80 (50ms)，时间=N * 0.625 m，时间范围:2.5ms~10240ms。
- scanwindow:扫描窗口，LE扫描的持续时间。LE_扫描窗口应该小于或等于LE_扫描间隔。范围:4-16384，默认值:48 (30ms)，时间=N * 0.625 ms，时间范围:2.5ms~10240ms。
- error:包含错误码和消息的对象。