Back to Corporate | | General:This module is used to communicate with a Lutron Homeworks Interactive or P5 system comprising of up to sixteen panels. All features of the panel for lighting and keypads are available in the APIs listed below as well as those supervisory features deemed necessary. Because the number of commands that can be queued at any given time is, to a large extent, determined by the number of loads and keypads in the system, the queue size is determined by the user at compile time. Refer to the include files in the package for those constants to set. Prerequisites:None Module Header:| Type | Name | Description | | Dev | vdv | Virtual device for the module | | Dev | dv | Physical device for the module | | Char[][] | Queue | Queue for transmissions | | Long | BaudRate | Baud Rate to use if not an Ethernet connection. | | Long | SendInterval | Maximum milliseconds to wait between APIs sent. |
Send_Commands:- '?' - 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 <0|1>' - Set debug state off or on
- 'Pass-<string>' - Put string on the normal queue.
API Calls Supported:See supplied include file for APIs predefined. All commands must be sent to the virtual device. L3_LutronHwi_AppendDimmerAddr (Addresses, Proc, Link, IntCkt, ModBus, Dimmer);
Call 'L3_LutronHwi_BeginSceneSaver' (vdv, Minutes);
Call 'L3_LutronHwi_DimmerLevelMonitor' (vdv, Enable);
Call 'L3_LutronHwi_EndSceneSaver' (vdv);
Call 'L3_LutronHwi_FadeDimmer' (vdv, Intensity, FadeTime, DelayTime, Addresses);
Call 'L3_LutronHwi_FlashDimmer' (vdv, Intensity, FlashRate, Addresses);
Call 'L3_LutronHwi_GetDimmerLevel' (vdv, Proc, Link, IntCkt, ModBus, Dimmer);
Call 'L3_LutronHwi_GetFullSystemTime' (vdv);
Call 'L3_LutronHwi_GetGrafikEyeScene' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_GetKeypadEnabledState' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_GetKeypadLastBtnPress' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_GetKeypadLedState' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_GetSceneSaverStatus' (vdv);
Call 'L3_LutronHwi_GetSecurityMode' (vdv);
Call 'L3_LutronHwi_GetSivoiaScene' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_GetSunriseTime' (vdv);
Call 'L3_LutronHwi_GetSunsetTime' (vdv);
Call 'L3_LutronHwi_GetSystemDate' (vdv);
Call 'L3_LutronHwi_GetSystemTime' (vdv);
Call 'L3_LutronHwi_GetTimeClockState' (vdv);
Call 'L3_LutronHwi_GetVacationMode' (vdv);
Call 'L3_LutronHwi_GrafikEyeSceneMonitor' (vdv, Enable);
Call 'L3_LutronHwi_GrafikEyeSceneSelect' (vdv, Proc, Link, Address);
Call 'L3_LutronHwi_KeypadButtonDoubleTap' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadButtonHold' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadButtonMonitor' (vdv, Enable);
Call 'L3_LutronHwi_KeypadButtonPress' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadButtonRelease' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadButtonSceneRestore' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadButtonSceneSave' (vdv, Proc, Link, Address, Button);
Call 'L3_LutronHwi_KeypadEnable' (vdv, Proc, Link, Address, Enable);
Call 'L3_LutronHwi_KeypadLedMonitor' (vdv, Enable);
Call 'L3_LutronHwi_KeypadSetLed' (vdv, Proc, Link, Address, Led, State);
Call 'L3_LutronHwi_KeypadSetLeds' (vdv, Proc, Link, Address, Leds);
Call 'L3_LutronHwi_LowerDimmer' (vdv, Addresses);
Call 'L3_LutronHwi_ParseAddr' (Count, IntArray, Bufr);
Call 'L3_LutronHwi_RaiseDimmer' (vdv, Addresses);
Call 'L3_LutronHwi_RelayClose' (vdv, Proc, Link, Address, RelayNum);
Call 'L3_LutronHwi_RelayOpen' (vdv, Proc, Link, Address, RelayNum);
Call 'L3_LutronHwi_RelayPulse' (vdv, Proc, Link, Address, RelayNum, PTime);
Call 'L3_LutronHwi_SetDate' (vdv, theMonth, theDay, theYear);
Call 'L3_LutronHwi_SetDateString' (vdv, Str);
Call 'L3_LutronHwi_SetSecurityMode' (vdv, Enable);
Call 'L3_LutronHwi_SetTime' (vdv, Hours, Minutes, Seconds);
Call 'L3_LutronHwi_SetTimeString' (vdv, Str);
Call 'L3_LutronHwi_SetVacationMode' (vdv, Mode);
Call 'L3_LutronHwi_SivoiaClose' (vdv, Proc, Link, Address, SecondsDelay);
Call 'L3_LutronHwi_SivoiaLower' (vdv, Proc, Link, Address, SecondsDelay);
Call 'L3_LutronHwi_SivoiaOpen' (vdv, Proc, Link, Address, SecondsDelay);
Call 'L3_LutronHwi_SivoiaPreset' (vdv, Proc, Link, Address, Preset, SecondsDelay);
Call 'L3_LutronHwi_SivoiaRaise' (vdv, Proc, Link, Address, SecondsDelay);
Call 'L3_LutronHwi_SivoiaStop' (vdv, Proc, Link, Address, SecondsDelay);
Call 'L3_LutronHwi_StopDimmer' (vdv, Addresses);
Call 'L3_LutronHwi_StopFlash' (vdv, Addresses);
Call 'L3_LutronHwi_TimeclockEnable' (vdv, Enable);
API Calls Returned:
The following APIs are called if their constants are defined (see the include file). These APIs must be defined within the user code using the parameter signatures provided: Define_Call 'L3_LutronHwi_CommandNote' (vdv, CmdStr)
Define_Call 'L3_LutronHwi_SystemDateNote' (vdv, Months, Days, Years)
Define_Call 'L3_LutronHwi_DimmerIntensityNote' (vdv, Processor, Link, Interface, ModBus, Dimmer, Intensity)
Define_Call 'L3_LutronHwi_DimmerMonitoringNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_GrafikEyeSceneNote' (vdv, Processor, Link, Address, Scene)
Define_Call 'L3_LutronHwi_GEyeSceneMonitoringNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_KpdButtonMonitoringNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_KpdLedMonitoringNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_KeypadButtonDblTapNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_KeypadButtonHoldNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_KeypadButtonPressNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_KeypadButtonReleaseNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_KeypadEnableNote' (vdv, Processor, Link, Address, Enabled)
Define_Call 'L3_LutronHwi_KeypadLastButtonPressedNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_KeypadLedStatesNote' (vdv, Processor, Link, Address, Status)
Define_Call 'L3_LutronHwi_SceneSaverNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_SecurityNote' (vdv, Status) (* L3_LITE_SECURITY_BEGIN, L3_LITE_SECURITY_ACTIVE, LITE_SECURITY_TERMINATED *)
Define_Call 'L3_LutronHwi_SivoiaButtonDblTapNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_SivoiaButtonHoldNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_SivoiaButtonPressNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_SivoiaButtonReleaseNote' (vdv, Processor, Link, Address, Button)
Define_Call 'L3_LutronHwi_SivoiaSceneNote' (vdv, Processor, Link, Address, Command, IsMoving) (* Command is '1', '2', '3', 'R', 'L', 'C', 'o', or 'S' *)
Define_Call 'L3_LutronHwi_SunriseTimeNote' (vdv, SunriseTime)
Define_Call 'L3_LutronHwi_SunsetTimeNote' (vdv, SunsetTime)
Define_Call 'L3_LutronHwi_FullSystemTimeNote' (vdv, Hours, Minutes, Seconds)
Define_Call 'L3_LutronHwi_SystemTimeNote' (vdv, Hours, Minutes)
Define_Call 'L3_LutronHwi_TimeclockStateNote' (vdv, Enabled)
Define_Call 'L3_LutronHwi_VacationNote' (vdv, Status) (* L3_LITE_VACATION_RECORDING, L3_LITE_VACATION_PLAYING, L3_LITE_VACATION_DISABLED *)
|
