Fibaro Lua Function Summary and Cross Reference

Note: characters < optional_parameter > indicate optional parameters. Characters [ choice1 | choice2 ] indicate a choice list for the specified parameter.

FunctionDescription
fibaro:abort() Terminates current scene processing.
fibaro:call( deviceID, action); Requests that the specified action be carried out on the device, e.g. "turnOn".
fibaro:callGroupAction( device_filter, action) Requests that the specified action be carried out on each device that matches the device_mask.
fibaro:countScenes() Returns the number of copies of this scene that are active, including the current scene.
fibaro:countScenes(sceneID) Returns the number of running copies of the specified scene.
fibaro:get( deviceID, property) Returns two string parameters: value of the requested device property and time the property was last reported/modified.
fibaro:getDevicesId( { device_mask } ) Returns a table of device ids that match the supplied mask.
fibaro:getGlobal( "var_name") Returns two string parameters: value of the fibaro global variable and time the variable was last modified.
fibaro:getGlobalModificationTime( "var_name") Returns the timestamp associated with a change to the value of the fibaro global variable.
fibaro:getGlobalValue( "var_name") Returns the value of the fibaro defined global variable
fibaro:getModificationTime( "deviceID", property) Returns the timestamp associated with the most recent change in value of the specified property on the specified device.
fibaro:getName( deviceID) Returns the name provided on the device configuration panel.
fibaro:getRoomID( deviceID) Returns the id of the room in which the device is located.
fibaro:getRoomName( "roomID") Returns the name of the room associated with roomID.
fibaro:getSceneRunConfig(sceneID) Returns a string containing one of the setRunConfig() parameter options.
fibaro:getSectionID( deviceID) Returns the id of the section in which the device is located.
fibaro:getSourceTrigger() Returns a table identifying the scene trigger. Always returns ['type'], may return additional table values dependent on type.
fibaro:getSourceTriggerType() Returns a string equivalent to the type table entry returned by the getSourceTrigger() function.
fibaro:getType( deviceID) Returns the device type.
fibaro:getValue( deviceID, property) Returns the value of the requested device property for the specified device.
fibaro:isSceneEnabled(sceneID) Returns binary true if the specified scene is enabled, otherwise false.
fibaro:killScenes(sceneID) Kills, terminates all running instances of the specified scene.
fibaro:setGlobal( "var_name", "value") Sets the value of the fibaro defined global variable var_name to the value provided by value
fibaro:setSceneEnabled(sceneID, cond.) Enable, cond. true, or disable, cond. false, the specified scene.
fibaro:setSceneRunConfig(sceneID, state ) Sets whether the scene can be triggered: 'TRIGGER_AND_MANUAL', run on request: 'MANUAL_ONLY' or not run at all: 'DISABLED'.
fibaro:sleep(milli-seconds) Suspends the scene for the number of milli-seconds specified.
fibaro:startScene(sceneID < ,{table} > ) Starts the specified scene optionally passing that scene the supplied table of parameters.

 

Fibaro
Lua API
Contents
HTTPClient

For completeness we have also added a link to the page describing the Fibaro lua http client

Questions or comments, please e-mail us at info@snys.nl