Руководство пользователя Версия для операционных систем ms windows

Скачать 153.97 Kb.

Название	Руководство пользователя Версия для операционных систем ms windows
Дата публикации	27.06.2013
Размер	153.97 Kb.
Тип	Руководство пользователя

odtdocs.ru > Информатика > Руководство пользователя

kicadbom2spec

Руководство пользователя

Версия для операционных систем MS Windows

Содержание

Введение 3

1. Установка необходимых программ и компонентов 4

1.1 python 4

1.2 odfpy 8

1.3 opengostfont 12

1.4 LibreOffice 12

2. Работа с программой kicadbom2spec 13

2.1 Режим графического пользовательского интерфейса 13

2.2 Режим командной строки 16

2.2.1 Параметр -b, --bom 17

2.2.2 Параметр -s, --schematic 18

2.2.3 Параметр -o, --output 19

2.2.4 Параметр -c, --console 19

2.2.5 Параметр -v, --verbose 19

2.2.6 Параметр -h, --help 19

3. Генерация перечня элементов (BOM), пригодного для создания спецификации 20

3.1 Настройка редактора схем EEschema 20

3.2 Создание перечня элементов (BOM) 21

Введение

kicadbom2spec — программа, написанная на языке python и предназначена для создания файлов спецификации в виде таблиц *.ods в формате Open Document Format, оформленных согласно требованиям ЕСКД, используя файлы перечней элементов (BOM), созданных с помощью программы EEschema из пакета программ САПР KiCAD.

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

Примечание: в данном руководстве указаны версии программ и файлов доступные на момент написания данного руководства и могут отличаться от существующих.
^

1. Установка необходимых программ и компонентов

Программа kicadbom2spec написана на языке python и по сути является обычным текстовым файлом (если попытаться запустить двойным щелчком файл kicadbom2spec.pyw он откроется в текстовом редакторе). Для того, чтобы заставить ее работать нужно установить интерпретатор языка python, который будет считывать команды из файла, строку за строкой, и выполнять их.

Файл спецификации имеет формат Open Document Format и сохраняется в виде электронной таблицы отформатированной таким образом, чтобы соответствовать требованиям ЕСКД. Для облегчения работы с файлами в данном формате используется модуль odfpy, который устанавливается как расширение интерпретатора языка python.

Шаблон спецификации был создан с помощью свободного офисного пакета LibreOffice с применением открытого чертежного шрифта opengostfont. Наличие данных элементов не обязательно, но крайне желательно, дабы получить спецификацию с корректным форматированием. Известно, что MS Office Word неправильно воспроизводит форматирование при открытии сгенерированного файла спецификации.

О том как установить нужные элементы для корректной работы kicadbom2spec будет рассказано далее на примере операционной системы MS Windows XP.

1.1 python

В данном случае нужен интерпретатор языка python версии 2. Устанавливается он как обычное приложение:

для начала нужно скачать файл установки с официального сайта www.python.org. На главной странице можно найти ссылку для скачивания, например, как показано на рис.1.

Рисунок 1. Ссылка на скачивание python2

после нажатия на ссылку появится диалоговое окно (рис. 2). Если нажать на кнопку «Выполнить», файл сохранится во временную папку и после завершения загрузки начнется процесс установки. А если нажать на кнопку «Сохранить» - появится диалог сохранения файла, в котором нужно указать место, куда нужно сохранить загружаемый файл и после окончания загрузки он не будет выполнятся автоматически (его можно будет запустить вручную).

Рисунок 2. Диалоговое окно

Нажимаем кнопку «Выполнить».

далее начинается загрузка файла установки (рис. 3).

Рисунок 3. Загрузка файла

После завершения загрузки откроется мастер установки интерпретатора python (рис. 4). Настройки по умолчанию нас устраивают, поэтому в процессе установки ничего не изменяем, а просто нажимаем кнопку «Next >».

Рисунок 4. Начало установки

Рисунок 5. Выбор места установки

Рисунок 6. Выбор элементов установки

Рисунок 7. Процесс установки

Рисунок 8. Завершение установки

если в процессе установки не возникло ошибок, окно мастера установки примет вид как показано на рис. 8. Для завершения нужно нажать кнопку «Finish».
Готово, интерпретатор языка python установлен и готов к работе.

