MELCloud — ReadMe

ÜBERSICHT   —   FREISCHALTUNG  —   SCREENSHOTS

1. Funk­tion­sum­fang
2. Sys­te­man­forderun­gen
3. Instal­la­tion
4. Befehlsref­erenz

1. Funktionsumfang

Mit diesem Mod­ul lassen sich Geräte von Mit­subishi, die über den Online-Dienst "MEL­Cloud" ver­füg­bar sind, ausle­sen und steuern. Aktuell wer­den nur Kli­maan­la­gen unter­stützt, das Mod­ul kann aber auf Wun­sch jed­erzeit für Wärmepumpen oder andere Geräte erweit­ert wer­den. Neben dem Ausle­sen und Visu­al­isieren von Geräte-Infor­ma­tio­nen kön­nen auch alle Funk­tio­nen der Geräte ges­teuert wer­den, dazu zählen unter anderem die Betrieb­sart (Kühlen, Heizen, …) oder auch das Aktivieren von in der MEL­Cloud fest­gelegten Voreinstellungen.

Wenn in der MEL­Cloud Vor­e­in­stel­lun­gen (max­i­males Kühlen, Nacht­be­trieb, …) vorgenom­men wur­den, wer­den diese automa­tisch aus­ge­le­sen und kön­nen über WebFront/App, oder auch eine Funk­tion in einem eige­nen Skript, aktiviert werden.

Je nach­dem welche Funk­tio­nen bei einem Gerät zur Ver­fü­gung ste­hen, kön­nen die angezeigten Vari­ablen und Steuerungsmöglichkeit­en vari­ieren. Für jedes Geräte wer­den bei der Erstel­lung der Geräte Instanz alle notwendi­gen Infor­ma­tio­nen aus­ge­le­sen und die für diese Gerät passenden Vari­ablen und Vari­ablenpro­file automa­tisch erstellt.

Bei der Ver­wen­dung fast aller Funk­tio­nen in eige­nen Skripten wer­den im Hin­ter­grund direkt die Vari­ablen von ein­er oder sog­ar allen Geräte Instanzen aktualisiert.

In der I/O Instanz ist ein Timer ein­stell­bar, welch­er sich um die Aktu­al­isierung aller Geräte­dat­en und ‑infor­ma­tio­nen kümmert.

Geräte Instanz:

• Geräte-Name, Geräte-ID, Geräte-Typ, Gebäude-Name, Stock­w­erks-Name, Bereichs-Name
• Aktivierung zusät­zlich­er Vari­ablen mit Sys­tem-Infor­ma­tio­nen (Diag­nose­modus, Firmware-Ver­sio­nen, MAC-Adresse, Seri­en­num­mer, WLAN-Informationen, …)
• Aktivierung des Geräte-Bildes (nur wenn man in der MEL­Cloud ein eigenes Foto hochge­laden hat)
• Bedi­enung sper­ren (Wartungsmodus)

I/O Instanz:

• E‑Mail
• Pass­wort
• Inter­vall für die Aktu­al­isierung der Gerätedaten
• Verbindung zur MEL­Cloud sper­ren (Wartungsmodus)

Konfigurator Instanz:

• Kat­e­gorie zur Erstel­lung der Geräte-Instanz(en)
• Liste aller in der MEL­Cloud ver­füg­baren Geräte
• Knöpfe zum Erstellen von nicht vorhan­de­nen Geräte-Instanzen (wenn noch nicht erstellt)

2. Systemanforderungen

• IP-Sym­con ab Ver­sion 4.3

3. Installation

Über die Kern-Instanz "Mod­ule Con­trol" fol­gende URL hinzufügen:

https://GITLAB-BENUTZERNAME:GITLAB-PASSWORT@gitlab.com/BY-IPS-Module/MELCloud.git

Nach dem Hinzufü­gen der URL kann die Instanz "MEL­Cloud Kon­fig­u­ra­tor" erstellt wer­den. Diese Instanz erstellt automa­tisch eine I/O Instanz, in der die Zugangs­dat­en zur MEL­Cloud kon­fig­uri­ert wer­den müssen. Ist die I/O Instanz erfol­gre­ich kon­fig­uri­ert und ver­bun­den, muss die Kon­fig­u­ra­tor Instanz neu geöffnet wer­den, damit die ver­füg­baren Geräte aus der MEL­Cloud aus­ge­le­sen und angezeigt werden.
Alter­na­tiv kann natür­lich auch erst die I/O Instanz erstellt und kon­fig­uri­ert — und danach die Kon­fig­u­ra­tor Instanz erstellt und geöffnet werden. 

