Вывод текстовой документации в KiCAD-ГОСТ, Обсуждаем разрабатываемые варианты вывода документации Опции

[Aldan]

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

Написал скрипт для создания спецификации, оформленной по требованиям ЕСКД, из BOM файла сгенерированного в EEschema (...)

Посмотрев на приаттаченный пример работы скрипта надежда на лучшее снова стала оживать, но опыт прежних неудач, когда тоже были продемонстрированы первые результаты, а потом пшик, заставлял приглушить радостные эмоции до момента тестирования готовой фичи, если, конечно, она будет реализована.
А дальше — больше, т. к. оказалось, что не только Константин занят разработкой вывода документации, но еще и AVL:

Константин, приветствую. Я в замешательстве Недели 2 назад начал разработку генератора перечня элементов и спецификации (в соответствии с ГОСТ) на c++ как дополнительный инструмент в самом KiCad с поддержкой исполнений. Вы меня опередили Теперь и не знаю как быть, продолжать свой делать или остановиться

К тому же, возможно, они объединят свои усилия:

AVL, здравствуйте! Думаю нужно продолжать. Нативный генератор перечня куда лучше скрипта, к тому же одно другому не мешает. В случае чего, готов помочь.

Но идет время и пока тишина... Неужели опять все напрасно? Хочется верить, что нет. Просто как всегда не хватает времени и еще все будет. Просто еще не время.
Как бы то ни было, я решил открыть эту тему для того, чтобы на ее страницах можно было обсуждать эту долгожданную мегафичу — вывод текстовой документации в Кикаде.

[tema-electric]

Мягко говоря, аномалия. Перезапустил тачанку сегодня:

Код

$ ps aux | grep soffice
tenzor    1790  0.3  5.5 264308 100356 ?       Sl   09:09   0:04 /opt/libreoffice4.0/program/soffice.bin --quickstart --nologo --nodefault
tenzor    2568  0.0  0.0   3364   828 pts/0    S+   09:30   0:00 grep --color=auto soffice

И что самое непонятное, GOST Tools работает. Ему больше ничего не надо. Неужели надо было перезагрузиться?

У GOST Component manager нет пока русификации? Я залил с launchpad вашу ветку kicad/doc.
Поле "Наименование" содержит названия типа Capacitor ... Resistor ...
Из интересных особенностей при генерации ПЭ ))
Первый лист: C34 1 Not installed
Второй лист: C100,C101 2 Не устанавливаются

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

Спасибо

[AVL]

Мягко говоря, аномалия. Перезапустил тачанку сегодня:

Код

$ ps aux | grep soffice
tenzor    1790  0.3  5.5 264308 100356 ?       Sl   09:09   0:04 /opt/libreoffice4.0/program/soffice.bin --quickstart --nologo --nodefault
tenzor    2568  0.0  0.0   3364   828 pts/0    S+   09:30   0:00 grep --color=auto soffice

И что самое непонятное, GOST Tools работает. Ему больше ничего не надо. Неужели надо было перезагрузиться?

У GOST Component manager нет пока русификации? Я залил с launchpad вашу ветку kicad/doc.
Поле "Наименование" содержит названия типа Capacitor ... Resistor ...
Из интересных особенностей при генерации ПЭ ))
Первый лист: C34 1 Not installed
Второй лист: C100,C101 2 Не устанавливаются

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

Спасибо

Насчет перезагрузки, видимо из-за того, что оказались установлены оба типа офиса, да еще и одновременно запущены, были такие глюки. Наверно можно было не перезагружать, а просто сделать sudo kill лишних процессов.

Ветку lp:~kicad-gost-committers/kicad/doc пока только создал, но русский перевод еще не добавил. У меня пока не решенный вопрос с poedit, о котором я писал ранее.

