Lua API Extensions Reference¶
Overview¶
Lua has a standard library which defines its core functionality, but to interact with the Intelligent Module, additional functionality is needed. As such, Symetrix has created a set of custom Lua API (Application Programming Interface) extensions that provide functionality specifically needed for interacting with Intelligent Modules.
The following pages describe the various Symetrix extensions to Lua that can be used by the Composer Intelligent Module Scripts.
Conventions¶
In the code examples, you will commonly see the following to the right of lines of code:
print("Ben") >> Ben
ChangeLabel("Ben") -- The label was changed to "Ben"
The first line prints to the Debug Output File. The output of this print statement is indicated with the “>>”.
The second line does something in the code but has no output to the Debug Output File. As such, the result of the line is described with the comment indicator “--".
More Lua Information¶
For more information about Lua, see the Lua References page.