跳至主要內容

通信协议

vSeasky大约 4 分钟VersaAssistant通信协议VersaAssistant通信协议

通信协议

接口协议说明

  • 以下所有低位在前发送

通信协议格式

帧头数据段帧尾
header(5byte)frame_user((9+(uLen * 4))byte)frame_tail(2byte，crc16，整包校验)

帧头 header 定义

字节偏移 [0]，字节大小 [5byte]

帧头偏移位置字节大小内容
fixed02数据帧起始字节，固定值为 0x5A53
data_length22数据帧 frame_user 中 data 的长度 uLen *4，单位 byte
crc_check41帧头crc校验

数据段 frame_user 定义

字节偏移 [5]，字节大小 [(9+(uLen * 4))byte]

数据偏移位置字节大小功能说明
cmd51功能码。
device_type62模块类型，可以区分传感器、控制器、或产品类型，对于同一个分类，该值一般固定。
device_id84模块ID，可以区分同一个传感器、控制器、或产品的不同个体，一般需要可以设置。
data_id122数据ID，可以指定模块的某类数据，具体由模块本身决定。
data14uLen*4数据

帧尾 frame_tail (crc16，整包校验)

字节偏移 [5 + 9 + (uLen * 4byte)]，字节大小 [2]

帧尾偏移位置字节大小功能说明
frame_tail5 + 9+(uLen * 4byte)2帧尾校验

通信协议依赖文件(CRC8,CRC16算法)

  • bsp_crc16.h
  • bsp_crc16.cpp
  • bsp_crc8.h
  • bsp_crc8.cpp

协议处理文件

  • bsp_protocol.cpp
  • bsp_protocol.h

使用方法

流程

  1. 需要自行实现物理意义的通信功能。
  2. 使用 bsp_protocol 提供的接口进行数据处理，然后通过自己实现的接口进行数据收发。

初始化结构体

// 定义数据发送处理结构体
protocol_struct protocol;
// 初始化协议处理结构体,txMaxCount为允许的最大float可变数据长度，不能大于 MAX_DATA_SIZE = 28
init_protocol(&protocol, txMaxCount);

发送数据

// 设置数据类型
protocol.frame.frame_user.header.cmd = 
protocol.frame.frame_user.header.device_type = 
protocol.frame.frame_user.header.device_id = 
protocol.frame.frame_user.header.data_id = 
// data_len 需要小于 max_data_len 
protocol.frame.frame_user.data.data_len = 
// 设置数据
for(uint16_t row=0;row<protocol.frame.frame_user.data.data_len;row++)
{
    if (row < protocol.frame.frame_user.data.data_len)
    {
        protocol.frame.frame_user.data.pData[row] = 
    }
}
make_protocol(protocol);

// 需要自行实现通信接口，如果是串口，务必使用DMA提升稳定性，非DMA发送的数据时序一般不是连续的，容易断帧
transmit(protocol.message.pData,protocolStruct.message.data_len);

接收数据

receive(your_data,current_len);
memcpy(&pProtocolVersaRx->message.pData[0], your_data, current_len);

// 可以用 result 的值进行数据断帧检查，在此不做演示，断帧检查需要重复遍历，较为消耗资源，建议使用DMA和空闲中断接收方式，实现第一层的数据帧处理。然后再利用 result 进行二次检验
result = parse_protocol(protocol, current_len);
if(result == PROTOCOL_RESULT_OK)
{
    // 使用数据
    protocol.frame.frame_user.header.cmd;
    protocol.frame.frame_user.header.device_type;
    protocol.frame.frame_user.header.device_id;
    protocol.frame.frame_user.header.data_id;
    protocol.frame.frame_user.data.data_len;
    protocol.frame.frame_user.data.pData[];
}

释放资源

deinit_protocol(&protocol);
memset(&protocol, 0, sizeof(protocol));
protocol.frame.frame_user.data.pData = NULL;
protocol.message.pData = NULL;

注意:为了避免数据冲突，如需发送和接收，建议定义两个结构体分别处理数据。

protocol_struct protocolTx;
protocol_struct protocolRx;
init_protocol(&protocolTx, txMaxCount);
init_protocol(&protocolRx, txMaxCount);

案例

