Holarch

指南 · 接口

接口控制文档 (ICD):包含哪些内容以及如何保持最新

收听本指南(英文音频) 20 分钟

接口控制文档记录跨越系统两部分之间边界的内容,并使双方团队受同一定义的约束。本指南介绍 ICD 包含哪些内容、由谁负责、如何首先找出接口,以及如何在设计变化时使文档与设计保持一致,并以一颗小型对地观测卫星的两个子系统为实例。

本页内容
  1. 什么是接口控制文档
  2. ICD 由谁负责
  3. ICD 包含哪些内容
    1. 数据和时序最需要详细说明
    2. 验证接口本身
  4. 在架构中找出接口
  5. 使 ICD 与模型保持关联
  6. 接口变更控制
  7. 常见失效模式
  8. 实例:CubeSat 上 C&DH 到通信系统的接口
    1. 找出交换
    2. 链路及其承载的内容
    3. 接口图
    4. 生成的 ICD
    5. 实例说明了什么
  9. 在 Holarch 中试用
  10. 后续阅读

什么是接口控制文档

大多数集成问题并不在子系统内部,而在两个子系统之间的接缝处。一个团队假定连接器朝一个方向键控,另一个团队假定方向相反。一方每 100 ms 发送一条状态消息,另一方的超时却是 80 ms。接口控制文档的作用就是让这个接缝清晰可见:它在双方都认可的一个地方说明双方之间传递什么,以及在什么条件下传递。

ICD 从外部描述接口。它不说明任何一方如何构建,只说明每一方必须在边界上提供什么:连接器及其引脚、电压和电流、消息格式和时序、安装点、接口必须承受的环境。然后每个团队设计自己的一方与之匹配。

有三个相关的文档名称经常被混淆:

文档回答典型内容
接口需求规格说明 (IRS)接口必须做什么?针对一个或多个接口的需求,在设计确定之前以可验证的“shall”陈述编写。
接口设计说明 (IDD)一方如何实现它?由一方实现的接口设计,通常是一个软件项或硬件项,其详细程度足以构建和测试它。
接口控制文档 (ICD)双方达成了什么一致?两个特定方之间受控的、经双方共同批准的接口定义,处于变更控制之下。

各项目对这些文档的组合方式不同。有些将需求并入 ICD;有些先尽早编写 IRS,然后在设计成熟后编写 ICD。重要的是需求和已商定的定义都有记录,并且明确其中哪一个起控制作用。

ICD 由谁负责

ICD 有两方(有时更多)和唯一的负责人。各方是负责每一侧的组织或团队:两个子系统团队、总承包商和供应商、飞行器团队和有效载荷团队。负责人是维护文档、跟催未关闭事项并主持审批的个人或小组。在较大的项目中,这是接口控制工作组 (ICWG):由每一方的代表加上负责集成的系统工程师组成,定期开会。

几条归属规则可以避免大多数争议:

  • 每个接口一个负责人,并在文档中写明。“系统团队”不是负责人;一位具名的负责人才是。
  • 双方都要批准。只有一方签字的 ICD 是愿望清单,而不是控制文档。
  • 负责集成的层级拥有其下级之间的接口。两个子系统之间的接口属于系统级,因为两个子系统都无法单独确定它。
  • 外部接口,即与项目之外的设备或系统之间的接口,由项目一方负责,并与外部方商定;外部方可能有自己的文档,且该文档具有优先效力。

ICD 包含哪些内容

确切的大纲取决于领域和项目的标准,但完整的 ICD 涵盖的内容是相同的。保留不适用的章节并注明“不适用”,而不是删除它,这样评审者就能看出它已被考虑过。

章节记录内容
标识和各方接口编号和名称、双方、负责人、文档状态和审批。
接口概述一张显示双方及其之间每条链路的图,以及对接口目的的简短说明。
接口清单每条单独的链路(线束、总线、线路、管路、安装),各有编号、端点和状态。
机械和物理安装点和螺栓孔位、包络和禁入区、接口处的质量特性、对准、连接器类型和位置。
电气引脚分配、电压和电流范围、电能质量、接地和搭接、屏蔽、隔离、信号电平。
数据和协议协议和物理层,包含字段名称、类型、范围、单位和比例因子的消息定义,标识符,错误处理。
时序消息速率和周期、延迟预算、启动和唤醒顺序、超时以及超时发生时各方的处理方式。
流体、热和光学边界处的流量、压力和温度,跨越边界传递的热量,光路和视场(如适用)。
环境接口必须承受的振动、冲击、温度、湿度、防护和电磁兼容条件。
接口需求接口必须满足的需求,每条都追溯到其父需求。
验证每条需求在接口处如何验证(测试、分析、检查、演示)、在哪个级别验证以及使用哪些设备。
未关闭事项每个 TBD(尚未确定的数值)和 TBR(已提出但尚未确认的数值),各有负责人和关闭日期。
变更历史每个修订版及其变更请求、更改内容以及由谁批准。

