Upload
vominh
View
225
Download
0
Embed Size (px)
Citation preview
ii
Lutron integration protocol
Updates new to this release of the Lutron Integration Protocol
Revision Update: Y About Integration• Added“IntegrationBestPractices”section 3
Integrator’s Reference• Addedtworowstothetableandaddedfootnotes9,10,and11 6• Updatedthe“Parameters”for“Action#3”andaddedfootnote7 10• Changed“VenetianTilt”to“DeviceLockStateMonitoring”andaddedfootnotes5,6,and7 12
Temperature Controls• Updatedthe“Parameters”for“Action#3”andaddedfootnote10 Alsorearrangedthefootnotesin
numericalorderandmadefootnote7intoageneralnote 142• Rearrangedthefootnotesinnumericalorderandmadefootnote6intoageneralnote 143
Palladiom Thermostat• Updatedthe“DEVICECommandFormat” 147
Wireless Temperature Sensor• ChangestheParametervalueunder“ActionnumbersandParameters,”removedtheothertwo
rowsunder“ActionnumbersandParameters”aswellasthecorrespondingfootnotes 149
Customer Assistance• AddedEuropeandAsiacontactnumbers 157
Revisions to previous releases of the Lutron Integration Protocol
Revision Update: X Global Changes• Changed“multi-tap”to“double-tap”• Addedafootnotetoeverypagewhere“Set(#)CurrentTemperature”ismentioned
Table of Contents• Correctedpagenumbers
Integrator’s Reference• Addedarowfor“PhotoSensorMonitoring”and“OccupancyGroupMonitoring” 12
RadioRA 2• ChangedParameterinfirstrowto“ModeIndexNumber”under“ActionNumbersand
Parameters”chartandrewrotefootnote 33
HomeWorks QS• Changed“monitoringofsensors”to“MonitorsensorsstateswithMonitoringcommand”
under“IntegrationCapabilities” 48
myRoom Plus• Changed“monitoringofsensors”to“MonitorsensorsstateswithMonitoringcommand”
under“IntegrationCapabilities” 62
Continuedonnextpage…
iii
Lutron integration protocol
Revision Update: W (this revision was never published) Global Changes• Madesectionheadersandmodelnumberlistsmoreconsistentthroughoutdocument
HomeWorks QS• Added“monitoringofsensors”under“IntegrationCapabilities” 48
myRoom Plus• Added“monitoringofsensors”under“IntegrationCapabilities” 62
Devices• Moved“DEVICECommand”sectionbefore“OUTPUTCommand”sectionfor
HybridKeypadtomatchsequenceofotherdevicesections 132• Added“DEVICE ”bulletunder“SupportedCommandTypes” 141• Madechangesinthe“ComponentNumbers”chart,the“ActionNumbersandParameters”chart
andaddedtwofootnotes 149• Moved“DEVICECommand”sectionbefore“OUTPUTCommand”sectionfor
MaestroDimmerandPlug-InModuletomatchsequenceofotherdevicesections 152• AddedPalladiomThermostatDeviceCommands 163
Revision Update: V Global Changes• AdjustedformattingofSet(#),Get(?),andReport(~)operationssotheyareshownthesameway
consistentlythroughouttheentiredocument• Changed“/”to“or”toprovidebetterclaritythroughouttheentiredocument• Movedmostofthefootnotereferencestoleftcolumnoftablesthroughouttheentiredocument
Integrator’s Reference• Addedfootnotes#4-5tobottomofpage 10• Addedfootnote#4tobottomofpage 11
QS Standalone• Addedfootnotes#3-4tobottomofpage 23
Temperature Controls• Updatedfootnote#6 142• Deletedfootnotes#7-8andrenumberedfootnote#9to#7 142• Addednewfootnote#8tobottomofpage 142• Addedfootnote#7tobottomofpage 143• Addedsecondnotetobottomofpage 144
Palladiom Thermostat• Addedfootnote#2tobottomofpage 146
QSE-IO• Reorderedparametersforactionnumber14 151• Reorderedparametersforactionnumber1 152
Customer Assistance• Updatedmodelnumberexampletomorerecentproduct 156• AddedphonenumberforMexico 156
iv
Lutron integration protocol
Table of ContentsAbout IntegrationIntegrationOperations 1OperationCharacters 1CommandTypes 1CommandStructure 1CommandTermination 1CommandandControlExamples 2QueryExamples 2MonitoringExamples 2IntegrationAccessPoints 3CommandRulesandFormatting 3Inter-MessageDelays 3IntegrationBestPractices 3
Integrator’s ReferenceCompatibilityMatrix 4DEVICE:CommandSummary 5OUTPUT:CommandSummary 8GROUP:CommandSummary 9HVAC:CommandSummary 10MONITORING:CommandSummary 12ERROR:CommandSummary 13HELP:CommandSummary 14SYSTEM:CommandSummary 15
QS StandaloneSystemOverview 16IntegrationAccessPoints 17SystemCommands 19
RadioRA 2SystemOverview 27IntegrationAccessPoints 28SystemCommands 30
QuantumSystemOverview 34IntegrationAccessPoints 35SystemCommands 37
HomeWorks QSSystemOverview 46IntegrationAccessPoints 48SystemCommands 50
myRoom plusSystemOverview 60IntegrationAccessPoints 62SystemCommands 64
DevicesGRAFIKEyeQS 74EnergiSavrNodeQSforDALIR 78HomeWorksQS/myRoom
PowerModuleforDALIR 78EnergiSavrNodeQSwithEcoSystem 81EnergiSavrNodeQS
withEcoSystem(International) 81HomeWorksQS/myRoom
PowerModulewithEcoSystem 81EnergiSavrNodeQS
for0–10V/Softswitch(International) 84EnergiSavrNodeQS
forPhaseAdaptive(International) 84EnergiSavrNodeQSfor0–10V/Softswitch 84HomeWorksQS/myRoomPowerModule
for0–10V/Softswitch/PhaseAdaptive 84EnergiSavrNodeQS
forMotorModule(International) 87HomeWorksQS/myRoom
PowerModuleforMotorModule 87RemotePowerModule 90Low-CapacitySwitching
DINPowerModule(1A/output) 92Low-CapacityPhaseAdaptive
DINPowerModule(1A/output) 92PalladiomKeypad 95ArchitraveKeypad 98SignatureSeriesKeypad 101seeTouchKeypad 104seeTouchQSKeypad(International) 107TabletopseeTouchKeypad 110PicoWirelessControl 113HybridKeypad 115DynamicKeypad 119WallboxInputClosureInterface 121SivoiaQSShade/SivoiaQSWirelessShade 124SivoiaQSVenetianBlind/
SivoiaQSWirelessVenetianBlind 127MaestroDimmerandPlug-InModule 130MaestroFanSpeedControl 133VisorControlReceiver 135RadioPowrSavrSensor 139TemperatureControls 141PalladiomThermostat 145WirelessTemperatureSensor 148QSE-IOControlInterface 150QSSensorModule(QSM) 154
1
Lutron integration protocol
About IntegrationIntegration OperationsTheLutronintegrationprotocolwillallowthird-partyequipment,suchastouch-screens,universalremotecontrols,andsoftwareapplications,tocontrolandmonitordevicesinaLutronlightingcontrolsystem Theprotocolsupportsthreebasictypesofintegrationoperations:
• ExecuteanactionintheLutronsystem• QuerythestatusoftheLutronsystemandLutrondevices• MonitorresponsesfromtheLutronsystem
Operation CharactersTohelpcreateandmanagethedifferentintegrationoperations,threedistinctoperationcharactershavebeenselectedtobegineachcommand Allprotocolmessageswillstartwithoneofthefollowingoperationcharacters:
# Executeanaction(e g ,turnadimmeron/off)? Querysysteminformation(e g ,determineon/offstatusofadimmer)~ Monitorresponsesfromthesystemwhenrequestedorafterachangehasoccurred(e g ,if
someoneturnsonadimmerlocally,aresponsecommandissentouttoindicatethechange)Note to Integrator: Operation characters are not used in any other location in the protocol command string. Therefore, the driver can search for these characters to determine the start of a new command string.
Command TypesOperationcharacterswillbefollowedbycommandtypes Thetwomostcommoncommandsare:OUTPUTandDEVICE Othercommandtypesareavailable;seetheIntegrator’sReferenceforasummary
• OUTPUTallowscontrolandmonitoringofdeviceoutputssuchasdimmersandcontactclosureoutputs
• DEVICEallowscontrolandmonitoringofdeviceinputssuchasbuttonpresses,releases,andcontactclosureinputs
Command StructureTheprotocolcommandstructureismadeupofthreeparts:
Command Integration ID Command-specific fields
1. TheCommandismadeupoftheoperationcharacter(#,?,or~)andthecommandtype 2. TheIntegration IDisassignedtoeachdeviceinthesystemduringsystemsetup,providinga
uniqueuser-assignedaddressforeachsystemdevice 3. TheCommand-specific fieldscontainadditionalinformationrelevanttothetypeofcommand
Detailsaboutwhatcommand-specificfielddataissupportedcanbefoundintheappropriatedevicespecificsectionofthisintegrationprotocolguide
Command TerminationEachcommandismadeupoffields,separatedbycommas,andterminatedwithacarriagereturn(ASCIIdec13/hex0D)andalinefeed(ASCIIdec10/hex0A) Throughoutthisdocument,carriagereturnisshownas<CR>andlinefeedisshownas<LF>
2
Lutron integration protocol
About Integration (continued)
Command and Control Examples1) Thiscommandsetsadimmer(1)levelto75%witha1minuteand30secondfadetime
#OUTPUT,1,1,75,01:30<CR><LF>
Command Integration ID Command-specific fields
ActionNumber Level FadeTime
#OUTPUT 1 1 75 01:30
2) Thiscommandpressesbuttonnumber1ofakeypad(2) #DEVICE,2,4,3<CR><LF>
Command Integration ID Command-specific fields
ComponentNumber ActionNumber
#DEVICE 2 4 3
Query Examples3) Thiscommandrequeststheoutputlevelforadimmer(3)
?OUTPUT,3,1<CR><LF>
Command Integration ID Command-specific fields
Action
?OUTPUT 3 1
Monitoring Examples4) Whenausermakesachangetoadimmerlocally,thefollowingcommandresponsewouldbesent
outfromthesystemorwhenrequestedbythecommandinExample3above Thiscommandresponseexampleshowsthelocaldimmer(3)levelwaschangedto90% ~OUTPUT,3,1,90.00<CR><LF>
Command Integration ID Command-specific fields
Action Level
~OUTPUT 3 1 90 00
3
Lutron integration protocol
About Integration (continued)
Integration Access Points• IntegrationAccessPointscommunicatewithexternalsystemsusingRS232,Ethernetorboth
TheLutronintegrationprotocolwillallowthird-partyequipment,suchastouch-screens,keypads,andsoftwareapplications,tocontrolandmonitordevicesintheLutronlightingcontrolsystemthroughanIntegrationAccessPoint Formoreinformation,checkthepagespecifictotheIntegrationAccessPointbeingused AnexampleofanIntegrationAccessPointistheQSNetworkInterface(QSE-CI-NWK-E) ForalistingofalltheavailableIntegrationAccessPointssupportedbyaparticularsystem,seetheIntegrationAccessPointssectionforthatsysteminthetableofcontents
Command Rules and Formatting• AllcommandsareinASCIIcharacters• Eachcommandismadeupoffields,separatedbycommas,andterminatedwithacarriagereturn
(<CR>,ASCII13)andanewline(<LF>,ASCII10)• Lettercaseisignored• Spacesareignored• Leadingzerosareignored
Inter-Message DelaysInboundandoutboundmessageswiththeIntegrationProtocolwillexperiencesystemdelaysduringnormaloperation Thefollowingshowstheminimumdelaysexpected:
Command Type Minimum Inter-Message Delay
CommandandControl:Thesecommandsstartwith“#” 100ms
Query:Thesecommandsstartwith“?”1 1500ms
NOTE1 IntegrationsystemsshouldbedesignedtoutilizeMonitoringcommandstomaintainanup-to-dateviewofthecurrent
systemstate
Integration Best Practices• Besuretousethe#MONITORINGcommandtoenableonlythemonitoringyourequireforyour
application Onlargesystems,unnecessarymonitoringinformationmayleadtoextratrafficthatcausesdelayormalfunctioningofthethirdpartyintegrationsystems
• Whencreatingasceneinvolvingseverallights,itisbettertocreatethesceneintheLutronsystemandactivatethatsceneviaasingle#DEVICEcommandratherthanseveral#OUTPUTcommandsforeachlight
• CreateseparateloginsforeachthirdpartydevicewhichwillbeintegratingtotheLutronsystem
4
Integration Access Point Compatibility Matrix
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusQSNetworkInterface RadioRA2MainRepeater HomeWorksQSProcessor myRoom(GCU-HOSP)Processor
Device Compatibility Matrix
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusGRAFIKEyeQS EnergiSavrNodeQS/DALI® EnergiSavrNodeQS/EcoSystem EnergiSavrNodeQS/EcoSystem(Int’l) EnergiSavrNodeQS/0–10V/Softswitch(Int’l) EnergiSavrNodeQS/Phase-Adaptive(Int’l) EnergiSavrNodeQS/0–10V/Softswitch EnergiSavrNodeQS/MotorModule(Int’l) RemotePowerModule Low-CapacitySwitchingDINPowerModule(1A/output) Low-CapacityPhase-AdaptiveDINPowerModule(1A/output) PalladiomKeypad PalladiomThermostat ArchitraveKeypad SignatureSeriesKeypad seeTouchKeypad seeTouchQSKeypad(Int’l) TabletopseeTouchKeypad PicoWirelessControl HybridKeypad DynamicKeypad WallboxInputClosureInterface SivoiaQSShade SivoiaQSWirelessShade SivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlind MaestroDimmerandPlug-InModule MaestroFanSpeedControl VisorControlReceiver RadioPowrSavrSensor HVACController WirelessTemperatureSensor QSInput/OutputControlInterface QSSensorModule
Lutronintegrationprotocol
Integrator’s ReferenceCompatibility Matrix
5
Lutronintegrationprotocol
DEVICE Command-specific fields
Component Numbers: RefertodevicespecifictablesforlistsofComponentNumbers
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Enable1 1 None
Set(#)Disable1 2 None
Set(#)Press,Close,orOccupied 3 None
Set(#)Release,Open,orUnoccupied 4 None
Set(#)Hold2 5 None
Set(#)Double-tap2 6 None
Set(#)orGet(?)CurrentScene1,2 7 Scene
Set(#)orGet(?)LEDState 9 0=Off1=On2=NormalFlash2
3=RapidFlash2
Set(#)orGet(?)LightLevel3 14 0–100or0 00–100 00
SS ss,SS,MM:SS,orHH:MM:SS
SS ss,SS,MM:SS,orHH:MM:SS
NOTES1 Quantum2 7andhigher 2 NotsupportedinRadioRA2 3 NotsupportedbyQuantum
DEVICE Command Formats
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
Integrator’s Reference (continued)
DEVICE: Command SummaryDeviceintegrationcommandsallowtheusertoaccesscomponentsofthesystemsuchasaphysicaldevice Theusercanactivateprogrammingviabuttonpresses,releases,etc ,aswellasmonitorthosesameeventsastheyoccurinthesystem
6
Lutron integration protocol
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLock1,2,3 15 0=Off1=On
Set(#)orGet(?)SceneLock1,2,3 16 0=Off1=On
Set(#)orGet(?)SequenceState1,2,3 17 0=Off1=Scenes1–42=Scenes5–16
Set(#)StartRaising3,4,5 18 None
Set(#)StartLowering3,4,5 19 None
Set(#)StopRaisingorLowering3,4,5 20 None
Get(?)batterystatus 22 1=Normal,2=Low
Set(#)acustomliftandtiltlevelofvenetianblindsprogrammedtothephantombutton4,6
23 Liftlevel%Tiltlevel%
Set(#)acustomliftlevelonlyofvenetianblindsprogrammedtothephantombutton4,6
24 Liftlevel%
Set(#)acustomtiltlevelonlyofvenetianblindsprogrammedtothephantombutton4,6
25 Tiltlevel%
Set(#)HoldorRelease2 32 None
Set(#)GRAFIKEyeQSTimeclockstate 34 0=Disabled1=Enabled
Get(?)QueryCCIstate8 35 None
Set(#)orGet(?)ActiveLEDLevel7 36 0–100%
Set(#)orGet(?)InactiveLEDLevel7 37 0–100%
Get(?)SensorTemperature(°F)9,10,11 41 None
Get(?)SensorTemperature(°C)9,10,11 42 None
NOTES1 NotsupportedinHomeWorksQS 2 NotsupportedinRadioRA2 3 NotsupportedbyQuantum 4 UseOUTPUTcommandwithequivalentactionnumberinRadioRA2 5 UseOUTPUTcommandwithequivalentactionnumberinHomeWorksQS 6 UseSHADEGRPcommandwithequivalentactionnumberinHomeWorksQS 7 AppliesonlytoPalladiomkeypads 8 RequiresNWKfirmware8 47ornewerforQSStandalonesystems 9 SupportedbyPalladiomThermostatonly 10 Thisfunctionreports“UNKNOWN”ifthevalueisnotknown 11 Whenissuingthiscommand,usetheintegrationIDandcomponentnumberofthetemperaturesensor,not
theHVACzone
Integrator’s Reference (continued)
DEVICE: Command Summary (continued)
Continuedonnextpage…
7
Lutron integration protocol
Programming Options Required Integration Action Numbers
Button Type Double Tap Hold Cycle
DimPress
(3)Release
(4)Double-Tap
(6)Hold (5)
Hold Release (32)
Single-ActionandToggleButtons
— — — — — — —
— — — — —
— — — — —
— — —
— — — —
DualActionButtons— — — — — —
— — — —
MasterandSingleSceneRaise/LowerButtons
— — — — — —
Open/Stop/Close/StopButtons — — — — — — —
Integrator’s Reference (continued)
DEVICE: Command Summary (continued)
HomeWorks / myRoom plus QS Button Types and Integration Requirements: RefertoLutronDesignersoftwareforsettingupprogrammingoptions
RadioRA 2 Button Types and Integration Requirements: RefertoRadioRA2Essentials/Inclusivesoftwareforsettingupprogrammingoptions
Programming Options Required Integration Action Numbers
Button Type Scene Save Enabled
Press (3)
Release (4)
Double-Tap (6)
Hold (5)
Hold Release (32)
Single-ActionandToggleButtons
— — — — —
— — —
MasterandSingleSceneRaise/LowerButtons
— — — —
ShadeToggleButtons — — — — —
8
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 0–100or0 00–100 00SS ss1,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 NoneSet(#)StartFlashing2 5 SS ss1,SS,MM:SS,orHH:MM:SSSet(#)PulseTime 6 SS ss1,SS,MM:SS,orHH:MM:SSSet(#)orGet(?)tiltlevel3,4 9 TiltLevel5=0–1006or0 00–100 005,6
Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay3in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)orGet(?)lift&tiltlevel4 10 LiftLevel5=0–100or0 00–100 005TiltLevel5=0–100for0 00–100 005,6
Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay3in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt4 11 NoneSet(#)StartLoweringTilt4 12 NoneSet(#)StopRaisingorLoweringTilt4 13 NoneSet(#)StartRaisingLift4 14 NoneSet(#)StartLoweringLift4 15 NoneSet(#)StopRaisingorLoweringLift4 16 NoneSet(#)DMXColororLevelSettings7,8 17 Color/levelindex:0–255/0 00–100 00Set(#)MotorJogRaise7,9 18 NoneSet(#)MotorJogLower7,9 19 NoneSet(#)Motor4-StageJogRaise7,9 20 NoneSet(#)Motor4-StageJogLower7,9 21 None
NOTES1 Fractionsareroundeduptotheclosest1/4second 2 Tostopadimmerfromflashing,sendittoavalidlevel(action1) 3 TheDelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay Theminimumdelaytimeis
0 seconds Themaximumdelaytimeis4hours 4 NotsupportedinQuantum 5 Forswitchedoutputs,anynon-zerolevelresultsinonorclosed,0resultsinofforopen 6 50forHorizontalSheerBlinds 7 NotsupportedinRadioRA2 8 SupportedinQuantumversion2 2andhigher 9 SupportedinQuantumversion2 5andhigher
Lutronintegrationprotocol
OUTPUT Command Format
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,6,ActionNumber,Parameters
Integrator’s Reference (continued)
OUTPUT: Command SummaryOutputsaredimmers,CCOs,orotherdevicesinasystemthathaveacontrollableoutput Allofthesedeviceswillacceptlevelsfrom0%to100%and0 00%to100 00%withagivenfadeanddelaytime Thesesamecommandscanbemonitoredastheyoccurinthesystem
9
Lutron integration protocol
Integrator’s Reference (continued)
GROUP1: Command SummaryTheGROUPcommandisusedtoreportthestatusofagroupofoccupancysensors
GROUP Command-specific fields
Action Numbers:
Action Action Number
Get(?)OccupancyGroupState 3
GROUP Command Format
Use “GROUP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
?GROUP,6,ActionNumber
Example GROUP Messages
Operation Command String
Query:?GROUP,IntegrationID,ActionNumber
WhatisOccGROUP1’sstatus? ?GROUP,1,3<CR><LF>
Response:~GROUP,IntegrationID,ActionNumber,Parameters
Occgroup1isoccupied ~GROUP,1,3,3<CR><LF>
Occgroup1isunknown ~GROUP,1,3,255<CR><LF>
Occupancy States:
Description Value
Occupied 3
Unoccupied 4
Unknown 255
NOTE1 NotsupportedinQSStandalone
Continuedonnextpage…
10
Lutron integration protocol
Integrator’s Reference (continued)
HVAC: Command SummaryHVACIntegrationcommandsallowtheusertoaccessthefeaturesandcomponentsofHVACcontrollersinthesystem TheusercanmodifyHVACparametersliketheoperatingmode,fanmodeetc ,aswellasmonitorthechangestotheseparametersastheyoccurinthesystem
HVAC Command Format
Use “HVAC Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#HVAC,21,ActionNumber,Parameters
HVAC Command-specific fields
Action NumbersandParameters: 1
Action Action Number Parameters
Set(#)orGet(?)CurrentTemperature(°F)5,6 1 Temperature=32–212°F
Set(#)orGet(?)HeatandCoolSetpoints(°F)2,4,5 2 SetpointHeat(SPH)=32–212°F
SetpointCool(SPC)=32–212°F
Set(#)orGet(?)OperatingMode 3 Mode(1=Off/Protect,2=Heat,3=Cool,4=Auto,5=Em Heat,67=Lockedout,7=Fan,8=Dry)
Set(#)orGet(?)FanMode 4 Mode(1=Auto,2=On,3=Cycler,4=NoFan,5=High,6=Medium,7=Low,8=Top)
Set(#)orGet(?)Eco(Setback)Mode 5 Mode(1=Off,2=On)
Get(?)EcoOffset 6 EcoOffset=1–11°F
Set(#)orGet(?)ScheduleStatus3 7
0=ScheduleUnavailable(Get“?”Only)1=FollowingSchedule(Set“#”orGet“?”)2=PermanentHold(Set“#”orGet“?”)3=TemporaryHold(Get“?”only)
Get(?)TemperatureSensorConnectionStatus 8
1=AllSensorsareActive2=MissingSensor3=WiredSensorOnly4=NoSensor
Get(?)ScheduleEvent 9 Schedule#(1–7),Event#(1–4),HH,MM,SPH,SPC
Get(?)ScheduleDayAssignment 10 Schedule#(1–7),DD(Bitmap:Sunday(Bit0)–Saturday(Bit6)1–activeday,0– inactiveday)
Get(?)SystemMode 111=Normal2=Away3=Green
Get(?)HeatandCoolSetpoints(°F)withoutEcoOffsetifapplied5 12 SetpointHeat(SPH)=32–212°F
SetpointCool(SPC)=32–212°F
Get(?)EmergencyHeatAvailable 13 1=NotAvailable2=Available
NOTES1 ThesecommandsaresupportedonlyforHomeWorksQS,RadioRA2,myRoomPlus 2 ChangingthesetpointwillturnEcoModeoffifitiscurrentlyon 3 ScheduleUnavailable–>Schedulenotprogrammedordeviceneedsdate/time
FollowingSchedule–>Runningprogrammedschedule;setpointsfromschedule PermanentHold–>Scheduleisnotrunning;setpointsasadjusted TemporaryHold–>Runningschedule;setpointsasadjusted Returnstofollowingscheduleatnextscheduleevent
4 Toleaveaparameterunchanged,use“255”asthevalueforthatparameterwhenendingthecommand 5 Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
6 SettingofcurrenttemperatureisonlypossibleiftheHVACzoneisconnectedtoa3rdpartyHVACcontroller 7 RCSHVACcontrollerlockedoutduetomissingwiredsensor Thisparametercan
onlyberead Continuedonnextpage…
11
Lutron integration protocol
Integrator’s Reference (continued)
HVAC: Command Summary (continued)
HVAC Command-specific fields (continued)
Action NumbersandParameters (continued):
Action Action Number Parameters
Set(#)orGet(?)CallStatus 14
0=None,LastwasHeat1=HeatStage12=HeatStage1and23=HeatStage1,2,and34=HeatStage35=None,LastwasCool6=CoolStage17=CoolStage1and28=Off9=EmergencyHeat10=Dry
Set(#)orGet(?)CurrentTemperature(°C)1,4,5 15 Temperature=0–100°C
Set(#)orGet(?)HeatandCoolSetpoints(°C)2,3,4 16 SetpointHeat(SPH)=0–100°C
SetpointCool(SPC)=0–100°CGet(?)HeatandCoolSetpoints(°C)withoutEcoOffsetifapplied2,4 17 SetpointHeat(SPH)=0–100°C
SetpointCool(SPC)=0–100°CSet(#)orGet(?)SingleSetpoint(°F)andDrifts3,4 18 SingleSetpoint=
32–212°FNegativeDrift=0–15°F
PositiveDrift=0–15°F
Set(#)orGet(?)SingleSetpoint(°C)andDrifts3,4 19 SingleSetpoint=
0–100°CNegativeDrift=0–8°C
PositiveDrift=0–8°C
NOTES1 HomeWorksQSsoftwareversion4 1andhigher 2 ChangingthesetpointwillturnEcoModeoffifitiscurrentlyon 3 Toleaveaparameterunchanged,use“255”asthevalueforthatparameterwhenendingthecommand 4 Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
5 SettingofcurrenttemperatureisonlypossibleiftheHVACzoneisconnectedtoa3rdpartyHVACcontroller
12
Lutronintegrationprotocol
MONITORING Command-specific fields
Monitoring Type:
Description Monitoring Type
Set(#)orGet(?)DiagnosticMonitoring 1Set(#)orGet(?)EventMonitoring 2Set(#)orGet(?)ButtonMonitoring1 3Set(#)orGet(?)LEDMonitoring1,2 4Set(#)orGet(?)ZoneMonitoring1 5Set(#)orGet(?)Occupancy1 6Set(#)orGet(?)PhotoSensorMonitoring 7Set(#)orGet(?)Scene#1 8Set(#)orGet(?)SystemVariable 10Set(#)orGet(?)ReplyState(ifdisabled,allmessagesFROMtheintegrationaccesspointwillcease)1,3
11
Set(#)orGet(?)PromptState(ifdisabled,thepromptwillnotbeprintedtotheterminal)1,3 12Set(#)orGet(?)OccupancyGroupMonitoring 13Set(#)orGet(?)DeviceLockStateMonitoring 14Set(#)orGet(?)SequenceMonitoring2 16Set(#)orGet(?)HVACMonitoring1,2,4 17Set(#)orGet(?)ModeMonitoring1,2,4 18Set(#)orGet(?)ShadeGroupMonitoring1,5 23Set(#)orGet(?)PartitionWall5,6 24Set(#)orGet(?)TemperatureSensorMonitoring1,7 27Set(#)orGet(?)StateofAllMonitoring(exceptReplyandPrompt) 255
NOTES1 Thefollowingmonitoringtypesareenabledbydefault,foruser-leveltelnetlogin:3-Button,4-LED,5-Zone,6-Occupancy,
8-Scene,11-Reply,12-Prompt,17-HVAC,18-Mode,23-Shade 2 NotsupportedinQSStandalone 3 Thefollowingmonitoringtypesareenabledbydefault,foradmin-leveltelnetlogin:11-Reply,12-Prompt 4 NotcompatiblewithQuantum 5 NotsupportedinRadioRA2andHomeWorksQS 6 NotsupportedviaQSE-CI-NWK-EinQuantum 7 SupportedbyPalladiomThermostatonly
Action Numbers:
Action Action Number
Enable 1
Disable 2
MONITORING Command Formats
Use “MONITORING Command-specific fields” tables to complete these command fields.
Operation
Command
#MONITORING,MonitoringType,ActionNumber
Integrator’s Reference (continued)
MONITORING: Command SummaryMonitoringallowstheusertoconfigurewhattypesofmessagesthesystemwillreport Note to Integrator:The default values of these are set in the programming database and restored whenever the integration port is logged in. The user can temporarily change those settings to hide or show information as desired.
13
Lutronintegrationprotocol
ERROR Command Formats
Refer to “ERROR Command-specific fields” table
Operation
Command
~ERROR,ErrorNumber
ERROR Command-specific fields
Error Numbers:
Description Error Number
Report(~)Parametercountmismatch 1
Report(~)Objectdoesnotexist 2
Report(~)Invalidactionnumber 3
Report(~)Parameterdataoutofrange 4
Report(~)Parameterdatamalformed 5
Report(~)UnsupportedCommand 6
Example ERROR Messages
Operation Command String
Parameter count mismatch: Toomanyortoofewparametersforthespecifiedaction
Toomanyparameterswhenactivatingscene #AREA,2,6,1,1,1,1,1<CR><LF>
Parametercountmismatch ~ERROR,1<CR><LF>
Object does not exist: TheIntegrationIDorserialnumberentereddoesnotmaptoaknownpartofthesystem
SendcommandtoanIDthatisnotvalid #OUTPUT,1234,1,100.00<CR><LF>
Objectdoesnotexist ~ERROR,2<CR><LF>
Invalid Action: Theactiondoesnotexistforthiscommand
Sendinvalidaction(4321)toArea2 #AREA,2,4321<CR><LF>
Invalidactionnumber ~ERROR,3<CR><LF>
Parameter data out of range: Theparameterdataisoutofrangeforthisaction
SendOutput11to120% #OUTPUT,11,1,120.00<CR><LF>
Parameterdataoutofrange ~ERROR,4<CR><LF>
Parameter data malformed:Theparameterdatagivenwasnotformattedproperly
SetTimeto12:23:24:25 #SYSTEM,1,12:23:24:25<CR><LF>
Invalidactionnumber ~ERROR,5<CR><LF>
Integrator’s Reference (continued)
ERROR: Command SummaryIntegrationAccessPointswillrespondwithanerrorifaninvalidcommandisreceived Seethetablebelowforexplanationsofdifferenterrors
14
Lutron integration protocol
HELP Command Formats
Example HELP Messages
Operation Command String
Query: ?HELP,CommandName,ActionNumber
WhatareallthesupportedIntegrationCommands? ?HELP<CR><LF>
Whatactionsareavailablefor#OUTPUT? ?HELP,#OUTPUT<CR><LF>
Howis“Raise”usedfor#OUTPUT? ?HELP,#OUTPUT,2<CR><LF>
Response: ~HELP,HelpInformation
ThelistofallIntegrationCommands #OUTPUT,?OUTPUT,#DEVICE,?DEVICE,#AREA, ?AREA,#TIMECLOCK,?TIMECLOCK,#SYSTEM, ?SYSTEM,#MONITORING,?MONITORING, <CR><LF>
Thehelpinformationforthe#OUTPUTcommand ~HELP, #OUTPUTrequiresaction<1–6><CR><LF>1=SetLevel/Position2=StartRaising3=StartLowering4=StopRaising/Lowering6=PulseUSAGE:#OUTPUT,<ID>,<action>,<CR><LF>
Thehelpinformationforthe“Raise”action(#OUTPUT) ~HELP, #OUTPUT,<action=2>startraisingoutputlevel<CR><LF>USAGE:#OUTPUT,<ID>,<action=2><CR><LF>
Operation
Command
?HELP,CommandName2,ActionNumber3
Integrator’s Reference (continued)
HELP1: Command SummaryHELPCommandforaspecificCommandNameprovidescommand-namespecificusageinformation
NOTES1 HELPnotsupportedinQSStandalone 2 The“CommandName”parameterisoptional Ifnotentered,alistofallthesupportedIntegrationCommandswillbe
printed Ifasupportedcommandnameisentered,thecorrespondingactionswillbelisted 3 The“Action”parameterisoptional Whenavalidactionnumberisentered(i e itissupportedbythecorresponding
“CommandName”),thehelpinformationforthatparticularactionwillbedisplayed
15
Lutron integration protocol
SYSTEM Command Formats
SYSTEM Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)Time1 1 Timein:SS ss,SS,MM:SS,orHH:MM:SS
Set(#)orGet(?)Date 2 DateinMM/DD/YYYY
Set(#)orGet(?)LatitudeandLongitude
4 Latitude=–90 00to+90 00degreesLongitude=–180 00to+180 00degrees
Set(#)orGet(?)TimeZone2
5 Hours=–12to12Minutes=0to59
Get(?)Sunset 6 None
Get(?)Sunrise 7 None
Get(?)OSRev 8 None
Set(#)LoadShed3 11 0=Disabled1=Enabled
NOTES1 Thesystemtimemustbeenteredin24hourformat 2 TheTimeZoneisreferencedtoGMT 3 LoadShedcommandsavailableonlyonQuantumversion2 0andhigher
Example SYSTEM Messages
Operation Command String
Execute: #SYSTEM,ActionNumber,Parameters
Settimeto5:45PM #SYSTEM,1,17:45<CR><LF>
SetdatetoJune1,2009 #SYSTEM,2,06/01/2009<CR><LF>
Query: ?SYSTEM,ActionNumber
Whatisthesystemtime? ?SYSTEM,1<CR><LF>
Whatisthesystemdate? ?SYSTEM,2<CR><LF>
Response: ~SYSTEM,ActionNumber,Parameters
Thesystemtimeis11:05AM ~SYSTEM,1,11:05:00<CR><LF>
ThesystemdateisJuly3,2009 ~SYSTEM,2,07/03/2009<CR><LF>
Use “SYSTEM Command-specific fields” tables to complete these command fields.
Operation
Command
#SYSTEM,ActionNumber,Parameters
Integrator’s Reference (continued)
SYSTEM1: Command SummarySYSTEMCommandprovidessupportforlocation,deviceandsystemspecificinformation(e g ,Date,Time,SoftwareVersionNumbers)
NOTE1 NotsupportedinQSStandalone
16
Lutron integration protocol
QS StandaloneSystem OverviewTheQSfamilyofproductsdeliversscalablelightingandshadingsolutionsforresidentialandcommercialapplications AtthecenteroftheQSsystemaretheGRAFIKEyeQScontrolunits,EnergiSavrNodecontrolunits,andSivoiaQSshadesanddrapes,providingdirectcontrolofelectricandnaturallight QSsystemdevicescommunicateoverthehighlyflexibleQSlink;thelinkallowsfordaisy-chainort-tapwiringconfigurations AllQSsystemdevicescommunicatewithouttheneedforinterfaces,andaddressingisautomatic,eliminatingtheneedtosetDIPswitches Inaddition,QSkeypadsareconfigurableinthefieldtocontrollights,shades,lights+shades,orthird-partydevices TheQSsystemcanbeeasilyintegratedwithothersystemsthroughcontact-closureinput/output,DMXoutput,orEthernet/RS232
QS System Device Compatibility IndexQS Standalone
GRAFIKEyeQS EnergiSavrNodeQS/DALI® EnergiSavrNodeQS/EcoSystem EnergiSavrNodeQS/EcoSystem(Int’l) EnergiSavrNodeQS/0–10V/Softswitch(Int’l) EnergiSavrNodeQS/Phase-Adaptive(Int’l) EnergiSavrNodeQS/0–10V/Softswitch EnergiSavrNodeQS/MotorModule(Int’l) ArchitraveKeypad SignatureSeriesKeypad seeTouchKeypad seeTouchQSKeypad(Int’l) PicoWirelessControl WallboxInputClosureInterface SivoiaQSShade SivoiaQSWirelessShadeSivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlindQSInput/OutputControlInterface QSSensorModule
17
Lutron integration protocol
Why Integrate with a QSE-CI-NWK-E?• IntegratesaQSlightingcontrolsystemwithaPCorotherdigitalequipmentthatsupportsRS232
orEthernetTCP/IPconnection • Allowsmonitorandcontrolofsystemdevices Forexample,theQSE-CI-NWK-Ecanbeusedto
simulatebuttonpresses,reportbuttonpresses,controllightlevels,andmonitorlightlevels
Supported Commands• MONITORINGspecifieswhattypeofmessagesthesystemwillreport• ETHERNETmodifiestheEthernetconfigurationsoftheQSE-CI-NWK-E• RESETrestartstheQSE-CI-NWK-Eorrestoresittofactorydefaults• INTEGRATION IDassignsIDstodevices,sothattheymaybereferredtoinamorelogicalfashion• DETAILSreturnsinformationaboutaQSdevice• ERRORreportssyntaxerrorsinanintegrationstringcommandorquery• PROGRAMMINGallowsusertoprogramPhantomButtonsontheNWKsupportedinversion8 0
orhigher• DEVICEusedtoactivatePhantomButtonsontheNWK• OUTPUTusedtocontroloutputsofaDevice• “Programming”and“Device”commandsrequireversion8 0orhigheroftheNWKsoftware
QS Standalone (continued)
Integration Access Points NetworkInterface
Model:QSE-CI-NWK-E
Continuedonnextpage…
18
Lutron integration protocol
Connection Information ProvidesanRS232andEthernetconnectiontocommunicatewithexternalequipment
CommunicationisthrougheitherRS232orEthernet,butnotbothsimultaneously RS232 TheRS232connectionhasthefollowingcommunicationsettings:• BaudRate9600/19200/38400/115200(setviadipswitchonunit)• 8databits• Noparitybit• 1stopbit• Noflowcontrol Ethernet Configuringthecontrolinterfacetocommunicateoveranetworktakesnotonlyknowledge
oftheQSsystem,butofnetworkingaswell InstallerswithlimitednetworkingknowledgeareadvisedtocontactanetworkingprofessionalbeforeattemptingtoconnectaQSE-CI-NWK-Ethroughanetwork TheinformationbelowwillhelpaninstallercommunicatetheQSE-CI-NWK-Econfigurationstoanetworkprofessional
TheinstallerwillmakeanynecessarychangestothecontrolinterfaceusingtheLutronDeviceIPorPCsoftwaretoolandthenetworkprofessionalcanmakeanynecessarychangestothenetworkingequipment
Single Ethernet Port• IEEE®802 3Auto-Sensing10BaseT/100BaseTX• SupportsMDI/MDIXauto-crossover(nocrossovercableneeded) • Female8P8C“ComputerRJ-45”socket• Green“Connect”LED,Amber“Activity”LED• UseCat5cablingorbetter TCP / IP Settings• IPAddress:<staticdefault=192 168 250 1>• SubnetMask:<staticdefault=255 255 255 0>• Gateway:<staticdefault=0 0 0 0> Protocols Used for Integration• TELNET Telnet Server• Usedbythirdpartyequipment(i e touchscreen)• LimitedtotransferringASCIIcharacters• TelnetPortnumberis23• Login #1:nwk• Login #2:nwk2
QS Standalone (continued)
Integration Access Points (continued)
19
Lutron integration protocol
ETHERNET Command Formats
ETHERNET Command-specific fields
Configuration Numbers:
Description Configuration Number Parameters
Set(#)orGet(?)IPAddress 0 Address(XXX XXX XXX XXX)
Set(#)orGet(?)GatewayAddress
1 Address(XXX XXX XXX XXX)
Set(#)orGet(?)SubnetMask 2 Address(XXX XXX XXX XXX)
Set(#)orGet(?)LoginInfo 3 User(0=Allusers;1=User1;2=User2),OldLogin,NewLogin
Example ETHERNET Commands
Operation Command String
Execute: #ETHERNET,ConfigurationNumber,Parameters
SetIPAddressto192 168 250 1 #ETHERNET,0,192.168.250.1<CR><LF>
SetGatewayAddressto10 2 4 1 #ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET,ConfigurationNumber,Parameters
WhatistheIPAddress? ?ETHERNET,0<CR><LF>
WhatistheLoginInformationforuser1? ?ETHERNET,3,1<CR><LF>
WhatistheLoginInformationforALLusers?(Note:0=ALL) ?ETHERNET,3,0<CR><LF>
Response: ~DEVICE,IntegrationID,ConfigurationNumber,Parameters
TheIPAddressis192 168 250 1 ~ETHERNET,0=,192.168.250.1<CR><LF>
QS Standalone (continued)
System CommandsETHERNETCommands
Use “ETHERNET Command-specific fields” tables to complete these command fields.
Operation
Command
#ETHERNET,ConfigurationNumber,Parameters
20
Lutron integration protocol
INTEGRATION ID Command Formats
INTEGRATION ID Command-specific fields
Action Numbers and Parameters:
Description Action Number Parameters
Set(#)orGet(?)IntegrationIDforaSerialNumber
1 SerialNumber=8characterHEXserialnumberofthedeviceIntegrationID=TheintegrationIDtobeassigned
Set(#)ChangeIntegrationID 2 CurrentIntegrationID,NewIntegrationIDNote:AnerrorwillbereportedifthenewIntegrationIDisthesameasanexistingIntegrationIDinthesystem
Get(?)InfofromID 3 IntegrationIDNote:Ifthisfieldisleftblank,allintegrationIDswillbeprinted
Set(#)orGet(?)OutputIntegrationID
4 SerialNumber,ComponentNumber,IntegrationID
Example INTEGRATION ID Commands
Operation Command String
Execute: #INTEGRATIONID,ActionNumber,Parameters
SettheIntegrationIDforaserialnumber #INTEGRATIONID,1,1234ABCD,kitchen dimmer<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
SettheIntegrationIDforaserialnumber ~INTEGRATIONID,1,1234ABCD,kitchen dimmer<CR><LF>
Execute: ?INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ~INTEGRATIONID,1,5678EFEF,living room keypad<CR><LF>
Execute: #INTEGRATIONID,ActionNumber,Parameters
ChangetheIntegrationID #INTEGRATIONID,2,diningroomlights1,diningroomaccents<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
ChangetheIntegrationID ~INTEGRATIONID,2,diningroomlights1,diningroomaccents<CR><LF>
Execute: ?INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand
?INTEGRATIONID,3,livingroomkeypad<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand ~INTEGRATIONID,3,livingroomkeypad,DEVICE,5678EFEF<CR><LF>
QS Standalone (continued)
System Commands (continued)INTEGRATIONIDCommands
Use “INTEGRATIONID Command-specific fields” tables to complete these command fields.
Operation
Command
#INTEGRATIONID,ActionNumber,Parameters
21
Lutron integration protocol
Example DETAILS String
Operation Command String
Query: ?DETAILS,ID
GetdetailsofthedevicewithserialIDnumber00AC123D ?DETAILS,00AC123D<CR><LF>
Response: ~DETAILS,SerialNumber,Name,Family,Model,SoftwareRev ,BootSoftwareRev
ThedevicewithserialIDnumber00AC123Dhasthefollowinginformation:Name=GRAFIKEye1ProductFamily=GRAFIKEyeProductModel=QSGSoftwareRevision=1 70BootCodeSoftwareRevision=2
~DETAILS,SN:00AC123D,IntegrationID:GRAFIKEye1,Family:GRAFIK_Eye(2),Product:QSG(1),CODE:1.70,Boot:2.1,HW:1.1<CR><LF>
DETAILS Command Formats
Operation
Command
?DETAILS,ID1
QS Standalone (continued)
System Commands (continued)DETAILSString
NOTE1 DeviceIDmaybeenteredastheserialIDnumberortheIntegrationID UseALL_DEVICESorFFFFFFFFtoqueryall
devicesonthelink
Continuedonnextpage…
22
Lutron integration protocol
RESET Command Formats
RESET Command-specific fields
Action Numbers:
Action Action Number
Set(#)restartthedevice 0
Set(#)restoretofactorydefaults 1
Set(#)restoretofactorydefaults(doesnotaffecttheIPaddress,Gatewayaddress,subnetmasksettings)
2
Example RESET Commands
Operation Command String
Execute: #RESET,ActionNumber
RestarttheNWK #RESET,0<CR><LF>
RestoreNWKtofactorydefaults #RESET,1<CR><LF>
Use “RESET Command-specific fields” tables to complete these command fields.
Operation
Command
#RESET,ActionNumber
QS Standalone (continued)
System Commands (continued)RESETCommands
23
Lutron integration protocol
QS Standalone (continued)
System Commands (continued)PROGRAMMINGCommands
PROGRAMMING Command-specific fields
Action NumbersandParameters:
Description Action Number Parameters
Set(#)addprogrammingtoaphantombutton 1 a)IntegrationID–TheIntegrationIDofthedeviceb)ComponentNumber–Always‘0’forShadec)Level–Theleveltowhichtheshadebeing
programmedwillgoonactivationofthisbuttond)Fade–Thetimethezonetakestoreachthe
levelspecified(maximum4hours)1e)Delay–ThetimeuntiltheShade/Zonebegins
tochange(maximum4hours)Set(#)addsceneprogrammingtoaphantombutton
2 a)IntegrationIDb)ComponentNumber(GRAFIKEyeQSScene
controller,EnergiSavrNodearea2)c)SceneNumber
Set(#)clearprogrammingfromaphantombutton3
3 None
Set(#)configureStop-If-Movingfunctionality4 4 0=Stop-If-MovingOff1=Stop-If-MovingOn
Set(#)addprogrammingtoaphantombutton(Venetianblind,liftandtiltlevels)
5 a)VenetianIntegrationIDb)ComponentNumber(always0)c)Liftleveld)Tiltlevel
Set(#)addprogrammingtoaphantombutton(Venetianblind,tiltonly)
6 a)VenetianIntegrationIDb)ComponentNumber(always0)c)Tiltlevel
Set(#)addprogrammingtoaphantombutton(Venetianblind,liftonly)
7 a)VenetianIntegrationIDb)ComponentNumber(always0)c)Liftlevel
NOTES Amaximumof500programmingassignmentscanbemadeintheQSE-CI-NWK-E 1 NotavailableforShades 2 Ifadevice’sZoneisalreadyassignedtothebutton,youcannotprogramaSceneforthatbutton IfaSceneisalready
programmedforthisbuttonforadevice,youcannotprogramanotherZoneforthisbutton 3 Usebuttonnumber0toclearprogrammingfromallbuttons 4 Usebuttonnumber0toconfigureStop-If-Movingfunctionalityonallbuttons
PROGRAMMING Command Formats
Integration ID or Serial # of the QSE-CI-NWK being used
Use “PROGRAMMING Command-specific fields” tables to complete these command fields.
Operation
Phantom Button Number (can be 1–100)
Command
#PROGRAMMING,1,ButtonNumber,ActionNumber,Parameters
Continuedonnextpage…
24
Lutron integration protocol
QS Standalone (continued)
System Commands (continued)PROGRAMMINGCommands(continued)
Example PROGRAMMING CommandsForasystemofoneshade(IntegrationID“livingroomsheer”),oneVenetianblind(“kitchenvenetian”),andoneQSE-CI-NWK(IntegrationID“1”),thefollowingexamplesshowhowprogrammingcanbedone
Operation Command String
Addshadeat100%tophantombutton1 #PROGRAMMING,1,1,1,living room sheer,0,100<CR><LF>ResponseReceived ~PROGRAMMING,1,1,1,living room sheer,0,100<CR><LF>AddVenetianblindat0%liftand50%tilttophantombutton2
#PROGRAMMING,1,2,5,kitchen venetian,0,0,50<CR><LF>
ResponseReceived ~PROGRAMMING,1,2,5,kitchen venetian,0,0,50<CR><LF>AddVenetianblindat75%tilttophantombutton3 #PROGRAMMING,1,3,6,kitchen venetian,0,75<CR><LF>ResponseReceived ~PROGRAMMING,1,3,6,kitchen venetian,0,75<CR><LF>AddVenetianblindat15%lifttophantombutton4 #PROGRAMMING,1,4,7,kitchen venetian,0,15<CR><LF>ResponseReceived ~PROGRAMMING,1,4,7,kitchen venetian,0,15<CR><LF>Addshadeat50%tophantombutton2 #PROGRAMMING,1,2,1,dining room blackout,0,50<CR><LF>ResponseReceived ~PROGRAMMING,1,2,1,dining room blackout,0,50<CR><LF>TurnOnStop-If-Movingforphantombutton5 #PROGRAMMING,1,5,4,1<CR><LF>ResponseReceived ~PROGRAMMING,1,5,4,1<CR><LF>Clearprogrammingfromallthephantombuttons #PROGRAMMING,1,0,3<CR><LF>ResponseReceived RepeatcommandtoclearallphantombuttonprogrammingRepeatcommandtoclearallphantombuttonprogramming
#PROGRAMMING,1,0,3<CR><LF>
ResponseReceived ~PROGRAMMING,1,0,3<CR><LF>Clearprogrammingfromphantombutton6 #PROGRAMMING,1,6,3<CR><LF>ResponseReceived ~PROGRAMMING,1,6,3<CR><LF>
25
Lutron integration protocol
PROGRAMING Command Formats
PROGRAMMING Command-specific fields Action NumbersandParameters:
Description Action Number Parameters
Get(?)displayprogrammingofaspecificphantombutton1
None None
Get(?)displayStop-If-Movingconfigurationofaspecificphantombutton2
4 None
Example PROGRAMMING CommandsThefollowingexamplesshowhowtoverifytheprogrammingofthephantombuttonsofaQSE-CI-NWK-EwithanIntegrationIDof“1 ”
Operation Command String
Displayprogrammingofphantombutton1 ?PROGRAMMING,1,1<CR><LF>
Displayprogrammingofallphantombuttons ?PROGRAMMING,1<CR><LF>
DisplayStop-If-Movingconfigurationofphantombutton5 ?PROGRAMMING,1,5,4<CR><LF>
DisplayStop-If-Movingconfigurationofallphantombuttons ?PROGRAMMING,1,0,4<CR><LF>
NOTES1 Todisplayprogrammingofallphantombuttons,leavethebuttonnumberfieldblank 2 TodisplayStop-If-Movingconfigurationofallphantombuttons,usebuttonnumber0
Operation
Command
?PROGRAMMING,1,ButtonNumber,ActionNumber
Integration ID or Serial # of the QSE-CI-NWK being used
Use “PROGRAMMING Command-specific fields” tables to complete these command fields.
Phantom Button Number (can be 1–100)
QS Standalone (continued)
System Commands (continued)PROGRAMMINGCommands(continued)
Continuedonnextpage…
26
Lutron integration protocol
QS Standalone (continued)
System Commands (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields Action Numbers and Parameters:
Description Action Number Parameters
Set(#)activatethephantombuttonpreset 3 NoneSet(#)acustomleveloftheshades,lightingzonesprogrammedtothephantombutton1
14 Level:Theleveltheshadeswillgoto1
Set(#)StartRaisingShades2 18 NoneSet(#)StartLoweringShades2 19 NoneSet(#)StopRaisingorLoweringShades 20 NoneSet(#)acustomliftandtiltlevelofvenetianblindspro-grammedtothephantombutton1
23 Liftlevel%Tiltlevel%
Set(#)acustomliftlevelonlyofvenetianblindspro-grammedtothephantombutton1
24 Liftlevel%
Set(#)acustomtiltlevelonlyofvenetianblindspro-grammedtothephantombutton1
25 Tiltlevel%
NOTES1 Specifyingacustomlevelabovewillnotaffectthepresetlevelprogrammedforthephantombutton 2 ForVenetianblinds,theRaise&LowerActionswillaffecteithertheliftorthetiltbasedonhowthephantombuttonwas
programmed If#PROGRAMMINGAction5isused(affectingbothliftandtiltlevels),thentheRaise&LowerActionswillaffectthetilt
Example DEVICE CommandsThefollowingexamplesshowhowwecanactivatephantombuttonsonalinkwithaQSE-CI-NWK-EwhoseIntegrationIDis“1 ”
Operation Command String
ActivatePresetonphantombutton1 #DEVICE,1,1,3<CR><LF>Setthelevelofallshadesprogrammedtophantombutton2to50% #DEVICE,1,2,14,50<CR><LF>Setallvenetianblindsprogrammedtophantombutton3toaliftlevelof50%andtiltlevelof25%
#DEVICE,1,3,23,50,25<CR><LF>
Setallvenetianblindsprogrammedtophantombutton4toaliftlevelof50% #DEVICE,1,4,24,50<CR><LF>Setallvenetianblindsprogrammedtophantombutton5toatiltlevelof25% #DEVICE,1,5,25,25<CR><LF>Raisetheshadesandvenetianblindsprogrammedtophantombutton6 #DEVICE,1,6,18<CR><LF>Lowershadesandvenetianblindsprogrammedtophantombutton7 #DEVICE,1,7,19<CR><LF>Stopshadesandvenetianblindsprogrammedtophantombutton8 #DEVICE,1,8,20<CR><LF>
Operation
Command
Integration ID or Serial # of the QSE-CI-NWK being used
Use “DEVICE Command-specific fields” tables to complete these command fields.
Phantom Button Number (can be 1–100)
#DEVICE,1,ButtonNumber,ActionNumber,Parameters
27
Lutron integration protocol
RadioRA 2System OverviewRadioRA2isawirelessmulti-roomcontrolsystemforlightsandshades Thesystemismadeupofrepeaters,dimmers,keypads,andotherdevices TheLutronproven,patentedRFtechnologyensuresreliableperformance WiththeRadioRA2system,youcan:createtherightambienceforvariedactivities,easilymonitorandcontrolyourlights,reduceenergyusage,andincreasesafetyinandaroundyourhome
RadioRA 2 System Device Compatibility IndexRadioRA 2
GRAFIKEyeQS seeTouchKeypad TabletopseeTouchKeypad PicoWirelessControl HybridKeypad SivoiaQSShade SivoiaQSWirelessShade SivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlind MaestroDimmerandPlug-InModule MaestroFanSpeedControl VisorControlReceiver RadioPowrSavrSensor HVACController WirelessTemperatureSensor
28
Lutron integration protocol
Setup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1
N / C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
Why Integrate with a RadioRA 2 Main Repeater?• IntegratesaRadioRA2lightingcontrolsystemwithaPCorotherdigitalequipmentthatsupports
RS232orEthernetTCP/IPcommunication • Allowsmonitoringandcontrolofsystemdevices Forexample,theMainRepeatercanbeusedto
simulatebuttonpresses,reportbuttonpresses,monitorLEDs,andcontrollightlevelsofdimmers
Integration Capabilities• 100“virtual”programmablebuttonswithLEDs(useDEVICEcommand)• Monitoringofchangestoothersystemdevices(useMONITORINGcommand)
Additional Commands• MONITORINGcommandsareusedtoprogramwhattypesofmessagesthesystemwillreport
RadioRA 2 (continued)
Integration Access PointsMainRepeater
Model:RR-MAIN-REP-WH,RRK-MAIN-REP-WH
Continuedonnextpage…
29
Lutron integration protocolSetup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1N
/ C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
RadioRA 2 (continued)
Integration Access Points (continued)Connection Information
ProvidesanRS232andEthernetconnectiontocommunicatewithexternalequipment RS232 TheRS232connectionhasthefollowingcommunicationsettings:• BaudRate9600• 8databits• Noparitybit• 1stopbit• Noflowcontrol Ethernet Configuringthecontrolinterfacetocommunicateoveranetworktakesnotonlyknowledgeof
theRadioRA2system,butofnetworkingaswell Installerswithlimitednetworkingknowledgeareadvisedtocontactanetworkingprofessionalbeforeattemptingtoconnectacontrolinterfacethroughanetwork Theinformationbelowwillhelpaninstallercommunicatethecontrolinterfaceconfigurationstoanetworkprofessional
TheinstallerwillmakeanynecessarychangestothecontrolinterfaceusingtheLutronDeviceIPorRadioRA2PCsoftwaretoolandthenetworkprofessionalcanmakeanynecessarychangestothenetworkingequipment
Single Ethernet Port• IEEE®802 3Auto-Sensing10BaseT/100BaseTX• SupportsMDI/MDIXauto-crossover(nocrossovercableneeded) • Female8P8C“ComputerRJ-45”socket• Green“Connect”LED,Amber“Activity”LED• UseCat5cablingorbetter TCP / IP Settings• DHCP(dynamic)orstaticconfiguration<factorydefault=DHCP>• IPAddress:<staticdefault=192 168 1 50ordynamicconfiguration>• SubnetMask:<staticdefault=255 255 255 0ordynamicconfiguration>• Gateway:<staticdefault=0 0 0 0ordynamicconfiguration> Protocols Used for Integration• TELNET Telnet Server• InclusiveSoftwarewillallowuptoatotalof10additionallogins• Usedbysoftwareand/orthirdpartyequipment(e g ,touchscreen)• LimitedtotransferringASCIIcharacters• Login:lutron• Password:integration Notes: –UptofouradditionalloginandpasswordvaluescanbedefinedintheRadioRA2PCsoftware
–Onlyoneconnectionperlogin/passwordisallowedatatime UDP Multicast Messaging• UsedbytheRadioRA2PCsoftwareduringdeviceconfigurationandsystemprogramming• TherearenousermodifiablesettingsforUDPmessaging
30
Lutron integration protocol
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1–100 1–100 Press,Release
LED1–100 101–200 SetorGetLEDstate
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)orGet(?)LEDState 9 0=Off1=On
Example DEVICE Commands
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,4,1,3<CR><LF>
ReleaseButton1 #DEVICE,4,1,4<CR><LF>
TurnOnLED1 #DEVICE,4,101,9<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,4,101,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,4,101,9,1<CR><LF>
Setup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1N
/ C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
RadioRA 2 (continued)
System CommandsDEVICECommands
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,1,ComponentNumber,ActionNumber,Parameters
31
Lutron integration protocol
RadioRA 2 (continued)
System Commands (continued)GROUPCommands
Setup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1N
/ C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
GROUP Command-specific fields
Action Numbers:
Action Action Number
Get(?)OccupancyGroupState 3
GROUP Command Format
Use “GROUP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
?GROUP,6,ActionNumber
Example GROUP Messages
Operation Command String
Query:?GROUP,IntegrationID,ActionNumber
WhatisOccGROUP1’sstatus? ?GROUP,1,3<CR><LF>
Response:~GROUP,IntegrationID,ActionNumber,Parameters
Occgroup1isoccupied ~GROUP,1,3,3<CR><LF>
Occgroup1isunknown ~GROUP,1,3,255<CR><LF>
Occupancy States:
Description Value
Occupied 3
Unoccupied 4
Unknown 255
32
Lutron integration protocol
MONITORING Command Formats
MONITORING Command-specific fields
Monitoring Type:
Description Monitoring Type
Set(#)orGet(?)DiagnosticMonitoring 1
Set(#)orGet(?)ButtonMonitoring(ifenabled,buttonactionswillbereported) 3
Set(#)orGet(?)LEDMonitoring(ifenabled,LEDstateswillbereported) 4
Set(#)orGet(?)ZoneMonitoring(ifenabled,zonelevelswillbereported,i e dimmer,shade,contactclosureoutputlevel)
5
Set(#)orGet(?)ReplyState(ifdisabled,allmessagesFROMtheintegrationaccesspointwillcease)
11
Set(#)orGet(?)PromptState(ifdisabled,thepromptwillnotbeprintedtotheterminal) 12
Set(#)orGet(?)TemperatureSensorMonitoring 27
Set(#)orGet(?)StateofAllMonitoring(exceptReplyandPrompt) 255
Action Numbers:
Action Action Number
Enable 1
Disable 2
Example MONITORING Commands
Operation Command String
Execute: #MONITORING,MonitoringType,ActionNumber
DisableDiagnosticMonitoring #MONITORING,1,2<CR><LF>
EnableEventMonitoring #MONITORING,2,1<CR><LF>
Query: ?MONITORING,MonitoringType
IsDiagnosticMonitoringdisabled? ?MONITORING,1<CR><LF>
Response: ~MONITORING,MonitoringType,ActionNumber
DiagnosticMonitoringisdisabled ~MONITORING,1,2<CR><LF>
Setup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1N
/ C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
RadioRA 2 (continued)
System Commands (continued)MONITORINGCommands
Use “MONITORING Command-specific fields” tables to complete these command fields.
Operation
Command
#MONITORING,MonitoringType,ActionNumber
33
Lutron integration protocolSetup
WiredRF
Communication
Repeater Status1 3 42 M
Main Repeater
Power Repeater LinkCO
M9 V
1N
/ C
MU
X
MU
X
2 3 4
AddTest
Integrate Program / Integrate
RS232 Ethernet
USB
RadioRA 2 (continued)
System Commands (continued)TIMECLOCKCommands
TIMECLOCK Command Formats
TIMECLOCK Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)CurrentTimeclockMode1
1 ModeIndexNumber
Get(?)CurrentTimeclockMode1
1 None
Get(?)SunriseTime 2 None
Get(?)SunsetTime 3 None
Get(?)Day’sSchedule 4 None
Set(#)ExecuteIndexedEvent
5 Indexoftheeventtotest Theindexnumberofthefirsteventis1;thesecondeventis2,andsoon
Set(#)IndexedEventasEnabledorDisabled
6 EventIndex,EnableState(1=Enable,2=Disable)
NOTE1 InordertosettheTimeclockMode,the“ModeIndex”mustbedeterminedusingthe(?)help,(#)timeclock,1command
ModeIndexesareprojectdependentandmaychangewitheachnewproject
Example TIMECLOCK Messages
Operation Command String
Execute: #TIMECLOCK,IntegrationID,ActionNumber,Parameters
Executethe3rdeventofthetimeclock #TIMECLOCK,4,5,3<CR><LF>
Query:?TIMECLOCK,IntegrationID,ActionNumber
Whatisthesunrisetime? ?TIMECLOCK,4,2<CR><LF>
Response:~TIMECLOCK,IntegrationID,ActionNumber,Parameters
Thetimethesunrises ~TIMECLOCK,4,2,05:32<CR><LF>
Use “TIMECLOCK Command-specific fields” tables to complete these command fields.
Operation
Command
#TIMECLOCK,4,ActionNumber,ParametersIntegration ID (example)
34
Lutron integration protocol
QuantumSystem OverviewTheQuantumsystemistheLutronpremiercommerciallightingcontrolsystem Itallowsthecontrolandmonitoringofindividualdevicesandoutputsaswellasallowingcontrolofentireareas,shadegroupsorotherportionsofthesystem TheQuantumsystemincludesQSdevicessuchastheGRAFIKEyeQSandSivoiaQSshadesaswellasLutronEcoSystemballastsandGRAFIKdimmingpanels WhenintegratingwithaQuantumsystemtheintegratorgetsadditionalaccesstoportionsofathesystemnotavailablewhenusingproductsinstand-alonemode,particularlytheabilitytoactivatescenesonanarea-by-areabasisandtocontrolthepositionofandactivatepresetsonentiregroupsofshadesatonce
Quantum System Device Compatibility IndexQuantum
GRAFIKEyeQS EnergiSavrNodeQS/DALI® EnergiSavrNodeQS/EcoSystem EnergiSavrNodeQS/EcoSystem(Int’l) EnergiSavrNodeQS/0–10V/Softswitch(Int’l) EnergiSavrNodeQS/Phase-Adaptive(Int’l) EnergiSavrNodeQS/0–10V/Softswitch RemotePowerModule PalladiomKeypad ArchitraveKeypad SignatureSeriesKeypad seeTouchKeypad seeTouchQSKeypad(Int’l) PicoWirelessControl WallboxInputClosureInterface SivoiaQSShade SivoiaQSWirelessShadeQSInput/OutputControlInterface
Why Integrate with a Quantum System• CompatiblewithQuantumsystemversion1 7orhigher• Gainaccesstosystem-onlyinformation• ActivateSystemAreascenes• SetlevelsforSystemOutputs• ActivateSystemShadeGrouppresets• ViewandmodifyparametersofaQuantumsystem,suchastime,date,timezone,etc
Command TypesOperationcharacterswillbefollowedbycommandtypes:
• AREAallowscontrolofanareaintheQuantumsystem Scenescanbeactivated,occupancymonitoredetc
• SHADEGRPallowscontrolofshadegroupsintheQuantumsystem ShadeGroupsarecollectionsofshadesthatoperateinunison
• OUTPUTallowscontrolandmonitoringofaQuantumsystemoutputgroupsuchasalightingzoneorclosureoutput
• SYSTEMallowssettingandcontrollingsystemparametersandvariables*• HELPdisplaysusageinformationforthesupportedcommandsandtheircorrespondingactions• INTEGRATION IDallowsqueryingintegrationIDsofdevicesinthesystem* LoadShedcommandsavailableonlyonQuantumversion2 0andhigher
35
Lutron integration protocol
Why Integrate with a QSE-CI-NWK-E?• IntegratesaQSlightingcontrolsystemwithaPCorotherdigitalequipmentthatsupportsRS232
orEthernetTCP/IPconnection • Allowsmonitorandcontrolofsystemdevices Forexample,theQSE-CI-NWK-Ecanbeusedto
simulatebuttonpresses,reportbuttonpresses,monitorLEDs,andcontrollightlevels
Additional Commands• MONITORINGspecifieswhattypeofmessagesthesystemwillreport• ETHERNETmodifiestheEthernetconfigurationsoftheQSE-CI-NWK-E• RESETrestartstheQSE-CI-NWK-Eorrestoresittofactorydefaults• INTEGRATION IDassignsIDstodevices,sothattheymaybereferredtoinamorelogicalfashion• DETAILSreturnsinformationaboutaQSdevice• ERRORreportssyntaxerrorsinanintegrationstringcommandorquery
Quantum (continued)
Integration Access PointsNetworkInterface
Model: QSE-CI-NWK-E
Continuedonnextpage…
36
Lutron integration protocol
Quantum (continued)
Integration Access Points (continued)Connection Information
ProvidesanRS232andEthernetconnectiontocommunicatewithexternalequipment RS232 TheRS232connectionhasthefollowingcommunicationsettings:• BaudRate9600/19200/38400/115200(setviadipswitchonunit)• 8databits• Noparitybit• 1stopbit• Noflowcontrol
Ethernet Configuringthecontrolinterfacetocommunicateoveranetworktakesnotonlyknowledgeof
theQuantumsystem,butofnetworkingaswell InstallerswithlimitednetworkingknowledgeareadvisedtocontactanetworkingprofessionalbeforeattemptingtoconnectaQSE-CI-NWK-Ethroughanetwork TheinformationbelowwillhelpaninstallercommunicatetheQSE-CI-NWK-Econfigurationstoanetworkprofessional
TheinstallerwillmakeanynecessarychangestothecontrolinterfaceusingtheLutronDeviceIPorQuantumPCsoftwaretoolandthenetworkprofessionalcanmakeanynecessarychangestothenetworkingequipment
Single Ethernet Port• IEEE®802 3Auto-Sensing10BaseT/100BaseTX• SupportsMDI/MDIXauto-crossover(nocrossovercableneeded) • Female8P8C“ComputerRJ-45”socket• Green“Connect”LED,Amber“Activity”LED• UseCat5cablingorbetter
TCP / IP Settings• IPAddress:<staticdefault=192 168 250 1>• SubnetMask:<staticdefault=255 255 255 0>• Gateway:<staticdefault=0 0 0 0>
Protocols Used for Integration• TELNET
Telnet Server• Usedbythirdpartyequipment(e g ,touchscreen)• LimitedtotransferringASCIIcharacters• TelnetPortnumberis23• Login #1:nwk• Login #2:nwk2
37
Lutron integration protocol
ETHERNET Command Formats
ETHERNET Command-specific fields
Configuration Numbers:
Description Configuration Number Parameters
Set(#)orGet(?)IPAddress 0 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)GatewayAd-dress
1 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)SubnetMask 2 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)LoginInfo 3 User(1or2),OldLogin,NewLogin
Example ETHERNET Commands
Operation Command String
Execute: #ETHERNET,ConfigurationNumber,Parameters
SetIPAddressto192 168 250 1 #ETHERNET,0,192.168.250.1<CR><LF>
SetGatewayAddressto10 2 4 1 #ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET,ConfigurationNumber,Parameters
WhatistheIPAddress? ?ETHERNET,0<CR><LF>
WhatistheLoginInformationforuser1? ?ETHERNET,3,1<CR><LF>
WhatistheLoginInformationforALLusers? ?ETHERNET,3,0<CR><LF>(Note:0=ALL)
Response: ~ETHERNET,IntegrationID,ConfigurationNumber,Parameters
TheIPAddressis192 168 250 1 ~ETHERNET,0,192.168.250.1<CR><LF>
Quantum (continued)
System CommandsETHERNETCommands
Use “ETHERNET Command-specific fields” tables to complete these command fields.
Operation
Command
#ETHERNET,ConfigurationNumber,Parameters
38
Lutron integration protocol
INTEGRATION ID Command Formats
INTEGRATION ID Command-specific fields
Action NumbersandParameters:
Description Action Number Parameters
Get(?)IntegrationIDforaSerialNumber
1 SerialNumber:8characterHEXserialnumberofthedevice;IntegrationID:TheintegrationIDtobeassigned
Get(?)InfofromID 3 IntegrationID=TheIntegrationIDthatinformationisdesiredfor Note:Ifthisfieldisleftblank,allintegrationIDswillbeprinted
Example INTEGRATION ID Commands
Operation Command String
Execute: ?INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ~INTEGRATIONID,1,5678EFEF,1<CR><LF>
Execute: ?INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand ?INTEGRATIONID,3,1<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand ~INTEGRATIONID,3,1,DEVICE,5678EFEF<CR><LF>
Quantum (continued)
System Commands (continued)INTEGRATIONIDCommands
Use “INTEGRATIONID Command-specific fields” tables to complete these command fields.
Operation
Command
?INTEGRATIONID,ActionNumber,Parameters
39
Lutron integration protocol
RESET Command Formats
RESET Command-specific fields
Action Numbers:
Action Action Number
Set(#)restartthedevice 0
Set(#)restoretofactorydefaults 1
Example RESET Commands
Operation Command String
Execute: #RESET,ActionNumber
RestarttheNWK #RESET,0<CR><LF>
RestoreNWKtofactorydefaults #RESET,1<CR><LF>
Use “RESET Command-specific fields” tables to complete these command fields.
Operation
Command
#RESET,ActionNumber
Quantum (continued)
System Commands (continued)RESETCommands
40
Lutron integration protocol
AREA Command Formats
AREA Command-specific fields
Action NumbersandParameters:Action Action Number Parameters
Set(#)AreaLevel 1 Level1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 NoneSet(#)StartLowering4 3 NoneSet(#)StopRaisingorLowering 4 NoneSet(#)orGet(?)CurrentScene 6 SceneNumber5=0–326
Set(#)orGet(?)DaylightingMode 7 1=Active2=Inactive
Get(?)OccupancyState 8 1=Unknown2=Inactive3=Occupied4=Unoccupied
Set(#)orGet(?)OccupancyMode 9 1=OccupancyandVacancy72=Vacancy73=NotApplicable84=Inactive
Set(#)orGet(?)OccupiedLevelorScene 12 Level=0–100;200–232forSceneNumber=0–32Set(#)orGet(?)UnoccupiedLevelorScene 13 Level=0–100;200–232forSceneNumber=0–32Set(#)orGet(?)HyperionShadowSensorOverrideState9
26 0=Disable1=Enable2=Mixed(GetOnly)
Set(#)orGet(?)HyperionBrightnessSensorOverrideState9
27 0=Disable1=Enable2=Mixed(GetOnly)
NOTES1 TheLevelisacceptedasapercentage 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifafadetimeisspecified
as1 45secondsavalueof1 25secondswillbeused 4 WhenaRaise/Lowercommandisissued,thearea’slevelwillcontinuetogotowardshighend/lowenduntilaStop
commandisreceived 5 Scene0istheOffScene 6 Scenes17–32availableonlyonSlider 7 IfAfterHoursisusedinanarea,settingthearea’sOccupancyModeto“OccupancyandVacancy”or“Vacancy”will
activateAfterHours 8 Theareawillreport“NotApplicable”asitsOccupancyModeiftheareadoesnothaveoccupancysensorsandifAfter
Hoursisnotused 9 Quantum2 7andhigher
Quantum (continued)
System Commands (continued)AREACommands
Use “AREA Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#AREA1,2,2,ActionNumber,Parameters
NOTES1 AREAcanbeusedtocontrolonlythoseareasofaQuantumsystemthathavebeenassignedtoaparticularintegration
accesspoint PleaserefertotheQ-Designsoftware(IntegrationTab)orQuantumIntegrationReportfordetailsofwhatareasareavailableforcontrolandmonitoring
2 AREAcommandscannotbesenttoareasthatcontainotherareas,suchasafloororanentirebuilding
Continuedonnextpage…
41
Lutron integration protocol
Example AREA Messages
Operation Command String
Execute: #AREA,IntegrationID,ActionNumber,Parameters
Setarealevelto75%(Fade=4sec,Delay=2sec) #AREA,2,1,70,4,2<CR><LF>
LowerArea #AREA,2,3<CR><LF>
Query: ?AREA,IntegrationID,ActionNumber
Istheareaoccupied? ?AREA,2,8<CR><LF>
Whatisthecurrentactivescene? ?AREA,2,6<CR><LF>
Response: ~AREA,IntegrationID,ActionNumber,Parameters
Theareaiscurrentlyoccupied ~AREA,2,8,3<CR><LF>
AreaScene2iscurrentlyactive ~AREA,2,6,2<CR><LF>
Quantum (continued)
System Commands (continued)AREACommands(continued)
42
Lutron integration protocol
SHADEGRP Command Formats
SHADEGRP Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)ShadeGroupLevel 1 Level1=0–100or0 00–100 00Delay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 None
Set(#)StartLowering4 3 None
Set(#)StopRaisingorLowering
4 None
Set(#)orGet(?)CurrentPreset
6 PresetNumber5=0–30
NOTES1 TheLevelisacceptedasapercentage,where100%isfullyopenand0%isfullyclosed 2 TheDelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay Theminimumdelaytimeis
0 seconds Themaximumdelaytimeis4hours 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecified
as1 45secondsavalueof1 25secondswillbeused 4 WhenaRaise/Lowercommandisissued,theshadegroup’slevelwillcontinuetogotowardsopen/closeuntilaStop
commandisreceived 5 Preset0istheOpenPresetandPreset30istheClosedPreset
Example SHADEGRP Messages
Operation Command String
Execute: #SHADEGRP,IntegrationID,ActionNumber,Parameters
Setshadegroupto70%(Delay=2sec) #SHADEGRP,2,1,70,2<CR><LF>
Lowershadegroup #SHADEGRP,2,3<CR><LF>
Query: ?SHADEGRP,IntegrationID,ActionNumber
Whatisthecurrentactivepreset? ?SHADEGRP,2,6<CR><LF>
Response: ~SHADEGRP,IntegrationID,ActionNumber,Parameters
ShadegroupPreset2iscurrentlyactive ~SHADEGRP,2,6,2<CR><LF>
Quantum (continued)
System Commands (continued)SHADEGRPCommands
Use “SHADEGRP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#SHADEGRP1,2,ActionNumber,Parameters
NOTE1 SHADEGRPcanbeusedtocontrolonlythoseshadegroupsofaQuantumsystemthathavebeenassignedtoa
particularintegrationaccesspoint PleaserefertotheQ-Designsoftware(IntegrationTab)orQuantumIntegrationReportfordetailsofwhatshadegroupsareavailableforcontrolandmonitoring
43
Lutron integration protocol
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)OutputLevel 1 Level1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 None
Set(#)StartLowering4 3 None
Set(#)StopRaisingorLowering4 4 None
Set(#)PulseTime 6 Pulse5timein:SS ss3,SS,MM:SS,orHH:MM:SS,orDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)DMXColororLevelSettings6 17 Color/levelindex:0–2550 00–100 005
Set(#)MotorJogRaise6,7 18 None
Set(#)MotorJogLower6,7 19 None
Set(#)Motor4-StageJogRaise6,7 20 None
Set(#)Motor4-StageJogLower6,7 21 None
NOTES1 TheLevelistakenasapercentage 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecifiedas1 45secondsavalueof1 25secondswillbeused
4 WhenaRaise/Lowercommandisissued,theoutput’slevelwillcontinuetogotowardshighend/lowenduntilaStopcommandisreceived
5 Thedefaulttimeisonesecond 6 NotsupportedinRadioRA2 7 Quantum2 5andup
Quantum (continued)
System Commands (continued)OUTPUTCommands
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT1,2,ActionNumber,Parameters
NOTE1 OUTPUTcommandscanbeusedtocontrolsystemlightingzones,contactclosedoutputsandACMotorLoads
Continuedonnextpage…
44
Lutron integration protocol
Example OUTPUT Messages
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setoutputlevelto70%(Fade=4sec,Delay=2sec) #OUTPUT,2,1,70,4,2<CR><LF>
RaiseOutput #OUTPUT,2,2<CR><LF>
Query: ?OUTPUT,IntegrationID
Whatisthecurrentoutputlevel? ?OUTPUT,2<CR><LF>
Response: ~OUTPUT,IntegrationID,ActionNumber,Parameters 1
Outputlevelissetto48% ~OUTPUT,2,1,48<CR><LF>
NOTE1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
Quantum (continued)
System Commands (continued)OUTPUTCommands(continued)
45
Lutron integration protocol
Quantum (continued)
System Commands (continued)SYSVARCommands1
SYSVAR Command Formats
Use “SYSVAR Command-specific fields” tables to complete these command fields.
Operation
Command
SYSVAR Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)thestateofagivenvariable
1 Statenumber
Example SYSVAR Messages
Operation Command String
Execute: #SYSVAR,IntegrationID,ActionNumber,Parameters
Setthevariablestatetothethirdstate #SYSVAR,2,1,3<CR><LF>
Query:?SYSVAR,IntegrationID,ActionNumber
Whatisthestateofthevariable? ?SYSVAR,2,1<CR><LF>
Response:~SYSVAR,IntegrationID,ActionNumber,Parameters
Thevariableisinthethirdstate ~SYSVAR,2,1,3<CR><LF>
#SYSVAR,2,ActionNumber,Parameters
NOTE1 SYSVARCommandsavailableonlyonQuantumversion2 5orhigher
46
Lutron integration protocol
HomeWorks QSSystem OverviewTheHomeWorksQSsystemisLutron’spremiertotalhomecontrolsystem Itallowscontrolandmonitoringoflights,shades,HVAC,sensors,andappliances TheHomeWorksQSsystemincludesQSdevices,RFdevices,andpowerpanelsthatprovidesolutionsfornewconstructionandretrofitprojectsofanysize
HomeWorks QS System Device Compatibility IndexHomeWorks QS
GRAFIKEyeQS HomeWorksQS/DALI® HomeWorksQS/EcoSystem HomeWorksQS/0–10V/Softswitch HomeWorksQS/Phase-Adaptive HomeWorksQS/MotorModule RemotePowerModule Low-CapacitySwitchingDINPowerModule(1A/output) Low-CapacityPhase-AdaptiveDINPowerModule(1A/output) PalladiomKeypad ArchitraveKeypad SignatureSeriesKeypad seeTouchKeypad seeTouchQSKeypad(Int’l) TabletopseeTouchKeypad PicoWirelessControl HybridKeypad DynamicKeypad WallboxInputClosureInterface SivoiaQSShade SivoiaQSWirelessShade SivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlind MaestroDimmerandPlug-InModule MaestroFanSpeedControl VisorControlReceiver RadioPowrSavrSensor HVACController WirelessTemperatureSensor QSInput/OutputControlInterface
Continuedonnextpage…
47
Lutron integration protocol
HomeWorks QS (continued)
System Overview (continued)
Command TypesThefollowingisalistofsupportedcommandtypes Detailsoncertaindevice-specifictypes(e g ,DEVICE,HVAC)arelocatedintheindividualdevicesectionofthismanual Operationcharacterswillbefollowedbycommandtypes
• DEVICE allowscontrolandmonitoringofdeviceinputssuchasbuttonpressesandcontactclosureinputs
• OUTPUTallowscontrolandmonitoringofdeviceoutputssuchasdimmersandcontactclosureoutputs
• SHADEGRPallowscontrolofshadesintheHomeWorksQSsystem Shadegroupsarecollectionsofshadesthatoperateinunison
• MONITORINGspecifiesthetypeofmessagesthatthesystemwillreport• HVACallowscontrolandmonitoringofLutronHVACequipment• TIMECLOCKallowscontrol(enable/disable)andmonitoringofsystemtimeclocks• SYSVAR allowscontrolandmonitoringofsystemvariables• AREAallowscontrolandmonitoringofanarea(e g ,activatingareaScenes,monitoring
occupancy)• ERRORdisplaysresponsestoinvalidcommands• HELPdisplaysusageinformationforthesupportedcommandsandtheircorrespondingactions• SYSTEMallowssettingandcontrollingsystemparametersandvariables• ETHERNETmodifiestheEthernetconfigurationoftheHomeWorksQSprocessor• INTEGRATIONIDgetsinformationoftheintegrationidorserialnumberofadevice• RESETresetstheHomeWorksQSprocessor
48
Lutron integration protocol
Why Integrate with a HomeWorks QS Processor?• IntegratingwithaHomeWorksQSProcessorprovidesintegrationoverEthernetwithouttheneed
foradditionalequipmentorinterfaces • RS-232integrationcanalsobeaccomplishedusingthirdpartyEthernettoRS-232adapters • IntegratingdirectlywiththeHomeWorksQSProcessoralsoprovidesthegreatestbandwidthport
intotheHomeWorksQSsystem • IntegrationIDsareautomaticallygeneratedbytheHomeWorksQSsoftwareapplication(e g ,for
devices,outputs,shadegroups,timeclocks) IntegrationIDscanberemovedtoreduceprocessingandtrafficofunwantedmessages
• PhantomKeypadsallowforintegrationfunctionalitytobeorganizedonvariousvirtualkeypadsthathaveunlimitedbuttonsanddonotcounttowardslinkdevicecountlimits
Integration Capabilities• Controlandmonitoringofoutputdevicessuchasdimmers,theGRAFIKEye,shadesandcontactclosure
outputs• ControlandmonitoringofphysicalorphantomkeypadbuttonsandbuttonstatusLEDs• ControlandmonitoringofLutronHVACequipment• Controlandmonitoringofindividualtimeclocks• Controlandmonitoringofstatevariables• MonitorsensorsstateswithMonitoringcommand• Controlandmonitoringofareastoactivatescenesandmonitoroccupancy
HomeWorks QS (continued)
Integration Access PointsHomeWorksQSProcessor
Model: HQP6-2
Continuedonnextpage…
49
Lutron integration protocol
HomeWorks QS (continued)
Integration Access Points (continued)
Connection Information Ethernet ConfiguringtheHomeWorksQSprocessortocommunicateoveranetworktakesnotonly
knowledgeoftheHomeWorksQSsystem,butofnetworkingaswell InstallerswithlimitednetworkingknowledgeareadvisedtocontactanetworkingprofessionalbeforeattemptingtoconnectaHomeWorksQSprocessorthroughanetwork
TheinstallerwillmakeanynecessaryconfigurationchangestotheHomeWorksQSprocessorusingtheHomeWorksQSDesignSoftwareApplicationandthenetworkprofessionalcanmakeanynecessarychangestothenetworkingequipment
Dual Ethernet Port• IEEE®802 3Auto-Sensing10BaseT/100BaseTX• SupportsMDI/MDIXauto-crossover(nocrossovercableneeded) • Female8P8C“ComputerRJ-45”socket• Green“Connect”LED,Amber“Activity”LED• UseCat5cablingorbetter• 2Port10/100EthernetSwitch
TCP / IP Settings• IPAddress:Addressatwhichtheprocessorcanbereachedforintegration Inmostinstances
whenintegratingtoaprocessor,DHCPshouldbedisabledandastaticIPaddressshouldbeassignedtopreventtheprocessorfromchangingIPaddresses
• SubnetMask:InconjunctionwiththeIPaddress,itdefinesthesubnetonwhichtheprocessorcommunicates Processorswillbeabletointegrateonlywithdevicesonthesamesubnet
• Gateway:Usedininstanceswheretheprocessorneedstocommunicatetotheinternet ShouldbesettotheIPaddressofthedeviceonthenetworkconnecteddirectlytotheinternet—typically,thehomerouter
Protocols Used for Integration• TELNET
Telnet Server• Usedbythirdpartyequipment(e g ,touchscreen)• UsedbyLutronmobiledevices(e g ,iPadandiPhone)• LimitedtotransferringASCIIcharacters• TelnetPortnumberis23• Logins:DefinedintheHomeWorksQSsoftwareapplication
RS232 TheHomeWorksQSProcessordoesnothavenativesupportforRS232 AnEthernettoRS232
adaptercanbeusedandconfiguredtoprovideRS232integrationdirectlyfromtheProcessorifneeded
iPhoneandiPadaretrademarksofApple,Inc ,registeredintheU S andothercountries
50
Lutron integration protocol
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)OutputLevel 1 Level1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 NoneSet(#)StartLowering4 3 NoneSet(#)StopRaisingorLowering4 4 NoneSet(#)orGet(?)FlashFrequency 5 Fade2in:SS ss3,SS,MM:SS,orHH:MM:SS
Delay2in:SS ss3,SS,MM:SS,orHH:MM:SSSet(#)PulseTime 6 Pulse5timein:SS ss3,SS,MM:SS,orHH:MM:SS,
orDelay2in:SS ss3,SS,MM:SS,orHH:MM:SSSet(#)TiltLevel 9 Tiltlevelin%=0 00–1006
Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)LiftandTiltLevels 10 Lift1=0–100or0 00–100 00Tilt1=0–1006or0 00–100 006Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt 11 NoneSet(#)StartLoweringTilt 12 NoneSet(#)StopRaisingorLoweringTilt 13 NoneSet(#)StartRaisingLift 14 NoneSet(#)StartLoweringLift 15 NoneSet(#)StopRaisingorLoweringLift 16 NoneGet(?)HorizontalSheerShadeRegion 28 Regions:0=Lift,1=Tilt
NOTES1 TheLevel/Lift/Tiltistakenasapercentage 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecifiedas1 45secondsavalueof1 25secondswillbeused
4 WhenaRaise/Lowercommandisissued,theoutput’slevelwillcontinuetogotowardshighend/lowenduntilaStopcommandisreceived
5 Thedefaulttimeisonesecond 6 50forHorizontalSheerBlinds
HomeWorks QS (continued)
System CommandsOUTPUTCommands
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT1,2,ActionNumber,Parameters
NOTE1 OUTPUTcommandscanbeusedtocontrolsystemlightingzones,individualshades,andcontactclosedoutputs
Continuedonnextpage…
51
Lutron integration protocol
Example OUTPUT Messages
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setoutputlevelto70%(Fade=4sec,Delay=2sec) #OUTPUT,2,1,70,4,2<CR><LF>
RaiseOutput #OUTPUT,2,2<CR><LF>
Query: ?OUTPUT,IntegrationID
Whatisthecurrentoutputlevel? ?OUTPUT,2<CR><LF>
Response 1: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Outputlevelissetto48% ~OUTPUT,2,1,48<CR><LF>
NOTE1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
HomeWorks QS (continued)
System Commands (continued)OUTPUTCommands(continued)
52
Lutron integration protocol
SHADEGRP Command Formats
SHADEGRP Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ShadeGroupLevel 1 Level1=0–100or0 00–100 00Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising3 2 NoneSet(#)StartLowering3 3 NoneSet(#)StopRaisingorLowering 4 NoneSet(#)orGet(?)CurrentPreset 6 PresetNumber4=0–30Set(#)TiltLevel 14 Level5=0–1006or0 00–100 006
Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)LiftandTiltLevels 15 Lift5=0–100or0 00–100 00Tilt5=0–1006or0 00–100 006Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt3 16 NoneSet(#)StartLoweringTilt3 17 NoneSet(#)StopRaisingorLoweringTilt3 18 NoneSet(#)StartRaisingLift3 19 NoneSet(#)StartLoweringLift3 20 NoneSet(#)StopRaisingorLoweringLift3 21 NoneGet(?)HorizontalSheerShadeRegion 28 Lift=0
Tilt=1
NOTES1 TheFadeandDelaytimeareoptional Forshades,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)
butitisrequiredwhenspecifyinganoptionaldelay Whennotused,thesystemwilluseazero-seconddelay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours
2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecifiedas1 45seconds,avalueof1 25secondswillbeused
3 WhenaRaise/Lowercommandisissued,theshadegroup’slevelwillcontinuetogotowardsopen/closeuntilaStopcommandisreceived
4 Preset0istheOpenPresetandPreset30istheClosedPreset 5 TheLevelisacceptedasapercentage,where100%isfullyopenand0%isfullyclosed 6 50forHorizontalSheerBlinds
HomeWorks QS (continued)
System Commands (continued)SHADEGRPCommands
Use “SHADEGRP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#SHADEGRP,2,ActionNumber,Parameters
Continuedonnextpage…
53
Lutron integration protocol
Example SHADEGRP Messages
Operation Command String
Execute: #SHADEGRP,IntegrationID,ActionNumber,Parameters
Setshadegroupto70%(Delay=2sec) #SHADEGRP,2,1,70,2<CR><LF>
Lowershadegroup #SHADEGRP,2,3<CR><LF>
Query: ?SHADEGRP,IntegrationID,ActionNumber
Whatisthecurrentactivepreset? ?SHADEGRP,2,6<CR><LF>
Response: ~SHADEGRP,IntegrationID,ActionNumber,Parameters
ShadegroupPreset2iscurrentlyactive ~SHADEGRP,2,6,2<CR><LF>
HomeWorks QS (continued)
System Commands (continued)SHADEGRPCommands(continued)
54
Lutron integration protocol
HomeWorks QS (continued)
System Commands (continued)TIMECLOCKCommands
TIMECLOCK Command Formats
TIMECLOCK Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Get(?)SunriseTime 2 None
Get(?)SunsetTime 3 None
Get(?)Day’sSchedule 4 None
Set(#)ExecuteIndexedEvent
5 Indexoftheeventtoexecute Theindexnumberofthefirsteventis1;thesecondeventis2,andsoon
Set(#)IndexedEventasEnabledorDisabled
6 EventIndex,EnableState(1=Enable,2=Disable)
Example TIMECLOCK Messages
Operation Command String
Execute: #TIMECLOCK,IntegrationID,ActionNumber,Parameters
Executethe3rdeventofthetimeclock #TIMECLOCK,2,5,3<CR><LF>
Query:?TIMECLOCK,IntegrationID,ActionNumber
Whatisthesunrisetime? ?TIMECLOCK,2,2<CR><LF>
Response:~TIMECLOCK,IntegrationID,ActionNumber,Parameters
Thetimethesunrises ~TIMECLOCK,2,2,05:32<CR><LF>
Use “TIMECLOCK Command-specific fields” tables to complete these command fields.
Operation
Command
#TIMECLOCK,2,ActionNumber,Parameters
55
Lutron integration protocol
HomeWorks QS (continued)
System Commands (continued)SYSVARCommands
SYSVAR Command Formats
SYSVAR Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)thestateofagivenvariable
1 Statenumber
Example SYSVAR Messages
Operation Command String
Execute: #SYSVAR,IntegrationID,ActionNumber,Parameters
Setthevariablestatetothethirdstate #SYSVAR,2,1,3<CR><LF>
Query:?SYSVAR,IntegrationID,ActionNumber
Whatisthestateofthevariable? ?SYSVAR,2,1<CR><LF>
Response:~SYSVAR,IntegrationID,ActionNumber,Parameters
Thevariableisinthethirdstate ~SYSVAR,2,1,3<CR><LF>
Use “SYSVAR Command-specific fields” tables to complete these command fields.
Operation
Command
#SYSVAR,2,ActionNumber,Parameters
56
Lutron integration protocol
HomeWorks QS (continued)
System Commands (continued)AREACommands
AREA Command Formats
AREA Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Get(?)OccupancyState 8 3=Occupied4=Unoccupied
Example AREA Messages
Operation Command String
Execute: #AREA,IntegrationID,ActionNumber,Parameters
Setarealevelto75%(Fade=4sec,Delay=2sec) #AREA,2,1,70,4,2<CR><LF>
LowerArea #AREA,2,3<CR><LF>
Query: ?AREA,IntegrationID,ActionNumber
Istheareaoccupied? ?AREA,2,8<CR><LF>
Whatisthecurrentactivescene? ?AREA,2,6<CR><LF>
Response: ~AREA,IntegrationID,ActionNumber,Parameters
Theareaiscurrentlyoccupied ~AREA,2,8,3<CR><LF>
AreaScene2iscurrentlyactive ~AREA,2,6,2<CR><LF>
Use “AREA Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
?AREA1,2,ActionNumber,Parameters
NOTE1 AREAcommandscannotbesenttoareasthatcontainotherareas,suchasafloororanentirebuilding
57
Lutron integration protocol
ETHERNET Command-specific fields
Configuration NumberandParameters:
Description Configuration Number Parameters
Set(#)orGet(?)IPAddress 0 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)GatewayAddress
1 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)SubnetMask 2 IPAddress(XXX XXX XXX XXX)
Get(?)DHCP 4 None
Set(#)orGet(?)MulticastAddress
5 IPAddress(XXX XXX XXX XXX)
Example ETHERNET Commands
Operation Command String
Execute: #ETHERNET,ConfigurationNumber,Parameters
SetIPAddressto192 168 250 1 #ETHERNET,0,192.168.250.1<CR><LF>
SetGatewayAddressto10 2 4 1 #ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET,ConfigurationNumber,Parameters
WhatistheIPAddress? ?ETHERNET,0<CR><LF>
Response: ~DEVICE,IntegrationID,ConfigurationNumber,Parameters
TheIPAddressis192 168 250 1 ~ETHERNET,0=,192.168.250.1<CR><LF>
HomeWorks QS (continued)
System Commands (continued)ETHERNETCommands
ETHERNET Command Formats
Use “ETHERNET Command-specific fields” tables to complete these command fields.
Operation
Command
#ETHERNET,ConfigurationNumber,Parameters
58
Lutron integration protocol
INTEGRATION ID Command-specific fields
Action NumbersandParameters:
Description Action Number Parameters
Get(?)IntegrationIDforaSerialNumber1
1 SerialNumber=8characterHEXserialnumberofthedevice
Get(?)InfofromID1 3 IntegrationIDNote:Ifthisfieldisleftblank,allintegrationIDswillbeprinted
Example INTEGRATION ID Commands
Operation Command String
Query: ?INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ~INTEGRATIONID,1,5678EFEF,1<CR><LF>
Query: ?INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand
?INTEGRATIONID,3,1<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand
~INTEGRATIONID,3,1,DEVICE,5678EFEF<CR><LF>
HomeWorks QS (continued)
System Commands (continued)INTEGRATIONIDCommands
INTEGRATION ID Command Formats
Use “INTEGRATIONID Command-specific fields” tables to complete these command fields.
Operation
Command
?INTEGRATIONID,ActionNumber,Parameters
NOTE1 RefertotheintegrationreportgeneratedbytheLutronDesignerTooltoidentifytheintegrationIDsfordevices
59
Lutron integration protocol
RESET Command Formats
RESET Command-specific fields
Action Numbers:
Action Action Number
Set(#)resettheHomeWorksQSprocessor 0
Example RESET Commands
Operation Command String
Execute: #RESET,ActionNumber
ResettheHomeWorksQSprocessor #RESET,0<CR><LF>
Use “RESET Command-specific fields” tables to complete these command fields.
Operation
Command
#RESET,ActionNumber
HomeWorks QS (continued)
System Commands (continued)RESETCommands
60
Lutron integration protocol
myRoom plusSystem OverviewThemyRoomplussystemisaguestroommanagementsystemforlight,temperature,andshadecontrolthatintegrateswithpropertymanagementsystems(PMS)andbuildingmanagementssystems(BMS) ThemyRoomplussystemprovidesincreasedenergysavingsthroughautomaticlightingandHVACadjustmentsandenhancedbyshadecontrol ThemyRoomplussystemusesoccupied/unoccupiedandsold/unsoldinformationforguestpresencedetectionandadditionalHVACsetbacks Itoffershotelguestsprivacyoraview;asinglebuttonpressclosesoropensshadesandintegrateswithBMStocontrolandmonitor
myRoom plus System Device Compatibility IndexmyRoom plus
HomeWorksQS/DALI® HomeWorksQS/EcoSystem HomeWorksQS/0–10V/Softswitch HomeWorksQS/Phase-Adaptive HomeWorksQS/MotorModule Low-CapacitySwitchingDINPowerModule(1A/output) Low-CapacityPhase-AdaptiveDINPowerModule(1A/output) PalladiomKeypad PalladiomThermostat ArchitraveKeypad SignatureSeriesKeypad seeTouchKeypad seeTouchQSKeypad(Int’l) TabletopseeTouchKeypad PicoWirelessControl HybridKeypad DynamicKeypad WallboxInputClosureInterface SivoiaQSShade SivoiaQSWirelessShade SivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlind MaestroDimmerandPlug-InModule MaestroFanSpeedControl VisorControlReceiver RadioPowrSavrSensor HVACController QSInput/OutputControlInterface QSSensorModule
Continuedonnextpage…
61
Lutron integration protocol
myRoom plus (continued)
System Overview (continued)
Command TypesThefollowingisalistofsupportedcommandtypes Detailsoncertaindevice-specifictypes(e g ,DEVICE,HVAC)arelocatedintheindividualdevicesectionofthismanual Operationcharacterswillbefollowedbycommandtypes
• DEVICE allowscontrolandmonitoringofdeviceinputssuchasbuttonpressesandcontactclosureinputs
• OUTPUTallowscontrolandmonitoringofdeviceoutputssuchasdimmersandcontactclosureoutputs
• SHADEGRPallowscontrolofshadesinthemyRoomplussystem Shadegroupsarecollectionsofshadesthatoperateinunison
• MONITORINGspecifiesthetypeofmessagesthatthesystemwillreport• HVACallowscontrolandmonitoringofLutronHVACequipment• TIMECLOCKallowscontrol(enable/disable)andmonitoringofsystemtimeclocks• SYSVAR allowscontrolandmonitoringofsystemvariables• AREAallowscontrolandmonitoringofanarea(e g ,activatingareaScenes,monitoring
occupancy)• ERRORdisplaysresponsestoinvalidcommands• HELPdisplaysusageinformationforthesupportedcommandsandtheircorrespondingactions• SYSTEMallowssettingandcontrollingsystemparametersandvariables• ETHERNETmodifiestheEthernetconfigurationofthemyRoomplusprocessor• INTEGRATIONIDgetsinformationoftheintegrationidorserialnumberofadevice• RESETresetsthemyRoomplusprocessor
62
Lutron integration protocol
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
Why Integrate with a myRoom Processor?• IntegratingwithamyRoomProcessorprovidesintegrationoverEthernetwithouttheneedfor
additionalequipmentorinterfaces • RS-232integrationcanalsobeaccomplishedusingthirdpartyEthernettoRS-232adapters • IntegratingdirectlywiththemyRoomProcessoralsoprovidesthegreatestbandwidthportintothe
myRoomplussystem • IntegrationIDsareautomaticallygeneratedbythemyRoomplussoftwareapplication(e g ,for
devices,outputs,shadegroups,timeclocks) IntegrationIDscanberemovedtoreduceprocessingandtrafficofunwantedmessages
• PhantomKeypadsallowforintegrationfunctionalitytobeorganizedonvariousvirtualkeypadsthathaveunlimitedbuttonsanddonotcounttowardslinkdevicecountlimits
Integration Capabilities• Controlandmonitoringofoutputdevicessuchasdimmers,theGRAFIKEye,shadesandcontactclosure
outputs• ControlandmonitoringofphysicalorphantomkeypadbuttonsandbuttonstatusLEDs• ControlandmonitoringofLutronHVACequipment• Controlandmonitoringofindividualtimeclocks• Controlandmonitoringofstatevariables• MonitorsensorsstateswithMonitoringcommand• Controlandmonitoringofareastoactivatescenesandmonitoroccupancy
myRoom plus (continued)
Integration Access PointsmyRoomProcessor
Model: GCU-HOSP
Continuedonnextpage…
63
Lutron integration protocol
myRoom plus (continued)
Integration Access Points (continued)
Connection Information Ethernet ConfiguringthemyRoomprocessortocommunicateoveranetworktakesnotonlyknowledgeof
themyRoomplussystem,butofnetworkingaswell InstallerswithlimitednetworkingknowledgeareadvisedtocontactanetworkingprofessionalbeforeattemptingtoconnectamyRoomprocessorthroughanetwork
TheinstallerwillmakeanynecessaryconfigurationchangestothemyRoomprocessorusingthemyRoomplusDesignSoftwareApplicationandthenetworkprofessionalcanmakeanynecessarychangestothenetworkingequipment
Dual Ethernet Port• IEEE®802 3Auto-Sensing10BaseT/100BaseTX• SupportsMDI/MDIXauto-crossover(nocrossovercableneeded) • Female8P8C“ComputerRJ-45”socket• Green“Connect”LED,Amber“Activity”LED• UseCat5cablingorbetter• 2Port10/100EthernetSwitch
TCP / IP Settings• IPAddress:Addressatwhichtheprocessorcanbereachedforintegration Inmostinstances
whenintegratingtoaprocessor,DHCPshouldbedisabledandastaticIPaddressshouldbeassignedtopreventtheprocessorfromchangingIPaddresses
• SubnetMask:InconjunctionwiththeIPaddress,itdefinesthesubnetonwhichtheprocessorcommunicates Processorswillbeabletointegrateonlywithdevicesonthesamesubnet
• Gateway:Usedininstanceswheretheprocessorneedstocommunicatetotheinternet ShouldbesettotheIPaddressofthedeviceonthenetworkconnecteddirectlytotheinternet
Protocols Used for Integration• TELNET
Telnet Server• Usedbythirdpartyequipment(e g ,touchscreen)• UsedbyLutronmobiledevices(e g ,iPadandiPhone)• LimitedtotransferringASCIIcharacters• TelnetPortnumberis23• Logins:DefinedinthemyRoomplussoftwareapplication
RS232 ThemyRoomProcessordoesnothavenativesupportforRS232 AnEthernettoRS232adapter
canbeusedandconfiguredtoprovideRS232integrationdirectlyfromtheProcessorifneeded
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
64
Lutron integration protocol
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)OutputLevel 1 Level1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 NoneSet(#)StartLowering4 3 NoneSet(#)StopRaisingorLowering4 4 NoneSet(#)orGet(?)FlashFrequency 5 Fade2in:SS ss3,SS,MM:SS,orHH:MM:SS
Delay2in:SS ss3,SS,MM:SS,orHH:MM:SSSet(#)CCOPulseTime 6 Pulse5timein:SS ss3,SS,MM:SS,orHH:MM:SS,
orDelay2in:SS ss3,SS,MM:SS,orHH:MM:SSSet(#)TiltLevel 9 Tiltlevelin%=0 00–1006
Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)LiftandTiltLevels 10 Lift1=0–100or0 00–100 00Tilt1=0–1006or0 00–100 006Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt 11 NoneSet(#)StartLoweringTilt 12 NoneSet(#)StopRaisingorLoweringTilt 13 NoneSet(#)StartRaisingLift 14 NoneSet(#)StartLoweringLift 15 NoneSet(#)StopRaisingorLowringLift 16 NoneGet(?)HorizontalSheerShadeRegion 28 Regions:0=Lift,1=Tilt
NOTES1 TheLevel/Lift/Tiltistakenasapercentage 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecifiedas1 45secondsavalueof1 25secondswillbeused
4 WhenaRaise/Lowercommandisissued,theoutput’slevelwillcontinuetogotowardshighend/lowenduntilaStopcommandisreceived
5 Thedefaulttimeisonesecond 6 50forHorizontalSheerBlinds
myRoom plus (continued)
System CommandsOUTPUTCommands
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT1,2,ActionNumber,Parameters
NOTE1 OUTPUTcommandscanbeusedtocontrolsystemlightingzones,individualshades,andcontactclosedoutputs
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
Continuedonnextpage…
65
Lutron integration protocol
Example OUTPUT Messages
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setoutputlevelto70%(Fade=4sec,Delay=2sec) #OUTPUT,2,1,70,4,2<CR><LF>
RaiseOutput #OUTPUT,2,2<CR><LF>
Query: ?OUTPUT,IntegrationID
Whatisthecurrentoutputlevel? ?OUTPUT,2<CR><LF>
Response 1: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Outputlevelissetto48% ~OUTPUT,2,1,48<CR><LF>
NOTE1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
myRoom plus (continued)
System Commands (continued)OUTPUTCommands(continued)
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
66
Lutron integration protocol
SHADEGRP Command Formats
SHADEGRP Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ShadeGroupLevel 1 Level1=0–100or0 00–100 00Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising3 2 NoneSet(#)StartLowering3 3 NoneSet(#)StopRaisingorLowering 4 NoneSet(#)orGet(?)CurrentPreset 6 PresetNumber4=0–30Set(#)TiltLevel 14 Level5=0–1006or0 00–100 006
Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)LiftandTiltLevels 15 Lift5=0–100or0 00–100 00Tilt5=0–1006or0 00–100 006Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt3 16 NoneSet(#)StartLoweringTilt3 17 NoneSet(#)StopRaisingorLoweringTilt3 18 NoneSet(#)StartRaisingLift3 19 NoneSet(#)StartLoweringLift3 20 NoneSet(#)StopRaisingorLoweringLift3 21 NoneGet(?)HorizontalSheerShadeRegion 28 Lift=0
Tilt=1
NOTES1 TheFadeandDelaytimeareoptional Forshades,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)
butitisrequiredwhenspecifyinganoptionaldelay Whennotused,thesystemwilluseazero-seconddelay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours
2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecifiedas1 45seconds,avalueof1 25secondswillbeused
3 WhenaRaise/Lowercommandisissued,theshadegroup’slevelwillcontinuetogotowardsopen/closeuntilaStopcommandisreceived
4 Preset0istheOpenPresetandPreset30istheClosedPreset 5 TheLevelisacceptedasapercentage,where100%isfullyopenand0%isfullyclosed 6 50forHorizontalSheerBlinds
myRoom plus (continued)
System Commands (continued)SHADEGRPCommands
Use “SHADEGRP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#SHADEGRP,2,ActionNumber,Parameters
Continuedonnextpage…
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
67
Lutron integration protocol
Example SHADEGRP Messages
Operation Command String
Execute: #SHADEGRP,IntegrationID,ActionNumber,Parameters
Setshadegroupto70%(Delay=2sec) #SHADEGRP,2,1,70,2<CR><LF>
Lowershadegroup #SHADEGRP,2,3<CR><LF>
Query: ?SHADEGRP,IntegrationID,ActionNumber
Whatisthecurrentactivepreset? ?SHADEGRP,2,6<CR><LF>
Response: ~SHADEGRP,IntegrationID,ActionNumber,Parameters
ShadegroupPreset2iscurrentlyactive ~SHADEGRP,2,6,2<CR><LF>
myRoom plus (continued)
System Commands (continued)SHADEGRPCommands(continued)
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
68
Lutron integration protocol
myRoom plus (continued)
System Commands (continued)TIMECLOCKCommands
TIMECLOCK Command Formats
TIMECLOCK Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Get(?)SunriseTime 2 None
Get(?)SunsetTime 3 None
Get(?)Day’sSchedule 4 None
Set(#)ExecuteIndexedEvent
5 Indexoftheeventtotest Theindexnumberofthefirsteventis1;thesecondeventis2,andsoon
Set(#)IndexedEventasEnabledorDisabled
6 EventIndex,EnableState(1=Enable,2=Disable)
Example TIMECLOCK Messages
Operation Command String
Execute: #TIMECLOCK,IntegrationID,ActionNumber,Parameters
Executethe3rdeventofthetimeclock #TIMECLOCK,2,5,3<CR><LF>
Query:?TIMECLOCK,IntegrationID,ActionNumber
Whatisthesunrisetime? ?TIMECLOCK,2,2<CR><LF>
Response:~TIMECLOCK,IntegrationID,ActionNumber,Parameters
Thetimethesunrises ~TIMECLOCK,2,2,05:32<CR><LF>
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
Use “TIMECLOCK Command-specific fields” tables to complete these command fields.
Operation
Command
#TIMECLOCK,2,ActionNumber,ParametersIntegration ID (example)
69
Lutron integration protocol
myRoom plus (continued)
System Commands (continued)SYSVARCommands
SYSVAR Command Formats
SYSVAR Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)thestateofagivenvariable
1 Statenumber
Example SYSVAR Messages
Operation Command String
Execute: #SYSVAR,IntegrationID,ActionNumber,Parameters
Setthevariablestatetothethirdstate #SYSVAR,2,1,3<CR><LF>
Query:?SYSVAR,IntegrationID,ActionNumber
Whatisthestateofthevariable? ?SYSVAR,2,1<CR><LF>
Response:~SYSVAR,IntegrationID,ActionNumber,Parameters
Thevariableisinthethirdstate ~SYSVAR,2,1,3<CR><LF>
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
Use “SYSVAR Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#SYSVAR,2,ActionNumber,Parameters
70
Lutron integration protocol
myRoom plus (continued)
System Commands (continued)AREACommands
AREA Command Formats
AREA Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Get(?)OccupancyState1 8 3=Occupied4=Unoccupied
Use “AREA Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
?AREA1,2,ActionNumber,Parameters
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
NOTE
1 ThisisnotforGuestPresenceDetectionoftheroom
NOTE
1 AREAcommandscannotbesenttoareasthatcontainotherareas,suchasaroomthathasmultipleareaswithinit(e g ,bedroom,bathroom)
Example AREA Messages
Operation Command String
Execute: #AREA,IntegrationID,ActionNumber,Parameters
Setarealevelto75%(Fade=4sec,Delay=2sec) #AREA,2,1,70,4,2<CR><LF>
LowerArea #AREA,2,3<CR><LF>
Query: ?AREA,IntegrationID,ActionNumber
Istheareaoccupied? ?AREA,2,8<CR><LF>
Whatisthecurrentactivescene? ?AREA,2,6<CR><LF>
Response: ~AREA,IntegrationID,ActionNumber,Parameters
Theareaiscurrentlyoccupied ~AREA,2,8,3<CR><LF>
AreaScene2iscurrentlyactive ~AREA,2,6,2<CR><LF>
71
Lutron integration protocol
ETHERNET Command-specific fields
Configuration NumberandParameters:
Description Configuration Number Parameters
Set(#)orGet(?)IPAddress 0 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)GatewayAddress
1 IPAddress(XXX XXX XXX XXX)
Set(#)orGet(?)SubnetMask 2 IPAddress(XXX XXX XXX XXX)
Get(?)DHCP 4 None
Set(#)orGet(?)MulticastAddress
5 IPAddress(XXX XXX XXX XXX)
Example ETHERNET Commands
Operation Command String
Execute: #ETHERNET,ConfigurationNumber,Parameters
SetIPAddressto192 168 250 1 #ETHERNET,0,192.168.250.1<CR><LF>
SetGatewayAddressto10 2 4 1 #ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET,ConfigurationNumber,Parameters
WhatistheIPAddress? ?ETHERNET,0<CR><LF>
Response: ~DEVICE,IntegrationID,ConfigurationNumber,Parameters
TheIPAddressis192 168 250 1 ~ETHERNET,0=,192.168.250.1<CR><LF>
myRoom plus (continued)
System Commands (continued)ETHERNETCommands
ETHERNET Command Formats
Use “ETHERNET Command-specific fields” tables to complete these command fields.
Operation
Command
#ETHERNET,ConfigurationNumber,Parameters
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
72
Lutron integration protocol
INTEGRATION ID Command-specific fields
Action NumbersandParameters:
Description Action Number Parameters
Get(?)IntegrationIDforaSerialNumber1
1 SerialNumber=8characterHEXserialnumberofthedevice
Get(?)InfofromID1 3 IntegrationIDNote:Ifthisfieldisleftblank,allintegrationIDswillbeprinted
Example INTEGRATION ID Commands
Operation Command String
Query: ?INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GettheIntegrationIDforaserialnumber ~INTEGRATIONID,1,5678EFEF,1<CR><LF>
Query: ?INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand
?INTEGRATIONID,3,1<CR><LF>
Response: ~INTEGRATIONID,ActionNumber,Parameters
GetinformationaboutanIntegrationIDcommand
~INTEGRATIONID,3,1,DEVICE,5678EFEF<CR><LF>
myRoom plus (continued)
System Commands (continued)INTEGRATIONIDCommands
INTEGRATION ID Command Formats
Use “INTEGRATIONID Command-specific fields” tables to complete these command fields.
Operation
Command
?INTEGRATIONID,ActionNumber,Parameters
Continuedonnextpage…
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
NOTE1 RefertotheintegrationreportgeneratedbytheLutronDesignerTooltoidentifytheintegrationIDsfordevices
73
Lutron integration protocol
RESET Command Formats
RESET Command-specific fields
Action Numbers:
Action Action Number
Set(#)ResetstheGCU-HOSP 0
Example RESET Commands
Operation Command String
Execute: #RESET,ActionNumber
ResettheGCU-HOSP #RESET,0<CR><LF>
Use “RESET Command-specific fields” tables to complete these command fields.
Operation
Command
#RESET,ActionNumber
myRoom plus (continued)
System Commands (continued)RESETCommands
Assembled in U.S.A.
50015757 Rev. A
GCU-HOSPGuestroom Control Unit
+ 44.(0)20.7680.4481
+ 1.800.523.9466lutron.com
243C IND. CONT. EQ.
IEC PELV/NEC Class 2 ®
74
Lutron integration protocol
Why Integrate with a GRAFIK Eye QS unit?• Controlindividuallightsandscenes• Querycurrentsceneandlightlevels• ControlLEDsofunprogrammedbuttons
Integration Capabilities• 16scenesandupto24controllableoutputs(outputcountdependsonmodel)
Supported Command Types• DEVICE allowscontrolandmonitoringofbuttons,LEDsandscenes• OUTPUTallowscontrolandmonitoringofthedimmerdeviceoutput
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusGRAFIKEyeQSMainUnit
1 2 3 4 5 6 Scene 1
OK
Fade Time
03 Seconds
DevicesGRAFIK Eye QSMainUnitModels:QSGR-,QSGRJ-,QSGRK-,QSGRM-,QSGRN-,QSGRQ-
Continuedonnextpage…
75
Lutron integration protocol
Continuedonnextpage…
Devices (continued)
GRAFIK Eye QS (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Zone1Controller–Zone24Controller 1–24 Raise,Lower,Stop,SetLightLevelScene1Button 70 Press,Release(ScenesActivateon“Press”)Scene2Button 71 Press,Release(ScenesActivateon“Press”)Scene3Button 76 Press,Release(ScenesActivateon“Press”)Scene4Button 77 Press,Release(ScenesActivateon“Press”)SceneOffButton 83 Press,ReleaseShadeColumn1Open 38 Press,Release(ShadesReacton“Release”)ShadeColumn1Preset1 39 Press,Release(ShadesReacton“Release”)ShadeColumn1Close 40 Press,Release(ShadesReacton“Release”)ShadeColumn1Lower 41 Press,Release(ShadesReacton“Release”)ShadeColumn1Raise 47 Press,Release(ShadesReacton“Release”)ShadeColumn2Open 44 Press,Release(ShadesReacton“Release”)ShadeColumn2Preset1 45 Press,Release(ShadesReacton“Release”)ShadeColumn2Close 46 Press,Release(ShadesReacton“Release”)ShadeColumn2Lower 52 Press,Release(ShadesReacton“Release”)ShadeColumn2Raise 53 Press,Release(ShadesReacton“Release”)ShadeColumn3Open 50 Press,Release(ShadesReacton“Release”)ShadeColumn3Preset1 51 Press,Release(ShadesReacton“Release”)ShadeColumn3Close 56 Press,Release(ShadesReacton“Release”)ShadeColumn3Lower 57 Press,Release(ShadesReacton“Release”)ShadeColumn3Raise 58 Press,Release(ShadesReacton“Release”)
SceneController 141SetCurrentScene,SetZoneLock,SetSceneLock,SetSequenceState,Raise,Lower,Stop,SceneSave
Scene1LED1 201 Get(?)LEDstateScene2LED1 210 Get(?)LEDstateScene3LED1 219 Get(?)LEDstateScene4LED1 228 Get(?)LEDstateSceneOffLED1 237 Get(?)LEDstateLocalCCI 163 Report(~)Occupied,Report(~)UnoccupiedTimeclockController 166 Enable/Disable,QueryStatusWirelessOccupancySensor1–30 500–529 Report(~)Occupied,Report(~)UnoccupiedEcoSystemBallastOccupancySensor1–64 700–763 Report(~)Occupied,Report(~)Unoccupied
NOTE1 NotsupportedinQSStandalone
1 2 3 4 5 6 Scene 1
OK
Fade Time
03 Seconds
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
76
Lutron integration protocol
DEVICE Command-specific fields (continued)
Component Numbers (continued):
Component Component Number Available Actions
ShadeColumn1OpenLED1 174 Get(?)LEDstateShadeColumn1Preset1LED1 175 Get(?)LEDstateShadeColumn1CloseLED1 211 Get(?)LEDstateShadeColumn2OpenLED1 183 Get(?)LEDstateShadeColumn2Preset1LED1 184 Get(?)LEDstateShadeColumn2CloseLED1 220 Get(?)LEDstateShadeColumn3OpenLED1 192 Get(?)LEDstateShadeColumn3Preset1LED1 193 Get(?)LEDstateShadeColumn3CloseLED1 229 Get(?)LEDstate
NOTE1 NotsupportedinQSStandalone
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)PressorOccupied 3 NoneSet(#)ReleaseorUnoccupied 4 NoneSet(#)CurrentScene1,2 7 SceneSet(#)orGet(?)LEDState3 9 0=Off
1=On2=Normal-Flash:1flasheverysecond23=Rapid-Flash:10flasheseverysecond2
Set(#)SceneSave 12 SceneSet(#)orGet(?)LightLevel4,5 14 Level=0–100or0 00–100 00
Fade6in:SS ss7,SS,MM:SS,orHH:MM:SSJ79(QSStandalonefade:maximum4hours)
Delay6in:SS ss7,SS,MM:SS,orHH:MM:SS(QSStandalonedelay:maximum4hours)
Set(#)ZoneLock8 15 0=Off;1=OnSet(#)SceneLock8 16 0=Off;1=OnSet(#)SequenceState8 17 0=Off
1=SequencethroughScenes1–42=SequencethroughScenes5–16
Set(#)StartRaising4,5 18 NoneSet(#)StartLowering4,5 19 NoneSet(#)StopRaisingorLowering4,5 20 NoneSet(#)orGet(?)TimeclockState 34 0=Disabled
1=Enabled
NOTESThe number of zone controllers available matches the number of zones a particular model supports.
1 NotsupportedinHomeWorksQS/myRoomplus 2 NotsupportedinRadioRA2 3 QuantumorHomeWorksonly “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘DefinedbyIntegration ’4 UseOUTPUTcommandwithequivalentcommandinRadioRA2 5 UseOUTPUTcommandwithequivalentcommandinHomeWorksQS/myRoomplus 6 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 7 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused 8 QSStandaloneonly
Devices (continued)
GRAFIK Eye QS (continued)DEVICECommands(continued)
1 2 3 4 5 6 Scene 1
OK
Fade Time
03 Seconds
Continuedonnextpage…
77
Lutron integration protocol 1 2 3 4 5 6 Scene 1
OK
Fade Time
03 Seconds
Devices (continued)
GRAFIK Eye QS (continued)OUTPUTCommands
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonefade:maximum4hours)Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonedelay:maximum4hours)Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 None
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersec Forexample,ifafadetimeisspecifiedas
1 31secondsavalueof1 25secondswillbeused
Example OUTPUT Commands
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,ParametersSetdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>StartRaisingzonelevel #OUTPUT,1,2<CR><LF>StopRaising/Loweringzonelevel #OUTPUT,1,4<CR><LF>Query: ?OUTPUT,IntegrationID,ActionNumberWhatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>Response 1: ~OUTPUT,IntegrationID,ActionNumber,ParametersOutputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(IntegrationID-1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
OUTPUT Command Format
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
78
Lutron integration protocol
Why Integrate with an Energi Savr Node (ESN) unit?• Controlindividualzonesandscenesinanarea• Querycurrentsceneandlightlevels
Integration Capabilities• Upto32areaswith16scenesperarea Upto32zonesacrossthetwoDALI®buses
Supported Command Types• DEVICE allowscontrolandmonitoringofzonelevelsandareascenes• OUTPUTallowscontrolandmonitoringofthedimmerdeviceoutput
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusEnergiSavrNodeQS/DALI® HomeWorksQS/myRoomPowerModule/DALI®
Devices (continued)
Energi Savr Node QS for DALIRModel:QSNE-2DAL-D
HomeWorks QS / myRoom Power Module for DALIRModel:LQSE-2DAL-D
VD E
Test
Power
Hi Temp
Ethernet DALI 1 DALI 2
IR
Phot
o
Com
20
V
20 V
Com
MU
X
MU
X
24 V
CO
M
Occ IR
Phot
o
Occ
Energi Savr Node QSQSNE-2DAL-D230 V~ 50/60 Hz 100 mAwww.lutron.com
+44.(0)20.7680.4481L N
1 1 2 2
3 3 4 4QS
8 mm0,5 N∙m
N1771Z096
Continuedonnextpage…
QSNE-2DAL-D
79
Lutron integration protocol
Devices (continued)
Energi Savr Node QS for DALIRHomeWorks QS / myRoom Power Module for DALIR (continued)DEVICECommands
iPhoneandiPodToucharetrademarksofApple,Inc ,registeredintheU S andothercountries
VD E
Test
Power
Hi Temp
Ethernet DALI 1 DALI 2
IR
Phot
o
Com
20
V
20 V
Com
MU
X
MU
X
24 V
CO
M
Occ IR
Phot
o
Occ
Energi Savr Node QSQSNE-2DAL-D230 V~ 50/60 Hz 100 mAwww.lutron.com
+44.(0)20.7680.4481L N
1 1 2 2
3 3 4 4QS
8 mm0,5 N∙m
N1771Z096
DEVICE Command Formats
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Zone1–Zone321,2,3 301–332 SetorGetLightLevel,Raise,Lower,StopArea1–Area321,3 401–432 SetorGetScene,SetLightLevel,Raise,Lower,StopOccupancySensors1–4 151–154 Report(~)Occupied
Report(~)Unoccupied
NOTES1 ZonesandareasarecreatedandconfiguredusingtheLutronESNConfigurationToolonaniPhone oriPod Touch mobile
device,theQuantumQ-DesignTool,theHomeWorksQSLutronDesigner,orthemyRoomLutronDesigner Onlythoseareasandzonesthathavebeenconfiguredusingoneofthesetoolsareaccessiblethroughintegration
2 AssignedzonescanbegivenanindividualIntegrationIDandcontrolledusingthe#OUTPUTcommand FormoredetailsonsettingtheoutputIntegrationIDofazonecomponent,seetheIntegrationAccessPointsectionofthesystemthatcontainstheESN
3 WhentheESNispartofaQuantumsystem,thenthe#AREAand#OUTPUTcommandsfoundintheQuantum“SystemCommands”sectionofthisintegrationdocumentshouldbeused
Action Numbers and Parameters:
Action Action Number Parameters
Report(~)Occupied 3 NoneReport(~)Unoccupied 4 NoneSet(#)orGet(?)CurrentScene 7 SceneSet(#)SceneSave1 12 SceneSet(#)orGet(?)LightLevel 14 Level=0–100or0 00–100 00
Fade2in:SS ss3,SS,MM:SS,orHH:MM:SS(QS Standalonefade:maximum90seconds)
Delay2in:SS ss3,SS,MM:SS,orHH:MM:SS(QS Standalonedelay:maximum4hours)
Set(#)SceneLock4 16 0=Off;1=OnSet(#)SequenceState4 17 0=Off;1=SequencethroughScenes1–4;
2=SequencethroughScenes5–16Set(#)StartRaising 18 NoneSet(#)StartLowering 19 NoneSet(#)StopRaisingorLowering 20 None
NOTES1 AvailableonlywithEnergiSavrNodefirmware>6 x 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifafadetimeisspecified
as1 31seconds,avalueof1 25secondswillbeused 4 QSStandaloneonly
Continuedonnextpage…
80
Lutron integration protocol
Devices (continued)
Energi Savr Node QS for DALIRHomeWorks QS / myRoom Power Module for DALIR (continued)OUTPUTCommands
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonefade:maximum90seconds)Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonedelay:maximum4hours)Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 None
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused
Example OUTPUT Commands
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,ParametersSetdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>StartRaisingzonelevel #OUTPUT,1,2<CR><LF>StopRaising/Loweringzonelevel #OUTPUT,1,4<CR><LF>Query: ?OUTPUT,IntegrationID,ActionNumberWhatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>Response 1: ~OUTPUT,IntegrationID,ActionNumber,ParametersOutputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(IntegrationID-1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
VD E
Test
Power
Hi Temp
Ethernet DALI 1 DALI 2
IR
Phot
o
Com
20
V
20 V
Com
MU
X
MU
X
24 V
CO
M
Occ IR
Phot
o
Occ
Energi Savr Node QSQSNE-2DAL-D230 V~ 50/60 Hz 100 mAwww.lutron.com
+44.(0)20.7680.4481L N
1 1 2 2
3 3 4 4QS
8 mm0,5 N∙m
N1771Z096
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
81
Lutron integration protocol
Why Integrate with an Energi Savr Node unit?• Controlindividualzonesandscenesinanarea• Querycurrentsceneandlightlevels
Integration Capabilities• Upto100areaswith16scenesperarea Upto100zonesacrossthetwoEcoSystemloops
Supported Command Types• DEVICE allowscontrolandmonitoringofzonelevelsandareascenes• OUTPUTallowscontrolandmonitoringofthedimmerdeviceoutput
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusEnergiSavrNodeQS/EcoSystem EnergiSavrNodeQS/EcoSystem(Int’l) HomeWorksQS/myRoomPowerModule/EcoSystem
Devices (continued)
Energi Savr Node QS with EcoSystemModel:QSN-2ECO-S
Energi Savr Node QS with EcoSystem (International)Model:QSNE-2ECO-D
HomeWorks QS / myRoom Power Module with EcoSystemModel:LQSE-2ECO-D
QSNE-2ECO-D QSN-2ECO-S
Continuedonnextpage…
82
Lutron integration protocol
Devices (continued)
Energi Savr Node QS with EcoSystemHomeWorks QS / myRoom Power Module with EcoSystem (continued)DEVICECommands1DEVICE Command Formats
iPhoneandiPodToucharetrademarksofApple,Inc ,registeredintheU S andothercountries
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
DEVICE Command-specific fields
Component Numbers:Component Component Number Available Actions
OccupancySensors1–4 136–139 Report(~)Occupied,Report(~)UnoccupiedLoop1BallastOccupancySensors 140–203 Report(~)Occupied,Report(~)UnoccupiedLoop2BallastOccupancySensors 204–267 Report(~)Occupied,Report(~)UnoccupiedZone1–Zone1001,2,3 1001–1100 SetorGetLightLevel,Raise,Lower,StopArea1–Area1001,3 1201–1300 SetorGetScene,SetLightLevel,Raise,Lower,Stop
NOTES1 ZonesandareasarecreatedandconfiguredusingtheLutronESNConfigurationToolonaniPhone oriPod Touch mobile
device,theQuantumQ-DesignTool,theHomeWorksQSLutronDesigner,orthemyRoomLutronDesigner Onlythoseareasandzonesthathavebeenconfiguredusingoneofthesetoolsareaccessiblethroughintegration
2 AssignedzonescanbegivenanindividualIntegrationIDandcontrolledusingthe#OUTPUTcommand FormoredetailsonsettingtheoutputIntegrationIDofazonecomponent,seetheIntegrationAccessPointsectionofthesystemthatcontainstheESN
3 WhentheESNispartofaQuantum,HomeWorksQSormyRoomplussystem,the#AREAand#OUTPUTcommandsfoundintheQuantum“SystemCommands”sectionofthisintegrationdocumentshouldbeused
Action Numbers and Parameters:Action Action Number Parameters
Report(~)Occupied 3 NoneReport(~)Unoccupied 4 NoneSet(#)orGet(?)CurrentScene 7 SceneSet(#)SceneSave1 12 SceneSet(#)orGet(?)LightLevel 14 Level=0–100or0 00–100 00
Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)SceneLock4 16 0=Off;1=OnSet(#)SequenceState4 17 0=Off;1=SequencethroughScenes1–4;
2=SequencethroughScenes5–16Set(#)StartRaising 18 NoneSet(#)StartLowering 19 NoneSet(#)StopRaisingorLowering 20 None
NOTES1 AvailableonlywithEnergiSavrNodeFirmware>6 x 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31seconds,avalueof1 25secondswillbeused 4 QSStandaloneonly
NOTE1 NotSupportedinHomeWorksQS/myRoomplus
Continuedonnextpage…
83
Lutron integration protocol
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonefade:maximum2hours)Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonedelay:maximum4hours)Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 None
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused
Example OUTPUT Commands
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,ParametersSetdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>StartRaisingzonelevel #OUTPUT,1,2<CR><LF>StopRaising/Loweringzonelevel #OUTPUT,1,4<CR><LF>Query: ?OUTPUT,IntegrationID,ActionNumberWhatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>Response1: ~OUTPUT,IntegrationID,ActionNumber,ParametersOutputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(IntegrationID-1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
Devices (continued)
Energi Savr Node QS with EcoSystemHomeWorks QS / myRoom Power Module with EcoSystem (continued)OUTPUTCommands
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
84
Lutron integration protocol
Why Integrate with an Energi Savr Node unit?• Controlindividualzonesandscenesinanarea• Querycurrentsceneandlightlevels
Integration Capabilities• Fourareaswith16scenesperarea Fourzonesonfourindependentoutputs
Supported Command Types• DEVICE allowscontrolandmonitoringofzonelevelsandareascenes• OUTPUTallowscontrolandmonitoringofthedimmerdeviceoutput
Compatibility QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusEnergiSavrNodeQS/0–10V/Softswitch(Int’l) EnergiSavrNodeQS/Phase-Adaptive(Int’l) EnergiSavrNodeQS/0–10V/Softswitch
HomeWorksQSPowerModule/0–10V/Softswitch/PhaseAdaptive
Devices (continued)
Energi Savr Node QS for 0 –10 V/Softswitch (International)Models (QSNE-):4T10-D,4S10-D
Energi Savr Node QS for Phase Adaptive (International)Model:QSNE-4A-D
Energi Savr Node QS for 0 –10 V/SoftswitchModels (QSN-):4T16-S,4S16-S
HomeWorks QS / myRoom Power Module for 0 –10 V/Softswitch / Phase Adaptive0-10 V / Switching Models (LQSE-):4T10-D,4S10-DPhase Adaptive Model:LQSE-4A-D
QSN-4T16-S
QSNE-4A-D
H
M
L
QSNE
-4A-D
DIN
Rai
l Pow
er M
odul
e
230 V~ 50 / 60 Hz 10 A www.lutron.com +44.(0)20.7702.0657
InputS1 S2 S3 S4 CCI
SwitchOccPhotoIR
Type
500 W Max 800 W Max 500 W Max 500 W Max
Zone 2Zone 1 Zone 3 Zone 4
Input
Hi Temp
Prog
Power
Opt1
Opt2
Opt3
DefOption
QSNE-4T10-D
Continuedonnextpage…
85
Lutron integration protocol
Devices (continued)
Energi Savr Node QS for 0 –10 V/Softswitch/Phase AdaptiveHomeWorks QS / myRoom Power Module for 0 –10 V/Softswitch / Phase Adaptive (continued)DEVICECommands1
DEVICE Command Formats
iPhoneandiPodToucharetrademarksofApple,Inc ,registeredintheU S andothercountries
H
M
L
QSNE
-4A-D
DIN
Rai
l Pow
er M
odul
e
230 V~ 50 / 60 Hz 10 A www.lutron.com +44.(0)20.7702.0657
InputS1 S2 S3 S4 CCI
SwitchOccPhotoIR
Type
500 W Max 800 W Max 500 W Max 500 W Max
Zone 2Zone 1 Zone 3 Zone 4
Input
Hi Temp
Prog
Power
Opt1
Opt2
Opt3
DefOption
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
DEVICE Command-specific fields Component Numbers:
Component Component Number Available ActionsZone1–Zone41,2,3 5–8 SetorGetLightLevel,Raise,Lower,StopArea1–Area41,3 10–13 SetorGetScene,SetLightLevel,Raise,Lower,StopOccupancySensor1–4 34–37 Report(~)Occupied,Report(~)UnoccupiedOccupancySensor1–2 34–35 Report(~)Occupied,Report(~)Unoccupied
NOTES1 ZonesandareasarecreatedandconfiguredusingtheLutronESNConfigurationToolonaniPhone oriPod Touch mobile
device,theQuantumQ-DesignTool,theHomeWorksQSLutronDesigner,orthemyRoomLutronDesigner Onlythoseareasandzonesthathavebeenconfiguredusingoneofthesetoolsareaccessiblethroughintegration
2 AssignedzonescanbegivenanindividualIntegrationIDandcontrolledusingthe#OUTPUTcommand FormoredetailsonsettingtheoutputIntegrationIDofazonecomponent,seetheIntegrationAccessPointsectionofthesystemthatcontainstheESN
3 WhentheESNispartofaQuantum,HomeWorksQSormyRoomplussystem,the#AREAand#OUTPUTcommandsfoundintheQuantum“SystemCommands”sectionofthisintegrationdocumentshouldbeused
Action Numbers and Parameters:Action Action Number ParametersReport(~)Occupied 3 NoneReport(~)Unoccupied 4 NoneSet(#)orGet(?)CurrentScene1 7 SceneSet(#)SceneSave2 12 SceneSet(#)orGet(?)LightLevel 14 Level=0–100or0 00–100 00
Fade3in:SS ss4,SS,MM:SS,orHH:MM:SSDelay3in:SS ss4,SS,MM:SS,orHH:MM:SS
Set(#)SceneLock1 16 0=Off;1=OnSet(#)SequenceState1 17 0=Off;1=SequencethroughScenes1–4;
2=SequencethroughScenes5–16Set(#)StartRaising 18 NoneSet(#)StartLowering 19 NoneSet(#)StopRaisingorLowering 20 None
NOTES1 QSStandaloneonly 2 AvailableonlywithEnergiSavrNodeFirmware>6 x 3 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 4 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifafadetimeisspecified
as1 31seconds,avalueof1 25secondswillbeused
NOTE1 NotSupportedinHomeWorksQS/myRoomplus
Continuedonnextpage…
86
Lutron integration protocolH
M
L
QSNE
-4A-D
DIN
Rai
l Pow
er M
odul
e
230 V~ 50 / 60 Hz 10 A www.lutron.com +44.(0)20.7702.0657
InputS1 S2 S3 S4 CCI
SwitchOccPhotoIR
Type
500 W Max 800 W Max 500 W Max 500 W Max
Zone 2Zone 1 Zone 3 Zone 4
Input
Hi Temp
Prog
Power
Opt1
Opt2
Opt3
DefOption
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonefade:maximum4hours)Delay1in:SS ss2,SS,MM:SS,orHH:MM:SS
(QS Standalonedelay:maximum4hours)Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 None
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused
Example OUTPUT Commands
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,ParametersSetdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>StartRaisingzonelevel #OUTPUT,1,2<CR><LF>StopRaising/Loweringzonelevel #OUTPUT,1,4<CR><LF>Query: ?OUTPUT,IntegrationID,ActionNumberWhatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>Response1: ~OUTPUT,IntegrationID,ActionNumber,ParametersOutputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(IntegrationID-1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
Devices (continued)
Energi Savr Node QS for 0 –10 V/Softswitch/Phase AdaptiveHomeWorks QS / myRoom Power Module for 0 –10 V/Softswitch / Phase Adaptive (continued)OUTPUTCommands
Operation
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
87
Lutron integration protocol
Why Integrate with an Energi Savr Node?• Allowscontrolandmonitoringofthedirectionandremainingtraveltimeofthefourhigh-voltage
outputs
Integration Capabilities• Upto4zones
Supported Command Types• DEVICE allowscontrolandmonitoringofzonelevels• OUTPUTallowscontrolandmonitoringofthedeviceoutputs
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusEnergiSavrNodeQS/MotorModule(Int’l) HomeWorksQS/myRoomPowerModuleforMotorModule
Devices (continued)
Energi Savr Node QS for Motor Module (International)Model:QSE-CI-4M-D
HomeWorks QS / myRoom Power Module for Motor ModuleModel:LQSE-4M-D
LQSE-CI-4M-D
Continuedonnextpage…
88
Lutron integration protocol
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Zone1–Zone41,2 1–4 SetorGetLightLevel,Raise,Lower,Stop
NOTES1 AssignedzonescanbegivenanindividualIntegrationIDandcontrolledusingthe#OUTPUTcommand Formoredetails
onsettingtheoutputIntegrationIDofazonecomponent,seetheIntegrationAccessPointsectionofthesystemthatcontainstheQSMotorModule
2 WhentheQSMotorModuleispartofaQuantumsystem,thenthecommandsfoundintheQuantum“SystemCommands”sectionofthisintegrationdocumentshouldbeused
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)LightLevel 14 Level=0–100or0 00–100 001Fade2in:Alwaysuse0Delay3in:SS ss4,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 18 NoneSet(#)StartLowering 19 NoneSet(#)StopRaisingorLowering 20 None
NOTES1 Settingthelevelto0%willcausetheoutputtotravelintheCloseddirection;settingthelevelto100%willcausethe
outputtotravelintheOpendirection;settinganylevelfrom1–99%willbeignoredbytheoutput Queryingitslevelwillreport0or100%,basedonthelastdirectionitmoved
2 FadeisnotavailableforMotorLoadsbecausetheymoveataconstantrate Theparametermustbeentered,butisignored
3 Thedelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay 4 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifafadetimeisspecified
as1 31seconds,avalueof1 25secondswillbeused
DEVICE Command Format
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
Devices (continued)
Energi Savr Node QS for Motor ModuleHomeWorks QS / myRoom Power Module for Motor Module (continued)DEVICECommands
Continuedonnextpage…
89
Lutron integration protocol
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0or100 001Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay4in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 NoneReport(~)TravelTimeRemaining5 17 Traveltimeinseconds:0–255Set(#)MotorJogRaise6 18 NoneSet(#)MotorJogLower6 19 NoneSet(#)Motor4-StageJogRaise6 20 NoneSet(#)Motor4-StageJogLower6 21 None
NOTES1 Settingthelevelto0%willcausetheoutputtotravelintheCloseddirection;settingthelevelto100%willcausethe
outputtotravelintheOpendirection;settinganylevelfrom1–99%willbeignoredbytheoutput Queryingitslevelwillreport0or100%,basedonthelastdirectionitmoved
2 FadeisnotavailableforShadesbecausetheymoveataconstantrate Theparametermustbeentered,butisignored 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifadelaytimeisspecified
as1 45seconds,avalueof1 25secondswillbeused 4 Thedelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay Theminimumdelaytimeis0 25
seconds;themaximumdelaytimeis4hours 5 Ifthetraveltimeofamotorisgreaterthan255seconds,theunitwillreport255untilthetraveltimedropsbelowthat
value 6 NotsupportedinQSStandalone
OUTPUT Command Format
Devices (continued)
Energi Savr Node QS for Motor ModuleHomeWorks QS / myRoom Power Module for Motor Module (continued)OUTPUTCommands
Operation
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Command
Integration ID (example)
#OUTPUT,3,ActionNumber,Parameters
90
Lutron integration protocol
Why Integrate with a Remote Power Module?• Controlindividualzonesandscenesinanarea• Querycurrentsceneandlightlevels
Integration Capabilities• Uptofourzonesoneachremotepowermodule
Supported Command Types• OUTPUTallowscontrolandmonitoringofthecontrolzoneoutput
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusRemotePowerModule
Devices (continued)
Remote Power ModuleAdaptive Phase Control Model:HW-RPM-4APhase Control Model:HW-RPM-4UQuiet Fan Speed Control Model:HW-RPM-4FSQ3-Wire Motor Control Model: HW-RPM-4MRelay Switching Model: HW-RPM-4R
HW-RPM-4A
Continuedonnextpage…
91
Lutron integration protocol
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 0–100or0 00–100 00
SS ss1,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 None
Set(#)StopLowering 3 None
Set(#)StopRaisingorLowering
4 None
Set(#)Flashing2 5 SS ss1,SS,MM:SS,orHH:MM:SS
Set(#)PulseTime 6 SS ss1,SS,MM:SS,orHH:MM:SS
Set(#)MotorJogRaise 18 None
Set(#)MotorJogLower 19 None
Set(#)Motor4-StageJogRaise
20 None
Set(#)Motor4-StageJogLower
21 None
NOTES1 Fractionsareroundeduptotheclosest¼second 2 Tostopadimmerfromflashing,sendittoavalidlevel(action1)
OUTPUT Command Format
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,6,ActionNumber,Parameters
Devices (continued)
Remote Power Module (continued)OUTPUTCommands
92
Lutron integration protocol
Why Integrate with a Low Capacity DIN Power Module?• Controlindividualzonesandscenesinanarea• Querycurrentsceneandlightlevels
Integration Capabilities• Fourareaswith16scenesperarea Fourzonesonfourindependentoutputs
Supported Command Types• DEVICE allowscontrolandmonitoringofzonelevelsandareascenes• OUTPUTallowscontrolandmonitoringofthedimmerdeviceoutput
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusLow-CapacitySwitchingDINPowerModule(1A/output) Low-CapacityPhase-AdaptiveDINPowerModule(1A/output)
Devices (continued)
Low-Capacity Switching DIN Power Module (1 A / output)myRoom plus Model: MQSE-4S1-DHomeWorks QS Model: LQSE-4S1-D
Low-Capacity Phase Adaptive DIN Power Module (1 A / output)myRoom plus Model: MQSE-4A1-DHomeWorks QS Model: LQSE-4A1-D
MQSE-4S1-D
LQSE-4A1-D
myRoomMQSE-4S1-D100 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
1 2 3 4
CC
I CO
M
CC
O N
.O.
CC
O C
OM
24 V
CO
M
CC
I
CC
O N
.C.
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
100 - 240 V~ 1 A
120 - 240 V~ 1 AX, 1 FLA / 6 LRA
IEC PELV /NECR Class 224 V- 132 mA
4,4 in-lb0,5 N•m65 / 75 °CCu Al N N N N N N
M
LL
HomeWorks QSLQSE-4A1-D120 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
CO
M
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
N N N N
120 - 240 V~ 1 A
DL1 DL2 DL3 DL4
CC
I CO
M
CC
I
NL
Continuedonnextpage…
93
Lutron integration protocol
Devices (continued)
Low-Capacity Switching/Phase-Adaptive DIN Power Module (1 A / output) (continued)DEVICECommands1
DEVICE Command Formats
iPhoneandiPodToucharetrademarksofApple,Inc ,registeredintheU S andothercountries
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Zone1–Zone41,2,3 5–8 SetorGetLightLevel,Raise,Lower,StopArea1–Area42,3 10–13 SetorGetScene,SetLightLevel,Raise,Lower,StopContactClosureInput 26 ReportOpen,ReportClosed
NOTES1 ZonesandareasarecreatedandconfiguredusingtheHomeWorksQSLutronDesigner,orthemyRoomLutron
Designer Onlythoseareasandzonesthathavebeenconfiguredusingoneofthesetoolsareaccessiblethroughintegration
2 AssignedzonescanbegivenanindividualIntegrationIDandcontrolledusingthe#OUTPUTcommand FormoredetailsonsettingtheoutputIntegrationIDofazonecomponent,seetheIntegrationAccessPointsectionofthesystemthatcontainstheESN
3 WhentheESNispartofaHomeWorksormyRoomsystem,thenthe#AREAand#OUTPUTcommandsfoundintheQuantum“SystemCommands”sectionofthisintegrationdocumentshouldbeused
Action Numbers and Parameters:
Action Action Number Parameters
Report(~)OccupiedorClosed1 3 NoneReport(~)UnoccupiedorOpen1 4 NoneSet(#)orGet(?)CurrentScene 7 SceneSet(#)orGet(?)LightLevel 14 Level=0–100or0 00–100 00
Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 18 NoneSet(#)StartLowering 19 NoneSet(#)StopRaisingorLowering 20 None
NOTES1 MQSE-4S1-Donly2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquarter-second Forexample,ifafadetimeisspecified
as1 31seconds,avalueof1 25secondswillbeused
NOTE1 NotSupportedinHomeWorksQS/myRoomplus
myRoomMQSE-4S1-D100 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
1 2 3 4
CC
I CO
M
CC
O N
.O.
CC
O C
OM
24 V
CO
M
CC
I
CC
O N
.C.
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
100 - 240 V~ 1 A
120 - 240 V~ 1 AX, 1 FLA / 6 LRA
IEC PELV /NECR Class 224 V- 132 mA
4,4 in-lb0,5 N•m65 / 75 °CCu Al N N N N N N
M
LL
HomeWorks QSLQSE-4A1-D120 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
CO
M
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
N N N N
120 - 240 V~ 1 A
DL1 DL2 DL3 DL4
CC
I CO
M
CC
I
NL
Continuedonnextpage…
94
Lutron integration protocol
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevelSet(#)orGet(?)CCOState1
1 Level=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SS
maximum4hoursDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
maximum4hoursSet(#)StartRaising 2 NoneSet(#)StartLowering 3 NoneSet(#)StopRaisingorLowering 4 NoneSet(#)PulseCCO1 6 None
NOTES1 Low-capacityswitchingonly 2 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused
Example OUTPUT Commands
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,ParametersSetdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>StartRaisingzonelevel #OUTPUT,1,2<CR><LF>StopRaising/Loweringzonelevel #OUTPUT,1,4<CR><LF>Query: ?OUTPUT,IntegrationID,ActionNumberWhatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>Response1: ~OUTPUT,IntegrationID,ActionNumber,ParametersOutputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(IntegrationID-1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
Devices (continued)
Low-Capacity Switching/Phase-Adaptive DIN Power Module (1 A / output) (continued)OUTPUTCommands
Operation
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
myRoomMQSE-4S1-D100 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
1 2 3 4
CC
I CO
M
CC
O N
.O.
CC
O C
OM
24 V
CO
M
CC
I
CC
O N
.C.
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
100 - 240 V~ 1 A
120 - 240 V~ 1 AX, 1 FLA / 6 LRA
IEC PELV /NECR Class 224 V- 132 mA
4,4 in-lb0,5 N•m65 / 75 °CCu Al N N N N N N
M
LL
HomeWorks QSLQSE-4A1-D120 - 240 V~ 50 / 60 Hz 4 A
+1.610.282.3800lutron.com
CO
M
MU
X
MU
XZn. 1Prog. Zn. 2 Zn. 3 Zn. 4
N N N N
120 - 240 V~ 1 A
DL1 DL2 DL3 DL4
CC
I CO
M
CC
I
NL
95
Lutron integration protocol
Why Integrate with a Palladiom Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
Palladiom KeypadsQS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plus
QSModel HomeWorksQSModel myRoomTModel
Devices (continued)
Palladiom KeypadQS Models (QWP-):U-2W,U-3W,U-4W,U-RW,S-2W,S-3W,S-4W,S-RW,S-22W,S-24W,S-42W,S-44W,S-2RW,S-4RW,S-RRW,B-2W,B-3W,B-4W,B-RW,B-22W,B-24W,B-42W,B-44W,B-2RW,B-4RW,B-RRW HomeWorks QS Models (HQWT-): U-P2W,U-P3W,U-P4W,U-PRW,S-P2W,S-P3W,S-P4W,S-PRW,S-P22W,S-P24W,S-P42W,S-P44W,S-P2RW,S-P4RW,S-PRRW,B-P2W,B-P3W,B-P4W,B-PRW,B-P22W,B-P24W,B-P42W,B-P44W,B-P2RW,B-P4RW,B-PRRW myRoom Models (MWP-):U-2W,U-3W,U-4W,U-RW,S-2W,S-3W,S-4W,S-RW,S-22W,S-24W,S-42W,S-44W,S-2RW,S-4RW,S-RRW,B-2W,B-3W,B-4W,B-RW,B-22W,B-24W,B-42W,B-44W,B-2RW,B-4RW,B-RRW
22W
button5
button8
button1
button4
24W
button5
button8
button1
button3
button2
button4
42W
button1
button4
button5
button7
button6
button8
44W
button5
button7
button6
button8
button1
button3
button2
button4
2W
button1
button4
3W
button1
button2
button4
4W
button1
button3
button2
button4
U.S. Style FaceplateSquare Style Faceplates
RW
button1
button3
button2
2RW
button5
button8
button1
button3
button2
4RW
button5
button7
button6
button8
button1
button3
button2
RRW
button1
button3
button2
button5
button7
button6
Continuedonnextpage…
96
Lutron integration protocol
Scene 1
Scene 2
Scene 3
Devices (continued)
Palladiom Keypad (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Column1,Button1 1 Press,ReleaseColumn1,Button2 2 Press,ReleaseColumn1,Button3 3 Press,ReleaseColumn1,Button4 4 Press,ReleaseColumn2,Button1 5 Press,ReleaseColumn2,Button2 6 Press,ReleaseColumn2,Button3 7 Press,ReleaseColumn2,Button4 8 Press,ReleaseColumn1,Lower 16 Press,ReleaseColumn1,Raise 17 Press,ReleaseColumn2,Lower 18 Press,ReleaseColumn2,Raise 19 Press,ReleaseColumn1,LED1 81 SetorGetLEDstateColumn1,LED2 82 SetorGetLEDstateColumn1,LED3 83 SetorGetLEDstateColumn1,LED4 84 SetorGetLEDstateColumn2,LED1 85 SetorGetLEDstateColumn2,LED2 86 SetorGetLEDstateColumn2,LED3 87 SetorGetLEDstateColumn2,LED4 88 SetorGetLEDstateActiveLEDIntensity1 89 SetorGetLEDstateInactiveLEDIntensity1 113 SetorGetLEDstate
NOTE
1 LEDintensitycanbesetonlywhentheDBMsensorisdisabled
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
97
Lutron integration protocol
Devices (continued)
Palladiom Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1 9 0=Off1=On2=Normal-Flash:1flasheverysecond13=Rapid-Flash:10flasheseverysecond1
Set(#)orGet(?)ActiveLEDLevel1,2
36 0–100
Set(#)orGet(?)InactiveLEDLevel1,2
37 0–100
NOTES
1 “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘DefinedbyIntegration ’2 LEDintensitycanbesetonlywhentheDBMsensorisdisabled
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
SetActiveLEDto50 #DEVICE,2,89,36,50<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatistheInactiveLEDLevel? ?DEVICE,2,113,37<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
InactiveLEDLevelis75% ~DEVICE,2,113,37,75<CR><LF>
Scene 1
Scene 2
Scene 3
Continuedonnextpage…
98
Lutron integration protocol
Why Integrate with an Architrave Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
Architrave KeypadsQS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plus
QSModel HomeWorksQS/myRoomModel
Devices (continued)
Architrave KeypadQS Models (QSWAS-) with Faceplate / Button Kit Models (KP5-, KP7-):DN,KP7HomeWorks QS / myRoom Models (HQWA-) with Faceplate / Button Kit Models (KP5-, KP7-):DN,KP7
KP5-DN KP5-DW
KP7-DN KP7-DW
QS HomeWorks QS
Button1 Button1
Button2 Button2
Button3 Button3
Button4 Button4
Button5 Button5
Button6 Button6
Button7 Button7
QS HomeWorks QS
Button1 Button1
Button2 Button2
Button3 Button3
Button4 Button4
Button5 Button5
Raise Button6
Lower Button7
Continuedonnextpage…
99
Lutron integration protocol
Devices (continued)
Architrave Keypad (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release,Double-tap,Hold,HoldRelease
Button2 2 Press,Release,Double-tap,Hold,HoldRelease
Button3 3 Press,Release,Double-tap,Hold,HoldRelease
Button4 4 Press,Release,Double-tap,Hold,HoldRelease
Button5 5 Press,Release,Double-tap,Hold,HoldRelease
Button6 6 Press,Release,Double-tap,Hold,HoldRelease
Button7 7 Press,Release,Double-tap,Hold,HoldRelease
Lower 18 Press,Release,Double-tap,Hold,HoldRelease
Raise 19 Press,Release,Double-tap,Hold,HoldRelease
CCI1 25 Press,Release
CCI2 26 Press,Release
LED11 81 SetorGetLEDstate
LED21 82 SetorGetLEDstate
LED31 83 SetorGetLEDstate
LED41 84 SetorGetLEDstate
LED51 85 SetorGetLEDstate
LED61 86 SetorGetLEDstate
LED71 87 SetorGetLEDstate
NOTE1 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomPlussystems
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
100
Lutron integration protocol
Devices (continued)
Architrave Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)PressorCCIClose 3 None
Set(#)ReleaseorCCIOpen 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1 9 0=Off1=On2=Normal-Flash:1flasheverysecond23=Rapid-Flash:10flasheseverysecond2
Set(#)HoldRelease2 32 None
NOTES1 Quantum,HomeWorksormyRoomplusonly “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘Definedby
Integration ’2 AvailableonlyonunitsinaQuantumorHomeWorkssystem
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
Continuedonnextpage…
101
Lutron integration protocol
Why Integrate with a Signature Series Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
Signature Series KeypadsQS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plus
QSModel HomeWorksQS/myRoom Model
Devices (continued)
Signature Series KeypadQS Models (QSWAS-):1B,1RLD,2B,2BRL,2RLD,3B,3BD,3BRL,5B,5BRL,7BHomeWorks QS / myRoom Models (HQWAS-B, HQWAS-G) with Faceplate / Button Kit Models (LFS-W):1B,1RLD,2BS,2RLD,3BS,3BD,3BSRL,4BS,4S,5B,5BRL,6B,6BRL,7B
1B
3B
5BT
1RLD
3BD
5BRL
2B
3BRL
6B
2BRL
3BSRL
6BRL
2BS
4BS
7B
2RLD
4S
3BS
5B
1234567
4
123
56
34
34
3
5
12
56
2
4
6
234
123
567
234
1
3
5
1
3
5
7
1234
6
23456
12345
12345
123456
123456
Configuration
Button1
Button2
Button3orRaise/Lower
Button4
Button5
Button6
Button7orRaise/Lower
Continuedonnextpage…
102
Lutron integration protocol
Devices (continued)
Signature Series Keypad (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release,Double-tap,Hold,HoldRelease
Button2 2 Press,Release,Double-tap,Hold,HoldRelease
Button3 3 Press,Release,Double-tap,Hold,HoldRelease
Button4 4 Press,Release,Double-tap,Hold,HoldRelease
Button5 5 Press,Release,Double-tap,Hold,HoldRelease
Button6 6 Press,Release,Double-tap,Hold,HoldRelease
Button7 7 Press,Release,Double-tap,Hold,HoldRelease
ButtonTopLower 16 Press,Release,Double-tap,Hold,HoldRelease
ButtonTopRaise 17 Press,Release,Double-tap,Hold,HoldRelease
ButtonBottomLower 18 Press,Release,Double-tap,Hold,HoldRelease
ButtonBottomRaise 19 Press,Release,Double-tap,Hold,HoldRelease
CCI1 25 Press,Release
CCI2 26 Press,Release
LED11 81 SetorGetLEDstate
LED21 82 SetorGetLEDstate
LED31 83 SetorGetLEDstate
LED41 84 SetorGetLEDstate
LED51 85 SetorGetLEDstate
LED61 86 SetorGetLEDstate
LED71 87 SetorGetLEDstate
NOTE1 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomsystems
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
103
Lutron integration protocol
Devices (continued)
Signature Series Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1 9 0=Off1=On2=Normal-Flash:1flasheverysecond3=Rapid-Flash:10flasheseverysecond
Set(#)HoldRelease2 32 None
NOTES1 Quantum,HomeWorksormyRoomplusonly “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘Definedby
Integration ’2 AvailableonlyonunitsinaQuantumorHomeWorkssystem
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
Continuedonnextpage…
104
Lutron integration protocol
Why Integrate with a seeTouch Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
seeTouch KeypadsQS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plus
QSModel RadioRA2Model HomeWorksQS/myRoomModel
ClearConnectDeviceModel
Devices (continued)
seeTouch KeypadQS Models (QSWS2-):1B,1RLD,2B,2BRL,2BRLIR,2RLD,3B,3BD,3BRL,3BRLIR,5B,5BRL,5BRLIR,7BRadioRA 2 Models (RRD-W):1RLD,2RLD,3BD,3BRL,3BSRL,4S,5BRL,5BRLIR,6BRL,7BHomeWorks QS / myRoom Models (HQRD-W, HQWD-W, HQWA-W, HQRA-W, HQWAS-W):1B,1RLD,2BS,2RLD,3BS,3BD,3BSRL,4BS,4S,5B,5BRL,5BIR,6B,6BRL,7BClear Connect Device Models (CCD-W): 6BRL
1B
3B
5B
1RLD
3BD
5BRL
2B
3BRL
5BRLIR
2BRL
3BRLIR
5BIR
2BRLIR
3BSRL
6B
2BS
4BS
6BRL
2RLD
4S
7B
button1
button2
button3
button4
button5
button6
button7
button4
button2
button3
button4
button1
button2
button3
button5
button6
button7
button2
button3
button4
button2
button3
button4
button1
button3
button5
button1
button3
button5
button7
button1
button2
button3
button4
button6
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button6
button1
button2
button3
button4
button5
button6
button1
button2
button3
button5
button6
button3
button4
button3
button4
button3
button4
button3
button5
button1
button2
button5
button6
Continuedonnextpage…
105
Lutron integration protocol
Devices (continued)
seeTouch Keypad (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release
Button2 2 Press,Release
Button3 3 Press,Release
Button4 4 Press,Release
Button5 5 Press,Release
Button6 6 Press,Release
Button7 7 Press,Release
ButtonTopLower 16 Press,Release
ButtonTopRaise 17 Press,Release
ButtonBottomLower 18 Press,Release
ButtonBottomRaise 19 Press,Release
CCI1 25 Press,Release
CCI2 26 Press,Release
LED11 81 SetorGetLEDstate
LED21 82 SetorGetLEDstate
LED31 83 SetorGetLEDstate
LED41 84 SetorGetLEDstate
LED51 85 SetorGetLEDstate
LED61 86 SetorGetLEDstate
LED71 87 SetorGetLEDstate
NOTE1 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomplussystem
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
106
Lutron integration protocol
Devices (continued)
seeTouch Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)PressorCCIClose 3 None
Set(#)ReleaseorCCIOpen 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1,2 9 0=Off1=On2=Normal-Flash:1flasheverysecond13=Rapid-Flash:10flasheseverysecond1
NOTES1 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomplussystem 2 Quantum,HomeWorks,ormyRoomonly “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic
‘DefinedbyIntegration ’
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
Continuedonnextpage…
107
Lutron integration protocol
Why Integrate with a seeTouch QS Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
seeTouch QS Keypads (Int’l)QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plus
QSModel HomeWorksQS/myRoomModel
Devices (continued)
seeTouch QS Keypad (International)QS Models (QSWE-):2B,3B,4B,5BRL,5BRLIR,6BRL,7BRL,8BRL,8BRLIR,10BRLHomeWorks QS / myRoom Models (HWQIS-NB-NONE) with Faceplate / Button Kit Models (LFS-W):2B,3B,4B,5BRL,5BRLIR,6BRL,7BRL,8BRL,8BRLIR,10BRL
2B
5BRLIR
8BRLIR
3B
6BRL
10BRL
4B
7BRL
5BRL
8BRL
button 6button 7button 8button 9button 10
button 1button 2button 3button 4button 5
Lower Raise
button 6button 7button 8button 9button 10
button 1
button 3
button 5
Lower Raise
button 6button 7button 8button 9button 10
Lower Raise
button 6
button 8
button 10
button 1
button 3
button 5
Lower Raise
button 6button 7button 8button 9button 10
button 2
button 4
Lower Raise
button 7
button 9
button 6
button 8
button 10
button 7
button 9
button 2
button 4
button 6button 7button 8button 9button 10
button 1
button 3
button 5
Lower Raise
button 6button 7button 8button 9button 10
Lower Raise
Continuedonnextpage…
108
Lutron integration protocol
Devices (continued)
seeTouch QS Keypad (International) (continued) DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release,Double-tap,Hold,HoldRelease
Button2 2 Press,Release,Double-tap,Hold,HoldRelease
Button3 3 Press,Release,Double-tap,Hold,HoldRelease
Button4 4 Press,Release,Double-tap,Hold,HoldRelease
Button5 5 Press,Release,Double-tap,Hold,HoldRelease
Button6 6 Press,Release,Double-tap,Hold,HoldRelease
Button7 7 Press,Release,Double-tap,Hold,HoldRelease
Button8 8 Press,Release,Double-tap,Hold,HoldRelease
Button9 9 Press,Release,Double-tap,Hold,HoldRelease
Button10 10 Press,Release,Double-tap,Hold,HoldRelease
Lower 18 Press,Release,Double-tap,Hold,HoldRelease
Raise 19 Press,Release,Double-tap,Hold,HoldRelease
CCI1 25 Press,Release
CCI2 26 Press,Release
LED11 81 SetorGetLEDstate
LED21 82 SetorGetLEDstate
LED31 83 SetorGetLEDstate
LED41 84 SetorGetLEDstate
LED51 85 SetorGetLEDstate
LED61 86 SetorGetLEDstate
LED71 87 SetorGetLEDstate
LED81 88 SetorGetLEDstate
LED91 89 SetorGetLEDstate
LED101 90 SetorGetLEDstate
NOTE1 NotsupportedinQSStandalone
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
109
Lutron integration protocol
Devices (continued)
seeTouch QS Keypad (International) (continued) DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)PressorCCIClose 3 None
Set(#)ReleaseorCCIOpen 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1 9 0=Off1=On2=Normal-Flash:1flasheverysec3=Rapid-Flash:10flasheseverysec
Set(#)HoldRelease2 32 None
NOTES1 “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘DefinedbyIntegration ’2 NotsupportedinQSStandalone
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
Continuedonnextpage…
110
Lutron integration protocol
Why Integrate with a Tabletop seeTouch Keypad?• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusTabletopseeTouchKeypad
Devices (continued)
Tabletop seeTouch KeypadRadioRA 2 Models (RR-):T5RL,T10RL,T15RLHomeWorks QS Models (HQR-, HQK-, HQQ-, HQM-, HQN-):T5RL,T10RL,T15RL,T5CRL,T10CRL,T15CRL
T5-RL T10-RL
T15-RL T15-CRL
button11
button12
button13
button14
button15
button11
button12
button13
button14
button15
button6
button7
button8
button9
button10
button6
button7
button8
button9
button10
button6
button7
button8
button9
button10
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
button1
button2
button3
button4
button5
Column3Lower Raise
Column3Lower Raise
Column3Lower Raise
Column3Lower Raise
Column2Lower Raise
Column1Lower Raise
button17
AllON
button17
AllON
button17
AllON
button16
AllOFF
button16
AllOFF
button16
AllOFF
Continuedonnextpage…
111
Lutron integration protocol
Devices (continued)
Tabletop seeTouch Keypad (continued) DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release
Button2 2 Press,Release
Button3 3 Press,Release
Button4 4 Press,Release
Button5 5 Press,Release
Button6 6 Press,Release
Button7 7 Press,Release
Button8 8 Press,Release
Button9 9 Press,Release
Button10 10 Press,Release
Button11 11 Press,Release
Button12 12 Press,Release
Button13 13 Press,Release
Button14 14 Press,Release
Button15 15 Press,Release
Button16 16 Press,Release
Button17 17 Press,Release
Column1:Lower 20 Press,Release
Column1:Raise 21 Press,Release
Column2:Lower 22 Press,Release
Column2:Raise 23 Press,Release
Column3:Lower 24 Press,Release
Column3:Raise 25 Press,Release
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,3,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
112
Lutron integration protocol
Devices (continued)
Tabletop seeTouch Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Component Numbers (continued):
Component Component Number Available Actions
LED1 81 SetorGetLEDstate
LED2 82 SetorGetLEDstate
LED3 83 SetorGetLEDstate
LED4 84 SetorGetLEDstate
LED5 85 SetorGetLEDstate
LED6 86 SetorGetLEDstate
LED7 87 SetorGetLEDstate
LED8 88 SetorGetLEDstate
LED9 89 SetorGetLEDstate
LED10 90 SetorGetLEDstate
LED11 91 SetorGetLEDstate
LED12 92 SetorGetLEDstate
LED13 93 SetorGetLEDstate
LED14 94 SetorGetLEDstate
LED15 95 SetorGetLEDstate
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)orGet(?)LEDStateSet is for unprogrammed LEDs only
9 0=Off1=On
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID3
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,3,1,3<CR><LF>
TurnOnLED1 #DEVICE,3,81,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,3,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,3,81,9,1<CR><LF>
Continuedonnextpage…
113
Lutron integration protocol
Why Integrate with a Pico Wireless Control?• Simulateabuttonpress• Monitorbuttonpresses
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusQSModel 1 2 RadioRA2Model PicoPJ-Model 1 2,3 PicoPJ2-Model 1 2,3
NOTES
1 InQSStandalonesystems,thePicoisintegratedthroughitsassociatedQSM RefertotheQS Sensor Module (QSM)section
2 CanbeusedonlywhenassociatedtoaQSM 3 PJ2-4BissupportedonlyonQSMsoftwareversion7 28andhigher
Devices (continued)
Pico Wireless ControlCURRENT Models: PJ-2B,PJ-2BRL,PJ-3B,PJ-3BRL,PJ2-2B,PJ2-2BRL,PJ2-3B,PJ2-3BRL,PJ2-4BLEGACY Models:
QS Models (QSR4P-, QSR8P-, QSRKP-, QSRMP-):2,2R,3RRadioRA 2 Models (RRD- P):3BRL-L,3BRL-S
2B 2BRL 3B 3BRL 4B
Button1
Button1
Button2
Button3
Button1 Button1 Button1
Button2
Button3
Button4
ButtonRaise
ButtonRaise
Button2
ButtonLower Button
Lower
Button3 Button3
Button3
Continuedonnextpage…
114
Lutron integration protocol
Devices (continued)
Pico Wireless Control (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
For all Legacy models and all Current models except for PJ2-4B
Button1 2 Press,Release
Button2 3 Press,Release
Button3 4 Press,Release
ButtonRaise 5 Press,Release
ButtonLower 6 Press,Release
For PJ2-4B model only
Button1 8 Press,Release
Button2 9 Press,Release
Button3 10 Press,Release
Button4 11 Press,Release
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Example DEVICE CommandsExamplespresumePicocontrolhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1(onanon-4Bmodel) #DEVICE,2,2,3<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
Button1waspressed ~DEVICE,2,2,3<CR><LF>
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
115
Lutron integration protocol
Devices (continued)
Hybrid KeypadRadioRA 2 Models (RRD-H):1RLD,2RLD,3BSRL,4S,5BRL,6BRLHomeWorks QS Models (HQRD-H): 1RLD,2RLD,3BSRL,4S,5BRL,6BRL
Why Integrate with a Hybrid Keypad?• TurnOntospecificlightlevelorOff• Raise/Lowerlightlevel• Querycurrentlightlevel
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusHybridKeypad
H6BRL
Continuedonnextpage…
116
Lutron integration protocol
Devices (continued)
Hybrid Keypad (continued)DEVICECommands
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release
Button2 2 Press,Release
Button3 3 Press,Release
Button4 4 Press,Release
Button5 5 Press,Release
Button6 6 Press,Release
Button7 7 Press,Release
ButtonTopLower 16 Press,Release
ButtonTopRaise 17 Press,Release
ButtonBottomLower 18 Press,Release
ButtonBottomRaise 19 Press,Release
LED1 81 SetorGetLEDstate
LED2 82 SetorGetLEDstate
LED3 83 SetorGetLEDstate
LED4 84 SetorGetLEDstate
LED5 85 SetorGetLEDstate
LED6 86 SetorGetLEDstate
LED7 87 SetorGetLEDstate
DEVICE Command Formats
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
117
Lutron integration protocol
Devices (continued)
Hybrid Keypad (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)orGet(?)LEDState 9 0=Off1=On2=Normal-Flash:1flasheverysecond13=Rapid-Flash:10flasheseverysecond1
NOTE1 “Set”isforLEDsonunprogrammedbuttonsandbuttonswithLEDlogic‘DefinedbyIntegration ’
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
Continuedonnextpage…
118
Lutron integration protocol
Devices (continued)
Hybrid Keypad (continued)OUTPUTCommandsOUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 None
Set(#)StartLowering 3 None
Set(#)StopRaisingorLowering 4 None
Set(#)StartFlashing3,4,5 5 Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused 3 Thesystemwillnotreportalevelwhiletheoutputisflashing,itwillinsteadreportthatitisflashing 4 Defaultflasheverysecond,unlessfadetimeisspecified(flashperiodis2×fadetime) 5 Tostopadimmerfromflashing,sendittoavalidlevel
Example OUTPUT CommandsExamplespresumedimmerhasbeenassignedIntegrationID1
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>
StartRaisingdimmerlevel #OUTPUT,1,2<CR><LF>
StopRaising/Loweringdimmerlevel #OUTPUT,1,4<CR><LF>
StartFlashingadimmer #OUTPUT,1,5<CR><LF>
StartFlashingadimmeronceevery2seconds #OUTPUT,1,5,1<CR><LF>
Query: ?OUTPUT,IntegrationID,ActionNumber
Whatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>
Response 1, 2: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Outputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTES1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
2 Thesystemwillnotreportalevelwhiletheoutputisflashing,itwillinsteadreportthatitisflashing
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
119
Lutron integration protocol
Why Integrate with a Dynamic Keypad?• Recognizeabuttonpress/releaseinordertocontrolathirdpartydevicefromtheDynamicKeypad’s
userinterface• Simulateabuttonpress• ControlLEDsofunprogrammedbuttons
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusDynamicKeypad
Devices (continued)
Dynamic KeypadModel: HQ-J-DK420
HQ-J-DK420
Continuedonnextpage…
120
Lutron integration protocol
Devices (continued)
Dynamic Keypad (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1(lefthardbutton) 1 Press,Release
Button2(middlehardbutton) 2 Press,Release
Button3(righthardbutton) 3 Press,Release
ButtonN1 N Press,Release
LEDM1 M SetorGetLEDstate
NOTE1 ComponentNumbersforthevariouspagesofbuttonsandLEDsforaDynamicKeypadaregeneratedbythe
HomeWorksQSormyRoomSoftware
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)Hold 5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState 9 0=Off1=On2=Normal-Flash3=Rapid-Flash
Example DEVICE CommandsExamplespresumetheDynamicKeypadhasbeenassignedIntegrationID23
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton118 #DEVICE,23,118,3<CR><LF>
TurnOnLED566 #DEVICE,23,566,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED566? ?DEVICE,23,566,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,23,566,9,1<CR><LF>
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
121
Lutron integration protocol
Why Integrate with a Wallbox Input Closure Interface?• Simulateabuttonpress
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusWallboxInputClosureInterface
Devices (continued)
Wallbox Input Closure InterfaceModel: QSE-CI-WCI
ON
1 2
1 2 3 4 5 6 7 8
1 2 3 4 5 6 7 8
COM
QSE-CI-WCI
INPUTSENTRADAENTRÉES
Continuedonnextpage…
122
Lutron integration protocol
Devices (continued)
Wallbox Input Closure Interface (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Button1 1 Press,Release,Double-tap,Hold,HoldRelease
Button2 2 Press,Release,Double-tap,Hold,HoldRelease
Button3 3 Press,Release,Double-tap,Hold,HoldRelease
Button4 4 Press,Release,Double-tap,Hold,HoldRelease
Button5 5 Press,Release,Double-tap,Hold,HoldRelease
Button6 6 Press,Release,Double-tap,Hold,HoldRelease
Button7 7 Press,Release,Double-tap,Hold,HoldRelease
Button8 8 Press,Release,Double-tap,Hold,HoldRelease
LED11 81 SetorGetLEDstate
LED21 82 SetorGetLEDstate
LED31 83 SetorGetLEDstate
LED41 84 SetorGetLEDstate
LED51 85 SetorGetLEDstate
LED61 86 SetorGetLEDstate
LED71 87 SetorGetLEDstate
LED81 88 SetorGetLEDstate
NOTE1 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomplussystem
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,2,ComponentNumber,ActionNumber,Parameters
ON
1 2
1 2 3 4 5 6 7 8
1 2 3 4 5 6 7 8
COM
QSE-CI-WCI
INPUTSENTRADAENTRÉES
Continuedonnextpage…
123
Lutron integration protocol
Devices (continued)
Wallbox Input Closure Interface (continued)DEVICECommands(continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)Hold(onlyifinputmodeisMomentary)
5 None
Set(#)Double-tap 6 None
Set(#)orGet(?)LEDState1 9 0=Off1=On2=Normal-Flash:1flasheverysecond23=Rapid-Flash:10flasheseverysecond2
Set(#)HoldRelease2 32 None
NOTES
1 Quantum,HomeWorks,ormyRoomplusonly “Set”isforunprogrammedbuttonsandbuttonswithLEDlogic‘DefinedbyIntegration ’
2 AvailableonlyonunitsinaQuantum,HomeWorks,ormyRoomplussystem
Example DEVICE CommandsExamplespresumekeypadhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3<CR><LF>
TurnOnLED5 #DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,2,81,9,1<CR><LF>
ON
1 2
1 2 3 4 5 6 7 8
1 2 3 4 5 6 7 8
COM
QSE-CI-WCI
INPUTSENTRADAENTRÉES
124
Lutron integration protocol
Devices (continued)
Sivoia QS Shade / Sivoia QS Wireless Shade
Why Integrate with a Sivoia QS Shade?• Setshadestoaspecificlevel• Querycurrentlevel
Integration Capabilities• Onecontrollableoutput(useOUTPUTcommand)
Supported Command Types• OUTPUTallowscontrolandmonitoringoftheshadeoutput• SHADEGRPallowscontrolofshadegroupsinaQuantumorHomeWorksQSsystem Shade
Groupsarecollectionsofshadesthatoperateinunison
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusSivoiaQSShade SivoiaQSWirelessShade
Includes all roller, cellular, and drapery styles
Continuedonnextpage…
125
Lutron integration protocol
Devices (continued)
Sivoia QS Shade / Sivoia QS Wireless Shade (continued)OUTPUTCommands
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level1=0–100or0 00–100 002Fade3in:SS ss4,SS,MM:SS,orHH:MM:SSDelay5in:SS ss4,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 None
Set(#)StartLowering 3 None
Set(#)StopRaisingorLowering
4 None
NOTES1 Forshades,alevelof0(or0 00)equalsclosed,andalevelof100(or100 00)equalsfullopen 2 0%=Closed;100%=Open3 Fadeisnotavailableforshadessincetheymoveataconstantrate Theparametermustbeenteredbutisignored 4 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecified
as1 45secondsavalueof1 25secondswillbeused 5 TheDelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay Theminimumdelaytimeis
0 25 seconds Themaximumdelaytimeis4hours Not supported in QS Standalone.
Example OUTPUT MessagesExamplespresumeshadehasbeenassignedIntegrationID1
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setshadeto75%witha1min30secdelay #OUTPUT,1,1,75,0,1:30<CR><LF>
StartRaisingshadelevel #OUTPUT,1,2<CR><LF>
StopRaising/Loweringshadelevel #OUTPUT,1,4<CR><LF>
Query: ?OUTPUT,IntegrationID,ActionNumber
Whatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>
Response 1: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Outputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofashade Theactuallevelisnottransmittedwhiletheyaremoving
Example:IftheLivingRoomBlackouts(IntegrationID1)areat20%andarecommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
Continuedonnextpage…
126
Lutron integration protocol
SHADEGRP Command Formats
SHADEGRP Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ShadeGroupLevel1
1 Level2=0–100or0 00–100 00Delay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising4 2 None
Set(#)StartLowering4 3 None
Set(#)StopRaisingorLowering
4 None
Set(#)orGet(?)CurrentPreset
6 PresetNumber5=0–30
Set(#)TiltLevel 14 Level6=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)LiftandTiltLevels 15 Lift6=0–100or0 00–100 00Tilt6=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay2in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt4 16 None
Set(#)StartLoweringTilt4 17 None
Set(#)StopRaisingorLoweringTilt4
18 None
Set(#)StartRaisingLift4 19 None
Set(#)StartLoweringLift4 20 None
Set(#)StopRaisingorLoweringLift4
21 None
NOTES1 Get(?)ShadeGroupLevel(actionnumber1) 2 TheFadeandDelaytimeareoptional Forshades,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)
butitisrequiredwhenspecifyinganoptionaldelay Whennotused,thesystemwilluseazero-seconddelay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours
3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecifiedas1 45seconds,avalueof1 25secondswillbeused
4 WhenaRaise/Lowercommandisissued,theshadegroup’slevelwillcontinuetogotowardsopen/closeuntilaStopcommandisreceived
5 Preset0istheOpenPresetandPreset30istheClosedPreset 6 TheLevelisacceptedasapercentage,where100%isfullyopenand0%isfullyclosed
Use “SHADEGRP Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#SHADEGRP,2,ActionNumber,Parameters
Devices (continued)
Sivoia QS Shade / Sivoia QS Wireless Shade (continued)OUTPUTCommands(continued)
127
Lutron integration protocol
Devices (continued)
Sivoia QS Venetian Blind / Sivoia QS Wireless Venetian Blind
Why Integrate with a Sivoia QS Venetian Blind?• SetVenetianblindtilt,lifttospecificlevels• Querycurrenttilt,liftlevels
Integration Capabilities• Onecontrollableoutput(useOUTPUTcommand)
Supported Command Types• OUTPUTallowscontrolandmonitoringoftheVenetianblindoutput• SHADEGRPallowscontrolofshadegroupsinaHomeWorksQSsystem
ShadeGroupsarecollectionsofshadesthatoperateinunison
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusSivoiaQSVenetianBlind SivoiaQSWirelessVenetianBlind
Continuedonnextpage…
128
Lutron integration protocol
Devices (continued)
Sivoia QS Venetian Blind / Sivoia QS Wireless Venetian Blind (continued)OUTPUTCommandsOUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)LiftLevel 1 LiftLevel1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay4in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)orGet(?)TiltLevel 9 TiltLevel1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay4in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)orGet(?)LiftandTiltLevels 10 LiftLevel1=0–100or0 00–100 00TiltLevel1=0–100or0 00–100 00Fade2in:SS ss3,SS,MM:SS,orHH:MM:SSDelay4in:SS ss3,SS,MM:SS,orHH:MM:SS
Set(#)StartRaisingTilt 11 None
Set(#)StartLoweringTilt 12 None
Set(#)StopRaisingorLoweringTilt 13 None
Set(#)StartRaisingLift 14 None
Set(#)StartLoweringLift 15 None
Set(#)StopRaisingorLoweringLift 16 None
NOTES1
2 Fadeisnotavailableforblindssincetheymoveataconstantrate Theparametermustbeenteredbutisignored 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifadelaytimeisspecified
as1 45seconds,avalueof1 25secondswillbeused 4 TheDelaytimeisoptional Whennotused,thesystemwilluseazero-seconddelay Theminimumdelaytimeis
0 25 seconds Themaximumdelaytimeis4hours Not supported in QS Standalone.
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
100% 75% 50% 25% 0%
Lift
Tilt
Continuedonnextpage…
129
Lutron integration protocol
Devices (continued)
Sivoia QS Venetian Blind / Sivoia QS Wireless Venetian Blind (continued)OUTPUTCommands (continued)
Example OUTPUT MessagesExamplespresumeshadehasbeenassignedIntegrationID1
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
SetVenetianblindtolift0%,tilt50% #OUTPUT,1,10,0,50<CR><LF>
StartraisingVenetiantilt #OUTPUT,1,11<CR><LF>
StopraisingVenetiantilt #OUTPUT,1,13<CR><LF>
Query: ?OUTPUT,IntegrationID,ActionNumber
WhatisthestateoftheVenetianliftandtilt? ?OUTPUT,1,10<CR><LF>
Response 1: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Venetianliftlevelis0%,tiltlevel50% ~OUTPUT,1,10,0.00,50.00<CR><LF>
NOTE1 ThesystemwillreportthetargetliftlevelandtargettiltlevelofaVenetianblind Theactuallevelsarenottransmitted
whileitismoving Example:IftheKitchenVenetian(IntegrationID1)issetat25%liftand75%tilt,andiscommandedtogoto100%liftand50%tiltbysending#OUTPUT,1,10,100,50,theresponsefromthesystemwillbe~OUTPUT,1,10,100.00,50.00
130
Lutron integration protocol
Devices (continued)
Maestro Dimmer and Plug-In ModuleRadioRA 2 Models (RRD-):6D,6NA,8ANS,8S-DV,10D,10ND,F6AN-DV,3LDRadioRA 2 Models (RR-): 3PD,15APSHomeWorks QS / myRoom plus Models (HQRD-, HQRA):6D,6ND,10D,10ND,6NA,F6AN-DV,8ANS,8S-DVHomeWorks QS / myRoom plus Models (HWD-, HWA-):6D,6ND,10D,10ND,5NE1,8ANSHomeWorks QS / myRoom plus Models (HQR-):3PD-1,15APS-1,3LDClear Connect Device Models (CCD-W):6D,6NA,F6AN-DV,15APS-1
Why Integrate with a Maestro Dimmer or Plug-In Module?• TurnOntospecificlightlevelorOff• Raise/Lowerlightlevel• Querycurrentlightlevel
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusRadioRA2Model HomeWorksQS/myRoomplusModels
ClearConnectDeviceModel
6D 3PD
LUTRON
NOTE1 5NEisnotavailableinarchitecturalstyle
Continuedonnextpage…
131
Lutron integration protocol
LUTRONDevices (continued)
Maestro Dimmer and Plug-In Module (continued)DEVICECommands
DEVICE Command Format
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
MaestroTapSwitch 6 Press,Release,DoubleTap,Hold
Action NumbersandParameters:
Action Action Number Parameters
Set(#)Press 3 None
Set(#)Release 4 None
Set(#)Hold 5 None
Set(#)DoubleTap 6 None
Example OUTPUT CommandsExamplespresumedimmerhasbeenassignedIntegrationID2
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressButton1 #DEVICE,2,1,3,<CR><LF>
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE1,2,ComponentNumber,ActionNumber,Parameters
NOTE1 SupportedonlyinHomeWorksQS4 0orhigher
Continuedonnextpage…
132
Lutron integration protocol
Devices (continued)
Maestro Dimmer and Plug-In Module (continued)OUTPUTCommandsOUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Level=0–100or0 00–100 00Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
Set(#)StartRaising 2 None
Set(#)StartLowering 3 None
Set(#)StopRaisingorLowering
4 None
Set(#)StartFlashing3,4,5 5 Fade1in:SS ss2,SS,MM:SS,orHH:MM:SSDelay1in:SS ss2,SS,MM:SS,orHH:MM:SS
NOTES1 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-seconddelay 2 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 31secondsavalueof1 25secondswillbeused 3 Thesystemwillnotreportalevelwhiletheoutputisflashing,itwillinsteadreportthatitisflashing 4 Defaultflasheverysecond,unlessfadetimeisspecified(flashperiodis2×fadetime) 5 Tostopadimmerfromflashing,sendittoavalidlevel
Example OUTPUT CommandsExamplespresumedimmerhasbeenassignedIntegrationID1
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setdimmerto75%witha1min30secfade #OUTPUT,1,1,75,01:30<CR><LF>
StartRaisingdimmerlevel #OUTPUT,1,2<CR><LF>
StopRaising/Loweringdimmerlevel #OUTPUT,1,4<CR><LF>
Query: ?OUTPUT,IntegrationID,ActionNumber
Whatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>
Response 1: ~OUTPUT,IntegrationID,ActionNumber,Parameters
Outputlevelissetto90% ~OUTPUT,1,1,90.00<CR><LF>
NOTE1 Thesystemwillreportthetargetlevelofadimmerwhileitisfadingfromoneleveltoanother
Theactuallevelisnottransmittedwhiledimmingbetweenlevels Example:Ifthe“OverSink”(1)dimmerisat20%andisthencommandedtogoto100%bysending#OUTPUT,1,1,100,theresponsefromthesystemwillbe~OUTPUT,1,1,100.00
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
LUTRON
133
Lutron integration protocol
Devices (continued)
Maestro Fan Speed Control
RadioRA 2 Models (RRD-):2ANFHomeWorks QS / myRoom Models (HQRD-, HQRA-, HWD-, HWA-):2ANF
Why Integrate with a Maestro Fan Speed Control?• TurnOntospecificspeed(High,Medium-High,Medium,Low,orOff)• Raise/Lowerfanspeed• Querycurrentspeed
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusRadioRA2FanSpeedControl HomeWorksQS/myRoomFanSpeedControl
2ANF
LUTRONLUTRON
Continuedonnextpage…
134
Lutron integration protocol
Devices (continued)
Maestro Fan Speed Control (continued)OUTPUTCommands
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)ZoneLevel 1 Levels:0=Off1–25%=Low26–50%=Medium56–75%=MediumHigh76–100%=High
Example OUTPUT CommandsExamplespresumedimmerhasbeenassignedIntegrationID1
Operation Command String
Execute: #OUTPUT,IntegrationID,ActionNumber,Parameters
SetfanspeedtoMediumHigh #OUTPUT,1,1,75<CR><LF>
Query: ?OUTPUT,IntegrationID,ActionNumber
Whatisthestateoftheoutput? ?OUTPUT,1,1<CR><LF>
Response: ~OUTPUT,IntegrationID,ActionNumber,Parameters
OutputlevelissettoHigh ~OUTPUT,1,1,100.00<CR><LF>
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT1,1,ActionNumber,Parameters
NOTE1 SupportedonlyinHomeWorksQS4 0orhigherandRadioRA26 0orhigher
LUTRONLUTRON
135
Lutron integration protocol
Devices (continued)
Visor Control Receiver
RadioRA 2 Model:RR-VCRXHomeWorks QS / myRoom Model:HQR-VCRX
Why Integrate with a Visor Control Receiver?• Simulateakeypadpressorcontactclosureinputs• ControlLEDsofunprogrammedbuttons• Controlcontactclosureoutputs
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusVisorControlReceiver
RR-VCRX
Visor Control Receiver
Learn
Visor Transmitter
KeypadOutputs
Flash
Full
Security InputInputs
1 2
Power9V
Inputs
CFull
1 C 2 C
Outputs
3 C 4 CFlash
Continuedonnextpage…
136
Lutron integration protocol
Devices (continued)
Visor Control Receiver (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
Scene1 1 Press,Release
Scene2 2 Press,Release
Scene3 3 Press,Release
Scene4 4 Press,Release
Scene5 5 Press,Release
Scene6 6 Press,Release
Full/Security 30 OpenInput,CloseInput
SecurityFlash 31 OpenInput,CloseInput
Input1 32 OpenInput,CloseInput
Input2 33 OpenInput,CloseInput
LEDScene1 81 SetorGetLEDstate
LEDScene2 82 SetorGetLEDstate
LEDScene3 83 SetorGetLEDstate
LEDScene4 84 SetorGetLEDstate
LEDScene5 85 SetorGetLEDstate
LEDScene6 86 SetorGetLEDstate
Action Numbers and Parameters:
Action Action Number Parameters
Set(#)PressorInputClose 3 None
Set(#)ReleaseorInputOpen 4 None
Set(#)orGet(?)LEDState1 9 0=Off;1=On
NOTES1 ValidforSceneLEDsonly
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
Visor Control Receiver
Learn
Visor Transmitter
KeypadOutputs
Flash
Full
Security InputInputs
1 2
Power9V
Inputs
CFull
1 C 2 C
Outputs
3 C 4 CFlash
Continuedonnextpage…
137
Lutron integration protocol
Example DEVICE CommandsExamplespresumeVisorControlReceiverhasbeenassignedIntegrationID5
Operation Command String
Execute: #DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
PressScene1 #DEVICE,5,1,3<CR><LF>
TurnOnScene1LED #DEVICE,5,9,81,1<CR><LF>
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatisthestateofLED1? ?DEVICE,5,9,81<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
LED1isOn ~DEVICE,5,9,81,1<CR><LF>
Devices (continued)
Visor Control Receiver (continued)DEVICECommands(continued)
Visor Control Receiver
Learn
Visor Transmitter
KeypadOutputs
Flash
Full
Security InputInputs
1 2
Power9V
Inputs
CFull
1 C 2 C
Outputs
3 C 4 CFlash
Continuedonnextpage…
138
Lutron integration protocol
Devices (continued)
Visor Control Receiver (continued)OUTPUTCommands
OUTPUT Command Format
OUTPUT Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)OutputState 1 Level1=0–100or0 00–100 00
Set(#)CCOPulseTime 6 Pulse2timein:SS ss3,SS,MM:SS,orHH:MM:SS,orDelay4in:SS ss3,SS,MM:SS,orHH:MM:SS
NOTES1 Anylevelgreaterthan0willclosetheoutput Whenlevelisequalto0theoutputwillopen 2 Thedefaulttimeisonesecond 3 Fractionalseconds“SS ss”willberoundeddowntothenearestquartersecond Forexample,ifafadetimeisspecified
as1 45secondsavalueof1 25secondswillbeused 4 TheFadeandDelaytimeareoptional Whennotused,thesystemwilluseaone-secondfadetimewithzero-second
delay Theminimumfadeanddelaytimeis0seconds Themaximumfadeanddelaytimeis4hours Forshadeoutputs,theFadeparameterhasnoeffect(sinceshadeshavefixedspeeds)butitisrequiredwhenspecifyinganoptionaldelay
Example OUTPUT MessagesExamplespresumeCCOhasbeenassignedIntegrationID21
Operation Command String
Set: #OUTPUT,IntegrationID,ActionNumber,Parameters
Setoutputtoopen #OUTPUT,21,1,0<CR><LF>
Setoutputtoclose #OUTPUT,21,1,1<CR><LF>
Query 1: ?OUTPUT,IntegrationID,ActionNumber
Whatisthestateoftheoutput? ?OUTPUT,21,1<CR><LF>
Response 2: ~OUTPUT,IntegrationID,ActionNumber
Outputstateisclosed ~OUTPUT,21,1,100.00<CR><LF>
NOTES1 Momentaryoutputsshouldnotbequeried 2 Thesystemwillreportthetargetlevelofoutputs Anylevelgreaterthan0meansthattheoutputisclosed
Use “OUTPUT Command-specific fields” tables to complete the parameter field.
Action number is always 1 for visor control outputs
Operation
Command
Integration ID (example)
#OUTPUT,21,ActionNumber,Parameters
Visor Control Receiver
Learn
Visor Transmitter
KeypadOutputs
Flash
Full
Security InputInputs
1 2
Power9V
Inputs
CFull
1 C 2 C
Outputs
3 C 4 CFlash
139
Lutron integration protocol
Why Integrate with a Radio Powr Savr Sensor?• Monitoroccupied,unoccupiedstatusofasinglesensor
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusRadioPowrSavrSensor
Devices (continued)
Radio Powr Savr Sensor
CURRENT Models (LRF2-, CCD-): OCR2B,VCR2B,OKLB,OHLB,OWLB,VKLB,VHLB,VWLBLEGACY Models (LRF2-):OCRB,VCRB
LRF2-OCR2B LRF2-OKLB
Continuedonnextpage…
140
Lutron integration protocol
Devices (continued)
Radio Powr Savr Sensor (continued)DEVICECommandsDEVICE Command Formats
~DEVICE,19,2,ActionNumberOccupied state component is always 2 for sensors
Operation
Command
Integration ID (example)
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
OccupiedState 2 Occupied,Unoccupied
Action Numbers:
Action Action Number
Report(~)Occupied 3
Report(~)Unoccupied 4
Example DEVICE CommandsExamplespresumesensorhasbeenassignedIntegrationID19
Operation Command String
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
RadioPowrSavr19wentoccupied ~DEVICE,19,2,3<CR><LF>
RadioPowrSavr19wentunoccupied ~DEVICE,19,2,4<CR><LF>
141
Lutron integration protocol
Why Integrate with an HVAC Controller?• Getcurrenttemperature• Setorgetheatsetpointsandcoolsetpoints• Setorgetoperatingmode,fanmodeandEcoMode1
• Getconnectionstatustothetemperaturesensor• Getscheduleinformationandholdschedules
Supported Command Types• HVACallowscontrolandmonitoringoftheHVACcontroller• DEVICEallowsmonitoringoftemperaturesensors
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusLR-HVAC-1-WH;LR-HWLV-HVAC LR-HVAC-230-S HQWT-T-HW
Devices (continued)
Temperature ControlsRadioRA 2 Models:LR-HVAC-1-WH,LR-HWLV-HVACHomeWorks QS Models:LR-HVAC-1-WH,LR-HWLV-HVAC,LR-HVAC-230-S,HQWT-T-HWmyRoom Model:LR-HVAC-230-S
LR-HVAC-1-WH
LR-HVAC-230-S
LR-HWLV-HVAC
1HQWT-T-HWdoesnotsupportEcoMode
HQWT-T-HW
142
Lutron integration protocol
HVAC Command-specific fields Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)CurrentTemperature(°F)1,2 1 Temperature=32–212°F
Set(#)orGet(?)HeatandCoolSetpoints(°F)1,3,4,5 2 SetpointHeat(SPH)=32–212°F
SetpointCool(SPC)=32–212°F
Set(#)orGet(?)OperatingMode6 3Mode(1=Off/Protect,2=Heat,3=Cool,4=Auto,5=Em Heat/AuxiliaryOnly,67=Lockedout,7=Fan,8=Dry)
Set(#)orGet(?)FanMode6 4 Mode(1=Auto,2=On,3=Cycler,4=NoFan,5=High,6=Medium,7=Low,8=Top)
Set(#)orGet(?)Eco(Setback)Mode8 5 Mode(1=Off,2=On)Get(?)EcoOffset8 6 EcoOffset=1–11°F
Set(#)orGet(?)ScheduleStatus9 7
0=ScheduleUnavailable,Get(?)only1=FollowingSchedule,Set(#)orGet(?)2=PermanentHold,Set(#)orGet(?)3=TemporaryHold6,Get(?)only
Get(?)TemperatureSensorConnectionStatus6 8
1=AllSensorsareActive2=MissingSensor3=WiredSensorOnly4=NoSensor
Get(?)ScheduleEvent 9 Schedule#(1–7),Event#(1–4),HH,MM,SPH,SPC
Get(?)ScheduleDayAssignment 10 Schedule#(1–7),DD(Bitmap:Sunday(Bit0)–Saturday(Bit6)1–activeday,0– inactiveday)
Get(?)SystemMode 111=Normal2=Away3=Green
Get(?)HeatandCoolSetpoints(°F)withoutEcoOffsetifapplied1,8 12 SetpointHeat(SPH)=32–212°F
SetpointCool(SPC)=32–212°F
Get(?)EmergencyHeatAvailable 13 1=NotAvailable2=Available
NOTES1 Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
2 SettingofcurrenttemperatureisonlypossibleiftheHVACzoneisconnectedtoa3rdpartyHVACcontroller 3 ChangingthesetpointwillturnEcoModeoffifitiscurrentlyon 4 Toleaveaparameterunchanged,use“255”asthevalueforthatparameterwhensendingthecommand 5 FortheHQWT-T-HW,thisrangedependsontheprogramminginthedatabase Thesetpointrangeis40-113°F(5-45°C) 6 HQWT-T-HWdoesnotsupportthisintegrationfeature
FollowingSchedule–>Runningprogrammedschedule;setpointsfromschedule PermanentHold–>Scheduleisnotrunning;setpointsasadjusted TemporaryHold–>Runningschedule;setpointsasadjusted Returnstofollowingscheduleatnextscheduleevent
7 RCSHVACcontrollerlockedoutduetomissingwiredsensor Thisparametercanonlyberead 8 ScheduleUnavailable–>Schedulenotprogrammedordeviceneedsdate/time 9 HQWT-T-HWdoesnotsupportEcoMode Note:IfthethermostatissetuptouseFahrenheit,itisrecommendedtouseFahrenheitIntegrationcommandset Ifitis
setuptouseCelsius,itisrecommendedtousetheCelsiusIntegrationcommandset
Devices (continued)
Temperature Controls (continued)HVACCommandsHVAC Command Format
Use “HVAC Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#HVAC,21,ActionNumber,Parameters
Continuedonnextpage…
143
Lutron integration protocol
HVAC Command-specific fields (continued)
Action NumbersandParameters (continued):
Action Action Number Parameters
Set(#)orGet(?)CallStatus 14
0=None,LastwasHeat1=HeatStage12=HeatStage1and23=HeatStage1,2,and34=HeatStage35=None,LastwasCool6=CoolStage17=CoolStage1and28=Off9=EmergencyHeat/AuxiliaryOnly10=Dry
Set(#)orGet(?)CurrentTemperature(°C)1,2,3 15 Temperature=0–100°C
Set(#)orGet(?)HeatandCoolSetpoints(°C)2,4,5,6 16 SetpointHeat(SPH)=0–100°C
SetpointCool(SPC)=0–100°CGet(?)HeatandCoolSetpoints(°C)withoutEcoOffsetifapplied2,4,7 17 SetpointHeat(SPH)=0–100°C
SetpointCool(SPC)=0–100°C
NOTES1 HomeWorksQSsoftwareversion4 1andhigher 2 Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
3 SettingofcurrenttemperatureisonlypossibleiftheHVACzoneisconnectedtoa3rdpartyHVACcontroller 4 ChangingthesetpointwillturnEcoModeoffifitiscurrentlyon 5 Toleaveaparameterunchanged,use“255”asthevalueforthatparameterwhensendingthecommand 6 FortheHQWT-T-HW,thisrangedependsontheprogramminginthedatabase Theheat/coolsetpointsincreaseor
decreaseinincrementsof0 5°C 7 HQWT-T-HWdoesnotsupportEcoMode Note:IfthethermostatissetuptouseFahrenheit,itisrecommendedtouseFahrenheitIntegrationcommandset Ifitis
setuptouseCelsius,itisrecommendedtousetheCelsiusIntegrationcommandset
Devices (continued)
Temperature Controls (continued)HVACCommands(continued)
Continuedonnextpage…
144
Lutron integration protocol
Devices (continued)
Temperature Controls (continued)HVACCommands(continued)
Example HVAC Commands
Operation Command String
Execute: #HVAC,IntegrationID,ActionNumber,Parameters
Setheatsetpointto68°Fandcoolsetpointto72°F #HVAC,1,2,68,72<CR><LF>
Setsystemmodetocool #HVAC,1,3,3<CR><LF>
TurnEcomodeon #HVAC,1,5,2<CR><LF>
Setheatsetpointto18 5Candcoolsetpointto21 5C #HVAC,21,16,18.5,21.5<CR><LF>
Query: ?HVAC,IntegrationID,ActionNumber
Whatisthecurrenttemperature? ?HVAC,1,1<CR><LF>
WhatisarethesettingsforSchedule1,Event2? ?HVAC,1,9,1,2<CR><LF>
WhatdaysarerunningSchedule1? ?HVAC,1,10,1<CR><LF>
WhatarethecurrentheatandcoolsetpointsinCelsius? ?HVAC,21,16<CR><LF>
WhatarethecurrentheatandcoolsetpointsinFahrenheitiftheCelsiusvaluesare18 5°Cand21 5°Crespectively?
?HVAC,21,2<CR><LF>
WhatarethecurrentheatandcoolsetpointsinFahrenheitiftheCelsiusvaluesare10°Cand20°Crespectively?
?HVAC,21,2<CR><LF>
Response: ~HVAC,IntegrationID,ActionNumber,Parameters
CurrentTemperatureis70°F ~HVAC,1,1,70<CR><LF>
Schedule1,Event2startsat8:00amwithSPH=65,SPC=78 ~HVAC,1,9,1,2,08,00,65,78<CR><LF>
Schedule1isbeingrunonMondayandTuesday ~HVAC,1,10,1,06<CR><LF>
CurrentheatandcoolsetpointsinCelsiusare18 5°Cand21 5°Crespectively
~HVAC,21,16,18.5,21.5<CR><LF>
CurrentheatandcoolsetpointsinFahrenheitare65 3°Fand70 7°Frespectively
~HVAC,21,2,65.3,70.7<CR><LF>
CurrentheatandcoolsetpointsinFahrenheitare50°Fand68°Frespectively
~HVAC,21,2,50,68<CR><LF>
NOTES•IfthethermostatissetuptouseFahrenheit,itisrecommendedtouseFahrenheitIntegrationcommandset Ifitissetup
touseCelsius,itisrecommendedtousetheCelsiusIntegrationcommandset •Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
145
Lutron integration protocol
Why Integrate with a Palladiom Thermostat?• Getcurrenttemperature• Setorgetsinglesetpoint• Setorgetoperatingmodeandfanmode• Setorgetpositiveornegativedrifts
Supported Command Types• HVACallowscontrolandmonitoringofthePalladiomThermostatandHVACController
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusMWP-T-OWH
1 RequiresmyRoom10 0ornewer
Devices (continued)
Palladiom Thermostat 1myRoom Model: MWP-T-OHW
MWP-T-OHW
SMC5300020401SMC5500050407
FCABACPSS002
OR
HVACControllerRequired
HVAC Controller Communication Link
Continuedonnextpage…
146
Lutron integration protocol
HVAC Command-specific fields
Action NumbersandParameters:
Action Action Number Parameters
Set(#)orGet(?)CurrentTemperature(°F)2,3 1 Temperature=32–104°F
Set(#)orGet(?)OperatingMode 3 Mode(1=Off,4=Auto)
Set(#)orGet(?)FanMode 4 Mode(1=Auto,4=NoFan,5=High,6=Medium,7=Low)
Set(#)orGet(?)CallStatus 14
0=None,LastwasHeat1=HeatStage15=None,LastwasCool6=CoolStage18=Off
Set(#)orGet(?)CurrentTemperature(°C)3 15 Temperature=0–40°C
Set(#)orGet(?)SingleSetpoint(°F)andDrifts1,2 18 SingleSetpoint=
50–90°FNegativeDrift=0–15°F
PositiveDrift=0–15°F
Set(#)orGet(?)SingleSetpoint(°C)andDrifts1,2 19 SingleSetpoint=
10–32°CNegativeDrift=0–8°C
PositiveDrift=0–8°C
Example HVAC Commands
Operation Command String
Execute: #HVAC,IntegrationID,ActionNumber,Parameters
SetSingleSetpointto75°F,PositiveDriftto2°FandNegativeDriftto1°F #HVAC,21,18,75,1,2<CR><LF>
SetSystemOperatingModeto“Auto” #HVAC,21,3,4<CR><LF>
SetFanModeto“Medium” #HVAC,21,4,6<CR><LF>
SetSingleSetpointto20°CandleavetheDriftsunaffected #HVAC,21,19,20,255,255<CR><LF>
Query: ?HVAC,IntegrationID,ActionNumber
WhatistheCurrentTemperature? ?HVAC,21,1<CR><LF>
WhatistheCurrentOperatingMode? ?HVAC,21,3<CR><LF>
WhatistheCurrentHVACCallStatus? ?HVAC,21,14<CR><LF>
Response: ~HVAC,IntegrationID,ActionNumber,Parameters
CurrentTemperatureis70°F ~HVAC,21,1,70<CR><LF>
CurrentOperatingModeis“Off” ~HVAC,21,3,1<CR><LF>
1 Toleaveaparameterunchanged,use“255”asthevalueforthatparameterwhensendingthecommand 2 Allowforreportedtemperaturevaluestobezeropadded,withupto3digitsbeforethedecimalpoint,and2digitsafter
–Possiblereportedvaluesof5°C:“005”,“05”,“5”,“005 ”,“005 ”,“5 ”,“005 0”,“05 0”,“5 0”,“005 00”,“05 00”,“5 00”–Possiblereportedvaluesof5 5°C:“005 5”,“05 5”,“5 5”,“005 50”,“05 50”,“5 50”–Possiblereportedvaluesof21°C:“021”,“21”,“021 0”,“21 0,“021 00,”“21 00”–Possiblereportedvaluesof21 5°C:“021 5”,“21 5”,“021 50”,“21 50”
3 SettingofcurrenttemperatureisonlypossibleiftheHVACzoneisconnectedtoa3rdpartyHVACcontroller
Devices (continued)
Palladiom Thermostat (continued)HVACZoneCommandsHVAC Command Format
Use “HVAC Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#HVAC,21,ActionNumber,Parameters
147
Lutron integration protocol
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
InternalSensor 17 Gettemperature
RemoteSensor#1 18 Gettemperature
RemoteSensor#21 42 Gettemperature
Action NumbersandParameters:
Action Action Number Parameters
Get(?)SensorTemperature(°F)2,3 41 None
Get(?)SensorTemperature(°C)2,3 42 None
1 UsedonlywhenthePalladiomthermostatcontrolsseparateheatingandcoolingzones 2 Thisfunctionreports“UNKNOWN”ifthevalueisnotknown 3 Whenissuingthiscommand,usetheintegrationIDandcomponentnumberofthetemperaturesensor,nottheHVAC
zone
Devices (continued)
Palladiom Thermostat (continued)DEVICECommandsDEVICE Command Format
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,21,ComponentNumber,ActionNumber,Parameters
148
Lutron integration protocol
Why Integrate with a Wireless Temperature Sensor?• Getbatterystatus Note:Togetcurrenttemperature,seeHVAC Controllersection
Additional Commands• None
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusWirelessTemperatureSensor
Devices (continued)
Wireless Temperature Sensor
Model: LRF2-TWRB
TestLink
Continuedonnextpage…
149
Lutron integration protocol
Devices (continued)
Wireless Temperature Sensor (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:
Component Component Number Available Actions
InternalSensor 1 Getbatterystatus
Action Numbers and Parameters:
Action Action Number Parameters
Get(?)batterystatus 22 Parameternumberfilterscommandresponse:0=Donotfilterresults1=Get“good”devicesonly2=Get“bad”devicesonly3=Getbatterypowereddevicesonly4=Getallnon-batterypowereddevicesonly5=Getdeviceswithlowbatteryonly6=Getallnon-activateddevicesonly
Example DEVICE Messages
Operation Command String
Query: ?DEVICE,IntegrationID,ComponentNumber,ActionNumber
WhatistheTemperatureSensor’sBatteryStatus? ?DEVICE,1,1,22<CR><LF>
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumber,Parameters
TemperatureSensor’sBatteryisLow ~DEVICE,1,1,22,2<CR><LF>
TestLink
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
?DEVICE,1,ComponentNumber,ActionNumber,Parameters
150
Lutron integration protocol
Why Integrate with a QSE-IO?• KnowthestateoftheContactClosureInputs(CCIs) • ControlthestateoftheContactClosureOutputs(CCOs)
Integration Capabilities 5ContactClosureInputs(CCIs)and5ContactClosureOutputs TheQSE-IOmodeofoperationisspecified
byitsDIPswitchconfiguration • CCIandCCOstatescanbepolledinanyDIPconfiguration • CCIeventscanbemonitoredthroughintegrationinanyDIPconfiguration • CCIevents(closuresoropeningsofCCIs)canbe‘spoofed’(faked)throughintegrationinDIPconfigurations
wheremomentaryCCIsarespecified • CCOeventscanbemonitoredthroughintegrationinanyDIPconfiguration • TheCCOstatelogicistypicallytiedtothestatesoftheCCIsorotherdevicesontheQSlinkandthus,CCO
eventscannotbegeneratedthroughintegrationinmostDIPconfigurations;theexceptionsaretheoutputDIPconfigurations(e g ,ShadeOutput,ZoneControlOutput)andtheIntegrationDIPconfigurationthatallowsfullmonitoringofCCIsandcontrolofCCOsthroughintegration
• OccupancyeventscanbemonitoredthroughintegrationwhentheQSE-IOisinanOccupancyDIPconfiguration
Supported Command Types• DEVICEallowsmonitoringofCCIandCCOeventsandpollingofCCI/CCOstatesandincertainQSE-IODIP
configurations,allows‘spoofing’ofCCIeventsandgenerationofCCOevents • OUTPUT(incertainoutput-orientedQSE-IODIPconfigurations)allowscontrolandmonitoringoftheCCOs
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusQSE-IO
Devices (continued)
QSE-IO Control Interface
Model: QSE-IO
CC
I1C
CI 2
CC
I 3C
CI 4
CO
MC
CI 5
V0-24 V 1 A0-24 V ½ A
R
ON
CC
O 1 N
CC
CO
1 NO
CC
O 2 N
CC
CO
2 NO
1-2 CO
M
CC
O 3 N
C
CC
O 4 N
O
CC
O 3 N
O
CC
O 4 N
C3-4 C
OM
CC
O 5 N
C
5 CO
MC
CO
5 NO
V
R
MU
X
CO
MV+
MU
X
CC
O 1
CC
O 2
CC
O 3
CC
O 4
CC
O 5
STAT
QS
800.523.9466+1.610.282.3800 www.lutron.com/qs
QSE-IO24 V 100 mA
243C IND. CONT. EQ.
8 7 6 5 4 3 2 1
4 3 2 1
Continuedonnextpage…
151
Lutron integration protocol
Devices (continued)
QSE-IO Control Interface (continued)DEVICECommandsDEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:Component Component Number Available Actions
CCI1 1 Report(~)closure/opening1
Poll(?)status2Spoof(#)closure/opening3
CCI2 2 Report(~)closure/opening1
Poll(?)status2Spoof(#)closure/opening3
CCI3 3 Report(~)closure/opening1
Poll(?)status2Spoof(#)closure/opening3
CCI4 4 Report(~)closure/opening1
Poll(?)status2Spoof(#)closure/opening3
CCI5 5 Report(~)closure/opening1
Poll(?)status2Spoof(#)closure/opening3
CCO1 11 Report(~)closure/opening4Poll(?)status2Generate(#)closure/opening3
CCO2 12 Report(~)closure/opening4Poll(?)status2Generate(#)closure/opening3
CCO3 13 Report(~)closure/opening4Poll(?)status2Generate(#)closure/opening3
CCO4 14 Report(~)closure/opening4Poll(?)status2Generate(#)closure/opening3
CCO5 15 Report(~)closure/opening4Poll(?)status2Generate(#)closure/opening3
OccupancySensor1 41 Report(~)occupied/unoccupied3,5
OccupancySensor2 42 Report(~)occupied/unoccupied3,5
OccupancySensor3 43 Report(~)occupied/unoccupied3,5
OccupancySensor4 44 Report(~)occupied/unoccupied3,5
OccupancySensor5 45 Report(~)occupied/unoccupied3,5
NOTES1 Monitoringtype2mustbeenabled(seeQSE-CI-NWK-E#MONITORINGsection)2 NotavailableinQuantum3 FeaturesupportedinonlysomeQSE-IODIPconfigurations4 Monitoringtype5mustbeenabled(seeQSE-CI-NWK-E#MONITORINGsection)5 Monitoringtype6mustbeenabled(seeQSE-CI-NWK-E#MONITORINGsection)
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,5,ComponentNumber,ActionNumber,Parameters
CC
I1C
CI 2
CC
I 3C
CI 4
CO
MC
CI 5
V0-24 V 1 A0-24 V ½ A
R
ON
CC
O 1 N
CC
CO
1 NO
CC
O 2 N
CC
CO
2 NO
1-2 CO
M
CC
O 3 N
C
CC
O 4 N
O
CC
O 3 N
O
CC
O 4 N
C3-4 C
OM
CC
O 5 N
C
5 CO
MC
CO
5 NO
V
R
MU
X
CO
MV+
MU
X
CC
O 1
CC
O 2
CC
O 3
CC
O 4
CC
O 5
STAT
QS
800.523.9466+1.610.282.3800 www.lutron.com/qs
QSE-IO24 V 100 mA
®
243C IND. CONT. EQ.
8 7 6 5 4 3 2 1
4 3 2 1
Continuedonnextpage…
152
Lutron integration protocol
Devices (continued)
QSE-IO Control Interface (continued)DEVICECommands(continued)DEVICE Command-specific fields(continued)
Action NumbersandParameters:Action Action Number Parameters
Set(#)ClosureReport(~)ClosureorOccupied1
3 None
Set(#)OpeningReport(~)OpeningorUnoccupied1
4 None
Set(#)CCOState1,2 14 Level(0=Open,100=Close)Get(?)CCOState2 NoneReport(~)CCOState Level(0=Open,100=Close)Get(?)CCIState2,3 35 None
NOTES1 FeaturesupportedinonlysomeQSE-IODIPconfigurations SeeQSE-IOinstallationinstructionsatwww lutron com2 NotavailableinQuantum3 RequiresNWKfirmware8 47ornewerforQSStandalonesystems
CC
I1C
CI 2
CC
I 3C
CI 4
CO
MC
CI 5
V0-24 V 1 A0-24 V ½ A
R
ON
CC
O 1 N
CC
CO
1 NO
CC
O 2 N
CC
CO
2 NO
1-2 CO
M
CC
O 3 N
C
CC
O 4 N
O
CC
O 3 N
O
CC
O 4 N
C3-4 C
OM
CC
O 5 N
C
5 CO
MC
CO
5 NO
V
R
MU
X
CO
MV+
MU
X
CC
O 1
CC
O 2
CC
O 3
CC
O 4
CC
O 5
STAT
QS
800.523.9466+1.610.282.3800 www.lutron.com/qs
QSE-IO24 V 100 mA
®
243C IND. CONT. EQ.
8 7 6 5 4 3 2 1
4 3 2 1
Continuedonnextpage…
153
Lutron integration protocol
Devices (continued)
QSE-IO Control Interface (continued)OUTPUTCommands
OUTPUT Command Formats
OUTPUT Command-specific fields Action Numbers and Parameters:
Action Action Number Parameters
Set(#)CCOstate1,2 1 Level(0=Open,100=Close)Get(?)CCOstate NoneReport(~)CCOstate Level(0=Open,100=Close)
NOTES1 FeaturesupportedinonlysomeQSE-IODIPconfigurations SeeQSE-IOinstallationinstructionsatwww lutron com2 NotavailableinQuantum
Use “OUTPUT Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#OUTPUT,1,ActionNumber,Parameters
CC
I1C
CI 2
CC
I 3C
CI 4
CO
MC
CI 5
V0-24 V 1 A0-24 V ½ A
R
ON
CC
O 1 N
CC
CO
1 NO
CC
O 2 N
CC
CO
2 NO
1-2 CO
M
CC
O 3 N
C
CC
O 4 N
O
CC
O 3 N
O
CC
O 4 N
C3-4 C
OM
CC
O 5 N
C
5 CO
MC
CO
5 NO
V
R
MU
X
CO
MV+
MU
X
CC
O 1
CC
O 2
CC
O 3
CC
O 4
CC
O 5
STAT
QS
800.523.9466+1.610.282.3800 www.lutron.com/qs
QSE-IO24 V 100 mA
®
243C IND. CONT. EQ.
8 7 6 5 4 3 2 1
4 3 2 1
154
Lutron integration protocol
Devices (continued)
QS Sensor Module (QSM)
Models:QSMX-,QSM2-,QSM3-,QSM4-,QSM5-,QSM6-,QSM7-
Why Integrate with a QS Sensor Module?• Viewoccupancyeventsthatoccur
Integration Capabilities• Canviewoccupancyeventsforupto14sensors • CanviewPicobuttonPress/ReleaseEvents
Compatibility
QS Standalone Quantum RadioRA 2 HomeWorks QS myRoom plusQSSensorModule
Continuedonnextpage…
155
Lutron integration protocol
Devices (continued)
QS Sensor Module (QSM) (continued)DEVICECommands
DEVICE Command Formats
DEVICE Command-specific fields
Component Numbers:Component Component Number Available Actions
WiredOccupancysensors 1–4 Occupied,UnoccupiedWirelessOccupancysensors1–10 5–14 Occupied,UnoccupiedPico1Buttons1,2 61–65 Press,ReleasePico2Buttons1,2 82–86 Press,ReleasePico3Buttons1,2 103–107 Press,ReleasePico4Buttons1,2 124–128 Press,ReleasePico5Buttons1,2 145–149 Press,ReleasePico6Buttons1,2 166–170 Press,ReleasePico7Buttons1,2 187–191 Press,ReleasePico8Buttons1,2 208–212 Press,ReleasePico9Buttons1,2 229–233 Press,ReleasePico10Buttons1,2 250–254 Press,Release
NOTES1 AllmodelsexceptPJ2-4B:Picobuttonorder(Top,Favorite,Bottom,Raise,Lower)dictatesComponentNumber(see
Pico1example,below):
Pico 1 Button Sample Component Number
Top 61Favorite 62Bottom 63Raise 64Lower 65
2 ModelPJ2-4B*only:Picobuttonorderis1,2,3,4andcomponentmappingwillbeasbelow:
Pico 1 Button Sample Component Number
1 612 643 654 63
*ModelPJ2-4BissupportedonlyonQSMsoftwareversion7 28andhigher
Use “DEVICE Command-specific fields” tables to complete these command fields.
Operation
Command
Integration ID (example)
#DEVICE,19,ComponentNumber,ActionNumber,Parameters
Continuedonnextpage…
156
Lutron integration protocol
Devices (continued)
QS Sensor Module (QSM) (continued)DEVICECommands (continued)
DEVICE Command-specific fields (continued)
Action NumbersandParameters:Action Action Number Parameters
Report(~)OccupiedorButtonPress 3 NoneReport(~)UnoccupiedorButtonRelease 4 None
Example DEVICE CommandsExamplespresumeQSMhasbeenassignedintegrationIDQSMID
Operation Command String
Response: ~DEVICE,IntegrationID,ComponentNumber,ActionNumberWiredOccupancySensor1transitionstoOccupied ~DEVICE,QSMID,1,3<CR><LF>WiredOccupancySensor1transitionstoUnoccupied ~DEVICE,QSMID,1,4<CR><LF>WirelessOccupancySensor1transitionstoOccupied ~DEVICE,QSMID,5,3<CR><LF>WirelessOccupancySensor1transitionstoUnoccupied ~DEVICE,QSMID,5,4<CR><LF>Pico1Favoritebuttonpress ~DEVICE,QSMID,62,3<CR><LF>
Customer AssistanceIfyouhavequestionsconcerningtheinstallationoroperationofthisproduct,callLutronCustomerAssistance
Pleaseprovidetheexactmodelnumberwhencalling Modelnumbercanbefoundontheproductpackaging Example:MWP-T-OHW-SN-A
U S A ,Canada,andtheCaribbean: 1 844 LUTRON1(588 7661)Europe +44 (0)20 7680 4481Asia +65 6220 4666Mexico +1 888 235 2910Othercountriescall: +1 610 282 3800Fax: +1 610 282 1243
Visitusonthewebatwww lutron com/support
LutronElectronicsCo ,Inc 7200SuterRoad
Coopersburg,PA18036USA
)Lutron,Lutron,ClearConnect,EcoSystem,GRAFIKEye,HomeWorks,Maestro,Palladiom,Pico,Quantum,RadioRA,seeTouch,Sivoia,andSoftswitcharetrademarksofLutronElectronicsCo ,Inc ,registeredintheU S andothercountries Architrave,EnergiSavrNode,GRAFIK,Hyperion,myRoom,Q-Design,RadioPowrSavr,andSignatureSeriesaretrademarksofLutronElectronicsCo ,Inc
IEEEisaregisteredtrademarkoftheInstituteofElectricalandElectronicsEngineers,Inc ,(IEEE) ThispublicationisnotendorsedorapprovedbytheIEEE
DALIisaregisteredtrademarkofZVEI-ZentralverbandElektrotechnik-undElektronikindustriee V
ThispublicationisnotendorsedorapprovedbyApple,Inc
©2014–2018LutronElectronicsCo ,Inc
P/N040249Rev Y04/2018