Qt中的案例,初始化和数据赋值不做演示。

接收

void VersaPhysicalCom::parseProtocol(QByteArray &data)
{
	int result;
	if (pProtocolVersaRx != nullptr)
	{
		if (lastProtocolStartIndex > 0)
		{
			data.remove(0, lastProtocolStartIndex);
			lastProtocolStartIndex = 0;
		}
		// 获取帧头索引
		startProtocolIndex = data.indexOf(PROTOCOL_HEAD_ID, lastProtocolStartIndex);
		if (startProtocolIndex != -1)
		{
			const char *pParseData = data.constData() + startProtocolIndex;
			int dataSize = data.size();
			
			int currentParseLength = qMin((int) (dataSize - startProtocolIndex),
			                              (int) (pProtocolVersaRx->message.max_data_len));
			
			if ((lastProtocolStartIndex <= startProtocolIndex) &&
			    (currentParseLength >= DATAS_MIN_SIZE))
			{
				memcpy(&pProtocolVersaRx->message.pData[0], pParseData + startProtocolIndex, currentParseLength);
				result = parse_protocol(pProtocolVersaRx, currentParseLength);
				switch (result)
				{
					// 解析成功
					case PROTOCOL_RESULT_OK:
					{
						// 记录成功的位置，下一次的位置在此之后
						lastProtocolStartIndex = startProtocolIndex + pProtocolVersaRx->message.data_len;
						emit refreshProtocolRx();
						// 还可以继续解析
						if (lastProtocolStartIndex + DATAS_MIN_SIZE < dataSize)
						{
							parseProtocol(data);
						}
						break;
					}
					case PROTOCOL_RESULT_ERR:
					{
						// 转到下一个帧头检测
						lastProtocolStartIndex = startProtocolIndex + 2;
						parseProtocol(data);
						break;
					}
					case PROTOCOL_RESULT_CHECK_HEAD_ERR:
					{
						// 转到下一个帧头检测
						lastProtocolStartIndex = startProtocolIndex + 2;
						parseProtocol(data);
						break;
					}
					case PROTOCOL_RESULT_CHECK_FRAME_ERR:
					{
						// 数据帧头检查成功，但是数据损坏，移动到帧头之后检查新数据包，损坏数据包丢弃
						lastProtocolStartIndex = startProtocolIndex + DATAS_OFFSET_ADDR;
						parseProtocol(data);
						break;
					}
					case PROTOCOL_RESULT_OUT_OF_MSG_LEN:
					{
						// 超出解析长度，数据包出错，解析下一个数据包
						lastProtocolStartIndex = startProtocolIndex + DATAS_OFFSET_ADDR;
						parseProtocol(data);
						break;
					}
					case PROTOCOL_RESULT_OUT_OF_DATA_LEN:
					{
						// 通过包头计算，还未收到完整的数据包，等待下一个数据包来即可。
						break;
					}
					default:
					{
						// 转到下一个帧头检测
						lastProtocolStartIndex = startProtocolIndex + 2;
						parseProtocol(data);
					}
				}
			}
		}
	}
}

发送

// const QString &address, quint16 port 是网络调试模式需要的参数，和协议无关
void VersaPhysicalCom::protocolVersaWrite(const QString &address, quint16 port)
{
	if (pProtocolVersaTx != nullptr)
	{
		make_protocol(pProtocolVersaTx);
		QByteArray writeData(reinterpret_cast<char *>(&pProtocolVersaTx->message.pData[0]),
		                     pProtocolVersaTx->message.data_len);
		// 124 字节只能收到 62字节，感觉是WIN的bug
		if (pProtocolVersaTx->message.data_len == 124)
		{
			writeData.append('\0');
		}
		if ((mVersaProtocolIndex == eProtocolVersa) &&
		    (writeData.size() > 0))
		{
			startWrite(address, port, writeData);
		}
	}
}

协议支持的通信方式

本软件所有通信方式均支持协议模式

  • 串口通信
  • 网络通信
    • TCP Server
    • TCP Client
    • UDP
  • USB通信
    • HID
使用 VuePress Theme Hope 主题 | MIT 协议, 版权所有 © 2022-present vSeasky
Copyright © 2024 vSeasky