Руководство · Интерфейсы
Документ управления интерфейсами (ICD): что он содержит и как поддерживать его актуальным
Прослушать это руководство 20 мин
Документ управления интерфейсами фиксирует, что пересекает границу между двумя частями системы, и обязывает команды по обе стороны следовать одному определению. Это руководство описывает, что содержит ICD, кто им владеет, как вообще найти интерфейсы и как поддерживать документ в соответствии с меняющейся конструкцией, с разобранным примером двух подсистем небольшого спутника наблюдения Земли.
На этой странице
Что такое документ управления интерфейсами
Большинство проблем интеграции находятся не внутри подсистемы, а на стыке двух подсистем. Одна команда считает, что разъём имеет ключ в одну сторону, другая — что в противоположную. Одна сторона отправляет сообщение о состоянии каждые 100 мс, а тайм-аут другой стороны — 80 мс. Документ управления интерфейсами существует, чтобы сделать этот стык явным: он в одном месте, согласованном обеими сторонами, указывает, что передаётся между ними и при каких условиях.
ICD описывает интерфейс снаружи. Он не говорит, как устроена каждая сторона, а только что каждая сторона должна представить на границе: разъём и его контакты, напряжение и ток, структуру и синхронизацию сообщений, точки крепления, среду, которую интерфейс должен выдержать. Затем каждая команда проектирует свою сторону в соответствии с этим.
Три близких названия документов часто путают:
| Документ | Отвечает на вопрос | Типичное содержание |
|---|---|---|
| Спецификация требований к интерфейсу (IRS) | Что должен делать интерфейс? | Требования к одному или нескольким интерфейсам, записанные как верифицируемые формулировки «shall» до того, как конструкция определена. |
| Описание проекта интерфейса (IDD) | Как его реализует одна сторона? | Проект интерфейса в исполнении одной стороны, часто программного или аппаратного изделия, с детализацией, достаточной для изготовления и тестирования. |
| Документ управления интерфейсами (ICD) | О чём договорились обе стороны? | Контролируемое, совместно утверждённое определение интерфейса между двумя конкретными сторонами, находящееся под управлением изменениями. |
Программы сочетают их по-разному. Некоторые включают требования в ICD; некоторые пишут IRS на ранней стадии, а ICD — когда конструкция созреет. Важно, чтобы и требования, и согласованное определение были записаны и чтобы одно из них было явно управляющим.
Кто владеет ICD
У ICD две стороны, иногда больше, и один владелец. Стороны — организации или команды, отвечающие за каждую сторону: две команды подсистем, головной подрядчик и поставщик, команда аппарата и команда полезной нагрузки. Владелец — человек или группа, которые ведут документ, отслеживают открытые вопросы и проводят утверждение. В крупных программах это рабочая группа по управлению интерфейсами (ICWG): представители каждой стороны плюс системный инженер, отвечающий за интеграцию, которые регулярно встречаются.
Несколько правил владения предотвращают большинство споров:
- Один владелец на интерфейс, названный в документе. «Системная команда» — не владелец; владелец — названный руководитель.
- Утверждают обе стороны. ICD, подписанный одной стороной, — список пожеланий, а не управляющий документ.
- Интегрирующий уровень владеет интерфейсами между своими дочерними элементами. Интерфейс между двумя подсистемами принадлежит системному уровню, потому что ни одна подсистема не может решить его в одиночку.
- Внешними интерфейсами — к оборудованию или системам вне программы — владеет сторона программы, согласуя их с внешней стороной, у которой может быть собственный документ, имеющий приоритет.
Что содержит ICD
Точная структура зависит от предметной области и стандартов программы, но полный ICD охватывает одно и то же. Оставляйте раздел с пометкой «не применимо», а не удаляйте его, чтобы рецензент видел, что он был рассмотрен.
| Раздел | Что фиксирует |
|---|---|
| Идентификация и стороны | Номер и название интерфейса, две стороны, владелец, статус документа и утверждения. |
| Обзор интерфейса | Диаграмма двух сторон и всех связей между ними и краткое описание назначения интерфейса. |
| Перечень интерфейсов | Каждая отдельная связь (жгут, шина, линия, трубопровод, крепление) со своим номером, конечными точками и статусом. |
| Механика и физика | Точки крепления и схемы болтов, габариты и запретные зоны, массовые характеристики на интерфейсе, выравнивание, типы и расположение разъёмов. |
| Электрика | Назначение контактов, диапазоны напряжения и тока, качество питания, заземление и металлизация, экранирование, изоляция, уровни сигналов. |
| Данные и протокол | Протоколы и физические уровни, определения сообщений с названиями полей, типами, диапазонами, единицами и масштабированием, идентификаторы, обработка ошибок. |
| Синхронизация | Частоты и периоды сообщений, бюджеты задержки, последовательности запуска и пробуждения, тайм-ауты и действия каждой стороны при их истечении. |
| Жидкости, тепло и оптика | Расходы, давления и температуры на границе, теплопередача через неё, оптические пути и поля зрения, где применимо. |
| Условия среды | Вибрация, удары, температура, влажность, защита от проникновения и условия электромагнитной совместимости, которые интерфейс должен выдержать. |
| Требования к интерфейсу | Требования, которым должен отвечать интерфейс, каждое прослеженное к родительскому требованию. |
| Верификация | Как каждое требование верифицируется на интерфейсе (тест, анализ, осмотр, демонстрация), на каком уровне и с каким оборудованием. |
| Открытые вопросы | Каждый TBD (значение ещё не определено) и TBR (значение предложено, но ещё не подтверждено), каждый с ответственным и датой закрытия. |
| История изменений | Каждая редакция с её запросом на изменение, тем, что изменилось, и тем, кто утвердил. |
Данные и синхронизация заслуживают наибольшей детализации
Механические и электрические интерфейсы обычно проверяются физически рано — при примерках и первом включении. Несоответствия данных и синхронизации живут гораздо дольше, часто до системной интеграции, потому что каждая сторона тестирует по собственному имитатору, построенному по собственному прочтению документа. Для каждого сообщения запишите идентификатор, период и его допуск, тип, диапазон, единицы и масштабирование каждого поля, порядок байтов и действия получателя, если сообщение опоздало, отсутствует или вышло за диапазон. Определение сообщения, которое говорит «ток батареи» без единиц, соглашения о знаке (положителен заряд или разряд) и разрешения, ещё не контролируется.
Верификация самого интерфейса
Требования к интерфейсу верифицируются как любые другие требования (руководство по матрице верификации требований описывает методы, уровни и свидетельства), но у свидетельств особая форма: нужны обе стороны. Тест совместимости между реальными блоками или между одним реальным блоком и валидированным эмулятором другого сильнее, чем два отдельных теста по двум частным прочтениям ICD. Планируйте эти тесты в ICD, чтобы оборудование и график существовали к тому моменту, когда они понадобятся.
Поиск интерфейсов в архитектуре
ICD может контролировать только те интерфейсы, которые кто-то нашёл. Надёжный способ найти их — по архитектуре, а не по памяти.
- Начните с функций. Декомпозируйте миссию на функции с их входами и выходами (руководство по функциональному анализу показывает, как). Диаграмма N² размещает функции (или подсистемы) на диагонали; ячейка в строке A, столбце B содержит то, что A отправляет B. Каждая заполненная ячейка вне диагонали — обмен, которому нужен путь. Скопления заполненных ячеек показывают, какие функции относятся друг к другу; насыщенная строка или столбец отмечает функцию, от которой зависят многие другие.
- Распределите функции по компонентам. Как только каждую функцию выполняет физическая часть, каждый обмен между функциями в разных частях становится обменом, пересекающим границу частей. Руководство по архитектуре системы показывает, как выполняется и проверяется такое распределение.
- Дайте каждому пересекающему обмену физический путь. Жгут, шина, радиолиния, трубопровод или механическое соединение. Обмен без пути — пробел в конструкции; путь, который ничего не передаёт, либо не нужен, либо ещё не понят.
- Нарисуйте диаграмму интерфейсов. Для каждой пары сторон покажите обе стороны, их внутренние части на границе и каждую связь с тем, что она передаёт. Это станет обзорным рисунком ICD.
Нумеруйте интерфейсы по мере обнаружения. Разобранный ниже пример нумерует свои связи от IF-01 до IF-25 и даёт связи внутри более крупного интерфейса десятичный номер (IF-14.1 внутри IF-14). Номера позволяют ссылаться на интерфейсы в требованиях, методиках испытаний и запросах на изменение и сохраняют список интерфейсов стабильным при смене названий.
Держите ICD привязанным к модели
ICD, написанный как отдельный файл текстового редактора, начинает отставать от конструкции в день утверждения. В чертеже жгута переназначают контакт, в ПО меняется период сообщения, для позднего требования добавляется новый сигнал, а ICD обновляют через несколько недель или не обновляют вовсе. Тогда рецензенты сравнивают документы друг с другом, а не с конструкцией.
Системная инженерия на основе моделей переворачивает это. Каждый интерфейс — элемент системной модели, связанный со своими двумя конечными точками, с передаваемыми предметами и с управляющими им требованиями. ICD — отчёт, сгенерированный из этих элементов. Тогда:
- Одна и та же связь с одинаковыми значениями появляется в ICD, на диаграмме интерфейсов, в трассировке требований и в матрице верификации, потому что все они читают одно определение.
- Изменение частоты сообщения или разъёма появляется в следующем сгенерированном ICD, а история изменений берётся из собственных записей модели.
- Проверки выполняются по модели: обмен между двумя частями без связи, которая бы его передавала, связь только с одной конечной точкой, связь, нагрузка которой превышает её пропускную способность, связь без владельца или статуса.
- Требования к интерфейсу прослеживаются к нему, поэтому разделы требований и верификации в ICD остаются полными (типы связей и проверки пробелов описаны в руководстве по прослеживаемости требований).
Не всё должно храниться в атрибутах модели. Подробные чертежи разъёмов, временные диаграммы и длинные каталоги сообщений могут оставаться во вложенных или упоминаемых документах. Модель всё равно хранит интерфейс, его статус, владельца и ссылку, поэтому сгенерированный ICD указывает на нужную редакцию.
Управление изменениями интерфейсов
Определение интерфейса созревает поэтапно, и этап определяет, как обрабатывается изменение. Для большинства программ подходит простая четырёхэтапная схема:
| Статус | Значение | Как вносится изменение |
|---|---|---|
| Черновик | Первое определение одной стороны. | Владелец свободно его правит. |
| Предложено | Передано другой стороне на рецензирование. | Изменения обсуждаются в рабочей группе и записываются. |
| Согласовано | Обе стороны его приняли; проектирование может опираться на него. | Изменению нужно согласие обеих сторон и оценка влияния для каждой стороны. |
| В базовой линии | Часть утверждённой базовой линии конфигурации. | Формальный запрос на изменение, оценённый и утверждённый советом по изменениям, с переизданием ICD. |
Распространённый ритм: интерфейсы составляются в черновике к рассмотрению системных требований, согласуются до предварительной защиты проекта и включаются в базовую линию до критической защиты проекта. Каким бы ни был ритм, запрос на изменение интерфейса в базовой линии должен указывать причину, затронутые связи и предметы, влияние на конструкцию, стоимость и график каждой стороны, затронутые требования и верификацию, а также применимость: с какой сборки или серийного номера действует изменение. Как находить и оценивать эти последствия, пошагово показано в руководстве по анализу влияния изменений.
Отслеживайте TBD и TBR как список, который должен сокращаться. Интерфейс, который на критической защите проекта всё ещё полон открытых вопросов, — риск для графика, что бы ни говорил его статус.
Типичные ошибки
- Интерфейсы, которые никто не нашёл. Обмену между функциями так и не дали физического пути, или внешний интерфейс (наземное оборудование, испытательное оборудование, оператор) был упущен. Стройте перечень интерфейсов по архитектуре, а не по перечню жгутов.
- Односторонние документы. Одна команда пишет ICD, другая так и не соглашается формально, и разногласие всплывает при интеграции. Требуйте утверждения обеих сторон до статуса «Согласовано».
- Отсутствующие единицы и соглашения. Значение без единиц, соглашения о знаке, порядка байтов или масштабирования допускает два разных прочтения. Считайте каждый такой случай дефектом при рецензировании.
- Нагрузка не сравнивается с пропускной способностью. Каждое сообщение умещается, но вместе они превышают возможности шины; каждая нагрузка умещается в жгут, но вместе превышают его номинал. Суммируйте нагрузки на каждой связи и сравнивайте с её пропускной способностью с запасом. В модели из примера ниже IF-05 Payload Interface передаёт полосу изображения 480 Мбит/с плюс расписание команд 0,02 Мбит/с по связи 400 Мбит/с: 480,02 из 400 Мбит/с, 120 %, — модель помечает это до интеграции, а не на стенде.
- Синхронизация остаётся неявной. Частоты указаны, а допуски и поведение при тайм-ауте — нет. Записывайте и то, и другое, а также действия каждой стороны, когда другая опаздывает.
- Устаревшие копии. ICD, чертёж жгута и таблица сообщений ПО хранят каждый свою версию. Генерируйте из одного источника или хотя бы назовите управляющий.
- Открытые вопросы без ответственного. TBR без человека и даты остаётся открытым. Дайте каждому и то, и другое.
- Слишком поздно запланированная верификация. Тестам интерфейсов нужно оборудование обеих сторон или валидированные эмуляторы. Планируйте их, когда ICD согласован, а не когда прибыли блоки.
Разобранный пример: C&DH и Communications в CubeSat
В примере используется EO-1 — CubeSat 6U для наблюдения Земли, снимающий сельхозугодья с солнечно-синхронной орбиты высотой 500 км; руководство по примеру проекта MBSE проходит по всей модели. Здесь мы берём один стык внутри аппарата: между 1.4 C&DH (управление командами и данными, бортовой компьютер с 64 ГБ памяти для данных полезной нагрузки) и 1.5 Communications (1.5.1 UHF Transceiver для команд и 1.5.2 S-band Transmitter для данных полезной нагрузки). Стороны строят разные команды, и каждая команда, которую исполняет спутник, и каждый снимок, который он отправляет на Землю, пересекают эту границу.
Поиск обменов
Штатный сеанс съёмки модели, OPS Run Nominal Imaging Pass, декомпозирован на двенадцать функций, от OPS.1 до OPS.12, и одиннадцать из них распределены на выполняющие их активы. Его диаграмма N² размещает их на диагонали, а предметы, которыми они обмениваются, — в ячейках:
Границу между C&DH и Communications пересекают две ячейки:
- Строка 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 отправляет Transmitter Enable Command в F9 Transmit Payload Data, которую выполняет S-band Transmitter. Перечень интерфейсов, построенный только по одному сценарию, упустил бы его, поэтому функции распределяются на активы по всей модели до составления перечня интерфейсов.
Связи и что они передают
Демо уже даёт каждому обмену физический путь. Чтобы сделать из них один контролируемый интерфейс, мы добавили в демо-проект единственный элемент: родительский канал IF-26 C&DH to Communications Interface, связанный с обеими подсистемами, со статусом «Согласовано», владельцем Comms Lead и двумя существующими связями в качестве дочерних. Всё остальное ниже — демо в том виде, в каком оно поставляется.
| Связь | Конечные точки | Среда и разъём | Передаёт | Пропускная способность | Статус |
|---|---|---|---|---|---|
| IF-07 Radio Command Interface | UHF Transceiver → C&DH | UART, 115,2 кбод; J3 (Micro-D 9) | Command Packets, 0,0096 Мбит/с (9,6 кбит/с) | 0,1 Мбит/с | В базовой линии |
| IF-08 Payload Data Interface | C&DH → S-band Transmitter | SpaceWire; J4 (Micro-D 9) | Downlink Frames, 10 Мбит/с; Transmitter Enable Command, частота не задана | 100 Мбит/с | Согласовано |
Каждая связь прослеживается к требованию, которое её определяет: IF-07 satisfies 5.2 UHF Command Uplink («The UHF transceiver shall receive ground commands at 9.6 kbps»), а IF-08 satisfies 5.1 S-band Downlink Rate («The S-band transmitter shall downlink payload data at 10 Mbps»).
Диаграмма интерфейсов
Диаграмма управления интерфейсами показывает две стороны как полосы, родительский интерфейс посередине, каждую связь как полосу со статусом, пропускной способностью и предметами и линию от каждой связи к части, которую она соединяет:
В полосе C&DH нет частей, потому что модель рассматривает бортовой компьютер как единый блок: обе связи заканчиваются на самом C&DH. На стороне Communications каждая связь заканчивается на своём радио, а это именно то, что нужно знать команде жгутов.
Сгенерированный ICD
ICD экспортируется из тех же элементов как документ Word. Его первая страница содержит реестр интерфейсов и сводку статусов; затем каждый канал получает собственный раздел с конечными точками, разъёмом и контактами, средой, передаваемыми предметами с направлением и частотой, связанными требованиями и проверкой пропускной способности.
Скачать ICD: ICD EO-1 для интерфейса C&DH — Communications (.docx) — полный трёхстраничный документ в том виде, в каком его экспортировал Holarch, с удалённой датой экспорта. Он содержит только вымышленные демо-данные EO-1.
Что показывает пример
- Реестр — повестка рабочей группы. IF-07 в базовой линии, поэтому его изменение идёт через запрос на изменение. IF-08 согласован: для изменения по-прежнему нужны и команда C&DH, и команда Communications. Ни у одного нет открытых TBD или TBR, так что этот интерфейс готов к включению в базовую линию целиком.
- Сверяйте пропускную способность с тем, что реально даёт среда. IF-07 передаёт 9,6 кбит/с при записанной пропускной способности 0,1 Мбит/с, что документ показывает как 10 %. UART на 115,2 кбод с одним стартовым и одним стоповым битом на байт передаёт 115 200 × 8 / 10 = 92 160 бит/с данных, так что истинная пропускная способность около 92 кбит/с, а нагрузка — около 10,4 % от неё. Запас в любом случае большой, но записанное значение округлено вверх; на более загруженной связи такое округление скрыло бы проблему.
- Связь может пройти проверку, а её система — нет. IF-08 передаёт 10 Мбит/с кадров по связи SpaceWire 100 Мбит/с — 10 % пропускной способности. Ограничение находится на один интерфейс дальше: IF-12 S-band Downlink передаёт 9,6 Мбит/с по радиолинии 10 Мбит/с — 96 %. Более быстрый поток кадров легко прошёл бы IF-08 и не прошёл бы на антенне, поэтому рецензирование ICD рассматривает цепочку, а не одну связь.
- Предмет без частоты не проверяется. У Transmitter Enable Command нет скорости передачи данных, поэтому проверка пропускной способности его пропускает. Он крошечный, но пустое значение — открытый вопрос: задайте ему частоту или TBD с ответственным.
- У родительского интерфейса нет собственной пропускной способности. Он объединяет предметы своих связей (здесь три) и даёт паре сторон один документ, одного владельца и один статус; проверки нагрузки выполняются по каждой связи.
- Изменение прослеживаемо. Если миссия перейдёт на более быстрый сброс данных, частота Downlink Frames меняется в одном месте, проверки IF-08 и IF-12 выполняются заново, а требование 5.1, прослеженное к IF-08, называет, что нужно повторно верифицировать.
Попробуйте в Holarch
- Создайте демо через Управление проектами → Файлы проекта ▾ → Новый демо-проект → CubeSat (пошаговая системная инженерия).
- Откройте Интерфейсы → Диаграммы N² и откройте диаграмму N² действия OPS Run Nominal Imaging Pass, чтобы увидеть обмены между его функциями.
- Откройте Интерфейсы → ICD, нажмите + Новая диаграмма и выберите C&DH левым и Communications правым родительским активом.
- Перетащите существующие каналы IF-07 Radio Command Interface и IF-08 Payload Data Interface из палитры в центральный блок. Их предметы и соединения переносятся вместе с ними.
- Выделите связь, чтобы проверить её Статус интерфейса, Владелец, TBD/TBR, Пропускная способность и Единицы, а также связанные требования.
- Нажмите Экспортировать документ ICD для документа Word или Экспортировать ICD (CSV) для таблицы.
Интерфейсы → Реестр интерфейсов перечисляет все интерфейсы проекта с их статусом и проверкой пропускной способности; в демо он показывает перегрузку IF-05. Пошаговые инструкции — в разделе создание документа управления интерфейсами; интерфейсы в базовой линии изменяются через запросы на изменение.
Что дальше
- Интерфейсы в Holarch: реестр интерфейсов, проверки пропускной способности и ICD из модели.
- Документация по интерфейсам: каналы, предметы, диаграмма управления интерфейсами, диаграммы N² и физических входов/выходов.
- Документация по запросам на изменение: управление конфигурацией для элементов в базовой линии.
- Что такое MBSE?: зачем инженеры хранят систему в модели.