[S] Namenskonvention/"beste Praxis" zum Ablegen eigener Libs im KiCad-Projektordner

OP #8101184
Lesenswert?
• ▲
▼

Hallo liebes Forum,

ich arbeite seit ca. 2018 mit KiCad.

Meine etwas anspruchsvolleren Projekte (mit Gehäuseeinbau etc.) habe ich zu JLCPCB oder PCBway geschickt; mit der (Hand-)Bestückung und Inbetriebnahme hat danach stets alles bestens geklappt.

Nur eine Sache ist mir noch nicht ganz klar: Ich habe nahezu bei jedem Projekt eine Handvoll von Dateien, die nicht aus den Kicad-Bibliotheken stammen, sondern von mir selbst angelegt wurden. Drei Typen lassen sich unterscheiden:

  • Eigene Symbole (häufig nötig, z. B. für eher etwas seltene ICs).
  • Eigene Footprints (ab und zu nötig, z. B. für Elektromechanik wie Steckverbinder und Schalter).
  • Eigene Step-Dateien für die 3D-Ansicht. Bin allerdings eher nicht so der CAD-Zeichenkünstler und habe mich damit begnügt, anderswo gefundene Dateien hineinzukopieren und im x,y,z Offset anzupassen.

Soll ich diese Dateien einfach "flach" im Projektordner ablegen? Oder spezielle Unter-Ordnernamen anlegen? Welchen Alias-Namen (erforderlich) im Pfade-Setup soll ich wählen? Es wäre schön, wenn die Namensgebung robust gegen Änderungen des Projektnamens wäre. WIMRE konnte man bei älteren KiCad-Versionen den Projektnamen nicht einfach ändern. Heutzutage geht das allerdings schon über "Speichern unter..."

Ergibt es Sinn, die Ordnernamen oder die Aliase mit # oder _ beginnen zu lassen, damit die eigenen Spezial-Libs nicht mittendrin in einer alphabetischen Liste stehen, sondern immer am Anfang?

Habe ich etwas in der KiCad-Doku übersehen? Gibt es ein Beispielprojekt, in dem jemand das schön gelöst hat?

Meine Motivation ist folgende: Die selbstangelegten Libs von einem Projekt von 2018 werden vielleicht in einem Projekt von 2026 wieder gebraucht. Daher möchte ich das Ganze übersichtlich halten und auf einen Blick sehen können, was selbst angelegt wurde und was aus vordefinierten KiCad-Libs stammt.

Danke im Voraus für Hilfe und Tipps!

Grüße Christian

: Bearbeitet durch User
Moderator Persönliche Seite #8101225
Lesenswert?
• ▲
▼

Wenn ich Symbole oder Footprints für spezielle Bauteile anlege, benenne ich sie möglichst so, dass man am Namen erkennt, wofür es ist.

Wenn es irgendwelcher Kram ist, der erwartbar nur lokal in diesem Projekt benutzt wird (bspw. ein Gehäuse), dann nenne ich die Libs oft einfach nur "local".

Wenn man sehr viele STEP-Modelle hat, könnte sich ein Unterverzeichnis "3D" lohnen. Habe ich bislang meist nicht.

Ist übrigens recht unabhängig von KiCad – handhabe ich im Job mit Altium sehr ähnlich.

Persönliche Seite #8101235
Lesenswert?
• ▲
▼

Hallo Christian S.

Christian S. schrieb:

Drei Typen lassen sich unterscheiden:

Eigene Symbole (häufig nötig, z. B. für eher etwas seltene ICs). Eigene Footprints (ab und zu nötig, z. B. für Elektromechanik wie Steckverbinder und Schalter). Eigene Step-Dateien für die 3D-Ansicht. Bin allerdings eher nicht so der CAD-Zeichenkünstler und habe mich damit begnügt, anderswo gefundene Dateien hineinzukopieren und im x,y,z Offset anzupassen.

Du hast die bei den Projekten verwendeten Unterschaltpläne vergessen, die sich sehr oft auch in anderen Projekten wiederverwenden lassen.

