[KiCad] Projektowanie w KiCad 5.0 - Cz.2 Jak ułatwić sobie tworzenie nowych projektów

Tutaj dzielimy się doświadczeniem z używania programu KiCAD.

Moderator: ZbeeGin

Awatar użytkownika
ZbeeGin
User
User
Posty: 492
Rejestracja: sobota 08 lip 2017, 17:16
Lokalizacja: Śląsko-Zagłębiowska Metropolia
Kontaktowanie:

[KiCad] Projektowanie w KiCad 5.0 - Cz.2 Jak ułatwić sobie tworzenie nowych projektów

Postautor: ZbeeGin » niedziela 05 lis 2017, 14:34

Część 2. KiCad 5.0 – Jak ułatwić sobie tworzenie nowych projektów

Witam w części drugiej. Ci którzy przebrnęli przez część pierwszą pewnie pamiętają, że nasz pierwotny projekt służący do wykonania podstawowej konfiguracji został zapisany. Pewnie niektórzy już domyślają się do czego zmierzam i w jaki sposób można ten projekt ponownie wykorzystać.

Załóżmy, że tworzymy nowy projekt. Rozpoczynamy jego podstawową konfigurację, ustalamy sobie jego własne biblioteki, wpisujemy dane w tabelkę tytułową, rysujemy podstawowe elementy schematu: zasilacz, jakieś złącza, interfejsy, itp. A gdyby tak te czynności wykonać raz i skrócić sobie czas umieszczając to wszystko w jednym projekcie, który sobie będziemy kopiować oraz później zmieniać?

Okazuje się, że KiCad może nam tu wiele pomóc. Nawet przejmując rolę osoby, która inteligentnie nam przekopiuje potrzebne rzeczy do nowego projektu. Jak to zrobić? Wykorzystać szablony!

Dlatego też na podstawie naszego projektu `Domyślny` utworzymy szablon, który umieścimy w folderze danych współdzielonych programu, tak by Menedżer projektów mógł go odnaleźć i wyświetlić na liście szablonów do wyboru. W przyszłości gdy będziemy chcieli utworzyć nowy projekt będziemy mogli skorzystać właśnie z niego i jego gotowych ustawień. Na początek jednak odrobina teorii i krótki opis jak korzystać z szablonów.

Czym są szablony w programie KiCad?

Szablon to nic innego jak już zapisany projekt z podstawowymi plikami, plus do tego pewne informacje – tzw. metadane – które pozwolą nam go nazwać, wyróżnić obrazkiem i dodać krótki opis do czego dany szablon służy. Całość jest bardzo prosta i tworzenia szablonu potrzeba tylko minimalnej wiedzy z zakresu języka HTML no i oczywiście struktury projektów programu KiCad.

KiCad posiada kilka gotowych szablonów, z których możemy utworzyć zalążek projektu. Przećwiczmy to zatem już teraz na jednym z nich.
Uruchamiamy Menedżera projektów i z menu Plik przejdźmy do Nowy -> Projekt z szablonu. Pokaże się okno, które zawiera wszystkie szablony jakie program odnalazł w folderach z szablonami.

rys1.png


Uwaga Gdyby w oknie szablonów nie pojawiły się żadne szablony to prawdopodobnie ich nie zainstalowaliśmy lub też ścieżka w zmiennej KICAD_TEMPLATE_DIR jest nieprawidłowa i należy tam wpisać właściwą, która ma prowadzić do podfolderu `\share\kicad\template` w folderze gdzie zainstalowaliśmy program.

Na górze okna znajdują się ikony wyróżniające poszczególne szablony. Wystarczy raz kliknąć w jedną z nich by w polu poniżej znalazł się dołączony do szablonu opis. Wybierzmy zatem jakiś szablon. Proponuję na początek coś prostego, dlatego wybiorę pierwszy z dostępnych szablonów `EuroCard`. Jak widać pojawił się krótki opis szablonu oraz obrazek przedstawiający obrys karty Euro.

rys2.png

Aby teraz program utworzył projekt należy kliknąć OK. Program zapyta jeszcze o folder docelowy, gdzie ma umieścić projekt. Ja utworzyłem folder o nazwie`Projekt_z_szablonu` i tam będę chciał umieścić wynikowy projekt.

rys3.png

Po wybraniu folderu program przekopiuje potrzebne pliki i załaduje projekt.

rys4.png

W projekcie pojawiły się trzy podstawowe pliki tworzące podstawową strukturę każdego projektu:
- `Projekt_z_szablonu.pro` - który spina wszystkie pliki projektu w całość.
- `Projekt_z_szablonu.sch` - który będzie zawierać schemat. Obecnie jest to pusty arkusz.
- `Projekt_z_szablonu.kicad_pcb` - który będzie zawierał obwód drukowany. Obecnie jest tam tylko ramka strony.

