Wiki source code of Selfbus Namenskonventionen

Last modified by Christian B. on 2021/02/22 15:09
Show last authors
1 {{velocity}}
2 $response.sendRedirect("https://selfbus.org/wiki/community/18-naming-conventions")
3 {{/velocity}}
4
5 (% id="cke_bm_149S" style="display:none" %) (%%)
6
7 {{box cssClass="floatinginfobox" title="**Contents**"}}
8 [[image:data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==||height="15" role="presentation" title="Click and drag to move" width="15"]]
9 {{/box}}
10
11 (% class="row" %)
12 (((
13 (% class="col-xs-12 col-sm-8" %)
14 (((
15 (% class="jumbotron" %)
16 (((
17 (% class="container" %)
18 (((
19 Eine einheitliche Verwendung von Begriffen und Strukturen erleichtert die Kommunikation. Neueinsteiger werden so das Projekt leichter verstehen, Alteingesessenen erleichtert es das Nachvollziehen von lange zurückliegenden Entwicklungen.
20
21 Hier werden die wichtigsten allgemeinen Konventionen zusammengefasst.
22 )))
23 )))
24
25 == ~-~-- ENTWURF ~-~-- ==
26
27 == Geräte ==
28
29 Selfbus-Geräte sind am Ende KNX-kompatible Geräte, die sich ähnlich wie die Kauflösungen verhalten.
30 Ein Selfbus-Gerät setzt sich in der Regel zusammen aus aus mehreren Bausteinen. Das Denken in Bausteinen repräsentiert mehr die Sicht eines Entwicklers, die Denke in Geräten mehr die eines Anwenders.
31
32 Wichtig ist festzuhalten, welche Kombinationen von konkreten Bausteinen valide sind, um ein fuktionierendes Gerät zu erzeugen.
33 Beispiel: "derselbe" 8fach Schaltaktor kann zwar dieselbe Applikationsplatine verwenden, aber verschiedene Controller (LPC922 SMD, LPC922 DIL oder LPC1115).
34
35 ,,Tabelle: Bausteinkombinationen 8fach Schaltaktor,,
36
37 (% style="height:159px; width:976px" summary="Bausteinkombinationen 8fach Schaltaktor" %)
38 |=(% scope="row" %)Gerät|=Controller-Baustein|=(% style="vertical-align:top" %)Applikations-Baustein
39 |=8fach Schaltaktor 10A|Controller LPCDIL - 4TE|(% style="vertical-align:top" %)(((
40 8out 10A
41 )))
42 |=8fach Schaltaktor 10A|Controller LPCSMD - 4TE|(% style="vertical-align:top" %)8out 10A
43 |=(% style="vertical-align:top" %)8fach Schaltaktor 10A|(% style="vertical-align:top" %)Controller ARM - 4TE|(% style="vertical-align:top" %)8out 10A
44 |=(% style="vertical-align:top" %)8fach Schaltaktor 16A|(% style="vertical-align:top" %)Controller ARM - 4TE|(% style="vertical-align:top" %)8out 16A v2.x
45 |=(% style="vertical-align:top" %) |(% style="vertical-align:top" %) |(% style="vertical-align:top" %)
46
47 == Prozessor-Bezeichnungen ==
48
49 |(bisher) Verwendeter Begriff|(% style="vertical-align:top" %)Standardisierter Begriff|Erläuterung
50 |(((
51 LPC, LPC 922, DIL
52 )))|(% style="vertical-align:top" %)LPCDIL|
53 |SMD LPC, LPC 922|(% style="vertical-align:top" %)LPCSMD|
54 |ARM|(% style="vertical-align:top" %)LPC1115|(((
55 * verfügt über die meisten Funktionen der LPC111x-Reihe
56 * zwingend notwendig für Rauchmeldermodul!
57 )))
58 |ARM|(% style="vertical-align:top" %)LPC1114|(((
59 * für viele SB-Appliaktionen ausreichend
60 * etwas günstiger als der LPC1115
61 )))
62 |ARM|(% style="vertical-align:top" %)ARM|wenn jede Variante der LPC111x-Reihe verwendet werden kann
63
64 == Dokumentation ==
65
66 Auch eine Vereinheitlichung der Struktur und Namen in der Dokumentation ist sinvoll - alleine, weil man sich schneller zurecht findet beim Suchen von Inhalten.
67
68 === Namensgebung für Geräte ===
69
70 Die Bezeichnung für ein Gerät wird konkateniert aus den folgenden Textbausteinen, wobei Werte in [] optional sind.
71
72 **[{differenzierende Merkmale}] {Gerätetyp} - [{besondere Eigenschaft}] - {Einbauort} [- {Version}]**
73
74 Das differenzierende Merkmal ist insbesondere wichtig um gleichartige Geräte mit zum Beispiel mehr oder weniger Kanälen unterscheiden zu können.
75
76 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.
77
78 Ein Hinweis, welche Optionen beider Wahl der Bausteine bestehen, sollte ausreichen.
79
80 **Beispiele**:
81
82 * 6fach 16A Schaltaktor - strommessend, bistabil - 6TE
83 * 8fach 10A Schaltaktor - 4TE
84 * 8fach 16A Schaltaktor - bistabil - 4TE
85 * 2fach AC 50Hz Dimmer - 4TE
86
87 === Namensgebung für Hardwarebausteine ===
88
89 Die Bezeichnung wird konkateniert aus den folgenden Textbausteinen, wobei Werte in [] optional sind.
90
91 **{Bausteintyp} {Bausteinname} {Prozessorvariante} - [{besondere Eigenschaft}] - {Einbauort} [{Einbaulage}] - {Version}**
92
93 Besonderheit: Manche Module (wie z.B. Einbaumodule) bestehen aus nur einem Hardwarebaustein! Daher müssten diese konsequenter Weise sowohl bei den Applikationsbausteinen als auch bei den Geräten gelistet werden.
94
95 **Beispiele**:
96
97 * Controller ARM - 4TE - v1.02
98 * Controller ARM - 4TE TOP - v1.0
99 * Controller LPCSMD - 4TE - v3.54
100 * Applikation 8out 16A - bistabile Relais - 4TE - v2.1
101 * Addon Tasterplatine - 4TE TOP - v1.0
102 * Einbaumodul Binäreingang LPC1115 - UP - v3.7
103 * Systembaustein FT1.2-Modul - HAT - v1.1
104 * Controller ARM - isoliert - 4TE VERT - v0.1
105
106 === Liste der Bausteintypen ===
107
108 * Applikation
109 * Controller
110 * Addon
111 * Systembaustein
112 * Einbaumodul
113
114 === Liste der Prozessorvarianten ===
115
116 * LPCDIL (für LPC922 im DIL Package)
117 * LPCSMD (für LPC922 im TSOP Package)
118 * LPC1115
119 * //leer //(für Bausteine, die sowohl von einem LPC922- als auch einem LPC1115-basierten Controller angesprochen werden können)
120
121 === Liste der Einbauorte ===
122
123 * 1TE
124 * 2TE
125 * 4TE (am häufigsten verwendet: REG-Gehäuse mit einer Breite von 4 Teilungseinheiten)
126 * 6TE
127 * 8TE
128 * UP (Gerät hat in einer Hohlwand- / Unterputzdose Platz)
129 * ET206 (BOPLA ET-206-Gehäuse)
130 * PK101 (BOPLA PK 101-Gehäuse)
131 * HAT (Hardware Attached on Top - Modul, das auf einen RPi aufgesteckt werden kann ([[https:~~/~~/www.raspberrypi.org/blog/introducing-raspberry-pi-hats/ )>>https://www.raspberrypi.org/blog/introducing-raspberry-pi-hats/]])
132
133 === Liste der Einbaulagen ===
134
135 * TOP
136 * MID
137 * BOT
138 * VERT
139
140 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.
141
142 Wird vom Standard (BOT = Applikation, MID = Controller, TOP = Addon) abgewichen, sollte das auf jeden Fall in der Bezeichnung angegeben werden.
143
144 Natürlich könnten diese Einbaulagen auch Einbaulagen von Platinen in anderen Gehäusen als den REG-Gehäusen differenzieren!
145
146 == ==
147 )))
148 )))