Philips Hue als virtuelles Modul im Fibaro HC2

5. Januar 2016

9 min. Lesedauer

Philips Hue als virtuelles Modul in der Fibaro HC2

Geschrieben von crissxcross

[vc_row full_width="" parallax="" parallax_image="" seperator_indeed_locker="Indeed Social Locker" lk_sl="" lk_t="" lk_la="horizontal" lk_dc="true" lk_dfn="true" lk_lt="2" lk_etl="0" lk_tl="30" lk_nru="0" lk_rl="0" lk_lra="30" lk_lrt="days" lk_io="" lk_lp="50" lk_dm="0" lk_thm="0" lk_tuo="0" lk_dt=" "][vc_column width="1/1" css=".vc_custom_1442767910088{background-color: #f4f4f4 !important;}"][vc_row_inner][vc_column_inner el_class="" width="1/4" css=".vc_custom_1442917949199{padding-top: 10px !important;padding-bottom: 5px !important;padding-left: 10px !important;}"][vc_single_image image="16142" alignment="center" style="vc_box_circle_2" border_color="grey" img_link_large="" img_link_target="_self" css_animation="" img_size="60x60"][/vc_column_inner][vc_column_inner el_class="" width="3/4"][vc_column_text]

New: Read this article in english

This article is now available in english on siio.com.[/vc_column_text][/vc_column_inner][/vc_row_inner][/vc_column][/vc_row][vc_row][vc_column][vc_column_text]Die Philips Hue Leuchten als erste ihrer Art, genießen inzwischen trotz des hohen Preises immer mehr Beliebtheit. Die Smartphone Steuerung ist ein nettes Gadget aber auch Fluch zugleich. So lassen sich die bunten Birnen zwar ganz nett als "Appcessories" verwenden, aber wer möchte schon jedesmal nach dem Smartphone kramen wenn er ein Zimmer betritt, um das Licht einzuschalten.

Seit einiger Zeit hat Philips die API für die Hue geöffnet, so das man die bunten Birnen nun in verschiedene Systeme einbinden kann. RWE SmartHome hat es vorgemacht (wir haben berichtet) und die Philips Hue in ihre Hausautomatisierung integriert.

Wie wäre es wenn du die Philips Hue Leuchten in dein Fibaro Home Center 2 einbinden könntest?

Klingt erst einmal nach einem netten Gadget, ist aber auf den zweiten Blick viel mehr. Denn als virtuelles Modul in die Fibaro HC2 eingebunden, ist es möglich die Philips Hue wie eine physische Hardware Komponente anzusprechen. Du kannst diese so per Schalter, Fernbedienung oder Bewegungsmelder ein- und ausschalten. Du kannst Sie auch in Szenen einbinden, um dir so zum Beispiel ein offenes Fenster optisch signalisieren zu lassen.

[carousel arrows="display" buttons="display"] [panel]

Farbe und Helligkeit der Philips Hue lassen sich frei variieren

[/panel] [panel]

Philips Hue lässt sich über die HC2 Weboberfläche sowie über die App steuern

[/panel] [panel]

Status der Philips Hue wird stetig abgefragt

[/panel] [panel]

das Icon Set passt sich stets der Helligkeit der Hue Leuchten an

[/panel] [/carousel]

So bindest du die Philips Hue in das Fibaro HC2 ein. Leider nicht für die Fibaro HCL geeignet, da LUA Code erforderlich ist.

Benutzer auf der Philips Hue Bridge anlegen

Zunächst benötigst du einen Benutzernamen auf der Philips Hue Bridge, um mit diesem später die Philips Hue API anzusprechen. Dazu gehst du über deinen Browser auf die Weboberfläche der Hue Bridge unter der Adresse:

http:///debug/clip.html

Die IP Adresse der Hue Bridge findest du am einfachsten über die Weboberfläche deines Routers heraus.

Auf der Weboberfläche der Philips Hue Bridge findest du neben den Buttons GET, PUT, POST, DELETE, drei Boxen:

URL
Message Body
Command Response

