IDF Eksporter

Podręcznik użytkownika

Prawa autorskie

Copyright © 2014-2015. Ten dokument jest chroniony prawem autorskim. Lista autorów znajduje się poniżej. Możesz go rozpowszechniać oraz modyfikować na zasadach określonych w General Public License (http://www.gnu.org/licenses/gpl.html), wersja 3 lub późniejsza, albo określonych w Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), wersja 3.0 lub późniejsza.

Wszystkie znaki towarowe użyte w tym dokumencie należą do ich właścicieli.

Współtwórcy

Cirilo Bernardo

Tłumaczenie

Kerusey Karyu <keruseykaryu@o2.pl>, 2014-2015.

Kontakt

Wszelkie komentarze lub sugestie dotyczące tego dokumentu prosimy kierować do autora dokumentu (cirilo_bernardo@yahoo.com).

Data publikacji i wersja oprogramowania

Opublikowano 26 stycznia 2014.

1. Wprowadzenie do eksportera IDFv3

The IDF exporter exports an IDFv3
[http://www.simplifiedsolutionsinc.com/images/idf_v30_spec.pdf]
compliant board (.emn) and library (.emp) file for communicating mechanical dimensions to a mechanical CAD package. The exporter currently exports the board outline and cutouts, all pad and mounting thru-holes including slotted holes, and component outlines; this is the most basic set of mechanical data required for interaction with mechanical designers. All other entities described in the IDFv3 specification are currently not exported.

2. Określanie modeli komponentów użytych przez eksporter

IDF eksporter korzysta z atrybutów pliku modelu 3D, który pierwotnie używany jest przez przeglądarkę 3D. Ponieważ przeglądarka 3D, IDF i ewentualnie przyszłe eksportery mechanicznego CAD są skupione na formatach plików różnego rodzaju, można użyć atrybutów modelu 3D, by określić modele dla wielu różnych eksporterów.

From within the Footprint Editor or Pcbnew, edit the footprint parameters and click on the 3D settings tab (see figure 1), click on Add 3D Shape, and select the filter "IDFv3 component files (*.idf)" (see figure 2). Select the desired outline file and enter any necessary values for the offset and rotation. Note that only the offset values and the Z rotation value are used by the IDF exporter; all other values are ignored. The offsets must be specified using the IDF board output units (mm or thou) and in the IDF coordinate system, that is a right-hand coordinate system with +Z moving towards the viewer, +X is to the viewer’s right, and +Y is up. The rotation must be in degrees and a positive rotation is a counter-clockwise rotation as described in the IDFv3 specification. Multiple outlines may be combined with appropriate offsets to represent simple assemblies such as a DIP package in a socket. [BUG: in discussions it has been decided that the unit of the Z offset should be inches, which is consistent with the units of the VRML model offset. It may also be useful not to ignore the (X,Y) offset values. The behavior mentioned here will change at some point in the future.]

Once models have been specified for all desired components, from within pcbnew select the File menu then Export and finally IDFv3 Export. A dialog box will pop up (see figure 3) which allows the output filename and IDF output units (mm or mils) to be set. The exported IDF files can be viewed in the free mechanical CAD software FreeCAD or converted to VRML using the idf2vrml tool and viewed with any suitable VRML viewer.

Rysunek 1. Footprint properties, 3D settings

Rysunek 2. Wybór zarysów komponentów IDF

Rysunek 3. Ustawienia wyjściowe IDF

3. Tworzenie pliku z zarysami komponentów

Plik z zarysem komponentu (*.idf) zawiera pojedynczą sekcję .ELECTRICAL lub .MECHANICAL jak opisano w specyfikacji. Sekcje mogą być poprzedzone dowolną ilością linii komentarza; linie komentarza są kopiowane przez eksporter do pliku biblioteki i mogą zostać użyte do śledzenia danych meta, takich jak odnośniki do dokumentacji używane do określania zarysu oraz rozmiaru komponentu.

Sekcja zarysu komponentu zawiera pola, które są ciągami znaków, liczbami całkowitymi lub ułamkowymi. Ciąg jest kombinacją znaków, które mogą zawierać spacje; jeśli ciąg zawiera spacje to musi być ujęty w cudzysłowy. Cudzysłowy nie mogą pojawiać się wewnątrz ciągu. Liczby ułamkowe mogą być reprezentowane za pomocą notacji dziesiętnej lub wykładniczej, ale notacja dziesiętna jest jednak bardziej czytelna. Punktem dziesiętnym musi być kropka, a nie przecinek. Plik IDF musi składać się tylko z 7-bitowych znaków ASCII; zastosowanie 8-bitowych znaków może doprowadzić do zachowań niemożliwych do zdefiniowania.

Plik IDF składa się z SEKCJI, które składają się z REKORDÓW, które składają się z PÓL. Dla plików konturów IDF może istnieć tylko jeden typ sekcji i musi być jednym z .ELECTRICAL lub .MECHANICAL. Rekord jest pojedynczą linią tekstu i może zawierać jedno lub więcej pól. Pola to sekwencje znaków rozdzielonych przez jedną lub kilka spacji, które nie pojawiają się w cudzysłowach. Wszystkie pola rekordu muszą znajdować się w jednej linii; rekordy nie mogą obejmować wielu wierszy.

Sekcja nagłówka (.ELECTRICAL lub .MECHANICAL) jest uważana za pierwszy rekord (Record 1) sekcji. Rekord 1 musi występować razem z rekordem 2, który posiada cztery pola:

Geometry Name: a string which in combination with the Part Number must form a unique identifier for the component outline. For standardized packages, the package name is a good value for the geometry name, for example "SOT-23". For unique packages the manufacturer’s part number is a good choice for the geometry name.
Part Number: although obviously intended for the part number, for example BS107, it is better to use this string to help describe the package. For example if the geometry name is "TO-92", the part number entry may be used to describe the layout of the pads or the orientation of this particular TO-92 outline file.
Jednostki IDF: musi zawierać jedną z dwóch wartości MM lub THOU i ma zastosowanie wyłącznie do jednostek opisujących ten pojedynczy składnik konturu.
Wysokość: jest to liczba rzeczywista reprezentująca wysokość nominalnego składnika przy użyciu jednostek określonych w polu 3.

Po rekordzie 2 musi wystąpić kilka rekordów 3, które określają kontur elementu. Rekord 3 składa się z czterech pól:

Indeks pętli: 0 (punkty konturu są określane przeciwnie do ruchu wskazówek zegara) lub 1 (punkty konturu są określone w kierunku ruchu wskazówek zegara)
położenie X: liczba rzeczywista ułamkowa
położenie Y: liczba rzeczywista ułamkowa
Kąt zawarty: liczba ułamkowa. Jeśli wartość wynosi 0 to odcinek linii prostej jest rysowany od poprzedniego punktu do tego punktu. Jeśli wartość wynosi 360, poprzedni punkt określa środek okręgu i punkt ten określa punkt na okręgu; nigdy nie należy podawać wartości -360, gdyż co najmniej jeden z wiodących pakietów mechanicznego CAD nie będzie się poprawnie zachowywał w takiej sytuacji. Jeśli wartość jest ujemna to jest rysowany łuk w prawo z poprzedniego punktu do tego punktu, a jeśli wartość jest dodatnia, to łuk jest rysowany w lewo.

Tylko jedna zamknięta pętla jest dopuszczalna i nie jest możliwe opisywanie wycięć. Ostatni punkt musi być taki sam jak pierwszy chyba, że kontur jest okrągły.

Pierwszy przykład pliku IDF:

# a simple cylinder - this could represent an electrolytic capacitor
.ELECTRICAL
    "cylinder" "5mm OD, 5mm height" MM 5
    0 0 0 0
    0 2.5 0 360
.END_ELECTRICAL

Drugi przykład pliku IDF:

# odwrócone T
# komentarz dodany by zaprezentować możliwość komentowania
.ELECTRICAL
    "Capital T" "5x8x10mm, upside down" MM 10
    0 -0.5 8 0
    0 -0.5 0.5 0
    0 -2.5 0.5 0
    0 -2.5 -0.5 180
    0 2.5 -0.5 0
    0 2.5 0.5 180
    0 0.5 0.5 0
    0 0.5 8 0
    0 -0.5 8 180
.END_ELECTRICAL

4. Wskazówki przy tworzeniu konturów

Podczas tworzenia konturów, zwłaszcza gdy są one udostępniane innym osobom, odpowiednie podejście przy ich tworzeniu i nazewnictwo pomoże innym szybciej zlokalizować pliki oraz umieszczać komponenty bez większych kłopotów.

4.1. Nazwy pakietów

Należy starać się zawierać pewne informacje o konturze w nazwie pliku, aby dać użytkownikowi ogólne pojęcie o tym, jaki kontur zawiera plik. Na przykład cylindryczna obudowa z wyprowadzeniami osiowymi może odzwierciedlać niektóre z rodzajów kondensatorów foliowych, jak również niektóre typy rezystorów, więc sensowne jest, by starać się identyfikować taki obrys jako poziomy lub pionowy z wyprowadzeniami, dodając kilka ważnych informacji o odpowiednich wymiarach: średnica, długość i rozstaw. Jeśli element posiada unikatowy kontur, warto dodać numer części według producenta i prefiks by wskazać klasę urządzenia.

4.2. Komentarze

Należy użyć komentarzy w pliku IDF, aby dać użytkownikom więcej informacji o konturze, na przykład odniesienie do źródła wykorzystywanego przy jego wymiarowaniu.

4.3. Wpisy Geometry i Part Number

Think carefully about the values to give to the Geometry and Part Number entries. Taken together, these strings act as a unique identifier for the MCAD system. The values of the strings will ideally have some meaning to a user, but this is not necessary: the values are primarily intended for the MCAD system to use as a unique ID. Ideally the values chosen will be unique within any large collection of outlines; choosing values well will result in fewer clashes especially in complex boards.

4.4. Orientacja wyprowadzeń oraz ich ustawianie

For through-hole components there are no widely accepted schemes for determining the pin orientation and component center in 3D models. For consistency, if there are only 2 pins they must be in a horizontal arrangement (see figure 4) along the X axis and for 3 pins try to keep 2 in a horizontal arrangement on the X axis. Polarized devices such as electrolytic or tantalum capacitors must have the positive lead on Pin 1 and diodes must have the cathode on Pin 1; this is to maintain compatibility of the schematic symbols with the orientation defined for SMT devices; however, note that many existing KiCad schematics and footprints place the anode at Pin 1.

Zapamiętaj

In the latest revision of the KiCad footprints on github the anode is now Pin 2 for THT as well as SMT components.

W przypadku komponentów DIP centrum konturu musi znajdować się w środku prostokąta opisanego w miejscu pinów, a pin 1 najlepiej by znajdował się w lewym górnym rogu; będzie to utrzymywać spójność ze znormalizowaną orientacją komponentów SMT; jednakże, taki model zostanie obrócony o -90 stopni w stosunku do większości istniejących footprintów w programie KiCad i modelów VRML. W przypadku elementów takich jak poziome kondensatory lub obudowy TO-220, najlepiej umieścić wyprowadzenia w rzędzie według osi X a korpus wyciągnięty do góry (patrz Rysunek 4). Niespolaryzowane pionowe elementy z wyprowadzeniami osiowymi muszą mieć wyprowadzenia z prawej strony; spolaryzowane pionowe elementy przewlekane mogą mieć wyprowadzenia z każdej strony, w zależności od tego, czy pin 1 znajduje się na dolnym końcu (wyprowadzenie po prawej) lub na górnym końcu (wyprowadzenie po lewej).

Zapamiętaj

In the current revision of the KiCad footprint modules the THT components are being organized with pins along the Y axis rather than the X axis and Pin 1 of the device is at the origin rather than at the center of the package. Orient and position the component outline to suit your specific footprints; this will avoid the need to specify a non-zero rotation for the IDF component outlines. Since the IDF exporter currently ignores the (X,Y) offset values it is vital that you use the correct origin in the IDF component outline.

W komponentach SMT orientacja, centrum pakietu oraz kontur są definiowane według różnych standardów. Należy użyć standardu właściwego dla własnego systemu pracy. Należy także pamiętać, że wiele komponentów nie odpowiada żadnym standardom; w takich przypadkach komponent wykraczający poza ramy najlepiej jest identyfikować przez numer części według producenta, umieszczonego w nazwie pliku konturu. Generalnie, obudowa SMT to kontur w postaci prostokąta obejmującego również wyprowadzenia; obudowa jest zorientowana tak, że pin 1 jest tak blisko jak to tylko możliwe lewego górnego rogu, a lewy górny róg jest zwykle sfazowany by był rozróżnialny.

Rysunek 4. Próbki konturów generowane przez programy idfrect oraz idfcyl zrenderowane przez SolidWorks.

Od lewej do prawej: (a) pionowy cylinder z wyprowadzeniami promieniowymi, (b) pionowy cylinder z wyprowadzeniem osiowym na lewo, (c) pionowy cylinder wyprowadzeniem osiowym na prawo, (d) poziomy cylinder z wyprowadzeniami osiowymi, (e) poziomy cylinder z wyprowadzeniami promieniowymi, (f) kwadratowy zarys, zwykły, (g) kwadratowy zarys z fazowaniem, (h) kwadratowy zarys z wyprowadzeniem osiowym na prawo. Kontury na górze zostały zwymiarowane w milimetrach, podczas gdy dolne kontury zostały zwymiarowane w jednostkach calowych.

4.5. Wskazówki dotyczące wymiarów

Celem dostarczenia “wyciąganych” konturów jest danie projektantowi mechanicznemu pewnego wyobrażenia o lokalizacji i fizycznej przestrzeni zajmowanej przez każdy z elementów. W typowym scenariuszu projektant mechaniczny zastąpi niektóre surowe modele za pomocą bardziej szczegółowych modeli, na przykład podczas sprawdzenia, czy zamontowane kątowe diody LED pasują do otworów w panelu. W większości sytuacji dokładność konturu nie ma znaczenia, ale do dobrej praktyki należy, stworzenie zarysów, które przeniosą możliwie jak najlepszą informacje mechaniczną. W kilku przypadkach użytkownik może chcieć, by dopasować komponent z bardzo niewielkim nadmiarem przestrzeni, na przykład w przypadku przenośnego odtwarzacza muzyki. W takiej sytuacji, jeżeli większość konturów dostarcza wystarczająco dobrą reprezentację komponentów, projektant mechanicznej części będzie musiał wymienić tylko niewiele modeli podczas projektowania obudowy. Jeśli kontury nie odbijają w pełni rzeczywistości, to projektant mechaniki będzie tylko tracić czas na zastępowanie modeli, tak by zapewnić im dobre dopasowanie. Mimo wszystko, jeśli umieścimy niepoprawne modele, to można oczekiwać tylko niepoprawnych rezultatów. Jeśli zaś umieścimy wiele odpowiednich informacji, można mieć pewność, że spotkamy się z dobrymi wynikami.

5. Narzęzia dla Kształtów IDF

Dostępny jest pewien zbiór narzędzi w linii poleceń, które pomagają tworzyć obrysy IDF. Narzędzia te to:

idfcyl: tworzy kontur cylindra w pionowej lub poziomej orientacji oraz osiowe lub promieniowe wyprowadzenia.
idfrect: tworzy zarys prostokąta, który może mieć zarówno wyprowadzenia osiowe lub sfazowania w lewym górnym rogu.
dxf2idf: konwertuje rysunki w formacie DXF na kontury komponentów IDF.

5.1. idfcyl

Gdy idfcyl zostanie wywołany bez parametrów użytkownik otrzyma informacje o jego użyciu i skrót informacji o danych wejściowych:

idfcyl: This program generates an outline for a cylindrical component.
    The cylinder may be horizontal or vertical.
    A horizontal cylinder may have wires at one or both ends.
    A vertical cylinder may have at most one wire which may be
    placed on the left or right side.

Input:
    Unit: mm, in (millimeters or inches)
    Orientation: V (vertical)
    Lead type: X, R (axial, radial)
    Diameter of body
    Length of body
    Board offset
    *   Wire diameter
    *   Pitch
    **  Wire side: L, R (left, right)
    *** Lead length
    File name (must end in *.idf)

    NOTES:
        *   only required for horizontal orientation or
            vertical orientation with axial leads

        **  only required for vertical orientation with axial leads

        *** only required for horizontal orientation with radial leads

Uwagi mogą zostać pominięte poprzez wprowadzenie odpowiednich argumentów w linii poleceń. Użytkownik może ręcznie wprowadzić informacje za pomocą linii poleceń lub osobnego skryptu generującego obrysy. Następujący skrypt tworzy pojedynczy okrągły kształt z wyprowadzeniem osiowym z prawej strony:

#!/bin/bash
# Generate a cylindrical IDF outline for test purposes
# vertical 5mm cylinder,  nominal length 8mm + 3mm board offset,
# axial wire on right,  0.8mm wire dia., 3.5mm pitch
idfcyl - 1 > /dev/null <<  _EOF
mm
v
x
5
8
3
0.8
3.5
r
cylvmm_1R_D5_L8_Z3_WD0.8_P3.5.idf
_EOF

5.2. idfrect

Gdy idfrect zostanie wywołany bez parametrów użytkownik otrzyma informacje o jego użyciu i skrót informacji o danych wejściowych:

idfrect: This program generates an outline for a rectangular component.
    The component may have a single lead (axial) or a chamfer on the
    upper left corner.
Input:
    Unit: mm, in (millimeters or inches)
    Width:
    Length:
    Height:
    Chamfer: length of the 45 deg. chamfer
    *  Leaded: Y,N (lead is always to the right)
    ** Wire diameter
    ** Pitch
    File name (must end in *.idf)

    NOTES:
        *   only required if chamfer = 0

        **  only required for leaded components

Uwagi mogą zostać pominięte poprzez wprowadzenie odpowiednich argumentów w linii poleceń. Użytkownik może ręcznie wprowadzić informacje za pomocą linii poleceń lub osobnego skryptu generującego obrysy. Następujący skrypt tworzy sfazowany kwadrat i okrągły kształt z wyprowadzeniami:

#!/bin/bash
# Generate various rectangular IDF outlines for test purposes
# 10x10, 1mm chamfer, 2mm height
idfrect - 1 > /dev/null <<  _EOF
mm
10
10
2
1
rectMM_10x10x2_C0.5.idf
_EOF
# 10x10x12,  0.8mm lead on 6mm pitch
idfrect - 1 > /dev/null <<  _EOF
mm
10
10
12
0
Y
0.8
6
rectLMM_10x10x12_D0.8_P6.0.idf
_EOF

5.3. dxf2idf

Plik DXF używany do określenia konturów komponentów może zostać przygotowany poprzez darmowe narzędzie LibreCAD by zachować najlepszą kompatybilność. Gdy dxf2idf zostanie wywołany bez parametrów użytkownik otrzyma informacje o jego użyciu i skrót informacji o danych wejściowych:

dxf2idf: this program takes line, arc, and circle segments
    from a DXF file and creates an IDF component outline file.

Input:
    DXF filename: the input file, must end in '.dxf'
    Units: mm, in (millimeters or inches)
    Geometry Name: string, as per IDF version 3.0 specification
    Part Name: as per IDF version 3.0 specification of Part Number
    Height: extruded height of the outline
    Comments: all non-empty lines are comments to be added to
        the IDF file. An empty line signifies the end of
        the comment block.
    File name: output filename, must end in '.idf'

#!/bin/bash
# Generate an IDF outlines from a DXF file
dxf2idf - 1 > /dev/null << _EOF
test.dxf
mm
DXF TEST GEOMETRY
DXF TEST PART
5
This is an IDF test file produced from the outline 'test.dxf'
This is a second IDF comment to demonstrate multiple comments

test_dxf2idf.idf
_EOF

6. idf2vrml

Narzędzie idf2vmrl odczytuje jeden plik IDF Board (.emn) i jeden IDF Component (.emp) i tworzy plik VRML, który można podejrzeć za pomocą przeglądarki VRML. Ta funkcjonalność jest stosowana w celu wizualizacji ułożenia elementów na płytce w tych przypadkach, gdzie użytkownik nie posiada dostępu do oprogramowania MCAD. Uruchomienie idf2vrml bez parametrów zwraca informacje o jego użyciu:

>./idf2vrml
Usage: idf2vrml -f input_file.emn -s scale_factor {-k} {-d} {-z} {-m}
flags:
   -k: produce KiCad-friendly VRML output; default is compact VRML
   -d: suppress substitution of default outlines
   -z: suppress rendering of zero-height outlines
   -m: print object mapping to stdout for debugging purposes
example to produce a model for use by KiCad: idf2vrml -f input.emn -s 0.3937008 -k
>

[BUG: The idf2vrml tool currently does not correctly render OTHER_OUTLINE entities in an emn file if that entity is specifies on the back layer of the PCB; however you will not notice this bug using files exported by KiCad since there is no mechanism to specify such an entity. Essentially this bug is only an issue in rare instances where you might render a third party emn file which does employ the entity on the back side of a board.]