aufräumen
This commit is contained in:
548
backend/docs/API_DOCS.md
Normal file
548
backend/docs/API_DOCS.md
Normal file
@@ -0,0 +1,548 @@
|
||||
# MYP Backend API-Dokumentation
|
||||
|
||||
Dieses Dokument beschreibt detailliert die API-Endpunkte des MYP (Manage Your Printer) Backend-Systems.
|
||||
|
||||
## Basis-URL
|
||||
|
||||
Die Basis-URL für alle API-Anfragen ist: `http://localhost:5000` (Entwicklungsumgebung) oder die URL, unter der die Anwendung gehostet wird.
|
||||
|
||||
## Authentifizierung
|
||||
|
||||
Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cookies/Sessions, die bei der Anmeldung erstellt werden. Die Session wird für 7 Tage gespeichert.
|
||||
|
||||
### Benutzerregistrierung
|
||||
|
||||
**Endpunkt:** `POST /auth/register`
|
||||
|
||||
**Beschreibung:** Registriert einen neuen Benutzer im System.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string", // Erforderlich
|
||||
"displayName": "string", // Optional (Standard: username)
|
||||
"email": "string" // Optional
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Registrierung erfolgreich!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzername bereits vergeben!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzeranmeldung
|
||||
|
||||
**Endpunkt:** `POST /auth/login`
|
||||
|
||||
**Beschreibung:** Meldet einen Benutzer an und erstellt eine Session.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string" // Erforderlich
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Anmeldung erfolgreich!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Ungültiger Benutzername oder Passwort!"
|
||||
}
|
||||
```
|
||||
|
||||
### Initialer Administrator
|
||||
|
||||
**Endpunkt:** `POST /api/create-initial-admin`
|
||||
|
||||
**Beschreibung:** Erstellt einen initialen Admin-Benutzer, falls noch keiner existiert.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string", // Erforderlich
|
||||
"password": "string", // Erforderlich
|
||||
"displayName": "string", // Optional (Standard: username)
|
||||
"email": "string" // Optional
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Administrator wurde erfolgreich erstellt!",
|
||||
"user": {
|
||||
"id": "string",
|
||||
"username": "string",
|
||||
"displayName": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Es existiert bereits ein Administrator!"
|
||||
}
|
||||
```
|
||||
|
||||
## Benutzer-Endpunkte
|
||||
|
||||
### Alle Benutzer abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/users`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Benutzer zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Benutzer abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Benutzers zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzer aktualisieren (Admin)
|
||||
|
||||
**Endpunkt:** `PUT /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Daten eines Benutzers.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"password": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"username": "string",
|
||||
"email": "string",
|
||||
"role": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzername bereits vergeben!"
|
||||
}
|
||||
```
|
||||
|
||||
### Benutzer löschen (Admin)
|
||||
|
||||
**Endpunkt:** `DELETE /api/users/{userId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Benutzer.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Benutzer gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
## Drucker-Endpunkte
|
||||
|
||||
### Alle Drucker abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/printers`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Drucker zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"status": "string",
|
||||
"description": "string"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Drucker hinzufügen (Admin)
|
||||
|
||||
**Endpunkt:** `POST /api/printers`
|
||||
|
||||
**Beschreibung:** Fügt einen neuen Drucker hinzu.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"status": "available",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Druckers zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"status": "string",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker aktualisieren (Admin)
|
||||
|
||||
**Endpunkt:** `PUT /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Daten eines Druckers.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"status": "string",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"name": "string",
|
||||
"location": "string",
|
||||
"type": "string",
|
||||
"status": "string",
|
||||
"description": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Drucker löschen (Admin)
|
||||
|
||||
**Endpunkt:** `DELETE /api/printers/{printerId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Drucker.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Drucker gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
## Druckauftrags-Endpunkte
|
||||
|
||||
### Alle Druckaufträge abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/jobs`
|
||||
|
||||
**Beschreibung:** Gibt eine Liste aller Druckaufträge zurück (für Admins) oder der eigenen Druckaufträge (für Benutzer).
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"title": "string",
|
||||
"start_time": "string (ISO 8601)",
|
||||
"end_time": "string (ISO 8601)",
|
||||
"duration": 60,
|
||||
"status": "string",
|
||||
"comments": "string",
|
||||
"user_id": 1,
|
||||
"printer_id": 1,
|
||||
"remaining_time": 30
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Druckauftrag erstellen
|
||||
|
||||
**Endpunkt:** `POST /api/jobs`
|
||||
|
||||
**Beschreibung:** Erstellt einen neuen Druckauftrag.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"title": "string",
|
||||
"duration": 60,
|
||||
"printer_id": 1,
|
||||
"comments": "string"
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"title": "string",
|
||||
"start_time": "string (ISO 8601)",
|
||||
"end_time": "string (ISO 8601)",
|
||||
"duration": 60,
|
||||
"status": "active",
|
||||
"comments": "string",
|
||||
"user_id": 1,
|
||||
"printer_id": 1,
|
||||
"remaining_time": 60
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Drucker ist nicht verfügbar!"
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/jobs/{jobId}`
|
||||
|
||||
**Beschreibung:** Gibt die Details eines bestimmten Druckauftrags zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"title": "string",
|
||||
"start_time": "string (ISO 8601)",
|
||||
"end_time": "string (ISO 8601)",
|
||||
"duration": 60,
|
||||
"status": "string",
|
||||
"comments": "string",
|
||||
"user_id": 1,
|
||||
"printer_id": 1,
|
||||
"remaining_time": 30
|
||||
}
|
||||
```
|
||||
|
||||
**Fehlerantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Nicht gefunden!"
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag aktualisieren
|
||||
|
||||
**Endpunkt:** `PUT /api/jobs/{jobId}`
|
||||
|
||||
**Beschreibung:** Aktualisiert die Daten eines Druckauftrags.
|
||||
|
||||
**Request-Body:**
|
||||
```json
|
||||
{
|
||||
"status": "string",
|
||||
"comments": "string",
|
||||
"duration": 30
|
||||
}
|
||||
```
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"title": "string",
|
||||
"start_time": "string (ISO 8601)",
|
||||
"end_time": "string (ISO 8601)",
|
||||
"duration": 90,
|
||||
"status": "string",
|
||||
"comments": "string",
|
||||
"user_id": 1,
|
||||
"printer_id": 1,
|
||||
"remaining_time": 60
|
||||
}
|
||||
```
|
||||
|
||||
### Druckauftrag löschen
|
||||
|
||||
**Endpunkt:** `DELETE /api/jobs/{jobId}`
|
||||
|
||||
**Beschreibung:** Löscht einen Druckauftrag.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "Druckauftrag gelöscht!"
|
||||
}
|
||||
```
|
||||
|
||||
### Verbleibende Zeit eines Druckauftrags abrufen
|
||||
|
||||
**Endpunkt:** `GET /api/job/{jobId}/remaining-time`
|
||||
|
||||
**Beschreibung:** Gibt die verbleibende Zeit eines aktiven Druckauftrags in Minuten zurück.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"remaining_minutes": 30
|
||||
}
|
||||
```
|
||||
|
||||
## Statistik-Endpunkte
|
||||
|
||||
### Systemstatistiken abrufen (Admin)
|
||||
|
||||
**Endpunkt:** `GET /api/stats`
|
||||
|
||||
**Beschreibung:** Gibt Statistiken zu Druckern, Aufträgen und Benutzern zurück.
|
||||
|
||||
**Erforderliche Rechte:** Admin
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"printers": {
|
||||
"total": 10,
|
||||
"available": 5,
|
||||
"utilization_rate": 0.5
|
||||
},
|
||||
"jobs": {
|
||||
"total": 100,
|
||||
"active": 5,
|
||||
"completed": 90,
|
||||
"avg_duration": 120
|
||||
},
|
||||
"users": {
|
||||
"total": 50
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Test-Endpunkt
|
||||
|
||||
### API-Test
|
||||
|
||||
**Endpunkt:** `GET /api/test`
|
||||
|
||||
**Beschreibung:** Testet, ob die API funktioniert.
|
||||
|
||||
**Erfolgsantwort:**
|
||||
```json
|
||||
{
|
||||
"message": "MYP Backend API funktioniert!"
|
||||
}
|
||||
```
|
||||
|
||||
## Fehlercodes
|
||||
|
||||
| Statuscode | Beschreibung |
|
||||
|------------|-----------------------------|
|
||||
| 200 | OK - Anfrage erfolgreich |
|
||||
| 201 | Created - Ressource erstellt |
|
||||
| 400 | Bad Request - Ungültige Anfrage |
|
||||
| 401 | Unauthorized - Authentifizierung erforderlich |
|
||||
| 403 | Forbidden - Unzureichende Rechte |
|
||||
| 404 | Not Found - Ressource nicht gefunden |
|
||||
| 500 | Internal Server Error - Serverfehler |
|
||||
213
backend/docs/PROJEKTDOKUMENTATION.md
Normal file
213
backend/docs/PROJEKTDOKUMENTATION.md
Normal file
@@ -0,0 +1,213 @@
|
||||
# MYP - Projektdokumentation für das IHK-Abschlussprojekt
|
||||
|
||||
## Projektübersicht
|
||||
|
||||
**Projektname:** MYP (Manage Your Printer)
|
||||
**Projekttyp:** IHK-Abschlussprojekt für Fachinformatiker für digitale Vernetzung
|
||||
**Zeitraum:** [Dein Projektzeitraum]
|
||||
**Team:** 2 Personen (Frontend- und Backend-Entwicklung)
|
||||
|
||||
## Projektziel
|
||||
|
||||
Das Ziel des Projektes ist die Entwicklung einer Reservierungs- und Steuerungsplattform für 3D-Drucker, die es Benutzern ermöglicht, Drucker zu reservieren und deren Stromversorgung automatisch über WLAN-Steckdosen (Tapo P115) zu steuern. Die Plattform soll eine einfache Verwaltung der Drucker und ihrer Auslastung bieten sowie den Stromverbrauch optimieren, indem Drucker nur während aktiver Reservierungen mit Strom versorgt werden.
|
||||
|
||||
## Aufgabenbeschreibung
|
||||
|
||||
Als Fachinformatiker für digitale Vernetzung besteht meine Aufgabe in der Entwicklung des Backend-Systems, das folgende Funktionen bereitstellt:
|
||||
|
||||
1. **API-Backend für das Frontend**: Entwicklung einer RESTful API, die mit dem Frontend kommuniziert und alle notwendigen Daten bereitstellt.
|
||||
|
||||
2. **Authentifizierungssystem**: Integration einer OAuth-Authentifizierung über GitHub, um Benutzer zu identifizieren und Zugriffskontrolle zu gewährleisten.
|
||||
|
||||
3. **Datenbankverwaltung**: Erstellung und Verwaltung der Datenbankmodelle für Benutzer, Drucker und Reservierungen.
|
||||
|
||||
4. **Steckdosensteuerung**: Implementierung einer Schnittstelle zu Tapo P115 WLAN-Steckdosen, um die Stromversorgung der Drucker basierend auf Reservierungen zu steuern.
|
||||
|
||||
5. **Automatisierung**: Entwicklung von Mechanismen zur automatischen Überwachung von Reservierungen und Steuerung der Steckdosen.
|
||||
|
||||
6. **Sicherheit**: Implementierung von Sicherheitsmaßnahmen zum Schutz der Anwendung und der Daten.
|
||||
|
||||
7. **Dokumentation**: Erstellung einer umfassenden Dokumentation für Entwicklung, Installation und Nutzung des Systems.
|
||||
|
||||
## Technische Umsetzung
|
||||
|
||||
### Backend (Mein Verantwortungsbereich)
|
||||
|
||||
#### Verwendete Technologien
|
||||
|
||||
- **Programmiersprache**: Python 3.11
|
||||
- **Web-Framework**: Flask 2.3.3
|
||||
- **Datenbank-ORM**: SQLAlchemy 3.1.1
|
||||
- **Datenbank**: SQLite (für Entwicklung), erweiterbar auf PostgreSQL für Produktion
|
||||
- **Authentifizierung**: Authlib für GitHub OAuth
|
||||
- **Steckdosen-Steuerung**: Tapo Python Library
|
||||
- **Container-Technologie**: Docker und Docker Compose
|
||||
|
||||
#### Architektur
|
||||
|
||||
Die Backend-Anwendung folgt einer klassischen dreischichtigen Architektur:
|
||||
|
||||
1. **Datenmodell-Schicht**: SQLAlchemy ORM-Modelle für Benutzer, Sessions, Drucker und Druckaufträge
|
||||
2. **Business-Logic-Schicht**: Implementierung der Geschäftslogik für Reservierungsverwaltung und Steckdosensteuerung
|
||||
3. **API-Schicht**: RESTful API-Endpunkte, die vom Frontend konsumiert werden
|
||||
|
||||
Zusätzlich wurden folgende Features implementiert:
|
||||
|
||||
- **OAuth-Authentifizierung**: Implementierung einer sicheren Authentifizierung über GitHub
|
||||
- **Session-Management**: Server-seitige Session-Verwaltung für Benutzerauthentifizierung
|
||||
- **Steckdosensteuerung**: Asynchrone Steuerung der Tapo P115 WLAN-Steckdosen
|
||||
- **CLI-Befehle**: Flask CLI-Befehle für automatisierte Aufgaben wie die Überprüfung abgelaufener Reservierungen
|
||||
|
||||
#### Datenmodell
|
||||
|
||||
Das Datenmodell besteht aus vier Hauptentitäten:
|
||||
|
||||
1. **User**: Benutzer mit GitHub-Authentifizierung und Rollenverwaltung
|
||||
2. **Session**: Sitzungsdaten für die Authentifizierung
|
||||
3. **Printer**: Drucker mit Status und IP-Adresse der zugehörigen Steckdose
|
||||
4. **PrintJob**: Reservierungen mit Start- und Endzeit, Dauer und Status
|
||||
|
||||
#### API-Endpunkte
|
||||
|
||||
Die API wurde speziell entwickelt, um nahtlos mit dem bestehenden Frontend zusammenzuarbeiten. Sie bietet Endpunkte für:
|
||||
|
||||
- Authentifizierung und Benutzerverwaltung
|
||||
- Druckerverwaltung
|
||||
- Reservierungsverwaltung (Erstellen, Abbrechen, Verlängern)
|
||||
- Statusinformationen wie verbleibende Zeit
|
||||
|
||||
#### Steckdosensteuerung
|
||||
|
||||
Die Steuerung der Tapo P115 WLAN-Steckdosen erfolgt über die Tapo Python Library. Das System:
|
||||
|
||||
- Schaltet Steckdosen bei Erstellung einer Reservierung ein
|
||||
- Schaltet Steckdosen bei Abbruch oder Beendigung einer Reservierung aus
|
||||
- Überprüft regelmäßig abgelaufene Reservierungen und schaltet die entsprechenden Steckdosen aus
|
||||
|
||||
#### Automatisierung
|
||||
|
||||
Das System implementiert mehrere Automatisierungsmechanismen:
|
||||
|
||||
- **Automatische Steckdosensteuerung**: Ein- und Ausschalten der Steckdosen basierend auf Reservierungsstatus
|
||||
- **Job-Überprüfung**: CLI-Befehl `flask check-jobs` zur regelmäßigen Überprüfung abgelaufener Reservierungen
|
||||
- **Logging**: Automatische Protokollierung aller Aktionen zur Fehlerdiagnose
|
||||
|
||||
### Frontend (Verantwortungsbereich des Teampartners)
|
||||
|
||||
Das Frontend wurde von meinem Teampartner entwickelt und besteht aus:
|
||||
|
||||
- Next.js-Anwendung mit React-Komponenten
|
||||
- Tailwind CSS für das Styling
|
||||
- Serverless Functions für API-Integrationen
|
||||
- Responsive Design für Desktop- und Mobile-Nutzung
|
||||
|
||||
## Projektergebnisse
|
||||
|
||||
Das Projekt hat erfolgreich eine funktionsfähige Reservierungs- und Steuerungsplattform für 3D-Drucker geschaffen, die es Benutzern ermöglicht:
|
||||
|
||||
1. Sich über GitHub zu authentifizieren
|
||||
2. Verfügbare Drucker zu sehen und zu reservieren
|
||||
3. Ihre Reservierungen zu verwalten (verlängern, abbrechen, kommentieren)
|
||||
4. Als Administrator Drucker und Benutzer zu verwalten
|
||||
|
||||
Technische Errungenschaften:
|
||||
|
||||
1. Nahtlose Integration mit dem Frontend
|
||||
2. Erfolgreiche Implementierung der Steckdosensteuerung
|
||||
3. Sichere Authentifizierung über GitHub OAuth
|
||||
4. Optimierte Stromnutzung durch automatische Steckdosensteuerung
|
||||
|
||||
## Herausforderungen und Lösungen
|
||||
|
||||
### Herausforderung 1: GitHub OAuth-Integration
|
||||
|
||||
Die Integration der GitHub-Authentifizierung, insbesondere mit GitHub Enterprise, erforderte eine sorgfältige Konfiguration der OAuth-Einstellungen und URL-Anpassungen.
|
||||
|
||||
**Lösung:** Implementierung mit Authlib und anpassbaren Konfigurationsoptionen für verschiedene GitHub-Instanzen.
|
||||
|
||||
### Herausforderung 2: Tapo P115 Steuerung
|
||||
|
||||
Die Kommunikation mit den Tapo P115 WLAN-Steckdosen erforderte eine zuverlässige und asynchrone Implementierung.
|
||||
|
||||
**Lösung:** Verwendung der Tapo Python Library mit asynchronem Handling und robusten Fehlerbehandlungsmechanismen.
|
||||
|
||||
### Herausforderung 3: Kompatibilität mit bestehendem Frontend
|
||||
|
||||
Das Backend musste mit dem bereits entwickelten Frontend kompatibel sein, was eine genaue Anpassung der API-Endpunkte und Datenstrukturen erforderte.
|
||||
|
||||
**Lösung:** Sorgfältige Analyse des Frontend-Codes, um die erwarteten API-Strukturen zu verstehen und das Backend entsprechend zu implementieren.
|
||||
|
||||
### Herausforderung 4: Automatische Steckdosensteuerung
|
||||
|
||||
Die zuverlässige Steuerung der Steckdosen bei abgelaufenen Reservierungen war eine Herausforderung.
|
||||
|
||||
**Lösung:** Implementierung eines CLI-Befehls, der regelmäßig durch Cron-Jobs ausgeführt werden kann, um abgelaufene Reservierungen zu überprüfen.
|
||||
|
||||
## Fachliche Reflexion
|
||||
|
||||
Das Projekt erforderte ein breites Spektrum an Fähigkeiten aus dem Bereich der digitalen Vernetzung:
|
||||
|
||||
1. **Netzwerkkommunikation**: Implementierung der Kommunikation zwischen Backend, Frontend und WLAN-Steckdosen über verschiedene Protokolle.
|
||||
|
||||
2. **Systemintegration**: Integration verschiedener Systeme (GitHub OAuth, Datenbank, Tapo-Steckdosen) zu einer kohärenten Anwendung.
|
||||
|
||||
3. **API-Design**: Entwicklung einer RESTful API, die den Anforderungen des Frontends entspricht und zukunftssicher ist.
|
||||
|
||||
4. **Datenbankentwurf**: Erstellung eines optimierten Datenbankschemas für die Anwendung.
|
||||
|
||||
5. **Sicherheitskonzepte**: Implementierung von Sicherheitsmaßnahmen wie OAuth, Session-Management und Zugriffskontrollen.
|
||||
|
||||
6. **Automatisierung**: Entwicklung von Automatisierungsprozessen für die Steckdosensteuerung und Job-Überwachung.
|
||||
|
||||
Diese Aspekte entsprechen direkt den Kernkompetenzen des Berufsbildes "Fachinformatiker für digitale Vernetzung" und zeigen die praktische Anwendung dieser Fähigkeiten in einem realen Projekt.
|
||||
|
||||
## Ausblick und Weiterentwicklung
|
||||
|
||||
Das System bietet verschiedene Möglichkeiten zur Weiterentwicklung:
|
||||
|
||||
1. **Erweiterung der Steckdosenunterstützung**: Integration weiterer Smart-Home-Geräte neben Tapo P115.
|
||||
|
||||
2. **Benachrichtigungssystem**: Implementierung von E-Mail- oder Push-Benachrichtigungen für Reservierungserinnerungen.
|
||||
|
||||
3. **Erweiterte Statistiken**: Detailliertere Nutzungsstatistiken und Visualisierungen für Administratoren.
|
||||
|
||||
4. **Mobile App**: Entwicklung einer nativen mobilen App für iOS und Android.
|
||||
|
||||
5. **Verbesserte Automatisierung**: Integration mit weiteren Systemen wie 3D-Drucker-APIs für direktes Monitoring des Druckstatus.
|
||||
|
||||
## Fazit
|
||||
|
||||
Das MYP-Projekt zeigt erfolgreich, wie moderne Webtechnologien und IoT-Geräte kombiniert werden können, um eine praktische Lösung für die Verwaltung von 3D-Druckern zu schaffen.
|
||||
|
||||
Als angehender Fachinformatiker für digitale Vernetzung konnte ich meine Fähigkeiten in den Bereichen Programmierung, Systemintegration, Netzwerkkommunikation und Automatisierung anwenden und erweitern.
|
||||
|
||||
Die Zusammenarbeit im Team mit klarer Aufgabenteilung (Frontend/Backend) hat zu einem erfolgreichen Projektergebnis geführt, das die gestellten Anforderungen erfüllt und einen praktischen Nutzen bietet.
|
||||
|
||||
---
|
||||
|
||||
## Anhang
|
||||
|
||||
### Installation und Einrichtung
|
||||
|
||||
Detaillierte Anweisungen zur Installation und Einrichtung des Backend-Systems finden sich in der README.md-Datei.
|
||||
|
||||
### Wichtige Konfigurationsparameter
|
||||
|
||||
Die folgenden Umgebungsvariablen müssen konfiguriert werden:
|
||||
|
||||
- `SECRET_KEY`: Geheimer Schlüssel für die Session-Verschlüsselung
|
||||
- `DATABASE_URL`: URL zur Datenbank
|
||||
- `OAUTH_CLIENT_ID`: GitHub OAuth Client ID
|
||||
- `OAUTH_CLIENT_SECRET`: GitHub OAuth Client Secret
|
||||
- `GITHUB_API_BASE_URL`, `GITHUB_AUTHORIZE_URL`, `GITHUB_TOKEN_URL`: URLs für GitHub OAuth
|
||||
- `TAPO_USERNAME`: Benutzername für die Tapo-Steckdosen
|
||||
- `TAPO_PASSWORD`: Passwort für die Tapo-Steckdosen
|
||||
- `TAPO_DEVICES`: JSON-Objekt mit der Zuordnung von Drucker-IDs zu IP-Adressen
|
||||
|
||||
### Cron-Job-Einrichtung
|
||||
|
||||
Für die automatische Überprüfung abgelaufener Jobs kann folgender Cron-Job eingerichtet werden:
|
||||
|
||||
```
|
||||
*/5 * * * * cd /pfad/zum/projekt && /pfad/zur/venv/bin/flask check-jobs >> /pfad/zum/projekt/logs/cron.log 2>&1
|
||||
```
|
||||
186
backend/docs/README.md
Normal file
186
backend/docs/README.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# MYP Backend-Steuerungsplattform
|
||||
|
||||
Dies ist das Backend für das MYP (Manage Your Printer) Projekt, ein IHK-Abschlussprojekt für Fachinformatiker für digitale Vernetzung. Die Plattform ist mit Python und Flask implementiert und stellt eine RESTful API zur Verfügung, die es ermöglicht, 3D-Drucker zu verwalten, zu reservieren und über WLAN-Steckdosen (Tapo P115) zu steuern.
|
||||
|
||||
## Funktionen
|
||||
|
||||
- Lokales Authentifizierungssystem (Offline-fähig)
|
||||
- Rollen-basierte Zugriffskontrolle (Admin/User/Guest)
|
||||
- Druckerverwaltung (Hinzufügen, Bearbeiten, Löschen)
|
||||
- Reservierungsverwaltung (Erstellen, Abbrechen, Verlängern)
|
||||
- Fernsteuerung von WLAN-Steckdosen (Tapo P115)
|
||||
- Statistikerfassung und -anzeige
|
||||
- RESTful API für die Kommunikation mit dem Frontend
|
||||
|
||||
## Technologie-Stack
|
||||
|
||||
- **Python**: Programmiersprache
|
||||
- **Flask**: Web-Framework
|
||||
- **SQLAlchemy**: ORM für Datenbankinteraktionen
|
||||
- **SQLite**: Datenbank (kann für Produktion durch PostgreSQL ersetzt werden)
|
||||
- **Tapo Python Library**: Steuerung der Tapo P115 WLAN-Steckdosen
|
||||
- **Gunicorn**: WSGI HTTP Server für die Produktionsumgebung
|
||||
- **Docker**: Containerisierung der Anwendung
|
||||
|
||||
## Projekt-Struktur
|
||||
|
||||
- `app.py`: Hauptanwendungsdatei mit allen Routen und Modellen
|
||||
- `requirements.txt`: Liste aller Python-Abhängigkeiten
|
||||
- `Dockerfile`: Docker-Konfiguration
|
||||
- `docker-compose.yml`: Docker Compose Konfiguration für einfaches Deployment
|
||||
- `.env.example`: Beispiel für die Umgebungsvariablen
|
||||
- `logs/`: Logdateien (automatisch erstellt)
|
||||
- `instance/`: SQLite-Datenbank (automatisch erstellt)
|
||||
|
||||
## Installation und Ausführung
|
||||
|
||||
### Lokal (Entwicklung)
|
||||
|
||||
1. Python 3.8 oder höher installieren
|
||||
2. Repository klonen
|
||||
3. Ins Projektverzeichnis wechseln
|
||||
4. Virtuelle Umgebung erstellen (optional, aber empfohlen)
|
||||
```
|
||||
python -m venv venv
|
||||
source venv/bin/activate # Unter Windows: venv\Scripts\activate
|
||||
```
|
||||
5. Abhängigkeiten installieren
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
6. `.env.example` nach `.env` kopieren und anpassen
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
7. Anwendung starten
|
||||
```
|
||||
python app.py
|
||||
```
|
||||
|
||||
Die Anwendung ist dann unter http://localhost:5000 erreichbar.
|
||||
|
||||
### Mit Docker
|
||||
|
||||
1. Docker und Docker Compose installieren
|
||||
2. Ins Projektverzeichnis wechseln
|
||||
3. `.env.example` nach `.env` kopieren und anpassen
|
||||
```
|
||||
cp .env.example .env
|
||||
```
|
||||
4. Anwendung starten
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
Die Anwendung ist dann unter http://localhost:5000 erreichbar.
|
||||
|
||||
## API-Endpunkte
|
||||
|
||||
### Authentifizierung
|
||||
|
||||
- `POST /auth/register`: Neuen Benutzer registrieren
|
||||
- `POST /auth/login`: Benutzer anmelden
|
||||
- `POST /auth/logout`: Abmelden und Session beenden
|
||||
- `POST /api/create-initial-admin`: Initialen Administrator erstellen
|
||||
- `GET /api/me`: Aktuelle Benutzerinformationen abrufen
|
||||
|
||||
### Benutzer
|
||||
|
||||
- `GET /api/users`: Liste aller Benutzer (Admin)
|
||||
- `GET /api/users/<id>`: Details zu einem Benutzer (Admin)
|
||||
- `PUT /api/users/<id>`: Benutzer aktualisieren (Admin)
|
||||
- `DELETE /api/users/<id>`: Benutzer löschen (Admin)
|
||||
|
||||
### Drucker
|
||||
|
||||
- `GET /api/printers`: Liste aller Drucker
|
||||
- `POST /api/printers`: Drucker hinzufügen (Admin)
|
||||
- `GET /api/printers/<id>`: Details zu einem Drucker
|
||||
- `PUT /api/printers/<id>`: Drucker aktualisieren (Admin)
|
||||
- `DELETE /api/printers/<id>`: Drucker löschen (Admin)
|
||||
|
||||
### Druckaufträge
|
||||
|
||||
- `GET /api/jobs`: Liste aller Druckaufträge (Admin) oder eigener Druckaufträge (Benutzer)
|
||||
- `POST /api/jobs`: Druckauftrag erstellen
|
||||
- `GET /api/jobs/<id>`: Details zu einem Druckauftrag
|
||||
- `POST /api/jobs/<id>/abort`: Druckauftrag abbrechen
|
||||
- `POST /api/jobs/<id>/finish`: Druckauftrag vorzeitig beenden
|
||||
- `POST /api/jobs/<id>/extend`: Druckauftrag verlängern
|
||||
- `PUT /api/jobs/<id>/comments`: Kommentare aktualisieren
|
||||
- `GET /api/job/<id>/remaining-time`: Verbleibende Zeit für einen aktiven Druckauftrag
|
||||
|
||||
### Statistiken
|
||||
|
||||
- `GET /api/stats`: Statistiken zu Druckern, Aufträgen und Benutzern (Admin)
|
||||
|
||||
## Datenmodell
|
||||
|
||||
### Benutzer (User)
|
||||
- id (String UUID, Primary Key)
|
||||
- username (String, Unique)
|
||||
- password_hash (String)
|
||||
- display_name (String)
|
||||
- email (String, Unique)
|
||||
- role (String, 'admin', 'user' oder 'guest')
|
||||
|
||||
### Session
|
||||
- id (String UUID, Primary Key)
|
||||
- user_id (String UUID, Foreign Key zu User)
|
||||
- expires_at (DateTime)
|
||||
|
||||
### Drucker (Printer)
|
||||
- id (String UUID, Primary Key)
|
||||
- name (String)
|
||||
- description (Text)
|
||||
- status (Integer, 0=available, 1=busy, 2=maintenance)
|
||||
- ip_address (String, IP-Adresse der Tapo-Steckdose)
|
||||
|
||||
### Druckauftrag (PrintJob)
|
||||
- id (String UUID, Primary Key)
|
||||
- printer_id (String UUID, Foreign Key zu Printer)
|
||||
- user_id (String UUID, Foreign Key zu User)
|
||||
- start_at (DateTime)
|
||||
- duration_in_minutes (Integer)
|
||||
- comments (Text)
|
||||
- aborted (Boolean)
|
||||
- abort_reason (Text)
|
||||
|
||||
## Steckdosensteuerung
|
||||
|
||||
Die Anwendung steuert Tapo P115 WLAN-Steckdosen, um die Drucker basierend auf Reservierungen ein- und auszuschalten:
|
||||
|
||||
- Bei Erstellung eines Druckauftrags wird die Steckdose des zugehörigen Druckers automatisch eingeschaltet
|
||||
- Bei Abbruch oder vorzeitiger Beendigung eines Druckauftrags wird die Steckdose ausgeschaltet
|
||||
- Nach Ablauf der Reservierungszeit wird die Steckdose automatisch ausgeschaltet
|
||||
- Ein CLI-Befehl `flask check-jobs` überprüft regelmäßig abgelaufene Jobs und schaltet Steckdosen aus
|
||||
|
||||
## Sicherheit
|
||||
|
||||
- Die Anwendung verwendet ein lokales Authentifizierungssystem mit Passwort-Hashing
|
||||
- Sitzungsdaten werden in Server-Side-Sessions gespeichert
|
||||
- Zugriffskontrollen sind implementiert, um sicherzustellen, dass Benutzer nur auf ihre eigenen Daten zugreifen können
|
||||
- Admin-Benutzer haben Zugriff auf alle Daten und können Systemkonfigurationen ändern
|
||||
- Der erste registrierte Benutzer wird automatisch zum Administrator
|
||||
|
||||
## Logging
|
||||
|
||||
Die Anwendung protokolliert Aktivitäten in rotierenden Logdateien in einem `logs` Verzeichnis. Dies hilft bei der Fehlersuche und Überwachung der Anwendung im Betrieb.
|
||||
|
||||
## Umgebungsvariablen
|
||||
|
||||
Die folgenden Umgebungsvariablen müssen konfiguriert werden:
|
||||
|
||||
- `SECRET_KEY`: Geheimer Schlüssel für die Session-Verschlüsselung
|
||||
- `DATABASE_URL`: URL zur Datenbank (Standard: SQLite-Datenbank im Instance-Verzeichnis)
|
||||
- `TAPO_USERNAME`: Benutzername für die Tapo-Steckdosen
|
||||
- `TAPO_PASSWORD`: Passwort für die Tapo-Steckdosen
|
||||
- `TAPO_DEVICES`: JSON-Objekt mit der Zuordnung von Drucker-IDs zu IP-Adressen der Steckdosen
|
||||
|
||||
## Automatisierung
|
||||
|
||||
Die Anwendung beinhaltet einen CLI-Befehl `flask check-jobs`, der regelmäßig ausgeführt werden sollte (z.B. als Cron-Job), um abgelaufene Druckaufträge zu überprüfen und die zugehörigen Steckdosen auszuschalten.
|
||||
|
||||
## Kompatibilität mit dem Frontend
|
||||
|
||||
Das Backend wurde speziell für die Kompatibilität mit dem bestehenden Frontend entwickelt, welches in `/packages/reservation-platform` zu finden ist. Die API-Endpunkte und Datenstrukturen sind so gestaltet, dass sie nahtlos mit dem Frontend zusammenarbeiten.
|
||||
Reference in New Issue
Block a user