Насчет
"Из интересных особенностей при генерации ПЭ ))
Первый лист: C34 1 Not installed
Второй лист: C100,C101 2 Не устанавливаются"
так и есть. Изначально я делал все на русском, поскольку бессмысленно делать еще на каком-то другом языке.
Был разговор с Jean-Pierre, он требовал, чтобы GOST-doc-gen был по умолчанию на английском. Согласиться с этим не могу.
Однако, для менеджера компонентов думаю есть смысл поддержки интернационализации, потому что он дает функции, которые будут полезны любому пользователю.
Таким образом, начал адаптировать на английский. А поскольку грамматика у русского и английского разная, то поплыла логика формирования падежей, числа и т.д.
Пока пришел к выводу, что GUI можно делать через интернационализацию, а содержимое выпадающих списков таких как поле "Наименование", надо формировать на основе языка, выбранного где-то в меню.
К примеру, я люблю GUI на английском, но значения в выпадающих списках менеджера компонентов мне нужны только на русском. Также такая опция выбора языка в меню дала бы возможность четко определять логику по формированию языковых конструкций в самом GOST-doc-gen в зависимости от языка. Так что буду это дорабатывать.

[Aldan]

Самая острая фаза ремонта моей квартиры миновала и у меня стало появляться немного времени для форума. Первым делом решил потестировать возможность вывода текстовой документации. Поскольку вариант от AVL не требует что-то доустанавливать (а ЛибреОфис у меня и так уже установлен), то я остановился именно на нем. Скачал сборку для винды kicad_ins_gost_docgen_4115 с ftp://ftp.kicad.ru/pub/kicad/kicad_eskd_doc/lunev_set/ и открыл схему проекта. Далее, зашел в «инструменты» и запустил «GOST Tools” и в раскрывшемся окне зашел в “файл» и выбрал генерацию спецификации. После этого запустился ЛибреОфис и показал пустой бланк (нет ни названия схемы, ни компонентов в списке).
Казалось бы, работая с конкретной схемой, можно надеяться, что все ее атрибуты будут автоматически использованы при формировании документа, а у меня что-то ничего не получилось.
Каких-то дополнительных возможностей изменить сложившуюся ситуацию к лучшему в опциях менеджера перечня я не обнаружил, да и хоть какая-то краткая инструкция по использованию GOST Tools мне на глаза тоже не попалась. Делаю вывод, ремонт квартиры совсем меня доканал и я не врубаюсь в то, что очевидно для для остальных форумцев, которые успешно генерят себе текстовую документацию в своих проектах и в ус не дуют.
AVL, подскажите, что нужно сделать, чтобы бланк спецификации был сгенерирован с заполненными полями.

[AVL]

Самая острая фаза ремонта моей квартиры миновала и у меня стало появляться немного времени для форума. Первым делом решил потестировать возможность вывода текстовой документации. Поскольку вариант от AVL не требует что-то доустанавливать (а ЛибреОфис у меня и так уже установлен), то я остановился именно на нем. Скачал сборку для винды kicad_ins_gost_docgen_4115 с ftp://ftp.kicad.ru/pub/kicad/kicad_eskd_doc/lunev_set/ и открыл схему проекта. Далее, зашел в «инструменты» и запустил «GOST Tools” и в раскрывшемся окне зашел в “файл» и выбрал генерацию спецификации. После этого запустился ЛибреОфис и показал пустой бланк (нет ни названия схемы, ни компонентов в списке).
Казалось бы, работая с конкретной схемой, можно надеяться, что все ее атрибуты будут автоматически использованы при формировании документа, а у меня что-то ничего не получилось.
Каких-то дополнительных возможностей изменить сложившуюся ситуацию к лучшему в опциях менеджера перечня я не обнаружил, да и хоть какая-то краткая инструкция по использованию GOST Tools мне на глаза тоже не попалась. Делаю вывод, ремонт квартиры совсем меня доканал и я не врубаюсь в то, что очевидно для для остальных форумцев, которые успешно генерят себе текстовую документацию в своих проектах и в ус не дуют.
AVL, подскажите, что нужно сделать, чтобы бланк спецификации был сгенерирован с заполненными полями.

Более актуальная сборка ftp://ftp.kicad.ru/pub/kicad/install/win3...it_bin_4126.zip, рекомендую начать с нее.

