Формирование текстовой документации в Altium Designer

Формирование текстовой документации в Altium Designer

В данной статье рассмотрены функциональные возможности обновленного вспомогательного программного модуля GOST 2.701-2008/2.106-1996 от компании Altium для задач формирования текстовой конструкторской документации на электронные модули, выполненные в Altium Designer.

Предисловие. Цели и задачи стандартизации.

В 1968 году в СССР Госстандартом была введена в действие Государственная система стандартизации, составным элементом которой явилась Единая система конструкторской документации (ЕСКД), группа ГОСТов – 2, первая редакция – 1971 год. ЕСКД пришла на смену Системе чертежного хозяйства (СЧХ) и явилась значительным шагом в деле стандартизации.

Стандартизация – это установление и применение правил с целью упорядочения деятельности в определенной области на пользу и при участии всех заинтересованных сторон, в частности для достижения всеобщей оптимальной экономии при соблюдении условий эксплуатации и требований безопасности.

Одной из основных задач стандартизации является установление норм, требований и методов в области проектирования и производства продукции с целью обеспечения ее оптимального качества и исключения нерационального многообразия видов, марок и типоразмеров комплектующих элементов, а также создание единой системы технической документации.

27 декабря 2002 года был принят Федеральный закон РФ N 184-ФЗ «О техническом регулировании», в соответствии с которым обязательное выполнение требований ГОСТ на территории РФ отменяется, их требования приобретают рекомендательный характер.

Обязательными для исполнения объявляются т.н. технические регламенты, сфера охвата которых носит весьма ограниченный характер. На переходный период до разработки и введения в действие технических регламентов, действуют соответствующие ГОСТы.

Таким образом, организациям, занимающимся проектированием и реализацией инсталляций, предоставляется уникальный шанс: есть возможность взять из системы ГОСТов все лучшее, что помогает существенно упростить и удешевить процессы проектирования и отработки технической документации, и отбросить все лишнее, не выдержавшее проверку временем или представляющееся избыточным.

Соответствие ГОСТам – по-прежнему обязательное требование при проведении многих тендеров, конкурсов, представлении проектов и сдачи в эксплуатацию готовых комплексов – в случае, когда заказчиком выступает государственная организация.

В настоящее время проектирование электронных модулей на основе печатных плат выполняется в САПР, где проектные данные агрегируются в виде электронных моделей изделия содержащие в себе в том числе и состав изделия. Который для разных служб требуется предоставлять в форме текстовых конструкторских документов.

Текстовый конструкторский документ – это конструкторский документ, содержащий в основном сплошной текст или текст, разбитый на графы. Виды текстовых документов определены ГОСТ 2.102 и ГОСТ 2.113, а формы и правила выполнения спецификаций, ведомостей и прочих документов определяет ГОСТ 2.106, а перечень элементов ГОСТ 2.701.

Процесс создания текстовой документации на электронный модуль в целом начинается после глубокой проработки электрической схемы. Под глубокой проработкой схемы прежде всего следует понимать не наличие связей на схеме и ее приведение в соответствие ЕСКД, а качественно-количественный показатель. Причем, зачастую на отечественных предприятиях от разработчика требуют уже на ранних стадиях проекта ведомость покупных изделий (ВП) для передачи в обработку отделом снабжения. Это, как правило, связано с большими сроками поставки комплектующих (от недель до нескольких месяцев), так сказать опережающая закупка комплектующих, даже в ущерб качеству и количеству. Таким образом, предприятие понимает риски, связанные с тем, что проект может претерпеть изменения, и часть комплектующих “осядет” на складе предприятия.

В связи с этим последовательность создания документов несколько отличается от предложенного в ЕСКД: на первом месте — ведомость покупных изделий (ВП), затем перечень элементов (ПЭ3) и последним в списке —  спецификация. Остальные текстовые документы, необходимые для полного комплекта документов, в данной статье рассматриваться не будут.

Здесь также следует сказать о правильном и своевременном заполнении реквизитной части проектных данных. Которые в последствии являются источником данных для реквизитов и атрибутов основной надписи, согласно ГОСТ 2.104 для всех видов документов. Это важно для последующей идентификации документов в хранилище предприятия, как бумажного, так и электронного (PDM/PLM/ERP).

Задача автоматизированного формирования ВП, ПЭ3 и спецификации, не смотря на сложность сортировки данных решена во многих программных приложениях. Зачастую эти приложения работают как самостоятельные редакторы с функциями импорта данных в нейтральных форматах. Всеобщая тенденция сокращение времени проектирования диктует условие и на автоматизированное формирование текстовых документов непосредственно из электронной модели изделия, без участие дополнительных конверторов проектных данных.

Затраты времени на формирование текстовых документов.
Затраты времени на формирование текстовых документов