Теперь можно запустить программу kicadbom2spec (двойным щелчком по файлу kicadbom2spec.pyw), появится окно, будут доступны поля для ввода и диалоги для выбора нужных файлов, но создать файл спецификации не выйдет, так как отсутствует необходимый модуль odfpy.

1.2 odfpy

Этот модуль предоставляет функции для работы с документами Open Document Format и в данном случае используется для создания и редактирования электронных таблиц *.ods.

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

Итак, для того, чтобы установить odfpy без использования командной строки необходимо выполнить следующее:

первым делом нужно скачать пакет с исходным кодом с сайта pypi.python.org/pypi/odfpy. На этой странице ссылка выполнена в виде кнопки «Download» (рис. 9).

Рисунок 9. Загрузка odfpy

после нажатия на эту кнопку появится предупреждающее сообщение (рис. 10).

Рисунок 10. Загрузка файла

нажимаем кнопку «Сохранить», в результате чего откроется диалог сохранения файла (рис. 11), в котором нужно указать куда должен быть загружен архив.
сохраняем пакет с исходными кодами odfpy на Рабочем столе (можно сохранить и в любом другом месте, что не столь важно, так как после установки модуля этот архив можно удалить).
далее нужно распаковать содержимое архива на Рабочий стол. В результате этого на Рабочем столе должна появиться новая папка «odfpy-0.9.6».
открываем папку «odfpy-0.9.6». Внутри содержится много вложенных папок и несколько файлов. Файл отвечающий за построение и установку модуля называется «setup.py» - это скрипт на языке python. При простом запуске двойным щелчком он ничего не выполняет. Для того чтобы собрать модуль из исходных кодов, нужно запустить данный скрипт с параметром «build». А для того чтобы установить собранный модуль, нужно его запустить с параметром «install».
чтобы передать параметр в «setup.py» при запуске без применения командной строки будем использовать ярлыки.

Рисунок 11. Диалог сохранения загрузки

для этого нажимаем на файле «setup.py» правой кнопкой мыши (далее ПКМ) и не отпуская ее перетаскиваем файл на свободное место в папке, затем отпускаем ПКМ. Появится контекстное меню как на рис. 12. Выбираем пункт «Создать ярлыки» - ярлык создан.

Рисунок 12. Создание ярлыка

чтобы не запутаться, сразу же переименовываем его в «build» (имя можно задать любое).
далее открываем свойства ярлыка. Для этого нажимаем ПКМ на ярлыке «build», в результате чего появится контекстное меню. Выбираем в самом низу пункт «Свойства» - откроется окно.
в окне свойств ярлыка (рис. 13) имеется некоторая информация о нем и несколько полей для редактирования. Нам нужно добавить в конец свойства «Объект» нужную команду, в данном случае «build» (через пробел).

Рисунок 13. Свойства ярлыка

Рисунок 14. Ход построения модуля

подтверждаем изменения нажатием кнопки «ОК».
после этого можно запустить построение двойным щелчком по ярлыку «build». На экране ненадолго появится окно командной строки с бегущими строками (рис. 14), что свидетельствует о работе скрипта «setup.py».
после сборки в папке с исходными кодами появится новая папка «build».
далее нужно установить собранный модуль. Для этого нужно создать ярлык для скрипта «setup.py», изменить имя на «install», открыть свойства этого ярлыка и добавить к свойству «Объект» через пробел команду «install», сохранить изменения в свойствах и запустить на выполнение. То есть, выполнить все точно так же как и для сборки модуля, но с командой «install».
на время установки, также как и при сборке, кратковременно появится консоль.
готово — модуль «odfpy» собран и установлен. Загруженный архив и распакованная папка уже не нужны и их можно удалить.

1.3 opengostfont

Устанавливается данный шрифт как и любой другой, путем копирования файлов шрифтов в системную папку C:\WINDOWS\Fonts.

Загрузить файлы шрифта можно на странице www.bitbucket.org/fat_angel/opengostfont/downloads, выбрав последнюю версию. Нужно заметить, что архив содержащий в названии «src» содержит исходные файлы шрифта, в нашем случае нужно выбрать один из архивов содержащий в названии «ttf» или «otf».

1.4 LibreOffice

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

