Посібник · Інтерфейси
Документ контролю інтерфейсів (ICD): що він містить і як підтримувати його актуальним
Слухати цей посібник 20 хв
Документ контролю інтерфейсів фіксує, що перетинає межу між двома частинами системи, і зобов’язує команди з обох боків дотримуватися одного визначення. Цей посібник описує, що містить ICD, хто ним володіє, як узагалі знайти інтерфейси і як підтримувати узгодженість документа з проєктом у міру його змін, на практичному прикладі двох підсистем малого супутника спостереження Землі.
На цій сторінці
Що таке документ контролю інтерфейсів
Більшість проблем інтеграції — не всередині підсистеми; вони на стику між двома підсистемами. Одна команда припускає, що роз’єм має ключ в один бік, інша — що в протилежний. Одна сторона надсилає повідомлення про стан кожні 100 ms, а тайм-аут іншої сторони — 80 ms. Документ контролю інтерфейсів існує, щоб зробити цей стик явним: він в одному місці, погодженому обома сторонами, визначає, що передається між ними і за яких умов.
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 Mbps плюс розклад команд 0,02 Mbps каналом 400 Mbps: 480,02 з 400 Mbps, 120 %, і модель позначає це до інтеграції, а не на стенді.
- Неявні часові параметри. Частоти вказано, а допуски й поведінку при тайм-ауті — ні. Записуйте і те, і те, а також що робить кожна сторона, коли інша запізнюється.
- Застарілі копії. ICD, креслення джгута й таблиця повідомлень програмного забезпечення мають кожна свою версію. Генеруйте з одного джерела або принаймні визначте, яке з них є визначальним.
- Відкриті пункти без відповідального. TBR без особи й дати залишається відкритим. Дайте кожному і те, і те.
- Надто пізно спланована верифікація. Тести інтерфейсу потребують апаратури обох сторін або валідованих емуляторів. Плануйте їх, коли ICD погоджено, а не коли надходять блоки.
Практичний приклад: C&DH — Communications на CubeSat
Приклад — EO-1, 6U CubeSat для спостереження Землі, що знімає сільськогосподарські угіддя із сонячно-синхронної орбіти висотою 500 km; посібник із прикладом проєкту 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, і одинадцять із них розподілено на актив, що їх виконує. Його діаграма 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, з’єднаний з обома підсистемами, зі статусом Agreed і власником Comms Lead, з двома наявними каналами як дочірніми. Усе інше нижче — демопроєкт у тому вигляді, як він постачається.
| Канал | Кінцеві точки | Середовище й роз’єм | Передає | Пропускна здатність | Статус |
|---|---|---|---|---|---|
| IF-07 Radio Command Interface | UHF Transceiver → C&DH | UART, 115,2 kbaud; J3 (Micro-D 9) | Command Packets, 0,0096 Mbps (9,6 kbps) | 0,1 Mbps | У базовій лінії |
| IF-08 Payload Data Interface | C&DH → S-band Transmitter | SpaceWire; J4 (Micro-D 9) | Downlink Frames, 10 Mbps; Transmitter Enable Command, частоту не задано | 100 Mbps | Погоджено |
Кожен канал простежується до вимоги, яка його зумовлює: IF-07 задовольняє 5.2 UHF Command Uplink («The UHF transceiver shall receive ground commands at 9.6 kbps»), а IF-08 задовольняє 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 kbps при записаній пропускній здатності 0,1 Mbps, що документ показує як 10 %. UART на 115,2 kbaud з одним стартовим і одним стоповим бітом на байт передає 115 200 × 8 / 10 = 92 160 bit/s даних, тож справжня пропускна здатність — близько 92 kbps, а навантаження становить близько 10,4 % від неї. Запас великий в обох випадках, але записане значення округлено вгору; на завантаженішому каналі таке округлення приховало б проблему.
- Канал може проходити перевірку, тоді як його система — ні. IF-08 передає 10 Mbps кадрів каналом SpaceWire на 100 Mbps, 10 % пропускної здатності. Обмеження розташоване на один інтерфейс нижче за течією: IF-12 S-band Downlink передає 9,6 Mbps радіоканалом на 10 Mbps, 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² і Physical I/O.
- Документація із запитів на зміну: контроль конфігурації для елементів у базовій лінії.
- Що таке MBSE?: чому інженери зберігають систему в моделі.