Fibaro LUA functies

Met behulp van LUA code kunnen uitgebreide Z-wave toepassingen gemaakt worden.

Kijk HIER voor: Inleiding tot Fibaro LUA programmering

Uitleg LUA functies:

fibaro:abort()
fibaro:calculateDistance()
fibaro:call()
fibaro:countScenes()
fibaro:debug()
fibaro:get()
fibaro:getGlobal()
fibaro:getGlobalModificationTime()
fibaro:getGlobalValue()
fibaro:getModificationTime()
fibaro:getRoomID()
fibaro:getSectionID()
fibaro:getSelfId()*
fibaro:getSourceTrigger()
fibaro:getSourceTriggerType()
fibaro:getType()
fibaro:getValue()
fibaro:isSceneEnabled()
fibaro:killScenes()
fibaro:log()*
fibaro:setGlobal()
fibaro:setSceneEnabled()
fibaro:sleep()
fibaro:startScene()
tonumber()
tostring()

fibaro:abort()

Actie :
Stopt de uitvoer van het huidige script.

Gebruik en parameters :
Er zijn geen argumenten nodig tussen de haakjes.

Teruggekregen waarde :
Er word geen waarde teruggegeven.

Programmeervoorbeeld :
Local a = 0
— oneindige loop
while true do
— als de waarde van a groter is dan 10 moet het script stoppen
if (a>10)
fibaro:abort()
end
a=a+1
— wacht 1 seconde
fibaro:sleep(1000)
end

fibaro:calculateDistance()

Actie :
Berekend de afstand tussen 2 geografische posities.

Gebruik en parameters :
fibaro:calculateDistance(position1, position2)
– position1: eerste locatie
– position2: tweede locatie

A punt word bepaald door de latitude en longitude. De waardes worden weergegeven in graden met een decimale punt (geen komma) en worden gescheiden door een puntkomma. Negatieve waarden zijn, respectievelijk, West en Zuid. Het decimale scheidingsteken is een punt.

Voorbeeld, punt 4°44’55″N, 73°59’11″W word dan “40.7486;-73.9864”.

Teruggekregen waarde :
De afstand in meters.

Programmeervoorbeeld :
local eigenlocatie = fibaro:getValue(123, ‘Location’) –123 is het ID van de gebruiker
local voorbeeldlocatie = “51.6578349135172;18.6398273982745”;
local result;
result = fibaro:calculateDistance(eigenlocatie,voorbeeldlocatie);
fibaro:debug(‘De afstand bedraagt’ ..result.. ” Meter”);

fibaro:call()

Actie :
Stuurt een verzoek naar een z-wave module om een actie uit te voeren.

Gebruik en parameters :
fibaro:call(apparaatID, actienaam, …)
– deviceID: Het ID-nummer van het apparaat in de Home Center (niet het z-wave node ID)
– actionNaam: Een tekststring met daarin de naam van de actie die uitgevoerd moet worden.

In sommige gevallen zijn er meerdere argumeten (actienamen) nodig om een actie correct uit te voeren. In dat geval kunnen er maximaal 7 argumenten extra toegevoegd worden aan apparaatID en actieNaam.

Teruggekregen waarde :
Geen.

Programmeervoorbeeld :
–Geef het uitschakel-commando door aan apparaatID 12
fibaro:call(12 , ‘turnOff’);

–Geef het setValue commando door aan apparaatID 12 met een extra parameter voor de in te stellen waarde
fibaro:call(12 , ‘setValue’ , 23);
Alle parameters zijn in principe tekst-strings. Door de slimme convertor is het echter niet strikt noodzakelijk om deze als string op te geven. het systeem zorgt zelf voor omzetting.

fibaro:countScenes()

Actie :
Vraagt het aantal keer op dat een bepaalde scene actief is.

Gebruik en parameters :
fibaro:countScenes()
fibaro:countScenes(sceneID)
– sceneID: nummerieke waarde — (optioneel) het scene-id waarvan bepaald moet worden hoe vaak het actief is.

Teruggekregen waarde :
A positief getal dat aangeeft hoe vaak een scene op dit moment actief is.
Als er geen sceneID word opgegeven dan word de huidige sceneID gebruikt.