Загрузить файл установки можно на официальном сайте http://www.libreoffice.org.
^

2. Работа с программой kicadbom2spec

Скачать архив с программой и документацией можно на странице проекта launchpad.net/kicadbom2spec, с правой стороны которой расположена кнопка загрузки (рис. 15).

Рисунок 15. Загрузка kicadbom2spec

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

kicadbom2spec не требует установки, для его использования нужно просто загрузить архив и распаковать содержимое в удобное место. Чтобы упростить работу с программой можно создать ярлык для «kicadbom2spec.pyw» и поместить его, скажем, на рабочий стол или в папку с проектом KiCAD.
^

2.1 Режим графического пользовательского интерфейса

Это основной режим. Для запуска программы нужно открыть файл «kicadbom2spec.pyw» двойным щелчком мыши, после чего появится окно, как показано на рис. 16.

Рисунок 16. Окно программы kicadbom2spec

Окно состоит из трех полей ввода с подписями и четырех кнопок.

В первое текстовое поле нужно обязательно ввести полное имя файла перечня элементов (включая путь к файлу). Это можно сделать вручную, набрав текст с клавиатуры, либо с помощью диалога открытия файлов (рис. 17), нажав на кнопку «Открыть...», расположенную возле текстового поля.

Рисунок 17. Диалог открытия файлов

Во втором поле указывается имя файла схемы в формате KiCAD Schematic аналогичным образом. Данное поле не является обязательным для заполнения. Если файл схемы указан, то из него будут считаны значения полей основной надписи и занесены в спецификацию. В противном случае в основную надпись спецификации будут занесены только номера страниц.

В третьем поле нужно обязательно указать полное имя файла спецификации. Задать его можно так же, как и в предыдущих случаях, за одним исключением, вместо диалога открытия файлов будет использован диалог сохранения файлов (рис. 18) при нажатии на кнопку «Сохранить как...».

Как правило файлы проектов KiCAD (чертежи схем, печатных плат и пр.) хранятся в отдельной папке и имеют одинаковые имена (за исключением расширений). Благодаря этому процесс загрузки файлов удалось несколько автоматизировать и он происходит следующим образом. В первую очередь нужно открыть файл перечня элементов нажав соответствующую кнопку «Открыть...». В появившемся диалоговом окне выбрать нужный файл перечня элементов. Далее проверяется, есть ли в той же папке файл схемы с таким же именем и если есть, то он сразу же загружается в соответствующее поле. На основе имени файла перечня элементов создается имя файла спецификации (путем замены расширения) и заносится в соответственное текстовое поле. Если же файл схемы или спецификации уже определен, то он остается без изменений.

После того как все необходимые файлы определены можно создать спецификацию, нажав на кнопку «Создать спецификацию». По завершению появится информационное окно (рис. 19) подтверждающее успешность выполнения операции. В случае возникновения ошибки будет выведено сообщение с ее описанием.

Рисунок 18. Диалог сохранения файлов

Рисунок 19. Сообщение о создании спецификации

Созданную спецификацию можно просмотреть и, если необходимо, отредактировать с помощью ранее установленного офисного пакета LibreOffice.
^

2.2 Режим командной строки

Этот режим может быть использован при пакетной обработке файлов или для взаимодействия с другими приложениями/скриптами.

Для того чтобы получить краткую справку о работе с kicadbom2spec в режиме командной строки нужно ввести следующую команду:

>python kicadbom2spec.pyw -h

или

>python kicadbom2spec.pyw --help

то есть запустить скрипт на выполнение с заданным параметром -h или --help, что эквивалентно. Результат выполнения описанной команды показан на рис. 20.

Рисунок 20. Получение справки в командной строке

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

При создании спецификации проверяется расширение заданного имени файла и если оно отсутствует или не корректно, то будет добавлено расширение «.ods».

В случае возникновения иных ошибочных ситуаций, будут выводится краткие сообщения об ошибке.

Рассмотрим пример создания спецификации с помощью командной строки. Для примера на рабочем столе создана папка «sample», в которой расположен проект KiCAD, состоящий из трех файлов:

sample.pro – файл проекта KiCAD;

sample.sch – файл схемы в формате KiCAD Schematic;

sample.csv – файл перечня элементов (BOM).