Jedes Gerät im Kon­fig­u­ra­tor, dass noch nicht als Geräte-Instanz angelegt wurde, kann ein­fach über den entsprechen­den Knopf im Kon­fig­u­ra­tor (unter­halb der Geräte-Liste) als Instanz erstellt werden.
HINWEIS: Nach dem Betäti­gen des Knopfes, zum Erstellen ein­er Geräte Instanz, kön­nen einige Sekun­den verge­hen, bis ein Pop­up-Fen­ster die erfol­gre­iche Erstel­lung und Kon­fig­u­ra­tion der Geräte Instanz bestätigt (hier bitte ggf. etwas Geduld haben). 

Alle Geräte die in der MEL­Cloud gefun­den wer­den und bere­its als Geräte Instanz erstellt wur­den, sind in der Liste grün hin­ter­legt. Geräte die als Geräte Instanz angelegt sind, aber in der MEL­Cloud nicht gefun­den wer­den, sind in der Liste rot hinterlegt.
HINWEIS: Nach "Änderungen/Aktionen" in der Kon­fig­u­ra­tor Instanz, muss diese erst geschlossen und neu geöffnet wer­den, damit die getätigten "Änderungen/Aktionen" in der Liste sicht­bar werden.

4. Befehlsreferenz

Geräte Instanzen:

MEL_Update(int $InstanzID);
Liest alle Dat­en aus und aktu­al­isiert direkt die entsprechen­den Vari­ablen. Zurück­gegeben wird TRUE oder FALSE.

MEL_Device_GetData(int $InstanzID);
Liest Geräte­dat­en aus und aktu­al­isiert direkt die entsprechen­den Vari­ablen. Zurück­gegeben wird FALSE oder ein Array mit den Gerätedaten.

MEL_Device_GetDataRAW(int $InstanzID);
Liest alle Geräte­dat­en aus und aktu­al­isiert direkt die entsprechen­den Vari­ablen. Zurück­gegeben wird FALSE oder ein Array mit den Gerätedaten.

MEL_Device_GetListInfo(int $InstanzID);
Liest Geräte­in­for­ma­tio­nen aus und aktu­al­isiert direkt die entsprechen­den Vari­ablen. Zurück­gegeben wird FALSE oder ein Array mit Infor­ma­tio­nen. Wie die Funk­tion "MEL_Devices_GetList", nur wer­den hier nur die Infor­ma­tio­nen zum jew­eili­gen Gerät zurückgegeben.

MEL_Device_GetImage(int $InstanzID);
Liest das Bild vom Gerät aus (nur möglich, wenn ein eigenes Bild in der MEL­Cloud hochge­laden wurde). Zurück­gegeben wird FALSE oder ein Array mit dem Head­er vom Bild und dem Bild selb­st (base64 kodiert).

MEL_Device_GetPresets(int $InstanzID);
Liest alle in der MEL­Cloud fest­gelegten Vor­e­in­stel­lun­gen aus und aktu­al­isiert das zuge­hörige Vari­ablenpro­fil (wird im Hin­ter­grund auch automa­tisch erledigt und muss nicht zusät­zlich manuell durchge­führt wer­den). Zurück­gegeben wird FALSE oder ein Array mit den Voreinstellungen.

MEL_Devices_GetList(int $InstanzID);
Liest Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus und aktu­al­isiert mit den zurück­gegeben Dat­en auch direkt die entsprechen­den Vari­ablen aller Geräte. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

MEL_Devices_GetListRAW(int $InstanzID);
Liest alle Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

MEL_DeviceInstance_Configuration(int $InstanzID, string $BuildingID, string $Devi­ceID, string $Device­Type);
Mit dieser Funk­tion kann man eine Geräte Instanz kon­fig­uri­eren. Legt man eine Geräte Instanz selb­st­ständig ohne Kon­fig­u­ra­tor an, dann muss diese Instanz mit dieser Funk­tion kon­fig­uri­ert wer­den. Die Funk­tion wird vom Kon­fig­u­ra­tor ver­wen­det, um eine erstellte Instanz automa­tisch kon­fig­uri­eren zu kön­nen. Zurück­gegeben wird FALSE oder TRUE.

MEL_FanSpeed_Set(int $InstanzID, int $FanSpeed);
Funk­tion zum Set­zen der gewün­scht­en Lüftergeschwindigkeit von Stufe 1 bis 5 (kann je nach Mod­ell vari­ieren). Zurück­gegeben wird FALSE oder TRUE.

