F´ 框架 Ref 部署中的 Ref::PingReceiver 组件：健康检查 Ping 应答与调试命令实战解析

F´ 框架 Ref 部署中的 Ref::PingReceiver 组件健康检查 Ping 应答与调试命令实战解析【免费下载链接】fprimeF´ - A flight software and embedded systems framework项目地址: https://gitcode.com/GitHub_Trending/fpr/fprimeRef::PingReceiver是 F´F Prime飞行软件框架参考部署Ref deployment中的一个演示型主动组件其核心职责是接收来自 Svc.Health 健康检查组件 的 Ping 请求并回复同时对外暴露一条用于测试目的的禁用 Ping 应答命令。本文将基于 PingReceiver 组件 SDD 文档 为主线结合其 FPP 模型、C 实现 与 Ref 部署拓扑完整讲解该组件的设计、接口、命令、事件、遥测以及它在实际部署中的接线方式帮助读者理解如何在 F´ 框架中构建一个可被健康检查系统周期性探测、且可通过命令人为制造故障的测试组件。Ref::PingReceiver 组件框图1. 组件定位与设计动机Ref::PingReceiver的名字已经说明了它的角色接收 Ping、回复 Ping。它是 F´ 参考部署TestDeploymentsProject/Ref中用于演示组件健康监测机制的一个最小化样例组件常见于演示与教学场景也可作为开发新组件时参考的模板。其设计动机来自 F´ 框架内置的健康检查机制系统中的主动组件Active Component需要周期性地证明自己还活着这一工作由Svc.Health组件承担。Svc.Health通过PingSend端口周期性发出 Ping 请求各被监测组件通过PingReturn端口返回应答若某组件在超时时间内没有应答Svc.Health即判定该组件不健康并上报事件。Ref::PingReceiver就是被Svc.Health监测的组件之一用于验证这条发送 Ping → 接收 Ping → 回复 Ping链路确实工作。与此同时为了让开发者在系统测试时能够验证 Health 的组件失联报警逻辑Ref::PingReceiver提供了PR_StopPings命令用来停止对 Ping 的应答从而人为模拟组件无响应场景。这正是 SDD 中两条需求ISF-PNG-001 / ISF-PNG-002分别对应的功能。2. 需求定义Requirements根据 SDD 第 2 节Ref::PingReceiver的正式需求如下需求编号描述验证方法ISF-PNG-001Ref::PingReceiver组件应对 Ping 请求进行回复系统测试ISF-PNG-002Ref::PingReceiver组件应提供命令以禁用 Ping 应答系统测试两条需求均以系统测试System test为验证手段即需要在 Ref 完整部署上运行通过 F´ GDS地面数据系统发送命令、观察遥测与事件来验证。这从侧面说明了该组件在 Ref 部署中的真实作用是端到端链路验证而非独立单元。3. 组件设计FPP 模型与 C 实现3.1 组件类型主动组件Active Component在 PingReceiver.fpp 中组件被声明为active component PingReceiver。这意味着它是一个拥有独立任务Task和队列Queue的主动组件F´ 会自动为其生成与任务、队列相关的代码骨架。FPP 中对该组件的描述为一个带有输入与输出 Ping 端口的 rate group active component。从部署实例配置instances.fpp可以看到它被赋予了明确的运行时资源instance pingRcvr: Ref.PingReceiver base id 0x10004000 \ queue size Default.QUEUE_SIZE \ stack size Default.STACK_SIZE \ priority 23即实例名为pingRcvr基础 ID 为0x10004000使用默认队列/栈大小任务优先级为 23。这些配置直接决定了该组件实例在 Ref 部署中的运行时行为。3.2 端口接口Ports组件对外端口分为通用端口与特殊端口两大类均在 PingReceiver.fpp 中定义通用端口General Portsasync input port PingIn: Svc.Ping dropPing 输入端口声明为异步async且带drop行为——当组件队列已满时到达的 Ping 请求会被丢弃而不会阻塞发送方output port PingOut: Svc.PingPing 输出端口用于将收到的 Ping 请求转发出去。这里使用的端口类型是Svc.Ping定义于 Svc/Ping/Ping.fppmodule Svc { Port for pinging active components port Ping( key: U32 Value to return to pinger ) }Svc.Ping端口携带一个key: U32参数语义上表示回传给 Ping 发起方的数值用于让发送方能够区分不同的 Ping 请求。特殊端口Special Portscommand recv port CmdDisp命令接收端口command reg port CmdReg命令注册端口command resp port CmdStatus命令响应端口event port Log事件上报端口text event port LogText文本事件端口time get port Time时间获取端口telemetry port Tlm遥测上报端口。这些特殊端口与 SDD 中的组件框图 完全对应——图中可以清晰看到PingIn、PingOut、CmdDisp、CmdReg、CmdStatus、Log、LogText、Time、Tlm等端口。它们是 F´ 组件与框架基础设施命令分发、事件记录、遥测、时间交互的标准通道。3.3 命令PR_StopPings组件对外仅暴露一条命令 Command to disable ping response async command PR_StopPings \ opcode 0命令名PR_StopPingsOpcode 为0声明为async command即命令在组件队列中异步处理功能禁用抑制该组件对 Ping 的应答。对应 C 处理函数位于 PingReceiverComponentImpl.cppvoid PingReceiverComponentImpl::PR_StopPings_cmdHandler(FwOpcodeType opCode, U32 cmdSeq) { this-m_inhibitPings true; this-cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK); }处理逻辑非常直白将成员变量m_inhibitPings置为true并通过cmdResponse_out返回Fw::CmdResponse::OK通知命令分发器命令已成功执行。3.4 事件Events组件定义了两个事件PR_PingsDisabledid 0severity 为activity highevent PR_PingsDisabled \ severity activity high \ id 0 \ format PingReceiver ping responses disabled在PR_StopPings命令执行后可通过log_ACTIVITY_HI_PR_PingsDisabled()上报该事件当前 C 实现中该调用处于注释状态见 PingReceiverComponentImpl.cpp 附近表明它是可选的扩展点。PR_PingReceivedid 1severity 为diagnosticevent PR_PingReceived( code: U32 Ping code ) \ severity diagnostic \ id 1 \ format PingReceiver pinged with code {}该事件携带一个code: U32参数对应收到 Ping 时传入的 key格式字符串为PingReceiver pinged with code {}用于诊断排障。与上一个事件相同其在 C 实现中也以注释形式保留// this-log_DIAGNOSTIC_PR_PingReceived(key);开发者可按需启用。3.5 遥测Telemetry组件定义了一项遥测 Number of pings received telemetry PR_NumPings: U32 id 0PR_NumPings为U32类型Id 为 0表示收到的 Ping 总数。在 C 实现中每当PingIn_handler被调用时都会更新该值见下节。3.6 C 实现核心处理逻辑组件实现类PingReceiverComponentImpl继承自 FPP 自动生成的基类PingReceiverComponentBase维护两个私有状态见 PingReceiverComponentImpl.hppbool m_inhibitPings是否抑制 Ping 应答U32 m_pingsRecvd已收到的 Ping 计数。构造函数将其分别初始化为false与0PingReceiverComponentImpl::PingReceiverComponentImpl(const char* const compName) : PingReceiverComponentBase(compName), m_inhibitPings(false), m_pingsRecvd(0) {}PingIn 输入处理函数PingReceiverComponentImpl.cppvoid PingReceiverComponentImpl::PingIn_handler(const FwIndexType portNum, U32 key) { // this-log_DIAGNOSTIC_PR_PingReceived(key); this-tlmWrite_PR_NumPings(this-m_pingsRecvd); if (not this-m_inhibitPings) { PingOut_out(0, key); } }处理逻辑分三步通过tlmWrite_PR_NumPings更新遥测PR_NumPings计数先使用后自增即第一条遥测值为 0检查m_inhibitPings标志若未被禁用则调用输出端口PingOut_out(0, key)将收到的 key 原样回传给 Ping 发起方从而完成一次 Ping 应答。当PR_StopPings命令被执行后m_inhibitPings变为true此后所有到达的 Ping 请求都只计数、不再转发Svc.Health侧便会因收不到应答而将该组件判定为不健康——这正是 ISF-PNG-002 所要求的通过命令禁用 Ping 应答能力的实现。4. 在 Ref 部署中的接线与运行4.1 实例化在 Ref/Top/instances.fpp 中组件被实例化为pingRcvr基础 ID 为0x10004000任务优先级 23instance pingRcvr: Ref.PingReceiver base id 0x10004000 \ queue size Default.QUEUE_SIZE \ stack size Default.STACK_SIZE \ priority 234.2 拓扑接线在 Ref/Top/topology.fpp 中pingRcvr被纳入 Ref 部署的拓扑实例列表中。其PingIn端口与Svc.Health组件的PingSend端口相连接PingOut端口则连回Svc.Health的PingReturn端口构成完整的 Ping 回路。作为参考Svc.Health在 Health.fpp 中定义的端口如下output port PingSend: [HealthPingPorts] Svc.Ping // 周期性发送 Ping async input port PingReturn: [HealthPingPorts] Svc.Ping // 接收组件应答Ref::PingReceiver也因此被 Ref 部署 SDD 组件清单 描述为一个接收健康检查 Ping、且可被关闭的测试组件。4.3 运行与验证在 Ref 部署运行后读者可通过以下方式验证组件的两条需求验证 ISF-PNG-001正常应答观察 GDS 中pingRcvr.PR_NumPings遥测值持续递增且Svc.Health未上报组件无应答事件说明PingIn → PingOut回路工作正常验证 ISF-PNG-002禁用应答通过 F´ GDS 向pingRcvr发送PR_StopPings命令命令返回Fw::CmdResponse::OK表示执行成功此后PR_NumPings仍会递增但Svc.Health将在超时后上报健康检查失败事件从而验证了组件无响应时健康监测的报警路径。5. 作为新组件模板的参考价值Ref::PingReceiver虽小却覆盖了一个 F´ 主动组件几乎全部的标准要素要素本组件中的体现异步输入端口async input port PingIn: Svc.Ping drop输出端口output port PingOut: Svc.Ping命令定义与处理async command PR_StopPingsPR_StopPings_cmdHandler事件定义PR_PingsDisabled、PR_PingReceived含 severity、id、format遥测定义telemetry PR_NumPings: U32tlmWrite_PR_NumPings特殊端口接线CmdDisp/CmdReg/CmdStatus/Log/LogText/Time/Tlm主动组件运行时配置队列/栈/优先级见 instances.fpp开发者完全可以参照该组件的PingReceiver.fppPingReceiverComponentImpl.{hpp,cpp}组合为自己的组件搭建接收探测 → 状态处理 → 应答/上报的完整骨架并借助 Health 机制获得免费的健康监测能力。6. 变更记录根据 SDD 第 7 节 的变更日志日期说明2017/4/20初始版本组件自 2017 年首次编写以来其接口与行为在 Ref 部署中保持稳定继续承担着演示 Health Ping 链路的职责。【免费下载链接】fprimeF´ - A flight software and embedded systems framework项目地址: https://gitcode.com/GitHub_Trending/fpr/fprime创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考