mirror of
https://gitlab.com/fabinfra/fabaccess/docs.git
synced 2024-12-22 04:03:47 +01:00
Added: concepts
This commit is contained in:
parent
578be5a47c
commit
14c71e1f39
22
source/concepts/claims.de.md
Normal file
22
source/concepts/claims.de.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Claim Konzept
|
||||
Das Claim Konzept dienen als Abstraktion des Verleihens einer Ressource in FabAccess. Ihr Hauptzweck besteht darin, die Möglichkeiten zu verwalten, wie Benutzer Zugriff auf eine Ressource erhalten und diesen Zugriff untereinander teilen können.
|
||||
|
||||
## Claims
|
||||
Ein "Claim" in FabAccess repräsentiert den gewährten Zugriff auf eine Ressource.
|
||||
|
||||
Die Flexibilität von Claims ermöglicht es, verschiedene Szenarien des Ressourcenzugriffs effektiv zu unterstützen. Zum Beispiel können mehrere Benutzer gleichzeitig einen Claim für eine Ressource erhalten, was besonders in Umgebungen mit kollaborativem Arbeiten von Vorteil ist. Darüber hinaus bietet die Möglichkeit, sich in eine Warteschlange mit einem Interest einzutragen, eine praktische Lösung für Situationen, in denen die Verfügbarkeit einer Ressource begrenzt ist und Benutzer darauf warten müssen, darauf zugreifen zu können.
|
||||
|
||||
Ein weiterer wichtiger Aspekt von Claims ist ihre Fähigkeit, Ressourcen zwischen Benutzern zu transferieren oder auszuleihen. Diese Funktionen ermöglichen eine flexible Nutzung der Ressourcen und fördern die Zusammenarbeit zwischen den Benutzern. Zum Beispiel kann ein Benutzer, der eine Ressource nicht mehr benötigt, diese einem anderen Benutzer übertragen, der sie gerade benötigt, oder ein Ausbilder kann einem Auszubildenden vorübergehend Zugriff auf eine Ressource gewähren, um bestimmte Fähigkeiten zu erlernen.
|
||||
|
||||
## Interest
|
||||
Ein wichtiger Bestandteil des Claims-Konzepts sind "Interest", die Reservierungen abbilden, die entweder zeitbasiert oder auf einer Warteschlange basieren können. Diese Interessen bieten den Benutzern die Möglichkeit, einen zukünftigen Zugriff auf eine Ressource zu sichern, entweder basierend auf einer vordefinierten Zeit oder in der Reihenfolge des Eintritts in die Warteschlange.
|
||||
|
||||
Mit einem Interest signalisiert der Nutzer dem System sein Interesse an einer bestimmten Ressource. Bei der nächsten Gelegenheit erhält der Nutzer entweder einen Claim auf die Ressource oder hat die Möglichkeit, seinen Interest auf einen Claim zu aktualisieren. Diese Flexibilität ermöglicht es den Benutzern, ihre Bedürfnisse anzupassen und auf Änderungen in der Verfügbarkeit der Ressourcen zu reagieren.
|
||||
|
||||
|
||||
## Notify
|
||||
Das letzte Element des Claim-Konzepts ist der "Notify". Durch den Notify können Nutzer den Status einer Ressource einsehen und sich über Änderungen benachrichtigen lassen.
|
||||
|
||||
Der Notify ermöglicht es Benutzern, den aktuellen Zustand einer Ressource abzurufen und bei Bedarf auf Änderungen zu reagieren. Dies bietet eine wichtige Möglichkeit, den Zustand von Ressourcen zu überwachen und zeitnah auf relevante Ereignisse zu reagieren.
|
||||
|
||||
Durch die Möglichkeit, sich für Benachrichtigungen über Zustandsänderungen zu registrieren, können Benutzer effektiv mit den Ressourcen interagieren und sicherstellen, dass sie stets über wichtige Entwicklungen informiert sind.
|
22
source/concepts/claims.en.md
Normal file
22
source/concepts/claims.en.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Claim Concept
|
||||
|
||||
The claim concept serves as an abstraction for allocating a resource in FabAccess. Its primary purpose is to manage the methods by which users gain access to a resource and share that access among themselves.
|
||||
|
||||
## Claims
|
||||
A "claim" in FabAccess represents the granted access to a resource.
|
||||
|
||||
The flexibility of claims enables effective support for various scenarios of resource access. For instance, multiple users can simultaneously claim access to a resource, which is particularly advantageous in collaborative working environments. Additionally, the ability to register in a queue with an interest provides a practical solution for situations where resource availability is limited, and users must wait to access it.
|
||||
|
||||
Another significant aspect of claims is their capability to transfer or lend resources between users. These functionalities facilitate a flexible utilization of resources and foster collaboration among users. For example, a user who no longer requires a resource can transfer it to another user in need, or an instructor can temporarily grant access to a resource to a trainee to acquire specific skills.
|
||||
|
||||
## Interest
|
||||
An integral part of the claim concept is "interest," which represents reservations that can be either time-based or queue-based. These interests allow users to secure future access to a resource, either based on a predefined time or in the order of entry into the queue.
|
||||
|
||||
With an interest, the user signals their interest in a particular resource to the system. At the next opportunity, the user either receives a claim to the resource or has the option to upgrade their interest to a claim. This flexibility enables users to adapt to their needs and respond to changes in resource availability.
|
||||
|
||||
## Notify
|
||||
The final element of the claim concept is the "notify." Through the notify, users can view the status of a resource and receive notifications about changes.
|
||||
|
||||
The notify allows users to retrieve the current state of a resource and respond to changes as needed. This provides an essential means of monitoring resource status and reacting promptly to relevant events.
|
||||
|
||||
By registering for notifications of state changes, users can effectively interact with resources and ensure they are informed about important developments at all times.
|
@ -1,16 +0,0 @@
|
||||
# Claims
|
||||
Ein Claim ist eine Zugang zu einer Resource um deren dynamischen Zustand zu ändern. Claims können dabei auch von mehreren Nutzern gleichzeitig erhalten werden.
|
||||
Claims enthalten Traits, welche eine Liste an Methoden ist, um den Zustand einer Resource zu ändern.
|
||||
Um einen Claim auf eine Resource zu erhalten kann man entweder ein Claim der Resource selber beziehen oder sich auf eine Liste mit einem Interest eintragen, welche als Queue abgearbeitet wird, sobald eine Resource disowned wird.
|
||||
|
||||
Ein Interest bildet das Anmeleden eines Interesses an einer Resource beim Server an. Ein Interest ist hierbei verbindlich, sollte also ein Nutzer ein Interest auf eine Resource haben, dann wird ihm diese auch automatisch gegeben, sobald die Resource keinen Claim mehr hat.
|
||||
|
||||
Um den Zustand einer Resource abzufragen kann auf eine Resource ein Notify geholt werden. Dieses Notify gibt den Zustand einer Resource zurück, also auch eine Möglichkeit auf einen Zustand zu einer Resource zu subscriben und Updates zu einer Änderung zu erhalten.
|
||||
|
||||
Mit Claims sollen die verschienden Eigenschaften einer Resource abgebildet werden ohne, dass der Server das Konzept des Verleihens jedes mal neu Implementieren muss.
|
||||
|
||||
Eine weitere Möglichkeit einen Claim zu erhalten ist über ein Transfer eines Claims. Hierbei holt sich der erste Nutzer ein Token, über transfer(), welches er per QR-Code oder NFC an einen zweiten Nutzer weitergibt. Dieser kann dann den Claim übernehmen, wenn er das Token beim Server einlöst. Dabei ist zu beachten, dass der übernehmende Nuter auch über die Berechtigung verfügen muss die Resource leihen zu dürfen.
|
||||
|
||||
Die letzte Möglichkeit einen Claim zu erhalten ist in dem ein Ausbilder lend() auf dem Claim aufruft und ein Token erhält, welches er einer Auszubildenen übergibt. Dieser kann dann auch die Maschine nutzen, wenn er nicht die erforderliche Berechtigung hat. Dabei erhält nach erfolgreicher einlösung des Tokens der Ausbilder einen Interest, mit welchem er den Claim zurückfordern kann. Dieses Konzept kann recursiv angewendet werden. Bei einem Lend bleibt der übergeber des Tokens in Verantwortung, im gegensatz zum Transfer, in dem er die Verantwortung abgibt.
|
||||
|
||||
# TODO
|
@ -1,9 +1,7 @@
|
||||
Concepts of FabAccess
|
||||
=================
|
||||
|
||||
FabAccess nutzt mehrer Konzept um den Process des Verleihens nutzbar zu machen. Und an den benötigten Stellen Freiheiten zugeben, um Anpassungen vornehmen zu können.
|
||||
|
||||
|
||||
FabAccess utilizes several key concepts to facilitate the process of resource allocation and provide flexibility where needed to accommodate customization.
|
||||
|
||||
.. toctree::
|
||||
claims.md
|
||||
|
6
source/concepts/measurements.de.md
Normal file
6
source/concepts/measurements.de.md
Normal file
@ -0,0 +1,6 @@
|
||||
# Measurements
|
||||
Durch "Measurements" in FabAccess werden Daten von Ressourcen gesammelt, um deren Leistung und Nutzung zu erfassen. Das Ziel ist es, dass FabAccess diese Messwerte sammelt und an die Nutzer weitergibt.
|
||||
|
||||
Die Funktion Measurements ermöglicht es FabAccess, wichtige Daten über die Nutzung von Ressourcen zu erfassen und den Nutzern zur Verfügung zu stellen. Dies umfasst Informationen wie Betriebsstunden, Auslastung und andere Leistungsindikatoren, die es den Nutzern ermöglichen, die Effizienz und Produktivität ihrer Arbeitsprozesse zu optimieren.
|
||||
|
||||
**Das Konzept zu Projekten exitiert zwar, jedoch gibt es noch keine Spezifikation!**
|
@ -1,2 +0,0 @@
|
||||
# Measurements
|
||||
Messwerte von Resourcen
|
6
source/concepts/projects.de.md
Normal file
6
source/concepts/projects.de.md
Normal file
@ -0,0 +1,6 @@
|
||||
# Projects
|
||||
Projekte in FabAccess sollen die Zusammenarbeit zwischen den Nutzern fördern und gleichzeitig die Abrechnung von Maschinenzeiten verbessern. Ein wichtiger Aspekt der Projektstruktur ist die Möglichkeit für Nutzer, Claims innerhalb desselben Projekts miteinander zu teilen, um gleichzeitig auf Ressourcen zugreifen zu können.
|
||||
|
||||
Durch die Zuweisung von Nutzern zu Projekten können Teams effizient zusammenarbeiten und ihre Ressourcen optimal nutzen. Das Teilen von Claims innerhalb eines Projekts ermöglicht es den Teammitgliedern, nahtlos auf benötigte Ressourcen zuzugreifen und gemeinsam an Projekten zu arbeiten. Darüber hinaus erleichtert diese Funktionalität die Abrechnung von Maschinenzeiten, da die Nutzung der Ressourcen innerhalb eines Projekts besser nachverfolgt und zugeordnet werden kann.
|
||||
|
||||
**Das Konzept zu Projekten exitiert zwar, jedoch gibt es noch keine Spezifikation!**
|
@ -1,2 +0,0 @@
|
||||
# Projects
|
||||
Claims mit einem Verweis auf Projekte beim Leihen von Resourcen
|
264
source/concepts/resourcenraum.md
Normal file
264
source/concepts/resourcenraum.md
Normal file
@ -0,0 +1,264 @@
|
||||
# Beispiel Space
|
||||
+ Spacename: Resourcenraum
|
||||
+ InstanceURL: resourcenraum.fab-access.space
|
||||
+ User-Passwort: secret
|
||||
+ User-PIN: 1234
|
||||
|
||||
Der Beispielspace "Resourcenraum" ist ein Konstrukt, das entworfen wurde, um die verschiedenen Anforderungen und Konzepte verschiedener offener Werkstätten abzubilden. Auf diesem Space basieren auch die Tests für die API, mit denen die Funktionalität überprüft und Entwicklern ein Leitfaden gegeben werden kann.
|
||||
|
||||
## Users
|
||||
### Admin - admin
|
||||
User für Debugging und Testing
|
||||
|
||||
### User mit Aufgaben im Space
|
||||
#### Sarah Barth - sbarth
|
||||
- Adresse: Albrechtstrasse 73, 85003 Ingolstadt
|
||||
- E-Mail: sbarth@resourcenraum.fab-access.space
|
||||
- Rolle: Admin im Space mit allen Rechten
|
||||
- Projekt: Management, Ausbildung, Workshop
|
||||
- Card: 0000000000001
|
||||
|
||||
#### Claudia Neustadt - cneustadt
|
||||
- Adresse: Bayreuther Strasse 25, 67661 Kaiserslautern Hohenecken
|
||||
- E-Mail: cneustadt@resourcenraum.fab-access.space
|
||||
- Rolle: Manage im Space für Metallbearbeitung
|
||||
- Projekt: Management, Ausbildung
|
||||
- Card: 0000000000002
|
||||
|
||||
#### Thomas Naumann - tneumann
|
||||
- Adresse: Inge Beisheim Platz 6, 21339 Lüneburg
|
||||
- E-Mail: tneumann@resourcenraum.fab-access.space
|
||||
- Rolle: Manage im Space für Holzbearbeitung
|
||||
- Projekt: Management, Ausbildung
|
||||
- Card: 0000000000003
|
||||
|
||||
#### Maik Pfeiffer - mpfeiffer
|
||||
- Adresse: Rudower Chaussee 15, 46238 Bottrop Batenbrock-Süd
|
||||
- E-Mail: mpfeiffer@resourcenraum.fab-access.space
|
||||
- Rolle: Manage im Space für Rapid Prototyping
|
||||
- Projekt: Management, Ausbildung
|
||||
- Card: 0000000000004
|
||||
|
||||
#### Katharina Abendroth - kabendroth
|
||||
- Adresse: Storkower Strasse 34, 56332 Wolken
|
||||
- E-Mail: kabendroth@resourcenraum.fab-access.space
|
||||
- Rolle: Manage für alle Ressourcen zur Reparatur
|
||||
- Projekt: Management
|
||||
- Card: 0000000000005
|
||||
|
||||
#### Ralf Luft - rluft
|
||||
- Adresse: An der Alster 3, 26721 Emden
|
||||
- E-Mail: rluft@resourcenraum.fab-access.space
|
||||
- Rolle: Manage für alle Ressourcen zur Reinigung
|
||||
- Projekt: Management
|
||||
- Card: 0000000000006
|
||||
|
||||
#### Sabine Faerber - sfaerber
|
||||
- Adresse: Michaelkirchstr. 84, 34385 Bad Karlshafen
|
||||
- E-Mail: sfaerber@resourcenraum.fab-access.space
|
||||
- Rolle: Manage für User und Abrechnung
|
||||
- Projekt: Management
|
||||
|
||||
#### Phillipp Blau - pblau
|
||||
- Adresse: Schönwalder Allee 15, 09218 Neukirchen
|
||||
- E-Mail: pblau@resourcenraum.fab-access.space
|
||||
- Rolle: Workshop für neue Leute für unspezialisierte Ressourcen
|
||||
- Projekt: Workshop
|
||||
- Card: 0000000000007
|
||||
|
||||
### User die den Space nutzen
|
||||
#### Michael Ziegler - mziegler
|
||||
- Adresse: Leipziger Strasse 76, 33619 Bielefeld Niederdornberg
|
||||
- E-Mail: mziegler@resourcenraum.fab-access.space
|
||||
- Rolle: Neu im Space und hat noch keinen Account
|
||||
- Card: 0000000000008
|
||||
|
||||
#### Leonie Fischer - lfischer
|
||||
- Adresse: Hauptstrasse 10, 10115 Berlin Mitte
|
||||
- E-Mail: lmueller@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzender des Space, hat Zugang zu allen Bereichen
|
||||
- Card: 0000000000009
|
||||
|
||||
#### Julia Schneider - jschneider
|
||||
- Adresse: Feldstrasse 5, 80333 München
|
||||
- E-Mail: jschneider@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzende des Space, hat Zugang zur Metallbearbeitung
|
||||
|
||||
#### Felix Wagner - fwagner
|
||||
- Adresse: Ludwig-Erhard-Strasse 20, 50679 Köln
|
||||
- E-Mail: fwagner@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzender des Space, hat Zugang zur Holzbearbeitung
|
||||
- Card: 000000000000A
|
||||
|
||||
#### Lara Schmidt - lschmidt
|
||||
- Adresse: Am Wehrhahn 50, 40211 Düsseldorf
|
||||
- E-Mail: lschmidt@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzende des Space, hat Zugang zum Rapid Prototyping
|
||||
|
||||
#### Lisa Meier - lmeier
|
||||
- Adresse: Musterstraße 123, 12345 Musterstadt
|
||||
- E-Mail: lmeier@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzende des Space, hat Zugang zum Rapid Prototyping
|
||||
- Projekt: Horizon
|
||||
- Card: 000000000000B
|
||||
|
||||
#### Tim Fischer - tfischer
|
||||
- Adresse: Beispielweg 456, 54321 Beispielstadt
|
||||
- E-Mail: tfischer@resourcenraum.fab-access.space
|
||||
- Rolle: Nutzender des Space, hat Zugang zum Rapid Prototyping
|
||||
- Projekt: Horizon
|
||||
|
||||
#### Niklas Becker - nbecker
|
||||
- Adresse: Hauptplatz 8, 10178 Berlin Mitte
|
||||
- E-Mail: nbecker@resourcenraum.fab-access.space
|
||||
- Rolle: Keine zusätzlichen Berechtigungen
|
||||
- Card: 000000000000D
|
||||
|
||||
## Resourcen
|
||||
### Allgemein
|
||||
#### Lötstation - solderstation
|
||||
- Ansteuerung: 230V - Zwischenstecker
|
||||
- Berechtigungen: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
|
||||
#### 3D-Scanner - 3dscanner
|
||||
- Ansteuerung: Keine
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Keine
|
||||
|
||||
#### Heißklebepistole - hotgluegun
|
||||
- Ansteuerung: 12V DC Lock (feste Position)
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Doorable
|
||||
|
||||
#### Schraubendrehersatz - screwdriverset
|
||||
- Ansteuerung: Keine
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Keine
|
||||
|
||||
#### Ringmaulschlüsselsatz - wrenchset
|
||||
- Ansteuerung: Keine
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Keine
|
||||
|
||||
#### Akkuschrauber - electricscrewdriver
|
||||
- Ansteuerung: 12V DC Lock (variable Position)
|
||||
- Berechtigung: Elektrowerkzeuge
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Locatable, Lockable
|
||||
|
||||
### Stichsäge - jigsaw
|
||||
- Ansteuerung: 12V DC Lock (variable Position)
|
||||
- Berechtigung: Elektrowerkzeuge
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Locatable, Lockable
|
||||
|
||||
### Winkelschleifer - anglegrinder
|
||||
- Ansteuerung: 12V DC Lock (variable Position)
|
||||
- Berechtigung: Elektrowerkzeuge
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Locatable, Lockable
|
||||
|
||||
### Eingangstür - frontdoor
|
||||
- Ansteuerung: 12V DC Summer
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Doorable (nur tmpOpen)
|
||||
|
||||
### Projektraum - projectroom
|
||||
- Ansteuerung: 12V DC Summer
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Doorable
|
||||
|
||||
### Projektkiste (10 Stück) - projectbox
|
||||
- Ansteuerung: 12V DC Lock (variable Position)
|
||||
- Berechtigung: Jeweils pro Kiste
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Lockable, Locatable
|
||||
|
||||
### E-Scooter - escooter
|
||||
- Ansteuerung: intern
|
||||
- Berechtigung: Keine
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Lockable, Locatable
|
||||
- Hint: Scooter
|
||||
|
||||
### Holzbearbeitung
|
||||
#### Absaugung - centralsuction
|
||||
- Ansteuerung: 230V - Schütz
|
||||
- Berechtigung: Admin
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
|
||||
#### Formatkreissäge - circularsaw
|
||||
- Ansteuerung: 230V - Schütz
|
||||
- Berechtigung: Holzbearbeitung
|
||||
- Abhängigkeit: Absaugung
|
||||
- Trait: Powerable
|
||||
|
||||
#### Bandsäge - bandsaw
|
||||
- Ansteuerung: 400V - Schütz
|
||||
- Berechtigung: Holzbearbeitung
|
||||
- Abhängigkeit: Absaugung
|
||||
- Trait: Powerable
|
||||
|
||||
#### Oberfräse - woodrouter
|
||||
- Ansteuerung: 230V - Zwischenstecker
|
||||
- Berechtigung: Felix Wagner
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
|
||||
### Metallbearbeitung
|
||||
#### Schweißgeräte - weldingmachine
|
||||
- Ansteuerung: 230V - Zwischenstecker(intern), 12V DC Lock (feste Position)
|
||||
- Berechtigung: Schweißen
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable, Lockable
|
||||
|
||||
#### CNC - cnc
|
||||
- Ansteuerung: 400V - Schütz
|
||||
- Berechtigung: CNC
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Checkable
|
||||
|
||||
### Rapid Prototyping
|
||||
#### 3D-Drucker FDM - 3dprinterfdm
|
||||
- Ansteuerung: 230V - Zwischenstecker
|
||||
- Berechtigung: 3D-Druck
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
|
||||
#### 3D-Drucker Farm (10 Stück) - 3dprinterfarm0 bis 3dprinterfarm9
|
||||
- Ansteuerung: 230V - Zwischenstecker
|
||||
- Berechtigung: 3D-Druck
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
|
||||
#### Lasercutter - lasercutter
|
||||
- Ansteuerung: 230V - Zwischenstecker
|
||||
- Berechtigung: Lasercut
|
||||
- Abhängigkeit: Keine
|
||||
- Trait: Powerable
|
||||
- Bemerkung: Keine Disclose Berechtigung und Alias
|
||||
|
||||
## Terminals
|
||||
curved25519 Zertifikate
|
||||
|
||||
### CNC - cnc
|
||||
- Resource: CNC
|
||||
|
||||
### 3D-Drucker Farm - farm
|
||||
- Resource: 3D-Drucker Farm
|
||||
|
||||
### Lasercutter - lasercutter
|
||||
- Resource: Lasercutter
|
||||
- Bemerkung: Alias QR Code
|
||||
|
||||
### Warenausgabe - goodsissue
|
||||
- Resource: Schraubendrehersatz, Ringmaulschlüsselsatz
|
6
source/concepts/terminals.de.md
Normal file
6
source/concepts/terminals.de.md
Normal file
@ -0,0 +1,6 @@
|
||||
# Terminals
|
||||
Terminals ermöglichen einen eingeschränkten Zugriff auf den Server in FabAccess. Diese Terminals können nur auf ihnen zugewiesene Maschinen zugreifen und haben die Fähigkeit, Maschinen für andere Nutzer auszuleihen.
|
||||
|
||||
Aufgrund ihrer beschränkten Zugriffsrechte eignen sich Terminals ideal für die Authentifizierung in FabFire. Durch die Verwendung von Terminals als Authentifizierungsmethode können Nutzer sicherstellen, dass nur autorisierte Benutzer auf die Ressourcen zugreifen und diese nutzen können.
|
||||
|
||||
Die Verwendung von Terminals für die Authentifizierung bietet eine zusätzliche Sicherheitsebene und trägt dazu bei, die Integrität des Systems zu gewährleisten. Darüber hinaus ermöglicht es eine effiziente Verwaltung der Ressourcennutzung, indem nur autorisierten Benutzern Zugriff gewährt wird.
|
@ -1,2 +0,0 @@
|
||||
# Terminals
|
||||
Eingeschränkte Nutzung von Resourcen bei Ausleih Terminals
|
@ -1,5 +1,5 @@
|
||||
# Checkable
|
||||
Trait welcher den Zustand von Resourcen abbildet, welche eine Überprüfung nach einer Nutzung benötigen.
|
||||
Der komplexere Trait "Checkable" ermöglicht die Abbildung von Ressourcen, die nach der Benutzung überprüft werden müssen. Bei einer Überprüfung durch einen berechtigten Nutzer kann die Ressource entweder für alle wieder freigegeben oder zurückgewiesen werden. Falls die Ressource zurückgewiesen wurde, kann der ursprüngliche Nutzer die Ressource weiterhin verwenden oder erneut zur Überprüfung einreichen, nachdem die Fehler behoben wurden.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.3`
|
||||
|
@ -1,5 +1,7 @@
|
||||
# Claimable
|
||||
Sonderfall um den Status des Claims anbieten zu können.
|
||||
Der Trait "Claimable" stellt einen Sonderfall dar, da er dazu dient, dass sich ein Nutzer über den Claim-Zustand einer Ressource informieren kann.
|
||||
|
||||
Nutzer können auf diesem Trait keine Aktionen ausführen, sondern lediglich den Zustand abfragen.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.0`
|
@ -1,5 +1,5 @@
|
||||
# Doorable
|
||||
Grundlegender Traits zum Ansteuern von Türen.
|
||||
Der Trait "Doorable" ermöglicht die Abbildung von Türen oder anderen Schließsystemen. Dabei besteht die Möglichkeit, kurzzeitige Öffnungen zu realisieren. Die genaue Zeitdauer, für die die Ressource geöffnet wird, wird dabei vom Server bestimmt.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.2`
|
||||
@ -12,5 +12,6 @@ stateDiagram
|
||||
OPEN --> CLOSED: lock
|
||||
CLOSED --> tempOPEN: unlocktemp
|
||||
tempOPEN --> OPEN: unlock
|
||||
tempOPEN --> CLOSED
|
||||
tempOPEN --> CLOSED: lock
|
||||
tempOPEN --> CLOSED: AUTO
|
||||
```
|
@ -1,5 +1,5 @@
|
||||
# Locatable
|
||||
Grundlegender Trait zum Auffinden von Resourcen
|
||||
Der Trait "Locatable" ermöglicht die Identifizierung von Ressourcen, wie beispielsweise Schließfächer oder 3D-Drucker in einer Druckerfarm. Dabei kann entweder eine kurzfristige Identifikation abgegeben werden oder die Identifizierung dauerhaft gesetzt werden.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.5`
|
||||
@ -11,5 +11,5 @@ stateDiagram
|
||||
IDLE --> ACTIVE: setActive
|
||||
IDLE --> ACTIVE: identify
|
||||
ACTIVE --> IDLE: setIdle
|
||||
ACTIVE --> IDLE
|
||||
ACTIVE --> IDLE: AUTO
|
||||
```
|
@ -1,16 +0,0 @@
|
||||
# Lockers
|
||||
Traits zum Abbilden von Schlössern
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.4`
|
||||
|
||||
## States
|
||||
```mermaid
|
||||
stateDiagram
|
||||
[*] --> locked
|
||||
locked --> unlocked: unengage
|
||||
unlocked --> locked
|
||||
unlocked --> open
|
||||
open --> unengaged
|
||||
unengaged --> locked: engage
|
||||
unengaged --> open
|
18
source/concepts/traits/lockers.md
Normal file
18
source/concepts/traits/lockers.md
Normal file
@ -0,0 +1,18 @@
|
||||
# Lockers
|
||||
"Lockers" ist einer der komplexeren Traits, mit dem Schlösser von Ressourcen genauer abgebildet werden können. Der Nutzer kann die Ressource nicht in jedem Zustand zurückgeben; erst wenn alles korrekt zurückgegeben wurde, kann die Ressource auch wieder gesperrt werden.
|
||||
|
||||
Die Zustandsänderungen zwischen den vom Nutzer verwendbaren Übergängen können von einem Initiator herbeigeführt werden.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.4`
|
||||
|
||||
## States
|
||||
```mermaid
|
||||
stateDiagram
|
||||
[*] --> locked
|
||||
locked --> unlocked: unengage
|
||||
unlocked --> locked: engage
|
||||
unlocked --> open: AUTO
|
||||
open --> unengaged: AUTO
|
||||
unengaged --> locked: engage
|
||||
unengaged --> open: AUTO
|
@ -1,5 +1,5 @@
|
||||
# Powerable
|
||||
Grundlegender Trait, welcher Resourcen einschalten kann.
|
||||
"Powerable" ist der grundlegendste Trait, den FabAccess unterstützt. Er dient dazu abzubilden, ob eine Ressource eingeschaltet bzw. mit Strom versorgt ist.
|
||||
|
||||
## OID
|
||||
`1.3.6.1.4.1.61783.612.1.1`
|
||||
|
@ -1,17 +1,17 @@
|
||||
Traits
|
||||
=================
|
||||
Traits bieten die Möglichkeit, den Zustand von Ressourcen zu ändern. Ressourcen können mehrere Traits besitzen und diese kombiniert nutzen.
|
||||
|
||||
Traits sind Implementierung speziell für eine Eigenschaft einer Resource.
|
||||
Mit einem Traits können Zustände auf einer Resource geändert werden.
|
||||
Mit Traits erhalten Nutzer Zugriff auf die Ressource, nachdem sie einen Claim erhalten haben. Dabei können Traits verwendet werden, um Ressourcen aus bestehenden Traits zusammenzusetzen oder spezifische Traits zu implementieren.
|
||||
|
||||
TODO
|
||||
=====
|
||||
Es kann mehrere Traits pro Resource gebenb
|
||||
Um eine optimale Anzeige der Traits für Nutzer in Clients zu ermöglichen, kann einer Ressource ein "Hint" hinzugefügt werden. Dieser ermöglicht es einem Client, eine verbesserte Ansicht der Ressource für Nutzer zu generieren.
|
||||
|
||||
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.
|
||||
|
||||
.. toctree::
|
||||
claimable.md
|
||||
powerable.md
|
||||
doorable.md
|
||||
lockable.md
|
||||
lockers.md
|
||||
checkable.md
|
||||
locatable.md
|
@ -3,19 +3,20 @@
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to FabAccess documentation!
|
||||
Welcome to FabAccess
|
||||
======================================
|
||||
|
||||
FabAccess is still in a state of development and has no stable Release.
|
||||
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.
|
||||
|
||||
So there is no stability and backward compatibility between the versions.
|
||||
Feel free to help us testing our software stack but not expect a full functional software.
|
||||
We will inform you about breaking changes over our Zulip. Please subscript to it to stay up to date, because the server and client can get incompatible.
|
||||
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.
|
||||
|
||||
In this documentation, we will provide a comprehensive overview of FabAccess' features and usage possibilities, as well as detailed instructions for integration and utilization. We invite you to become acquainted with our system and discover its diverse capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
concepts/concepts.rst
|
||||
installation/installation.rst
|
||||
configuration/configuration.rst
|
||||
usage/usage.rst
|
||||
|
Loading…
Reference in New Issue
Block a user