Um einen neuen User anzulegen schreibst du in die URL Zeile:

http://ip address>/api

In den Message Body kommt folgendes:

{"devicetype":"test user","username":"newdeveloper"}

1	{"devicetype":"test user","username":"newdeveloper"}

Weboberfläche der Philips Hue Bridge

Damit wird dann der User "newdeveloper" erzeugt. Du kannst ihn natürlich auch Fibaro oder HeinzHorst nennen. Bevor du auf den Button POST drückst, musst du kurz auf den (physikalischen) Button an der Philips Hue Bridge drücken. Nachdem du nun auf POST gedrückt hast, solltest du eine "success" Meldung erhalten. Eine Step by Step Anleitung, findest du für die Philips Hue API auch noch einmal hier "Getting started"

Virtuelles Modul erstellen

Fibaro HC2 - virtuelles Modul erstellen

Nun kannst du auf die Weboberfläche deines Fibaro HC2 wechseln. Dort legst du unter "Module" > Add or remove > Virtuelles Modul hinzufügen - ein neues virtuelles Modul an. Vergebe dem Modul einen Namen deiner Wahl. Dieses Modul wird eine Philips Hue Bulb steuern, daher hab ich die Module bei mir Philips Hue Bulb 1 bis 3 benannt. Vergebe noch einen Raum. Das Feld für die IP Adresse und den TCP Port kannst du frei lassen.

Fibaro HC2 - neues virtuelles Modul benennen

Gehe auf die Registerkarte "Fortgeschritten" und füge einen Slider hinzu.

Dieser Slider wird später die Helligkeit regulieren. Benenne Ihn am besten mit "Brightness", als ID vergebe "sldBrightness" und wähle für den Slider "LUA Code" aus.

Fibaro HC2 - Slider zum virtuellen Modul hinzufügen

Upload Icon Set

Damit das virtuelle Modul nachher je nach Helligkeit der Philips Hue ein passendes Icon erhält, benötigst du als nächstes das Icon Set. Dieses kannst du dir hier herunterladen:

[icons icon="icon-folder-open"]Icon Set Leuchten

Nach dem Download entpacke es auf deinem PC. In dem Ordner findest du 13 Icons. Lade sie über den Button "Symbol ändern" in der nummerierten Reihenfolge hoch.

Fibaro HC2 - virtuelles Modul, Icon ändern

Sobald die Icons hochgeladen sind, erhalten diese eine ID von dem Fibaro Home Center. In der Regel erhält das erste Icon die ID 1000, das nächste die 1001 und so weiter. Um sicher zu gehen ob bei dir die IDs ebenfalls bei 1000 beginnen, denn es kann ja sein das du schon einmal Icons hochgeladen hast, schaue nochmal nach. Am einfachsten geht dies über den Google Chrom Browser oder beim Firefox über die Entwickler Tools. Mit einem rechtsklick auf das Icon > dann "Element untersuchen" findet sich im Quelltext fix die vergebene ID.

Fibaro HC2 - rechtsklick auf Icon

Im Quelltext findest du die vergebene ID. Diese benötigst du dann im Script.

Fibaro HC2 - Element untersuchen öffnet Quelltext und zeigt ID des Icons

Slider LUA Code

Der zuvor hinzugefügte Slider, soll nun endlich das Script erhalten, welches die Philips Hue in der Helligkeit reguliert. Da der Wert bei der Philips Hue Leuchte für die volle Helligkeit 255 ist, der Slider aber nur einen Wert von 0-100 annehmen kann, müssen wir diesen stets mit 2.55 multiplizieren. Den folgenden Code kannst du so in den Slider (sldBrightness) kopieren:

  hueBrightness = math.floor(_sliderValue_ * 2.55) 
  hueOn = true

1 2	hueBrightness = math.floor(_sliderValue_ * 2.55) hueOn = true

Im Kopf des LUA Scripts findest du drei Werte (in Rot) welche du anpassen musst.

hueIP = fibaro:get(selfId, "IPAddress")
huePort = fibaro:get(selfId, "TCPPort")
hueUser = "newdeveloper" 
hueLightID = 1

