8.1 Integrierte Datentypen
8.1.1 ConfigBase-Typ
Basiskonfigurationstyp
class ConfigBase{
string GetConfigString(string key, string default);
int GetConfigInt(string key, string default);
}8.1.1.1 Zeichenfolgenkonfigurationsparameter abrufen
Definition:
GetConfigString(key, default) -> stringKategorie: Methode
Parameter:
key: string-Typ,Konfigurationsnamedefault: string-Typ,Standardwert
Rückgabe:
stringKonfigurationsinhalt abrufen, gibt Standardwert zurück, wenn leerBeispiel:
8.1.2 Device-Typ
Datenerfassungsgerättyp, erbt von ConfigBase, kann ConfigBase-Methoden verwenden
class Device : ConfigBase{
string name;
string code;
string type;
json current;
json last;
int state;
int id;
}8.1.2.2 Geräte-ID
Definition:
idKategorie: Eigenschaft
Typ:
intBeschreibung: Gibt Geräte-ID zurück
Beispiel:
8.1.2.3 Gerätename
Definition:
nameKategorie: Eigenschaft
Typ:
stringBeschreibung: Gibt Gerätenamen zurück
Beispiel:
8.1.2.4 Gerätecode
Definition:
codeKategorie: Eigenschaft
Typ:
stringBeschreibung: Gibt Gerätecode zurück
Beispiel:
8.1.2.5 Aktuelle Erfassungsdaten
Definition:
currentKategorie: Eigenschaft
Typ: table
Beschreibung: Gibt aktuelle Erfassungsdaten vom Gerät zurück
Beispiel:
8.1.2.6 Letzte Erfassungsdaten
Definition:
lastKategorie: Eigenschaft
Typ: table
Beschreibung: Gibt letzte Erfassungsdaten vom Gerät zurück
Beispiel:
8.1.3 Variable-Typ
Datenerfassungsvariablentyp, erbt von ConfigBase, kann ConfigBase-Methoden verwenden
class Variable{
int Write(json value);
Device device;
string name;
bool writable;
bool readable;
json current;
json last;
}8.1.3.1 Wert in Variable schreiben
Definition:
Write(value)Kategorie: Methode
Parameter:
value: any-Typ,Zu schreibender Wert, Typ hängt von der Datentypeinstellung der Variable ab
Beispiel:
8.1.3.2 Variablenname
Definition:
nameKategorie: Eigenschaft
Typ:
stringBeschreibung: Variablenname
Beispiel:
8.1.3.3 Aktuelle Erfassungsdaten
Definition:
currentKategorie: Eigenschaft
Typ:
tableBeschreibung: Aktuelle Erfassungsdaten der Variable
Beispiel:
8.1.3.4 Letzte Erfassungsdaten
Definition:
lastKategorie: Eigenschaft
Typ:
tableBeschreibung: Letzte Erfassungsdaten der Variable
Beispiel:
8.1.3.5 Variablengerät
Definition:
deviceKategorie: Eigenschaft
Typ: Device
Beschreibung: Gerät, zu dem die Variable gehört
Beispiel:
8.1.4 Publisher-Typ
Push-Plattform-Typ
8.1.4.1 Originale Erfassungsdaten abrufen
Definition:
GetOriginMessage() -> tableKategorie: Methode
Rückgabe:
tableGibt originale Erfassungsdaten zurückDatenformat:
8.1.5 Mqtt-Typ
Mqtt-Client zum Pushen
class MqttClient{
int Connect();
int PushMessage(string message, string topic, int qos, int retained);
int CheckConnect();
int Subscribe(string message, int qos);
string address;
string username;
string password;
string client_id;
int keepalive;
string will_msg;
int will_qos;
bool connected;
function on_connect;
function on_disconnect;
function on_message;
function on_connect;
string ca;
string cert;
string key;
string key_pass;
string ssl_version;
}8.1.5.1 Mit Mqtt verbinden
- Definition:
Connect() -> int - Kategorie: Methode
- Rückgabe:
intGibt Verbindungsstatus zurück, 0 für ok, sonst ungleich 0 für Verbindungsfehler
8.1.5.2 Zum Mqtt-Server pushen
- Definition:
PushMessage(message,topic,qos,retained) -> int - Kategorie: Methode
- Parameter:
message:stringstring-Typ,Zu pushende Nachrichttopic:stringstring-Typ,Ziel-Topic zum Pushenqos:intint-Typ,Push-QoS, 0 oder 1 oder 2retained:intint-Typ,Ob behaltene Nachricht, 0 oder 1
- Rückgabe:
intGibt Push-Status zurück, 0 für ok, sonst ungleich 0 für Verbindungsfehler
8.1.5.3 Aktuellen Serververbindungsstatus prüfen
- Definition:
CheckConnect() -> int - Kategorie: Methode
- Rückgabe:
intGibt Verbindungsstatus zurück, 0 für ok, sonst ungleich 0 für Verbindungsfehler
8.1.5.4 Topic abonnieren
- Definition:
Subscribe(topic,qos) -> int - Kategorie: Methode
- Parameter:
topic:stringstring-Typ,Zu abonnierendes Topicqos:intint-Typ,0 oder 1 oder 2
- Rückgabe:
intGibt Push-Status zurück, 0 für ok, sonst ungleich 0 für Verbindungsfehler
8.1.5.5 Mqtt-Serveradresse
- Definition:
address - Kategorie: Eigenschaft
- Typ: string
- Beschreibung: Format: tcp://127.0.0.1:1883
8.1.5.6 Mqtt-Authentifizierungs-Benutzername
- Definition:
username - Kategorie: Eigenschaft
- Typ: string
8.1.5.7 Mqtt-Authentifizierungs-Benutzername
- Definition:
username - Kategorie: Eigenschaft
- Typ: string
8.1.5.13 Mqtt-Testament-QoS
- Definition:
will_qos - Kategorie: Eigenschaft
- Typ: int
- Beschreibung: 0 oder 1 oder 2
8.1.5.14 Aktueller Mqtt-Verbindungsstatus
- Definition:
connected - Kategorie: Eigenschaft
- Typ: Bool
- Beschreibung: Aktueller Verbindungsstatus, true / false
8.1.5.15 Mqtt-Connected-Ereignis
- Definition:
on_connect - Kategorie: Eigenschaft
- Typ: function()
- Beschreibung: Wird aufgerufen, wenn die Mqtt-Serververbindung erfolgreich ist, keine Parameter
8.1.5.16 Mqtt-Disconnected-Ereignis
- Definition:
on_disconnect - Kategorie: Eigenschaft
- Typ: function()
- Beschreibung: Wird aufgerufen, wenn der Mqtt-Server getrennt wird, keine Parameter
8.1.5.17 Mqtt-Abonnachrichten-Ereignis
- Definition:
on_message - Kategorie: Eigenschaft
- Typ: function(topic,message)
- Parameter:
topic:stringstring-Typ,Topic der empfangenen Abonnementnachrichtmessage:stringstring-Typ,Inhalt der empfangenen Abonnementnachricht
- Beschreibung: Wird ausgelöst, wenn Mqtt eine Abonnementnachricht empfängt, empfängt zwei Parameter