Компания Altium LLC для реализации этой задачи в своих флагманских САПР Altium Designer и Altium NEXUS (далее ПО Altium) выпустила обновлённый программный модуль «GOST 2.701-2008/2.106-1996» (далее модуль GOSTBOM). Основными достоинствами модуля являются, то что формируемые файлы документов в формате Excel® не требуют установленного приложения Microsoft Excel®, упрощённый процесс настройки и внедрения на предприятии.

Основными факторами модернизации модуля GOSTBOM явились:

  • расширение функциональных возможностей;
  • адаптация под новые технологии Altium;
  • оптимизация производительности;
  • системная интеграция.

Далее в рамках данной статьи будут рассмотрены основные приёмы работы с модулем GOSTBOM по формированию текстовых конструкторских документов (перечень элементов, ведомость покупных изделий, спецификация).

Установка и начальная настройка модуля.

Модуль GOSTBOM входит в дистрибутив ПО Altium, но требует дополнительной установки пользователем, так как модуль является региональным. Инсталляция модуля производится на установленном ПО Altium из пользовательского интерфейса в разделе Extensions & Updates.

Модуль GOSTBOM
Модуль GOSTBOM

Для корректной работы комплекса (Altium & GOSTBOM) в состав модуля были добавлены шаблоны листов схем которые содержат основные надписи по ЕСКД и форматы с А4 по А0. Установка шаблонов производится командой CopyTemplates. Шаблоны листов схем будут скопированы в папку, указанную на странице системных настроек Data Management — Templates.

Комплект шаблонов SCHDOT
Комплект шаблонов SCHDOT

Для корректного заполнения текстом граф, размер которых регламентирован ГОСТ, в формируемых документах, рекомендуется установить шрифт, который используется в шаблонах (по умолчанию) текстовых документов и листов схем. Шрифт расположен в папке установленного модуля. Не рекомендуется менять шрифт по умолчанию. При изменении шрифта изменяется гарнитура шрифта: плотность и насыщенность. В связи с этим замечанием, данные могут не поместиться в соответствующие ячейки таблицы отчета.

Заполнение свойств проекта.

Подготовительным этапом создания текстовых документов является заполнение реквизитной части проектных данных, которые будут использованы как при заполнении основной надписи схемы электрической, так и в документах, генерируемых модулем GOSTBOM. Для заполнения и редактирования реквизитов применяется команда ProjectProperties, которая открывает диалоговое окно Свойства проекта.

Диалоговое окно редактирование свойств проекта.
Диалоговое окно редактирование свойств проекта.

Диалоговое окно разделено на информационные блоки. Блок сведений об авторах проектных данных заполняется согласно ГОСТ 2.106, так же учитывает разделение ответственности по проектным задачам: проектирование схемы электрической и проектирование конструкции печатной платы.

Для сокращения времени заполнения свойств предусмотрены выпадающие списки. Списки допускается править. Справочник списков расположен в папке модуля GOSTBOM: файл Settings.xml.

Блок заполнения сведений о подписании документов
Блок заполнения сведений о подписании документов

Блок «Сведения об изменениях документа ГОСТ 2.503» предусматривает возможность вносить данные об изменениях для каждого формируемого документа в отдельности. Изменения разнесены с учетом специфики и в дополнение стандартов.

Значение свойств информационных блоков «Проект печатной платы ГОСТ 2.104» и «Схема ГОСТ 2.701» заполняются в соответствие с указанными стандартами. Дополнительно ГОСТ введены такие атрибуты как “Входимость”, “Вид/Код Проекта”, “Вид/Код Платы” и соответственно “Раздел”, которые заполняются на усмотрение пользователя. Результат заполнения основной надписи в документе схема электрическая принципиальная представлен на рисунке ниже.

Пример заполненной основной надписи листа схемы.
Пример заполненной основной надписи листа схемы.

Атрибуты проекта после первого применения команды ProjectPropertiesдобавляются в параметры проекта Project Options …/Parameters.

После подготовки реквизитной части проекта следует сказать несколько слов об общих принципах работы модуля GOSTBOM.

  • модуль не требует предустановленного ПО Microsoft Office;
  • отчеты формируются в виде таблиц EXCEL, которые в свою очередь будут включены в проект в папку “Other Documents”. Перейти к отчету в проводнике или открыть для просмотра, печати можно находясь непосредственно в интерфейсе ПО Altium. Имена документов выполнены по схеме ‘Имя файла проекта + Код_документа.xls;
