Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung | ||
manuals:symcon:mqtt-integration [2017/08/04 17:47] – paulg4h | manuals:symcon:mqtt-integration [2018/09/23 19:15] (aktuell) – paulg4h | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
====== MQTT in Symcon Einbinden ====== | ====== MQTT in Symcon Einbinden ====== | ||
+ | |||
+ | <WRAP center round info 60%> | ||
+ | Stand September 2018, IPS 4.4 | ||
+ | </ | ||
+ | |||
Diese Anleitung zeigt wie man auf einem Raspberry PI 3 das MQTT Protokoll über Mosquitto und mqttwarn in Symcon schreibend und per Modul auch Beschreibbar ist. Also in beide Richtungen Ereigniss Basierend kommuniziert so wie ich es schon seit einem halben Jahr Produktiv mit diversen Arduinos und ESP8266 (PubSub Library) einsetze. | Diese Anleitung zeigt wie man auf einem Raspberry PI 3 das MQTT Protokoll über Mosquitto und mqttwarn in Symcon schreibend und per Modul auch Beschreibbar ist. Also in beide Richtungen Ereigniss Basierend kommuniziert so wie ich es schon seit einem halben Jahr Produktiv mit diversen Arduinos und ESP8266 (PubSub Library) einsetze. | ||
Zeile 7: | Zeile 12: | ||
**Auch müssen alle Werte in < | **Auch müssen alle Werte in < | ||
- | </ | ||
- | |||
- | <WRAP center round info 90%> | ||
- | Nachdem Symcon ja Debian auf x86 Hardware nicht Unterstütz (werd ich nie verstehen) sondern nur Ubuntu und da die jetzt schon sehr alte 14.04er habe ich soeben ein paar Ergänzungen in der Anleitung gemacht und die MQTT integration nun auch auf Ubuntu Installiert (Stand Jänner 2017) | ||
</ | </ | ||
Zeile 40: | Zeile 41: | ||
===== Pakete Installieren ===== | ===== Pakete Installieren ===== | ||
+ | Einen MQTT Broker z.B. das Paket mosquitto Installieren | ||
+ | aptitude install mosquitto mosquitto_pub mosquitto_sub | ||
+ | | ||
===== Symcon Vorbereiten ===== | ===== Symcon Vorbereiten ===== | ||
- | Nach der Installation von IPS dort in einer Kategorie z.b. Datenpunlte/ | ||
- | < | ||
- | <? | ||
- | $d = false; $msg = ""; | ||
- | $value = ""; | ||
- | if ($d){ $msg .= " | ||
- | //if (($_IPS[' | ||
- | if ($_IPS[' | ||
- | | ||
- | if ($value == $_IPS[' | ||
- | $msg .= " | ||
- | $run = false; | ||
- | } | ||
- | } | ||
- | if (($_IPS[' | ||
- | | ||
- | } | ||
- | if ($d){ $msg .= " | ||
- | $id = $_IPS[' | ||
- | $topic = explode(";", | ||
- | if((strlen($topic) > 3) and ($run)){ | ||
- | switch(IPS_GetVariable($id)[' | ||
- | case 0: //boolean | ||
- | if($value == 1){ $value = " | ||
- | break; | ||
- | case 1: //Integer | ||
- | | + | ==== MQTT Client zum Senden in Symcon Installieren ==== |
- | case 2: //float | + | Zum Senden von Daten per MQTT_Publish aus jedem script: |
+ | https:// | ||
- | | ||
- | case 3: //string | ||
- | break; | + | ==== Mosquitto an Symcon Anbinden ==== |
- | } | + | |
- | if($d){ $msg .= "veröffentliche: ".$value." | + | Eine Kategorie anlegen |
- | | + | Datenpunkte/ |
+ | |||
+ | In diesem Knoten werden dann alle Geräte und Datenpunkte Automatisch erstellt / Aktualisiert, | ||
+ | Datenpunkte/ | ||
+ | und erstellen das Script " | ||
+ | |||
+ | Die Datei: | ||
+ | Datenpunkte/ | ||
+ | |||
+ | mit folgendem Inhalt: | ||
+ | <code php><? | ||
+ | include_once(IPS_GetScript(42011 )[" | ||
+ | |||
+ | $d = true; $msg = ""; | ||
+ | $value = ""; | ||
+ | |||
+ | if ($d){ | ||
+ | $msg .= "Sender: ".$_IPS[' | ||
+ | $msg .= print_r($_IPS, | ||
+ | } | ||
+ | |||
+ | if ($_IPS[' | ||
+ | //On Manual Execute check child events and set Event Trigger to "On Change" | ||
+ | foreach (IPS_GetChildrenIDs($_IPS[' | ||
+ | if (IPS_GetObject($value)[' | ||
+ | IPS_SetEventTrigger($value, | ||
+ | } | ||
+ | } | ||
+ | } else { | ||
+ | if (($_IPS[' | ||
+ | if ($_IPS[' | ||
+ | //$value = (GetValueBoolean($_IPS[' | ||
+ | $value = ($_IPS[' | ||
+ | } | ||
+ | if (($_IPS[' | ||
+ | $value = ($_IPS[' | ||
+ | } | ||
+ | |||
+ | if (($value == (GetValueBoolean($_IPS[' | ||
+ | if($d){ $msg .= " | ||
+ | $run = false; | ||
+ | } | ||
+ | |||
+ | if ($d){ | ||
+ | $msg .= " | ||
+ | } | ||
+ | |||
+ | $topic = explode(";", | ||
+ | |||
+ | if((strlen($topic) > 3) and ($run)){ | ||
+ | if ($d){ | ||
+ | $msg .= " | ||
+ | $msg .= " | ||
+ | $msg .= " | ||
+ | $msg .= " | ||
+ | } | ||
+ | MQTT_Publish($idMQTTBroker | ||
+ | } | ||
+ | } | ||
} | } | ||
- | |||
- | if ($d){ $msg .= " | ||
- | |||
| | ||
| | ||
} | } | ||
- | ?> | + | ?></ |
- | </ | + | |
- | Das Zweite | + | Das Eigentliche Script welces die Daten per RPC vom mqttwarn Daemon entgegennimmt und ablegt, |
- | <code php><? | + | |
- | $d = false; $msg = ""; | + | <code php> <? |
+ | $d = true; $msg = ""; | ||
//sample value: devices/ | //sample value: devices/ | ||
// mqtt topic to symcon variable id mapping | // mqtt topic to symcon variable id mapping | ||
$idParent = IPS_GetParent($_IPS[' | $idParent = IPS_GetParent($_IPS[' | ||
- | $archiveId = <archiv id> / | + | $archiveId = 32289; |
- | $relaisScriptId = <id des Relais scripts> / | + | $relaisScriptId = 17676; //Relais Script ID |
// get value from mqtt variable | // get value from mqtt variable | ||
- | $var = $_IPS[' | + | if( array_key_exists(" |
- | $varsplit = explode(";", | + | |
- | + | | |
- | if(count($varsplit)> | + | $payload |
- | $topics = explode("/", | + | |
- | $topic=$varsplit[0]; | + | |
- | $payload=$varsplit[1]; | + | |
- | $payload = str_replace(array(" | + | if ($d){ $msg .= " |
- | + | ||
- | if ($d){ $msg .= " | + | // Datentyp der payload herausfinden und ins Format für IPS Übersetzen |
- | + | | |
- | // Datentyp der payload herausfinden und ins Format für IPS Übersetzen | + | if (is_float($payload+0)){ |
- | $contType = 99; | + | |
- | if (is_float($payload+0)){ | + | |
- | //Float | + | } |
- | $contType = 2; | + | if (($contType == 99) and (is_numeric($payload))){ |
- | } | + | |
- | if (($contType == 99) and (is_numeric($payload))){ | + | |
- | //Integer | + | } |
- | $contType = 1; | + | if (($contType == 99) and (is_string($payload))){ |
- | } | + | if ((strtolower($payload) == " |
- | if (($contType == 99) and (is_string($payload))){ | + | //Boolean |
- | if ((strtolower($payload) == " | + | $contType = 0; |
- | //Boolean | + | } else { |
- | $contType = 0; | + | //String |
- | } else { | + | $contType = 3; |
- | //String | + | } |
- | $contType = 3; | + | } |
- | } | + | $idf = $idParent; |
- | } | + | // |
- | $idf = $idParent; | + | |
- | //Pfad durchlaufen und Prüfen ob die Kategorien / Variablen vorhanden sind und bei bedarf Anlegen | + | if ($i == (count($topics) -1)){ |
- | for($i = 0; $i < count($topics); | + | $type = 2; |
- | if ($i == (count($topics) -1)){ | + | } else { |
- | | + | $type = 0; |
- | } else { | + | } |
- | $type = 0; | + | $idf = checkIfElementExists($idf, |
- | } | + | } |
- | $idf = checkIfElementExists($idf, | + | |
- | } | + | |
- | + | | |
- | if($d){ | + | |
- | $msg .= " | + | } |
- | $msg .= "Set Itend to: " | + | |
- | } | + | |
- | + | ||
- | // | + | // |
- | IPS_SetIdent($idf, | + | SetValue($idf, |
- | + | ||
- | //Wert Setzen | + | |
- | mqset($idf, $payload); | + | |
- | + | ||
} | } | ||
- | if (strlen($msg) > 0){ | + | if ((strlen($msg) > 0) and ($d)){ |
| | ||
print $msg; | print $msg; | ||
- | } else { | + | } |
- | IPS_LogMessage(" | + | IPS_LogMessage(" |
- | } | + | |
} | } | ||
Zeile 169: | Zeile 195: | ||
function mqset($id, $value){ | function mqset($id, $value){ | ||
- | switch(IPS_GetVariable($id)[" | + | Global $msg, $d; |
- | case 0: // boolean | + | if(GetValue($id) != $value){ |
- | $val = filter_var($value, | + | switch(IPS_GetVariable($id)[" |
- | SetValue($id, | + | case 0: // boolean |
- | break; | + | $val = filter_var($value, |
- | case 1: // integer | + | if($d){ $msg .= "val: " |
- | $val = intval($value); | + | SetValue($id, |
- | SetValue($id, | + | break; |
- | break; | + | case 1: // integer |
- | case 2: // float | + | $val = intval($value); |
- | $val = floatval($value); | + | SetValue($id, |
- | SetValue($id, | + | break; |
- | break; | + | case 2: // float |
- | case 3: // string | + | $val = floatval($value); |
- | SetValue($id, | + | SetValue($id, |
- | break; | + | break; |
+ | case 3: // string | ||
+ | SetValue($id, | ||
+ | break; | ||
+ | } | ||
} | } | ||
} | } | ||
Zeile 214: | Zeile 244: | ||
} | } | ||
IPS_SetName($id, | IPS_SetName($id, | ||
- | IPS_SetParent($id, | + | |
- | if($type == 2){ // Variable | + | if($type == 2){ // Variable |
- | | + | |
- | if (strpos(" | + | if (strpos(" |
- | | + | |
- | | + | |
- | | + | |
- | } elseif(strpos(" | + | } elseif(strpos(" |
- | IPS_SetVariableCustomProfile($id, | + | |
- | } elseif ($name == " | + | } elseif ($name == " |
- | IPS_SetVariableCustomProfile($id, | + | |
- | } else { | + | } else { |
- | //Wenn es eine Boolean Variable ist das Profile ~Switch zuweisen | + | |
- | IPS_SetVariableCustomProfile($id, | + | |
- | IPS_SetVariableCustomAction($id, | + | |
- | checkCreateEvent($id, | + | |
- | } | + | } |
- | } | + | |
- | if (strpos(" | + | |
- | | + | IPS_SetVariableCustomProfile($id, |
- | } | + | |
- | if (strpos(" | + | |
- | | + | IPS_SetVariableCustomProfile($id, |
- | } | + | |
- | if (strpos(" | + | |
- | | + | IPS_SetVariableCustomProfile($id, |
- | } | + | |
IPS_SetInfo($id, | IPS_SetInfo($id, | ||
// | // | ||
- | | + | AC_SetLoggingStatus($archiveId, |
- | IPS_ApplyChanges($archiveId); | + | |
} | } | ||
} | } | ||
Zeile 269: | Zeile 299: | ||
} | } | ||
if ($create){ | if ($create){ | ||
- | //Event Anlegen | + | |
- | $eid = IPS_CreateEvent(0); | + | $eid = IPS_CreateEvent(0); |
- | IPS_SetEventTrigger($eid, | + | IPS_SetEventTrigger($eid, |
- | IPS_SetParent($eid, | + | IPS_SetParent($eid, |
IPS_SetEventActive($eid, | IPS_SetEventActive($eid, | ||
} | } | ||
Zeile 278: | Zeile 308: | ||
?></ | ?></ | ||
- | hier noch das switch Script damit sind " | + | ==== MQTT Broker |
- | + | aptitude install mosquitto mosquitto-clients python-pip | |
- | <code php><? | + | |
- | $d = false; $msg = ""; | + | |
- | $value | + | |
- | if ($d){ $msg .= " | + | |
- | //if (($_IPS[' | + | |
- | if ($_IPS[' | + | |
- | | + | |
- | if ($value == $_IPS[' | + | |
- | $msg .= " | + | |
- | $run = false; | + | |
- | } | + | |
- | } | + | |
- | if (($_IPS[' | + | |
- | | + | |
- | } | + | |
- | if ($d){ $msg .= " | + | |
- | $id = $_IPS[' | + | |
- | $topic = explode(";", | + | |
- | if((strlen($topic) > 3) and ($run)){ | + | |
- | switch(IPS_GetVariable($id)[' | + | |
- | case 0: //boolean | + | |
- | if($value == 1){ $value = " | + | |
- | break; | + | |
- | case 1: //Integer | + | |
- | + | ||
- | | + | |
- | case 2: //float | + | |
- | + | ||
- | | + | |
- | case 3: //string | + | |
- | + | ||
- | | + | |
- | } | + | |
- | if($d){ $msg .= " | + | |
- | MQTT_Publish(50729 / | + | |
- | } | + | |
- | + | ||
- | if ($d){ $msg .= " | + | |
- | + | ||
- | | + | |
- | | + | |
- | } | + | |
- | + | ||
- | ?></ | + | |
- | + | ||
- | ==== Mosquitto | + | |
- | aptitude install mosquitto mosquitto-clients python-pip -y | + | |
| | ||
==== mqttwarn (mqtt daemon der alle Ereignisse zu Symcon weiterleitet) ==== | ==== mqttwarn (mqtt daemon der alle Ereignisse zu Symcon weiterleitet) ==== | ||
Zeile 402: | Zeile 385: | ||
[devices/#] | [devices/#] | ||
- | targets = http: | + | targets = log: |
template = ipsrpc.json | template = ipsrpc.json | ||
</ | </ | ||
Zeile 416: | Zeile 399: | ||
vi ipsrpc.json | vi ipsrpc.json | ||
mit folgendem Inhalt erstellen: | mit folgendem Inhalt erstellen: | ||
- | < | + | < |
- | | + | ' |
- | ' | + | ' |
- | ' | + | ' |
- | ' | + | ' |
- | ' | + | } |
- | } | + | |
%} | %} | ||
{{ data | jsonify }}</ | {{ data | jsonify }}</ |