Welcome to the Lua API docs
The power of system:inmation lies in its customizability, and the basis of this is the Lua API engine.
In this section you can find information regarding the Lua API and examples demonstrating how to use the scripting engine to customize your environment by creating objects, fetching data and setting properties.
The Lua API can be used by any user regardless of if they are experienced developers or novice end users who wish to create new ways to effectively use the data in their system. This section will help you to get started with the Lua API and begin creating your own customized system.
In this section you will find:
- syslib Lua library functions
-
All the Lua library functions in the API. Allowing you to access all objects in the system, set properties and values; create and delete objects; retrieve real-time and historical data and much more.
- Object methods
-
The Object methods available in the API. These methods are used to access data associated with the called objects in the system.
- ESI libraries
-
The ESI ("Extended Script Infrastructure") developer community is a regulated collaborative eco-system, designed to help extend the software customization possibilities of system:inmation. Here you will find custom libraries developed across multiple organizations that cover common tasks encountered by experienced users. There is also information regarding the rules of the ESI community and how you can become a part of it.
- Lua Scripting Introduction
-
Here you can find an introduction to the Lua scripting engine, including information about event handling, script libraries, use of paths and other tips and tricks.
- Using Lua Scripting Jumpstart
-
A tutorial for beginners to introduce using Lua in DataStudio. Includes tasks such as creating objects to simulate data; creating interfaces to retrieve data from SQL databases and http endpoints; and creating KPI models to represent objects producing data in your system.