HSL 2.0-Framework
Beschreibung des Frameworks
Öffentliche Methoden | Öffentliche, statische Methoden | Aufstellung aller Elemente
hsl20_4.hsl20_4.Framework Klassenreferenz

Bildet alle Framework-Funktionalitäten ab. Mehr ...

Öffentliche Methoden

def __init__ (self, homeserver_context, module_context, module_instance)
 Konstruktor. Mehr ...
 
def get_homeserver_version (self)
 Liefert die Version der auf dem Gerät aufgespielten Firmware. Mehr ...
 
def get_homeserver_version_major (self)
 Liefert die Hauptversionsnummer (major release) der auf dem Gerät aufgespielten Firmware. Mehr ...
 
def get_homeserver_version_minor (self)
 Liefert die Nebenversionsnummer (minor release) der auf dem Gerät aufgespielten Firmware. Mehr ...
 
def get_homeserver_serial_id (self)
 Liefert die Seriennummer des Geräts. Mehr ...
 
def get_homeserver_private_ip (self)
 Liefert die private IP-Adresse des Geräts. Mehr ...
 
def get_project_id (self)
 Liefert die ID des aktuell aufgespielten Projekts. Mehr ...
 
def get_coordinates (self)
 Liefert die im Projekt angegebenen Koordinaten für die Sonnenstandsberechnung. Mehr ...
 
def get_context (self)
 Liefert den Schlüssel des Modulkontexts. Mehr ...
 
def get_instance_by_id (self, instance_id)
 Liefert eine Baustein-Instanz zurück. Mehr ...
 
def get_instance_from_module_by_id (self, module_context, instance_id)
 Liefert eine Baustein-Instanz zurück. Mehr ...
 
def create_http_server (self)
 Erstellt eine Instanz eines HTTP-Servers. Mehr ...
 
def create_http_client (self)
 Erstellt eine Instanz eines HTTP-Clients. Mehr ...
 
def create_tcp_client (self)
 Erstellt eine Instanz eines TCP-Clients. Mehr ...
 
def create_udp_unicast (self)
 Erstellt eine Instanz eines UDP-Unicast-Sockets. Mehr ...
 
def create_udp_broadcast (self)
 Erstellt eine Instanz eines UDP-Broadcast-Sockets. Mehr ...
 
def create_udp_multicast (self)
 Erstellt eine Instanz eines UDP-Multicast-Sockets. Mehr ...
 
def create_timer (self)
 Erstellt eine Instanz eines Timers. Mehr ...
 
def create_interval (self)
 Erstellt eine Instanz eines Intervall-Timers. Mehr ...
 
def create_debug_section (self)
 Erstellt eine Sektion auf der Debug-Seite des HS/FS. Mehr ...
 
def create_md5_hash (self)
 Erstellt eine Instanz der MD5-Klasse. Mehr ...
 
def create_sha1_hash (self)
 Erstellt eine Instanz der SHA1-Klasse. Mehr ...
 
def create_sha224_hash (self)
 Erstellt eine Instanz der SHA2-Klasse. Mehr ...
 
def create_sha256_hash (self)
 Erstellt eine Instanz der SHA2-Klasse. Mehr ...
 
def create_sha384_hash (self)
 Erstellt eine Instanz der SHA2-Klasse. Mehr ...
 
def create_sha512_hash (self)
 Erstellt eine Instanz der SHA2-Klasse. Mehr ...
 
def create_aes (self)
 Erstellt eine Instanz der AES-Klasse. Mehr ...
 
def resolve_dns (self, host)
 Liefert eine IP-Addresse. Mehr ...
 

Öffentliche, statische Methoden

def get_framework_index ()
 Liefert den Versions-Index des Frameworks. Mehr ...
 

Ausführliche Beschreibung

Bildet alle Framework-Funktionalitäten ab.

Die Klasse wird automatisch vom Basis-Modul instanziert und sollte nicht direkt instanziert werden.

Ab Version 2.0.5:
Fehlerhaftes Verhalten im Zusammenhang mit Timern beseitigt

Beschreibung der Konstruktoren und Destruktoren

◆ __init__()

def hsl20_4.hsl20_4.Framework.__init__ (   self,
  homeserver_context,
  module_context,
  module_instance 
)

Konstruktor.