Soll ich diese Dateien einfach "flach" im Projektordner ablegen? Oder spezielle Unter-Ordnernamen anlegen? Welchen Alias-Namen (erforderlich) im Pfade-Setup soll ich wählen? Es wäre schön, wenn die Namensgebung robust gegen Änderungen des Projektnamens wäre.

In den aktuelleren KiCad Versionen (ab Vers. 6?) sind sowohl die Symbole als auch die Footprints in den Schaltplan und Platinendateien selber enthalten. Trotzdem ist es sinnvoll, zusätzlich eigene Unterordner im Projekt anzulege, wo die Symbole, Footprints, 3D Daten und auch PDF-Datenblätter liegen. Das erspart Zeit beim suchen, und Du hast immer alles beisammen, und kannst komplette Projekte so weiterreichen.

Es wäre schön, wenn die Namensgebung robust gegen Änderungen des Projektnamens wäre.

Relative Pfade verwenden, keine globalen!

WIMRE konnte man bei älteren KiCad-Versionen den Projektnamen nicht einfach ändern. Heutzutage geht das allerdings schon über "Speichern unter..."

Ja, Du kannst das komplette Projekt unter neuem Namen Speichern. Die Namen, die von KiCad Projektspezifisch SELBER vergeben werden, werden mit geändert. Aber was Du sonst mit dem Projektnamen im Namen gespeichert hast, Nicht .

Ergibt es Sinn, die Ordnernamen oder die Aliase mit # oder _ beginnen zu lassen, damit die eigenen Spezial-Libs nicht mittendrin in einer alphabetischen Liste stehen, sondern immer am Anfang?

Must Du selber wissen. Jeder hat eigene Erfahrungen und Ordnungsvorlieben. Persönlich habe ich die Erfahrung gemacht, das es generell sehr sinnvoll ist, sich bei Datei- und Ordnernamen auf die "normalen" lateinischen Groß- und Kleinbuchstaben (ohne Umlaute und andere Sonderlocken wie "ß"), sowie die Zahlen und ".", "-" und "_" zu Beschränken, nicht nur bei KiCad. Speziell bei KiCad bin ich selber mal hereingefallen, als ich in einem Footprint ein Kaufmansund "&" verwendet habe, weil ich die Angewohnheit habe, in solche Dateinamen oft den Hersteller zu Benennen, und der Herstellername enthielt so etwas. Zumindest das damalige KiCad verwendete den Dateinamen intern in einer Platinendatei. Gleichzeitig bedeutete das "&" KiCadintern eine Escapesequenz, was zur Folge hatte, das der Footprint zu einem Abbruch des Programms führte. Ob das immer noch so der Fall ist, weiss ich nicht. Aber nachdem ich soetwas einmal erlebt habe, sehe ich solches Verhalten auch gelegentlich bei anderen Programmen. Darum bin ich da Vorsichtig.

Bei den Namen verwende ich ein Schema wie: "HTFS-Series_LEM-HallEffektCurrentTransducer_RevA_16Oct2013.kicad_mod", also eine Zusammensetzung aus Bauteilbezeichner, Hersteller, Funktionsbeschreibung, Revision und Erstellungsdatum. Dabei wird CamelCase verwendet, und die Blöcke durch Tiefstriche getrennt. Das Datum enthält immer den Monatsnamen mit 3 Stelliger Buchstabenabkürzung und Trennt die vierstellig geschriebene Jahreszahl von der Tageszahl. So ist immer klar, was gemeint ist, auch wenn man die einschlägige Norm vergessen hat. :O)

Habe ich etwas in der KiCad-Doku übersehen? Gibt es ein Beispielprojekt, in dem jemand das schön gelöst hat?

Ich habe mir schon lange die Beispielprojekte in KiCad selber nicht mehr angesehen. Die könnten als Vorbild dienen, aber sind vermutlich auf der anderen Seite sehr verkürzt. Ich habe selber mal solche Beispiele erstell, aber zuletzt für ein KiCad 6.

Meine Motivation ist folgende: Die selbstangelegten Libs von einem Projekt von 2018 werden vielleicht in einem Projekt von 2026 wieder gebraucht. Daher möchte ich das Ganze übersichtlich halten und auf einen Blick sehen können, was selbst angelegt wurde und was aus vordefinierten KiCad-Libs stammt.