Ponieważ był to tylko przykład, który miał pokazać jak prosto tworzy się projekty na bazie szablonów folder `Projekt_z_szablonu` możemy już usunąć. Nie będzie on nam już potrzebny.

Jak utworzyć własny szablon?

Poznajmy teraz strukturę szablonu. Jak już wspomniałem na początku szablon tworzą pliki projektu oraz metadane przechowywane w folderze nazwanym `meta`.

rys5.png

Jak widać pliki szablonu znajdują się w folderze, którego nazwa jest tożsama z nazwą pozostałych głównych plików. Jest to bardzo ważne, by te nazwy były takie same, gdyż korzysta z tego mechanizm tworzenia projektu potomnego. Podczas tworzenia projektu `Domyślny` zachowaliśmy te standardy, zatem nie pozostało nam nic więcej jak tylko stworzyć folder metadanych.

rys6.png


Spójrzmy zatem co zawiera folder `meta` w definicji szablonu. Najważniejszym plikiem z tego folderu jest dokument HTML o stałej nazwie `info.html`. On zawiera opis jaki pojawia się w środkowym polu okna wyboru szablonów, a także tytuł szablonu, który brany jest z zakodowanego w pliku tytułu dokumentu - w tagu HMTL <TITLE>. Drugim ważnym plikiem jest plik graficzny `icon.png`, który powinien zawierać ikonę szablonu, która również pojawia się w oknie wyboru szablonu. Ikona musi mieć stały rozmiar: 64x64 piksele.
W folderze szablonu widzimy też jeszcze jeden plik graficzny `brd.png`, który jest wykorzystywany jako jeden z rysunków osadzony w treści opisu. Nic nie stoi na przeszkodzie by w metadanych szablonów umieszczać dodatkowe pliki. Nie są one jednak obowiązkowe.

rys7.png

Przystąpmy teraz do właściwego tworzenia naszego własnego szablonu. Ponieważ nie należy on do szablonów systemowych, które wyświetlają się w zakładce Szablony systemowe powinniśmy go zapisać tak, by pojawił się on w zakładce Szablony użytkownika. Szablony jakie się tam wyświetlają są pobierane z innego folderu, tym razem wskazywanego przez zmienną systemową KICAD_USER_TEMPLATE_DIR.

Ponieważ KiCad przypisał zmiennej już domyślną ścieżkę, ale nie tworzy automatycznie takiego folderu, to musimy to zrobić sami. Dlatego też sprawdzamy zawartość tej zmiennej i tworzymy w strukturze plików odpowiednie foldery. Z reguły będzie to `<folder_użytkownika>\kicad\template`. Teraz skopiujmy nasz projekt - w całości, razem z folderem nadrzędnym do tego folderu. Przejdźmy do niego, oraz utwórzmy podfolder `meta`. Teraz z pomocą zwykłego edytora zapiszmy tam podstawowy plik `info.html` z taką oto zawartością:

Kod: Zaznacz cały

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Microgeek </TITLE>
</HEAD>
<BODY LANG="pl-PL" DIR="LTR">
<P>Szablon ten zawiera skonfigurowane ustawienia dla programów Eeeschema
oraz Pcbnew na podstawie kursu opublikowanego na fourm
<A HREF="https://microgeek.eu/">Microgeek.EU</A></P>

<P>Odnośnik do tematu:
<A HREF="https://microgeek.eu/viewtopic.php?f=71&t=1239">
[KiCad] Projektowanie w KiCad 5.0 - Cz.2 Jak ułatwić sobie tworzenie nowych projektów</A>
</P>

<P>Autor szablonu: ZbeeGin<BR>
Licencja: CC BY-SA</P>
</BODY>
</HTML>


Jak widać, w treści dokumentu zawarliśmy tylko podstawowe elementy języka HTML wraz z minimalną strukturą dokumentów hypertekstowych. W tagu <TITLE> umieściliśmy nazwę szablonu, która będzie się wyświetlać jako podpis pod ikoną. Następnie w sekcji <BODY> umieściliśmy trzy akapity (tagi <P>) tekstu opisującego szablon. W treści wykorzystaliśmy też łącza internetowe zawarte w tagach <A>.
Gdybyśmy chcieli do tekstu wprowadzić obrazki, możemy użyć tagu <IMG> i zapisać je w folderze `meta`.