hueIP = fibaro:get(selfId, "IPAddress")

huePort = fibaro:get(selfId, "TCPPort")

hueUser = "newdeveloper"

hueLightID = 1

Dies ist zum einen die IP Adresse deiner Philips Hue Bridge. Solltest du im ersten Schritt deinen Benutzer anders als "newdeveloper" benannt haben, so musst du diesen ebenfalls ersetzen. Der Wert "hueLightID" gibt an, welche Hue Bulb gesteuert werden soll. Im Starterpack der Philips Hue befinden sich drei Leuchten, demzufolge könnte der Wert hier 1-3 annehmen.

Sollte deine Fibaro HC2 bei den Icons nicht ab 1000 begonnen haben die IDs zu vergeben, musst du dies ggf. noch anpassen - ab der Funktion:

selfId = fibaro:getSelfId()
hueIP = fibaro:get(selfId, "IPAddress")
huePort = fibaro:get(selfId, "TCPPort")
hueUser = "newdeveloper" 
hueLightID = 1

-- set the id of the HC2 Virtual Device 
vDeviceID = fibaro:getSelfId(); 

-- function to select the correct icon based on the slider value 
-- NOTE: change the icon IDs if needed 
function getIcon(sValue) 
  if(sValue >= 90) then return 1010         -- 90%-99% 11_s_light100.png 
  elseif(sValue >= 80) then return 1009     -- 80%-89% 10_s_light90.png 
  elseif(sValue >= 70) then return 1008     -- 70%-79% 09_s_light80.png 
  elseif(sValue >= 60) then return 1007     -- 60%-69% 08_s_light70.png 
  elseif(sValue >= 50) then return 1006     -- 50%-59% 07_s_light60.png 
  elseif(sValue >= 40) then return 1005     -- 40%-49% 06_s_light50.png 
  elseif(sValue >= 30) then return 1004     -- 30%-39% 05_s_light40.png 
  elseif(sValue >= 20) then return 1003     -- 20%-29% 04_s_light30.png 
  elseif(sValue >= 10) then return 1002     -- 10%-19% 03_s_light20.png 
  elseif(sValue >= 1) then return 1001      -- 1%-9%   02_s_light10.png 
  else return 1000 end                      -- 0%      01_s_light0.png 
end 

-- define the new values for hueBrightness and hueOn 
if (_sliderValue_ == 0) then 
  hueBrightness = _sliderValue_ 
  hueOn = false 
else 
  -- multiply the slider value with 2.55 and round it DOWNWARDS 
  -- to get the hueBrightness value (0-255) 
  hueBrightness = math.floor(_sliderValue_ * 2.55) 
  hueOn = true 
end 

-- connect to the Hue bridge 
Hue = Net.FHttp(hueIP,huePort) 
-- HTTP PUT to set the new values 
response, status, errorCode = Hue:PUT('/api/'..hueUser..'/lights/'..hueLightID..'/state', '{"on":'..tostring(hueOn)..',"bri":'..hueBrightness..'}') 
-- continue if HTTP status code is 200 
if (tonumber(status) == 200) then 
    -- change the icon based on the new slider value 
    fibaro:call(vDeviceID, "setProperty", "currentIcon", getIcon(_sliderValue_)) 
end

selfId = fibaro:getSelfId()

hueIP = fibaro:get(selfId, "IPAddress")

huePort = fibaro:get(selfId, "TCPPort")

hueUser = "newdeveloper"

hueLightID = 1

-- set the id of the HC2 Virtual Device

vDeviceID = fibaro:getSelfId();

-- function to select the correct icon based on the slider value

-- NOTE: change the icon IDs if needed

function getIcon(sValue)

if(sValue >= 90) then return 1010 -- 90%-99% 11_s_light100.png

elseif(sValue >= 80) then return 1009 -- 80%-89% 10_s_light90.png

elseif(sValue >= 70) then return 1008 -- 70%-79% 09_s_light80.png

elseif(sValue >= 60) then return 1007 -- 60%-69% 08_s_light70.png