数据和时序最需要详细说明

机械接口和电气接口往往很早就会在配合检查和首次加电时得到实物检查。数据和时序的不匹配则会存在得久得多,常常直到系统集成,因为每一方都是对照自己根据对文档的理解构建的模拟器进行测试的。对于每条消息,都要写下标识符、周期及其容差、每个字段的类型、范围、单位和比例因子、字节顺序,以及消息迟到、缺失或超出范围时接收方的处理方式。只写“电池电流”而没有单位、符号约定(充电为正还是放电为正)和分辨率的消息定义,还不能算受控。

验证接口本身

接口需求的验证方式与其他需求相同(需求验证矩阵指南介绍了方法、级别和证据),但证据有一种特殊的形式:它需要双方。真实单元之间的兼容性测试,或一个真实单元与另一方经过确认的仿真器之间的兼容性测试,比按照对 ICD 的两种私下理解分别进行的两项测试更有说服力。在 ICD 中规划这些测试,以便在需要时设备和进度安排都已到位。

在架构中找出接口

ICD 只能控制已被找出的接口。找出接口的可靠方法是从架构出发,而不是凭记忆。

  1. 从功能开始。将任务分解为功能及其输入和输出(功能分析指南介绍了方法)。N² 图将功能(或子系统)放在对角线上;第 A 行、第 B 列的单元格包含 A 发送给 B 的内容。每个已填写的非对角线单元格都是一个需要路径的交换。已填写单元格的聚集显示哪些功能属于一组;繁忙的行或列标示出许多其他功能所依赖的功能。
  2. 将功能分配给组件。一旦每个功能都由一个物理部件执行,位于不同部件中的功能之间的每个交换就都成为跨越部件边界的交换。系统架构指南介绍了如何进行和检查这种分配。
  3. 为每个跨越边界的交换提供物理路径。线束、总线、无线电链路、管路或机械连接。没有路径的交换是设计中的缺口;不承载任何内容的路径要么是不必要的,要么是尚未被理解的。
  4. 绘制接口图。对于每一对参与方,显示双方、双方在边界处的内部部件,以及每条链路及其承载的内容。这就成为 ICD 的概述图。

在找出接口时就为其编号。下面的实例将其链路编号为 IF-01 到 IF-25,并为较大接口内部的链路使用小数编号(IF-14 内部的 IF-14.1)。编号使接口能够在需求、测试程序和变更请求中被引用,并在名称变化时保持接口清单的稳定。

使 ICD 与模型保持关联

作为独立文字处理文件编写的 ICD,从获批之日起就开始与设计脱节。线束图中某个引脚被重新分配,软件中某个消息周期发生变化,为一项后来的需求增加了一个新信号,而 ICD 要过几周才更新,甚至根本不更新。于是评审者只能拿文档与文档相互比较,而不是与设计比较。

基于模型的系统工程扭转了这种局面。每个接口都是系统模型中的一个元素,连接到其两个端点、它承载的项以及约束它的需求。ICD 是根据这些元素生成的报告。于是:

  • 同一条链路在 ICD、接口图、需求追溯和验证矩阵中以相同的数值出现,因为它们读取的都是同一个定义。
  • 对消息速率或连接器的更改会出现在下一次生成的 ICD 中,变更历史来自模型自身的记录。
  • 检查在模型上运行:两个部件之间没有链路承载的交换、只有一个端点的链路、负载超过容量的链路、没有负责人或状态的链路。
  • 针对接口的需求会追溯到该接口,因此 ICD 的需求和验证章节保持完整(关联类型和缺口检查参见需求可追溯性指南)。

并非所有内容都适合放在模型属性中。详细的连接器图纸、时序图和冗长的消息目录可以保留在附件或引用的文档中。模型仍然保存接口、其状态、负责人和引用,因此生成的 ICD 会指向正确的修订版。

接口变更控制

接口定义是逐步成熟的,所处的阶段决定了如何处理变更。一个简单的四阶段方案适用于大多数项目:

状态含义如何进行更改
草稿一方的初步定义。负责人可自由编辑。
已提议已提交给另一方评审。更改在工作组中讨论并记录。
已商定双方都已接受;设计可以据此推进。更改需要双方同意,并附有对每一方的影响说明。
已纳入基线属于已批准的配置基线的一部分。正式的变更请求,由变更委员会评估和批准,并重新发布 ICD。

