Light Groups Module Information


	L Cubed Solutions *Valued Independent Programmers*, AMX Certified Experts

Back to Corporate

General:

These modules are used to allow the user to deal with lights as groups that can be turned on/off based upon a schedule or based upon an event (car sensor, motion detector, etc). Scheduled events include time, pre-dusk, pre-dawn, dusk, and dawn. Event groups have a duration for how long the lights stay on. Lights contained in more than one active group will work as expected based upon how the group of lights is setup. Groups also include manual override and auxiliary action states. Load intensities can be set as a group, or individually adjusted for finer control. All settings can be stored to disk or restored from disk.

Prerequisites:

TP Tracker Module
Lighting Communication Module
Light Load Data Module

Module Headers:

Lighting Group Management Module

Type	Name	Description
Dev	vdvLighting	Lighting communications module device
Dev	vdvGroupControl	Virtual device for the module
Char	isDark	True when it is dark (after sunset, before sunrise)
Char	isVacation	True when vacation mode is selected
Integer	LatestDawnTime	Value in minutes of the latest dawn time
Integer	LatestDuskTime	Value in minutes of the latest dusk time
Integer	MaxLtLoad	Maximum light loads read from file
Char[][]	LtLdDescription	Each load's description
Char[]	LtLdType	Each load's type
Char[]	LtLdIntensity	Current intensity of each light load
Integer[]	LtLdProcAddr	Numeric representation of each light load's processor address
Char[][]	LtLdInGroup	Each load's group membership
Char[][]	FadeRateStr	Description of each fade rate
Char[][]	GroupDescription	Description of each group
Integer	MaxSchedGroup	Max number of scheduled groups
Integer	MaxEventGroup	Max number of event groups
Integer	MaxGroup	Total number of groups combined
Integer[][][][]	GroupSchedule	Each group's schedule time and action
Integer[][]	GroupProperty	Each group's properties

Lighting Group Touch Panel UI Module

Type	Name	Description
Dev	vdvGroupControl	Virtual device for the module
Dev	vdvTpMain	Main panel device (used for popup control)
Dev	vdvTpLites	Lighting panel device (could be same as vdvTpMain)
Integer[]	cTpBeginEnd	Navigation buttons
Integer[]	cTpRaiseLower	Value modify buttons
Integer	cTpPrevious	To show/hide 'Previous' button
Integer[]	cTpGrpDescription	List of description channels for visible groups
Integer[]	cTpGrpOverride	List of override channels for visible groups
Integer[]	cTpGrpFadeOnRate	List of 'ON' fade rate channels for visible groups
Integer[]	cTpGrpOnIntensity	List of 'ON' intensity channels for visible groups
Integer[]	cTpGrpFadeOffRate	List of 'OFF' fade rate channels for visible groups
Integer[]	cTpGrpOffIntensity	List of 'OFF' intensity channels for visible groups
Integer[]	cTpGrpCursorSelected	Used to denote which group is currently selected
Integer[]	cTpGrpPopups	Mutually exclusive buttons for each setting popup
Integer	cTpDetailGrpName	Text button for name of current group on Detail popup
Integer	cTpGrpEnable	Channel used to enable/disable the current group
Integer	cTpEventAuxEnable	Channel used to enable/disable the Event group Aux feature
Integer	cTpGrpVacationExempt	Channel used to exempt a group from vacation status
Integer[]	cTpGrpDetailSettable	Channels used for settable values (predusk and predawn times)
Integer	cTpSchedGrpName	Text button for name of current group on Schedule popup
Integer	cTpGrpSchedToday	Channel to select the current day in the weekly schedule
Integer	cTpGrpSchedCopyToWeekday	Channel to copy current day schedule to all week days
Integer	cTpGrpSchedCopyToWeekend	Channel to copy current day schedule to weekend days
Integer[]	cTpGrpSchedDaySelected	Channels used to select a day of the week
Integer[]	cTpGrpSchedTimes	Channels to adjust time of a scheduled item
Integer[]	cTpGrpSchedActions	Channels to adjust the action of a scheduled item
Integer	cTpLoadGrpName	Text button for name of current group on Load Assignment popup
Integer[]	cTpGrpLoadSelected	List of channel/text buttons to list and select loads from
Integer	cTpGrpLtLdClearAll	Channel used to clear all currently selected loads for current group
Integer	cTpGrpLtLdLvlDescription	Text channel for description of current level adjusted load
Integer	cTpGrpLtLdLvlDefault	Sets current level adjusted load's intensity setting to group default
Integer	cTpGrpLtLdLvlAdjust	Channel attached to intensity level adjustment bar
Integer	lTpGrpLtLdLvlAdjust	Level value attached to intensity level adjustment bar
Integer	cTpLtLdSetProperties	Toggles state of Load level adjustment popup feature
Char	isDark	True when it is dark (after sunset, before sunrise)
Char	isVacation	True when vacation mode is selected
Char[][]	LtLdDescription	Each load's description
Char[]	LtLdType	Each load's type
Integer[]	LtLdProcAddr	Numeric representation of each light load's processor address
Char[]	LtLdIntensity	Current intensity of each light load
Integer[]	LoadDisplayOrder	Contains loads in display order
Integer	MaxLtLoad	Maximum light loads read from file
Char[][]	LtLdInGroup	Each load's group membership
Char[][]	FadeRateStr	Description of each fade rate
Char[][]	GroupDescription	Description of each group
Integer	MaxSchedGroup	Max number of scheduled groups
Integer	MaxEventGroup	Max number of event groups
Integer	MaxGroup	Total number of groups combined
Integer[][][][]	GroupSchedule	Each group's schedule time and action
Integer[][]	GroupProperty	Each group's properties
Char[]	TpCurrPage	Name of the current page for this TP
Char[]	TpCurrPopup	Name of the latest popup with activity
Integer	TpNewPage	True when the current page has just changed
Integer	TpNewPop	True when a popup has just appeared or disappeared
Integer	TpPopup	True if appearing, false if disappearing
Integer	cTpEdit	Channel used as edit feature button enable/disable
Integer	TpEditing	True is editing feature is enabled
Integer	TpEditChannel	Current channel number being edited
Integer	TpKeyType	Specifies the keypad/keyboard type
Char[]	TpEditPreset	Preset text to display

Send_Commands (to vdvGroupControl):

"'SET_GROUP',<group_num>,<0|1|2>" where 0 = OFF, 1 = ON, 2 = TOGGLE
"'SET_PRE_DUSK_EVENT',<event_num>" turns on a pre-dusk event if pre-dusk is satisfied.
'Initialize' - Resets group data and reads data from disk.
'Load_Data' - Reads data from disk.
'Save_Data' - Saves data to disk.
'Ver' - Displays the compilation and version information for the module.

Send_Strings (from vdvGroupControl to TPs):

'GROUP_PAGE_UPDATE' - Group page must be refreshed.
"'GROUP_STATUS_UPDATE',<group_num>" group_num's data must be updated.

API Calls Supported:

None

API Calls Returned:

None

Last Modified: 05/16/2008 08:20:14 PM