1. Przeznaczenie

CvPcb pozwala na przypisanie każdemu komponentowi jaki występuje na liście sieci stworzonej przez program do edycji schematu, nazwy footprintu, który będzie go reprezentował na obwodzie drukowanym, a także na dodanie tych informacji do listy sieci.
Generalnie, lista sieci nie określa który footprint (fizyczne odzwierciedlenie komponentu) będzie wyświetlany przez oprogramowanie do edycji obwodu drukowanego (Pcbnew) podczas tworzenia płytki.
Komponenty mogą mieć manualnie przypisane footprinty. Można też utworzyć skrypty przypisań (ang: equivalence files), które stanowią specyficzną bazę danych dla przypisywania komponentom ich footprintów. Jeśli dostępne są skrypty przypisań, jest również możliwa praca automatyczna.
Lista footprintów dostępnych dla oprogramowania PCB przechowywana jest w bibliotekach footprintów, których może być więcej niż jedna.

Ten interaktywny proces jest znacznie prostszy niż bezpośrednie przypisywanie tych informacji z poziomu schematu, ponieważ pozwala na jego automatyzację. CvPcb pozwala także na przeglądanie list dostępnych footprintów oraz podgląd ich wyglądu na ekranie.

2. Ogólna charakterystyka aplikacji

Charakterystyka aplikacji

Aplikacja służy do interaktywnego lub automatycznego - w oparciu o pliki skryptów - przypisywania komponentom ich footprintów.
Tworzenie (jeśli zachodzi taka potrzeba) plików numeracji wstecznej (ang: back-annotation files) dla edytora schematów z tymi przypisaniami.

Pliki wejściowe

• Pliki listy sieci *.net tworzone przez program Eeschema (z lub bez odnośników do footprintów),
• Zewnętrzne skrypty przypisań footprintów *.cmp stworzone wcześniej przez CvPcb, jeśli istnieją.

Pliki wyjściowe

Są generowane dwa pliki dla Pcbnew:

• Rozszerzony plik z listą sieci (z odnośnikami do footprintów),
• Zewnętrzny skrypt przypisań (.cmp).

3. Uruchamianie CvPcb

CvPcb można uruchomić z poziomu schematu (plik o tej nazwie jest wybierany po naciśnięciu klawisza CvPcb, z poziomu menu) lub wsadowo poprzez wpisanie z konsoli polecenia: cvpcb <filename>, (filename to nazwa pliku z listą sieci pochodząca z narzędzia do edycji schematów Eeschema).
Nazwa pliku może zostać przekazana jako plik z rozszerzeniem lub bez. Rozszerzenie pliku może, jeśli jest potrzebne zostać dostarczone przez zdefiniowaną w CvPcb konfigurację.
Dwa tworzone pliki będą posiadać tą samą nazwę (ale z innym rozszerzeniem).
Domyślnym rozszerzeniem pliku wejściowego jest .net. Domyślnym rozszerzeniem pliku wyjściowego również jest .net, i zastępuje poprzedni plik .net.
Standardowym rozszerzeniem pliku zewnętrznego skryptu przypisań do przypisywania footprintów poszczególnym symbolom na schemacie (także generowanym przez CvPcb) jest .cmp.

4. Obsługa CvPcb

Ekran główny

Panel listy bibliotek (z lewej strony) zawiera listę dostępnych w projekcie bibliotek. Panel ten współpracuje z opcją filtrowaniem według bibliotek.
Panel komponentów (w środku) zawiera listę komponentów odczytanych z listy sieci.
Panel footprintów (z prawej strony) zawiera listę modułów odczytanych z dostępnych bibliotek. Zawartość tej listy może być filtrowana.

Główny pasek narzędzi