elseif(sValue >= 50) then return 1006 -- 50%-59% 07_s_light60.png

elseif(sValue >= 40) then return 1005 -- 40%-49% 06_s_light50.png

elseif(sValue >= 30) then return 1004 -- 30%-39% 05_s_light40.png

elseif(sValue >= 20) then return 1003 -- 20%-29% 04_s_light30.png

elseif(sValue >= 10) then return 1002 -- 10%-19% 03_s_light20.png

elseif(sValue >= 1) then return 1001 -- 1%-9% 02_s_light10.png

else return 1000 end -- 0% 01_s_light0.png

end

-- define the new values for hueBrightness and hueOn

if (_sliderValue_ == 0) then

hueBrightness = _sliderValue_

hueOn = false

else

-- multiply the slider value with 2.55 and round it DOWNWARDS

-- to get the hueBrightness value (0-255)

hueBrightness = math.floor(_sliderValue_ * 2.55)

hueOn = true

end

-- connect to the Hue bridge

Hue = Net.FHttp(hueIP,huePort)

-- HTTP PUT to set the new values

response, status, errorCode = Hue:PUT('/api/'..hueUser..'/lights/'..hueLightID..'/state', '{"on":'..tostring(hueOn)..',"bri":'..hueBrightness..'}')

-- continue if HTTP status code is 200

if (tonumber(status) == 200) then

-- change the icon based on the new slider value

fibaro:call(vDeviceID, "setProperty", "currentIcon", getIcon(_sliderValue_))

end

Fibaro HC2 - einfügen des LUA Codes in den Slider (Helligkeit)

Main loop LUA Code - Status abfragen

Fibaro HC2 - einfügen des Main Loop LUA Code welcher den Status der Philip Hue stetig abfragt

Fibaro HC2 - einfügen des Main Loop LUA Code welcher den Status der Philips Hue stetig abfragt

Der Main Loop Code wird den Status deiner Philips Hue Bulb stetig aktualisieren, um den Status des Slider, das Icon und die Informationsbar zu aktualisieren. Denn falls du zwischendurch mal die Philips Hue App nutzen solltest um die Helligkeit zu regulieren, so wird der Status Slider im virtuellen Modul der Fibaro HC2 automatisch aktualisiert. Diese Informationen holt sich die Fibaro HC2 alle 3 Sekunden (Standard, kannst du im Script ändern) von der Philips Hue Bridge. Kopiere das folgende Script in das Feld "Main loop". Auch hier musst du im Kopf des Scripts die Werte "hueIP"; "hueUser" und die "hueLightID" anpassen.

-- set the Hue bridge properties 
-- http://developers.meethue.com/gettingstarted.html 
-- go to http:///api//lights to get the ID of all your Hue lights 
selfId = fibaro:getSelfId()
hueIP = fibaro:get(selfId, "IPAddress")
huePort = fibaro:get(selfId, "TCPPort")
hueUser = "newdeveloper" 
hueLightID = 1

-- set the id of the HC2 Virtual Device 
vDeviceID = fibaro:getSelfId(); 
-- set the id of the icons used 
-- NOTE: change the icon IDs if needed 
iconUnreachable = 1011 
iconError = 1012 
-- specify the delay in milliseconds (3000 = 3 seconds) 
-- the lower the delay, the more traffic is send to the Hue bridge 
delay = 3000 

-- function to select the correct icon based on the slider value 
-- NOTE: change the icon IDs if needed 
function getIcon(sValue) 
  if(sValue >= 90) then return 1010         -- 90%-99% 11_s_light100.png 
  elseif(sValue >= 80) then return 1009     -- 80%-89% 10_s_light90.png 
  elseif(sValue >= 70) then return 1008     -- 70%-79% 09_s_light80.png 
  elseif(sValue >= 60) then return 1007     -- 60%-69% 08_s_light70.png 
  elseif(sValue >= 50) then return 1006     -- 50%-59% 07_s_light60.png 
  elseif(sValue >= 40) then return 1005     -- 40%-49% 06_s_light50.png 
  elseif(sValue >= 30) then return 1004     -- 30%-39% 05_s_light40.png 
  elseif(sValue >= 20) then return 1003     -- 20%-29% 04_s_light30.png 
  elseif(sValue >= 10) then return 1002     -- 10%-19% 03_s_light20.png 
  elseif(sValue >= 1) then return 1001      -- 1%-9%   02_s_light10.png 
  else return 1000 end                      -- 0%      01_s_light0.png 
