Asentria Teleboss 850, User Manual

Page: 165 / 223

TeleBoss 850 2.06.280_STD User Manual
Page 159
View Script File
displays the contents of the selected script file. Equivalent to the SCRIPT SHOW command.
Edit Script File
bring up the selected script file, or a new blank one, in the VI text editor. Equivalent to the SCRIPT
EDIT command.
Delete Script File
deletes the selected script file. Equivalent to the SCRIPT DELETE command.
Download Script File to Unit transfers a script file to the unit. Equivalent to the SCRIPT GET command.
Upload Script File From Unit transfers a script file from the unit. Equivalent to the SCRIPT PUT command.
Script Programming Guide
Scripts are written using the Lua programming language. In addition to built-in Lua constructs and the standard Lua
libraries, the 'omni' library provides an interface to Asentria-specific functionality.
A complete list of Asentria-specific functions can be found in
OmniLua Function List . Additional OmniLua scripting
information can be found in the Scripting FAQ .
Scripting FAQ
1. How do I post records to a database file using a script?
2. How do I retrieve or change a setting?
3. How do I create a custom setting?
4. Which functions should a well-behaved script contain?
5. How do I save frequently-changing data so it survives a power cycle?
6. How can I generate an event?
How do I post records to a database file using a script?
In order to post a record to the database, the script creates a table that defines the records, then passes it to the
a_lib.DBPostRecord() function.
How do I retrieve or change a setting?
Settings are accessed from a script using their corresponding Setting Key, via the a_lib.AccessSetting() function. This
function returns the value of the setting in text format. Simply pass the name of the Setting Key by itself to read the
value. To modify the value, append "= <value>" to the Setting Key, where <value> is the desired value for the setting.
How do I create a custom setting?
There are 200 settings keys available to the write of a script to store values.

One hundred of these keys are for nonvolatile settings - settings that do not change often and need to
survive resets. Those keys are:
scripting.nvstring[x]
scripting.nvint[x]
Where X can range from 1 to 50. Obviously there is a group of settings for string values and a group of
settings for integer values. Examples of this would be things like sitenames or IP addresses.

One hundred settings are also available for volatile settings that do not have to survive a reset.
scripting.vstring[x]
scripting.vint[x]
Strings can be up to 64 characters long. Integers can go from 0 to 2,147,483,647. These settings would
be used to store values that can change often such as a signal strength or temperature.