MEL_OperationMode_Set(int $InstanzID, int $Oper­a­tion­Mode);
Funk­tion zum Set­zen der gewün­scht­en Betrieb­sart. Zurück­gegeben wird FALSE oder TRUE. Betrieb­sarten für Klimaanlagen: 

• 1 = Heizbetrieb
• 3 = Kühlbetrieb
• 7 = Gebläselüfter
• 8 = Automatik

MEL_PowerState_Set(int $InstanzID, bool $Pow­er­State);
Funk­tion zum Auss­chal­ten (false) und Ein­schal­ten (true) des Gerätes. Zurück­gegeben wird FALSE oder TRUE.

MEL_Preset_Set(int $InstanzID, int $Pre­set);
Funk­tion zum Set­zen ein­er in der MEL­Cloud fest­gelegten Vor­e­in­stel­lung. Zurück­gegeben wird FALSE oder TRUE. Zum Ermit­teln der Nummer/ID ein­er bes­timmten Vor­e­in­stel­lun­gen kann die Funk­tion "MEL_GetPresets" ver­wen­det werden.

MEL_Temperature_Set(int $InstanzID, float $Tem­per­a­ture);
Funk­tion zum Set­zen der gewün­scht­en SOLL-Tem­per­atur (min. und max. Tem­per­atur vari­ieren je nach Betrieb­sart). Zurück­gegeben wird FALSE oder TRUE.

MEL_VaneHorizontal_Set(int $InstanzID, int $val­ue);
Funk­tion zum Ein­stellen der hor­i­zon­tal­en Schaufel. Zurück­gegeben wird FALSE oder TRUE. 

• 0 = Auto
• 1 bis max. 5 = Schaufel­stel­lung (abhängig vom Geräte-Typ/­Mod­ell)
• 12 = Schwin­gen (muss vom Gerät unter­stützt werden)

MEL_VaneVertical_Set(int $InstanzID, int $val­ue);
Funk­tion zum Ein­stellen der ver­tikalen Schaufel. Zurück­gegeben wird FALSE oder TRUE. 

• 0 = Auto
• 1 bis max. 5 = Schaufel­stel­lung (abhängig vom Geräte-Typ/­Mod­ell)
• 7 = Schwin­gen (muss vom Gerät unter­stützt werden)

MEL_Weather_Get(int $InstanzID);
Liest die in der MEL­Cloud ver­füg­baren Wet­ter­dat­en aus (aktuelle Dat­en und Vorher­sage). Zurück­gegeben wird FALSE oder ein Array mit Wetterdaten.

I/O Instanz:

MELIO_Device_GetDataRAW(int $InstanzID, string $BuildingID, string $Devi­ceID);
Liest alle Geräte­dat­en aus und aktu­al­isiert direkt die entsprechen­den Vari­ablen. Zurück­gegeben wird FALSE oder ein Array mit den Gerätedaten.

MELIO_Device_GetImage(int $InstanzID, string $BuildingID, string $Devi­ceID);
Liest das Bild vom Gerät aus (nur möglich, wenn ein eigenes Bild in der MEL­Cloud hochge­laden wurde). Zurück­gegeben wird FALSE oder ein Array mit dem Head­er vom Bild und dem Bild selb­st (base64 kodiert).

MELIO_Devices_GetList(int $InstanzID);
Liest Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus und aktu­al­isiert mit den zurück­gegeben Dat­en auch direkt die entsprechen­den Vari­ablen aller Geräte. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

MELIO_Devices_GetListRAW(int $InstanzID);
Liest alle Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

MELIO_Timer_Control(int $InstanzID, 'Update_GetList', int $TimerOp­tion);
Funk­tion zur Steuerung des Modul-Timers. 

• 0 = Timer anhalten
• 1 = Timer starten (mit dem in der Instanz eingestell­ten Intervall)

Konfigurator Instanz:

MELC_Devices_GetList(int $InstanzID);
Liest Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus und aktu­al­isiert mit den zurück­gegeben Dat­en auch direkt die entsprechen­den Vari­ablen aller Geräte. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

MELC_Devices_GetListRAW(int $InstanzID);
Liest alle Infor­ma­tio­nen von in der MEL­Cloud ver­füg­baren Geräte aus. Zurück­gegeben wird FALSE oder ein Array mit Informationen.

> ALLGEMEINER HINWEIS ZU DEN BEFEHLEN: Wird eine Funk­tion oder ein Wert von einem Gerät nicht unter­stützt, dann kommt im Debug eine entsprechende Ausgabe.