Warnung
Eine Instanz dieser Klasse wird durch den Baustein erzeugt.
Parameter
homeserver_contextobject
Verweis auf die HomeServer-Objektstruktur.
module_contextstring
Schlüssel des Modulkontexts.
module_instancefunction
Baustein Instanz

Dokumentation der Elementfunktionen

◆ create_aes()

def hsl20_4.hsl20_4.Framework.create_aes (   self)

Erstellt eine Instanz der AES-Klasse.

Dient zur Ent-/Verschlüsselung von Daten per AES.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.AESCipher

◆ create_debug_section()

def hsl20_4.hsl20_4.Framework.create_debug_section (   self)

Erstellt eine Sektion auf der Debug-Seite des HS/FS.

Rückgabe
hsl20_4_debug_page.hsl20_4_debug_page.Section
Sektion

◆ create_http_client()

def hsl20_4.hsl20_4.Framework.create_http_client (   self)

Erstellt eine Instanz eines HTTP-Clients.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_http_client in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_http_client.hsl20_4_http_client.Client
HTTP-Client

◆ create_http_server()

def hsl20_4.hsl20_4.Framework.create_http_server (   self)

Erstellt eine Instanz eines HTTP-Servers.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_http_server in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_http_server.hsl20_4_http_server.Server
HTTP-Server

◆ create_interval()

def hsl20_4.hsl20_4.Framework.create_interval (   self)

Erstellt eine Instanz eines Intervall-Timers.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_timer in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_timer.hsl20_4_timer.Interval
Intervall-Timer

◆ create_md5_hash()

def hsl20_4.hsl20_4.Framework.create_md5_hash (   self)

Erstellt eine Instanz der MD5-Klasse.

Dient zur Erzeugung eines 128 Bit langen MD5-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.MD5Hash
128 Bit langer MD5-Hashwert

◆ create_sha1_hash()

def hsl20_4.hsl20_4.Framework.create_sha1_hash (   self)

Erstellt eine Instanz der SHA1-Klasse.

Dient zur Erzeugung eines 160 Bit langen SHA1-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.SHA1Hash
160 Bit langer SHA1-Hashwert

◆ create_sha224_hash()

def hsl20_4.hsl20_4.Framework.create_sha224_hash (   self)

Erstellt eine Instanz der SHA2-Klasse.

Dient zur Erzeugung eines 224 Bit langen SHA2-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.SHA2Hash
224 Bit langen SHA2-Hashwert

◆ create_sha256_hash()

def hsl20_4.hsl20_4.Framework.create_sha256_hash (   self)

Erstellt eine Instanz der SHA2-Klasse.

Dient zur Erzeugung eines 256 Bit langen SHA2-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.SHA2Hash
256 Bit langen SHA2-Hashwert

◆ create_sha384_hash()

def hsl20_4.hsl20_4.Framework.create_sha384_hash (   self)

Erstellt eine Instanz der SHA2-Klasse.

Dient zur Erzeugung eins 384 Bit langen SHA2-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.SHA2Hash
384 Bit langen SHA2-Hashwert

◆ create_sha512_hash()

def hsl20_4.hsl20_4.Framework.create_sha512_hash (   self)

Erstellt eine Instanz der SHA2-Klasse.

Dient zur Erzeugung von 512 Bit langen SHA2-Hashwerts.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_crypto in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_crypto.hsl20_4_crypto.SHA2Hash
512 Bit langen SHA2-Hashwert

◆ create_tcp_client()

def hsl20_4.hsl20_4.Framework.create_tcp_client (   self)

Erstellt eine Instanz eines TCP-Clients.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_tcp in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_tcp.hsl20_4_tcp.Client
TCP-Client

◆ create_timer()

def hsl20_4.hsl20_4.Framework.create_timer (   self)

Erstellt eine Instanz eines Timers.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_timer in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_timer.hsl20_4_timer.Timer
Timer

◆ create_udp_broadcast()

def hsl20_4.hsl20_4.Framework.create_udp_broadcast (   self)

Erstellt eine Instanz eines UDP-Broadcast-Sockets.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_udp in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_udp.hsl20_4_udp.Broadcast
UDP-Socket

◆ create_udp_multicast()

def hsl20_4.hsl20_4.Framework.create_udp_multicast (   self)

Erstellt eine Instanz eines UDP-Multicast-Sockets.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_udp in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_udp.hsl20_4_udp.Multicast
UDP-Socket