Рисунок 21. Содержимое папки sample

Также на рабочем столе расположена папка с программой kicadbom2spec.

Для начала работы выбираем «Пуск→Все программы→Стандартные→Командная строка» - откроется окно командной строки и по умолчанию рабочей директорией будет папка текущего пользователя (о чем свидетельствует приглашение командной строки). Нам нужно сделать Рабочий стол директорией по умолчанию, для этого нужно ввести следующую команду:

>cd "Рабочий стол"

или

>cd "C:\Documents and Settings\%USERNAME%\Рабочий стол"

С помощью последней команды можно перейти к Рабочему столу с любой текущей директории.

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

>python kicadbom2spec\kicadbom2spec.pyw -c -b sample\sample.csv -v

Параметр -v включает вывод сообщений о текущей выполняемой операции.

После успешного создания спецификации содержимое окна командной строки примет вид, подобный рис. 22, а в папке «sample» появится файл спецификации «sample.ods» (рис. 23).

Далее будет рассмотрено назначение каждого из имеющихся параметров.
^

2.2.1 Параметр -b, --bom

С помощью этого параметра в программу передается имя файла перечня элементов (BOM). Его можно применять как в режиме командной строки, так и в режиме графического пользовательского интерфейса. В режиме командной строки этот параметр является обязательным. Имя файла может быть полным или относительным (относительно текущей директории командной строки).

^ Пример использования:

>python kicadbom2spec.pyw -c -b ..\..\myproject\device.cvs

Рисунок 22. Создание спецификации с помощью командной строки

Рисунок 23. Созданный файл спецификации

^

2.2.2 Параметр -s, --schematic

С помощью этого параметра в программу передается имя файла схемы в формате KiCAD Schematic. Его можно применять как в режиме командной строки, так и в режиме графического пользовательского интерфейса. Он используется в том случае, если имя файла схемы отличается от имени файла перечня элементов или расположен в другой папке. Имя файла может быть полным или относительным (относительно текущей директории командной строки).

Пример использования:

>python kicadbom2spec.pyw -b ..\bom\bom.csv -s ..\sch\schematic.sch
^

2.2.3 Параметр -o, --output

С помощью этого параметра в программу передается имя файла в который будет сохранена спецификация. Его можно применять как в режиме командной строки, так и в режиме графического пользовательского интерфейса. Он используется в том случае, если имя файла спецификации должно быть отличным от имени файла перечня элементов или расположен в другой папке. Имя файла может быть полным или относительным (относительно текущей директории командной строки). Расширение файла должно быть «.ods», если это не так, то в режиме графического пользовательского интерфейса будет показано сообщение об ошибке, а в режиме командной строки автоматически добавится расширение «.ods» без вывода каких-либо сообщений.

Пример использования:

>python programs\kicad\addons\kicadbom2spec.pyw —c -b projects\clock\

clock.csv -o documents\Спецификация -v
^

2.2.4 Параметр -c, --console

Этот параметр указывает программе работать в режиме командной строки без использования графического пользовательского интерфейса. Параметр не принимает никаких данных.
^

2.2.5 Параметр -v, --verbose

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

2.2.6 Параметр -h, --help

С этим параметром программа выводит справочное сообщение с краткой информацией о программе и имеющихся параметрах и закрывается без выполнения каких-либо вычислений.
^

3. Генерация перечня элементов (BOM), пригодного для создания спецификации

Для того, чтобы сгенерировать спецификацию должным образом необходимо правильно составить перечень элементов. Для этого сначала нужно настроить редактор схем KiCAD Eeschema .
^

3.1 Настройка редактора схем EEschema

Сперва нужно определить несколько пользовательских полей для элементов схемы. Для этого нужно открыть диалог настроек выбрав в меню "Настройки→Параметры" и во вкладке "Шаблон имен полей" заполнить поля как показано на рис. 24.

Рисунок 24. Настройка пользовательских полей

Пользовательские поля 7 и 8 могут быть использованы по усмотрению пользователя, при создании спецификации используются только первые шесть полей, остальные игнорируются.

Из пользовательских полей 2...5 и поля элемента "Значение" формируется наименование элемента. Элементы имеющие одинаковые значения поля "Группа" будут объединены в одну группу с указанным названием. Значение поля "Примечание" помещается в одноименную графу спецификации.

