neozng1@hnu.edu.cn
- -> TODO: -> -> 1. 补全标志位解析和发送设置的代码 -> 2. 增加发送给视觉数据的时间戳用于数据对齐 - - - -## 总览和封装说明 - -模块包含了和视觉通信的初始化、向上位机发送信息的接口和模块的串口的回调处理。接口的定义统一，可以方便的替换成其他通信方式，如CAN。 - -## 代码结构 - -.h文件内包括了外部接口和与**视觉上位机通信的数据结构定义**，以及模块对应的宏。c文件内为私有函数和外部接口的定义。 - -本模块主要是对协议解析的处理和协议发送的封装，实际内容不多。协议相关内容都在`seasky_protocol.h`中。 - -## 类型定义 - -和视觉通信所必须的标志位和数据。包括开火模式，目标状态，目标类型，接收/发送数据结构体。 - -```c -typedef enum -{ - NO_FIRE = 0, - AUTO_FIRE = 1, - AUTO_AIM = 2 -} Fire_Mode_e; - -typedef enum -{ - NO_TARGET = 0, - TARGET_CONVERGING = 1, - READY_TO_FIRE = 2 -} Target_State_e; - -typedef enum -{ - NO_TARGET_NUM = 0, - HERO1 = 1, - ENGINEER2 = 2, - INFANTRY3 = 3, - INFANTRY4 = 4, - INFANTRY5 = 5, - OUTPOST = 6, - SENTRY = 7, - BASE = 8 -} Target_Type_e; - -typedef struct -{ - Fire_Mode_e fire_mode; - Target_State_e target_state; - Target_Type_e target_type; - - float pitch; - float yaw; -} Vision_Recv_s; - -typedef enum -{ - BLUE = 0, - RED = 1 -} Enemy_Color_e; - -typedef enum -{ - MODE_AIM = 0, - MODE_SMALL_BUFF = 1, - MODE_BIG_BUFF = 2 -} Work_Mode_e; - -typedef enum -{ - BIG_AMU_10 = 10, - SMALL_AMU_15 = 15, - BIG_AMU_16 = 16, - SMALL_AMU_18 = 18, - SMALL_AMU_30 = 30, -} Bullet_Speed_e; - -typedef struct -{ - Enemy_Color_e enemy_color; - Work_Mode_e work_mode; - Bullet_Speed_e bullet_speed; - - float yaw; - float pitch; - float roll; -} Vision_Send_s; -``` - -## 外部接口 - -```c -Vision_Recv_s *VisionInit(UART_HandleTypeDef *_handle); - -void VisionSend(Vision_Send_s *send); -``` - -给`VisionInit()`传入串口handle，将初始化一个视觉通信模块，返回值是接收数据的结构体指针。拥有视觉模块的应用应该在初始化中调用此函数，并保存返回值的指针。 - -调用`VisionSend`并传入填好发送数据的结构体，会通过底层的通信模块向视觉发送一帧报文。 - -## 私有函数和变量 - -```c -static Vision_Recv_s recv_data; - -static usart_instance *vision_usart_instance; - -static void DecodeVision() -{ - static uint16_t flag_register; - get_protocol_info(vision_usart_instance->recv_buff, &flag_register, (uint8_t*)&recv_data.pitch); - // TODO: code to resolve flag_register; -} -``` - -第一个是保存接收数据的结构体，其指针将会在初始化的时候返回给拥有者。目前最多只能配置一个视觉模块。 - -第二个是该模块拥有的串口实例指针，用于调度其底层的发送和接收。如果要换成CAN/SPI等，替换成对应实例，并修改初始化和发送的实现即可。 - -`DecodeVision()`是解析视觉接收数据的回调函数，会在串口接收回调中被调用。如果修改通信协议，只需要更改 - -`get_protocol_info()`。 \ No newline at end of file diff --git a/modules/master_machine/seasky_protocol.c b/modules/master_machine/seasky_protocol.c deleted file mode 100644 index 85304dd..0000000 --- a/modules/master_machine/seasky_protocol.c +++ /dev/null @@ -1,133 +0,0 @@ -/** - * @file seasky_protocol.c - * @author Liu Wei - * @author modified by Neozng - * @brief 湖南大学RoBoMatster串口通信协议 - * @version 0.1 - * @date 2022-11-03 - * - * @copyright Copyright (c) 2022 - * - */ - -#include "seasky_protocol.h" -#include "crc8.h" -#include "crc16.h" -#include "memory.h" - -/*获取CRC8校验码*/ -uint8_t Get_CRC8_Check(uint8_t *pchMessage,uint16_t dwLength) -{ - return crc_8(pchMessage,dwLength); -} -/*检验CRC8数据段*/ -static uint8_t CRC8_Check_Sum(uint8_t *pchMessage, uint16_t dwLength) -{ - uint8_t ucExpected = 0; - if ((pchMessage == 0) || (dwLength <= 2)) - return 0; - ucExpected = crc_8(pchMessage, dwLength - 1); - return (ucExpected == pchMessage[dwLength - 1]); -} - -/*获取CRC16校验码*/ -uint16_t Get_CRC16_Check(uint8_t *pchMessage,uint32_t dwLength) -{ - return crc_16(pchMessage,dwLength); -} - -/*检验CRC16数据段*/ -static uint16_t CRC16_Check_Sum(uint8_t *pchMessage, uint32_t dwLength) -{ - uint16_t wExpected = 0; - if ((pchMessage == 0) || (dwLength <= 2)) - { - return 0; - } - wExpected = crc_16(pchMessage, dwLength - 2); - return (((wExpected & 0xff) == pchMessage[dwLength - 2]) && (((wExpected >> 8) & 0xff) == pchMessage[dwLength - 1])); -} - -/*检验数据帧头*/ -static uint8_t protocol_heade_Check(protocol_rm_struct *pro, uint8_t *rx_buf) -{ - if (rx_buf[0] == PROTOCOL_CMD_ID) - { - pro->header.sof = rx_buf[0]; - if (CRC8_Check_Sum(&rx_buf[0], 4)) - { - pro->header.data_length = (rx_buf[2] << 8) | rx_buf[1]; - pro->header.crc_check = rx_buf[3]; - pro->cmd_id = (rx_buf[5] << 8) | rx_buf[4]; - return 1; - } - } - return 0; -} - -/* - 此函数根据待发送的数据更新数据帧格式以及内容，实现数据的打包操作 - 后续调用通信接口的发送函数发送tx_buf中的对应数据 -*/ -void get_protocol_send_data(uint16_t send_id, // 信号id - uint16_t flags_register, // 16位寄存器 - float *tx_data, // 待发送的float数据 - uint8_t float_length, // float的数据长度 - uint8_t *tx_buf, // 待发送的数据帧 - uint16_t *tx_buf_len) // 待发送的数据帧长度 -{ - static uint16_t crc16; - static uint16_t data_len; - - data_len = float_length * 4 + 2; - /*帧头部分*/ - tx_buf[0] = PROTOCOL_CMD_ID; - tx_buf[1] = data_len & 0xff; // 低位在前 - tx_buf[2] = (data_len >> 8) & 0xff; // 低位在前 - tx_buf[3] = crc_8(&tx_buf[0], 3); // 获取CRC8校验位 - - /*数据的信号id*/ - tx_buf[4] = send_id & 0xff; - tx_buf[5] = (send_id >> 8) & 0xff; - - /*建立16位寄存器*/ - tx_buf[6] = flags_register & 0xff; - tx_buf[7] = (flags_register >> 8) & 0xff; - - /*float数据段*/ - for (int i = 0; i < 4 * float_length; i++) - { - tx_buf[i + 8] = ((uint8_t *)(&tx_data[i / 4]))[i % 4]; - } - - /*整包校验*/ - crc16 = crc_16(&tx_buf[0], data_len + 6); - tx_buf[data_len + 6] = crc16 & 0xff; - tx_buf[data_len + 7] = (crc16 >> 8) & 0xff; - - *tx_buf_len = data_len + 8; -} -/* - 此函数用于处理接收数据， - 返回数据内容的id -*/ -uint16_t get_protocol_info(uint8_t *rx_buf, // 接收到的原始数据 - uint16_t *flags_register, // 接收数据的16位寄存器地址 - uint8_t *rx_data) // 接收的float数据存储地址 -{ - // 放在静态区,避免反复申请栈上空间 - static protocol_rm_struct pro; - static uint16_t date_length; - - if (protocol_heade_Check(&pro, rx_buf)) - { - date_length = OFFSET_BYTE + pro.header.data_length; - if (CRC16_Check_Sum(&rx_buf[0], date_length)) - { - *flags_register = (rx_buf[7] << 8) | rx_buf[6]; - memcpy(rx_data, rx_buf + 8, pro.header.data_length - 2); - return pro.cmd_id; - } - } - return 0; -} diff --git a/modules/master_machine/seasky_protocol.h b/modules/master_machine/seasky_protocol.h deleted file mode 100644 index 5c24c43..0000000 --- a/modules/master_machine/seasky_protocol.h +++ /dev/null @@ -1,36 +0,0 @@ -#ifndef __SEASKY_PROTOCOL_H -#define __SEASKY_PROTOCOL_H - -#includeSeasky LIUWei
- -modified by neozng1@hnu.edu.cn
- -可用于视觉，以及其他自研模块（仅限串口通信） - -> TODO: -> -> 1. 利用F4自带的硬件CRC模块计算校验码，提高速度 -> 2. 增加更多的数据类型支持，使得数据类型也为可配置的 - -## 一、串口配置 - -通信方式是串口，配置为波特率 921600，8 位数据位，1 位停止位，无硬件流控，无校验位。 - -## 二、数据帧说明 - -以下所有低位在前发送，数据长度可变。 - -1. 通信协议格式 - - | 帧头 | 数据ID | 数据 | 帧尾 | - | ----------------------- | -------------- | ------------- | :---------------------------------- | - | protocol_header(4-byte) | cmd_id(2-byte) | data (n-byte) | frame_tail(2-byte，CRC16，整包校验) | - -2. 帧头详细定义 - - | 帧头 | 偏移位置 | 字节大小 | 内容 | - | ----------- | -------- | -------- | ----------------------------- | - | sof(CMD) | 0 | 1 | 数据帧起始字节，固定值为 0xA5 | - | data_length | 1 | 2 | 数据帧中 data 的长度 | - | crc_check | 3 | 1 | 帧头CRC校验 | - -3. cmd_id 命令码 ID 说明 **(字节偏移 4，字节大小 2)** - - | 命令码 | 数据段长度 | 功能说明 | - | -------------- | --------------- | -------- | - | 0x0001(可修改) | 2 byte (16-bit) | 视觉数据 | - | ....... | | | - -4. 数据段data (n-byte) - - | 数据 | 偏移位置 | 字节大小 | 内容 | - | -------------- | -------- | --------------- | ------------------------------------- | - | flags_register | 6 | 2 | 16位标志置位寄存器 | - | float_data | 8 | 4 * data_length | float数据内容（4 * data_length-byte） | - -5. frame_tail(CRC16，整包校验) - -## 三、协议接口说明 - -```c -/*更新发送数据帧，并计算发送数据帧长度*/ -void get_protocol_send_data(uint16_t send_id, //信号id - uint16_t flags_register, // 16位寄存器 - float *tx_data, //待发送的float数据 - uint8_t float_length, // float的数据长度 - uint8_t *tx_buf, //待发送的数据帧 - uint16_t *tx_buf_len); //待发送的数据帧长度 -``` - -将float_data字段准备好放入`tx_data[]`并设置好标志位`flags_register`之后，调用此函数。它将计算循环冗余校验码，并把数据转换成串口发送的格式，放在`tx_buf[]`中。 - -```c -/*接收数据处理*/ -uint16_t get_protocol_info(uint8_t *rx_buf, //接收到的原始数据 - uint16_t *flags_register, //接收数据的16位寄存器地址 - float *rx_data); //接收的float数据存储地址 -``` - -将收到的一包原始数据buff地址传入，若校验通过，会把收到的标志位和float数据解析出来，保存在`flags_register*`和 `rx_data[]`中。 \ No newline at end of file