◆ create_udp_unicast()

def hsl20_4.hsl20_4.Framework.create_udp_unicast (   self)

Erstellt eine Instanz eines UDP-Unicast-Sockets.

Zu beachten
Um diese Funktion nutzen zu können, muss das Modul hsl20_4_udp in der XML-Definition des Bausteins importiert werden.
Rückgabe
hsl20_4_udp.hsl20_4_udp.Unicast
UDP-Socket

◆ get_context()

def hsl20_4.hsl20_4.Framework.get_context (   self)

Liefert den Schlüssel des Modulkontexts.

Rückgabe
string
Schlüssel des Modulkontexts.

◆ get_coordinates()

def hsl20_4.hsl20_4.Framework.get_coordinates (   self)

Liefert die im Projekt angegebenen Koordinaten für die Sonnenstandsberechnung.

Rückgabe
tuple
(Breitengrad, Längengrad)
Ab Version 2.0.7:
neue Methode

◆ get_framework_index()

def hsl20_4.hsl20_4.Framework.get_framework_index ( )
static

Liefert den Versions-Index des Frameworks.

In dieser Version beträgt der Versions-Index 7.

Rückgabe
int
Index (=7)

◆ get_homeserver_private_ip()

def hsl20_4.hsl20_4.Framework.get_homeserver_private_ip (   self)

Liefert die private IP-Adresse des Geräts.

Rückgabe
string
IP-Adresse

◆ get_homeserver_serial_id()

def hsl20_4.hsl20_4.Framework.get_homeserver_serial_id (   self)

Liefert die Seriennummer des Geräts.

Rückgabe
string
Seriennummer

◆ get_homeserver_version()

def hsl20_4.hsl20_4.Framework.get_homeserver_version (   self)

Liefert die Version der auf dem Gerät aufgespielten Firmware.

Rückgabe
string
Version der Firmware.

◆ get_homeserver_version_major()

def hsl20_4.hsl20_4.Framework.get_homeserver_version_major (   self)

Liefert die Hauptversionsnummer (major release) der auf dem Gerät aufgespielten Firmware.

result int Hauptversionsnummer der Firmware.

◆ get_homeserver_version_minor()

def hsl20_4.hsl20_4.Framework.get_homeserver_version_minor (   self)

Liefert die Nebenversionsnummer (minor release) der auf dem Gerät aufgespielten Firmware.

result int Nebenversionsnummer der Firmware.

◆ get_instance_by_id()

def hsl20_4.hsl20_4.Framework.get_instance_by_id (   self,
  instance_id 
)

Liefert eine Baustein-Instanz zurück.

Dient zur Kommunikation zwischen zwei Bausteinen. Im GLE kann die ID einem anderen Baustein über eine direkte Verdrahtung der Bausteine bekannt gemacht werden.

Die ID muss sich innerhalb des Modulkontexts befinden.

Parameter
instance_idint
Laufzeit-ID des Bausteins.
Rückgabe
object
Instanz des Bausteins (vererbt von BaseModule). Liefert None, wenn eine ungültige ID übergeben wurde.

◆ get_instance_from_module_by_id()

def hsl20_4.hsl20_4.Framework.get_instance_from_module_by_id (   self,
  module_context,
  instance_id 
)

Liefert eine Baustein-Instanz zurück.

Parameter
module_contextstring
Schlüssel des Modulkontexts.
instance_idint
Laufzeit-ID des Bausteins.
Rückgabe
object
Instanz eines Bausteins (vererbt von BaseModule). Liefert None, wenn eine ungültige ID übergeben wurde.

◆ get_project_id()

def hsl20_4.hsl20_4.Framework.get_project_id (   self)

Liefert die ID des aktuell aufgespielten Projekts.

Rückgabe
string
Projekt-ID

◆ resolve_dns()

def hsl20_4.hsl20_4.Framework.resolve_dns (   self,
  host 
)

Liefert eine IP-Addresse.

Nutzt den DNS-Dienst des HS/FS um den Hostnamen aufzulösen.

Rückgabe
string
IP-Addresse. Liefert None, wenn die Adresse nicht aufgelöst werden konnte.
Warnung
Dieser Aufruf blockiert bis eine Antwort eingetroffen ist oder der Timeout abgelaufen ist.

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei: