docs: add detailed Chinese comments for code files and correct GPIO mapping table in main.md

This commit is contained in:
Antigravity IDE
2026-07-16 17:52:52 +08:00
parent afd59d28ee
commit ddd001b90b
26 changed files with 32803 additions and 53495 deletions

View File

@@ -4,13 +4,66 @@
#include "../App/config.h"
#include "stc32g.h"
// Public RF functions
/* ====== LR690L / EV1527 无线射频编解码驱动接口 ====== */
/**
* @brief 初始化无线射频芯片相关的 GPIO 引脚
* @details 配置 RF_TX_DAT (P3.6) 为推挽输出,配置 RF_TX (P2.0)、RF_RX (P3.7)、SHUT (P2.2) 等引脚,
* 使能 ATR5179 射频前端开关,为无线射频收发建立硬件基础。
*/
void RF_Init(void);
void RF_SetMode(u8 mode); // mode: 0=Sleep, 1=Rx, 2=Tx
/**
* @brief 配置无线射频收发系统的运行模式
* @param mode 0-休眠模式 (Sleep)1-接收模式 (Rx)2-发射模式 (Tx)
* @details 负责联合调度 SHUT 控制引脚、天线切换使能引脚以及 ATR5179 射频开关:
* - 模式 0 (Sleep): 拉高 SHUT 以关断 LR690L 芯片电源,实现零电流待机。
* - 模式 1 (Rx): 拉低 SHUT 启动 LR690L 芯片,接通天线并配置前端为接收放大状态。
* - 模式 2 (Tx): 切换天线前端开关为发射直通状态,准备调制发送。
*/
void RF_SetMode(u8 mode);
/**
* @brief 按照 EV1527 协议单次调制发送一帧 24 位射频数据
* @param addr 24 位发射源地址
* @param dat 4 位命令状态数据码
* @details 会生成由 1 个同步码 (Sync Code) 和 24 个数据编码(由 addr + dat 组成)组成的完整帧脉冲。
*/
void EV1527_TxFrame(u32 addr, u8 dat);
/**
* @brief 连续多次发送 EV1527 射频帧,防止单帧丢失
* @param addr 24 位源地址
* @param dat 4 位命令状态码
* @details 连续发送多次以保证无线通信在嘈杂噪声环境下的接收可靠性。
*/
void EV1527_Transmit(u32 addr, u8 dat);
/**
* @brief 获取特定引脚电平状态的持续微秒时间
* @param state 待检测的电平目标状态 (0-低电平, 1-高电平)
* @param timeout_us 最大等待超时上限 (单位: 微秒)
* @return u16 最终测得的脉冲宽度时长。如果超出 timeout_us 仍未改变电平,则直接返回超时值。
*/
u16 GetPulseDuration(u8 state, u16 timeout_us);
/**
* @brief 阻塞式检测并解码一个合法的 EV1527 射频信号数据帧
* @param out_addr 输出参数指针:若解码成功,将写入解析得到的 20 位发送地址 (即 24 位帧除去 4 位数据位后的剩余高 20 位)
* @param out_data 输出参数指针:若解码成功,将写入解析出的 4 位命令状态数据码 (例如报警/SOS等)
* @return bit 1-成功解析出一帧有效数据0-当前未捕获到合法脉冲或校验失败
* @note 此函数通过对 P2.1 (RF_RX_DATA) 输入脉冲宽度进行软件精密测量,定位同步头,依次采集 24 个数据位,并进行 3 次重复性去噪校验。
*/
bit EV1527_Decode(u32 *out_addr, u8 *out_data);
/**
* @brief 串口与射频功能的回环测试函数 (调试使用)
*/
void Loopback_Test(void);
#endif
/**
* @brief 射频控制引脚的高低电平输出极性测试 (硬件排查使用)
*/
void RF_Test_Pin(void);
#endif // __RF_H__