Руководство пользователя
Версия 3.18
Введение
kicadbom2spec — приложение для создания перечней элементов схем, выполненных в KiCad.
Перечень оформляется в соответствии с требованиями ЕСКД и сохраняется в виде текстового документа *.odt или электронной таблицы *.ods. Также, существует возможность сохранить перечень элементов без оформления (только данные) в формате *.csv, для дальнейшего использования в других документах.
Кроме создания перечня элементов, с помощью данной программы можно редактировать необходимые пользовательские поля элементов как в файлах схем (*.sch) так и в файлах библиотек (*.lib).
В этом руководстве представлена вся необходимая информация для успешного создания перечней элементов и редактирования необходимых полей компонентов схем/библиотек.
Все изображения были созданы в операционной системе Ubuntu, но в других ОС интерфейс пользователя выглядит аналогично. В некоторых случаях, все же, присутствуют различия и в таких местах приводятся изображения для каждого конкретного случая.
Быстрый старт
Для демонстрации работы программы, kicadbom2spec поставляется в с небольшим проектом KiCad — sample. Он состоит из следующих файлов:
-
sample.lib — библиотека элементов схемы
-
sample.pdf — образец готового перечня элементов
-
sample.pro — файл проекта KiCad
-
sample.sch — файл схемы (поля элементов уже заполнены в соответствии с данным руководством)
Чтобы создать перечень элементов для схемы sample.sch нужно запустить kicadbom2spec, выполнить команду Файл→Открыть схему… и выбрать файл примера схемы. По умолчанию, он находится по следующему пути:
- Linux
-
/usr/share/kicadbom2spec/sample/sample.sch - Windows
-
C:\Program Files\kicadbom2spec\sample\sample.sch
В результате, в таблицу kicadbom2spec будут загружены элементы схемы и станет доступной команда Файл→Создать перечень элементов… (и соответствующая кнопка на панели инструментов):
На данном этапе, обычно, выполняется редактирование полей элементов с последующим сохранением изменений в файл схемы. Но в приведенном примере ничего редактировать не нужно, все поля уже заполнены и готовы к созданию перечня. Выполните команду Файл→Создать перечень элементов… — откроется диалог создания перечня элементов:
По умолчанию, файл перечня элементов предлагается расположить в каталоге со схемой. Но, так как файлы примера установлены вместе с программой в системный каталог, то у некоторых пользователей может быть недостаточно прав для записи в него. Нужно изменить место сохранения перечня, нажав кнопку справа от текстового поля — откроется диалог выбора файла. В нём нужно указать каталог, к которому пользователь может легко получить доступ, например — "Рабочий стол". Имя файла перечня элементов оставить без изменений — "sample.odt".
Для этого примера параметры нужно оставить со значениями по умолчанию, а именно:
-
формат файла "*.odt"
-
опция "Добавить единицы измерения" включена
-
опция "Вставить пробел перед единицами измерения" включена
-
остальные опции отключены
Теперь, когда все подготовлено, можно нажать кнопку Ок. После завершения генерации перечня элементов будет показано сообщение:
В указанном ранее каталоге (на Рабочем столе) появится новый файл sample.odt:
Готово — перечень элементов создан. Чтобы убедится что все выполнено верно и приложение kicadbom2spec работает корректно, можно сравнить полученный перечень с образцом sample.pdf.
1. Графический интерфейс пользователя
Внешний вид приложения kicadbom2spec показан на рисунке ниже.
Графический интерфейс пользователя имеет следующие основные элементы:
-
меню;
-
панель инструментов;
-
таблицу полей элементов.
Рассмотрим дальше каждый из этих элементов отдельно.
1.1. Меню
Меню располагается в верхней части окна и содержит следующие элементы:
-
Файл — содержит команды для работы с файлами.
-
Правка — содержит команды для редактирования полей элементов и настроек программы.
-
Вид — содержит элементы настройки внешнего вида программы.
-
Справка — содержит команды для получения справки.
1.1.1. Файл
В этом меню содержатся следующие команды для управления файлами:
-
Открыть схему… — открывает диалог для выбора файла схемы.
-
Недавние схемы — содержит список 10-и последних файлов схем.
-
Сохранить схему — сохраняет изменения полей элементов в файл схемы.
-
Сохранить схему как… — открывает диалог для сохранения схемы с изменёнными полями элементов в новый файл.
-
Открыть библиотеку… — открывает диалог для выбора файла библиотеки элементов.
-
Недавние библиотеки — содержит список 10-и последних файлов библиотек.
-
Сохранить библиотеку — сохраняет изменения полей элементов в файл библиотеки.
-
Сохранить библиотеку как… — открывает диалог для сохранения библиотеки с измененными полями элементов в новый файл.
-
Создать перечень элементов… — открывает диалог создания перечня элементов.
В данном окне указывается имя файла для перечня элементов, задаются некоторые параметры и редактируются поля основной надписи.
-
Выход — завершит выполнение программы, если имеются не сохранённые изменения — будет показано предупреждающее сообщение.
1.1.2. Правка
В этом меню содержатся следующие команды редактирования полей элементов:
-
Отменить — отменяет последнее изменение поля/полей элементов.
-
Повторить — повторяет отменённое ранее изменение.
|
Примечание
|
Все изменения сохраняются в оперативной памяти и количество сохраняемых изменений не ограничивается. При длительной работе с большим количеством элементов может использоваться значительный объем памяти и если это критично, то для её освобождения нужно сохранить схему/библиотеку и открыть её вновь. |
-
Копировать — копирует значения всех пользовательских полей выбранного элемента в буфер обмена.
-
Вырезать… — вырезает в буфер обмена значения полей элемента, которые были указаны в диалоге выбора полей. Значения полей, которые не были отмечены, просто копируются (без дальнейшего удаления).
|
Примечание
|
Команды Копировать и Вырезать… применяются только к одному элементу. Если при выполнении одной из этих команд будет выделено несколько элементов — отобразится предупреждающее сообщение с предложением применить операцию только к первому выделенному элементу. |
-
Вставить… — вставляет в выделенный(е) элемент(ы) значения из буфера обмена.
Вставка выполняется с помощью специального диалогового окна.
|
Примечание
|
Для организации копирования, вырезания и вставки полей элементов в программе реализован собственный буфер обмена. |
-
Найти… — открывает диалог поиска текста в полях элементов.
-
Заменить… — открывает диалог замены текста в полях элементов.
-
Редактировать поля… — открывает редактор полей для выделенного(ых) элемента(ов).
-
Очистить поля… — удаляет во всех выбранных элементах содержимое полей, указанных в диалоге выбора полей.
-
Параметры… — открывает редактор настроек.
-
Импорт параметров… — открывает диалог выбора файла, в который нужно сохранить текущие параметры программы.
-
Экспорт параметров… — открывает диалог выбора файла, из которого нужно загрузить параметры программы.
1.1.3. Вид
Меню вид содержит команды для управления внешним видом интерфейса пользователя:
-
Панель инструментов — с помощью этой команды можно скрыть или отобразить панель инструментов.
-
Панель полей компонента — с помощью этой команды можно скрыть или отобразить панель полей текущего компонента.
1.1.4. Справка
С помощью меню справки можно выполнить два действия:
-
Руководство пользователя — открывает данное справочное руководство.
-
О программе… — открывает диалоговое окно с краткими сведениями о программе kicadbom2spec.
1.2. Панель инструментов
Панель инструментов расположена в верхней части окна и повторяет часто используемые команды меню.
Здесь доступны следующие команды (в порядке расположения слева направо):
-
Открыть схему
-
Сохранить схему
-
Создать перечень элементов
-
Копировать
-
Вырезать
-
Вставить
-
Отменить
-
Повторить
-
Редактировать поля
-
Очистить поля
-
Найти
-
Заменить
-
Руководство пользователя
-
Панель полей компонента
В случае необходимости панель инструментов можно скрыть выбрав команду меню Вид→Панель инструментов.
1.3. Таблица полей элементов
Таблица полей элементов занимает основную часть окна приложения и имеет следующую структуру.
Каждая строка представляет собой элемент схемы или библиотеки, а столбцы — поля элементов. Всего столбцов девять:
-
Первый столбец не имеет названия и содержит во всех ячейках флажки. С помощью этих флажков можно выбирать элементы, которые нужно использовать при создании перечня элементов. По умолчанию, все элементы отмечены флажками. При редактировании файла библиотеки этот столбец хоть и отображается, но не используется.
-
Второй столбец Группа содержит текст одноимённого поля элемента.
-
Третий столбец Обозначение содержит текст одноимённого поля элемента. Это поле используется как уникальный идентификатор элемента и доступно только для чтения. Нормально заполненная схема не должна иметь элементов с одинаковыми обозначениями. Если в схеме есть не пронумерованные элементы (обозначение пустое или оканчивается вопросительным знаком, например, R?, C? и т.д.), то они не будут загружены в таблицу.
-
Четвёртый — девятый столбцы отображают содержимое полей Марка, Значение, Класс точности, Тип, Стандарт, Примечание, соответственно.
При редактировании библиотеки элементов, ячейки столбца Значение доступны только для чтения, изменять значение этого поля в элементах библиотеки нельзя.
1.3.1. Контекстное меню таблицы
Контекстное меню вызывается щелчком правой кнопки мыши или нажатием специальной клавиши на клавиатуре (между правыми Alt и Ctrl) над строкой таблицы или выделением нескольких строк.
Здесь собраны команды, позволяющие одновременно обрабатывать поля нескольких компонентов:
-
первые три команды Копировать поля, Вырезать поля… и Вставить поля… манипулируют с буфером обмена.
-
следующие две команды Редактировать поля… и Очистить поля… предназначены для непосредственного изменения значений полей выбранных компонентов.
-
последний пункт Подбирают при регулировании позволяет установить или снять одноимённою отметку с выбранных компонентов.
1.3.2. Редактор ячеек таблицы
Изменение содержимого отдельной ячейки таблицы выполняется с помощью специального элемента графического интерфейса — текстового поля с выпадающим списком.
Новое значение вводится непосредственно в текстовое поле или выбирается из списка доступных значений. Выпадающий список вызывается нажатием кнопки с символом списка справа от текстового поля или с клавиатуры — нажатием клавиши вниз. В нём содержатся стандартные значения для данного поля (располагаются вверху и выделены жирным), а также значения из других компонентов.
1.3.2.1. Контекстное меню редактора ячеек
Контекстное меню редактора ячеек содержит следующие команды:
-
Копировать — копировать выделенный текст.
-
Вырезать — вырезать выделенный текст.
-
Вставить — вставить текст из буфера обмена вместо выделенного текста.
|
Примечание
|
Операции копировать, вырезать и вставить взаимодействуют с системным буфером обмена. |
-
Удалить — удалить выделенный текст.
-
Выделить всё — выделить содержимое текстового поля.
-
Добавить "…" в стандартные — добавить текущее значение в список стандартных (этот пункт появляется если значение ещё отсутствует в стандартных для данного поля).
-
Удалить "…" из стандартных — удалить текущее значение из списка стандартных (этот пункт появляется если значение уже присутствует в стандартных для данного поля).
-
Вставить подстановку… — содержит подменю с командами вставки шаблонов подстановки значений из других полей.
1.4. Панель полей компонента
Для того чтобы посмотреть какие поля имеет компонент и какие им присвоены значения, можно воспользоваться панелью полей компонента.
Панель отображает информацию только для текущего компонента. Текущим считается тот компонент, на строке которого расположен курсор. Если посмотреть на показанное выше изображение можно увидеть, что в таблице элементов выделено несколько компонентов, но курсор расположен на строке компонента R1 (столбец Группа) и потому панель полей отображает информацию для R1.
Данную панель можно скрыть или отобразить через меню Вид→Панель полей компонента или с помощью кнопки на панели инструментов, которая располагается у правого края.
Панель содержит три информационных поля:
-
Сверху отображается обозначение компонента. Если компонент расположен на нескольких листах, то он имеет несколько обозначений, и в таких случаях все обозначения указываются через запятую (такое возможно при назначении одного и того же файла схемы нескольким иерархическим листам, см. Редактирование полей компонентов иерархических схем).
-
По-центру отображается таблица полей компонента. Она состоит из трёх колонок: номер, название и значение поля. Поля нумеруются начиная с нуля (как и в файле схемы). Любой компонент имеет как минимум четыре поля Обозначение, Значение, Поса.место и Документация, остальные поля — пользовательские.
-
Снизу отображается имя файла, в котором содержится текущий компонент. Это может быть полезным при работе с иерархическими схемами.
Вся информация на панели полей доступна только для чтения. Названия и значения полей можно скопировать используя контекстное меню:
|
Примечание
|
Панель отображает информацию, которая содержится в файле схемы. Это значит что новые изменения в таблице элементов не будут отображены на панели полей компонента, а будут показаны только после сохранения изменений в файл. |
2. Работа с программой
Работать с приложением kicadbom2spec довольно просто, но для полного понимания процесса формирования перечня элементов из файла схемы KiCad, нужно объяснить некоторые определения и условности.
2.1. Основные принципы
Компоненты из схем, выполненных в KiCad, имеют всего четыре стандартных поля:
-
Обозначение
-
Значение
-
Посад.место
-
Документация
Этого не достаточно для создания полноценного перечня элементов. Но KiCad позволяет каждому элементу добавлять пользовательские поля и, благодаря этому, становится возможным задать недостающую информацию для всех элементов.
Внесение недостающей информации для каждого компонента непосредственно в редакторе схем Eeschema — процесс довольно долгий, особенно, когда проект достаточно крупный. Решить эту проблему позволяет kicadbom2spec. С его помощью можно быстро и просто заполнить все необходимые поля и сформировать перечень элементов.
Для каждого компонента схемы/библиотеки kicadbom2spec использует следующий набор полей:
-
Группа
-
Обозначение
-
Марка
-
Значение
-
Класс точности
-
Тип
-
Стандарт
-
Примечание
|
Примечание
|
Курсивом выделены пользовательские поля, а жирным — стандартные. |
Элементы, имеющие одинаковые значения поля Группа и идущие подряд, будут озаглавлены указанным наименованием группы.
Значение поля Обозначение помещается в графу Поз. обозначение.
Из полей 3…7 формируется наименование элемента.
Значение поля Примечание помещается в одноимённую графу перечня.
Рассмотрим пример образования одной строки перечня элементов:
ЗНАЧЕНИЕ В ПЕРЕЧНЕ: |
ПОЛЕ ЭЛЕМЕНТА: |
|---|---|
Резисторы |
Группа |
R1 |
Обозначение |
МЛТ-0,25 |
Марка1 |
1,8к |
Значение2 |
±5% |
Класс точности1 |
В |
Тип1 |
ОЖ0.467.18 |
Стандарт1 |
1…2,8кОм |
Примечание |
Примечания:
|
Если какое-нибудь поле не нужно — его оставляют пустым. При этом разделители к пустому полю не добавляются.
Количество элементов подсчитывается автоматически. Если имеется несколько одинаковых элементов идущих подряд, они сводятся в одну строку с указанием первого, последнего элемента и их общего количества.
Компоненты сортируются в порядке возрастания их позиционных обозначений.
Группы формируются на основе буквенной части позиционных обозначений компонентов.
С помощью поля Группа компоненты объединяются одним заглавием.
2.2. Работа с таблицей полей элементов
2.2.1. Сортировка элементов
Для облегчения процесса редактирования полей предусмотрена возможность сортировки содержимого таблицы.
После загрузки элементов из файла схемы/библиотеки таблица сортируется по содержимому столбца Обозначение.
Чтобы изменить порядок элементов нужно нажать левой кнопки мыши на заголовке столбца, по содержимому которого должна производится сортировка. Например, если нужно отобразить элементы собранные по группам и в алфавитном порядке — нужно нажать на заголовок столбца Группа. Если нажать ещё один раз — содержимое отобразится в обратном порядке.
В заголовке столбца, по которому выполнена сортировка, отображается индикатор с указанием направления сортировки.
|
Примечание
|
Элементы управления операционной системы Windows XP не поддерживают Unicode, поэтому там используются символы < и > в качестве индикаторов сортировки. |
2.2.2. Выделение элементов
Чтобы выделить один элемент нужно нажать левой кнопкой мыши (ЛКМ) на одном из его полей.
Если необходимо выделить несколько элементов подряд — нужно выделить первый нужный элемент, затем нажать клавишу Shift и не отпуская её нажать ЛКМ на последнем нужном элементе. Эту же операцию можно выполнить другим способом — нажать ЛКМ на первом нужном элементе и не отпуская её тянуть курсор к последнему нужному элементу и после этого отпустить ЛКМ.
Чтобы выделить несколько не последовательных элементов нужно выделить первый элемент, а последующие выделять при нажатой клавише Ctrl.
2.2.3. Поиск/замена текста
Чтобы найти текст в полях элементов нужно воспользоваться командной Правка→Найти… После выбора данной команды будет открыт диалог поиска текста в котором нужно ввести фрагмент текста в текстовое поле и для поиска ниже выделенного элемента, нажать кнопку Далее или нажать клавишу Enter. Для поиска текста в обратном направлении нужно нажать кнопку Назад.
Чтобы уточнить результаты поиска можно воспользоваться опциями:
-
С учётом регистра – поиск будет выполнен учитывая регистр введённых букв;
-
Слово целиком – будут найдены только те слова, которые полностью соответствуют введённому поисковому запросу.
|
Важно!
|
Если включена опция Слово целиком и запрос состоит из нескольких слов, то они никогда не будут найдены (если нужно найти слово, то и запрос должен быть словом). |
Для замены текста используется команда Правка→Заменить… При её выборе появится расширенное диалоговое окно поиска — диалог замены текста. В начале выполняется поиск фрагмента текста, который нужно заменить подобно тому как было описано ранее. Далее вводится текст на который нужно заменить найденный фрагмент в поле Заменить на и нажатием кнопки Заменить выполняется замена.
2.2.4. Редактирование полей
Любое изменение в таблице можно отменить с помощью команды меню Правка→Отменить, а отменённое действие повторить с помощью команды Правка→Повторить. Если после отмены было произведено новое изменение то команда повтора становится недоступной.
Для редактирования содержимого полей предусмотрено несколько способов.
Прежде всего, каждое доступное для редактирования поле можно править щёлкнув по нему двойным щелчком ЛКМ. В случае с флажками — однократный щелчок ЛКМ изменит его состояние на противоположное. Эти же операции можно выполнять с клавиатуры. С помощью стрелок нужно переместиться к ячейке с содержимым поля, которое необходимо изменить и нажать клавишу Enter или F2 для начала редактирования. Для изменения состояния флажка нужно нажать клавишу пробел.
Изменение содержимого ячеек выполняется с помощью редактора ячеек. При его активации, выпадающий список заполняется следующим образом. Сначала в него добавляются стандартные значения (если они имеются) и, затем, все уникальные значения этого же поля других компонентов.
Чтобы добавить новое значение в список стандартных для текущего поля, можно воспользоваться контекстным меню. Аналогичным образом текущее значение можно удалить из стандартных, если оно там уже присутствует.
2.2.5. Редактирование полей нескольких элементов одновременно
Для редактирования полей нескольких элементов одновременно нужно воспользоваться редактором полей. Для этого необходимо выделить элементы для редактирования и затем выполнить команду Правка→Редактировать поля…, откроется редактор полей. Он содержит флажок для указания того, нужно ли помещать выделенные элементы в перечень элементов или нет (при редактировании библиотеки — отсутствует) и текстовые поля с выпадающим списком (аналог редактора ячеек) для редактирования полей элементов. В отличии от редактора ячеек, в редакторе полей значения для каждого поля собираются не со всех компонентов, а только с выделенных.
По умолчанию, во всех текстовых полях редактора полей установлено значение <не изменять>, указывающее на то, что значение полей не будет изменено. Это позволяет редактировать только нужные поля, а остальные оставить без изменений. Чтобы изменить значение поля всех выделенных элементов нужно заменить надпись <не изменять> на нужное значение и нажать кнопку Ок.
Значения полей одного или нескольких элементов можно очищать. Для этого существует команда меню Правка→Очистить поля…, после выбора которой отобразится диалог выбора полей. Чтобы очистить нужные поля — их необходимо отметить и нажать кнопку Ок.
2.2.6. Работа с буфером обмена
При редактировании полей доступны операции для работы с буфером обмена Правка→Копировать/Вырезать…/Вставить…
Буфер может хранить набор полей одного из элементов, поэтому команды Копировать и Вырезать… применимы только к одному компоненту. Если при выполнении одной из этих команд будет выделено несколько элементов — отобразится предупреждающее сообщение с предложением применить операцию только к первому выделенному элементу. Команду Вставить… можно применять сразу к нескольким выделенным элементам.
При копировании, в буфер обмена сохраняются значения всех полей выделенного элемента.
При вырезании выполняется копирование значений всех полей с последующей очисткой только тех полей, которые будут указаны в диалоге выбора полей.
При вставке открывается диалоговое окно вставки полей.. В каждом поле этого окна содержится значение из буфера обмена. По умолчанию, в выпадающем меню содержится два варианта значений, первое — <не изменять>, второе — значение из буфера. Данный набор позволяет вставить из буфера обмена только нужные значения.
2.2.7. Редактирование полей компонентов иерархических схем
С помощью KiCad можно создавать довольно сложные схемы, содержащие множество иерархических листов неограниченной вложенности. Компоненты таких схем собираются со всех листов, включая иерархические, в один список и формируют единый перечень элементов.
Ещё одной особенностью САПР KiCad, при создании сложных схем, является возможность использования одного и того же файла схемы для нескольких иерархических листов. Таким образом можно изобразить некое количество повторяющихся однотипных узлов. В данном случае компоненты иерархической схемы сохраняются особым образом. Дело в том, что несколько однотипных листов ссылаются к одной и той же схеме и, таким образом, эти однотипные листы используют одни и те же компоненты. Эти компоненты содержат специальные свойства, в которых указаны обозначения для каждого из листов, т.е. каждый из таких компонентов имеет несколько обозначений. Изменение значения поля компонента в одном из однотипных листов приведёт к изменению этого же поля, такого же компонента, в остальных листах.
В kicadbom2spec такие компоненты отображаются особым образом. Компоненты одного из повторяющихся однотипных листов принимаются за "оригинальные", а компоненты остальных листов как "копии". Это разделение условно и сделано для удобства редактирования.
"Оригинальные" компоненты отображаются в таблице с префиксом "(*)". Если увидите компонент с данной пометкой, например, (*)R256, значит где-то в таблице имеются его "копии".
"Копии" компонента, в свою очередь, в поле Обозначение содержат обозначение "оригинального" компонента заключённое в скобки. Например, (R256)R123.
Так как "оригинальные" компоненты и их "копии", по сути, являются одним компонентом с одним набором полей, но с несколькими обозначениями, то значения полей у них всегда равны. Поэтому редактировать можно только "оригинальные" компоненты. После изменения поля "оригинального" компонента, соответствующее поле "копий" примет такое же значение. "Копии" доступны лишь для чтения и отображаются для предоставления полного перечня элементов.
Если в процессе редактирования дважды щёлкнуть мышей по "копии", отобразиться информационное сообщение с предложением перейти к "оригинальному" компоненту.
При формировании перечня элементов будут использоваться обычные обозначения без каких либо пометок (в данном случае без "(*)" и "(256)"). Они используются только для удобства редактирования.
2.2.8. Подстановки полей
В процессе работы kicadbom2spec использует фиксированный набор полей. В то же время, пользователь может хранить некоторую информацию в других пользовательских полях или в стандартных полях, которые не используются в kicadbom2spec (Посад.место, Документация). Для того чтобы включить эти данные в перечень элементов используются подстановки полей.
Принцип работы следующий. В полях, с которыми работает kicadbom2spec, вставляются специальные метки:
${Название_поля}
При формировании перечня элементов kicadbom2spec обрабатывает каждый элемент и когда находит подобную метку — ищет в этом же компоненте поле с названием Название_поля. Далее, метка заменяется содержимым найденного поля. Если поле с указанным именем не найдено, метка просто удаляется.
Подобные метки можно вводить вручную с клавиатуры или воспользоваться контекстным меню в редакторе ячеек. В нём всегда присутствуют подстановки четырех стандартных полей. Чтобы вставить подстановку пользовательского поля, можно выбрать Вставить подстановку…→Другую…. При этом в текстовое поле будет вставлена пустая метка с курсором внутри скобок для ввода названия нужного поля.
Метки могут быть окружены текстом, т.е. помимо меток в поле можно указывать и другую информацию. Также, в поле можно вставлять несколько меток.
Для примера предположим, что в перечне элементов компоненту схемы нужно указать тип корпуса. Используем для этого поле Примечание и заполняем его следующим образом:
В корпусе ${Посад.место}
Компоненту присвоено посадочное место, скажем, DIP16. Тогда в перечне элементов, в поле Примечание получим:
В корпусе DIP16
2.2.9. Метка "Подбирают при регулировании"
Компоненты, номиналы которых требуют подбора при наладке, обычно отмечаются меткой "*" в виде суффикса обозначения компонента. Чтобы добавить такую метку в kicadbom2spec, необходимо воспользоваться контекстным меню таблицы полей. Операция применима как одному, так и к нескольким элементам таблицы.
Метка "*" сохраняется в файл схемы в виде отдельного поля компонента, которое называется Подбирают при регулировании и содержит значение "*". Параметры поля устанавливаются такими же как и у обозначения компонента, а позиция вычисляется таким образом, чтобы значение "*" размещалось после обозначения, дополняя его. По умолчанию, поле создаётся заново при каждом сохранении для вычисления актуального положения. Но в некоторых случаях, корректно вычислить позицию поля невозможно. В таких случаях, пользователь может сам в Eeschema отредактировать поле так, как потребуется. Для того чтобы kicadbom2spec не перезаписал эти исправления, необходимо установить значение поля отличным от "*", например "* " (добавить пробел). При сохранении компонентов, kicadbom2spec проверяет, отличается ли значение поля Подбирают при регулировании от значения по умолчанию ("*"). Если отличается, то поле сохраняется без изменений, в противном случае — поле создаётся заново.
2.3. Создание перечня элементов
Если в kicadbom2spec загружен файл схемы и все необходимые поля заполнены — можно приступить к созданию перечня элементов. Для этого нужно выполнить команду Файл→Создать перечень элементов…, откроется диалог создания перечня элементов.
2.3.1. Файл
На первой вкладке Файл можно указать расположение и имя файла для перечня элементов, а также выбрать формат файла. По умолчанию, имя образуется из имени файла схемы путём замены расширения *.sch на расширение, соответствующее текущему формату. Если же данный вариант не устраивает, можно исправить имя в текстовом поле или с помощью диалога выбора файлов, нажав кнопку справа от текстового поля.
Перечень элементов может быть сохранён в одном из доступных форматов:
-
Текстовый документ (*.odt)
-
Электронная таблица (*.ods)
-
Табличные данные (*.csv)
Текстовый докумен, по сравнению с электронной таблицей, имеет больший размер, дольше генерируется, но с ним удобнее работать, так как все страницы представлены единым документом, в то время как в электронной таблице каждая страница представлена в виде отдельной таблицы.
Также нужно заметить, что в электронной таблице для текста, который превышает длину ячейки, автоматически уменьшается размер шрифта средствами LibreOffice Calc. А вот LibreOffice Writer такой функциональности не имеет, поэтому в подобной ситуации kicadbom2spec уменьшает ширину текста (сохраняя размер шрифта).
Формат *.csv используется для экспорта данных перечня элементов. Файл является обычным текстовым документом и имеет стандартные, для этого формата, параметры:
-
разделитель — запятая (,)
-
разделитель текста — кавычки(")
-
кодировка — Юникод (UTF-8)
Перечень элементов в формате *.csv можно открыть в LibreOffice Calc, он будет показан в виде простой таблицы без форматирования. В первой строке указаны заголовки столбцов, а далее, все компоненты в том же виде, что и в обычном перечне, включая пустые строки и заголовки групп элементов.
2.3.2. Параметры
Конечный вид перечня элементов можно настроить с помощью следующих параметров:
-
Все элементы — если этот параметр отмечен, то перечень будет составлен из всех элементов схемы, т.е. состояние флажка в таблице будет проигнорировано.
-
Добавить единицы измерения — если этот параметр отмечен и в значениях резисторов/конденсаторов/индуктивностей (определяется по первым литерам обозначения R, C, L) отсутствуют единицы измерения (например, 10к, 1мк, 2.2м), то они будут добавлены автоматически (10кОм, 1мкФ, 2.2мГн).
Дополнительно, к значению ёмкости конденсаторов добавляется приставка множителя, если оно представлено в виде целого числа — п (пико), а если в виде десятичной дроби — мк (микро).
Работает данная функция следующим образом, kicadbom2spec пытается определить цифровую часть значения и множитель. В случае удачного определения, значение будет приведено в нормальный вид и будут добавлены единицы изменения. В противном случае, значение останется без изменений. В качестве десятичного разделителя используется запятая. Единицы изменения и множители, указанные в международном формате, будут переведены.
Примеры:
| На схеме | В перечне |
|---|---|
Конденсаторы |
|
1.2 |
1,2мкФ |
1200 |
1200пФ |
1н2 |
1,2нФ |
12 μF |
12мкФ |
120u |
120мкФ |
Резисторы |
|
4.7 |
4,7Ом |
4R7 |
4,7Ом |
R47 |
0,47Ом |
470 |
470Ом |
4,7k |
4,7кОм |
4.7 kOhm |
4,7кОм |
4,7 kΩ |
4,7кОм |
4M7 |
4,7МОм |
Дроссели |
|
910 |
910мкГн |
910u |
910мкГн |
910мк |
910мкГн |
9m1 |
9,1мГн |
910 uH |
910мкГн |
-
Вставить пробел перед единицами измерения — этот параметр становится доступным, если предыдущий установлен. По умолчанию единицы измерения добавляются к значению слитно, но данный этот параметр установлен то цифровая часть значения будет отделена пробелом от единиц измерения с множителем.
-
Вставлять пустую строку после наименования группы — если этот параметр установлен, то между наименованием группы и первым её элементом будет вставляться одна пустая строка.
-
0..9 пустых строк между разными типами элементов — все компоненты в перечне группируются и сортируются по их обозначению. Между группами элементов с разным обозначением будет вставлено указанное число пустых строк.
-
Вставлять пустые строки между разными группами — если этот параметр установлен, то указанное в предыдущем параметре число пустых строк будет вставлено и между элементами с однотипным обозначением, но разным значением поля "Группа".
-
Запретить пустые строки в начале страницы — при вставке пустых строк, может случиться так, что они окажутся в начале следующей страницы. Если этот параметр установлен, то пустые строки будут вставляться только до конца текущей страницы. Таким образом, каждая страница будет начинаться с компонента или наименования группы.
-
Указывать стандарт в наименовании группы — по умолчанию, в наименовании группы указывается только содержимое поля "Группа". Если этот параметр установлен, то в наименовании группы будет также указан стандарт и марка компонентов, к которому он применим. Если все элементы в группе имеют единый стандарт, то в наименовании группы указывается только имя группы и стандарт, без указания марки. Если же в группе имеются компоненты с разным значением поля стандарт, то будет сформировано несколько наименований группы для каждого стандарта с указанием марки. Эти наименования указываются подряд в начале группы. Если марка компонентов с одинаковым стандартом отличается (например, МЛТ-0,125 и МЛТ-0,25), то будет указана общая часть марки (МЛТ).
-
Указывать наименование группы единственного элемента в строке компонента — если группа компонентов состоит из одного компонента (например, в схеме имеется одна микросхема, соответственно, в группе "Микросхемы" будет содержаться лишь один элемент), то, по умолчанию, для него в перечне будет создано две строки, в одной будет указано наименование группы, в другой — сам компонент. Если этот параметр включен, то такие компоненты будут записываться одной строкой, причём имя группы будет указано в начале наименования компонента в единственном числе.
Наименования групп в единственном числе берутся из словаря (см. раздел Словарь) и в случае отсутствия, в процессе создания перечня элементов будет показано диалоговое окно с запросом на ввод варианта наименования группы в единственном числе, которое в последующем будет добавлено в словарь. -
Объединять группы с одинаковыми именами — компоненты разбиваются на группы по буквенно-позиционным обозначениям, но могут иметь одинаковое наименование группы. Если параметр отмечен, то последовательно идущие группы с одинаковыми именами будут объединены в одну, даже если компоненты имеют разные обозначения.
-
Запретить наименования групп в конце страницы — в процессе формирования перечня элементов может возникнуть ситуация, при которой внизу страницы окажется только наименование группы, а компоненты будут расположены на следующей странице. Если этот параметр отмечен, то в подобных ситуациях наименование будет перенесено на следующую страницу, а на его месте останется пустая строка.
-
Добавить графы первичной применяемости — если этот параметр отмечен, то форматная рамка будет содержать графы первичной применяемости (24, 25 по ГОСТ2.104-2006). Данные графы не являются обязательными и вводятся при необходимости.
-
Указать первичную применяемость — этот параметр становится доступным, если предыдущий установлен. Если отметка установлена, то в графу Перв. примен. будет помещено значение децимального номера без кода документа.
-
Добавить графы заказчика — если этот параметр отмечен, то над основной надписью будут показаны графы заказчика (27-30 по ГОСТ2.104-2006). Данные графы не являются обязательными и вводятся при необходимости.
-
Добавить лист регистрации изменений, если количество листов больше 0…9999 — если данная опция включена и количество листов перечня превышает указанное число, то в конец перечня элементов будет добавлен лист регистрации изменений. Если установить 0 в поле ввода, то лист регистрации изменений будет добавляться всегда (при условии, что параметр отмечен).
-
Курсив — если этот параметр активен, то при формировании перечня элементов будет использован курсив. В противном случае, будет использоваться прямой шрифт.
-
Подчёркивать наименования групп — если параметр отмечен, то наименование группы будет подчёркнуто сплошной линией.
-
Наименование группы по центру — если параметр отмечен, то наименование группы будет выровнено по центру ячейки таблицы. По умолчанию, оно выравнивается по левому краю.
-
Поз. обозначение по центру — если параметр отмечен, то позиционное обозначение компонента будет выровнено по центру ячейки таблицы. По умолчанию, оно выравнивается по левому краю.
-
Переносить текст на следующую строку, если ширина шрифта меньше 1…99% — если значение ячейки очень длинное и уменьшение ширины шрифта чрезмерно, текст разбивается на несколько строк. Нижний предел ширины шрифта можно регулировать с помощью данного параметра. Текст переносится только в трёх графах перечня: Поз. обозначение, Наименование, Примечание. Наименование и примечание разделяется в месте пробела (т.е. по словам). Поз. обозначения разделяются в месте разделителя:
-
если идёт перечисление поз. обозначений, то перенос будет выполнен после запятой, а пробел, идущий за ней, будет опущен; следующая строка начнётся со следующего поз. обозначения;
-
если указан диапазон поз. обозначений, то перенос будет выполнен после дефиса; следующая строка будет начата с дефиса, указывая на продолжение разорванного диапазона.
-
-
Открыть перечень элементов — если этот параметр установлен, то по завершении будет открыт созданный перечень элементов в редакторе по умолчанию (например, в LibreOffice).
2.3.3. Основная надпись
Помимо параметров, в диалоговом окне создания перечня элементов имеется вкладка со значениями полей основной надписи. Эта информация загружается из файла схемы, за исключением поля Нормоконтролер, которое хранится в настройках программы. Все эти значения доступны для редактирования. Новые значения сохраняются вместе со значениями полей элементов при сохранении файла схемы. Значения полей Децимальный номер и Наименование автоматически корректируются согласно ЕСКД перед помещением в основную надпись перечня элементов. Результат коррекции можно наблюдать рядом с полями ввода.
|
Примечание
|
Формат файла схемы KiCad не позволяет хранить имя нормоконтролёра, поэтому данное значение хранится в настройках программы kicadbom2spec. |
2.3.4. Примечания
Когда все параметры заданы, можно запустить создание перечня нажав кнопку Ок. После успешного завершения генерации перечня элементов будет показано сообщение:
Если перед созданием перечня был установлен параметр Открыть перечень элементов, то сообщение о завершении не отображается, вместо него будет открыт созданный перечень элементов.
При создании перечня элементов из Eeschema в директории фала схемы автоматически создаются два новых файла: один с названием схемы и расширением *.xml, второй тоже с названием схемы, но без расширения. Они не используются программой kicadbom2spec и если в них нет необходимости, могут быть удалены.
3. Настройка программы
Редактор настроек вызывается из меню с помощью команды Правка→Параметры….
Все настройки разбиты на группы, каждая из которых расположена на отдельной вкладке.
3.1. Основные параметры
Эти параметры относятся к программе в целом. Рассмотрим каждый из параметров в отдельности.
Отображать пробелы в виде точек "·" — если этот параметры установлен, то в таблице полей и поле ввода редактора ячеек/полей пробелы будут показаны в виде специального символа "·".
Показывать метку "*" возле обозначения на схеме — если этот параметр установлен, то содержимое поля "Подбирают при регулировании" (метка "*") будет отображаться на схеме, иначе оно будет скрыто.
Автоматически заполнять поле "Группа" — данный параметр позволяет несколько автоматизировать процесс оформления перечня элементов. А именно, для заданных типов элементов автоматически заполнять поле "Группа" при загрузке документа.
|
Примечание
|
Автоматическое заполнение применяется только к элементам с пустым полем "Группа". |
Для организации пар тип элемента — значение поля "Группа" предусмотрен специальный редактор, в котором доступны три действия Добавить, Изменить и Удалить. Существующие элементы отображаются в списке и могут включаться или отключаться с помощью отметок.
Чтобы добавить новый элемент нужно нажать на кнопку Добавить после чего отобразится диалоговое окно, как показано на рисунке:
В этом диалоге нужно заполнить два поля.
Первое из них Обозначение элемента — это один или два символа, из которых
состоит обозначение элемента (позиционное обозначение без порядкового номера),
и по которым можно определить принадлежность элемента к группе. Например, "С"
для конденсаторов, "R" для резисторов, "VT" для транзисторов, "D" для
аналоговых и цифровых микросхем (если нужно конкретизировать можно указать "DA"
для, скажем, стабилизаторов или операционных усилителей) и т.д.
Также, доступны два шаблонных символа:
? — один любой символ,
* — множество любых символов,
которые позволяют расширить выбор компонентов. Например "R?" — обозначит все
типы резисторов: переменные, шунты, терморезисторы и т.д.
Второе — Значение поля "Группа" — здесь нужно задать значение поля Группа, которое будет автоматически присваиваться элементам, обозначение которых начинается с символов, указанных в предыдущем поле.
Если нужно отредактировать уже существующий элемент, необходимо его выделить и нажать кнопку Изменить или произвести двойной щелчок ЛКМ по элементу списка. В результате откроется диалоговое окно, подобное диалогу создания элемента.
Для сохранения выполненных изменений нужно нажать кнопку Ок, для отмены — Отмена.
Чтобы удалить элемент из списка, нужно выделить его и нажать кнопку Удалить.
3.2. Значения полей
При оформлении перечня элементов, заполняя поля элементов часто приходится использовать стандартные значения, такие, например, как "Резисторы", "Конденсаторы", "Диоды" и т.д. для поля Группа или "±1%", "±5%", "±10%" для поля Класс точности.
Чтобы ускорить процесс заполнения перечня предусмотрена возможность задавать стандартные значения для определённых полей элементов. Делается это с помощью вкладки Значения полей редактора настроек.
Для каждой группы можно задать несколько значений, которые записываются в виде отдельных строк.
При редактировании элементов все эти варианты значений будут всегда присутствовать в выпадающем списке.
3.3. Разделители
В процессе формирования перечня наименование элементов образуется путём объединения значений таких полей:
-
Марка
-
Значение
-
Класс точности
-
Тип
-
Стандарт
Чтобы отделить значения указанных полей друг от друга используются разделители в виде префиксов и суффиксов.
Это позволяет избавится от необходимости вводить дополнительные символы при редактировании полей элементов.
Например, значение поля Стандарт, практически, всегда отделяется от наименования пробелом. Чтобы не вводить каждое значение стандарта с пробелом в начале, достаточно в параметрах указать префикс для этого поля в виде пробела и он будет добавляться автоматически.
К пустому полю разделители не добавляются. Т.е. если при формировании перечня элементов встречается поле с пустым значением, то соответствующие ему разделители в наименование вставляться не будут.
|
Примечание
|
Так как в составе разделителей могут использоваться пробелы, то для повышения читабельности, в полях ввода символы пробелов обозначаются специальным символом "·". |
В нижней части окна расположена панель предварительного просмотра наименования с заданными разделителями. Это поле обновляется автоматически при редактировании префиксов и суффиксов. Каждое поле (марка, значение, класс точности, тип, стандарт) со своим префиксом и суффиксом обозначается отдельным цветом для лучшей наглядности. В качестве значения полей используются их наименования. Отсутствие или наличие значения поля можно имитировать с помощью отметок под наименованием. Если отметка установлена, то одноимённое поле попадает в наименование со своим префиксом и суффиксом. Если отметка снята, то, соответственно, ни значение поля, ни его разделители в наименование не попадают. Отметки влияют только на предварительный просмотр.
3.4. Псевдонимы
В процессе работы приложение kicadbom2spec использует фиксированный набор полей. По умолчанию требуется, чтобы элементы схемы содержали эти поля. Но это не является обязательным. С помощью вкладки Псевдонимы редактора настроек можно каждому полю назначить любое пользовательское поле.
|
Примечание
|
Псевдонимы применяются только при открытии или сохранении файла
схемы/библиотеки. При изменении псевдонимов с уже открытым файлом схемы/библиотеки, необходимо заново открыть этот файл для применения новых значений. |
Благодаря этому, при открытии файла схемы/библиотеки загружается значение поля указанного в качестве псевдонима и помещается в графу стандартного поля. А при сохранении значение из стандартного поля присваивается полю элемента указанного в качестве псевдонима. Здесь под стандартными полями подразумевается набор полей, необходимый для работы приложения kicadbom2spec.
Для примера рассмотрим следующую ситуацию. Предположим, пользователь хранит полное наименование элементов в собственном поле BOM_ID и не нуждается в автоматическом составлении наименования из стандартных полей средствами kicadbom2spec. В таком случае достаточно назначить псевдоним BOM_ID для поля Значение, а поля Марка, Класс точности, Тип и Стандарт оставить пустыми. В результате, при формировании перечня элементов наименование будет состоять лишь из значения поля BOM_ID.
3.5. Словарь
Если параметр Указывать наименование группы единственного элемента в строке компонента включен то при формировании перечня элементов потребуются наименования групп в единственном числе. Для их нахождения в программе kicadbom2spec используется "словарь". Просмотреть и отредактировать его содержимое можно на вкладке Словарь редактора настроек. На ней расположена таблица, состоящая из двух колонок В множественном числе и В единственном числе. Каждая строка представляет собой элемент словаря.
Элементы словаря можно добавлять, изменять и удалять с помощью кнопок, расположенных справа от таблицы.
При добавлении или редактировании будет показано специальное диалоговое окно:
|
Примечание
|
Если при формировании перечня элементов потребуется наименование группы в единственном числе, которого нет в словаре, то будет показано данное диалоговое окно с последующим добавлением нового элемента в словарь. |
3.6. Файл параметров
Файл, содержащий пользовательские настройки, называется settings.ini. Его расположение зависит от используемой операционной системы:
- Linux
-
~/.config/kicadbom2spec/ - Windows
-
%APPDATA%\kicadbom2spec\
В каталоге с файлами программы kicadbom2spec, тоже имеется файл settings.ini — в нём содержатся параметры со значениями по умолчанию. Если kicadbom2spec установлен впервые, то этот файл копируется в качестве пользовательского, в указанный выше каталог.
3.7. Импорт/экспорт параметров
Выполнить перенос параметров из одной копии программы в другую можно следующим образом.
В первой копии программы необходимо выбрать пункт меню Правка→Экспорт
параметров… и в диалоге сохранения файлов указать в какой файл нужно
сохранить текущие настройки. По умолчанию, имя файла — settings.ini, его
можно изменить по своему усмотрению.
Далее нужно во второй программе выбрать пункт меню Правка→Импорт параметров… и в диалоге открытия файлов выбрать файл, полученный в предыдущем шаге. После этого откроется диалоговое окно выбора параметров.
Будут загружены только отмеченные параметры, остальные останутся без изменений.
Для завершения импорта параметров нужно нажать кнопку ОК.
4. Параметры командной строки
При запуске программы kicadbom2spec, ей можно передавать один или два позиционных аргумента. Это даёт возможность подключать kicadbom2spec к редактору схем Eeschema в качестве плагина.
python kicadbom2spec.pyw [-h] [-v] [schematic] [complist]
4.1. Первый позиционный аргумент schematic
С помощью этого параметра в программу передаётся имя файла схемы в формате KiCad Schematic.
Так как при запуске kicadbom2spec в качестве плагина Eeschema, ей передаётся в первом параметре имя файла списка цепей (*.xml), то для обеспечения правильной работы применяется следующий процесс обработки параметра:
-
считывается имя файла;
-
удаляется расширение;
-
добавляется расширение *.sch;
-
проверяется наличие файла с полученным именем:
-
если файл существует — его содержимое загружается для дальнейшего редактирования;
-
если файл не существует — открывается диалог выбора файла схемы вручную.
-
4.2. Второй позиционный аргумент complist
С помощью этого параметра в программу передаётся имя файла в который будет сохранен перечень элементов. Если указан не поддерживаемый формат файла, то расширение файла автоматически заменяется на *.ods.
4.3. Параметр -h, --help
С этим параметром программа выводит справочное сообщение с краткой информацией о программе и доступных параметрах. Затем закрывается без выполнения каких-либо вычислений.
4.4. Параметр -v, --version
С этим параметром программа выводит номер текущей версии программы и закрывается без выполнения каких-либо вычислений.
5. Настройка KiCad для работы с kicadbom2spec
Возможности программы Eeschema позволяют использовать сторонние инструменты для создания перечней элементов. Как использовать в данном случае kicadbom2spec будет рассказано далее.
5.1. Создание и настройка плагина
В Eeschema нужно выполнить команду Инструменты→Сформировать перечень элементов или нажать соответствующую кнопку на панели инструментов, после чего откроется диалог:
Чтобы добавить новый инструмент генерации перечня элементов нужно нажать кнопку Добавить плагин. Откроется диалог выбора файлов в котором необходимо указать файл программы. По умолчанию, kicadbom2spec находится по следующему пути:
- Linux
-
/usr/share/kicadbom2spec/kicadbom2spec.pyw - Windows
-
C:\Program Files\kicadbom2spec\kicadbom2spec.pyw
Нужно выбрать его. После этого откроется диалоговое окно, в котором будет предложено ввести имя плагина (по умолчанию, "kicadbom2spec" — формируется автоматически на основе имени файла плагина) и подтвердить создание нажатием кнопки Ок.
Теперь, когда плагин создан, в диалоговом окне отобразится новый элемент с указанным ранее названием. Поле Команда KiCad заполнит автоматически.
В операционных системах на базе Linux могут быть установлены обе версии Python2 и Python3 — нужно указать конкретную версию Python, как показано на рисунке ниже.
В операционных системах MS Windows диалог создания перечня элементов немного отличается. Там присутствует специальный параметр Показать окно консоли. Нужно установить отметку напротив этого параметра — это очень важно, без него окно программы не будет отображаться!
После этого плагин готов к работе. Его можно запустить нажатием кнопки Сформировать.