diff --git a/通讯协议-平台化-应用部分[内部].md b/通讯协议-平台化-应用部分[内部].md index 3a1feee..79e4e54 100644 --- a/通讯协议-平台化-应用部分[内部].md +++ b/通讯协议-平台化-应用部分[内部].md @@ -32,7 +32,7 @@ SunVote 二次开发
通讯协议

-Ver 1.0.7 +Ver 1.0.8


@@ -48,7 +48,7 @@ Ver 1.0.7
-二〇二五年六月 +二〇二五年七月

@@ -74,6 +74,7 @@ Ver 1.0.7 |1.0.5| 2025年6月5日|刘琴|1. 增加语音题接口
2. 增加拍照反馈接口
3. 增加锁定解锁白名单
4. 增加基站容量、基站加密(内部指令)| |1.0.6| 2025年6月18日|刘琴|1. 增加遥控修改键盘配对码
2. 增加设置基站是否自动清除白名单| |1.0.7| 2025年6月24日|刘琴|1. 增加自定义科目名称和清除科目名称
2. 增加控制键盘灯光、震动、蜂鸣(T2)
3. 增加空闲标题下发(T2)
4. 增加下发和清除分数(T2)| +|1.0.8| 2025年7月8日|刘琴|1. 增加读写基站MAC地址(内部)|

@@ -238,6 +239,8 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ||设置基站AES加密状态(内)|[setBsAES](#setbsaes)|[fEvtBsAES](#fevtbsaes)| |网络设置 - TCP/IP参数|获取TCP/IP参数|[getBsTcpipParams](#getbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)| ||设置TCP/IP参数|[setBsTcpipParams](#setbstcpipparams)|[fEvtBsTcpipParams](#fevtbstcpipparams)|| +||获取基站Mac地址(内)|[getBsMac](#getbsmac)|[fEvtBsMac](#fevtbsmac)|| +||设置基站Mac地址(内)|[setBsMac](#setbsmac)|[fEvtBsMac](#fevtbsmac)|| |网络设置 - MQTT参数|获取MQTT参数|[getBsMqttParams](#getbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)| ||设置MQTT参数|[setBsMqttParams](#setbsmqttparams)|[fEvtBsMqttParams](#fevtbsmqttparams)|| |基站维护|获取基站日志信息(内)|[getBsLogInfo](#getbsloginfo)|[sEvtStateCode](#sevtstatecode)
[fEvtBsLogInfo](#fevtbsloginfo)| @@ -308,7 +311,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 ### 拍照反馈 |功能归类|功能|API指令|指令事件| |---|---|---|---| -|拍照反馈-单题拍照反馈|启动单题拍照反馈|[startQAPhoto](#startQAPhoto)|[sEvtStateCode](#sevtstatecode)
[fEvtPhotoFile](#fEvtPhotoFile)| +|拍照反馈-单题拍照反馈|启动单题拍照反馈|[startQAPhoto](#startqaphoto)|[sEvtStateCode](#sevtstatecode)
[fEvtPhotoFile](#fEvtphotofile)| ||停止单题拍照反馈|[stopKpVote](#stopkpvote)|[sEvtStateCode](#sevtstatecode)| ### 在线测验 |功能归类|功能|API指令|指令事件| @@ -2710,6 +2713,51 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 } } ``` + +##### getBsMac +- **主题**:/manage/{baseSN}/send +- **功能描述**:获取基站MAC地址 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| + +- **示例代码** +```json +{ + "fun":"getBsMac", + "dataTag":"1", + "baseSn":"2024061101" +} +``` +##### setBsMac +- **主题**:/manage/{baseSN}/send +- **功能描述**:设置基站MAC地址 +- **参数说明** + +|参数名|类型|限制|是否必填|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+value|string||否|MAC地址| + +- **示例代码** +```json +{ + "fun":"setBsMac", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "value":"FF:FF:FF:FF:FF:FF" + } +} +``` + ##### getBsMqttParams - **主题**:/client/{baseSN}/send - **功能描述**:获取基站MQTT参数 @@ -2794,6 +2842,32 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 } } ``` + +##### fEvtBsMac +- **主题**: /manage/{baseSN}/receive +- **功能描述**:返回基站TCP/IP参数 +- **参数说明** + +|参数名|类型|限制|非空|说明| +|---|---|---|---|---| +|fun|string|-|是|指令名称| +|dataTag|string|-|否|数据包标识,可为空字符串| +|baseSn|string||是|基站的出厂编码| +|data|object|-|是|传送参数的对象| +|+value|string||是|MAC地址| + +- **示例代码** +```json +{ + "fun":"fEvtBsMac", + "dataTag":"1", + "baseSn":"2024061101", + "data":{ + "value":"FF:FF:FF:FF:FF:FF" + } +} +``` + ##### fEvtBsMqttParams - **主题**: /basestation/{baseSN}/receive - **功能描述**:返回基站MQTT参数 @@ -3644,7 +3718,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象数组| -|+keySns|array||否|需要清除分数的键盘SN数组,
空数组表示清空所有键盘| +|+keySns|array||否|需要清除分数的键盘SN数组
空数组表示清空所有键盘| - **示例代码** @@ -4406,7 +4480,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |dataTag|string|-|否|数据包标识,可为空字符串| |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象数组| -|+keySns|array||否|需要清除绑定信息键盘SN数组,
空数组表示清空所有键盘| +|+keySns|array||否|需要清除绑定信息键盘SN数组
空数组表示清空所有键盘| - **示例代码** @@ -5442,11 +5516,6 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象| |+keySns|array||是|指定的键盘SN数组,空数组表示全部在线键盘| -|+mode|int||是|拍照模式(预留)
0 - 普通拍照(默认值)| -|+submitTimes|int||是|允许提交次数,0-255
0 - 不限次数| -|+format|int||否|拍照格式
0 - 图片文件| -|+imgFormat|int||否|图片格式
0 - bmp
1 - jpg(默认值1)
2 - png| -|+tip|string||否|提示的标题,长度不超过16字符| - **示例代码** ```json @@ -5455,12 +5524,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 "dataTag":"1", "baseSn":"2024061101", "data": { - "keySns": [], - "mode":0, - "submitTimes":0, - "format":0, - "imgFormat":1, - "tip":"请拍照提交" + "keySns": [] } } ``` @@ -6060,7 +6124,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象数组| |+type|int||是|需要清除自定义标题的题目类型
0-所有题型| -|+keySns|array||否|需要清除键盘自定义测验题型标题的键盘SN数组,
空数组表示清空所有键盘| +|+keySns|array||否|需要清除键盘自定义测验题型标题的键盘SN数组
空数组表示清空所有键盘| - **示例代码** ```json @@ -6208,7 +6272,7 @@ WebSocket方式应用与SDK建立长连接后,通过WebSocket接口发送接 |baseSn|string||是|基站的出厂编码| |data|object|-|是|传送参数的对象数组| |+index|int||是|需要清除自定义科目名称的类型
0 : 所有科目
1-12 : 指定的科目序号| -|+keySns|array||否|需要清除键盘自定义科目名称的键盘SN数组,
空数组表示清空所有键盘| +|+keySns|array||否|需要清除键盘自定义科目名称的键盘SN数组
空数组表示清空所有键盘| - **示例代码** ```json