Selfbus

Grundsätzliches

Dateinamen werden grundsätzlich in Englisch erzeugt, auch wenn der Großteil der Diskussionen und der Dokumentation auf Deutsch ist. 

Um überlange Dateinamen zu vermeiden, sollten Abkürzungen verwendet werden. Wiederkehrene Bausteine / Bausteinnamen sollten gleichermaßen benannt und abgekürzt werden. 

Abkürzungen

controller -> ctrl
application -> app
module -> mod
addon -> add
middle (layer) -> mid
bottom (layer) -> bot

Geräte

Ein Selfbus-Gerät ist in der Regel aus mehreren Bausteinen aufgebaut.

Wichtig ist festzuhalten, welche Kombinationen von konkreten Bausteinen valide sind, um ein fuktionierendes Gerät zu erzeugen.
Beispiel: "derselbe" 8-fach Schaltaktor kann zwar dieselbe Applikationsplatine verwenden, aber verschiedene Controller (LPC922 SMD, LPC922 DIL oder LPC1115).

Prozessor-Bezeichnungen

Namensgebung für Geräte

Die Bezeichnung für ein Gerät wird konkateniert aus den folgenden Textbausteinen, wobei Werte in [] optional sind.
Das Wichtigste zuerst!

{Gerätetyp} [{differenzierende Merkmale}] [{besondere Eigenschaft}] {Einbauort} [{differenzierende Merkmale}] [- {Version}]

Das differenzierende Merkmal ist insbesondere wichtig um gleichartige Geräte mit zum Beispiel mehr oder weniger Kanälen unterscheiden zu können.

Ob die Version bei Geräten wirklich Sinn macht, ist fraglich. Nur weil eine Applikationsplatine weiterentwickelt wird, sollte man keine neue Geräte Version dokumentieren. Eine neue Variante, die zum Beispiel durch eine andere Anschlussvariante der Phase auf der 16A Applikationsplatine für den 8fach 16A entstand, die aber ansonsten (Aufbau, Bauteile, Controller, Einbauort und -größe), sollte nicht auf Geräte-Ebene differenziert werden.

Ein Hinweis, welche Optionen bei der Wahl der Bausteine bestehen, sollte ausreichen.

Beispiele:

• Schaltaktor 6-fach 16A - strommessend, bistabil - 6TE
• Schaltaktor 8-fach 10A - 4TE
• Schaltaktor 8-fach 16A - bistabil - 4TE
• Dimmer 2-fach AC 50Hz - 4TE
• IO-Modul "XL" 24-fach - abgesichert - UP 

Namensgebung für Hardwarebausteine

Die Bezeichnung wird konkateniert aus den folgenden Textbausteinen, wobei Werte in [] optional sind. 

{Bausteintyp} [{Bausteinname}] [{Prozessorvariante}] [{besondere Eigenschaft}] {Einbauort} [{Einbaulage}] [{differenzierende Merkmale}] [-{Version}]

Besonderheit: Manche Bausteine (wie z.B. (Einbau-) Module) bestehen aus nur einem Hardwarebaustein! Daher müssten diese konsequenter Weise sowohl bei den Applikationsbausteinen als auch bei den Geräten gelistet werden.

Die Versionierung spielt während der Enwicklung keine Rolle. 

Beispiele:

• Controller ARM 4TE MID Entwicklung - v1.02 (Dateiname:  ctrl_LPC1115-4TE_MID_dev_v1.02.brd)
• Controller ARM 4TE TOP - v1.0
• Controller LPCSMD 4TE - v3.54
• Applikation 8out 16A bistabile Relais 4TE - v2.1
• Addon Tasterplatine 4TE TOP - v1.0
• Modul Binäreingang LPC1115 UP - v3.7
• Modul FT1.2 HAT - v1.1
• Controller ARM isoliert 4TE VERT - v0.1

Liste der Bausteintypen

• Applikation
• Controller
• Addon
• Systembaustein
• Modul
• Breakoutboard

Liste der Prozessorvarianten

• LPC922 (für LPC922 im DIL Package)
• LPC922SMD (für LPC922 im TSOP Package)
• LPC1115
• leer (für Bausteine, die sowohl von einem LPC922- als auch einem LPC1115-basierten Controller angesprochen werden können)

Liste der Einbauorte

• 1TE
• 2TE
• 4TE (am häufigsten verwendet: REG-Gehäuse mit einer Breite von 4 Teilungseinheiten)
• 6TE
• 8TE
• UP (Gerät hat in einer Hohlwand- / Unterputzdose Platz)
• ET206 (BOPLA ET-206-Gehäuse)
• PK101 (BOPLA PK 101-Gehäuse)
• HAT (Hardware Attached on Top - Modul, das auf einen RPi aufgesteckt werden kann (https://www.raspberrypi.org/blog/introducing-raspberry-pi-hats/ ))

Liste der Einbaulagen

• TOP
• MID
• BOT
• VERT

Die standardmäßig verwendeten REG-Einbaugehäuse haben drei verwendbare Abschnitte. Der untere (BOT) ist der flächenmäßig größte und trägt typischerweise die Applikationsplatine mit den Fahrstuhlklemmen. Der mittlere (MID) wurde bisher fast immer verwendet, um die Controllerplatine aufzunehmen. Der obere (TOP) wurde meist verwendet, um Addon-Platinen für Taster / LEDs unterzubringen.

Wird vom Standard (BOT = Applikation, MID = Controller, TOP = Addon) abgewichen, sollte das auf jeden Fall in der Bezeichnung angegeben werden.

Natürlich könnten diese Einbaulagen auch Einbaulagen von Platinen in anderen Gehäusen als den REG-Gehäusen differenzieren!