Skip to content

waldbrandpraevention/backend

Repository files navigation

Waldbrandprävention Backend

pylint

Python FastAPI SQLite SQLite

Einleitung

Im Backend können Drohnen über eingerichtete API Endpunkte ihre Updates (Standort und Timestamp) und Events (Detektion von Feuer und/oder Rauch) schicken. Diese Daten werden anschließend in der Datenbank gespeichert. Beim Anfragen der Daten wird jederzeit sichergestellt, dass Nutzer*innen nur auf Daten innerhalb des Territoriums ihrer Organisation zugreifen können.

Datenbank

Für SQLite ungewöhnlich sind die Attribute vom Typ spatia geometry (Geometry), die das speichern von Geodaten, wie beispielsweise eine lat/lon Koordinate oder auch Polygone (z.B. die Grenze einer Gemeinde), ermöglichen. So können Zonenpolygone generiert, kombiniert und auf einer Karte dargestellt werden.

Nutzer und Orgadaten

In der Tabelle ’users’ können Nutzer angelegt werden. Dabei muss die id einer Organisation angegeben werden, denn so wird später sichergestellt, dass Nutzer nur auf die Daten im Territorium ihrer Organisation zugreifen können.

Über die Tabelle ’user_settings’ und ’settings’ können neue Einstellungen mit default_value definiert und für Nutzer gesetzt werden. Für jede Einstellung wird der Typ ihres Wertes festgelegt, mögliche Typen sind Integer, String oder JSON.

In ’zones’ werden die einzelnen Zonen definiert, welche den Territorien von Organisationen zugeordnet werden können. Wir haben uns dafür entschieden, die bestehenden Gemeindegrenzen als Zonen zu definieren und können sie aus einer geojson-Datei in die Datenbank einlesen. Diese Definition ist intuitiv und hilft der Feuerwehr bei der internen Kommunikation über potentielle Brandstellen und deren Standort.

Über ’territories’ und ’territory_zones’ können diese Zonen, Territorien zugeordnet werden, welche widerum fest zu einer Organisation gehören. So können größere Gebiete aus vielen Zonen angelegt und einer Organisation zugeordnet werden.

Drohnendaten

In der Tabelle ’drones’ können Drohnen angelegt werden. Dies passiert beispielsweise im Anmeldeprozess einer Drohne über den /drones/signup/ API Endpunkt. Hinzu kommen ’drone_data’ für Updates und ’drone_event’ für Events. Ein Update ist eine Kombination aus Standort, Timestamp und Daten zur verbleibenden Reichweite, während ein Event Daten zu einer potenziellen Brandstelle enthält.

API Docs

In der Demo können die API Endpunkte eingesehen und getestet werden. Für die meisten Endpunkte benötigt man einen Nutzer, hierfür auf den Authorize Knopf drücken und die folgenden Benutzerdaten eingeben:

kiwa.tech/api/docs

E-Mail: admin@kiwa.tech Passwort: adminkiwa

main.py und ihre Umgebungsvariablen

In der main.py werden die nötigen Tabellen erstellt, Demodaten eingelesen und die Simulation gestartet. Das am Ende die gewünschten Daten in die Tabellen geschrieben werden, müssen die folgenden Umgebungsvariablen entsprechend gesetzt werden (für backend only in demo.env, ansonsten im docker-compose.yml des Frontends).

Benennung der Datenbankdatei und ihr Pfad.

DB_PATH = 'data/testing.db'
DB_BACKUP_PATH = 'data/backuptest.db'

Erstellen von Demo Accounts. Im folgenden gilt: Ist eine Varbiable nicht gesetzt, so wird das entsprechende Element nicht erstellt. Will man nur einen User und eine Orga erstellen und dieser nur einen District zuordnen, so setzt man die Überflüssigen Variablen nicht.

ADMIN_MAIL = 'admin@kiwa.tech'
ADMIN_MAIL_TWO = 'ka@kiwa.tech'
ADMIN_PASSWORD = 'adminkiwa'
ADMIN_ORGANIZATION = 'KIWA'
ADMIN_ORGANIZATION_TWO = 'KIKA'

Für Demo Drohnenevents und -updates, können die folgenden Variablen gesetzt werden. (unabhängig von der Simulation, müssen nicht gesetzt werden).

DEMO_LONG = '12.68895149'
DEMO_LAT = '52.07454738'

Mithilfe der folgenden Variablen, werden die Zonendaten gesetzt. Unter (https://data.opendatasoft.com/explore/dataset/georef-germany-gemeinde%40public/table) können geojson Files erstellt werden, die anschließend in die Datenbank eingelesen werden. District entspricht "Kreis name" im geojson. Sofern gesetzt, werden DEMO_DISTRICT (und DEMO_DISTRICT_TWO) der ADMIN_ORGANIZATION zugeordnet. DEMO_DISTRICT_THREE wird ADMIN_ORGANIZATION_TWO zugeordnet, sofern beides gesetzt wurde.

GEOJSON_PATH = 'data/zone_data.geojson' 
DEMO_DISTRICT = 'Landkreis Potsdam-Mittelmark'
DEMO_DISTRICT_TWO = 'Landkreis Teltow-Fläming'
DEMO_DISTRICT_THREE = 'Landkreis Karlsruhe'
DOMAIN_API = 'http://127.0.0.1:8000'
EVENT_PATH = 'data/events' 
DRONE_FEEDBACK_PATH = 'data/feedback'

Simulationsspezifische Variablen. UPDATE_FREQUENCY bestimmt nach wieviel Sekunden das nächste Update geschickt werden soll.

RUN_SIMULATION = 'True'
SIMULATION_EVENT_CHANCE = '0.1'
SIMULATION_UPDATE_FREQUENCY = '10'
SIMULATION_DRONE_SPEED_MIN = '0.0001'
SIMULATION_DRONE_SPEED_MAX = '0.0002'

Installation


Um die vollständige Anwendung zu installieren, bitte die detaillierte Readme im waldbrandpraevention/frontend Repo beachten.


Development

Vorrausetzungen

Anleitung getestet auf WSL/Ubuntu.

[ 1 ]

git clone https://github.com/waldbrandpraevention/backend.git

[ 2 ]

cd waldbrandpraevention/backend

[ 3 ]

pip install -r requirements.txt

[ 4 ]

pip install python-dotenv

[ 5 ]

Spatialite installieren https://www.gaia-gis.it/fossil/libspatialite/home

Windows

Auf Windows ein WSL nutzen.

Ubuntu / Debian / WSL

sudo apt install libspatialite7 libspatialite-dev libsqlite3-mod-spatialite

MacOS (nicht getestet)

brew install sqlite3 libspatialite

Alpine

apk add libspatialite=5.0.1-r5

[ 6 ] TF2 Object detection installieren https://github.com/tensorflow/models/blob/master/research/object_detection/g3doc/tf2.md

[ 7 ]

Bei Linux/MacOS muss noch in der demo.env die \\ auf / geändert werden.

Eventuell vorhandene Datenbank löschen rm -f testing.db

[ 8 ]

uvicorn main:app --reload --env-file demo.env

Backend läuft auf http://localhost:8000
API Documentation auf http://localhost:8000/docs

Tools

Spatialite GUI Editor https://www.gaia-gis.it/fossil/spatialite_gui/index

QGIS GUI https://www.qgis.org/de/site/about/index.html