Shelly Flood goes Homatic- with original firmware

© 2019 Stefan K. (aka 66er) - detailed information about this at the end of the manual (#3)

#1 Introduction

#2 failure monitoring

#3 Data transfer in Homematic

Hello everybody,

It was a very stony way, but below I can now introduce my solution with the original firmware.

The implementation of the transmit-detection was the first hurdle. Details were explained at this point.(only in German)

technical requirements:

• compatible with the homematic systems CCU2, CCU3, Charly, as well as all offshoots like RaspberryMatic and piVCCU.

• installed add-on CUxD
  (The knowledge about the handling CUxD, such as devices create, I assume at this point, otherwise "exploded" this guide Thank you for understanding.)

The advantages from my point of view:

• all Shelly Flood features are preserved, as I operate all the actuators and sensors with the original manufacturer firmware

• all future Shelly Flood updates will be usable

• Full Shelly app usability in parallel with homematic automation

• Operation as local solution or via Shelly-Cloud, additionally Homemati

The only compelling disadvantage is a shorter battery life! 

I implemented the following functions on the Homematic page:

• Display of status (sleep or alarm condition)

• battery status

• Temperature (at the time of the last transmission)

• in addition to the possibilities of the cloud: failure monitoring

A view of the connection:

Why the integration as a switch:

It would have been nicer to present the Shelly Flood as a threat detector in Homematic. Why this does not work, I have already explained in this thread.(only in German)

After much trial and error (hence the name "VG Shelly Flood V4 in the picture), this solution seemed to me the most plausible:

OFF -> no alarm

ON -> water alarm

I would like to recommend you, especially newcomers, at this point to take a look at this thread before the implementation:

• Important notes for the Shelly couplings on Homematic
  
• Preventive note for homematic users with firmware >=3.47.15
  
• Shelly with RESTRICT-LOGIN & Homematic
  

It should also be noted that the procedure of the transmitter detection is completely different than known from previous couplings! In this respect, please work carefully from top to bottom when rebuilding the instructions.

as usual:

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

Have fun and success with it

In another thread,there was the question "How do I know if the Shelly flood fails and stops sending?" .

I have found a solution for homematic-user, which at the same time forms the basic for also getting the data of the Shelly Flood into the Homematic and for being able to process it there.

The principle of failure monitoring:

Meanwhile, the Shelly Flood sends a status message after 12 hours without any other events. This is recorded and if not available, a system variable is set after 13 hours without message / update, with which you can then send a push or e-mail message, however. Of course, any conceivable other homematic control can be activated.

The implementation:

We need a system variable that will later be assigned to the CUxD channel of the switch.

To set this to "no alarm", we use the "Actions" function of the Shelly Flood, which can only be set in the WEB UI via browser.

At this point, the hint that currently the data can not be transferred directly via Actions to Homematic.

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

Adapt the IP address to your own homematic center.

Adapt the name of the system variable.

Now we need 1 CUxD Timer-channel / Shelly Flood.

One channel of an existing CUxD timer can be used. Or you create your own CUxD timer device for the flood. Thus, with a device CUxD timer a maximum of 16 Shelly Flood could be monitored.

Create CUxD timer:

The used channel is preset as follows:

entry for SYSTEM|CMD_EXEC::

extra/timer.tcl Shelly-Flood_Ausfall_KG 0

Adapt the name of the system variable!

What happened so far is the following:

• The timer counts down the 13 hours

• If the Shelly answers during this time, the timer is reset to 13 hours

• If a message remains and the timer is set to "0", it sets the system variable to "Fail?" (or whatever text you have deposited.

We can use that to trigger a homematic program:

The IF section always resets the timer.

The Otherwise IF section will send (as an example) an email.

Thus, the failure monitoring is realized and created the basic for the data transfer Shelly-Flood -> Homematic.

Take over the data of the Shelly Flood in the Homematic

To take over the data of the Shelly Flood in Homematic, we need 2 more system variables, which are also assigned to the CUxD channel of the switch:

(Depending on the place of installation the temperature values can of course be adjusted)

The variables are assigned to the used channel of an existing or newly created (40) CUxD-16 universal control panel.

With 1 universal control a maximum of 16 Shelly Floods can be integrated.

Of cause there is nothing to operate on the Shelly Flood, no settings are made in the CUxD switch.

The data transfer:

In order to take over the data from the flood, the already created program has to be extended:

The script is still missing in the 1. IF:

!Skript V2.0 zum Werte auslesen Shelly-Flood mit Originalfirmware  (c) 2020 by 66er (Stefan K.)
! Shelly Flood KG Waschmaschine     (Standort kann angepasst werden)


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

! ACHTUNG: Beim Anpassen der Adressen keine "" löschen!

! Setup der CUxD-GERÄTE
var url = "http://192.168.1.145/status"; !  IP-Adresse des Shelly Flood anpassen 
var execf = "CUxD.CUX2801001:2";   ! Adresse und Kanal des CUxD-Exec-Device angeben
var shellyf =  "CUxD.CUX4000013:1" ;  ! Adresse und Kanal des CUxD-Device für den Shelly Flood anpassen


!Setup der SYSTEMVARIABLEN
var floodbat = "Shelly-Flood_Batt_KG-Waschmaschine";  ! Name der Systemvariablen anpassen
var floodtemp = "Shelly-Flood_Temp_KG-Waschmaschine"; !Name der Systemvariablen anpassen

!****No changes ********END of SETUP ********No changes ******


!*****Ab hier NICHTS MEHR ÄNDERN *****


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



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

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



!**** Variable setzen****
!Variablennamen anpassen (hier: Shelly-Flood_Temp_KG-Waschmaschine)
dom.GetObject(""#floodtemp#"").State(temp);



!****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****
!Variablennamen anpassen (hier: Shelly-Flood_Bat_KG-Waschmaschine)
dom.GetObject(""#floodbat#"").State(bat);



!Abfrage Alarm
string word = "flood";
integer word_laenge = word.Length();
integer word_position = Antwort.Find(word);
string daten = Antwort.Substr((word_position + word_laenge +2), 5);
integer word_position = daten.Find(word);
daten = daten.Substr(0, (word_position +6));
Antwort = "true";
!WriteLine(daten);



!**** Zustand  aktualisieren ****

var zustand = dom.GetObject(""#shellyf#".STATE").State();
!WriteLine(zustand);
if ((daten == "true,") && (zustand != true) )
{dom.GetObject(""#shellyf#".SET_STATE").State(1);
!WriteLine("if ON");
}
if ((daten == "false") && (zustand != false)) {
dom.GetObject(""#shellyf#".SET_STATE").State(0);
!WriteLine("if off");
}


!Skript Ende

In the script, adjust the IP address, CUxD-Exec address, CUxD switch address and system variable name!

Each time the Shelly Flood is sent, the current data is transferred to the Homematic.

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

I have just released the new V2.0 update script.

Modification:

simplified setup (completely at the beginning of the script)

Have fun with it.