Jandy AquaLink RS Module Information


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

Back to Corporate

General:

This module is used to control any model of AquaLink RS pool/spa system. The communications module is designed to get the model type from the AquaLink RS system and look up its index into the array of model properties passed into the module as a parameter. This allows the User Interface module to know how to behave for the particular model of AquaLink RS system being controlled. The UI module works for all models of AquaLink RS and works for either 3^rd or 4^th generation touch panels.

Prerequisites:

None

Comm. Module Header:

Type	Name	Description
Dev	vdvAquaLinkRs	Virtual device for the module
Dev	dv	AquaRs device being controlled
Integer[][]	aModel	Table of model properties for all models

UI Module Header:

Type	Name	Description
Dev	vdvAquaLinkRs	Virtual device for the comm. module
Dev	vdvTpPool	TP device for pool/spa pages
Integer[][]	aModel	Table of model properties for all models
Integer[]	cTpPumpLoEnabled	Pump Low control (discrete or toggle)
Integer[]	cTpPumpEnabled	Main Pump control (discrete or toggle)
Integer[]	cTpPoolHeaterEnabled	Discrete or toggle
Integer	cTpPoolHeaterActive	Pool Heater status
Integer	lTpPoolSP	Optional Pool Setpoint level control
Integer	cTpPoolSP	Pool Setpoint text feedback
Integer[]	cTpSpaOrPoolHt2_HeaterEnabled	Discrete or toggle
Integer	cTpSpaOrPoolHt2_HeaterActive	Heater status
Integer	lTpSpaOrPoolHt2_HeaterSP	Setpoint level control
Integer	cTpSpaOrPoolHt2_HeaterSP	Setpoint text feedback
Integer	lTpPoolTemp	Optional Pool Temperature level feedback
Integer	cTpPoolTemp	Pool Temperature text feedback
Integer[]	cTpSpaEnabled	Discrete or toggle
Integer[]	cTpSpaHeaterEnabled	Discrete or toggle
Integer	cTpSpaHeaterActive	Status
Integer	lTpSpaSP	Optional Spa Setpoint level control
Integer	cTpSpaSP	Spa Setpoint text feedback
Integer	lTpSpaTemp	Optional Spa Temperature level feedback
Integer	cTpSpaTemp	Spa Temperature text feedback
Integer[]	cTpSolarHeaterEnabled	Discrete or toggle
Integer	cTpSolarHeaterActive	Status
Integer	lTpSolarTemp	Optional Temperature level feedback
Integer	cTpSolarTemp	Temperature text feedback
Integer[]	cTpWaterfallEnabled	Discrete or toggle
Integer[]	cTpCleanerEnabled	Discrete or toggle
Integer[]	cTpAuxEnabled	Enable auxiliaries (discrete or toggle)
Integer[]	cTpAuxDisabled	Disable auxiliaries (not used if toggling)
Integer	lTpAirTemp	Optional Air Temperature level feedback
Integer	cTpAirTemp	Air Temperature text feedback
Integer	lTpBatteryVoltage	Optional Battery Voltage level feedback
Integer	cTpBatteryVoltage	Battery Voltage text feedback
Integer	cTpBatteryLow	Battery Low status
Char	ValidPoolPage	True if page is a pool page (input)
Integer	NewPage	True if page just changed
Char[]	ErrorPopup	Name of error popup to write to
Integer	cPuErrorMsg	Text channel for error message

Send_Commands (to Comm. Module):

'?' - This causes the module to display all supported commands via messages to the master.
'Ver' - Displays the compilation and version information for the module.
'Debug <n>' - Changes debug state where:
0 = No Debug status and turn off DEBUG channel on the virtual device.
1 = Display all minor debug information and turn on DEBUG channel on the virtual device.
2 = Display all sent and received data to/from the device and minor debug information.
'Pass-<string>' - Put <string> on the transmit queue.
'Xmit' - Get the current values for the transmit variables.

API Calls Supported:

'AquaRsGetLeds' (dv)
'AquaRsGetPumpLoState' (dv)
'AquaRsSetPumpLo' (dv, Enable)
'AquaRsTogglePumpLo' (dv)
'AquaRsGetPumpState' (dv)
'AquaRsSetPump' (dv, Enable)
'AquaRsTogglePump' (dv)
'AquaRsGetCleanerState' (dv)
'AquaRsSetCleaner' (dv, Enable)
'AquaRsToggleCleaner' (dv)
'AquaRsGetWaterfallState' (dv, Model)
'AquaRsSetWaterfall' (dv, Enable, Model)
'AquaRsToggleWaterfall' (dv, Model)
'AquaRsGetSpaState' (dv, Model)
'AquaRsSetSpa' (dv, Enable, Model)
'AquaRsToggleSpa' (dv, Model)
'AquaRsGetPoolHeaterState' (dv)
'AquaRsSetPoolHeater' (dv, Enable)
'AquaRsTogglePoolHeater' (dv)
'AquaRsGetPoolHeater2State' (dv, Model)
'AquaRsSetPoolHeater2' (dv, Enable, Model)
'AquaRsTogglePoolHeater2' (dv, Model)
'AquaRsGetSpaHeaterState' (dv, Model)
'AquaRsSetSpaHeater' (dv, Enable, Model)
'AquaRsToggleSpaHeater' (dv, Model)
'AquaRsGetSolarHeaterState' (dv)
'AquaRsSetSolarHeater' (dv, Enable)
'AquaRsToggleSolarHeater' (dv)
'AquaRsGetPoolSetpt' (dv)
'AquaRsSetPoolSetpt' (dv, Temperature)
'AquaRsGetPoolSetpt2' (dv, Model)
'AquaRsSetPoolSetpt2' (dv, Temperature, Model)
'AquaRsGetSpaSetpt' (dv, Model)
'AquaRsSetSpaSetpt' (dv, Temperature, Model)
'AquaRsGetPoolTemp' (dv)
'AquaRsGetSpaTemp' (dv, Model)
'AquaRsGetAirTemp' (dv)
'AquaRsGetSolarHeaterTemp' (dv, Model)
'AquaRsGetAuxState' (dv, Num, Model)
'AquaRsSetAux' (dv, Num, Enable, Model, OpSwitch)
'AquaRsToggleAux' (dv, Num, Model)

API Calls Returned:

The following APIs are called if their constants are defined (see the include file):

Define_Call 'AquaRsAuxNote' (AuxNum, Value)
Define_Call 'AquaRsAirTempNote' (Float TempNum, TempStr[6])
Define_Call 'AquaRsCleanerNote' (IsEnabled)
Define_Call 'AquaRsLedNote' (LedBytes[5])
Define_Call 'AquaRsOpModeNote' (ModeStr[7])
Define_Call 'AquaRsOptionsNote' (OptionNum)
Define_Call 'AquaRsPumpLoNote' (IsEnabled)
Define_Call 'AquaRsPumpNote' (IsEnabled)
Define_Call 'AquaRsPoolTempNote' (TempNum, TempStr[6])
Define_Call 'AquaRsPoolSetPtNote' (SetPtNum, SetPtStr[6])
Define_Call 'AquaRsPoolSetPt2Note' (SetPtNum, SetPtStr[6])
Define_Call 'AquaRsPoolHeaterNote' (IsEnabled)
Define_Call 'AquaRsPoolHeater2Note' (IsEnabled)
Define_Call 'AquaRsSolarTempNote' (TempNum, TempStr[6])
Define_Call 'AquaRsSolarHeaterNote' (IsEnabled)
Define_Call 'AquaRsSpaTempNote' (TempNum, TempStr[6])
Define_Call 'AquaRsSpaSetPtNote' (SetPtNum, SetPtStr[6])
Define_Call 'AquaRsSpaHeaterNote' (IsEnabled)
Define_Call 'AquaRsSpaNote' (IsEnabled)
Define_Call 'AquaRsBatteryNote' (VoltsNum, IsLow)
Define_Call 'AquaRsWaterfallNote' (IsEnabled)
Define_Call 'AquaRsErrorMsgNote' (ErrNum, ErrMsg[])
Define_Call 'AquaRsModelNote' (ModelIndex)

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