Lege Dir einen eigenen Ordner irgendwo an, in der Du ein eigenes Bibliothekssystem Pflegst, in das Du schon einmal erfolgreich verwendete Bibliotheken, egal ob "originale" KiCad Bibliotheken oder eigene Bibliotheken. einpflegst. Bei zukünftigen Projekten nimmst Du bevorzugt aus diesen Bibliotheken, und erst wenn das nicht mehr langt, nimmst Du kiCad Bibliotheken oder baust etwas neues. Die Folge ist, dass Du meistens schon erprobte Bibliotheken verwendest, was die Gefahr von unangenehmen Überraschungen vermindert.

Danke im Voraus für Hilfe und Tipps!

Viel Erfolg!

Mit freundlichem Gruß: Bernd Wiebus alias dl1eic http:www.dl0dg.de

#8101245
Lesenswert?
• ▲
▼

Bernd W. schrieb:

Meine Motivation ist folgende: Die selbstangelegten Libs von einem Projekt von 2018 werden vielleicht in einem Projekt von 2026 wieder gebraucht. Daher möchte ich das Ganze übersichtlich halten und auf einen Blick sehen können, was selbst angelegt wurde und was aus vordefinierten KiCad-Libs stammt.

Lege Dir einen eigenen Ordner irgendwo an, in der Du ein eigenes Bibliothekssystem Pflegst, in das Du schon einmal erfolgreich verwendete Bibliotheken, egal ob "originale" KiCad Bibliotheken oder eigene Bibliotheken. einpflegst. Bei zukünftigen Projekten nimmst Du bevorzugt aus diesen Bibliotheken, und erst wenn das nicht mehr langt, nimmst Du kiCad Bibliotheken oder baust etwas neues.

Das funktioniert gut. Ich gehe noch einen Schritt weiter und verwende ausschließlich eigene Bibliotheken. Ggf. kopiere ich aus den Original-Bibliotheken in die eigenen. Und immer öfter lege ich neue Bauteile selbst an, bevor ich lange etwas passendes suche. Projektspezifische Bibliotheken sind schlecht für die Wiederverwendung. Weil: ich kann mich wohl erinnern, dass ich das Teil schon mal verwendet hatte, aber wo?

#8101282
Lesenswert?
• ▲
▼

Ich habe 3 zusätzlich Ordner in meinem KiCad Workspace: eig_symbols eig_footprints eig_3D

da kommt alles rein, was nicht in der standardlibs drin ist oder was ich geändert habe. Sinnvolle Dateinamen sind obligatorisch.

Bauform B. schrieb:

Ich gehe noch einen Schritt weiter und verwende ausschließlich eigene Bibliotheken. Ggf. kopiere ich aus den Original-Bibliotheken in die eigenen. Und immer öfter lege ich neue Bauteile selbst an, bevor ich lange etwas passendes suche.

Das macht auch Sinn, ist mir aber zuviel Arbeit. ;-)

#8101726
Lesenswert?
• ▲
▼

Hallo,

für eigene Bauteile habe ich eigene Ordner und Bibliotheken. Die Bibliotheken sind immer global angelegt. Das macht am meisten Sinn. Für Footprints war ich schlampig und es gibt nur eine Sammelbibliothek namens "my_Footprints". Für Symbole war ich sorgsamer und habe Bibliotheken für Bauteilrubriken angelegt beginnend immer mit "my_". Alle Dateien befinden sich bei mir im vorgesehen Ordner Dokumente\KiCad\xx.x\ und auch die 3D Modelle sind dort in "3dmodels" sortiert abgelegt. Nach KiCad Updates muss man notfalls nur die Aliase für die Pfade angeben, was meistens automatisch klappt. \Dokumente\KiCad\ lässt sich auch einfach sichern. Hier ist alles drin was ich mit KiCad mache. Selbst wenn ich alles neu installieren müsste, muss ich nur Kicad installieren, \Dokumente\KiCad\ zurückspielen, Aliaspfade angeben, fertig.

Antwort schreiben

Bitte melde dich an, um einen Beitrag zu schreiben.

oder

Mit Google-Account einloggen

Die Registrierung ist kostenlos und dauert nur eine Minute.

Jetzt registrieren