Znaczenie poszczególnych przycisków jest następujące:

	Wybiera listę sieci, która ma być przetworzona.
	Tworzy skrypt przypisań komponentów .cmp oraz plik .net, czyli zmodyfikowaną, rozszerzoną listę sieci.
	Uruchamia menu konfiguracji CvPcb.
	Wyświetla bieżący footprint (czyli ten który obecnie jest wskazany na liście dostępnych footprintów).
	Automatycznie przypisuje nazwy footprintów korzystając z baz danych .equ o przypisaniach automatycznych. Użycie tego narzędzia domyślnie przyjmuje, że te pliki są dostępne.
	Automatycznie przeskakuje do poprzedniego elementu, któremu jeszcze nie został przypisany żaden footprint.
	Automatycznie przeskakuje do następnego elementu, któremu jeszcze nie został przypisany żaden footprint.
	Kasuje wszystkie przypisania.
	Wyświetla dokumentację footprintu, jeśli istnieje.
	Przełącznik poszczególnych filtrów służących do filtrowania listy dostępnych footprintów na panelu footprintów. Możliwa jest filtracja według wzorców ustawionych w ustawieniach poszczególnych komponentów (pierwsza opcja), liczby wyprowadzeń (druga opcja) oraz według wybranej biblioteki (ostatnia opcja). Opcje te można łączyć. Gdy filtrowanie jest włączone, panel footprintów zawiera tylko elementy pasujące do sumy wybranych filtrów.

Konfigurowanie CvPcb bez obsługi tabeli bibliotek

Główne okno

Uruchomienie menu konfiguracji powoduje otwarcie następującego okna dialogowego:

Wybór bibliotek footprintów

Po wybraniu elementu z listy za pomocą myszy:

• Dodaj - dodaje nową bibliotekę do listy na końcu listy.
• Wstaw - dodaje nową bibliotekę do listy przed aktualnie wybranym elementem.
• Usuń - usuwa wskazaną bibliotekę z listy.
• Góra - przesuwa wybraną bibliotekę wyżej na liście (zwiększa priorytet).
• Dół - przesuwa wybrany bibliotekę niżej na liście (zmniejsza priorytet).

Zapamiętaj:
Dowolna modyfikacja tej listy przenosi się do Pcbnew.

Wybór plików aliasów footprintów (skrypty przypisań)

Po wybraniu nazwy pliku z listy:

• Dodaj - dodaje nową nazwę do listy na końcu listy.
• Wstaw - dodaje nową nazwę do listy przed aktualnie wybranym elementem.
• Usuń - usuwa wskazany element z listy.
• Góra - przesuwa wybrany element wyżej na liście (zwiększa priorytet).
• Dół - przesuwa wybrany element niżej na liście (zmniejsza priorytet).

Wybór domyślnej ścieżki bibliotek footprintów

Domyślna ścieżka do bibliotek jest wyświetlana przez CvPcb. CvPcb używa tych ścieżek do odnajdywania bibliotek footprintów (pliki .mod) oraz skryptów przypisań (pliki .equ).

Ścieżki poszukiwań

CvPcb używa dwóch typów ścieżek:

• Ścieżki ustawiane automatycznie przez CvPcb.
• Ścieżki dodane przez użytkownika.

Ścieżki użytkownika

Ścieżki ustalane automatycznie przez CvPcb

Zależą one (częściowo) od systemu operacyjnego. Zawsze występuje na liście katalog roboczy.
Następnie:

• kicad/share/modules.
• kicad/share/modules/packages3d (dla obiektów 3D w formacie VRML stworzonych przez Wings3D).
• kicad/share/template.

Ścieżka główna programu KiCad to:

• Ścieżka gdzie znaleziono pliki binarne programu KiCad (.../kicad/bin).

Jeśli nie znaleziono:
W systemie Windows:

• c:\kicad
• d:\kicad

W systemach Linux/Unix:

• /usr/local/kicad
• /usr/share/kicad

Tabele footprintów - Zarządzanie bibliotekami po nowemu

Począwszy od wersji z dnia 2013-12-08 BZR4535-product, CvPcb nie używa narzędzia do konfiguracji opisanego w poprzednim punkcie. Nowa implementacja tego narzędzia opiera się na tabeli bibliotek footprintów.
Poniższy rysunek pokazuje okno dialogowe z wspomnianą tabelą. Aby go wywołać należy użyć polecenia Tabela bibliotek.

