diff --git a/docs/bestpractice/index.md b/docs/bestpractice/index.md index 091b436..d55cb26 100644 --- a/docs/bestpractice/index.md +++ b/docs/bestpractice/index.md @@ -1 +1,8 @@ -# Best Practice \ No newline at end of file +# Best Practice +## Netzwerk separieren +Für ein funktionierendes FabAccess-System sollten die Geräte, die Ressourcen freischalten, in einem separaten Netzwerk betrieben werden. Dadurch wird das Risiko minimiert, dass unerwartete Freischaltungen stattfinden. + +## Backups erstellen +Auch bei FabAccess ist es wichtig, regelmäßig Backups der Benutzerdatenbank und der Konfiguration zu erstellen. Nichts wirft einen mehr zurück als der Verlust aller zugewiesenen Rollen durch einen Ausfall. + +Für die Konfiguration bietet sich auch die Verwendung eines Git-Repositories an, um Änderungen nachvollziehen zu können. \ No newline at end of file diff --git a/docs/getstarted.md b/docs/getstarted.md index 9e8c2d6..b9c235e 100644 --- a/docs/getstarted.md +++ b/docs/getstarted.md @@ -3,3 +3,13 @@ Aller Anfang ist schwer, insbesondere beim Einstieg in FabAccess. Man fragt sich Mit diesem Getting Started möchten wir euch die Angst nehmen und einen einfachen Einstieg bieten, wie ihr Schritt für Schritt FabAccess bei euch einführen könnt. +## Was sollte man alles integrieren? +In FabAccess kann man grundsätzlich alles integrieren, was man möchte. Allerdings ist es nicht immer sinnvoll, da es entweder zu komplex ist, zu viel Zeit kosten würde oder sozial nicht verträglich ist. + +Für einen guten Einstieg sollte man mit den Ressourcen beginnen, deren Nutzung eingeschränkt werden muss. Sobald die Nutzer das System verstanden haben, kann man es auf andere Ressourcen ausweiten. + +## Wo fängt man an? +Ein guter Start bieten 3D-Drucker, da sich diese einfach mit 230V-Zwischensteckern freischalten lassen. Zudem hat man eine direkte Referenz, von welchem Nutzer der letzte Druck stammt. + +## Was muss man alles an Hardware kaufen? +Für den Anfang reichen ein paar 230V-Zwischenstecker aus. Mit diesen können bereits die ersten Ressourcen integriert werden. Alles andere an Hardware kann dann nachgerüstet werden, sobald das System läuft und die entsprechenden Berechtigungen vorhanden sind. \ No newline at end of file diff --git a/docs/hardware/230v/nousa1t.md b/docs/hardware/230v/nousa1t.md index 7a425af..536079c 100644 --- a/docs/hardware/230v/nousa1t.md +++ b/docs/hardware/230v/nousa1t.md @@ -1,6 +1,6 @@ # Nous A1T Mit dem Nous A1T lässt sich kostengünstig über einen Zwischenstecker die Stromversorgung von Ressourcen einschalten. Durch die Tasmota Firmware kann auch die Software angepasst werden. -![NousA1T](/img/nousa1t.jpg) +![NousA1T](./nousa1tp.jpg) **Wichtig ist, dass es sich bei dem Nous um die Tasmota-Variante handelt, da nur diese ohne externe Cloud funktioniert.** \ No newline at end of file diff --git a/docs/img/nousa1t.jpg b/docs/hardware/230v/nousa1tp.jpg similarity index 100% rename from docs/img/nousa1t.jpg rename to docs/hardware/230v/nousa1tp.jpg diff --git a/docs/hardware/230v/shelly1.md b/docs/hardware/230v/shelly1.md index e69de29..4241bd7 100644 --- a/docs/hardware/230v/shelly1.md +++ b/docs/hardware/230v/shelly1.md @@ -0,0 +1,11 @@ +# Shelly 1 +Mit dem Shelly 1 können Ressourcen extern über die Unterverteilung freigeschaltet werden. Auch kann der Shelly 1 sehr gut in Geräte eingebaut werden, um so auch mobile Geräte freizuschalten. + +Für die verschiedenen Shelly-Produkte gibt es auch 3D-gedruckte Hutschienenhalter. + +![Shelly 1](./shelly1p.jpg) + +# Shelly 1 Plus +Mit den Shelly Plus Modellen hat Shelly eine neue Generation von schaltbaren WLAN-Steckdosen und Adaptern veröffentlicht. Diese unterscheiden sich durch die Gen2-API und müssen daher anders angesteuert werden. + +![Shelly 1 Plus](./shelly1plusp.jpg) \ No newline at end of file diff --git a/docs/hardware/230v/shelly1p.jpg b/docs/hardware/230v/shelly1p.jpg new file mode 100644 index 0000000..48dcc1f Binary files /dev/null and b/docs/hardware/230v/shelly1p.jpg differ diff --git a/docs/hardware/230v/shelly1plusp.jpg b/docs/hardware/230v/shelly1plusp.jpg new file mode 100644 index 0000000..2db031f Binary files /dev/null and b/docs/hardware/230v/shelly1plusp.jpg differ diff --git a/docs/hardware/230v/shellyplug.md b/docs/hardware/230v/shellyplug.md index e69de29..c843ba1 100644 --- a/docs/hardware/230v/shellyplug.md +++ b/docs/hardware/230v/shellyplug.md @@ -0,0 +1,12 @@ +# Shelly Plug +Die Shelly-Steckdosen eignen sich gut, um Ressourcen einfach über den Strom zu schalten. + +## Shelly Plug S +Der Shelly Plug S ist das Äquivalent zum Nous A1T. Er kann jedoch weniger Strom als Dauerlast schalten. + +![Shelly Plug S](./shellyplugsp.jpg) + +# Shelly Plug 1 +Mit dem Shelly Plug 1 können bis zu 16A Dauerlast geschaltet werden. + +![Shelly Plug 1](./shellyplug1p.jpg) \ No newline at end of file diff --git a/docs/hardware/230v/shellyplug1p.jpg b/docs/hardware/230v/shellyplug1p.jpg new file mode 100644 index 0000000..630a59c Binary files /dev/null and b/docs/hardware/230v/shellyplug1p.jpg differ diff --git a/docs/hardware/230v/shellyplugsp.jpg b/docs/hardware/230v/shellyplugsp.jpg new file mode 100644 index 0000000..e2f07c9 Binary files /dev/null and b/docs/hardware/230v/shellyplugsp.jpg differ diff --git a/docs/hardware/400v/index.md b/docs/hardware/400v/index.md index 6e6c4bc..b4f5ec1 100644 --- a/docs/hardware/400v/index.md +++ b/docs/hardware/400v/index.md @@ -1 +1,8 @@ # 400V +Für die Ansteuerung von Ressourcen mit 400V Anschluss bieten sich verschiedene Kombinationen an. + +Für einen einfachen Einstieg kann ein 4-poliges Schütz mit einem 230V Relais verbunden werden, um den Strom zuzuschalten. + +Da bei diesen Geräten oft größere Lasten angeschlossen sind und diese nicht immer vom Strom im Betrieb getrennt werden können, bietet sich eine Kombination mit einem Stromzähler an. + +Es sollte auch ein Wiederanlaufschutz vorhanden sein oder vorgeschaltet werden, insbesondere bei diesen Ressourcen. \ No newline at end of file diff --git a/docs/hardware/400v/shellypro.md b/docs/hardware/400v/shellypro.md index e69de29..8951fc7 100644 --- a/docs/hardware/400v/shellypro.md +++ b/docs/hardware/400v/shellypro.md @@ -0,0 +1,4 @@ +# Shelly Pro 1 +Der Shelly Pro 1 eignet sich in der Kombination mit einem Schütz ideal dafür Resourcen mit 400V zu schalten. + +![Shelly Pro 1](./shellypro1p.png) \ No newline at end of file diff --git a/docs/hardware/400v/shellypro1p.png b/docs/hardware/400v/shellypro1p.png new file mode 100644 index 0000000..3eb6970 Binary files /dev/null and b/docs/hardware/400v/shellypro1p.png differ diff --git a/docs/hardware/door/index.md b/docs/hardware/door/index.md index 6d2c4ed..173bcdd 100644 --- a/docs/hardware/door/index.md +++ b/docs/hardware/door/index.md @@ -1 +1,4 @@ -# Doors \ No newline at end of file +# Doors +Um mit FabAccess Türen steuern zu können, ist es wichtig, bei der Auswahl der Aktoren darauf zu achten, dass es zu dem Zustand kommen kann, dass die Tür noch geöffnet ist, jedoch das Schloss verschlossen ist. Dieses Szenario kann mit geeigneten Sensoren wie Türkontakten behoben werden. + +Zur Steuerung kann entweder der Trait "Doorable" oder "Lockers" verwendet werden, je nachdem, wie die Tür Rückmeldung über ihren Zustand geben kann. \ No newline at end of file diff --git a/docs/hardware/door/nuki.md b/docs/hardware/door/nuki.md index e69de29..bed59d1 100644 --- a/docs/hardware/door/nuki.md +++ b/docs/hardware/door/nuki.md @@ -0,0 +1,8 @@ +# Nuki +Mit Nuki Türschlössern können bestehende Türen einfach umgerüstet werden. Die Ansteuerung kann dann direkt über MQTT erfolgen. + +Außerdem können die Schlösser mit den Nuki Türsensoren kombiniert werden. + +Für die Ansteuerung muss entweder ein Nuki Pro verwendet werden, der direkt über WLAN gesteuert werden kann, oder ein Nuki mit Gateway. + +![Nuki Pro](nukip.jpg) \ No newline at end of file diff --git a/docs/hardware/door/nukip.jpg b/docs/hardware/door/nukip.jpg new file mode 100644 index 0000000..049a970 Binary files /dev/null and b/docs/hardware/door/nukip.jpg differ diff --git a/docs/hardware/locker/index.md b/docs/hardware/locker/index.md index 321bb85..92c765a 100644 --- a/docs/hardware/locker/index.md +++ b/docs/hardware/locker/index.md @@ -1 +1,2 @@ -# Lockers \ No newline at end of file +# Lockers +Um Schließfächer oder ähnliche Einrichtungen zu integrieren, bieten sich einfache 12V DC Electric Locks an. Diese können dann mithilfe von Relais und ESPs angesteuert werden. \ No newline at end of file diff --git a/docs/index.de.md b/docs/index.de.md index c8c4e79..6b9969f 100644 --- a/docs/index.de.md +++ b/docs/index.de.md @@ -1,5 +1,4 @@ # Wilkommen bei FabAccess - FabAccess ist ein leistungsstarkes System, das das Management und die Zuweisung von Ressourcen ermöglicht. Mit seiner flexiblen API können Ressourcenbesitz und -zustände effektiv abgebildet werden, wobei jede Ressource einem bestimmten Benutzer zugeordnet werden kann. Darüber hinaus bietet FabAccess die Möglichkeit, Statusänderungen von Ressourcen zu verfolgen, was eine präzise Überwachung und Verwaltung ermöglicht. Ein zentraler Aspekt von FabAccess ist das Management von Berechtigungen, das die Steuerung des Zugriffs auf bestimmte Ressourcen ermöglicht. Diese Berechtigungen bieten eine feingranulare Kontrolle darüber, welcher Benutzer auf welche Ressourcen zugreifen kann, und dienen als wichtiges Instrument für die Sicherheit und Effizienz des Systems. diff --git a/docs/index.en.md b/docs/index.en.md index ec3d859..58b2b59 100644 --- a/docs/index.en.md +++ b/docs/index.en.md @@ -1,5 +1,4 @@ # Welcome to FabAccess - FabAccess is a powerful system that enables the management and allocation of resources. With its flexible API, resource ownership and states can be effectively mapped, with each resource being assignable to a specific user. Furthermore, FabAccess provides the capability to track status changes of resources, facilitating precise monitoring and management. A central aspect of FabAccess is the management of permissions, which allows for controlling access to specific resources. These permissions offer granular control over which user can access which resources, serving as a crucial tool for the security and efficiency of the system. diff --git a/mkdocs.yml b/mkdocs.yml index dfe907d..cbe6876 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,13 @@ theme: primary: blue grey accent: teal +# nav: +# - 'index.md' +# - 'getstarted.md' +# - concepts/*.md +# - example/*.md +# - hardware/*.md +# - bestpractice/*.md plugins: - search - mkdocstrings: