Floorplan Script Functions
From XAP Automation
Available functions:
Contents
- 1 Available functions:
- 2 Globals
- 3 Devices
- 3.1 GetState(xAPName) As String
- 3.2 GetLevel(xAPName) As String
- 3.3 GetLevelMax(xAPName) As String
- 3.4 GetDisplayText(xAPName) As String
- 3.5 GetText(xAPName) As String
- 3.6 GetLastUpdate(xAPName) As Date
- 3.7 GetLastChange(xAPName) As Date
- 3.8 GetValue(xAPName) As String
- 3.9 GetDisplayValue(xAPName) As String
- 3.10 SetDisplayValue(xAPName, NewValue) As Boolean
- 3.11 SetDisplayText(xAPName, NewValue) As Boolean
- 3.12 SetDisplayTooltip(xAPName, NewValue) As Boolean
- 4 Sending
- 5 Timers
- 5.1 AddTimer(TimerName As String, TimerTime As Date, Script As String, Optional RawCode) As Boolean
- 5.2 DeleteTimer(TimerName As String) As Boolean
- 5.3 EditTimer(TimerName As String, TimerTime As Date, Script As String, Optional RawCode) As Boolean
- 5.4 CheckTimer(TimerName As String) As Variant
- 5.5 ScriptRun(ScriptName)
- 5.6 LogDebug(Message)
- 5.7 GetFromRaw(RawMessage, ItemToFind)
- 6 Time
- 7 Database
- 8 Rooms
- 9 Custom Page specific
Globals
GetGlobal(Globalname)
SetGlobal(Globalname, NewData) As Boolean
GetDBGlobal(Globalname) As Variant
GetDBGlobal returns a Variant, as you can have an array of DBGlobals. Most users are frequently only going to use a single item (the zero'th) as in this case.
if GetDBGlobal("HouseEmpty")(0) then
....some code
end if
The DBGlobal being used here is storing Boolean.
SetDBGlobal(Globalname, NewData, Overwrite As Boolean) As Boolean
The following will set the HouseEmpty global variable to TRUE, overwriting an existing value.SetDBGlobal "HouseEmpty", TRUE, TRUE