常见的节奏是:在系统需求评审前起草接口,在初步设计评审前达成一致,在关键设计评审前纳入基线。无论采用何种节奏,针对已纳入基线接口的变更请求都应说明原因、受影响的链路和条目、对每一方的设计、成本和进度的影响、受影响的需求和验证,以及适用性:变更从哪个构建版本或序列号开始适用。如何找出并评估这些影响,变更影响分析指南中有逐步说明。

将 TBD 和 TBR 作为一份必须不断缩短的清单来跟踪。到关键设计评审时仍充满未关闭事项的接口是一项进度风险,无论其状态显示什么。

常见失效模式

  • 无人发现的接口。功能之间的某个交换从未获得物理路径,或者某个外部接口(地面设备、测试设备、操作员)被遗漏。应根据架构而不是线束清单建立接口清单。
  • 单方面的文档。一个团队编写 ICD,另一个团队从未正式认可,分歧在集成时才暴露出来。在状态变为“已商定”之前,要求双方都批准。
  • 缺少单位和约定。没有单位、符号约定、字节顺序或比例因子的数值会引出两种不同的理解。在评审中将每一项都视为缺陷。
  • 没有将负载与容量比较。每条消息单独都能容纳,但合起来超出了总线;每项负载单独都在线束能力之内,但合起来超出了其额定值。汇总每条链路上的负载并与其容量比较,并留有裕度。在下面的示例模型中,IF-05 Payload Interface 在一条 400 Mbps 链路上承载 480 Mbps 的图像条带和 0.02 Mbps 的指令计划:400 Mbps 中占用 480.02,即 120 %,在集成之前就被模型标记出来,而不是在试验台上才发现。
  • 时序未明确说明。给出了速率,却没有给出容差和超时行为。两者都要记录,并说明一方迟到时另一方如何处理。
  • 过时的副本。ICD、线束图和软件的消息表各自保存着自己的版本。应从单一来源生成,或至少指明由哪一个起控制作用。
  • 没有负责人的未关闭事项。没有指定人员和日期的 TBR 会一直保持未关闭。为每一项都指定这两者。
  • 验证规划得太晚。接口测试需要双方的硬件或经过确认的仿真器。应在 ICD 达成一致时就规划它们,而不是等单元到货时。

实例:CubeSat 上 C&DH 到通信系统的接口

示例是 EO-1,一颗从 500 km 太阳同步轨道为农田成像的 6U 对地观测 CubeSat;MBSE 示例项目指南介绍了整个模型。这里我们选取航天器内部的一个接缝:1.4 C&DH(指令与数据处理,一台带 64 GB 有效载荷存储的飞行计算机)与 1.5 Communications(用于指令的 1.5.1 UHF Transceiver 和用于有效载荷数据的 1.5.2 S-band Transmitter)之间的接缝。两侧由不同的团队构建,卫星执行的每条指令和发送到地面的每幅图像都要跨越这条边界。

找出交换

模型中的正常成像过境 OPS Run Nominal Imaging Pass 被分解为十二个功能 OPS.1 到 OPS.12,其中十一个已分配给执行它们的 Asset。它的 N² 图将这些功能放在对角线上,将它们交换的项放在单元格中:

有两个单元格跨越 C&DH 与通信系统之间的边界:

  • 第 OPS.2 Receive Imaging Plan 行(由 UHF Transceiver 执行)、第 OPS.3 Load Command Schedule 列(由 C&DH 执行):Command Packets,即来自无线电的已解码指令包。
  • 第 OPS.7 Encode and Store Image 行 (C&DH)、第 OPS.8 Transmit Image Data 列(S-band Transmitter):Downlink Frames,即经过压缩和分包的图像数据。

第三个交换没有出现在这次过境中,因为它来自航天器的模式逻辑:C&DH 的进入动作 Enable S-band Transmitter 向由 S-band Transmitter 执行的 F9 Transmit Payload Data 发送 Transmitter Enable Command。只根据一个场景建立的接口清单会遗漏它,这就是为什么要在列出接口之前,先在整个模型范围内将功能分配给 Asset。

演示项目已经为每个交换提供了物理路径。为了将它们组成一个受控接口,我们在演示项目中添加了一个元素:一个父 Conduit IF-26 C&DH to Communications Interface,连接到两个子系统,状态为 Agreed,负责人为 Comms Lead,以两条现有链路作为其子项。下文的其余内容都是演示项目的原样。