К сожалению, я не писал документацию на менеджер компонентов + GOST-doc-gen.
Скорее всего прийдется это сделать.
Пока отвечаю на Ваш вопрос. По умолчанию (если Вы взяли сырую схему) все компоненты имеют не заданные поля "Наименование" (атрибут Title), ну и остальные поля тоже не заданы.
Компонент начинает отображаться в КД после того как будет задано поле "Наименование", например, Конденсатор.
Сделано так для удобства. К примеру в схеме 1000 компонентов. Вы решили поработать и назначили через менеджер компонентов параметры двухстам компонентам, и решили продолжить работать на следующий день. Вы открываете проект, смотрите какие компоненты уже имеют заданное поле "Наименование", а какие имеют пустое поле. И понимаете, что заполнять нужно дальше те компоненты, у которых поле "Наименование" пустое.
Также скоро добавлю иконки напротив каждого компонента, будет нагляднее эта логика.

Также не забывайте про пример корректно заполненной схемы demos/GOST/multivibrator.sch

Конечно же есть ряд правил как нужно работать с менеджером компонентов. Документацию делать надо.

Я использую poedit 1.4.1 в Windows. Что у Андрея не знаю, он формирует ru/kicad.po/mo.
Предложения по улучшению перевода отсылаю ему или через форум. Исходники давно не сканировал.

Проверил 1.4.1 под винду. Проблема, к сожалению, не ушла.

Проверил также версии 1.3.9, 1.4.3, 1.4.4, 1.4.5, 1.4.6, 1.5.5. Безуспешно.

Сообщение отредактировал AVL - May 22 2013, 20:43

[Aldan]

Более актуальная сборка ftp://ftp.kicad.ru/pub/kicad/install/win3...it_bin_4126.zip, рекомендую начать с нее.

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

По умолчанию (если Вы взяли сырую схему) все компоненты имеют не заданные поля "Наименование" (атрибут Title), ну и остальные поля тоже не заданы.
Компонент начинает отображаться в КД после того как будет задано поле "Наименование", например, Конденсатор.

Да, схема у меня «сырая». Задал у нескольких компонентов в списке поле «наименование» и, о чудо, - спецификация на эти несколько компонентов сформировалась! Это вызвало необычайно бурные эмоции, т. к. наконец-то появилась эта долгожданная возможность вывода текстовой документации! ОГРОМНОЕ ВАМ СПАСИБО!
Кстати, самый первый компонент в моей схеме — кварцевый резонатор, а его в списке наименований нет. Более детальное тестирование продолжу несколько позже, т. к. мой ремонт квартиры еще не закончен, но радость от сегодняшнего события просто огромная дает стимул побыстрее его завершить!

Конечно же есть ряд правил как нужно работать с менеджером компонентов. Документацию делать надо.

Документацию никто не любит делать, это естественно, т. к. все силы и время съедает написание программы, но все же хотя бы несколько пояснительных предложений стоит сочинить, т. к. только в этом случае созданное приложение будет использоваться с максимальной эффективностью. Хорошая документация, что позолота на добротном изделии.
----------------
И еще, обычно Жан Пьер заканчивает вылизывание стабильной сборки не позже мая месяца, по крайней мере так было раньше. Так вот, возможно версия 4017 https://code.launchpad.net/~kicad-stable-co...rs/kicad/stable или какая-то ближайшая как раз этой самой наифинальной и будет. Так вот, хотелось бы иметь стабильную сборку со всеми последними усовершенствованиями в т.ч. и с генератором тектовой документации.

[AVL]

И еще, обычно Жан Пьер заканчивает вылизывание стабильной сборки не позже мая месяца, по крайней мере так было раньше. Так вот, возможно версия 4017 https://code.launchpad.net/~kicad-stable-co...rs/kicad/stable или какая-то ближайшая как раз этой самой наифинальной и будет. Так вот, хотелось бы иметь стабильную сборку со всеми последними усовершенствованиями в т.ч. и с генератором тектовой документации.

Если Вы имеете в виду попадание менеджера компонентов+GOST-doc-gen в ветку lp:kicad, то боюсь это не реально из-за серьезных разногласий с командой lp:kicad. Если будет время, почитайте, некоторая информация была озвучена на этом форуме.
В первоисточнике и в полном виде об этом можно почитать здесь:
https://code.launchpad.net/~kicad-gost-comm...d/+merge/163239
и здесь:
https://lists.launchpad.net/kicad-developers/msg10412.html

Поэтому была создана ветка lp:~kicad-gost-committers/kicad/kicad

[Aldan]

Если Вы имеете в виду попадание менеджера компонентов+GOST-doc-gen в ветку lp:kicad, то боюсь это не реально из-за серьезных разногласий с командой lp:kicad.

