diff --git a/docs/bestpractice/index.md b/docs/bestpractice/index.md new file mode 100644 index 0000000..091b436 --- /dev/null +++ b/docs/bestpractice/index.md @@ -0,0 +1 @@ +# Best Practice \ No newline at end of file diff --git a/docs/concepts/traits/index.de.md b/docs/concepts/traits/index.de.md index 0ca900a..4126e0c 100644 --- a/docs/concepts/traits/index.de.md +++ b/docs/concepts/traits/index.de.md @@ -7,4 +7,5 @@ Um eine optimale Anzeige der Traits für Nutzer in Clients zu ermöglichen, kann Traits werden anhand einer OID (Object Identifier) bereitgestellt. In FabAccess gibt es bereits vordefinierte Traits für grundlegende Funktionen, mit denen viele Zustände von Ressourcen abgebildet werden können. -## Hints \ No newline at end of file +## Hints +Mit Hints können Clients über die API einen optionalen Tipp zu einer Ressource erhalten, welcher Typ die Ressource hat. Dadurch können Clients ohne dass sich die Traits für diese Ressource ändern, bessere Darstellungen zur Verwendung der Ressource anzeigen. \ No newline at end of file diff --git a/docs/concepts/traits/index.en.md b/docs/concepts/traits/index.en.md index 2d009d7..b2f1f02 100644 --- a/docs/concepts/traits/index.en.md +++ b/docs/concepts/traits/index.en.md @@ -5,4 +5,5 @@ To enable optimal display of traits for users in clients, a "hint" can be added Traits are provided based on an OID (Object Identifier). FabAccess already includes predefined traits for basic functions, which can represent many states of resources. -## Hints \ No newline at end of file +## Hints +With Hints, clients can receive an optional tip about a resource's type via the API. This allows clients to display better representations for using the resource without the need for the resource's traits to change. \ No newline at end of file diff --git a/docs/getstarted.md b/docs/getstarted.md new file mode 100644 index 0000000..9e8c2d6 --- /dev/null +++ b/docs/getstarted.md @@ -0,0 +1,5 @@ +# Getting Started +Aller Anfang ist schwer, insbesondere beim Einstieg in FabAccess. Man fragt sich vielleicht, mit welchen Ressourcen man beginnen soll und ob am Ende alles wie geplant funktionieren wird. + +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. + diff --git a/docs/hardware/230v/index.md b/docs/hardware/230v/index.md new file mode 100644 index 0000000..e6cbcea --- /dev/null +++ b/docs/hardware/230v/index.md @@ -0,0 +1,11 @@ +# 230V +Für die Aktivierung von Ressourcen mit Strom bieten sich verschiedene Möglichkeiten an. Entweder kann dies direkt an der Ressource selbst erfolgen, über einen Zwischenstecker oder in der Unterverteilung. Für diese Anwendungsfälle gibt es entsprechende Produkte. + +Das Trait "Powerable" eignet sich für die Aktivierung von Ressourcen mit Strom. Damit können die Ressourcen eingeschaltet werden. + +Je nach den verwendeten Geräten zur Stromaktivierung lässt sich auch der Stromverbrauch messen. + +**Die Spezifikation für "Measurements" ist noch nicht vollständig!** + +## Empfehlung +Wenn Ressourcen mit 230V aktiviert werden, ist es wichtig zu beachten, dass diese Ressourcen auch einen unerwarteten Spannungsverlust verkraften können sollten. Die direkte Schaltung der Eingangsspannung mag zwar die einfachste Methode sein, ist aber nicht immer die beste Option, insbesondere wenn es um Ressourcen geht, die solche Spannungsabfälle nicht vertragen. diff --git a/docs/hardware/230v/nousa1t.md b/docs/hardware/230v/nousa1t.md new file mode 100644 index 0000000..7a425af --- /dev/null +++ b/docs/hardware/230v/nousa1t.md @@ -0,0 +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) + +**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/hardware/230v/shelly1.md b/docs/hardware/230v/shelly1.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/hardware/230v/shellyplug.md b/docs/hardware/230v/shellyplug.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/hardware/400v/index.md b/docs/hardware/400v/index.md new file mode 100644 index 0000000..6e6c4bc --- /dev/null +++ b/docs/hardware/400v/index.md @@ -0,0 +1 @@ +# 400V diff --git a/docs/hardware/400v/shellypro.md b/docs/hardware/400v/shellypro.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/hardware/door/index.md b/docs/hardware/door/index.md new file mode 100644 index 0000000..6d2c4ed --- /dev/null +++ b/docs/hardware/door/index.md @@ -0,0 +1 @@ +# Doors \ No newline at end of file diff --git a/docs/hardware/door/nuki.md b/docs/hardware/door/nuki.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/hardware/index.md b/docs/hardware/index.md new file mode 100644 index 0000000..4e00831 --- /dev/null +++ b/docs/hardware/index.md @@ -0,0 +1,6 @@ +# Hardware Support +Da FabAccess auf das Aktorenkonzept zur Steuerung von Hardware setzt, können prinzipiell alle Arten von Hardware angesteuert werden. Ob selbstgebaut oder gekauft ist dabei nicht relevant, solange es eine Schnittstelle gibt und die Motivation besteht, einen Aktor zu entwickeln. + +Für den Einstieg in FabAccess gibt es jedoch mehrere Produkte, die verwendet werden können und direkt vom Projekt unterstützt werden. + +In offenen Werkstätten treten verschiedene Probleme auf, für die nicht immer die perfekte Lösung vorhanden ist. Einige haben jedoch bereits ähnliche Probleme gelöst, und die Lösungen können vorerst verwendet werden, bis etwas Besseres entwickelt wurde. \ No newline at end of file diff --git a/docs/hardware/locker/index.md b/docs/hardware/locker/index.md new file mode 100644 index 0000000..321bb85 --- /dev/null +++ b/docs/hardware/locker/index.md @@ -0,0 +1 @@ +# Lockers \ No newline at end of file diff --git a/docs/img/nousa1t.jpg b/docs/img/nousa1t.jpg new file mode 100644 index 0000000..50eec35 Binary files /dev/null and b/docs/img/nousa1t.jpg differ diff --git a/mkdocs.yml b/mkdocs.yml index f98d83f..dfe907d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,3 +27,5 @@ markdown_extensions: - markdown_include.include: base_path: . - admonition + - attr_list + - md_in_html