# Electricity maps

![App-Schema](https://raw.githubusercontent.com/eliona-smart-building-assistant/electricity-maps-app/refs/heads/develop/schema.png)

### Installation

Installieren Sie die Electricity Maps App über den Eliona App Store.

### Konfiguration

#### Registrierung bei Electricity Maps

1. Erstellen Sie ein Konto unter [Electricity Maps](https://www.electricitymaps.com/)
2. Abonnieren Sie den passenden API-Tarif (kostenlose Version für grundlegende Nutzung in einer Region verfügbar)
3. Generieren Sie einen API-Schlüssel in Ihren Kontoeinstellungen und speichern Sie ihn für die Eliona-Konfiguration

#### Konfiguration der Electricity Maps App

Konfigurationen können in Eliona unter `Einstellungen > Apps > Electricity Maps` erstellt werden, was die App-Oberfläche [Generic Frontend](https://doc.eliona.io/collection/v/eliona-english/manuals/settings/apps) öffnet. Verwenden Sie den Konfigurationsendpunkt mit der PUT-Methode.

Die Konfiguration erfordert folgende Daten:

| Attribut        | Beschreibung                                                                  | Erforderlich         |
| --------------- | ----------------------------------------------------------------------------- | -------------------- |
| apiKey          | Electricity Maps API-Schlüssel aus dem vorherigen Schritt                     | Ja                   |
| enable          | Flag zum Aktivieren/Deaktivieren dieser Konfiguration                         | Ja                   |
| refreshInterval | Intervall in Sekunden für die Datensynchronisation (mindestens 300 empfohlen) | Ja                   |
| requestTimeout  | API-Abfrage-Timeout in Sekunden                                               | Nein (Standard: 120) |
| projectIDs      | Liste der Eliona Projekt-IDs für die Datenerfassung                           | Ja                   |

Beispiel-Konfigurations-JSON:

```json
{
  "apiKey": "Ihr-API-Schlüssel",
  "enable": true,
  "refreshInterval": 900,
  "requestTimeout": 120,
  "projectIDs": [
    "10"
  ]
}
```

### Asset-Erstellung

Nach der Konfiguration erstellt die App einen Asset-Typ `Electricity Zone`. Sie können mehrere Assets dieses Typs erstellen, die jeweils eine geografische Zone repräsentieren, die überwacht werden soll.

### Konfiguration von Electricity Zone Standorten

1. Erstellen Sie ein neues Asset vom Typ `Electricity Zone`
2. Klicken Sie auf die Bearbeitungsschaltfläche des Assets
3. Setzen Sie im Abschnitt "Weitere Informationen" den Zonen-Identifier (z.B. "CH" oder "Switzerland" für die Schweiz, "DE" oder "Germany" für Deutschland)
4. Speichern Sie die Asset-Konfiguration
5. Aktualisieren Sie die Seite, um zu überprüfen, ob die App die Zone korrekt identifiziert hat

Das Asset wird dann mit Stromnetzdaten befüllt:

| Attribut                 | Beschreibung                                     | Einheit    |
| ------------------------ | ------------------------------------------------ | ---------- |
| carbon\_intensity        | CO₂-Intensität des Stromverbrauchs               | gCO₂eq/kWh |
| renewable\_percentage    | Anteil erneuerbarer Energien am Stromverbrauch   | %          |
| fossil\_free\_percentage | Anteil fossiler-freier Energie am Stromverbrauch | %          |

### App-Statusüberwachung

Die App erstellt ein Root-Asset namens "Electricity Maps Root", das Informationen über den Status der App bereitstellt:

* Asset-Status: Aktiv/Inaktiv zeigt an, ob die App läuft
* Status-Attribut: Zeigt den aktuellen Betriebsstatus. Wenn der App-Status nicht "OK" ist, deutet dies darauf hin, dass die App möglicherweise nicht richtig funktioniert. Wenn der Fehlerzustand anhält, lassen Sie es uns wissen, indem Sie einen Fehlerbericht einreichen.

### Anwendungsfälle

Die Electricity Maps App ermöglicht:

* Echtzeitüberwachung der CO₂-Intensität des Stromnetzes
* Verfolgung des Anteils erneuerbarer Energien
* Optimierung des Energieeinkaufs
* ESG-Berichterstattung und Nachhaltigkeitsverfolgung
* Lastmanagementstrategien basierend auf der Netzzusammensetzung
* CO₂-bewusste Lastverlagerung