Programmeervoorbeeld :
–geeft het aantal keer dat de huidige scene actief is
local num = fibaro:countScenes() ;
if num == 1 then
fibaro:debug(‘Scene is 1 keer actief’);
else
fibaro:debug(‘ik ben ‘ ..num.. ‘keer actief’);
end
–Als de scene maar 1 keer actief mag zijn
if fibaro:countScenes() >1 then
fibaro:abort();
end
–Geef het aantal keer weer dat scene 1 actief is
num = fibaro:countScenes(12);
fibaro:debug(‘scene 12 is’ ..num.. ‘ keer actief.’) ;
— Controleer of scene 12 geactiveerd is
if fibaro:countScenes((12) >= 1 then
fibaro:debug(‘Scene 12 is actief’);
else
fibaro:debug(‘Scene 12 is niet actief’);
end

Zie ook :
fibaro:killScenes
fibaro:startScene

fibaro:debug()

Actie :
Geeft een tekst-string of een variabele weer in het debug scherm. Geschikt bij het controlleren van uw LUA-code

Gebruik en parameters :
fibaro:debug(tekst)
tekst : de tekst die weergegeven word in het het debug venster

Teruggekregen waarde :
Geen.

Programmeervoorbeeld :
— Geef Hello World weer in het debug scherm
fibaro:debug(‘Hello World’);

–geef een tekst en de waarde van een variabele weer.
local variabele1 = 1;
fibaro:debug(‘De waarde van de variabele is ‘ ..variabele1..);

fibaro:get()

Actie :
Ontvangt de status of eigenschap van een apparaat, in het bijzonder de waarden van ‘value’ en ‘time last modified’
De functie maakt onderdeel uit van een groep met functies:
fibaro:get()
fibaro:getValue()
fibaro:getGlobalModificationTime()
De functies verschillen alleen in de waarde die teruggegeven word.

Gebruik en parameters :
fibaro:get(ApparaatID, NaamEigenschap)
– ApparaatID: Het ID van het apparaat waar de gegevens van gelezen dienen te worden.
– NaamEigenschap: De naam van de Eigenschap die opgevraagd dient te worden

Teruggekregen waarde :
Deze functie geeft 2 waarden terug.
1 Een string met de huidige waarde van de instelling, en
2 Een tijdstempel wanneer de waarde voor het laatst gewijzigd is
De waarden worden teruggeven in tekst-string formaat. wanneer u er een getal van wilt maken dient u het tonumber() commando te gebruiken.

Programmeervoorbeeld :
— vraag de waarde op en de laaste keer dat deze gewijzigd is van de ‘brightness’ instelling van apparaat 11
local waarde, laatstewijziging = fibaro:get(11, ‘brightness’);

— in lua kan de 2e variabele ook achterwege gelaten worden
— onderstaande mag dus ook
local waarde2 = fibaro:get(11, ‘brightness’);

— De verkregen waarde kan gebruikt worden om een andere taak uit te voeren
— voorbeeld : Zet het apparaat uit als de ‘Brightness” boven de 50 uitkomt.
if (tonumber(waarde) > 50) then
 fibaro:call(11,’turnOff’)
end

Zie ook
fibaro:getValue()
fibaro:getGlobalModificationTime()

fibaro:getGlobal()

Actie :
Ontvangt de ‘value’ en ‘time last modified’ van een globale variabele die gedefinieerd zijn in het variabelen paneel.
De functie maakt onderdeel uit van een groep met functies:
fibaro:get()
fibaro:getValue()
fibaro:getGlobalModificationTime()
De functies verschillen alleen in de waarde die teruggegeven word.

Gebruik en parameters :
fibaro:getGlobal(variabelenaam)
variabelenaam : De naam van de globale variabele.

Teruggekregen waarde :
Deze functie geeft 2 waarden terug.
1 Een string met de huidige waarde van variabele, en
2 Een tijdstempel wanneer de waarde voor het laatst gewijzigd is
De waarden worden teruggeven in tekst-string formaat. wanneer u er een getal van wilt maken dient u het tonumber() commando te gebruiken.

Programmeervoorbeeld :
— vraag de waarde op en de laaste keer dat deze gewijzigd is van de variabele isNight
local waarde, laatstewijziging = fibaro:getGlobal(‘isNight’);

— in lua kan de 2e variabele ook achterwege gelaten worden
— onderstaande mag dus ook
local waarde2 = fibaro:getGlobal(‘isNight’);

— De verkregen waarde kan gebruikt worden om een andere taak uit te voeren
— voorbeeld : Zet het apparaat uit als de ‘Brightness” boven de 50 uitkomt.
if waarde == ‘1’ then
 fibaro:debug(‘Het is nacht’);
end

Zie ook
fibaro:getValue()
fibaro:getGlobalModificationTime()

fibaro:getGlobalModificationTime()

Actie :
Ontvangt de ‘time last modified’ tijd van een globale variabele die gedefinieerd zijn in het variabelen paneel.
De functie maakt onderdeel uit van een groep met functies:
fibaro:get()
fibaro:getValue()
fibaro:getGlobalModificationTime()
De functies verschillen alleen in de waarde die teruggegeven word.

Gebruik en parameters :
fibaro:getGlobalModificationTime(variabelenaam)
variabelenaam : De naam van de globale variabele.

Teruggekregen waarde :
Een tijdstempel wanneer de waarde voor het laatst gewijzigd is.
De waarde word teruggeven in tekst-string formaat. wanneer u er een getal van wilt maken dient u het tonumber() commando te gebruiken.

Programmeervoorbeeld :
— vraag de laatste keer dat de variabele ‘teller’ gewijzigd is op.
local laatstewijziging = fibaro:getGlobalModificationTime(‘teller’);

— voer een actie uit als het meer dan 10 seconden geleden is dat de waarde is gewijzigd
if ((os.time()) – tonumber(laatstewijziging) >= 10 then

— De verkregen waarde kan gebruikt worden om een andere taak uit te voeren
— voorbeeld : Zet het apparaat uit als de ‘Brightness” boven de 50 uitkomt.
if waarde == ‘1’ then
 fibaro:debug(‘het is meer dan 10 seconden geleden’);
else
 fibaro:debug(‘het is minder dan 10 seconden geleden’);
end

Zie ook
fibaro:getValue()
fibaro:getModificationTime()

fibaro:getGlobalValue()

Actie :
Ontvangt de waarde van een globale variabele die gedefinieerd zijn in het variabelen paneel.
De functie maakt onderdeel uit van een groep met functies:
fibaro:get()
fibaro:getValue()
fibaro:getGlobalModificationTime()
De functies verschillen alleen in de waarde die teruggegeven word.

Gebruik en parameters :
fibaro:getGlobalValue(variabelenaam)
– variabelenaam : De naam van de globale variabele.

Teruggekregen waarde :
De waarde toegekend aan de variable
De waarde word teruggeven in tekst-string formaat. wanneer u er een getal van wilt maken dient u het tonumber() commando te gebruiken.

Programmeervoorbeeld :
— vraag de waarde van de variabale isNight.
local waarde = fibaro:getGlobalModificationTime(‘teller’);

— voer een actie uit als het meer dan 10 seconden geleden is dat de waarde is gewijzigd
if ((os.time()) – tonumber(laatstewijziging) >= 10 then

— De verkregen waarde kan gebruikt worden om een andere taak uit te voeren
— voorbeeld : Zet het apparaat uit als de ‘Brightness” boven de 50 uitkomt.
if waarde == ‘1’ then
fibaro:debug(‘het is meer dan 10 seconden geleden’);
else
fibaro:debug(‘het is minder dan 10 seconden geleden’);
end

Zie ook
fibaro:getValue()
fibaro:getModificationTime()

fibaro:getModificationTime()

Actie :
Ontvangt de ‘time last modified’ tijd van een apparaat met een aan te geven ID.
De functie maakt onderdeel uit van een groep met functies:
fibaro:get()
fibaro:getValue()
fibaro:getModificationTime()
De functies verschillen alleen in de waarde die teruggegeven wordt.

Gebruik en parameters :
fibaro:getGlobalModificationTime(apparaatID, eigenschap)
– Apparaat ID waarvan u de data wenst te ontvangen
– Eigenschap waarvan u de waarde wilt ontvangen

Teruggekregen waarde :
Een tijdstempel wanneer het apparaat voor het laatst gewijzigd is.
De waarde word teruggeven in tekst-string formaat. wanneer u er een getal van wilt maken dient u het tonumber() commando te gebruiken.

Programmeervoorbeeld :
— vraag de laatste keer dat de apparaat 11 gewijzigd is op.
local laatstewijziging = fibaro:getModificationTime(11, ‘value’);

— voer een actie uit als het meer dan 10 seconden geleden is dat de waarde is gewijzigd
if ((os.time()) – tonumber(laatstewijziging) >= 10 then
fibaro:debug(‘het is meer dan 10 seconden geleden’);
else
fibaro:debug(‘het is minder dan 10 seconden geleden’);
end

Zie ook
fibaro:getValue()
fibaro:getModificationTime()

fibaro:getRoomId()

Actie :
Ontvangt het nummer van de kamer waarin een bepaald apparaat zich bevindt.

Gebruik en parameters :
fibaro:getRoomID(apparaatID)
– ApparaatId: Het unieke ID van een apparaat.

Teruggekregen waarde :
Een getal met het kamernummer. De kamer ‘niet toegewezen’ krijgt nummer 0.

Programmeervoorbeeld :
— vraag het kamernummer van ID 12 op.
local kamernummer = fibaro:getRoomID(12);

— gebruik de variabele om het kamernummer weer te geven.
if (kamernummer == 0 )then
fibaro:debug(‘Het apparaat heeft geen kamernummer, het is niet aan een kamer toegewezen’);
else
fibaro:debug(‘Het apparaat bevindt zich in kamer ‘ ..kamernummer);
end

Zie ook
fibaro:getSection()
fibaro:getType()

fibaro:getSectionID()

Actie :
Ontvangt het nummer van de sectie (verdieping) waarin een bepaald apparaat zich bevindt.

Gebruik en parameters :
fibaro:getsectionID(apparaatID)
– ApparaatId: Het unieke ID van een apparaat.

Teruggekregen waarde :
Een getal met het sectienummer. De sectie ‘niet toegewezen’ krijgt nummer 0.

Programmeervoorbeeld :
— vraag het sectienummer van ID 12 op.
local sectienummer = fibaro:getSectionID(12);

— voer een actie uit als het meer dan 10 seconden geleden is dat de waarde is gewijzigd
if (room == 0 )then
fibaro:debug(‘Het apparaat heeft geen sectienummer, het is niet aan een sectie toegewezen’);
else
fibaro:debug(‘Het apparaat bevindt zich in sectie ‘ ..sectienummer);
end

Zie ook
fibaro:getSection()
fibaro:getType()

fibaro:getSelfID()*

Actie :
Ontvangt het nummer van het virtuele apparaat van waaruit het is aangeroepen.
Deze functie werkt alleen binnen een virtueel apparaat en werkt daarom niet bij het gebruik in scenes.

Gebruik en parameters :
fibaro:getSelfId()
– Er worden geen argumenten doorgegeven.

Teruggekregen waarde :
Een getal met het nummer van het virtuele apparaat.

Programmeervoorbeeld :
— vraag het nummer van dit virtuele apparaat op.
local ditapparaat = fibaro:getSelfId();

— gebruik de variabele om het IP-adres en de gebruikte poort
— van het apparaat op te halen
local ip = fibaro:getValue(ditapparaat, ‘IPAdress’);
local poort = fibaro:getValue(ditapparaat, ‘TCPPort’);
— open een connectie naar die poort en schrijf een bericht.
tcpSocket = Net.FTcpSocket(ip, poort)
bytes,errorCode =tcpSocket:write(“Dit wordt naar de tcp poort geschreven”);

fibaro:getSourceTrigger()

Actie :
Ontvangt informatie omtrent de trigger die de scene heeft gestart.

Gebruik en parameters :
fibaro:getSourceTrigger()
– Er worden geen paramaters meegegeven.

Teruggekregen waarde :
Een array met informatie over wat de scene in werking heeft gezet. De array bevat altijd een veld genaamd type, die afhankelijk van de trigger een van de volgende waarden heeft.
Eigenschap (property) : Als de scene gestart word door een ApparaatID.
Globale variabele (Global) : Als de scene gestart word door een globale variabele.
Overig (other) : In overige gevallen (bijvoorbeeld wanneer een scene direct gestart word vanuit de interface of de app.
Afhankelijk van wat de scene start ontvangt de functie de volgende waarden terug:

Programmeervoorbeeld :
–[[
%%properties
13 value
15 value

%%globals
ishetdonkerbuiten
–]] local trigger = fibaro:getSourceTrigger()
if ( trigger[‘type’] == ‘property’) then
fibaro:debug(‘ scene gestart door apparaat met ID ‘..trigger[‘deviceID’] )
elseif ( trigger[‘type’] == ‘global’) then
fibaro:debug(‘ scene gestart door variabele ‘..trigger[‘varName’] )
elseif ( trigger[‘type’] == ‘other’) then
fibaro:debug(‘ scene gestart door iets anders. ‘)
end

fibaro:getSourceTriggerType()

Actie :
Ontvangt informatie omtrent het type trigger dat de scene heeft gestart.

Gebruik en parameters :
fibaro:getSourceTriggerType()
– Er worden geen paramaters meegegeven.

Teruggekregen waarde :
Een string met het type trigger dat de scene aangeroepen (gestart) heeft.
de functie lijkt op fibaro:getTriggerSource() en controleert welk type trigger de scene aangeroepen heeft.

Programmeervoorbeeld :
— controlleer of de scene handmatig is gestart
if ( fibaro:getSourceTriggerType() == ‘other’ ) then
fibaro:debug(‘ scene is handmatig gestart’ );
end

Zie ook
fibaro:getSourceTrigger()

fibaro:getType()

Actie :
Ontvangt informatie omtrent het type apparaat.

Gebruik en parameters :
fibaro:getType(apparaatID)
– ApparaatID : Het ID van het apparaat waarvan het type opgevraagd moet worden.

Teruggekregen waarde :
Een string met het type apparaat.

Programmeervoorbeeld :
— vraag het type op van apparaat met ID 128
local typeapparaat = fibaro:getType(128);
— als het een ‘blind’ (rolluikmodule) betreft.
if (typeapparaat == ‘blind’ ) then
fibaro:debug(‘ het apparaat is een rolluikmodule’ );
else
fibaro:debug(‘ het apparaat is een ‘..typeapparaat)’
end

Zie ook
fibaro:getRoomId()
fibaro:getSectionId()