Difference between revisions of "Floorplan Script Functions"

From XAP Automation
Jump to: navigation, search
(GetDBGlobal(Globalname) As Variant)
(GetDBGlobal(Globalname) As Variant)
Line 12: Line 12:
 
end if
 
end if
 
</pre>
 
</pre>
The DBGlobal being used here is a Boolean.
+
The DBGlobal being used here is storing Boolean.
  
 
====SetDBGlobal(Globalname, NewData, Overwrite As Boolean) As Boolean====
 
====SetDBGlobal(Globalname, NewData, Overwrite As Boolean) As Boolean====

Revision as of 18:20, 2 March 2007

Available functions:

Contents


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

Devices

GetState(xAPName) As String

GetLevel(xAPName) As String

GetLevelMax(xAPName) As String

GetDisplayText(xAPName) As String

GetText(xAPName) As String

GetLastUpdate(xAPName) As Date

GetLastChange(xAPName) As Date

GetValue(xAPName) As String

GetDisplayValue(xAPName) As String

SetDisplayValue(xAPName, NewValue) As Boolean

SetDisplayText(xAPName, NewValue) As Boolean

SetDisplayTooltip(xAPName, NewValue) As Boolean

Sending

SendxAP(xBody, xClass, Optional xTarget)

SendxPL(xBody, xClass, Optional xTarget)

SendBSCState(xTarget, NewState)

SendBSCLevel(xTarget, NewLevel)

SendBSCText(xTarget, NewText)

SendBSC(xTarget, NewState, NewLevel, NewText)

Timers

AddTimer(TimerName As String, TimerTime As Date, Script As String, Optional RawCode) As Boolean

DeleteTimer(TimerName As String) As Boolean

EditTimer(TimerName As String, TimerTime As Date, Script As String, Optional RawCode) As Boolean

CheckTimer(TimerName As String) As Variant

ScriptRun(ScriptName)

LogDebug(Message)

GetFromRaw(RawMessage, ItemToFind)

Time

DawnTime() As String

DuskTime() As String

IsDay() As Boolean

IsNight() As Boolean

Database

ExecuteSQL(SQL)

RunSQL(SQL) As Variant

Rooms

GetRoomMode(RoomName)

GetRoomState(RoomName)

GetRoomOccupancy(RoomName) As Boolean

SetRoomMode(RoomName, RoomMode As Integer) As Boolean

SetRoomOccupancy(RoomName) As Boolean

Custom Page specific

GetLastEvents() As Variant

TitleStripGreen(xTitle, xURL)

TitleStripBlue(xTitle, xURL)