end 

-- connect to the Hue bridge 
Hue = Net.FHttp(hueIP,huePort) 
-- HTTP GET to get all the info from the light 
response ,status, errorCode = Hue:GET('/api/'..hueUser..'/lights/'..hueLightID); 
-- continue if HTTP status code is 200 
if (tonumber(status) == 200) then 
  jsonTable = json.decode(response) 
  -- check if error table exists 
  if (jsonTable[1] ~= nil) then 
    -- show error information 
    errorType = jsonTable[1].error.type 
    errorDescription = jsonTable[1].error.description 
    fibaro:debug("Error type = "..errorType) 
    fibaro:debug("Error description = "..errorDescription) 
    if (errorType == 1) then fibaro:log("Hue: Unauthorized user") 
    elseif (errorType == 3) then fibaro:log("Hue: Incorrect light ID")  
    end 
     -- set slider value to 0 
     fibaro:call(vDeviceID, "setProperty", "ui.sldBrightness.value", 0) 
     -- change the icon to iconError 
     fibaro:call(vDeviceID, "setProperty", "currentIcon", iconError)    
  else 
      -- get the on state 
      hueOn = jsonTable.state.on 
      fibaro:debug("hueOn = " .. tostring(hueOn)); 
      -- get the brightness value (0-255) 
      hueBrightness = tonumber(jsonTable.state.bri) 
      fibaro:debug("hueBrightness = "..hueBrightness); 
      -- get the reachable state 
      hueReachable = jsonTable.state.reachable 
      fibaro:debug("hueReachable = " .. tostring(hueReachable)); 
      if (hueReachable == true) then 
          if (hueOn == false) then 
            hueSlider = 0; 
          else 
            -- devide the hueBrightness value by 2.55 and round it UPWARDS 
            -- to get the hueSlider value (0-100) 
            hueSlider = math.ceil(hueBrightness / 2.55); 
          end 
          fibaro:debug("hueSlider = "..hueSlider); 
          -- show brightness and state info on the bottom bar of the Virtual Device 
          fibaro:log("brightness: "..hueBrightness.." | on: "..tostring(hueOn)); 
          -- set the actual slider value 
          fibaro:call(vDeviceID, "setProperty", "ui.sldBrightness.value", hueSlider) 
          -- change the icon of the Virtual Device based on the hueSlider value 
          fibaro:call(vDeviceID, "setProperty", "currentIcon", getIcon(hueSlider))    
      else 
         fibaro:log("Hue: Light not reachable"); 
         -- set slider value to 0 
         fibaro:call(vDeviceID, "setProperty", "ui.sldBrightness.value", 0) 
         -- change the icon to unreachable 
         fibaro:call(vDeviceID, "setProperty", "currentIcon", iconUnreachable)    
      end 
    end 
end 
-- delay the Main loop 
fibaro:sleep(delay);

-- set the Hue bridge properties

-- http://developers.meethue.com/gettingstarted.html

-- go to http:///api//lights to get the ID of all your Hue lights

selfId = fibaro:getSelfId()

hueIP = fibaro:get(selfId, "IPAddress")

huePort = fibaro:get(selfId, "TCPPort")

hueUser = "newdeveloper"

hueLightID = 1

-- set the id of the HC2 Virtual Device

vDeviceID = fibaro:getSelfId();

-- set the id of the icons used

-- NOTE: change the icon IDs if needed

iconUnreachable = 1011

iconError = 1012

-- specify the delay in milliseconds (3000 = 3 seconds)

-- the lower the delay, the more traffic is send to the Hue bridge

delay = 3000