AVL, я, к сожалению, почти не разбираюсь в тонкостях взаимодействия стабильной ветки Кикад со всеми остальными его ветками. По жизни я вынес для себя урок: без крайней необходимости не переходить со стабильной сборки на тестовую, т. к. у меня был досадный случай некоторой порчи проекта при работе на тестовой сборке.
Вот я и стараюсь работать только на стабильных сборках, а тестовыми только иногда для тестирования пользоваться.
Видимо я наивен, т. к. до этого дня считал, что стабильная сборка — такая сборка которая приведена к максимально возможной завершенности и безглючности, т. е. «вылизанная». Если к такой сборке прикручивается некий завершенный и стабильный программный код для расширения ГОСТ-функциональности, то, весьма вероятно, что результирующий программный продукт тоже будет стабильным.
Словом, хотелось бы в обозримом будущем иметь такую стабильную сборку со всеми ГОСТ-наворотами, а не тест-сборку, дабы не наступать на старые грабли в виде порчи проекта в самый не подходящий момент.
Хочется верить, что такое пожелание не является не исполнимым и вскоре стабильная сборка «с полным фаршем» будет доступна. Иначе, я перестаю что-либо понимать в логике развития ГОСТ-Кикада - что, теперь стабильных ГОСТ-сборок никогда не будет?

[AVL]

AVL, я, к сожалению, почти не разбираюсь в тонкостях взаимодействия стабильной ветки Кикад со всеми остальными его ветками. По жизни я вынес для себя урок: без крайней необходимости не переходить со стабильной сборки на тестовую, т. к. у меня был досадный случай некоторой порчи проекта при работе на тестовой сборке.
Вот я и стараюсь работать только на стабильных сборках, а тестовыми только иногда для тестирования пользоваться.
Видимо я наивен, т. к. до этого дня считал, что стабильная сборка — такая сборка которая приведена к максимально возможной завершенности и безглючности, т. е. «вылизанная». Если к такой сборке прикручивается некий завершенный и стабильный программный код для расширения ГОСТ-функциональности, то, весьма вероятно, что результирующий программный продукт тоже будет стабильным.
Словом, хотелось бы в обозримом будущем иметь такую стабильную сборку со всеми ГОСТ-наворотами, а не тест-сборку, дабы не наступать на старые грабли в виде порчи проекта в самый не подходящий момент.
Хочется верить, что такое пожелание не является не исполнимым и вскоре стабильная сборка «с полным фаршем» будет доступна. Иначе, я перестаю что-либо понимать в логике развития ГОСТ-Кикада - что, теперь стабильных ГОСТ-сборок никогда не будет?

Здесь могу предложить такой вариант, дожидаемся, когда менеджер компонентов+GOST-doc-gen станет "стабильным" и мержим этот код с последним стабильным релизом lp:kicad. Получаем, надеюсь, "стабильный" агрегированный релиз.

Лично я не доверяю ни тестовым релизам, ни стабильным. Причем, что кто-то несет ответственность за полную исправность стабильного релиза? Нет, это не так.
Чтобы не испортить проект платы на любом из этапов ее разработки/сохранения на диск, я пользуюсь системой контроля версий. В данный момент использую git. Если становится понятно, что что-то пошло не так, то всегда можно вернуться к предыдущему коммиту и восстановить плату в нормальном виде.
Прежде, чем отдавать плату в производство, я обязательно визуально проверяю все сгенерированные gerber-слои и файлы сверловки. Удобная для этого программа - gerbv,
В случае с KiCad, стабильную сборку не использую никогда. Иначе буду сидеть в прошлом веке. Но это не значит, что так нужно делать всем. Каждый решает для себя сам и определяется с рисками.

P.S.:
NO WARRANTY

11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

На самом деле пока не видел ни одной коммерческой лицензии, где не было бы подобного отказа от ответственности.

[tema-electric]

gerbv

Когда в одной из сборок кикада в стабильную версию, да и в тестовую попали косяки с дугами при генерации герберов, то gerbv не показал косячную дугу, увы. Их показал только CAM350 и то когда уже дошло до разборок. Дуги образовывали окружность, и она была гораздо больше платы. Gerbv их просто не прорисовал, почему-то.