Tabela bibliotek footprintów jest używana do mapowania plików bibliotek obsługiwanych przez program do ich nazw skrótowych. Nazwa skrótowa jest używana do wyszukiwania footprintów zamiast poprzedniej metody z wyszukiwaniem plików zgodnie z ustalonym układem ścieżek dostępu. Pozwala to programowi CvPcb na dostęp do footprintów za pomocą tej samej nazwy w różnych bibliotekach gwarantując tym samym, że właściwy footprint zostanie załadowany z odpowiedniej biblioteki. Pozwala to również na obsługę bibliotek pochodzących z innych programów (z pomocą wtyczek) EDA, takich jak np. Eagle czy gEDA.

Globalna tabela bibliotek footprintów

Globalna tabela bibliotek footprintów zawiera listę biblioteki, które są dostępne zawsze, niezależnie od obecnie wczytanego projektu. Tabela ta jest zapisana w pliku fp-lib-table w katalogu domowym użytkownika. Jego rzeczywista lokacja zależy użytego systemu operacyjnego.

Lokalna tabela bibliotek footprintów zależna od projektu

Lokalna tabela bibliotek footprintów zależna od projektu zawiera listę bibliotek, które są dostępne wyłącznie w obecnie wczytanym projekcie. Lokalna tabela może być modyfikowana tylko wtedy, gdy zostanie ona załadowana razem z listą sieci tego projektu. Gdy projekt nie został załadowany lub gdy taka lokalna tabela nie istnieje, tworzona jest pusta tabela, którą będzie można wypełnić i później zapisać razem z plikiem przypisań footprintów (z rozszerzeniem .cmp).

Konfiguracja początkowa

Gdy CvPcb lub Pcbnew zostanie uruchomiony i globalna tabela bibliotek fp-lib-table nie zostanie znaleziona w katalogu domowym użytkownika, CvPcb będzie próbował skopiować domyślną tabelę bibliotek fp_global_table zapisaną w folderze template do pliku fp-lib-table w katalogu domowym użytkownika. Jeśli plik fp_global_table nie został znaleziony, to zamiast operacji kopiowania zostanie utworzona pusta tabela. Gdyby taka sytuacja miała miejsce użytkownik ma też możliwość skopiowania fp_global_table samodzielnie lub "ręczne" skonfigurowania tabeli.
Domyślna tabela bibliotek zawiera wszystkie standardowe biblioteki jakie zostały zainstalowane razem z programem KiCad EDA Suite.

Dodawanie nowych wpisów w tabeli

By móc używać biblioteki najpierw należy dodać globalną lub lokalną tabelę. Lokalna tabela ma zastosowanie tylko gdy istnieje otwarta lista sieci projektu.

Każda pozycja tabeli musi posiadać unikalną nazwę skrótową. Nie musi ona mieć jakiegokolwiek związku z bieżącą nazwą pliku lub ścieżki do niego. Znak dwukropka ':' nie może być używany w nazwach skrótowych. Każda pozycja musi również odnosić się do prawidłowej ścieżki/nazwy pliku w zależności od typu biblioteki. Ścieżki do plików mogą być bezpośrednie, względne lub pochodzić ze specjalnych zmiennych systemowych - opisanych dalej.
Aby biblioteka została wczytana przez CvPcb musi być także wybrana właściwa wtyczka obsługująca dany format pliku. CvPcb obecnie wspiera następujące formaty plików bibliotek: KiCad Legacy, KiCad Pretty, Eagle oraz gEDA.

Istnieje również pole przeznaczone do wpisania opisu dla danego wpisu w tabeli. Pole z opcjami nie jest w tej chwili używane, zatem umieszczanie jakichkolwiek opcji nie ma znaczenia przy ładowaniu bibliotek.

Proszę zauważyć, że nie można umieścić dwóch takich samych nazw skrótowych w jednej tabeli. Jednakże, można wpisać tą samą nazwę skrótową w globalnej i lokalnej tabeli bibliotek, ponieważ tabela lokalna ma większy priorytet niż tabela globalna w takim przypadku.

Gdy wpisy zostaną zdefiniowane w lokalnej tabeli bibliotek, to plik fp-lib-table zawierający te wpisy zostanie umieszczony w folderze skąd pochodzi lista sieci.

Pobieranie wartości ze zmiennych systemowych

Jednym z największych zalet tabeli bibliotek footprintów jest możliwość używania odnośników do zmiennych systemowych. Pozwala to na zdefiniowanie własnych ścieżek do bibliotek w zmiennych systemowych i używanie ich w projektach.

