Python Skripte schreiben

Mit der Einführung von Eliona Version 12.2 wurden wichtige Änderungen vorgenommen, die es erforderlich machen, Skripte anzupassen, um das neue API-Design zu nutzen.

Skript-Definition

Wenn ein neues Skript im Eliona-System erstellt wird, wird automatisch ein Funktionsheader generiert. Dieser Header enthält zwei Parameter:

• id: Die eindeutige ID des Skripts.

• eliona: Ein Objekt, über das der Benutzer mit dem Eliona-System interagieren kann.

Der Funktionsheader sieht wie folgt aus:

# you may add imports only inside the function
# don't change or delete the function definition
def UserFunction(id, eliona):
	# add your code here

Importieren von Modulen

Alle notwendigen Module müssen innerhalb der Funktion importiert werden. Es ist wichtig, dass Module nur innerhalb der Funktion importiert und keine globalen Importe verwendet werden.

Beispiel:

def UserFunction(id, eliona):
    import random
    # Weitere Codezeilen folgen

---

Methoden des Eliona-Objekts

Das eliona-Objekt stellt eine Reihe von Methoden zur Verfügung, die es Benutzern ermöglichen, mit dem Eliona-System zu interagieren. Hier sind die wichtigsten Methoden zusammen mit ihren Parametern und Beschreibungen:

Methode	Parameter	Beschreibung
GetHeap	gai: str, subtype: str, attribute: str	Ruft den aktuellen Wert eines Attributs oder das gesamte Daten-JSON eines Assets aus dem Heap ab.
SetHeap	gai: str, subtype: str, data: dict, source: str	Sendet Daten an den Calculator, um sie zu verarbeiten und im Heap zu speichern.
GetAssetIDByGAI	gai: str	Gibt eine Asset-ID für die angegebene GAI zurück.
GetAll	ids: [ints or strs], subtype: str`	Ruft alle Datenpunkte eines bestimmten Subtyps für eine Liste von Assets ab und gibt diese als Dictionary zurück, wobei jede Asset-ID oder GAI als Schlüssel dient. Ideal für die gleichzeitige Auswertung mehrerer Assets.
SQLQuery	query: str	Führt eine beliebige SQL-Abfrage aus und gibt die Ergebnisse als Tupel zurück.
MakeSource	id: int	Gibt einen String zurück, der als Quelle in einer Nachricht für die Datenbank verwendet werden kann.
OpenFile	name: str, mode: str	Öffnet eine Datei mit dem gewünschten Namen und Modus in einem Ordner, in dem das Schreiben erlaubt ist. -> Doc Python open()
AddAssetTag	gai: str, tag: str	Fügt einem Asset ein Tag hinzu, wenn es noch nicht zugewiesen wurde. Wenn das Tag bereits vorhanden ist, passiert nichts.
RemoveAssetTag	gai: str, tag: str	Entfernt ein Tag von einem Asset, falls es zugewiesen wurde. Wenn das Tag nicht vorhanden ist, passiert nichts.

---

Beispielskripte

Einfaches Skript zur Manipulation von Daten

Dieses Beispiel zeigt, wie ein Skript einen zufälligen Wert generiert und diesen in den Heap eines Assets schreibt:

def UserFunction(id, eliona):
    import random

    data = {
        "power_val": random.randint(10, 100)
    }

    eliona.SetHeap("TestInactIn", "input", data, eliona.MakeSource(id))

Beschreibung:

• Das Skript importiert das Modul random.

• Es wird ein Wörterbuch data erstellt, das einen Schlüssel power_val enthält, dem ein zufälliger Wert zwischen 10 und 100 zugewiesen wird.

• Der generierte Wert wird mit der Methode SetHeap in den Heap des Assets TestInactIn geschrieben.

---

Daten abrufen und modifizieren

In diesem Beispiel wird der Wert eines Attributs von einem Asset abgerufen, modifiziert und in einem anderen Asset gespeichert:

def UserFunction(id, eliona):
    from datetime import datetime

    heap = eliona.GetHeap("TestInactIn", "input")

    data = {
        "energy_val": heap["power_val"] * 3
    }

    eliona.SetHeap("TestInactIn", "input", data, eliona.MakeSource(id))

Beschreibung:

• Das Skript importiert das Modul datetime.

• Der aktuelle Wert des Attributs power_val wird aus dem Heap des Assets TestInactIn abgerufen.

• Dieser Wert wird verdreifacht und als energy_val in dasselbe Asset geschrieben.

---

Erweiterte Funktionen und SQL-Abfragen

Mit der Methode SQLQuery können beliebige SQL-Abfragen direkt aus dem Skript heraus ausgeführt werden:

def UserFunction(id, eliona):
    result = eliona.SQLQuery("SELECT * FROM public.asset WHERE gai = 'TestInactIn';")
    # Weitere Verarbeitung des Ergebnisses

Beschreibung:

• Die SQL-Abfrage ruft alle Informationen zu dem Asset mit der GAI TestInactIn ab.

• Das Ergebnis kann anschließend weiterverarbeitet werden.