HSL 2.0-Framework Beschreibung des Frameworks

Öffentliche Methoden | Private Methoden | Aufstellung aller Elemente
hsl20_4.hsl20_4.BaseModule Klassenreferenz

Basis-Klasse für einen HSL 2.0-Baustein. Mehr ...

## Öffentliche Methoden
def | __init__ (self, homeserver_context, module_context)
| Konstruktur, muss im Konstruktor der vererbten Klasse aufgerufen werden. Mehr ...
def | on_input_value (self, index, value)
| Wird jedes Mal aufgerufen, wenn ein Wert auf einem Eingang des Baustein eintrifft. Mehr ...
def | on_init (self)
| Wird einmalig aufgerufen, wenn der Baustein initialisiert wird. Mehr ...

## Private Methoden
def | _get_module_id (self)
| Liefert die Laufzeit-ID des Moduls zurück. Mehr ...
def | _get_module_class_id (self)
| Liefert die fünfstellige Baustein-ID (zum Beispiel '10001') zurück. Mehr ...
def | _get_framework (self)
| Liefert ein Objekt vom Typ hsl20_4.Framework zurück. Mehr ...
def | _get_logger (self, logType, param)
| Liefert ein Objekt vom Type hsl20_4.Logger zruück. Mehr ...
def | _get_input_value (self, index)
| Liefert den Wert, der zum Zeitpunkt des Aufrufs am Eingang index anliegt, zurück. Mehr ...
def | _set_output_value (self, index, value)
| Setzt einen Wert auf einen Ausgang. Mehr ...
def | _can_set_output (self)
| Zeigt an, ob ein Wert auf einen Ausgang gesetzt werden kann. Mehr ...
def | _get_remanent (self, index)
| Liefert den Wert der remanenten Variable zurück. Mehr ...
def | _set_remanent (self, index, value)
| Beschreibt eine remanente Variable. Mehr ...

## Ausführliche Beschreibung

Basis-Klasse für einen HSL 2.0-Baustein.

Ein HSL 2.0-Baustein muss diese Klasse durch Vererbung als Basis haben. Der Generator erzeugt die notwendigen Code-Segmente: Ein Beispiel für die Umsetzung des Bausteins Sperre liegt bei: 10701_MyBaseModule_03.py

## Beschreibung der Konstruktoren und Destruktoren

## ◆ __init__()

def hsl20_4.hsl20_4.BaseModule.__init__ | ( |  | self,
|  |  | homeserver_context,
|  |  | module_context
| ) |  |

Konstruktur, muss im Konstruktor der vererbten Klasse aufgerufen werden.

Parameter

  homeserver_context | object Verweis auf die HomeServer-Objektstruktur.
  module_context | string Schlüssel des Modulkontexts. Der Schlüssel legt fest, in welchem Kontext der Baustein läuft.

## Dokumentation der Elementfunktionen

## ◆ _can_set_output()

def hsl20_4.hsl20_4.BaseModule._can_set_output | ( |  | self | ) |
| private

Zeigt an, ob ein Wert auf einen Ausgang gesetzt werden kann.

Liefert False falls vorerst kein weiterer Wert geschrieben werden kann.

Rückgabe
  bool Ein Ausgang kann gesetzt werden

## ◆ _get_framework()

def hsl20_4.hsl20_4.BaseModule._get_framework | ( |  | self | ) |
| private

Liefert ein Objekt vom Typ hsl20_4.Framework zurück.

Rückgabe
  hsl20_4.hsl20_4.Framework
  Eine Instanz auf das HSL 2.0-Framework

## ◆ _get_input_value()

def hsl20_4.hsl20_4.BaseModule._get_input_value | ( |  | self,
|  |  | index
| ) |  |
| private

Liefert den Wert, der zum Zeitpunkt des Aufrufs am Eingang
index anliegt, zurück.

Der am Eingang anliegende Wert kann sich während des Ablaufs der Bausteinlogik ändern.

Parameter

  index | int Index des Eingangs.