链路端点介质和连接器承载内容容量状态
IF-07 Radio Command InterfaceUHF Transceiver → C&DHUART,115.2 kbaud;J3 (Micro-D 9)Command Packets,0.0096 Mbps (9.6 kbps)0.1 Mbps已纳入基线
IF-08 Payload Data InterfaceC&DH → S-band TransmitterSpaceWire;J4 (Micro-D 9)Downlink Frames,10 Mbps;Transmitter Enable Command,未设置速率100 Mbps已商定

每条链路都追溯到驱动它的需求:IF-07 satisfies 5.2 UHF Command Uplink(“The UHF transceiver shall receive ground commands at 9.6 kbps”,UHF 收发机应以 9.6 kbps 接收地面指令),IF-08 satisfies 5.1 S-band Downlink Rate(“The S-band transmitter shall downlink payload data at 10 Mbps”,S 频段发射机应以 10 Mbps 下行传输有效载荷数据)。

接口图

接口控制图将双方显示为条带,父接口位于中间,每条链路显示为一个带有状态、容量和项的条形,并从每条链路引出一条线连接到其所连接的部件:

C&DH 条带中没有部件,因为模型将飞行计算机视为一个单元:两条链路都终止于 C&DH 本身。在通信系统一侧,每条链路终止于不同的无线电设备,这正是线束团队需要知道的。

生成的 ICD

ICD 从相同的元素导出为 Word 文档。第一页包含接口登记册和状态摘要;随后每个 Conduit 都有自己的章节,包括端点、连接器和引脚、介质、带方向和速率的传递项、关联的需求以及容量检查。

下载 ICD:EO-1 C&DH 到通信系统接口的 ICD (.docx),即 Holarch 导出的完整三页文档,已删除导出日期。其中仅包含虚构的 EO-1 演示数据。

实例说明了什么

  • 登记册就是工作组的议程。IF-07 已纳入基线,因此对它的更改要通过变更请求。IF-08 已商定:更改仍需 C&DH 团队和通信团队双方同意。两者都没有未关闭的 TBD 或 TBR,因此这个接口可以整体纳入基线。
  • 对照介质实际提供的能力检查容量。IF-07 在记录容量 0.1 Mbps 上承载 9.6 kbps,文档报告为 10 %。每字节带一个起始位和一个停止位、速率为 115.2 kbaud 的 UART 传输 115,200 × 8 / 10 = 92,160 bit/s 的数据,因此真实容量约为 92 kbps,负载约占其 10.4 %。无论按哪种算法裕度都很大,但记录的数字是向上取整的;在更繁忙的链路上,这种取整会掩盖问题。
  • 链路通过,系统仍可能失败。IF-08 在 100 Mbps 的 SpaceWire 链路上传输 10 Mbps 的帧,占容量的 10 %。约束位于下游一个接口:IF-12 S-band Downlink 在 10 Mbps 无线电链路上承载 9.6 Mbps,占 96 %。更快的帧流可以轻松通过 IF-08,却会在天线处失败,因此 ICD 评审要看整条链,而不是一条链路。
  • 没有速率的项不会被检查。Transmitter Enable Command 没有数据速率,因此容量检查将它排除在外。它的数据量很小,但空值就是一个未关闭事项:给它一个速率,或者一个带负责人的 TBD。
  • 父接口本身没有容量。它汇集其链路的项(这里是三个),为这一对参与方提供一份文档、一个负责人和一个状态;负载检查在每条链路上运行。
  • 变更可追溯。如果任务改用更快的下行链路,Downlink Frames 的速率只需在一个地方更改,IF-08 和 IF-12 上的检查会重新运行,而追溯到 IF-08 的需求 5.1 会指明需要重新验证的内容。

在 Holarch 中试用

  1. 通过管理项目 → 项目文件 ▾ → 新建演示项目 → CubeSat(引导式系统工程)创建演示项目。
  2. 打开接口 → N² 图,并打开动作 OPS Run Nominal Imaging Pass 的 N² 图,查看其功能之间的交换。
  3. 打开接口 → ICD,点击+ 新建图,并选择 C&DH 作为左侧父 Asset,Communications 作为右侧父 Asset。
  4. 将现有的 Conduit IF-07 Radio Command Interface 和 IF-08 Payload Data Interface 从调色板拖到中间的框中。它们的项和连接会一并带入。
  5. 选择一条链路,查看其 Interface Status、Owner、TBD/TBR、Capacity 和 Units,以及关联的需求。
  6. 点击导出 ICD 文档获取 Word 文档,或点击导出 ICD (CSV)获取表格。

接口 → 接口登记册列出项目中的每个接口及其状态和容量检查;在演示项目中,它显示 IF-05 超出容量。分步说明见生成接口控制文档;已纳入基线的接口通过变更请求进行更改。

后续阅读