Odnośniki do zmiennych systemowych można wplatać w treść pól zawierających ścieżkę do pliku używając powszechnie znanego formatu ${nazwa_zmiennej}. Domyślnie CvPcb definiuje zmienną środowiskową KISYSMOD. Wskazuje ona na miejsce, gdzie zainstalowane zostały biblioteki instalowane razem z programem KiCad EDA Suite. Można ją re-definiować samodzielnie, co pozwala na zastąpienie standardowych bibliotek ich własnymi odpowiednikami. Gdy wczytana zostanie lista sieci, CvPcb automatycznie definiuje również zmienną KIPRJMOD. Pozwala to na tworzenie bibliotek w miejscu wskazywanym przez projekt bez konieczności definiowania bezwzględnej ścieżki do biblioteki w lokalnej tabeli footprintów projektu.

Używanie wtyczki GitHub

GitHub to specjalna wtyczka pozwalająca na łączenie się ze zdalnym repozytorium GitHub zawierającym footprinty w formacie .pretty (nowa wersja formatu zapisu footprintów przez program KiCad). Repozytorium to jest tylko do odczytu, ale wtyczka umożliwia również dostęp do technologi "Copy On Write" (COW) wspierającej możliwość edycji footpritnów odczytanych z repozytorium GitHub i zapisanie ich nowych wersji na dysku lokalnym, które później można wysłać z w celu ich aktualizacji. Sama wtyczka nie umożliwia zapisu do repozytorium.

Przykładowe wpisy w tabeli

Poniższa tabela pokazuje wpis z tabeli bibliotek, której nie została przypisana opcja allow_pretty_writing_to_this_dir:

Następna tabela pokazuje wpis z tabeli bibliotek z opcją dotyczącą COW. Zmienna ${HOME} jest tylko przykładowa. Folder github.pretty jest umieszczony w folderze do którego prowadzi ścieżka ${HOME}/pretty/. W każdym przypadku użycia opcji allow_pretty_writing_to_this_dir, wymagane jest samodzielne utworzenie tego folderu i musi on posiadać rozszerzenie .pretty.

Footprinty pobierane z repozytorium mają zawsze pierwszeństwo przed tymi umieszczonymi w folderze na który wskazuje opcja allow_pretty_writing_to_this_dir. Po zapisaniu footprintu do lokalnego folderu przechowującego hybrydowe pliki COW, np. poprzez zapisanie zmian w edytorze footprintów, żadne aktualizacje GitHub nie będą widoczne podczas ładowania footprintów o tej samej nazwie, niż te, które zostały zapisane lokalnie.
Zawsze należy korzystać z odrębnego folderu *.pretty dla poszczególnych bibliotek GitHub i nigdy nie powinno się łączyć folderów przez przypisywanie tego samego folderu do innych bibliotek GitHub, gdyż mogłoby to doprowadzić do bałaganu nad którym nie byłoby można zapanować.

Wartości symboliczne w zmiennych systemowych zapisane w notacji ${nazwa_zmiennej} przypisane do opcji allow_pretty_writing_to_this_dir będą rozwijane automatycznie by utworzyć właściwą ścieżkę, tak samo jak to ma miejsce w polu Ścieżka.

Co robić z plikami w COW?

System COW to element przyśpieszający współużytkowanie footprintów. Jeśli zawartość COW będzie regularnie przesyłana do zarządcy repozytorium GitHub, będzie można pomóc w uaktualnianiu kopii znajdujących się w repozytorium zdalnym.
Całość jest bardzo prosta. Za pomocą poczty elektronicznej należy wysłać pliki *.kicad_mod znajdujące się w folderach systemu COW do osoby zarządzającej repozytorium. Po otrzymaniu potwierdzenia, że zmiany zostały zaakceptowane i wprowadzone, można skasować wysłane pliki z COW. Nowe wersje plików zostaną pobrane z repozytorium GitHub.
Głównym celem jest utrzymywanie jak najmniejszego zestawu plików systemu COW jak tylko jest to możliwe poprzez regularne przesyłanie zawartych w niej plików.

Generalne zalecenia przy używaniu tabeli bibliotek