Дерево проекта.
Дерево проекта.
  • в случае удаления, переименования шаблонов (специальным или случайным образом) в модуле предусмотрено повторное копирование исходных шаблонов;
  • модуль работает с вариантами проекта. В терминологии ЕСКД варианты проекта равносильны исполнениям изделия. При наличии вариантов проекта генерируются групповые текстовые документы согласно ГОСТ 2.113;
  • модуль работает с данными полученными из ActiveBOM. Для формирования отчетов файл *.BOMDoc не нужен. При наличии файла *.BOMDoc модуль работает с пользовательскими записями custom item, row item, а также после применения команды Specificationв поле #line заносятся номера позиций;
  • согласно ГОСТ 2.710 п.2.2.11 и приложению 1 в модуле реализован справочник буквенных кодов видов элементов и их названий. (файл DesignatorDevice.xml). 
  • для корректной работы модуля необходимо указать параметр(ы) для вставки в отчеты для поля “Наименование”. По умолчанию в качестве “Наименования” указан параметр компонентов равный “Comment”.
Редактирование параметра «Наименование».
Редактирование параметра «Наименование».

Перечень элементов.

Формирование документа ПЭ3 производится запуском команды “ListOfElements”при активном документе листа схемы проекта печатной платы. В зависимости от наличия исполнений в проекте формируется единичный или групповой документ. Такой подход исключает необходимость добавлять статическую таблицу исполнений на листах схемы.

Пример групового документа перечень элементов схемы электрической.
Пример групового документа перечень элементов схемы электрической.

Ведомость покупных изделий.

Формирование документа ведомость покупных изделий согласно ГОСТ 2.106 и ГОСТ 2.113 составляют на основании всех спецификаций данного изделия. Возможность формирование ВП добавлена опционально на случай, если проект печатного узла является самостоятельным изделием. 

Формирование документа ВП производится запуском команды “ListOfPurchased” при активном документе листа схемы проекта печатной платы.

Спецификация.

Учитывая, что электронная модель печатного узла в формате данных Altium Designer не содержит все необходимые сведения для получения полноценного документа Спецификация, в модуле GOSTBOM предусмотрены инструменты внесение дополнительных данных на проектируемый печатный узел, а именно:

  • Для заполнения в спецификацию данных о печатной плате как составной части, входящую в специфицируемое изделие предусмотрены графы в диалоговом окне «Свойства проекта» сведений.
  • Для заполнения данных в разделы: Документация, Материалы, Комплекты, предусмотрены соответствующие команды, которые доступны в редакторе печатных плат. Вносимые сведения имеют стандартные записи, поэтому предлагается набирать их из выпадающих списков, которые читаются из справочника. Справочник расположен в папке модуля GOSTBOM: файл DefaultValues.xml.

Внесенные сведения для разделов Документация, Материалы, Комплекты записываются непосредственно в параметры проекта Project Options …/Parameters, что позволяет вносить данные в проект один раз. Стоит отметить, что занесенные таким образом данные не синхронизируются с документом ActiveBOM (*.BOMDoc).

Группа команд для разделов спецификации
Группа команд для разделов спецификации

Формирование документа Спецификации производится запуском команды Specification. при активном файле топологии проекта печатной платы. В зависимости от наличия исполнений в проекте формируется единичный или групповой документ. 

Пример сформированного группового документа спецификация.
Пример сформированного группового документа спецификация.

После генерации спецификации и при наличии в проекте печатного узла документа ActiveBOM (*.BomDOC) доступна возможность синхронизировать позиционные обозначения на сборочном чертеже (*.PCBDwf), формируемом средствами ПО Altium в редакторе Draftsman.

Добавление позиционных обозначений на сборочный чертеж.
Добавление позиционных обозначений на сборочный чертеж.

После внесения изменений в состав проекта (добавление, удаление компонентов) для обновления позиций на чертеже потребуется повторная генерация новой версии спецификации и обновления сборочного чертежа.

Формирование комплекта документации в редакторе OUTJOB.

Для формирования требуемого комплекта выходной документации в файлах типа *.OutJob, для генерации документов ПЭ3, ВП, Спецификация, в разделе Report Outputs добавлена настройка включения требуемых документов.

Настройка пакетного формирования выполнения отчетов.
Настройка пакетного формирования выполнения отчетов.

В случае, если какой-либо из отчетов был сформирован ранее, он будет перезаписан. Остается только проследить, чтобы отчеты не были открыты или, не был установлен атрибут “только для чтения”. Последнее замечание актуально при хранении электронных документов в различных PDM-системах.

Заключение.

Обновлённый программный модуль «GOST 2.701-2008/2.106-1996» в САПР Altium Designer и Altium NEXUS учитывает целостность проектных данных и обеспечивает высокую степень автоматизации формирование конструкторских документов такие как Перечень элементов схемы электрической, Ведомость покупных изделий и Спецификация.

Предложенный алгоритм формирования текстовой документации непосредственно в САПР Altium ориентирован в основном на разработчиков, которые выполняют весь цикл проектирования самостоятельно и не имеют в своём арсенале специализированных средств и инструментов управления проектными данными (PDM — системы).

В модуле GOSTBOM в формируемых документах ПЭ3, ВП, Спецификация максимально учтены требования следующих нормативных документов: