1. Installieren von python und pip
2. Empfohlen: Virtuelle Enviroment erstellen und aktivieren
3. Projekt auf Computer clonen: git clone git@github.com:s1n7/Energy2.0.git
4. Alle packages installieren: pip install -r requirements.txt
5. Datenbank erstellen mit python manage.py makemigrations und dann python manage.py migrate
6. Jetzt können die bereits simulierten Daten, geladen werden: python manage.py loaddata simulateddata.json
   • Jetzt gibt es einen Amin (username: admin, password: 1234)
   • Einfache User haben alle das Password (abcd1234xyz)
7. Sie können auch einen neuen admin anlegen mit: python manage.py createsuperuser
8. Server starten: python manage.py runserver

Hier wird beipielhaft gezeigt, wie Sie die mitgelieferten Daten (siehe loaddata in Installationsanleitung) bis zum aktuellen Zeitpunkt weiter simulieren. Falls Sie einen neu angelegten Producer simulieren wollen, müssen Sie ggf. beim initialisiern der KLasse einen Zeitpunkt angeben. Schauen Sie dafür einfach in die Klasse rein.

1. Starten Sie eine Python Konsole im Terminal: python
2. Importieren die alles aus simulator.py: from input.simulator import *
3. Initialisieren Sie einen Simulator: sim = EnergySimuluator(1)
4. Folgen Sie der Aufforderungen im Terminal, um die Durschnittsproduktionen und Verbräuche festzulegen.
5. Starten Sie die Simulation bis zum aktuellen Zeitpunkt: sim.simulate_until()

Die Endpunkte der einzelnen Entitäten, welche oben beschrieben sind, werden hier nicht dokumentiert. Django REST erstellt automatisch eine Grafisches Interface zur REST-API und ist damit selbst beschreibend. Hierfür muss einfach der Server gestartet werden, wie oben beschrieben.

Folgende Endpunkte sind nicht im Django REST GUI enthalten und werden im folgendem dokumentiert.

• /login
  • Authorization
• /logout
• /input
• /output
• /setup

POST /login/

{
    status: 200,
        data
:
    {
        token: string,
            is_admin
    :
        bool,
            consumer_id
    :
        integer | None,
    }
}

Für Anfragen die Authorisierung benötigen, muss folgender Header gesetzt werden

Authorization: Token ...apitoken...

POST /logout/

Authentifizierung erforderlich

{
  "status": "200",
  "data": {
    "message": "{username} logged out successfully"
  }
}

POST /input/

Das folgende Format ist in datahub definiert. Die verwendeten Parameter sind im folgendem aufgezählt.

  {
  "device_id": "integer",
  "source_time": "datetime",
  "parsed": {
    "Bezug_Gesamt_kWh": "float",
    "Lieferung_Gesamt_kWh": "float",
    "Leistung_Summe_W": "float"
  }
}

{
  "status": "200"
}

GET /output/

With producer_id and consumer_id not set:

{
  "producers_total_production": "Decimal",
  "producers_total_used": "Decimal",
  "producers_total_revenue": "Decimal",
  "producers_total_saved": "Decimal",
  "producers_total_consumption": "Decimal",
  "producers": {
    "{producer_name}": {
      "total_production": "Decimal",
      "total_used": "Decimal",
      "consumers_total_revenue": "Decimal",
      "consumers_total_saved": "Decimal",
      "total_consumption": "Decimal",
      "productions": "Array<Production>",
      "consumers": {
        "{consumer_name}": {
          "total_used": "Decimal",
          "total_price": "Decimal",
          "total_reduced_price": "Decimal",
          "total_grid_price": "Decimal",
          "total_saved": "Decimal",
          "total_consumption": "Decimal",
          "total_self_consumption": "Decimal",
          "total_grid_consumption": "Decimal",
          "productions": "Array<Production>",
          "consumptions": "Array<Consumption>"
        }
      }
    }
  }
}

With producer_id set:

{
  "total_production": "Decimal",
  "total_used": "Decimal",
  "consumers_total_revenue": "Decimal",
  "consumers_total_saved": "Decimal",
  "consumers_total_consumption": "Decimal",
  "productions": "Array<Production>",
  "consumers": {
    "{consumer_name}": {
      "total_used": "Decimal",
      "total_price": "Decimal",
      "total_reduced_price": "Decimal,"
      "total_grid_price": "Decimal",
      "total_saved": "Decimal",
      "total_consumption": "Decimal",
      "total_self_consumption": "Decimal",
      "total_grid_consumption": "Decimal",
      "productions": "Array<Production>",
      "consumptions": "Array<Consumption>"
    }
  },
  "consumptions": "Array<Consumption(aggregated)>"
}

With consumer_id set:

{
  "total_used": "Decimal",
  "total_price": "Decimal",
  "total_reduced_price": "Decimal",
  "total_grid_price": "Decimal",
  "total_saved": "Decimal",
  "total_consumption": "Decimal",
  "total_self_consumption": "Decimal",
  "total_grid_consumption": "Decimal",
  "productions": "Array<Production>",
  "consumptions": "Array<Consumption>" 
}

This API endpoint creates the first Production and Consumptions for a given Producer and its Consumers, for a given time with all meter readings set to 0.

POST /setup/

Das Django Projekt ist in unterschiedliche Applikationen aufgeteilt. Diese sind zwar stark verkoppelt, aber haben unterschiedliche Aufgaben.

• base
  • base.sensors
  • base.data
  • base.contracts
• input
• output

Die ReadMe ist nicht ganz vollständig und Verlinkungen teilweise nicht gesetzt

In base werden alle Modelle und grundlegenden administrativen Serializer und Views definiert. In dieser Ebene wird der UserSerializer definiert und die Views, also die API-Endpunkte definiert.

Viewset, für Dokumentation siehe Django REST GUI

Für API-DOkumentation siehe hier
Diese Klasse erweitert die von Standard Klasse für Token Authentifizierung von Django, damit zusätzlich zum Token, die Parameter is_admin und customer_id für den einloggenden User mitgesendet werden.

Für API-DOkumentation siehe hier

Hier wird ganz grundlegend eine Logout Funktion für Token-Authentifizierung implementiert, indem der Token des ausloggenden Benutzers gelöscht wird und damit ein neuer Token generiert werden muss.

In dieser Ebenen wird die Entität Sensor definiert und alle Entitäten, die direkt einem Sensor zugeordnet sind.

Hier sollte erwähnt werden, dass die Serializer für Producer und Consumer so definiert sind, dass die Sensoren zusammen mit einem Producer/Consumer erstellt werden und nicht seperat. Genauso wird ein User zusammen mit einem Konsumenten erstellt.

Sensoren, sind die Entitäten, welche die konkreten Lorawan Sensoren abbilden, welche in unserem Projekt zum Einsatz kommen. Sensoren speichern die Gerätenummer und sind einem von drei Typen zugeordnet, damit eingehende Daten (siehe input) einem Sensor zugeordnet werden kann und ob dieser Sensor Produktion(PM), Netzeinspeisung(GM) oder Verbrauch(CM) misst.

Ein Produzent (bspw. Solaranalge) bildet die oberste Einheit in unserem Projekt. Ein Produzent hat immer zwei Sensorenn, ein für die Produktion und einen für die Netzeinspeisung. Des Weiteren werden beschreibende Attribute gespeichert, wie ein Anzeigename oder eine Addresse

Ein Konsument(bspw. eine Wohneinheit) konsumiert Energie, welche von einem Sensor gemessen wird und ist genau einem Produzenten zugeordnet. Darüber hinaus werden Attribute zur Kontaktaufnahme gespeichert. Ein Konsument ist genau einem Benutzer zugeordnet, damit eine Authentifizierung