From 98bd2327d34d0262ea86deca01fd9029896b89c0 Mon Sep 17 00:00:00 2001 From: TheJoKlLa Date: Mon, 13 May 2024 23:42:37 +0200 Subject: [PATCH] Added: Text to concepts --- docs/concepts/actorinitiator.md | 6 ++++++ docs/concepts/auth.md | 5 ++++- docs/concepts/cachable.md | 5 +++++ docs/concepts/capnp.md | 9 ++++++++- docs/concepts/fabfire.md | 3 ++- docs/concepts/urlurn.md | 5 ++++- 6 files changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/concepts/actorinitiator.md b/docs/concepts/actorinitiator.md index 63507f9..1468878 100644 --- a/docs/concepts/actorinitiator.md +++ b/docs/concepts/actorinitiator.md @@ -1,2 +1,8 @@ # Actors and Initiators +Um FabAccess erweiterbar zu halten, basiert die Steuerung externer Geräte wie WLAN-Steckdosen oder Türschlösser auf einem Aktoren- und Initiatorskonzept. +## Aktoren +Aktoren in FabAccess haben die Aufgabe, die digitalen Zustände von Ressourcen in reale Zustände umzusetzen. Vom Server aus werden die Übergänge der Traits an kleine Skripte oder Prozesse weitergegeben, die entsprechend darauf reagieren. + +## Initiatoren +Mit Initiatoren werden reale Zustände auf die digitalen Zustände in FabAccess abgebildet. Zum Beispiel können Türkontakte den aktuellen Zustand der Tür übertragen, und FabAccess kann entsprechend darauf reagieren. \ No newline at end of file diff --git a/docs/concepts/auth.md b/docs/concepts/auth.md index b3952e2..e0e7b0a 100644 --- a/docs/concepts/auth.md +++ b/docs/concepts/auth.md @@ -1,5 +1,8 @@ # Authentication +Das Authentifizieren in FabAccess basiert vollständig auf SASL und unterstützt daher verschiedene Mechanismen. ## OAuth -## LDAP \ No newline at end of file +## LDAP + +## FabFire \ No newline at end of file diff --git a/docs/concepts/cachable.md b/docs/concepts/cachable.md index f969c1a..ad33609 100644 --- a/docs/concepts/cachable.md +++ b/docs/concepts/cachable.md @@ -1 +1,6 @@ # Cache Data +In FabAccess gibt es eine Unterscheidung zwischen statischen und dynamischen Daten, die von Ressourcen besessen werden. + +Dynamische Daten umfassen Zustände oder Messwerte, die von Ressourcen erzeugt werden. + +Statische Daten hingegen sind Eigenschaften, die sich nicht regelmäßig ändern, sondern nur in größeren zeitlichen Abständen. Diese statischen Daten werden in FabAccess zwischengespeichert, um die Antwortzeiten des Servers zu reduzieren und Ressourcen in Clients schneller anzeigen zu können. \ No newline at end of file diff --git a/docs/concepts/capnp.md b/docs/concepts/capnp.md index c45a2d3..36033fc 100644 --- a/docs/concepts/capnp.md +++ b/docs/concepts/capnp.md @@ -1 +1,8 @@ -# Capn Proto API +# Cap'n Proto API +Die API von FabAccess basiert auf Cap'n Proto. Cap'n Proto wird verwendet, um eine erweiterbare und bidirektionale API bereitzustellen. Dank der Codegenerierungsfunktion von Cap'n Proto kann die API in jede Programmiersprache portiert werden. Jedes Interface wird in einer übersichtlichen Schema-Sprache dargestellt, was die API selbst dokumentierend macht. Die Verfügbarkeit von Interfaces im Client kann durch einfache Null-Checks überprüft werden. + +Um einen übergeordneten Zugangspunkt zu bieten, ist die API in Systeme unterteilt, die erweitert und ausgetauscht werden können. Der Einstiegspunkt in die API ist das Bootstrap-Interface, das jedem Client angeboten wird. Nach der Authentifizierung werden die für den Client relevanten Interfaces bereitgestellt. + +Die API soll anderen Clients oder Skripten einen stabilen Zugang zu Ressourcen ermöglichen und die Zusammenarbeit zwischen Systemen fördern. Der Server entscheidet selbst, welche Ressourcen und Interfaces er den Clients zur Verfügung stellt, je nach Berechtigung und Konfiguration. Die Clients müssen daher in der Lage sein, damit umzugehen. + +Durch die API und die damit verbundenen Anforderungen soll der Zugang zu Ressourcen für alle erleichtert und die Zusammenarbeit gefördert werden. Diese Grundlagen sollen dazu beitragen, ein föderiertes System für den Ressourcenverleih aufzubauen. \ No newline at end of file diff --git a/docs/concepts/fabfire.md b/docs/concepts/fabfire.md index c08eef5..dcd77db 100644 --- a/docs/concepts/fabfire.md +++ b/docs/concepts/fabfire.md @@ -1 +1,2 @@ -# FabFire \ No newline at end of file +# FabFire +FabFire ist eine Entwicklung, die auf NXP Mifare DESFire basiert und die Anwendung von Karten nutzt, um Benutzer über das Over-the-Air (OTA)-Verfahren zu authentifizieren. \ No newline at end of file diff --git a/docs/concepts/urlurn.md b/docs/concepts/urlurn.md index 8925282..4c8f0fb 100644 --- a/docs/concepts/urlurn.md +++ b/docs/concepts/urlurn.md @@ -1 +1,4 @@ -# URL and URN \ No newline at end of file +# URL and URN +Ressourcen in FabAccess werden durch einen Namen dargestellt. Um jedoch die Suche nach Ressourcen zu verbessern, können diese Referenzen als URN (Uniform Resource Name) oder URL (Uniform Resource Locator) geschrieben werden. + +Die URN ist ein Identifikator ohne Bezug zum Space, während die URL auch den Space referenzieren kann, um einen Austausch von Ressourcen zu ermöglichen. \ No newline at end of file