Uwaga! Warto przed tagiem zamykającym </TITLE> dodać spację, gdyż program czasem traktuje tag zamykający jako dalszą część nazwy. Nazwa też nie może być zbyt długa bo i tak zostanie obcięta.

Teraz za pomocą programu graficznego narysujmy sobie jakąś ikonę wyróżniającą nasz szablon i również zapiszmy ją w folderze `meta` jako `icon.png`. Ja narysuję sobie coś mało odkrywczego...

rys8.png

OK. Wszystkie pliki są na miejscach teraz pora na przetestowanie naszego szablonu. Wykonujemy te same kroki co na początku tego odcinka.

rys9.png

Pliki projektu powinny się bez problemu utworzyć. Jeśli teraz otworzymy schemat i przejdziemy do ustawień to zobaczymy, że nasze ustawienia, np. szerokość magistrali została ustawiona zgodnie z wartościami jakie zapisaliśmy.

Zauważmy jak program poradził sobie z plikami szablonu/projektu: wszystkie pliki, które miały nazwę `Domyślny` zostały przemianowane na nazwę jaką wpisaliśmy podczas tworzenia folderu. Tak działa mechanizm tworzenia szablonów. Wszystkie pliki z nazwą tożsamą z nazwą folderu w którym znajduje się szablon zostaną skopiowane do projektu, a ich nazwa zostanie zmieniona. Gdyby w folderze szablonu znalazły się również inne pliki to również zostaną one skopiowane, ale ich nazwa już nie zostanie zmieniona!. Oczywiście folder `meta` oraz wszystkie pliki w nim umieszczone nie są kopiowane, gdyż są one potrzebne tylko przy wyborze szablonu.

Co jeszcze możemy zrobić z szablonami?

Ponieważ szablony to tylko nieco zmodyfikowane kompletne projekty, nic nie stoi na przeszkodzie by w szablonach umieszczać też gotowe już fragmenty schematów lub obwodów drukowanych. Na wstępie pisałem o tym, że na początku tworzenia schematu zwykle rozrysowujemy sobie część zasilającą (Robicie tak, prawda?). Wiadomo, nie zawsze będziemy mieć ją taką samą. Raz np. użyjemy zasilacza z transformatorem, stabilizatorem liniowym i garstką kondensatorów, drugi raz wykorzystamy przetwornicę impulsową, itd. Możemy to wszystko narysować na arkuszu schematu i potem ewentualnie niepotrzebny blok usuwać zaledwie trzema kliknięciami myszy. Inny przykład to szablon `EuroCard` jaki otwarliśmy już na początku tego odcinka. W pliku z płytką został już narysowany obrys płytki zgodny z normą płytek EuroCard. Do nas należało tylko dorysować resztę schematu i przenieść go na płytkę.

To co umieścimy w plikach w szablonie w zasadzie zależy tylko od nas. Polecam przeglądnąć sobie zawartość pozostałych zainstalowanych szablonów, np. serię płytek Arduino.

Biblioteki w szablonach

Cały czas w szablonach mówimy tylko o schematach i półgotowych płytkach. Czy można w szablonach umieszczać także biblioteki? Od razu powiem: Jak najbardziej! Mechanizm tworzenia projektu poprzez szablon został tak napisany, że wszystko co znajduje się w szablonie zostaje przecież przeniesione do nowego projektu. Zatem dołączenie bibliotek do projektu i ich lokalnych plików konfiguracyjnych: `sch-lib-table` lub `fp-lib-table` spowoduje, że one także zostaną skopiowane.

Uwaga! W takim wypadku nie powinno się tworzyć bibliotek projektowych z nazwą tożsamą z nazwą plików projektów. Mechanizm podmiany nazwy plików nie ominął by też tych plików i konfiguracja bibliotek mogłaby wskazywać na bibliotekę, która nie byłaby widoczna dla programu, z powodu różnicy nazw!

Na zakończenie

Dziękuję, że przebrnęliście przez te dwa początkowe odcinki kursu. Zastanawiałem się czy fragmentu o szablonach nie scalić z częścią pierwszą, ale jednak zostawię tak jak jest by część pierwsza nie była zbyt długa. Ponadto chciałbym ją jeszcze uzupełnić o kolejne informacje.

W najbliższych odcinkach zajmiemy się już tym co "tygrysy" lubią najbardziej. Poznamy bardziej praktycznie program do rysowania schematów oraz program do tworzenia bibliotek z symbolami.
Nie masz wymaganych uprawnień, aby zobaczyć pliki załączone do tego posta.

Wróć do „KiCAD”

Kto jest online

Użytkownicy przeglądający to forum: Obecnie na forum nie ma żadnego zarejestrowanego użytkownika i 2 gości