Shelly Door/window goes Homematic - with the original firmware

©2019 Stefan K. (alias 66er)

Attention:

This coupling is no longer executable with the firmware 1.6.3

Hello everybody,

to integrate the Shelly Door / Window in Homematic, you don't need any 3rd party firmware that you have to flash.

Below is my solution with the original firmware:

techn. requirements:

• compatible with the Homematic systems CCU2, CCU3, Charly, as well as all offshoots such as RaspberryMatic and piVCCU.
• installed addon CUxD in current version
  (At this point, I assume that I know how to use CUxD, e.g. how to create devices, otherwise this manual "explodes". Thank you for your understanding.)

The advantages from my point of view:

• very low price (19.90 €) compared to the Homematic original (from 29.95 €)

• more properties can be used

• all Shelly Door / Window properties are retained because I operate the Shelly with the original manufacturer firmware

• all future Shelly Door / Window updates / updates will be available

• full Shelly app usability parallel to Homematic automation

• Operation as a local solution or via Shelly cloud, additionally Homematic

So far I have implemented the following functions on the Homematicsystem:

• Status display of the magnetic contact (open / closed)

• Update of the integrated values with every transmission (battery status, brightness)

• Optional monitoring of the cycl. reporting = failure monitoring and in case of failure e.g. email delivery

The view of the connection:

I would like to recommend you, especially beginners, to take a look at this thread before implementing:

• Important information about the Shelly couplings on Homematic
• Shelly with activated restricted login & homematic coupling

Please follow the instructions carefully from top to bottom when copying.

Otherwise, as always:

If not yet available, please create a device (28) System Exec! The commands are issued above this. (No entries are made in the CUxD-Exec!) 

Have fun and good luck with it.

Query start and (optional) failure monitoring:

Of cause the Shelly Door / Window is also battery operated, it is only online when it is sending data.

In order for Homematic to know the time of transmission and to update the data accordingly, we first need a system variable that is updated by Shelly when it is sent.

This system variable (here: Shelly-MK_Ausfall_WeFi) as well as the other variables must be created in advance:

Now we need the actions in the Shelly Door / Window that serve as the trigger for the update process:

The entry:

http://192.168.1.93:8181/x.exe?Antwort=dom.GetObject("Shelly-MK_Ausfall_WeFi").State(1)

Adapt the IP of the CCU and the name of the system variable to your own system. 

Every time the Shelly is sent, the failure variable is updated, which we can now use as a trigger for updating the values in Homematic.

However, since failure monitoring can also be optionally implemented with this variable, let's look at this first.

We need a free channel of an existing device "CUxD-Timer" or create a new timer

The time entry (preset) corresponds to 13 hours. The value may have to be adjusted later.

(Since the official document for the Shelly Door / Window is not yet available, I assume a 12 hour interval for "routine reporting" of the Shelly.)

And a program:

The timer is reset every time the Shelly has sent any data. The variable keeps the value "in order".

(Later in this program, the values are updated via another THEN line.)

You can do without the optional ELSEIF branch. I use it for an email notification if the Shelly fails.

Data transfer in Homematic:

And now we come to the essentials.

We create a 16-channel universal control in CUxD:

A maximum of 16 Shelly Door / Windows can be mapped in Homematic with one 16-channel universal control . We need 1 channel for each Shelly Door / Window.

The system variables desired in the view are linked to the channel (see picture in # 1) so that they become visible in the channel.

We extend our program from # 2 in the THEN branch of the 1st IF condition by a 2nd line that executes the update script. It looks like this in the detail:

And last but not least, the script, which is to be worked through from top to bottom as usual. And as specified, IP of the Homematic, CUxD device address and CUxD Exec address must be adjusted:

!Skript V2.1.0 zur Statusaktualisierung ShellyDoor Window mit Originalfirmware (c) 2020 by 66er  (alias Stefan.K)
!Raumbezeichnung WZ    Raum  (kann angepasst werden)


!**** SETUP ******** SETUP ******** SETUP ******** SETUP ***

! Setup der CUxD-GERÄTE
var url = "http://192.168.1.129/status"; !  IP-Adresse des Shelly Door Window anpassen 
var exec = "CUxD.CUX2801001:13";   ! Adresse und Kanal des CUxD-Exec-Device angeben
var shelly =  "CUxD.CUX4000012:2" ;  ! Adresse und Kanal des CUxD-Device für den Shelly D/W anpassen


!Setup der SYSTEMVARIABLEN
var mkbat = "Shelly-MK_Batt_WZ";  ! Name der Systemvariablen anpassen, "" bleiben stehen
var mklux = "Shelly-MK_Helligkeit_WZ"; !Name der Systemvariablen anpassen, "" bleiben stehen

!****END of SETUP ********END of SETUP ********ENDof SETUP *


!*****No Changes from here *****

dom.GetObject(""#exec#".CMD_SETS").State("wget -q -O - '"#url#"'");
dom.GetObject(""#exec#".CMD_QUERY_RET").State(1);
string Antwort = dom.GetObject(""#exec#".CMD_RETS").State();
dom.GetObject(""#exec#".CMD_SETS").State("0");  
!WriteLine(Antwort);
string t = (Antwort);
WriteLine(t)


!***Auswertung MK ****
string word = "state";
integer word_laenge = word.Length();
integer word_position = Antwort.Find(word);
string daten = Antwort.Substr((word_position + word_laenge +3), 4);
integer word_position = daten.Find(word);
daten = daten.Substr(0, (word_position -3));
Antwort = "true";
!WriteLine(daten);


!Auswertung MK
var zustand = dom.GetObject(""#shelly#".STATE").State();
!WriteLine(zustand);
if ((daten == "clos") && (zustand != false) )
{dom.GetObject(""#shelly#".SET_STATE").State(0);
!WriteLine("if ON");
}
if ((daten == "open") && (zustand != true))
{dom.GetObject(""#shelly#".SET_STATE").State(1);
!WriteLine("if off");
}


!****Auswertung des Antwortstrings für Batt  ****
string s;
foreach (s,t.Split (",")) {
   if (s.LTrim ("{").StartsWith ('"bat"')) {
   string bat =  (s.StrValueByIndex (":",2).RTrim ("}"));
!  WriteLine(bat);
   }
}  


!**** Variable setzen****
dom.GetObject(""#mkbat#"").State(bat);



!****Auswertung des Antwortstrings für Lux  ****

string s;
foreach (s,t.Split (",")) {
   if (s.LTrim ("{").StartsWith ('"lux"')) {
   string lux =  (s.StrValueByIndex (":",2).RTrim ("}"));
!  WriteLine(lux);
   }
}  



!**** Variable setzen****
dom.GetObject(""#mklux#"").State(lux);


daten = "0";


!Ende Skript

And now good luck with the reconstruction and above all have fun with it.

____________________________________________________________

The instructions including the scripts and pictures are subject to copyright. Anyone who infringes the copyright (for example, pictures or texts illegally copied and published on other websites), according to §§ 106 ff UrhG punishable, can also be warned for a fee and must pay damages (§ 97 UrhG).

© 2019 Stefan K. (aka 66er)

All rights reserved

-- reserved --

For information:

The update script was released in a new version today.

Reason:

• simplified setup (adapting the CUxD addresses etc.)
• Prepare for new features