Biblioteki footprintów mogą być zdefiniowane globalne lub lokalnie dla obecnie wczytanego projektu. Biblioteki umieszczone w globalnej tabeli bibliotek użytkownika są zawsze dostępne i są zapisane w pliku fp-lib-table w katalogu domowym użytkownika. Globalne biblioteki będą dostępne nawet jeśli nie została otwarta lista sieci danego projektu. Inaczej sprawa się ma w przypadku lokalnych bibliotek, które są aktywne wyłącznie dla bieżącej listy sieci. Lokalna tabela bibliotek jest zapisywana w pliku fp-lib-table umieszczonym w tej samej ścieżce co lista sieci.

Nie ma przeszkód co do definiowania odnośników do bibliotek w obu tabelach. Dlatego też nie zostało odgórnie określone w jaki sposób użytkownik będzie wykorzystywał możliwości jakie dają globalne i lokalne tabele. Są jednak zalety i wady każdego z rozwiązań, które należy rozważyć.
Można zdefiniować wszystkie biblioteki w globalnej tabeli bibliotek, co oznacza, że będą one zawsze dostępne gdy będą potrzebne. Wadą takiego rozwiązania będzie szybkość wyszukiwania w nich odpowiedniego footprintu.
Można zdefiniować wszystkie biblioteki w lokalnej tabeli bibliotek. Zaletą takiego rozwiązania będzie możliwość zdefiniowania tylko tych bibliotek, które będą w danej chwili potrzebne oraz skrócenie czasu ich przeszukiwania. Wadą tego rozwiązania będzie zaś to, że będzie trzeba zawsze pamiętać, by dodać odpowiednie biblioteki dla każdego nowego projektu.

Można zdefiniować biblioteki w obu tabelach jednocześnie. Sensowne staje się wtedy wpisanie bibliotek, które są wykorzystywane prawie we wszystkich projektach do tabeli globalnej, a w lokalnych tabelach umieszczać tylko te, które są przydatne tylko w tym konkretnym projekcie. Będzie to rozwiązanie, które będzie posiadało największą elastyczność kosztem zmniejszenia szybkości wyszukiwania.

Podgląd bieżącego footprintu

Polecenie Podgląd footprintu pozwala na wyświetlenie bieżącego footprintu, czyli tego który aktualnie jest wskazany na liście w panelu footprintów.
Można przeglądać w ten sposób listę footprintów klikając na ich nazwy przy pozostawionym oknie podglądu footprintów.
Można również podglądać widok 3D (jeśli moduły maja przypisane kształty 3D).

Wyświetlanie

Pozycja kursora jest wyświetlana na dolnym pasku ekranu:

Pozycja absolutna (X nnnn Y nnnn) oraz relatywna (dx nnnn dy nnnn). Punkt odniesienia dla pozycji relatywnej można zmieniać klawiszem spacji.

Skróty klawiaturowe

Menu kontekstowe

Wyświetlane jest klikając prawy klawisz myszy. Pierwsze cztery polecenia służą do bezpośredniego dostosowywania powiększenia. Dwa kolejne wyświetlają dodatkowe podmenu:

Pasek narzędzi

	Opcje wyświetlania
	Opcje powiększania
	Wyświetlanie kształtów 3D

Podgląd 3D

5. Przypisywanie footprintów do komponentów

Podstawy

Aby przypisać wybranemu komponentowi (podświetlony element) z panelu komponentów określony footprint, należy w panelu footprintów dwukrotnie kliknąć nazwę wybranego footprintu.
Następny komponent z listy komponentów jest podświetlany:

• Automatycznie po poprzednim przypisaniu.
• Ręcznie z pomocą myszy lub klawiszy kursora.

Operacja przypisywania

Wystarczy kliknąć dwukrotnie lewym klawiszem myszy na wybranym footprincie.

Zmiana bieżącego przypisania

Jest wykonywana na zasadzie nowego przypisania, jak wyżej.

Filtrowanie listy footprintów

Polecenia z paska narzędzi pozwalają na włączenie/wyłączenie poszczególnych sposobów filtracji. Poszczególne filtry można włączać niezależnie by bardziej zawęzić wynik filtracji.
Możliwa jest filtracja według wzorców ustawionych w ustawieniach poszczególnych komponentów (pierwsza ikona), liczby wyprowadzeń (druga ikona) oraz według wybranej biblioteki (ostatnia ikona).
Jeśli nie ma ustalonej filtracji wyświetlana jest pełna lista footprintów. Poniższy rysunek ukazuje przykład listy bez filtracji:

Filtrowanie za pomocą wzorców z ustawień komponentów

Jeśli wybrany komponent posiada zdefiniowane wzorce nazw dozwolonych footprintów, lista footprintów w CvPcb może być według niej filtrowana.
Po włączeniu filtracji według pasujących nazw lista footprintów ulegnie znacznemu skróceniu. W tym konkretnym przypadku wyświetlonych zostanie tylko 8 footprintów:

Dzieje się tak, gdyż w Eeschema podczas tworzeniu symbolu zostały uzupełnione informacje o dozwolonych footprintach dla tego komponentu w zakładce Filtr footprintów:

Filtrowanie za pomocą pasującej liczby wyprowadzeń

W przypadku włączenia filtracji według liczby wyprowadzeń, widok prawego panelu zmieni się i zostaną wyświetlone tylko te footprinty, które posiadają odpowiednią liczbę wyprowadzeń (tu: 9).

Filtrowanie za pomocą wybranej biblioteki

W przypadku włączenia filtracji według wybranej biblioteki, widok prawego panelu będzie podobny i zostaną wyświetlone tylko te footprinty, które pochodzą z wybranej w panelu bibliotek biblioteki.

6. Automatyczne przypisywanie footprintów

Pliki aliasów footprintów

Format plików

Pliki .equ zawierają zwykły tekst, gdzie każda linia odpowiada jednemu komponentowi.
Każda z linii posiada strukturę:

    'component value' 'footprint name'

Każda nazwa musi być zamknięta w apostrofach, obie nazwy muszą być rozdzielone przynajmniej jednym znakiem spacji.

Przykładowo:
Jeśli element U3 to układ scalony 14011 a jego odpowiedni footprint to 14DIP300, to linia powinna wyglądać tak:

	
    '14011'  '14DIP300'

Linie rozpoczynające się od znaku hash (#) są traktowane jako komentarz.

Przykładowa zawartość pliku:

#integrated circuits (smd):
'74LV14' 'SO14E'
'74HCT541M' 'SO20L'
'EL7242C' 'SO8E'
'DS1302N' 'SO8E'
'XRC3064' 'VQFP44'
'LM324N' 'S014E'
'LT3430' 'SSOP17'
'LM358' 'SO8E'
'LTC1878' 'MSOP8'
'24LC512I/SM' 'SO8E'
'LM2903M' 'SO8E'
'LT1129_SO8' 'SO8E'
'LT1129CS8-3.3' 'SO8E'
'LT1129CS8' 'SO8E'
'LM358M' 'SO8E'
'TL7702BID' 'SO8E'
'TL7702BCD' 'SO8E'
'U2270B' 'SO16E'
#Xilinx
'XC3S400PQ208' 'PQFP208'
'XCR3128-VQ100' 'VQFP100'
'XCF08P' 'BGA48'

#upro
'MCF5213-LQFP100' 'VQFP100'

#regulators
'LP2985LV'	'SOT23-5'

Przypisywanie automatyczne

Proces automatycznego przypisywania jest uruchamiany przez wybranie ikony:

Wszystkie komponenty jakie zostały znalezione (na podstawie ich wartości) w pliku .equ będą miały przypisany automatycznie wskazany tam footprint.

7. Pliki numeracji wstecznej

Pliki te mogą być użyte do przeprowadzenia procesu numeracji wstecznej na schemacie. Nie są one używane przez Pcbnew.

Zawierają zwykły tekst, gdzie każda linia odpowiada jednemu komponentowi, podając nazwę komponentu (identyfikator) na schemacie i przypisany jemu footprint.

Przykładowo:
Jeśli komponentowi oznaczonemu jako U3 został przypisany footprint 14DIP300, to wygenerowana linia będzie zawierać tekst:

comp "U3" = footprint "14DIP300"

Utworzony plik będzie się nazywał tak samo jak plik wejściowy CvPcb, ale z rozszerzeniem .stf, i zostanie umieszczony w tym samym folderze gdzie zostanie wygenerowana nowa lista sieci.