Рассмотрим пример образования одной строки спецификации:

┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━┳━━━━━━━━━━━━━━┓

┃Поз. обоз-┃ Наименование ┃Кол.┃ Примечание ┃

┃ начение ┃ ┃ ┃ ┃

┠──────────╂───────────────────────────────────────────────╂────╂──────────────┨

┋ ┋ ┋ ┋ ┋

┠──────────╂───────────────────────────────────────────────╂────╂──────────────┨

┃ ┃ Резисторы ┃ ┃ ┃

┠──────────╂───────────────────────────────────────────────╂────╂──────────────┨

┃ ┃ ┃ ┃ ┃

┠──────────╂───────────────────────────────────────────────╂────╂──────────────┨

┃ R1 ┃ МЛТ-0,25-1,8кОм±5%-В ОЖ0.467.18 ┃ 1 ┃ 1...2,8кОм ┃

┠──────────╂───────────────────────────────────────────────╂────╂──────────────┨

┋ ┋ ┋ ┋ ┋

^ ЗНАЧЕНИЕ В СПЕЦИФИКАЦИИ:	ПОЛЕ ЭЛЕМЕНТА:
Резисторы	Группа
R1	Обозначение
МЛТ-0,25-	Марка
1,8к	Значение¹
±5%	Класс точности
-В	Тип
ОЖ0.467.18	Стандарт²
1...2,8кОм	Примечание

Примечания:

1. Единицы измерения (в данном случае "Ом") добавляются автоматически для резисторов, конденсаторов и индуктивностей если они отсутствуют.

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

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

3.2 Создание перечня элементов (BOM)

После заполнения полей элементов и завершения работы над схемой можно создать список элементов. Для этого необходимо нажать на панели инструментов кнопку "Сформировать перечень элементов и материалов" или выбрать в меню "Инструменты→ Сформировать перечень элементов". В появившемся диалоговом окне нужно задать следующие параметры (рис. 25):

^ Формат вывода: Импорт в эл.таблицу (по обозн.)

Разделитель полей для импорта в эл.таблицу: Tab

Добавить в список: Обозначение

Поля пользователя 1...6 (можно выбрать "Все поля пользователя")

Создать перечень элементов нажав кнопку "ОК" диалогового окна.

Созданный таким образом перечень элементов можно использовать для генерации спецификации.

Рисунок 25. Настройки генератора BOM файлов

kicadbom2spec

Руководство пользователя

Версия для операционных систем MS Windows

Барановский Константин

baranovskiykonstantin@gmail.com

2013

Добавить документ в свой блог или на сайт

	Руководство пользователя Версия для операционных систем Linux Ескд, используя файлы перечней элементов (bom), созданных с помощью программы eeschema из пакета программ сапр kicad		Моделирование стохастических и детерминированных систем: Руководство... ...
	Моделирование стохастических и детерминированных систем: Руководство... Гайдышев И. П. Моделирование стохастических и детерминированных систем: Руководство пользователя программы AtteStat. – Курган		Моделирование стохастических и детерминированных систем: Руководство... Гайдышев И. П. Моделирование стохастических и детерминированных систем: Руководство пользователя программы AtteStat. – Курган
	Руководство пользователя L inux Mint 5 “Elyssa” То же относится и к конфигурациям Apple Mac os с bsd и с другими разновидностями Linux, и к другим операционным системам. Компьютер...		Задачами для достижения этой цели можно считать Цель работы состоит в изучении принципов организации сети на базе операционных систем семейства Microsoft Windows
	Руководство пользователя Linux Mint 11 Katya Также Linux Mint можно установить совместно с любыми другими операционными системами, при этом он автоматически, во время инсталляции,...		Эволюция операционных систем и основные идеи А если проще то,операционная система это программа, управляющая аппаратными и программными средствами компьютера, которые предназначены...
	Инструкция по установке инфо-бухгалтер 7 сетевая версия для Windows 1 Проверка настроек клиента для сетей Microsoft, адаптера сетевой карты и сетевых протоколов для Windows 95/98 13		Система управления хостингом руководство пользователя Документ содержит сведения о назначении, области применения и основных функциях программ. В документе описываются условия, необходимые...