Rückgabe
  float/str
  Wert des Eingangs. Der Typ des Rückgabewerts hängt von der Definition des Eingangs ab.

## ◆ _get_logger()

def hsl20_4.hsl20_4.BaseModule._get_logger | ( |  | self,
|  |  | logType,
|  |  | param
| ) |  |
| private

Liefert ein Objekt vom Type hsl20_4.Logger zruück.

Zu beachten
  Diese Methode wird durch den vom Generator erzeugten Code aufgerufen. Ein erneutes Aufrufen dieser Methode liefert (unabängig von den Parametern) das bereits erzeugte Logger-Objekt zurück.

Parameter

  logType | int Logging-Handler (z.B. hsl20_4.LOGGING_SYSLOG)
  param | tuple Parameter zum verwendeten Logging-Handler

Rückgabe
  hsl20_4.hsl20_4.Logger
  Logger-Objekt

## ◆ _get_module_class_id()

def hsl20_4.hsl20_4.BaseModule._get_module_class_id | ( |  | self | ) |
| private

Liefert die fünfstellige Baustein-ID (zum Beispiel '10001') zurück.

Rückgabe
  string
  Baustein-ID

Ab Version 2.0.3:
  Methode set_reference(self, hsl_module) entfernt.

## ◆ _get_module_id()

def hsl20_4.hsl20_4.BaseModule._get_module_id | ( |  | self | ) |
| private

Liefert die Laufzeit-ID des Moduls zurück.

Die ID ist nur während der Laufzeit des Geräts gültig.

Rückgabe
  int
  ID des Moduls

## ◆ _get_remanent()

def hsl20_4.hsl20_4.BaseModule._get_remanent | ( |  | self,
|  |  | index
| ) |  |
| private

Liefert den Wert der remanenten Variable zurück.

Siehe auch die Dokumentation zum Remanentspeicher.

Parameter

  index | int Index der remanten Variable

Rückgabe
  float/str
  Wert der remanenten Variable

## ◆ _set_output_value()

def hsl20_4.hsl20_4.BaseModule._set_output_value | ( |  | self,
|  |  | index,
|  |  | value
| ) |  |
| private

Setzt einen Wert auf einen Ausgang.

Parameter

  index | int Index des Ausgangs, der beschrieben werden soll.
  value | float/str Wert, der auf den Ausgang geschrieben wird. Der Datentyp ist abhängig davon, ob der Ausgang als numerisch oder alphanumerisch definiert wurde.

## ◆ _set_remanent()

def hsl20_4.hsl20_4.BaseModule._set_remanent | ( |  | self,
|  |  | index,
|  |  | value
| ) |  |
| private

Beschreibt eine remanente Variable.

Warnung
  Der Remanentspeicher wird im HomeServer nur alle 15 Minuten persistiert.

Siehe auch die Dokumentation zum Remanentspeicher.

Parameter

  index | int Index der remanenten Variable
  value | float/str Wert der remanenten Variable (maximale Größe: 30.000 Byte).

## ◆ on_init()

def hsl20_4.hsl20_4.BaseModule.on_init | ( |  | self | ) |

Wird einmalig aufgerufen, wenn der Baustein initialisiert wird.

Diese Methode kann implementiert (überschrieben) werden, wenn ein Baustein erstellt wird.

## ◆ on_input_value()

def hsl20_4.hsl20_4.BaseModule.on_input_value | ( |  | self,
|  |  | index,
|  |  | value
| ) |  |

Wird jedes Mal aufgerufen, wenn ein Wert auf einem Eingang des Baustein eintrifft.

Die Methode wird für jedes Eintreffen eines Wertes an einem Eingang genau einmal aufgerufen.

Diese Methode muss implementiert (überschrieben) werden, wenn ein Baustein erstellt wird.

Parameter

  index | int Index des Eingangs.
  value | float/str Wert, der auf dem Eingang eingetroffen ist. Der Datentyp ist abhängig davon, ob der Eingang als numerisch oder alphanumerisch definiert wurde.

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

- hsl20_4.py