mirror of
https://gitlab.com/fabinfra/fabaccess/docs.git
synced 2024-11-05 07:13:24 +01:00
31 lines
1.8 KiB
ReStructuredText
31 lines
1.8 KiB
ReStructuredText
|
Wilkommen bei der FabAccess Dokumentation!
|
||
|
|
======================================
|
||
|
|
|
||
|
|
FabAccess ist ein Projekt zur Automatisierung von Abläufen in offenen Werkstätten und anderen Spaces (Makerspace, Hackerspace, etc.).
|
||
|
|
Wir möchten damit die Sicherheit im Umgang mit Maschinen erhöhen und den Betreibern die Verwaltung der Geräte vereinfachen.
|
||
|
|
|
||
|
|
Da wir FabAccess kontinuierlich weiterentwickeln kann es zwischen den Versionen zu Kompatibilitätsproblemen kommen.
|
||
|
|
|
||
|
|
FabAccess ist ein OpenSource Projekt und wir veröffentlichen unseren Code auf GitLab.
|
||
|
|
Sollten Probleme auftreten können Issues auf GitLab erstellt werden.
|
||
|
|
|
||
|
|
FabAccess besteht aus einem Server (BFFH geschrieben in Rust) und einem Client (Borepin geschrieben in C#).
|
||
|
|
Den Server muss jeder Space für sich aufsetzten und betreiben. Unseren Client stellen wir über die Platformspezifischen Stores bereit.
|
||
|
|
Es steht natürlich jedem frei seinen eigenen Client zu schreiben und über die API (geschrieben in Cap'n Proto) mit dem Server anzubinden.
|
||
|
|
|
||
|
|
Da wir als Projekt nicht für jeden Ablauf bei euch im Space einen Prozess einbauen können, sind die Funktionen von FabAccess erweiterbar und anpassbar.
|
||
|
|
Ihr könnt als eure eigenen Geräte (Actoren) über die Scipting API anschließen.
|
||
|
|
Wir stellen jedoch für den Einstieg passende Scripte zu den gängsten Actoren bereit.
|
||
|
|
|
||
|
|
Wir freuen uns über eure Unterstützung und Rückmeldungen, dazu könnt ihr unserer Community auf Matrix beitreten und euch mit anderen Betreibern austauschen.
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
In unsere Dokumentation findet Ihr Anleitungen zum Aufsetzten eurer Server, Beispielkonfigurationen, Empfehlungen zur Integration in eueren Space und Informationen zum Schreiben eurer eigener Actoren.
|
||
|
|
.. toctree::
|
||
|
|
:maxdepth: 1
|
||
|
|
:caption: Contents:
|
||
|
|
|
||
|
|
installation/installation.rst
|
||
|
|
configuration/configuration.rst
|
||
|
|
usage/usage.rst
|