Skip to content

Changes

Page history
Proof Reading and minor corrections authored by Jona Florian Müller's avatar Jona Florian Müller
Show whitespace changes
Inline Side-by-side
Software-Konzept.md
View page @ 9f172c5c
# 1. Systemüberblick
>Diese Software soll es ermöglichen, viele kleine, zu Clustern zusammengefasste, Gewächshäuser zentral zu verwalten.
Um dies zu bewerkstelligen, sind in jedem Gewächshaus auf einem Arduino mehrere Sensoren verbaut, die über Bluetooth LE Messdaten an einen AccessPoint schicken. Die Gewächshäuser sind batteriebetrieben. Im Falle einer Messwert Unter- bzw- Überschreitung kann diese über eine RGB-LED kommuniziert werden.
Ein AccessPoint kann sich mit bis zu 255 Gewächshäuser (SensorStations) verbinden. Die zugeschickten Daten werden auf Messwert Unter- bzw- Überschreitungen geprüft und diese werden der entsprechenden SensorStation ggf. mitgeteilt. Die Daten werden in einstellbaren Intervallen an einen zentralen Webserver übertragen, über dessen Weboberfläche verschiedene Akteure auf die Daten zugreifen und diese verwalten können.
Des Weiteren ist an jedem Gewächshaus ein QR-Code angebracht, über den man auf eine Seite gelangt, auf der man Bilder der Pflanze ohne Anmeldung hochladen kann.
Diese Software soll es ermöglichen, viele kleine, zu Clustern zusammengefasste, Gewächshäuser zentral zu verwalten.
Um dies zu bewerkstelligen, sind in jedem Gewächshaus auf einem Arduino mehrere Sensoren verbaut, die über Bluetooth LE Messdaten an einen AccessPoint schicken. Die Gewächshäuser sind batteriebetrieben. Im Falle einer Messwert Unter- bzw. Überschreitung kann diese über eine RGB-LED kommuniziert werden.
Ein AccessPoint kann sich mit bis zu 255 Gewächshäuser (SensorStations) verbinden. Die zugeschickten Daten werden auf Messwert Unter- bzw. Überschreitungen geprüft und diese werden der entsprechenden SensorStation ggf. mitgeteilt. Die Daten werden in einstellbaren Intervallen an einen zentralen Webserver übertragen, über dessen Weboberfläche verschiedene Akteure auf die Daten zugreifen und diese verwalten können.
Des Weiteren ist an jedem Gewächshaus ein QR-Code angebracht.Über diesen Code gelangt auf eine Seite, auf der Bilder dieser Pflanze zu sehen sind und die Möglichkeit besteht Bilder hochzuladen.
# 2. Use Cases
......@@ -35,29 +35,28 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
### 2.3.1 Akteur: User
**Einloggen:**
**Einloggen**
- **Vorbedingung:** Das System läuft, man befindet sich auf der Startseite und der User soll von Admin schon erstellt worden sein.
- **Ablauf:** Benutzer trägt den Benutzernamen und das Passwort ein und wird durch das Drücken auf den Login-Button weitergeleitet.
- **Erfolg:**
- Admin: Alle Gewächshäuser werden angezeigt.
- Gärtner: Die Gewächshäuser, für die der angemeldete Gärtner zuständig ist, werden aufgezeigt.
- Benutzer: Können das Dashboard mit allen Gewächshäusern einsehen.
- **Kein Erfolg:** Der User enthält eine Fehlermeldung.
- **Involvierte Klassen:** User.
- **Involvierte Klassen:** User
### 2.3.2 Akteur: Gardener
**Pflanzendaten einsehen:**
**Pflanzendaten einsehen**
- **Vorbedingung** : Das System läuft, der Nutzer ist mit Berechtigungslevel Gardener angemeldet.
- **Ablauf** : Der Nutzer wählt die Sensorstation mit der Pflanze, deren Daten er einsehen will, aus dem Dashboard aus und gelangt auf eine neue Seite.
- **Erfolg** : Auf dieser Seite sind u.a. die (historischen) Daten für diese Pflanze in grafischer und Textform aufgelistet.
- **Kein Erfolg** : Der Nutzer erhält eine Fehlermeldung.
- I **nvolvierte Klassen** : Gardener
- **Involvierte Klassen** : Gardener
**Grenzwerte einstellen:**
**Grenzwerte einstellen**
- **Vorbedingung** : Das System läuft, der Nutzer ist mit Berechtigungslevel Gardener angemeldet.
- **Ablauf** : Der Nutzer wählt die Sensorstation mit der Pflanze, deren Grenzwerte er ändern will, aus dem Dashboard aus und gelangt auf eine neue Seite. Auf dieser Seite werden u.a. die aktuellen Grenzwerte angezeigt.
......@@ -65,7 +64,7 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
- **Kein Erfolg** : Der Nutzer erhält eine Fehlermeldung.
- **Involvierte Klassen** : Gardener
**Übertragungsintervalle einstellen:**
**Übertragungsintervalle einstellen**
- **Vorbedingung** : Das System läuft, der Nutzer ist mit Berechtigungslevel Gardener angemeldet.
- **Ablauf** : Der Nutzer wählt die Sensorstation, deren Übertragungsintervalle er ändern will, aus dem Dashboard aus und gelangt auf eine neue Seite. Auf dieser Seite wird u.a. das aktuelle Übertragungsintervall angezeigt.
......@@ -73,7 +72,7 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
- **Kein Erfolg** : Der Nutzer erhält eine Fehlermeldung.
- **Involvierte Klassen** : Gardener
**Bildgalerie verwalten:**
**Bildgalerie verwalten**
- **Vorbedingung:** Der User ist angemeldet und hat die Rolle „Gardener".
- **Ablauf:** Der Gärtner sieht alle seine Pflanzen aufgelistet. Er klickt auf einen Button einer bestimmten Pflanze, um die Bildergalerie zu öffnen. Der Gärtner hat nun die Möglichkeit, Bilder zu löschen, indem er auf einen Button am Bild klickt.
......@@ -83,7 +82,7 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
### 2.3.3 Akteur: Admin
**Manage Access Point:**
**Manage Access Point**
- **Vorbedingung** : Der User hat sich als Admin erfolgreich angemeldet.
- **Ablauf:**
......@@ -94,9 +93,9 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
- Existierender AccessPoint löschen
- **Erfolg** : Admin hat einen neuen AccessPoint angelegt, einen bereits vorhandenen bearbeitet oder einen gelöscht.
- **Kein Erfolg** : Fehlermeldung
- **Involvierte Klassen** : User mit Admin Berechtigungen, AccessPoint.
- **Involvierte Klassen** : User mit Admin Berechtigungen, AccessPoint
**Manage Sensor Station:**
**Manage Sensor Station**
- **Vorbedingung** : Der User hat sich als Admin erfolgreich angemeldet.
- **Ablauf:**
......@@ -108,9 +107,9 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
- Der Sensor Station einen Universally Unique Identifier (UUID) zuweisen?
- **Erfolg:** Der Sensor Station wird einen UUID zugewiesen, diese wird editiert oder gelöscht.
- **Kein Erfolg** : Fehlermeldung
- **Involvierte Klassen:** User mit Admin Berechtigungen, SensorStation.
- **Involvierte Klassen:** User mit Admin Berechtigungen, SensorStation
**Verbindung zum Webserver herstellen:**
**Verbindung zum Webserver herstellen**
- **Vorbedingung:** Webserver läuft, Admin eingeloggt, AccessPoint eingeschaltet
- **Ablauf:**
......@@ -121,132 +120,94 @@ Eine SensorStation beinhaltet eine Pflanze und mehrere Sensoren. Die Daten diese
- **Kein Erfolg:** Verbindung fehlgeschlagen. Erneuter Verbindungsversuch.
- **Involvierte Klassen:** Admin, AccessPoint
**Manage User:**
- **Vorbedingung** :
Das System läuft, man ist auf der Startseite und als Admin angemeldet. Es existiert mindestens ein User-Account auf dem System.
- **Ablauf** :
Der Admin klickt auf den Reiter „Manage User". Dann wählt er den zu löschenden User aus und drückt auf den dafür gekennzeichneten Button.
- **Erfolg** :
Der User wird aus der Datenbank gelöscht und wird nicht mehr auf der Seite „Manage Users" angezeigt. Der gelöschte User kann sich natürlich nicht mehr mit seinem Account anmelden.
**Manage User**
- **Vorbedingung** : Das System läuft, man ist auf der Startseite und als Admin angemeldet. Es existiert mindestens ein User-Account auf dem System.
- **Ablauf** : Der Admin klickt auf den Reiter „Manage User". Dann wählt er den zu löschenden User aus und drückt auf den dafür gekennzeichneten Button.
- **Erfolg** : Der User wird aus der Datenbank gelöscht und wird nicht mehr auf der Seite „Manage Users" angezeigt. Der gelöschte User kann sich natürlich nicht mehr mit seinem Account anmelden.
- **Kein Erfolg** : Der Admin erhält eine Fehlermeldung und der User bleibt weiterhin in der Datenbank gespeichert.
- **Involvierte Klassen** : Userx
**Status der AccessPoints/SensorStations einsehen:**
- **Vorbedingung:**
Das System funktioniert fehlerfrei, es gibt mindestens eine SensorStation bzw. AccessPoint, die bereits verbunden sind. Der aktuelle Nutzer ist als Admin angemeldet.
- **Ablauf** :
Der Admin klickt auf den Reiter „Devices" und bekommt dann eine Übersicht über den Status der Geräte.
- **Erfolg** :
Der Admin bekommt alle Geräte zu sehen und kann sich einen Überblick über den Status verschaffen.
- **Kein Erfolg:**
Die Seite „Devices" kann nicht aufgerufen werden, der Admin bekommt eine Fehlermeldung und muss es nach einer Zeit wieder probieren.
**Status der AccessPoints/SensorStations einsehen**
- **Involvierte Klassen:**
- **Vorbedingung**: Das System funktioniert fehlerfrei, es gibt mindestens eine SensorStation bzw. AccessPoint, die bereits verbunden sind. Der aktuelle Nutzer ist als Admin angemeldet.
- **Ablauf** : Der Admin klickt auf den Reiter „Devices" und bekommt dann eine Übersicht über den Status der Geräte.
- **Erfolg** : Der Admin bekommt alle Geräte zu sehen und kann sich einen Überblick über den Status verschaffen.
- **Kein Erfolg**: Die Seite „Devices" kann nicht aufgerufen werden, der Admin bekommt eine Fehlermeldung und muss es nach einer Zeit wieder probieren.
- **Involvierte Klassen**: Userx, AccessPoint, SensorStations
Userx, AccessPoint, SensorStations
**Logs einsehen**
**Logs einsehen:**
- **Vorbedingung** :
Das System funktioniert und der Akteur ist als Admin angemeldet.
- **Ablauf:**
Der Admin klickt auf den Reiter „Logs".
- **Erfolg:**
Der Admin hat Einsicht über alle AuditLog-Einträge.
- **Kein Erfolg:**
Die Seite „Logs" ist nicht verfügbar. Der Admin bekommt eine Fehlermeldung.
- **Involvierte Klassen:**
Userx, AuditLog
- **Vorbedingung** : Das System funktioniert und der Akteur ist als Admin angemeldet.
- **Ablauf**: Der Admin klickt auf den Reiter „Logs".
- **Erfolg**: Der Admin hat Einsicht über alle AuditLog-Einträge.
- **Kein Erfolg**: Die Seite „Logs" ist nicht verfügbar. Der Admin bekommt eine Fehlermeldung.
- **Involvierte Klassen**: Userx, AuditLog
### 2.3.4 Akteur: Visitor
**Bilder hochladen:**
**Bilder hochladen**
- **Vorbedingung:** Der Besucher befindet sich beim Gewächshaus und scannt den QR-Code
- **Ablauf:** Nach dem Scan befindet sich der Besucher auf der Seite, auf der sich eine Bildgalerie der gescannten Pflanze befindet. Der Besucher kann nun ein Bild hochladen in dem er auf den dazugehörigen Button klickt.
- **Vorbedingung**: Der Besucher befindet sich beim Gewächshaus und scannt den QR-Code
- **Ablauf**: Nach dem Scan befindet sich der Besucher auf der Seite, auf der sich eine Bildgalerie der gescannten Pflanze befindet. Der Besucher kann nun ein Bild hochladen in dem er auf den dazugehörigen Button klickt.
- **Erfolg:** Das neue Bild befindet sich in der Bildgalerie und jeder, der mit dieser Bildgalerie interagiert, kann das neue Bild betrachten.
- **Kein Erfolg:** -
- **Involvierte Klassen:** Userx, PlantPicture, SensorStation
- **Kein Erfolg**: -
- **Involvierte Klassen**: Userx, SensorStation
**Bilder anschauen:**
**Bilder anschauen**
- **Vorbedingung:** Der Besucher befindet sich beim Gewächshaus und scannt den QR-Code
- **Ablauf:** Nach dem Scan befindet sich der Besucher auf der Seite, auf der sich eine Bildgalerie der gescannten Pflanze befindet.
- **Erfolg:** Der Besucher kann sich nun durch die Bildgalerie forsten und die Bilder anschauen.
- **Kein Erfolg:** Eine Fehlermeldung wird angezeigt
- **Involvierte Klassen:** Userx, PlantPicture, SensorStation
- **Vorbedingung**: Der Besucher befindet sich beim Gewächshaus und scannt den QR-Code
- **Ablauf**: Nach dem Scan befindet sich der Besucher auf der Seite, auf der sich eine Bildgalerie der gescannten Pflanze befindet.
- **Erfolg**: Der Besucher kann sich nun durch die Bildgalerie forsten und die Bilder anschauen.
- **Kein Erfolg**: Eine Fehlermeldung wird angezeigt
- **Involvierte Klassen**: Userx, PlantPicture, SensorStation
2.3.5 Akteur: AccessPoint
### 2.3.5 Akteur: AccessPoint
**Verbindung zwischen SensorStation und AccessPoint herstellen:**
**Verbindung zwischen SensorStation und AccessPoint herstellen**
- **Vorbedingung:** Webserver läuft, Admin eingeloggt, AccessPoint mit Webserver verbunden
- **Ablauf:**
- **Vorbedingung**: Webserver läuft, Admin eingeloggt, AccessPoint mit Webserver verbunden
- **Ablauf**:
- Admin setzt AccessPoint via Webinterface in Kopplungsmodus.
- SensorStation mithilfe von Taster auf Mikrocontroller in Kopplungsmodus setzen. LED fängt an, blau zu blinken.
- SensorStation findet einen (oder mehrere) AccessPoints im Kopplungsmodus.
- SensorStation verbindet sich mit dem ersten AccessPoint. Kopplungsmodus von SensorStation wird beendet. LED hört auf zu blinken.
- Admin gibt SensorStation manuell im Webinterface frei.
- Admin beendet den Kopplungsmodus des AccessPoints via Webinterface.
- **Erfolg:** SensorStation mit AccessPoint verbunden, keines der beiden Geräte im Kopplungsmodus, Kommunikation möglich
- **Kein Erfolg:**
- **Erfolg**: SensorStation mit AccessPoint verbunden, keines der beiden Geräte im Kopplungsmodus, Kommunikation möglich
- **Kein Erfolg**:
- Kein AccessPoint in der Nähe. Nach fünf Minuten wird Kopplungsmodus automatisch beendet.
- Falls die ID der SensorStation bereits von einer anderen mit dem AccessPoint verbundenen Station verwendet wird, verbindet sich die SensorStation mit einem anderen AccessPoint. Falls keiner vorhanden wird der Kopplungsmodus beendet.
- **Involvierte Klassen:** Admin, AccessPoint, SensorStation
- **Involvierte Klassen**: Admin, AccessPoint, SensorStation
**Accesspoint sendet Messdaten an Webserver:**
- **Vorbedingung:** Accesspoint und die Sensorstation ist auf der Webseite registriert. Accesspoint hat die Daten erfolgreich erhalten und zwischengespeichert.
- **Ablauf:** Accesspoint sendet die Daten über eine REST-schnittstelle an den Webserver und wartet auf die Rückmeldung ob die Daten empfangen wurden. Der Webserver empfängt die Daten und sendet dem Accesspoint eine Bestätigung. Nach erhalt der Bestätigung löscht der Accesspoint die Messdaten.
- **Erfolg:** Der Webserver erhält die Daten und der Accesspoint erhält die Bestätigung.
- **Kein Erfolg:** Der Accesspoint behält die Daten im Speicher und sendet die Daten erneut.
- **Involvierte Klassen:** AccessPoint, SensorStation
- **Vorbedingung**: Accesspoint und die Sensorstation ist auf der Webseite registriert. Accesspoint hat die Daten erfolgreich erhalten und zwischengespeichert.
- **Ablauf**: Accesspoint sendet die Daten über eine REST-Schnittstelle an den Webserver und wartet auf die Rückmeldung ob die Daten empfangen wurden. Der Webserver empfängt die Daten und sendet dem Accesspoint eine Bestätigung. Nach erhalt der Bestätigung löscht der Accesspoint die Messdaten.
- **Erfolg**: Der Webserver erhält die Daten und der Accesspoint erhält die Bestätigung.
- **Kein Erfolg**: Der Accesspoint behält die Daten im Speicher und sendet die Daten erneut.
- **Involvierte Klassen**: AccessPoint, SensorStation
**Wertüberschreitung mitteilen:**
**Wertüberschreitung mitteilen**
- **Vorbedingung:** Webserver läuft, Accesspoint und SensorStation mit Server verbunden, Wertüberschreitung für konfiguriertes Intervall festgestellt
- **Ablauf:**
- **Vorbedingung**: Webserver läuft, Accesspoint und SensorStation mit Server verbunden, Wertüberschreitung für konfiguriertes Intervall festgestellt
- **Ablauf**:
- AccessPoint sendet die Intensität der Überschreitung und den betroffenen Wert an die SensorStation, bei der die Überschreitung festgestellt worden ist.
- Die SensorStation gibt anhand des Typs und anhand der Intensität einen Farbton in einem gewissen Blinkcode aus.
- AccessPoint sendet die Intensität, den betroffenen Wert und die betroffene SensorStation an den Webserver, welcher die Grenzwertüberschreitung in einer Nachricht anzeigt.
- **Erfolg:** LED der SensorStation blinkt und am Webserver wird eine Nachricht angezeigt
- **Kein Erfolg:** Die SensorStation erhält die Message des AccessPoint nicht und kann die Über-/Unterschreitung nicht ausgeben.
- **Involvierte Klassen:** Accesspoint, SensorStation
- **Erfolg**: LED der SensorStation blinkt und am Webserver wird eine Nachricht angezeigt
- **Kein Erfolg**: Die SensorStation erhält die Message des AccessPoint nicht und kann die Über-/Unterschreitung nicht ausgeben.
- **Involvierte Klassen**: Accesspoint, SensorStation
### 2.3.6 Akteur: SensorStation
**Werte an AccessPoint senden:**
**Werte an AccessPoint senden**
- **Vorbereitung:** Verbindung zwischen AccessPoint und Sensorstation sind aktiv und haben eine aktive Verbindung.
- **Ablauf:** Die Sensorstation sendet Daten über Bluetooth LE an den AcccessPoint
- **Erfolg:** Der AccessPoint erhält die Daten, kann sie verarbeiten und ggf. Werteüber-/unterschreitungen an die Sensorstation senden.
- **Kein Erfolg:** Die Verbindung zwischen AccessPoint und Sensorstation bricht ab und die Daten können nicht geschickt werden. Der AccessPoint meldet die Sensorstation als offline an den Webserver.
- **Involvierte Klassen:** Accesspoint, SensorStation
- **Vorbereitung**: Verbindung zwischen AccessPoint und Sensorstation sind aktiv und haben eine aktive Verbindung.
- **Ablauf**: Die Sensorstation sendet Daten über Bluetooth LE an den AcccessPoint
- **Erfolg**: Der AccessPoint erhält die Daten, kann sie verarbeiten und ggf. Werteüber-/unterschreitungen an die Sensorstation senden.
- **Kein Erfolg**: Die Verbindung zwischen AccessPoint und Sensorstation bricht ab und die Daten können nicht geschickt werden. Der AccessPoint meldet die Sensorstation als offline an den Webserver.
- **Involvierte Klassen**: Accesspoint, SensorStation
# 3. Klassendiagramm
......@@ -285,7 +246,7 @@ Userx ist die Basisklasse für alle vier möglichen Nutzer, diese werden über e
- Daten (bis zu einem Gewissen Punkt) buffern bis Verbindung wiederhergestellt wurde
- automatische Wiederherstellung der Verbindung
**T4: Kurzfristiger Ausfall des zentralen Backends.**
**T4: Kurzfristiger Ausfall des zentralen Backends**
- Benachrichtigung alle Benutzer über den den Ausfall
**T5: Ausfall der Sensorstation**
......@@ -384,7 +345,7 @@ Apache Maven ist für das Build-Management zuständig. Mit dieser Technologie we
- Java Webapp
**Andreas Kirchmair:**
- Github
- GitLab
- Arduino
- Bluetooth
......@@ -395,7 +356,7 @@ Apache Maven ist für das Build-Management zuständig. Mit dieser Technologie we
## 8.2 Milestones
- 16. 3 Einrichtung Git
- 16. 3 Einrichtung Git-Repository
- 16.3 Konzept fertig
- 23.3 Implementierung fachliche Komponenten (Models) zwischen Raspberry & Webserver
- 23.3 Steckplan fertig
......
......