# 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 BuildingPro Suites App Store.

### Konfiguration

#### Bei Electricity Maps registrieren

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

#### Konfigurieren Sie die Electricity Maps App

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

Die Konfiguration erfordert die folgenden Daten:

| Attribut        | Beschreibung                                                                   | Erforderlich         |
| --------------- | ------------------------------------------------------------------------------ | -------------------- |
| apiKey          | Electricity Maps API-Schlüssel aus dem vorherigen Schritt                      | Ja                   |
| enable          | Kennzeichen zum Aktivieren/Deaktivieren dieser Konfiguration                   | Ja                   |
| refreshInterval | Intervall in Sekunden für die Datensynchronisierung (mindestens 300 empfohlen) | Ja                   |
| requestTimeout  | Zeitüberschreitung für API-Abfragen in Sekunden                                | Nein (Standard: 120) |
| tenantIDs       | Liste der BuildingPro Suites Tenant-IDs für die Datenerfassung                 | Ja                   |

Beispiel für eine Konfigurations-JSON:

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

#### Asset-Erstellung

Nach der Konfiguration erstellt die App einen `Electricity Zone` Asset-Typ. Sie können mehrere Assets dieses Typs erstellen, die jeweils eine zu überwachende geografische Zone darstellen.

#### Electricity Zone-Standorte konfigurieren

1. Erstellen Sie ein neues Asset vom Typ `Electricity Zone`
2. Klicken Sie auf die Bearbeiten-Schaltfläche des Assets
3. Setzen Sie im Abschnitt "Weitere Informationen" die Zonenkennung (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 prüfen, ob die App die Zone korrekt erkannt hat

Das Asset wird dann mit Daten zum Stromnetz gefü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 fossilerfreier Energie am Stromverbrauch | %          |

#### Überwachung des App-Status

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

* Asset-Status: Aktiv/Inaktiv zeigt an, ob die App läuft
* Statusattribut: Zeigt den aktuellen Betriebsstatus an. Wenn der App-Status nicht "OK" ist, deutet dies darauf hin, dass die App möglicherweise nicht korrekt funktioniert. Wenn der Fehlerzustand weiterhin besteht, 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₂-bewusstes Lastverschieben