Lutron integration protocol

Lutron integration protocol
Lutron
®
integration protocol
revision R
15 July 2015
Lutron integration protocol
®
Updates new to this release of the Lutron® Integration Protocol
Revision Update: R
HVAC Controller
• HVAC Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . 133, 134
–Actions modified: “Changing the setpoint will turn Eco Mode off if it is currently on” (#2, #16,
#17); Set (#) or Get (?) Heat and Cool Setpoints (°C) (#16); Get (?) Heat and Cool Setpoints (°C)
without Eco Offset if applied (#17)
–Action added: Get (?) Heat and Cool Setpoints (°F) without Eco Offset if applied (#12)
Revisions to previous releases of the Lutron® Integration Protocol
Revision Update: Q
HVAC Controller
• New models added: LR-HVAC-230-S, LR-HVAC-PLC1-CPN7120, MWP-T-OHW-WH-A . . . . 132
Revision Update: P
Pico® Wireless Control
• Current models added: PJ2-2B, PJ2-2BRL, PJ2-3B, PJ2-3BRL, PJ2-4B;
Graphic added: 4B. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
• Compatibility table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
–Models added: Pico® models (PJ2-)
–Models added to note 2 reference: Pico® models PJ-, Pico® models PJ2 –“In QS Standalone systems…” note added (note 1)
–“All models supported except…” note added (note 3)
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . 109
–Table section subhead added: “For all Legacy models and all Current models except…”
–Table section added: “For PJ2-4B only”
–Table Components added: Buttons 1–4 (#8, #9, #10, #11)
• Example DEVICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
–Operation Execute: Press Button 1 modified: “(on a non-4B model)”
HVAC Controller
• HVAC Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . 133, 134
–Parameters modified: Temperature: “32–212 °F” (#1); Heat Setpoint: “32–212 °F”,
Cool Setpoint “32–212 °F” (#2); Mode 1: “Protect” added (#3); “0 –100 °C” (#15);
“with Eco Offset applied” added, Heat Setpoint: “0 –100 °C”, Cool Setpoint “0 –100 °C” (#16)
–Parameters added: Mode 7 = Fan, Mode 8 = Dry (#3); Mode 3 = Cycler, Mode 4 = No,
Mode 5 = High, Mode 6 = Medium, Mode 7 = Low, Mode 8 = Top (#4);
8 = Off, 9 = Emergency Heat, 10 = Dry (#14);
–Action added: Set or Get Heat and Cool Setpoints (#17)
QS Sensor Module
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . 142
–Components modified: Model PJ2-4B added to Pico® 1–10 Buttons (note reference 2)
–Note 2 added: Model PJ2-4B button order and component mapping
Continued on next page…
2
Lutron integration protocol
®
Revisions to previous releases of the Lutron® Integration Protocol
Revision Update: O
Integrator’s Reference
• Compatibility Matrix (Device Compatibility Matrix). . . . . . . . . . . . . . . . . . . . . . . . . 10
–Devices added: Energi Savr NodeTM QS/Softswitch®, Energi Savr NodeTM QS/International
Softswitch®, Energi Savr NodeTM QS/Phase Adaptive, QS Input/Output Interface (QSE-IO),
QS Sensor Module (QSM)
• DEVICE: Command Summary (Action Numbers and Parameters) . . . . . . . . . . . . . . 11, 12
–Actions added: Enable (#1); Disable (#2); QSG Timeclock State (#34); Query CCI State (#35)
–“Not supported by Quantum” note added to actions (#14 – 20)
• MONITORING: Command Summary (Monitoring Type). . . . . . . . . . . . . . . . . . . . . . 16
–Monitoring Types added: Occupancy (#6); System Variable (#10); Venetian Tilt (#14);
Shade Group (#23); Partition Wall (#24)
–“Not supported in QS Standalone” note added to monitoring types: LED (#4);
Sequence (#16); HVAC (#17); Mode (#18)
• HELP: Command Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
–“Not supported in QS Standalone” note added
QS Standalone
• System Overview (QS System Device Compatibility Index). . . . . . . . . . . . . . . . . . . . 20
–Devices added: Energi Savr NodeTM QS International Motor Module,
QS Input/Output Interface (QSE-IO), QS Sensor Module (QSM), QS Wall Control Interface
• Supported Commands (formerly “Additional Commands”) . . . . . . . . . . . . . . . . . . . . 21
–Command description added: OUTPUT
• ETHERNET Commands (Configuration Numbers) . . . . . . . . . . . . . . . . . . . . . . . . 23
–Descriptions modified: Get/Set (#0 – 3)
–Parameter modified: Login Info (#3)
• RESET Commands (Action Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
–Action added: Restore to Factory Defaults (#2)
• PROGRAMMING Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . 27
–Action added: Add Scene programming to a phantom button (#2)
–Parameters modified: a), b): “Shade” removed (#1)
–Parameters added: d): “Fade”, e): “Delay” (#1)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 30
–Command descriptions modified: Lighting zones added (#14); Venetians removed (#18 – 20)
RadioRA® 2
• TIMECLOCK Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . 37
–Action added: Enable/Disable Event (#6)
Continued on next page…
3
Lutron integration protocol
®
Revisions to previous releases of the Lutron® Integration Protocol
Revision Update: O (continued)
Quantum®
• AREA Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . . 51
–Actions added: Get or Set HyperionTM Shadow Sensor Override State (#26);
Get or Set HyperionTM Brightness Sensor Override State (#27)
–Parameters added: 1= unknown, 2= inactive (#8)
–“Scene 17 to 32 available only on slider” note added (#6)
HomeWorks® QS
• TIMECLOCK Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . 65
–Action added: Enable/Disable Event (#6)
GRAFIK Eye® QS
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . 72, 73
–Components added: Local CCI (#163); Timeclock Controller (#166),
Wireless Occupancy Sensor 1– 30 (#500 – 529); EcoSystem® Ballast
Occupancy Sensor 1– 64 (#700 –763)
–“Not supported in QS Standalone” note added (#201, #210, #219, #228, #237,
#174, #175, #211, #183, #184, #220, #192, #193, #229)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 73
–Actions added: Scene Save (#12); Get/Set Timeclock State (#34)
–Actions modified: Press/Occupied (#3); Release/Unoccupied (#4);
Get/Set Light Level (#14)
–Parameter modified: QS Standalone fade/delay (#14)
• OUTPUT Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . . . 74
–Parameter modified: QS Standalone fade/delay (#1)
Energi Savr NodeTM QS for DALI®
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
–Component added: Occupancy Sensors 1– 4 (#151– 154)
–Component numbers changed: #301– 332 (formerly #201– 232)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 76
–Actions added: Report Occupied (#3); Report Unoccupied (#4); Scene Save (#12)
–Parameter modified: QS Standalone fade/delay (#14)
• OUTPUT Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . . . 77
–Parameter modified: QS Standalone fade/delay (#1)
Energi Savr NodeTM QS with EcoSystem®
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
–Components added: Occupancy Sensors 1– 4 (#136–139); Loop 1 Ballast
Occupancy Sensors (#140–203); Loop 2 Ballast Occupancy Sensors (#204–267)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 79
–Actions added: Report Occupied (#3); Report Unoccupied (#4); Scene Save (#12)
• OUTPUT Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . . . 80
–Parameter modified: QS Standalone fade/delay (#1)
Continued on next page…
4
Lutron integration protocol
®
Revisions to previous releases of the Lutron® Integration Protocol
Revision Update: O (continued)
Energi Savr NodeTM QS for 0 –10V/Softswitch®/Phase Adaptive
• Phase Adaptive models added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
–Components added: Occupancy Sensors 1– 4 (#34 – 37);
Occupancy Sensors 1– 2 (#34 – 35)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 82
–Actions added: Report Occupied (#3); Report Unoccupied (#4); Scene Save (#12)
• OUTPUT Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . . . 83
–Parameter modified: QS Standalone fade/delay (#1)
Energi Savr NodeTM QS for Motor Module (International)
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
–Component added: Zones 1– 4 (#1– 4)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 85
–Actions added: Set Light Level (#14); Raise (#18); Lower (#19); Stop (#20)
• OUTPUT Commands (Action Numbers and Parameters). . . . . . . . . . . . . . . . . . . . . 86
–Actions added: Set/Get Zone Level (#1); Report Travel Time Remaining (#17)
ArchitraveTM Keypad
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
–“Available only on units in a Quantum® or HomeWorks® system” note removed (#26)
–“Available only on units in a Quantum® or HomeWorks® system” note added (#82 – 87)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 91
–Actions modified: Press/CCI Close (#3); Release/CCI Open (#4)
–“Available only on units in a Quantum® or HomeWorks® system” note removed (#5)
seeTouch® Keypad
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 97
–Actions modified: Press/CCI Close (#3); Release/CCI Open (#4)
–“Available only on units in a Quantum® or HomeWorks® system” note removed (#5, #6)
–“Available only on units in a Quantum® or HomeWorks® system” note added (#9)
seeTouch® Keypad (International)
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
–“Not supported in QS Standalone” note added (#81– 90)
• DEVICE Commands (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . . . . . 100
–Actions modified: Press/CCI Close (#3); Release/CCI Open (#4)
–“Not supported in QS Standalone” note added (#32)
Wallbox Input Closure Interface
• DEVICE Commands (Component Numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . 113
–Components added: Button 8 (#8); LED 8 (#88)
QSE-IO
–New product section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
QS Sensor Module
–New product section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
5
Lutron integration protocol
®
Table of Contents
About Integration
Integration Operations . . . . . . . . . . . . . . . 7
Operation Characters . . . . . . . . . . . . . . . . 7
Command Types. . . . . . . . . . . . . . . . . . 7
Command Structure . . . . . . . . . . . . . . . . 7
Command Termination. . . . . . . . . . . . . . . 7
Command Examples. . . . . . . . . . . . . . . . 8
Integration Access Points . . . . . . . . . . . . . . 9
Command Rules and Formatting. . . . . . . . . . 9
Integrator’s Reference
Compatibility Matrix . . . . . . . . . . . . . . . . 10
Device Command Summary. . . . . . . . . . . .11
Output Command Summary. . . . . . . . . . . .14
Group Command Summary. . . . . . . . . . . . 15
Monitoring Command Summary . . . . . . . . . .16
Error Command Summary. . . . . . . . . . . . .17
Help Command Summary . . . . . . . . . . . . .18
System Command Summary. . . . . . . . . . . .19
QS Standalone
System Overview. . . . . . . . . . . . . . . . . .20
Integration Access Points . . . . . . . . . . . . . 21
System Commands. . . . . . . . . . . . . . . . 23
RadioRA® 2
System Overview. . . . . . . . . . . . . . . . . .31
Integration Access Points . . . . . . . . . . . . . 32
System Commands. . . . . . . . . . . . . . . . 34
Clear Connect® Gateway System
System Overview. . . . . . . . . . . . . . . . . .38
Integration Access Points . . . . . . . . . . . . . 39
System Commands. . . . . . . . . . . . . . . . 42
Quantum®
System Overview. . . . . . . . . . . . . . . . . .44
Integration Access Points . . . . . . . . . . . . . 46
System Commands. . . . . . . . . . . . . . . . 48
HomeWorks® QS
System Overview. . . . . . . . . . . . . . . . . .57
Integration Access Points . . . . . . . . . . . . . 59
System Commands. . . . . . . . . . . . . . . . 61
6
Devices
GRAFIK Eye® QS. . . . . . . . . . . . . . . . . .71
Energi Savr NodeTM QS/DALI® . . . . . . . . . . . 75
Energi Savr NodeTM QS/EcoSystem® . . . . . . . .78
Energi Savr NodeTM QS/EcoSystem® (Int’l) . . . . . 78
Energi Savr NodeTM QS/0 –10 V/Softswitch® (Int’l). . 81
Energi Savr NodeTM QS/Phase Adaptive (Int’l). . . .81
Energi Savr NodeTM QS/0 –10 V/Softswitch® . . . . 81
Energi Savr NodeTM QS/Motor Module (Int’l) . . . . 84
Remote Power Module. . . . . . . . . . . . . . .87
ArchitraveTM Keypad . . . . . . . . . . . . . . . . 89
Signature SeriesTM Keypad . . . . . . . . . . . . .92
seeTouch® Keypad. . . . . . . . . . . . . . . . .95
seeTouch® QS International Keypad . . . . . . . . 98
Tabletop seeTouch® Keypad . . . . . . . . . . . 101
Hybrid Keypad. . . . . . . . . . . . . . . . . . 104
Pico® Wireless Control . . . . . . . . . . . . . . 108
Dynamic Keypad. . . . . . . . . . . . . . . . . 110
Wallbox Input Closure Interface. . . . . . . . . .112
Sivoia® QS Shade . . . . . . . . . . . . . . . . 115
Sivoia® QS Venetian Blind . . . . . . . . . . . . 118
Maestro® Dimmer and Plug-In Module . . . . . . 121
Maestro® Fan Speed Control. . . . . . . . . . . 124
Visor Control Receiver . . . . . . . . . . . . . . 126
Radio Powr SavrTM Sensor . . . . . . . . . . . . 130
HVAC Controller . . . . . . . . . . . . . . . . . 132
Wireless Temperature Sensor . . . . . . . . . . 135
QSE-IO Control Interface. . . . . . . . . . . . . 137
QS Sensor Module (QSM) . . . . . . . . . . . . 141
Lutron integration protocol
®
About Integration
Integration Operations
The Lutron® integration protocol will allow third-party equipment, such as touch-screens, universal
remote controls and software applications, to control and monitor devices in a Lutron® lighting
control system.
The protocol supports three basic types of integration operations:
• Execute an action in the Lutron® system
• Query the status of the Lutron® system and Lutron® devices
• Monitor responses from the Lutron® system
Operation Characters
To help create and manage the different integration operations, three distinct operation characters
have been selected to begin each command. All protocol messages will start with one of the
following operation characters:
# Execute an action (e.g., turn a dimmer on/off)
? Query system information (e.g., determine on/off status of a dimmer)
~ Monitor responses from the system when requested or after a change has occurred (e.g., if
someone turns on a dimmer locally, a response command is sent out to indicate the change)
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 Types
Operation characters will be followed by command types. The two most common commands are:
OUTPUT and DEVICE. Other command types are available; see the Integrator’s Reference for a
summary.
• OUTPUT allows control and monitoring of device outputs such as dimmers and contact closure
outputs.
• DEVICE allows control and monitoring of device inputs such as button presses, releases, and
contact closure inputs.
Command Structure
The protocol command structure is made up of three parts:
Command
Integration ID
Command-specific fields
1.The Command is made up of the operation character and the command type.
2.The Integration ID is assigned to each device in the system during system setup, providing a
unique user-assigned address for each system device.
3.The Command-specific fields contain additional information relevant to the type of command.
Details about what command-specific field data is supported can be found in the appropriate
device specific section of this integration protocol guide.
Command Termination
Each command is made up of fields, separated by commas and terminated with a carriage return
(ASCII dec 13/hex 0D) and a line feed (ASCII dec 10/hex 0A). Throughout this document, carriage
return is shown as <CR> and line feed is shown as <LF>.
7
Lutron integration protocol
®
About Integration (continued)
Command Examples
1) This command sets a dimmer (1) level to 75% with a 1 minute and 30 second fade time.
#OUTPUT,1,1,75,01:30<CR><LF>
Command
#OUTPUT
Integration ID
1
Command-specific fields
Action Number
Level
Fade Time
1
75
01:30
2) This command presses button number 1 of a keypad (2).
#DEVICE,2,4,3<CR><LF>
Command
#DEVICE
Integration ID
2
Command-specific fields
Component Number
Action Number
4
3
3) This command requests the output level for a dimmer (3).
?OUTPUT,3,1<CR><LF>
Command
Integration ID
Command-specific fields
Action
?OUTPUT
3
1
4) When a user makes a change to a dimmer locally, the following command response would be sent
out from the system or when requested by the command in Example 3 above. This command
response example shows the local dimmer (3) level was changed to 90%.
~OUTPUT,3,1,90.00<CR><LF>
Command
~OUTPUT
8
Integration ID
3
Command-specific fields
Action
Level
1
90.00
Lutron integration protocol
®
About Integration (continued)
Integration Access Points
• Integration Access Points communicate with external systems using RS232, Ethernet or both.
The Lutron® integration protocol will allow third-party equipment, such as touch-screens, keypads
and software applications, to control and monitor devices in the Lutron® lighting control system
through an Integration Access Point. For more information, check the page specific to the
Integration Access Point being used. An example of an Integration Access Point is the QS Network
Interface (QSE-CI-NWK-E). For a listing of all the available Integration Access Points supported
by a particular system, see the Integration Access Points section for that system in the table of
contents.
Command Rules and Formatting
• All commands are in ASCII characters
• Each command is made up of fields, separated by commas and terminated with a carriage return
(<CR>, ASCII 13) and a new line (<LF>, ASCII 10)
• Letter case is ignored
• Spaces are ignored
• Leading zeros are ignored
9
Lutron integration protocol
®
Integrator’s Reference
COMPATIBILITY MATRIX
Integration Access Point Compatibility Matrix:
Connect®
QS Standalone Quantum® RadioRA® 2 HomeWorks® QS Clear
Gateway System

QS Network Interface
RadioRA® 2 Main Repeater
HomeWorks® QS Processor
Clear Connect® Gateway





Device Compatibility Matrix:
Connect®
QS Standalone Quantum® RadioRA® 2 HomeWorks® QS Clear
Gateway System
GRAFIK Eye® QS
seeTouch® Keypad
Tabletop seeTouch® Keypad
ArchitraveTM Keypad
Signature SeriesTM Keypad
Sivoia® QS Shade
Maestro® Dimmer + Switch
Maestro® Fan Speed Control
Visor Control Receiver
Hybrid Keypad
Pico® Wireless Control
Radio Powr SavrTM Sensor
HVAC Controller
Remote Power Module
Energi Savr NodeTM QS/DALI®
Energi Savr NodeTM QS/0 –10 V
(Int’l)
Energi Savr NodeTM QS/
EcoSystem®
Energi Savr NodeTM QS/0 –10 V
Energi Savr NodeTM QS/
EcoSystem® (Int’l)
Energi Savr NodeTM QS/
Motor Module (Int’l)
Wallbox Input Closure Interface
Wireless Temperature Sensor
Energi Savr NodeTM QS/Softswitch®
Energi Savr NodeTM QS/
Softswitch® (Int’l)
Energi Savr NodeTM QS/
Phase Adaptive (Int’l)
QS Input/Output Interface
QS Sensor Module
10





































































Lutron integration protocol
®
Integrator’s Reference (continued)
DEVICE: Command Summary
Device integration commands allow the user to access components of the system such as a
physical device. The user can activate programming via button presses, releases, etc., as well as
monitor those same events as they occur in real time in the system.
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Refer to device specific tables for lists of Component Numbers.
Action Numbers and Parameters:
Action
Action Number
Parameters
Enable
1
None1
Disable
2
None1
Press / Close / Occupied
3
None
Release / Open / Unoccupied
4
None
Hold2
5
None
Multi-tap2
6
None
Scene1,2
7
Scene
Set (#) or Get (?) LED State
9
0 = Off
1 = On
2 = Normal Flash2
3 = Rapid Flash2
Set or Get Light Level3,4
14
0–100 or 0.00–100.003
Set or Get Current
SS.ss, SS, MM:SS, or HH:MM:SS3
SS.ss, SS, MM:SS, or HH:MM:SS3
NOTES
1.Quantum® 2.7 and higher.
2. Not supported in RadioRA® 2.
3. Not supported by Quantum®.
4. Not supported by Clear Connect® Gateway.
Continued on next page…
11
Lutron integration protocol
®
Integrator’s Reference (continued)
DEVICE: Command Summary (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Set or Get Zone
1.
2.
3.
4.
5.
6.
Action Number
Lock 1,2,3
Parameters
15
0 = Off
1 = On
Set or Get Scene Lock 1,2,3
16
0 = Off
1 = On
Set or Get Sequence State 1,2,3
17
0 = Off
1 = Scenes 1–4
2 = Scenes 5–16
Start Raising 3,4,5
18
None
Start
Lowering 3,4,5
19
None
Stop
Raising / Lowering 3,4,5
20
None
Get battery status
22
1 = Normal, 2 = Low
Set a custom lift and tilt level of venetian blinds
programmed to the phantom button 4,6
23
Lift level %
Tilt level %
Set a custom lift level only of venetian blinds
programmed to the phantom button 4,6
24
Lift level %
Set a custom tilt level only of venetian blinds
programmed to the phantom button 4,6
25
Tilt level %
Hold / Release2
32
None
GRAFIK Eye® QS Timeclock state
34
0 = Disabled
1 = Enabled
Query CCI state
35
None
NOTES
Not supported in HomeWorks® QS.
Not supported in RadioRA® 2.
Not supported by Quantum®.
Use OUTPUT command with equivalent action number in RadioRA® 2.
Use OUTPUT command with equivalent action number in HomeWorks® QS.
Use SHADEGRP command with equivalent action number in HomeWorks® QS.
12
Lutron integration protocol
®
Integrator’s Reference (continued)
DEVICE: Command Summary (continued)
HomeWorks® QS Button Types and Integration Requirements:
Refer to Lutron® Designer software for setting up programming options.
Programming Options
Required Integration Action Numbers
Double
Tap
Hold
Cycle
Dim
Press
(3)
—
—
—
—

—
—


—
—



—
—
—
—
—

—


—
—
—

—
Master and Single
Scene Raise / Lower
Buttons
—
Open/Stop/Close/
Stop Buttons
—
Buttton Type
Single-Action and
Toggle Buttons
Dual Action Buttons
Release Multi-Tap
(4)
(6)
Hold
(5)
Hold
Release (32)
—
—
—
—

—
—





—






—


—
—
—
—



—
—
—
—


—
—
—
—
—

—
—
—
—

—
—


RadioRA® 2 Button Types and Integration Requirements:
Refer to RadioRA® 2 Essentials / Inclusive software for setting up programming options.
Programming Options
Required Integration Action Numbers
Scene Save
Enabled
Press
(3)
—
—



Master and Single
Scene Raise / Lower
Buttons
—
Shade Toggle Buttons
—
Buttton Type
Single-Action and
Toggle Buttons
Release Multi-Tap
(4)
(6)
Hold
(5)
Hold
Release (32)
—
—
—
—
—

—


—
—
—

—
—
—
—
13
Lutron integration protocol
®
Integrator’s Reference (continued)
OUTPUT: Command Summary
Outputs are dimmers, CCOs, or other devices in a system that have a controllable output. All of
these devices will accept levels from 0% to 100% and 0.00% to 100.00% with a given fade and
delay time. These same commands can be monitored in real-time as they occur in the system.
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 6, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set or Get Zone Level
1
Start Raising
Start Lowering
Stop Raising / Lowering
Start Flash 2
Pulse
Set (#) or Get (?) 3,4
Venetian tilt level only
2
3
4
5
6
9
Set (#) or Get (?) 4
Venetian lift & tilt level
10
Start raising Venetian tilt
Start lowering Venetian tilt
Stop Venetian tilt
Start raising Venetian lift
Start lowering Venetian lift
Stop Venetian lift
Set DMX color / level settings 7
Motor Jog Raise 7
Motor Jog Lower 7
Motor 4-Stage Jog Raise 7
Motor 4-Stage Jog Lower 7
11
12
13
14
15
16
17
18
19
20
21
Parameters
0–100 or
0.00–100.00
SS.ss 1, SS, MM:SS, or HH:MM:SS
None
None
None
SS.ss 1, SS, MM:SS, or HH:MM:SS
SS.ss 1, SS, MM:SS, or HH:MM:SS
Tilt Level 5 = 0–1006 or 0.00–100.00 5,6
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 3 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Lift Level 5 = 0–100 or 0.00–100.00 5
Tilt Level 5 = 0–100f or 0.00–100.00 5,6
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 3 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
None 4
None 4
None 4
None 4
None 4
None 4
Color / level index: 0–255 / 0.00–100.00 8
None 9
None 9
None 9
None 9
NOTES
1. Fractions are rounded up to the closest 1/4 second.
2. To stop a dimmer from flashing, send it to a valid level (action 1).
3. The Delay time is optional. When not used, the system will use a zero-second delay. The minimum delay time is
0 seconds. The maximum delay time is 4 hours.
4. Not supported in Quantum®.
5. For switched outputs, any non-zero level results in on or closed, 0 results in off or open.
6. 50 for Horizontal Sheer Blinds.
7. Not supported in RadioRA® 2.
8. Supported in Quantum® version 2.2 and higher.
9. Supported in Quantum® version 2.5 and higher.
14
Lutron integration protocol
®
Integrator’s Reference (continued)
GROUP1: Command Summary
The GROUP command is used to report the status of a group of occupancy sensors.
GROUP Command Format
Operation
Integration ID (example)
?GROUP, 6, Action Number
Command
Use “GROUP Command-specific fields” tables
to complete these command fields.
NOTE
1. Not supported in QS Standalone.
GROUP Command-specific fields
Occupancy States:
Description
Occupied
3
Unoccupied
4
Unknown
Value
255
Action Numbers:
Action
Action Number
Get (?) Occupancy Group State
3
Example GROUP Messages
Operation
Command String
Query: ?GROUP, Integration ID, Action Number
What is Occ GROUP 1’s status? ?GROUP,1,3<CR><LF>
Response: ~ GROUP, Integration ID, Action Number, Parameters
Occ group 1 is occupied
~GROUP,1,3,3<CR><LF>
Occ group 1 is unknown
~GROUP,1,3,255<CR><LF>
15
Lutron integration protocol
®
Integrator’s Reference (continued)
MONITORING: Command Summary
Monitoring allows the user to configure what types of messages the system will report.
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.
MONITORING Command Formats
Operation
#MONITORING, Monitoring Type, Action Number
Command
Use “MONITORING Command-specific fields” tables
to complete these command fields.
MONITORING Command-specific fields
Monitoring Type:
Description
Monitoring Type
Diagnostic Monitoring
Event Monitoring
Button Monitoring
LED Monitoring1
Zone Monitoring
Occupancy
Scene #
System Variable
Reply State (if disabled, all messages FROM the integration access point will cease)
Prompt State (if disabled, the prompt will not be printed to the terminal)
Venetian Tilt2
Sequence Monitoring1
HVAC Monitoring1,2
Mode Monitoring1,2
Shade Group Monitoring3
Partition Wall3
Set (#) or Get (?) State of All Monitoring (except Reply and Prompt)
NOTES
1. Not supported in QS Standalone.
2. Not compatible with Quantum®.
3. Not supported in RadioRA® 2.
Action Numbers:
Action
Action Number
Enable
1
Disable
2
16
1
2
3
4
5
6
8
10
11
12
14
16
17
18
23
24
255 Lutron integration protocol
®
Integrator’s Reference (continued)
ERROR: Command Summary
Integration Access Points will respond with an error if an invalid command is received. See the
table below for explanations of different errors.
ERROR Command Formats
Operation
~ERROR, Error Number
Command
Refer to “ERROR Command-specific fields” table
ERROR Command-specific fields
Error Numbers:
Description
Error Number
Parameter count mismatch
1
Object does not exist
2
Invalid action number
3
Parameter data out of range
4
Parameter data malformed
5
Unsupported Command
6
Example ERROR Messages
Operation
Command String
Parameter count mismatch: Too many or too few parameters for the specified action
Too many parameters when activating scene
#AREA,2,6,1,1,1,1,1<CR><LF>
Parameter count mismatch.
~ERROR,1<CR><LF>
Object does not exist: The Integration ID or serial number entered does not map to a known part of the system
Send command to an ID that is not valid
#OUTPUT,1234,1,100.00<CR><LF>
Object does not exist
~ERROR,2<CR><LF>
Invalid Action: The action does not exist for this command
Send invalid action (4321) to Area 2
#AREA,2,4321<CR><LF>
Invalid action number
~ERROR,3<CR><LF>
Parameter data out of range: The parameter data is out of range for this action
Send Output 11 to 120%
#OUTPUT,11,1,120.00<CR><LF>
Parameter data out of range
~ERROR,4<CR><LF>
Parameter data malformed: The parameter data given was not formatted properly
Set Time to 12:23:24:25
#SYSTEM,1,12:23:24:25<CR><LF>
Invalid action number
~ERROR,5<CR><LF>
17
Lutron integration protocol
®
Integrator’s Reference (continued)
HELP1: Command Summary
HELP Command for a specific Command Name provides command-name specific usage
information.
HELP Command Formats
Operation
?HELP, Command Name 2, Action Number 3
Command
NOTES
1. HELP not supported in QS Standalone.
2. The “Command Name” parameter is optional. If not entered, a list of all the supported Integration Commands will be
printed. If a supported command name is entered, the corresponding actions will be listed.
3. The “Action” parameter is optional. When a valid action number is entered (i.e. it is supported by the corresponding
“Command Name”), the help information for that particular action will be displayed.
Example HELP Messages
Operation
Command String
Query: #HELP, Command Name, Action Number
What are all the supported Integration Commands?
?HELP<CR><LF>
What actions are available for #OUTPUT?
?HELP,#OUTPUT<CR><LF>
How is “Raise” used for #OUTPUT?
?HELP,#OUTPUT,2<CR><LF>
Response: ~HELP, Help Information
The list of all Integration Commands.
#OUTPUT,?OUTPUT,#DEVICE,?DEVICE,#AREA,
?AREA,#TIMECLOCK,?TIMECLOCK,#SYSTEM,
?SYSTEM,#MONITORING,?MONITORING,
<CR><LF>
The help information for the #OUTPUT command.
~HELP, #OUTPUT requires action<1–6><CR><LF>
1 = Set Level / Position
2 = Start Raising
3 = Start Lowering
4 = Stop Raising / Lowering
6 = Pulse
USAGE: #OUTPUT, <ID>, <action>,<CR><LF>
The help information for the “Raise” action (#OUTPUT).
~HELP, #OUTPUT, <action=2> start raising
output level<CR><LF>
USAGE: #OUTPUT, <ID>, <action=2><CR><LF>
18
Lutron integration protocol
®
Integrator’s Reference (continued)
SYSTEM1: Command Summary
SYSTEM Command provides support for location, device and system specific information
(e.g., Date, Time, Software Version Numbers).
SYSTEM Command Formats
Operation
#SYSTEM, Action Number, Parameters
Command
Use “SYSTEM Command-specific fields” tables to
complete these command fields.
NOTE
1. Not supported in QS Standalone.
SYSTEM Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Get (?)Time 1
1
Time in: SS.ss, SS, MM:SS, or HH:MM:SS
Set or Get Date
2
Date in MM/DD/YYY
Set or Get Latitude and
Longitude
4
Latitude = –90.00 to +90.00 degrees
Longitude = –180.00 to +180.00 degrees
Set or Get Time Zone 2
5
Hours = –12 to 12
Minutes = 0 to 59
Get Sunset
6
None
Get Sunrise
7
None
Get OS Rev
8
None
11
0 = Disabled
1 = Enabled
Set Load
Shed 3
NOTES
1. The system time must be entered in 24 hour format.
2. The Time Zone is referenced to GMT.
3. Load Shed commands available only on Quantum® version 2.0 and higher.
Example SYSTEM Messages
Operation
Command String
Execute: #SYSTEM, Action Number, Parameters
Set time to 5:45 PM.
#SYSTEM,1,17:45<CR><LF>
Set date to June 1, 2009.
#SYSTEM,2,06/01/2009<CR><LF>
Query: ?SYSTEM, Action Number
What is the system time?
?SYSTEM,1<CR><LF>
What is the system date?
?SYSTEM,2<CR><LF>
Response: ~SYSTEM, Action Number, Parameters
The system time is 11:05 AM.
~SYSTEM,1,11:05:00<CR><LF>
The system date is July 3, 2009.
~SYSTEM,2,07/03/2009<CR><LF>
19
Lutron integration protocol
®
QS Standalone
System Overview
The QS family of products delivers scalable lighting and shading solutions for residential and
commercial applications. At the center of the QS system are the GRAFIK Eye® QS control units,
Energi Savr NodeTM control units, and Sivoia® QS shades and drapes, providing direct control of
electric and natural light. QS system devices communicate over the highly flexible QS link; the
link allows for daisy-chain or t-tap wiring configurations. All QS system devices communicate
without the need for interfaces, and addressing is automatic, eliminating the need to set DIP
switches. In addition, QS keypads are configurable in the field to control lights, shades, lights +
shades, or third-party devices. The QS system can be easily integrated with other systems through
contact‑closure input /output, DMX output, or Ethernet/RS232.
QS System Device Compatibility Index:
QS Standalone
GRAFIK Eye® QS
seeTouch® QS
Sivoia® QS Shade
Energi Savr NodeTM QS DALI®
Energi Savr NodeTM QS EcoSystem® (Int’l)
Energi Savr NodeTM QS 0 –10 V/Softswitch® (Int’l)
Energi Savr NodeTM QS Phase Adaptive (Int’l)
Energi Savr NodeTM QS EcoSystem®
Energi Savr NodeTM QS 0 –10 V/Softswitch®
Energi Savr NodeTM QS Motor Module (Int’l)
QSE-IO Control Interface
QS Sensor Module
QS Wall Control Interface
20













Lutron integration protocol
®
QS Standalone (continued)
Integration Access Points
Network Interface
Model: QSE-CI-NWK-E
Why Integrate with a QSE-CI-NWK-E?
• Integrates a QS lighting control system with a PC or other digital equipment that supports RS232
or Ethernet TCP/IP connection.
• Allows monitor and control of system devices. For example, the QSE-CI-NWK-E can be used to
simulate button presses, report button presses, control light levels, and monitor light levels.
•
•
•
•
•
•
•
•
•
•
Supported Commands
MONITORING specifies what type of messages the system will report
ETHERNET modifies the Ethernet configurations of the QSE-CI-NWK-E
RESET restarts the QSE-CI-NWK-E or restores it to factory defaults
INTEGRATION ID assigns IDs to devices, so that they may be referred to in a more logical fashion
DETAILS returns information about a QS device
ERROR reports syntax errors in an integration string command or query
PROGRAMMING allows user to program Phantom Buttons on the NWK supported in version 8.0
or higher
DEVICE used to activate Phantom Buttons on the NWK
OUTPUT used to control outputs of a Device
“Programming” and “Device” commands require version 8.0 or higher of the NWK software
21
Lutron integration protocol
®
QS Standalone (continued)
Integration Access Points (continued)
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Connection Information
Provides an RS232 and Ethernet connection to communicate with external equipment.
Communication is through either RS232 or Ethernet, but not both simultaneously.
RS232
The RS232 connection has the following communication settings:
Baud Rate 9600/19200/38400/115200 (set via dipswitch on unit)
8 data bits
No parity bit
1 stop bit
No flow control
Ethernet
Configuring the control interface to communicate over a network takes not only knowledge
of the QS system, but of networking as well. Installers with limited networking knowledge are
advised to contact a networking professional before attempting to connect a QSE-CI-NWK-E
through a network. The information below will help an installer communicate the QSE-CI-NWK-E
configurations to a network professional.
The installer will make any necessary changes to the control interface using the Lutron® DeviceIP or
PC software tool and the network professional can make any necessary changes to the networking
equipment.
Single Ethernet Port
IEEE® 802.3 Auto-Sensing 10BaseT / 100BaseTX
Supports MDI/MDIX auto-crossover (no crossover cable needed).
Female 8P8C “Computer RJ-45” socket
Green “Connect” LED, Amber “Activity” LED
Use Cat 5 cabling or better
TCP / IP Settings
IP Address: <static default = 192.168.250.1>
Subnet Mask: <static default = 255.255.255.0>
Gateway: <static default = 0.0.0.0>
Protocols Used for Integration
TELNET
Telnet Server
Used by third party equipment (i.e. touch screen)
Limited to transferring ASCII characters
Telnet Port number is 23
Login #1: nwk
Login #2: nwk2
22
Lutron integration protocol
®
QS Standalone (continued)
System Commands
ETHERNET Commands
ETHERNET Command Formats
Operation
#ETHERNET, Configuration Number, Parameters
Command
Use “ETHERNET Command-specific fields” tables
to complete these command fields.
ETHERNET Command-specific fields
Configuration Numbers:
Description
Configuration Number
Parameters
Get/Set IP Address
0
Address (XXX.XXX.XXX.XXX)
Get/Set Gateway Address
1
Address (XXX.XXX.XXX.XXX)
Get/Set Subnet Mask
2
Address (XXX.XXX.XXX.XXX)
Get/Set Login Info
3
User (0 = All users; 1 = User 1; 2 = User 2),
Old Login,
New Login
Example ETHERNET Commands
Operation
Command String
Execute: #ETHERNET, Configuration Number, Parameters
Set IP Address to 192.168.250.1
#ETHERNET,0,192.168.250.1<CR><LF>
Set Gateway Address to 10.2.4.1
#ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET, Configuration Number, Parameters
What is the IP Address?
?ETHERNET,0<CR><LF>
What is the Login Information for user 1?
?ETHERNET,3,1<CR><LF>
What is the Login Information for ALL users? (Note: 0 = ALL)
?ETHERNET,3,0<CR><LF>
Response: ~DEVICE, Integration ID, Configuration Number, Parameters
The IP Address is 192.168.250.1
~ETHERNET,0=,192.168.250.1<CR><LF>
23
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
INTEGRATION ID Commands
INTEGRATION ID Command Formats
Operation
#INTEGRATIONID, Action Number, Parameters
Command
Use “INTEGRATIONID Command-specific fields” tables
to complete these command fields.
INTEGRATION ID Command-specific fields
Action Numbers and Parameters:
Description
Action Number
Parameters
Set or Get Integration ID for a
Serial Number
1
Serial Number = 8 character HEX serial number of the device
Integration ID = The integration ID to be assigned.
Change Integration ID
2
Current Integration ID, New Integration ID
Note: An error will be reported if the new Integration ID is the
same as an existing Integration ID in the system.
Get Info from ID
3
Integration ID
Note: If this field is left blank, all integration IDs will be printed.
Set or Get output Integration ID
4
Serial Number, Component Number, Integration ID
Example INTEGRATION ID Commands
Operation
Command String
Execute: #INTEGRATIONID, Action Number, Parameters
Set the Integration ID for a serial number
#INTEGRATIONID,1,1234ABCD,kitchen dimmer<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Set the Integration ID for a serial number
~INTEGRATIONID,1,1234ABCD,kitchen dimmer<CR><LF>
Execute: ?INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
~INTEGRATIONID,1,5678EFEF,living room keypad<CR><LF>
Execute: #INTEGRATIONID, Action Number, Parameters
Change the Integration ID
#INTEGRATIONID,2,diningroomlights1,diningroomaccents<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Change the Integration ID
~INTEGRATIONID,2,diningroomlights1,diningroomaccents<CR><LF>
Execute: ?INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID
command
?INTEGRATIONID,3,livingroomkeypad<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID command ~INTEGRATIONID,3,livingroomkeypad,DEVICE,5678EFEF<CR><LF>
24
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
DETAILS String
DETAILS Command Formats
Operation
?DETAILS, ID 1
Command
NOTE
1. Device ID may be entered as the serial ID number or the Integration ID. Use ALL_DEVICES or FFFFFFFF to query all
devices on the link.
Example DETAILS String
Operation
Command String
Query: ?DETAILS, ID
Get details of the device with serial ID number 00AC123D
?DETAILS,00AC123D<CR><LF>
Response: ~DETAILS, Serial Number, Name, Family, Model, Software Rev., Boot Software Rev.
The device with serial ID number 00AC123D has the
following information:
Name = GRAFIK Eye 1
Product Family = GRAFIK Eye
Product Model = QSG
Software Revision = 1.70
Boot Code Software Revision = 2
~DETAILS,SN:00AC123D,IntegrationID:GRAFIKEye1,Famil
y:GRAFIK_Eye(2),Product:QSG(1),CODE:1.70,Boot:2.1,H
W:1.1<CR><LF>
25
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
RESET Commands
RESET Command Formats
Operation
#RESET, Action Number
Command
Use “RESET Command-specific fields” tables
to complete these command fields.
RESET Command-specific fields
Action Numbers:
Action
Action Number
Restart the device
0
Restore to factory defaults
1
Restore to factory defaults (does not affect the IP address,
Gateway address, subnet mask settings)
2
Example RESET Commands
Operation
Command String
Execute: #RESET, Action Number
Restart the NWK
#RESET,0<CR><LF>
Restore NWK to factory defaults
#RESET,1<CR><LF>
26
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
PROGRAMMING Commands
PROGRAMMING Command Formats
Operation
Integration ID or Serial # of
the QSE-CI-NWK being used
#PROGRAMMING, 1, Button Number, Action Number, Parameters
Command
Phantom Button Number
(can be 1–100)
Use “PROGRAMMING Command-specific fields” tables
to complete these command fields.
PROGRAMMING Command-specific fields
Action Numbers and Parameters:
Description
Action Number Parameters
Add programming to a phantom button
1
Add Scene programming to a phantom button
2
Clear programming from a phantom button.
Note: Use 0 to clear programming from all
buttons.
Configure Stop-If-Moving functionality
Note: Use button 0 to configure Stop-If-Moving
functionality on all buttons.
Add programming to a phantom button
(Venetian blind, lift and tilt levels)
3
Add programming to a phantom button
(Venetian blind, tilt only)
6
Add programming to a phantom button
(Venetian blind, lift only)
7
a) Integration ID – The Integration ID of the device
b) Component Number – Always ‘0’ for Shade
c) Level – The level to which the shade being
programmed will go on activation of this button
d) Fade – The time the zone takes to reach the
level specified (maximum 4 hours)1
e) Delay – The time until the Shade/Zone begins
to change (maximum 4 hours)
a) Integration ID
b) Component Number (GRAFIK Eye® QS Scene
controller, Energi Savr NodeTM area2)
c) Scene Number
None
4
0 = Stop-If-Moving Off
1 = Stop-If-Moving On
5
a) Venetian Integration ID
b) Component Number (always 0)
c) Lift level
d) Tilt level
a) Venetian Integration ID
b) Component Number (always 0)
c) Tilt level
a) Venetian Integration ID
b) Component Number (always 0)
c) Lift level
NOTES
A maximum of 500 programming assignments can be made in the QSE-CI-NWK-E.
1. Not available for Shades.
2. If a device’s Zone is already assigned to the button, you cannot program a Scene for that Zone. If a Scene is already
programmed for this button for a device, you cannot program another Scene.
27
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
PROGRAMMING Commands (continued)
Example PROGRAMMING Commands
For a system of one shade (Integration ID “living room sheer”), one Venetian blind (“kitchen
venetian”), and one QSE-CI-NWK (Integration ID “1”), the following examples show how
programming can be done.
Operation
Command String
Add shade at 100% to phantom button 1
Response Received
Add Venetian blind at 0% lift and 50% tilt to phantom
button 2
Response Received
Add Venetian blind at 75% tilt to phantom button 3
Response Received
Add Venetian blind at 15% lift to phantom button 4
Response Received
Add shade at 50% to phantom button 2
Response Received
Turn On Stop-If-Moving for phantom button 5
Response Received
Clear programming from all the phantom buttons
Response Received
Repeat command to clear all phantom button
programming
Response Received
Clear programming from phantom button 6
Response Received
#PROGRAMMING,1,1,1,living room sheer,0,100<CR><LF>
~PROGRAMMING,1,1,1,living room sheer,0,100<CR><LF>
#PROGRAMMING,1,2,5,kitchen venetian,0,0,50<CR><LF>
28
~PROGRAMMING,1,2,5,kitchen venetian,0,0,50<CR><LF>
#PROGRAMMING,1,3,6,kitchen venetian,0,75<CR><LF>
~PROGRAMMING,1,3,6,kitchen venetian,0,75<CR><LF>
#PROGRAMMING,1,4,7,kitchen venetian,0,15<CR><LF>
~PROGRAMMING,1,4,7,kitchen venetian,0,15<CR><LF>
#PROGRAMMING,1,2,1,dining room blackout,0,50<CR><LF>
~PROGRAMMING,1,2,1,dining room blackout,0,50<CR><LF>
#PROGRAMMING,1,5,4,1<CR><LF>
~PROGRAMMING,1,5,4,1<CR><LF>
#PROGRAMMING,1,0,3<CR><LF>
Repeat command to clear all phantom button programming
#PROGRAMMING,1,0,3<CR><LF>
~PROGRAMMING,1,0,3<CR><LF>
#PROGRAMMING,1,6,3<CR><LF>
~PROGRAMMING,1,6,3<CR><LF>
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
PROGRAMMING Commands (continued)
PROGRAMING Command Formats
Operation
Integration ID or Serial # of
the QSE-CI-NWK being used
?PROGRAMMING, 1, Button Number, Action Number
Command
Phantom Button Number
(can be 1–100)
Use “PROGRAMMING Command-specific fields” tables
to complete these command fields.
PROGRAMMING Command-specific fields
Action Numbers and Parameters:
Description
Action Number
Display programming of a specific
phantom button
Note: To display programming of all phantom
buttons, leave the button # field blank
Display Stop-If-Moving configuration of a specific
phantom button
Note: To display Stop-If-Moving configuration of all
phantom buttons, use button #0
Parameters
None
None
4
None
Example PROGRAMMING Commands
The following examples show how to verify the programming of the phantom buttons of a
QSE-CI-NWK-E with an Integration ID of “1.”
Operation
Command String
Display programming of phantom button 1
?PROGRAMMING,1,1<CR><LF>
Display programming of all phantom buttons
?PROGRAMMING,1<CR><LF>
Display Stop-If-Moving configuration of phantom button 5
?PROGRAMMING,1,5,4<CR><LF>
Display Stop-If-Moving configuration of all phantom buttons
?PROGRAMMING,1,0,4<CR><LF>
29
Lutron integration protocol
®
QS Standalone (continued)
System Commands (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID or Serial # of
the QSE-CI-NWK being used
#DEVICE, 1, Button Number, Action Number, Parameters
Command
Phantom Button Number
(can be 1–100)
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Action Numbers and Parameters:
Description
Activate the phantom button preset
Set a custom level of the shades, lighting zones
programmed to the phantom button
Raise the shades
Lower the shades
Stop the shades
Set a custom lift and tilt level of venetian blinds programmed
to the phantom button
Set a custom lift level only of venetian blinds programmed to
the phantom button
Set a custom tilt level only of venetian blinds programmed to
the phantom button
Action Number Parameters
3
14 1
None
Level: The level the shades will go to 1
18 2
19 2
20
23 1
24 1
None
None
None
Lift level %
Tilt level %
Lift level %
25 1
Tilt level %
NOTES
1. Specifying a custom level above will not affect the preset level programmed for the phantom button.
2. For Venetian blinds, the Raise & Lower Actions will affect either the lift or the tilt based on how the phantom button was
programmed. If #PROGRAMMING Action 5 is used (affecting both lift and tilt levels), then the Raise & Lower Actions will
affect the tilt.
Example DEVICE Commands
The following examples show how we can activate phantom buttons on a link with a
QSE-CI-NWK-E whose Integration ID is “1.”
Operation
Command String
Activate Preset on phantom button 1
Set the level of all shades programmed to phantom button 2 to 50%
Set all venetian blinds programmed to phantom button 3 to a lift level of
50% and tilt level of 25%
Set all venetian blinds programmed to phantom button 4 to a lift level of 50%
Set all venetian blinds programmed to phantom button 5 to a tilt level of 25%
Raise the shades and venetian blinds programmed to phantom button 6
Lower shades and venetian blinds programmed to phantom button 7
Stop shades and venetian blinds programmed to phantom button 8
#DEVICE,1,1,3<CR> <LF>
#DEVICE,1,2,14,50<CR><LF>
#DEVICE,1,3,23,50,25<CR><LF>
30
#DEVICE,1,4,24,50<CR><LF>
#DEVICE,1,5,25,25<CR><LF>
#DEVICE,1,6,18<CR><LF>
#DEVICE,1,7,19<CR><LF>
#DEVICE,1,8,20<CR><LF>
Lutron integration protocol
®
RadioRA® 2
System Overview
RadioRA® 2 is a wireless multi-room control system for lights and shades. The system is made up
of repeaters, dimmers, keypads, and other devices. The Lutron® proven, patented RF technology
ensures reliable performance. With the RadioRA® 2 system, you can: create the right ambience for
varied activities, easily monitor and control your lights, reduce energy usage, and increase safety in
and around your home.
RadioRA® 2 System Device Compatibility Index:
RadioRA® 2
Maestro® Dimmer
Tabletop seeTouch® Keypad
Visor Control Receiver
GRAFIK Eye® QS
seeTouch® Keypad
Sivoia® QS Wireless Shade
Hybrid Keypad
Pico® Wireless Control
Radio Powr SavrTM Sensor
HVAC Controller
Plug-In Module











31
Lutron integration protocol
®
RadioRA® 2 (continued)
Integration Access Points
Main Repeater
Model: RR-MAIN-REP-WH, RRK-MAIN-REP-WH
USB
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
Wired
Test
COM
MUX
MUX
9V
N/C
Power Repeater Link
1
2
3
4
Add
Integrate
RS232
Program / Integrate
Ethernet
Why Integrate with a RadioRA® 2 Main Repeater?
• Integrates a RadioRA® 2 lighting control system with a PC or other digital equipment that supports
RS232 or Ethernet TCP/IP communication.
• Allows monitoring and control of system devices. For example, the Main Repeater can be used to
simulate button presses, report button presses, monitor LEDs, and control light levels of dimmers.
Integration Capabilities
• 100 “virtual” programmable buttons with LEDs (use DEVICE command)
• Monitoring of changes to other system devices (use MONITORING command)
Additional Commands
• MONITORING commands are used to program what types of messages the system will report
32
Lutron integration protocol
®
USB
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
COM
MUX
9V
MUX
Power Repeater Link
N/C
RadioRA® 2 (continued)
Integration Access Points (continued)
Wired
Test
1
2
3
4
Add
Integrate
RS232
Program / Integrate
Ethernet
Connection Information
Provides an RS232 and Ethernet connection to communicate with external equipment.
RS232
The RS232 connection has the following communication settings:
Baud Rate 9600
8 data bits
No parity bit
1 stop bit
No flow control
Ethernet
Configuring the control interface to communicate over a network takes not only knowledge of
the RadioRA® 2 system, but of networking as well. Installers with limited networking knowledge
are advised to contact a networking professional before attempting to connect a control interface
through a network. The information below will help an installer communicate the control interface
configurations to a network professional.
The installer will make any necessary changes to the control interface using the Lutron® DeviceIP
or RadioRA® 2 PC software tool and the network professional can make any necessary changes to
the networking equipment.
Single Ethernet Port
• IEEE® 802.3 Auto-Sensing 10BaseT / 100BaseTX
• Supports MDI/MDIX auto-crossover (no crossover cable needed).
• Female 8P8C “Computer RJ-45” socket
• Green “Connect” LED, Amber “Activity” LED
• Use Cat 5 cabling or better
TCP / IP Settings
• DHCP (dynamic) or static configuration <factory default = DHCP>
• IP Address: <static default = 192.168.1.50 or dynamic configuration>
• Subnet Mask: <static default = 255.255.255.0 or dynamic configuration>
• Gateway: <static default = 0.0.0.0 or dynamic configuration>
Protocols Used for Integration
• TELNET
Telnet Server
• Up to 4 telnet sessions can be accessed through Essentials Software
• Used by software and/or third party equipment (e.g., touch screen)
• Limited to transferring ASCII characters
• Login: lutron
• Password: integration
Notes:
–Up to four additional login and password values can be defined in the RadioRA® 2 PC software.
–Only one connection per login / password is allowed at a time.
UDP Multicast Messaging
• Used by the RadioRA® 2 PC software during device configuration and system programming
• There are no user modifiable settings for UDP messaging
•
•
•
•
•
33
Lutron integration protocol
USB
®
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
RadioRA® 2 (continued)
System Commands
DEVICE Commands
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Button 1–100
1–100
LED 1–100
101– 200
Available Actions
Press, Release
Set or Get LED state
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Set or Get LED State
9
0 = Off
1 = On
Example DEVICE Commands
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,4,1,3<CR><LF>
Release Button 1
#DEVICE,4,1,4<CR><LF>
Turn On LED 1.
#DEVICE,4,101,9<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,4,101,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
34
~DEVICE,4,101,9,1<CR><LF>
COM
#DEVICE, 1, Component Number, Action Number, Parameters
MUX
Integration ID (example)
MUX
9V
N/C
Power Repeater Link
DEVICE Command Formats
Operation
Wired
Test
1
2
3
4
Add
Integrate
RS232
Program / Integrate
Ethernet
Lutron integration protocol
®
USB
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
COM
MUX
9V
MUX
Power Repeater Link
N/C
RadioRA® 2 (continued)
System Commands (continued)
GROUP Commands
Wired
Test
1
2
3
4
Add
Integrate
RS232
Program / Integrate
Ethernet
GROUP Command Format
Operation
Integration ID (example)
?GROUP, 6, Action Number
Command
Use “GROUP Command-specific fields” tables
to complete these command fields.
GROUP Command-specific fields
Occupancy States:
Description
Occupied
3
Unoccupied
4
Unknown
Value
255
Action Numbers:
Action
Action Number
Get (?) Occupancy Group State
3
Example GROUP Messages
Operation
Command String
Query: ?GROUP, Integration ID, Action Number
What is Occ GROUP 1’s status? ?GROUP,1,3<CR><LF>
Response: ~ GROUP, Integration ID, Action Number, Parameters
Occ group 1 is occupied
~GROUP,1,3,3<CR><LF>
Occ group 1 is unknown
~GROUP,1,3,255<CR><LF>
35
Lutron integration protocol
USB
®
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
RadioRA® 2 (continued)
System Commands (continued)
MONITORING Commands
Wired
Test
COM
MUX
MUX
9V
N/C
Power Repeater Link
1
2
3
4
Add
Integrate
RS232
MONITORING Command Formats
Operation
#MONITORING, Monitoring Type, Action Number
Command
Use “MONITORING Command-specific fields”
tables to complete these command fields.
MONITORING Command-specific fields
Monitoring Type:
Description
Monitoring Type
Diagnostic Monitoring
1
Button Monitoring (if enabled, button actions will be reported)
3
LED Monitoring (if enabled, LED states will be reported)
4
Zone Monitoring (if enabled, zone levels will be reported, i.e. dimmer, shade, contact closure
output level)
5
Reply State (if disabled, all messages FROM the integration access point will cease)
11
Prompt State (if disabled, the prompt will not be printed to the terminal)
12
Set or Get State of All Monitoring (except Reply and Prompt)
255
Action Numbers:
Action
Action Number
Enable
1
Disable
2
Example MONITORING Commands
Operation
Command String
Execute: #MONITORING, Monitoring Type, Action Number
Disable Diagnostic Monitoring.
#MONITORING,1,2<CR><LF>
Enable Event Monitoring.
#MONITORING,2,1<CR><LF>
Query: ?MONITORING, Monitoring Type
Is Diagnostic Monitoring disabled?
?MONITORING,1<CR><LF>
Response: ~MONITORING, Monitoring Type, Action Number
Diagnostic Monitoring is disabled.
36
~MONITORING,1,2<CR><LF>
Program / Integrate
Ethernet
Lutron integration protocol
USB
®
Main Repeater
Repeater Status
1
M
2
3
4
Communication
RF
Setup
RadioRA® 2 (continued)
System Commands (continued)
TIMECLOCK Commands
Wired
Test
COM
MUX
MUX
9V
N/C
Power Repeater Link
1
2
3
4
Add
Integrate
RS232
Program / Integrate
Ethernet
TIMECLOCK Command Formats
Operation
Integration ID (example)
#TIMECLOCK, 4, Action Number, Parameters
Command
Use “TIMECLOCK Command-specific fields” tables
to complete these command fields.
TIMECLOCK Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) Current Timeclock
Mode 1
1
Mode
Get (?) Current Timeclock
Mode
1
None
Get (?) Sunrise Time
2
None
Get (?) Sunset Time
3
None
Get (?) Day’s Schedule
4
None
Execute (#) event
5
Index of the event to test. The index number of the first event
is 1; the second event is 2, and so on.
Enable/Disable Event
6
Event Index, Enable State (1 = Enable, 2 = Disable)
NOTE
1. In order to set the Timeclock Mode, the “mode” settings must first be determined using the ?help,#timeclock,1 command.
Example TIMECLOCK Messages
Operation
Command String
Execute: #TIMECLOCK, Integration ID, Action Number, Parameters
Execute the 3rd event of the time clock.
#TIMECLOCK,4,5,3<CR><LF>
Query: ?TIMECLOCK, Integration ID, Action Number
What is the sunrise time?
?TIMECLOCK,4,2<CR><LF>
Response: ~TIMECLOCK, Integration ID, Action Number, Parameters
The time the sun rises.
~TIMECLOCK,4,2,05:32<CR><LF>
37
Lutron integration protocol
®
Clear Connect® Gateway System
System Overview
The Clear Connect® Gateway System is a wireless multi-room control system for lights and shades.
The system is made up of repeaters, dimmers, keypads, and other devices. The Lutron® proven,
patented RF technology ensures reliable performance. With the Clear Connect® Gateway system,
you can: create the right ambience for varied activities, easily monitor and control your lights,
reduce energy usage, and increase safety in and around your home.
Clear Connect® System Device Compatibility Index:
Clear Connect®
Gateway System
Maestro® Dimmer
seeTouch® Keypad
Sivoia® QS Wireless Shade
Radio Powr SavrTM Sensor
38




Lutron integration protocol
®
Clear Connect® Gateway System (continued)
Integration Access Points
Models: NXB-CCG, NXB-CCG-K
Why Integrate with a Clear Connect® Gateway System?
• Integrates a Clear Connect® lighting control system with a PC or other digital equipment that
supports Ethernet TCP/IP communication.
• Allows monitoring and control of system devices. For example, the Translator can be used to
simulate button presses, report button presses, monitor LEDs, and control light levels of dimmers.
Integration Capabilities
• 100 “virtual” programmable buttons with LEDs (use DEVICE command).
Additional Commands
• PING commands are used to verify network connectivity.
39
Lutron integration protocol
®
Clear Connect® Gateway System (continued)
Integration Access Points (continued)
Connection Information
Provides an Ethernet connection to communicate with external equipment.
Ethernet
Configuring the control interface to communicate over a network takes not only knowledge of the
Clear Connect® Gateway System, but of networking as well. Installers with limited networking
knowledge are advised to contact a networking professional before attempting to connect a
control interface through a network. The information below will help an installer communicate the
control interface configurations to a network professional.
The installer will make any necessary changes to the control interface using the Integrated
Web Configuration tool and the network professional can make any necessary changes to the
networking equipment.
•
•
•
•
•
Single Ethernet Port
IEEE® 802.3 Auto-Sensing 10BaseT / 100BaseTX
Supports MDI/MDIX auto-crossover (no crossover cable needed).
Female 8P8C “Computer RJ-45” socket
Green “Connect” LED, Amber “Activity” LED
Use Cat 5 cabling or better
•
•
•
•
TCP / IP Settings
DHCP (dynamic) or static configuration <factory default = DHCP>
IP Address: <static or dynamic configuration>
Subnet Mask: <static or dynamic configuration>
Gateway: <static or dynamic configuration>
Protocols Used for Integration
• Raw socket (Telnet port)
• SSH
Server
• Up to 10 usernames can be created. Each username supports multiple simultaneous connections
• Used by software and/or third party equipment (i.e. touch screen)
• Limited to transferring ASCII characters
• Raw Socket port number is 23; can be changed in the Web Configuration tool
• SSH port number is 22; cannot be changed
• Default Integration Login information
NXB-CCG / NXB-CCG-K:
– Login: amx
– Password: clearconnect
Continued on next page…
40
Lutron integration protocol
®
Clear Connect® Gateway System (continued)
Integration Access Points (continued)
Connection Information (continued)
System Configuration
• Default web admin information
NXB-CCG / NXB-CCG-K:
– Login: admin
– Password: 1988
• XML file extraction is supported
a) Browsing to “/xml” after logging in will return the XML data for the system
b) B
rowsing to “/xml?login=<user>&password=<password>” will return the XML data without
first having to log in
Note: The “login” info can use either web login or integration login credentials.
• ZeroConf discovery of the CCT device
a) The device will present itself as:
– NXB-CCG or NXB-CCG-K will present itself as
“NXB-CCG-<Numeric Portion of Serial Number>”
b) The domain suffix is displayed next to the hostname in the Web Configuration tool
41
Lutron integration protocol
®
Clear Connect® Gateway System (continued)
System Commands
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 1, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Button 1–100
1–100
LED 1–100
101– 200
Available Actions
Press, Release
Set or Get LED state
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Set or Get LED State
9
0 = Off
1 = On
Example DEVICE Commands
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,4,1,3<CR><LF>
Release Button. 1
#DEVICE,4,1,4<CR><LF>
Turn On LED 1.
#DEVICE,4,101,9<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,4,101,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
42
~DEVICE,4,101,9,1<CR><LF>
Lutron integration protocol
®
Clear Connect® Gateway System (continued)
System Commands (continued)
GROUP Commands
GROUP Command Format
Operation
Integration ID (example)
?GROUP, 6, Action Number
Command
Use “GROUP Command-specific fields” tables
to complete these command fields.
GROUP Command-specific fields
Occupancy States:
Description
Occupied
3
Unoccupied
4
Unknown
Value
255
Action Numbers:
Action
Action Number
Get (?) Occupancy Group State
3
Example GROUP Messages
Operation
Command String
Query: ?GROUP, Integration ID, Action Number
What is Occ GROUP 1’s status? ?GROUP,1,3<CR><LF>
Response: ~ GROUP, Integration ID, Action Number, Parameters
Occ group 1 is occupied
~GROUP,1,3,3<CR><LF>
Occ group 1 is unknown
~GROUP,1,3,255<CR><LF>
43
Lutron integration protocol
®
Clear Connect® Gateway System (continued)
System Commands (continued)
PING Commands
PING Command Formats
Operation
#PING
Command
Example PING Command
Operation
Command String
Execute: #PING
Ping to verify connectivity
#PING
Response: ~PING
Connection is established
44
~PING
Lutron integration protocol
®
Quantum®
System Overview
The Quantum® system is the Lutron® premier commercial lighting control system. It allows the
control and monitoring of individual devices and outputs as well as allowing control of entire areas,
shade groups or other portions of the system. The Quantum® system includes QS devices such as
the GRAFIK Eye® QS and Sivoia® QS shades as well as Lutron® EcoSystem® ballasts and GRAFIKTM
dimming panels. When integrating with a Quantum® system the integrator gets additional access
to portions of a the system not available when using products in stand-alone mode, particularly
the ability to activate scenes on an area-by-area basis and to control the position of and activate
presets on entire groups of shades at once.
Quantum® System Device Compatibility Index:
Quantum®
GRAFIK Eye® QS
seeTouch® QS
Sivoia® QS Shade
QS Input / Output Interface
Energi Savr NodeTM QS DALI®
Energi Savr NodeTM QS EcoSystem® (Int’l)
Energi Savr NodeTM QS 0 –10 V/Softswitch® (Int’l)
Energi Savr NodeTM QS Phase Adaptive (Int’l)
Energi Savr NodeTM QS EcoSystem®
Energi Savr NodeTM QS 0 –10 V/Softswitch®
•
•
•
•
•
•










Why Integrate with a Quantum® System
Compatible with Quantum® system version 1.7 or higher
Gain access to system-only information
Activate System Area scenes
Set levels for System Outputs
Activate System Shade Group presets
View and modify parameters of a Quantum® system, such as time, date, time zone, etc.
Command Types
Operation characters will be followed by command types:
• AREA allows control of an area in the Quantum® system. Scenes can be activated, occupancy
monitored etc.
• SHADEGRP allows control of shade groups in the Quantum® system. Shade Groups are
collections of shades that operate in unison
• OUTPUT allows control and monitoring of a Quantum® system output group such as a lighting
zone or closure output.
• SYSTEM allows setting and controlling system parameters and variables *
• HELP displays usage information for the supported commands and their corresponding actions
• INTEGRATION ID allows querying integration IDs of devices in the system
* Load Shed commands available only on Quantum® version 2.0 and higher.
45
Lutron integration protocol
®
Quantum® (continued)
Integration Access Points
Network Interface
Model: QSE-CI-NWK-E
Why Integrate with a QSE-CI-NWK-E?
• Integrates a QS lighting control system with a PC or other digital equipment that supports RS232
or Ethernet TCP/IP connection.
• Allows monitor and control of system devices. For example, the QSE-CI-NWK-E can be used to
simulate button presses, report button presses, monitor LEDs, and control light levels.
•
•
•
•
•
•
Additional Commands
MONITORING specifies what type of messages the system will report
ETHERNET modifies the Ethernet configurations of the QSE-CI-NWK-E
RESET restarts the QSE-CI-NWK-E or restores it to factory defaults
INTEGRATION ID assigns IDs to devices, so that they may be referred to in a more logical fashion
DETAILS returns information about a QS device
ERROR reports syntax errors in an integration string command or query
46
Lutron integration protocol
®
Quantum® (continued)
Integration Access Points (continued)
•
•
•
•
•
Connection Information
Provides an RS232 and Ethernet connection to communicate with external equipment.
RS232
The RS232 connection has the following communication settings:
Baud Rate 9600/19200/38400/115200 (set via dipswitch on unit)
8 data bits
No parity bit
1 stop bit
No flow control
Ethernet
Configuring the control interface to communicate over a network takes not only knowledge of
the Quantum® system, but of networking as well. Installers with limited networking knowledge
are advised to contact a networking professional before attempting to connect a QSE-CI-NWK-E
through a network. The information below will help an installer communicate the QSE-CI-NWK-E
configurations to a network professional.
The installer will make any necessary changes to the control interface using the Lutron® DeviceIP or
Quantum® PC software tool and the network professional can make any necessary changes to the
networking equipment.
•
•
•
•
•
Single Ethernet Port
IEEE® 802.3 Auto-Sensing 10BaseT / 100BaseTX
Supports MDI/MDIX auto-crossover (no crossover cable needed).
Female 8P8C “Computer RJ-45” socket
Green “Connect” LED, Amber “Activity” LED
Use Cat 5 cabling or better
•
•
•
TCP / IP Settings
IP Address: <static default = 192.168.250.1>
Subnet Mask: <static default = 255.255.255.0>
Gateway: <static default = 0.0.0.0>
Protocols Used for Integration
• TELNET
•
•
•
•
•
Telnet Server
Used by third party equipment (e.g., touch screen)
Limited to transferring ASCII characters
Telnet Port number is 23
Login #1: nwk
Login #2: nwk2
47
Lutron integration protocol
®
Quantum® (continued)
System Commands
ETHERNET Commands
ETHERNET Command Formats
Operation
#ETHERNET, Configuration Number, Parameters
Command
Use “ETHERNET Command-specific fields” tables
to complete these command fields.
ETHERNET Command-specific fields
Configuration Numbers:
Description
Configuration Number
Parameters
Set IP Address
0
IP Address (XXX.XXX.XXX.XXX)
Set Gateway Address
1
IP Address (XXX.XXX.XXX.XXX)
Set Subnet Mask
2
IP Address (XXX.XXX.XXX.XXX)
Change Login Info
3
User (1 or 2),
Old Login,
New Login
Example ETHERNET Commands
Operation
Command String
Execute: #ETHERNET, Configuration Number, Parameters
Set IP Address to 192.168.250.1
#ETHERNET,0,192.168.250.1<CR><LF>
Set Gateway Address to 10.2.4.1
#ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET, Configuration Number, Parameters
What is the IP Address?
?ETHERNET,0<CR><LF>
What is the Login Information for user 1?
?ETHERNET,3,1<CR><LF>
What is the Login Information for ALL users?
?ETHERNET,3,0<CR><LF> (Note: 0 = ALL)
Response: ~ETHERNET, Integration ID, Configuration Number, Parameters
The IP Address is 192.168.250.1
48
~ETHERNET,0,192.168.250.1<CR><LF>
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
INTEGRATION ID Commands
INTEGRATION ID Command Formats
Operation
?INTEGRATIONID, Action Number, Parameters
Command
Use “INTEGRATIONID Command-specific fields” tables
to complete these command fields.
INTEGRATION ID Command-specific fields
Action Numbers and Parameters:
Description
Action Number
Parameters
Get Integration ID for a Serial
Number
1
Serial Number: 8 character HEX serial number of the device;
Integration ID: The integration ID to be assigned.
Get Info from ID
3
Integration ID = The Integration ID that information is desired for.
Note: If this field is left blank, all integration IDs will be printed.
Example INTEGRATION ID Commands
Operation
Command String
Execute: ?INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
~INTEGRATIONID,1,5678EFEF,1<CR><LF>
Execute: ?INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID command
?INTEGRATIONID,3,1<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID command
~INTEGRATIONID,3,1,DEVICE,5678EFEF<CR><LF>
49
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
RESET Commands
RESET Command Formats
Operation
#RESET, Action Number
Command
Use “RESET Command-specific fields” tables
to complete these command fields.
RESET Command-specific fields
Action Numbers:
Action
Action Number
Restart the device
0
Restore to factory defaults
1
Example RESET Commands
Operation
Command String
Execute: #RESET, Action Number
Restart the NWK
#RESET,0<CR><LF>
Restore NWK to factory defaults
#RESET,1<CR><LF>
50
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
AREA Commands
AREA Command Formats
Operation
Integration ID (example)
#AREA 1, 2, 2, Action Number, Parameters
Command
Use “AREA Command-specific fields” tables
to complete these command fields.
NOTES
1. AREA can be used to control only those areas of a Quantum® system that have been assigned to a particular integration
access point. Please refer to the Q-DesignTM software (Integration Tab) or Quantum® Integration Report for details of what
areas are available for control and monitoring.
2. AREA commands cannot be sent to areas that contain other areas, such as a floor or an entire building.
AREA Command-specific fields
Action Numbers and Parameters:
Action
Action Number Parameters
Set (#) Area Level
1
Start Raising 4
Start Lowering 4
Stop Raising / Lowering
Set or Get Current Scene
Set or Get Daylighting Mode
2
3
4
6
7
Get Occupancy State
8
Set or Get Occupancy Mode
9
Get or Set Occupied Level or Scene
Get or Set Unoccupied Level or Scene
Get or Set HyperionTM Shadow Sensor Override
State9
12
13
26
Get or Set HyperionTM Brightness Sensor
Override State9
27
Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
None
None
None
Scene Number 5 = 0–326
1 = Active
2 = Inactive
1 = Unknown
2 = Inactive
3 = Occupied
4 = Unoccupied
1 = Occupancy and Vacancy 7
2 = Vacancy 7
3 = Not Applicable 8
4 = Inactive
Level = 0–100; 200–232 for Scene Number = 0–32
Level = 0–100; 200–232 for Scene Number = 0–32
0 = Disable
1 = Enable
2 = Mixed (Get Only)
0 = Disable
1 = Enable
2 = Mixed (Get Only)
NOTES
1. The Level is accepted as a percentage.
2. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter-second. For example, if a fade time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
4. When a Raise/Lower command is issued, the area’s level will continue to go towards high end/low end until a Stop
command is received.
5. Scene 0 is the Off Scene.
6. Scenes 17 – 32 available only on Slider.
7. If After Hours is used in an area, setting the area’s Occupancy Mode to “Occupancy and Vacancy” or “Vacancy” will
activate After Hours.
8. The area will report “Not Applicable” as its Occupancy Mode if the area does not have occupancy sensors and if After
Hours is not used.
9.Quantum® 2.7 and higher.
51
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
AREA Commands (continued)
Example AREA Messages
Operation
Command String
Execute: #AREA, Integration ID, Action Number, Parameters
Set area level to 75% (Fade = 4 sec, Delay = 2 sec)
#AREA,2,1,70,4,2<CR><LF>
Lower Area
#AREA,2,3<CR><LF>
Query: ?AREA, Integration ID, Action Number
Is the area occupied?
?AREA,2,8<CR><LF>
What is the current active scene?
?AREA,2,6<CR><LF>
Response: ~AREA, Integration ID, Action Number, Parameters
The area is currently occupied
~AREA,2,8,3<CR><LF>
Area Scene 2 is currently active
~AREA,2,6,2<CR><LF>
52
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
SHADEGRP Commands
SHADEGRP Command Formats
Operation
Integration ID (example)
#SHADEGRP 1, 2, Action Number, Parameters
Command
Use “SHADEGRP Command-specific fields” tables
to complete these command fields.
NOTE
1. SHADEGRP can be used to control only those shade groups of a Quantum® system that have been assigned to a
particular integration access point. Please refer to the Q-DesignTM software (Integration Tab) or Quantum® Integration
Report for details of what shade groups are available for control and monitoring.
SHADEGRP Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) Shade Group Level
1
Level 1 = 0–100 or 0.00–100.00
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Start Raising 4
2
None
3
None
Stop Raising / Lowering
4
None
Set or Get Current Preset
6
Preset Number 5 = 0–30
Start
Lowering 4
NOTES
1. The Level is accepted as a percentage, where 100% is fully open and 0% is fully closed.
2. The Delay time is optional. When not used, the system will use a zero-second delay. The minimum delay time is
0 seconds. The maximum delay time is 4 hours.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a delay time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
4. When a Raise / Lower command is issued, the shade group’s level will continue to go towards open / close until a Stop
command is received.
5. Preset 0 is the Open Preset and Preset 30 is the Closed Preset.
Example SHADEGRP Messages
Operation
Command String
Execute: #SHADEGRP, Integration ID, Action Number, Parameters
Set shade group to 70% (Delay = 2 sec)
#SHADEGRP,2,1,70,2<CR><LF>
Lower shade group.
#SHADEGRP,2,3<CR><LF>
Query: ?SHADEGRP, Integration ID, Action Number
What is the current active preset?
?SHADEGRP,2,6<CR><LF>
Response: ~SHADEGRP, Integration ID, Action Number, Parameters
Shade group Preset 2 is currently active.
~SHADEGRP,2,6,2<CR><LF>
53
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT 1, 2, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
NOTE
1. OUTPUT commands can be used to control system lighting zones, contact closed outputs and AC Motor Loads.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Get (?) Output Level
1
Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Start Raising 4
2
None
3
None
Stop Raising / Lowering 4
4
None
Pulse
6
Pulse 5 time in: SS.ss 3, SS, MM:SS, or HH:MM:SS, or
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Set DMX color / level settings 6
17
Color / level index: 0–255
0.00–100.00 5
Motor Jog Raise 6
18
None 7
Motor Jog Lower 6
19
None 7
Motor 4-Stage Jog Raise 6
20
None 7
Motor 4-Stage Jog Lower 6
21
None 7
Start
Lowering 4
NOTES
1. The Level is taken as a percentage.
2. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours. For shade outputs,
the Fade parameter has no effect (since shades have fixed speeds) but it is required when specifying an optional delay.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
4. When a Raise / Lower command is issued, the output’s level will continue to go towards high end / low end until a Stop
command is received.
5. The default time is one second.
6. Not supported in RadioRA® 2.
7.Quantum® 2.5 and up.
54
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
OUTPUT Commands (continued)
Example OUTPUT Messages
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set output level to 70% (Fade = 4 sec, Delay = 2 sec)
#OUTPUT,2,1,70,4,2<CR><LF>
Raise Output
#OUTPUT,2,2<CR><LF>
Query: ?OUTPUT, Integration ID
What is the current output level?
?OUTPUT,2<CR><LF>
Response: ~OUTPUT, Integration ID, Action Number, Parameters 1
Output level is set to 48%.
~OUTPUT,2,1,48<CR><LF>
NOTE
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours. For shade outputs,
the Fade parameter has no effect (since shades have fixed speeds) but it is required when specifying an optional delay.
55
Lutron integration protocol
®
Quantum® (continued)
System Commands (continued)
SYSVAR Commands 1
SYSVAR Command Formats
Operation
#SYSVAR,2,Action Number, Parameters
Command
Use “SYSVAR Command-specific fields” tables
to complete these command fields.
NOTE
1. SYSVAR Commands available only on Quantum® version 2.5 or higher.
SYSVAR Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
1
State number
Set (#) or Get (?) the state
of a given variable
Example SYSVAR Messages
Operation
Command String
Execute: #SYSVAR, Integration ID, Action Number, Parameters
Set the variable state to the third state
#SYSVAR,2,1,3<CR><LF>
Query: ?SYSVAR, Integration ID, Action Number
What is the state of the variable?
?SYSVAR,2,1<CR><LF>
Response: ~SYSVAR, Integration ID, Action Number, Parameters
The variable is in the third state.
56
~SYSVAR,2,1,3<CR><LF>
Lutron integration protocol
®
HomeWorks® QS
System Overview
HomeWorks® QS is Lutron’s premier total home control system. It allows control and monitoring of
lights, shades, HVAC, sensors and appliances. The HomeWorks® QS system includes QS devices,
RF devices and power panels that provide solutions for new construction and retrofit projects of
any size.
HomeWorks® QS (HomeWorks® QS) System Device Compatibility Index:
HomeWorks QS®
HomeWorks® QS RF and Wired seeTouch® Keypad
Sivoia® QS and RF Shade
HomeWorks® QS RF and Wired Maestro® Control
HomeWorks® QS Hybrid Keypad
HomeWorks® QS Dynamic Keypad
HomeWorks® QS Tabletop seeTouch® Keypad
HVAC Controller
HomeWorks® QS Plug-in Module
HomeWorks® QS Visor Control Receiver
QS Input / Output Interface
HomeWorks® QS Wallbox Power Module
GRAFIK Eye® QS
Pico® Wireless Control
Radio Powr SavrTM Sensor
Remote Power Module
Adaptive Power Module (Int’l)
EcoSystem® Adaptive Power Module (Int’l)
DALI® Power Module (Int’l)
0 –10 V/Softswitch® Power Module (Int’l)
Motor Module (Int’l)




















57
Lutron integration protocol
®
HomeWorks® QS (continued)
System Overview (continued)
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Command Types
The following is a list of supported command types. Details on certain device-specific types (e.g.,
DEVICE, HVAC) are located in the individual device section of this manual.
Operation characters will be followed by command types.
DEVICE allows control and monitoring of device inputs such as button presses and contact
closure inputs
OUTPUT allows control and monitoring of device outputs such as dimmers and contact closure
outputs
SHADEGRP allows control of shades in the HomeWorks® QS system. Shade groups are
collections of shades that operate in unison
MONITORING specifies the type of messages that the system will report
HVAC allows control and monitoring of Lutron® HVAC equipment
TIMECLOCK allows control (enable/disable) and monitoring of system timeclocks
SYSVAR allows control and monitoring of system variables
AREA allows control and monitoring of an area (e.g., activating area Scenes, monitoring
occupancy)
ERROR displays responses to invalid commands
HELP displays usage information for the supported commands and their corresponding actions
SYSTEM allows setting and controlling system parameters and variables
ETHERNET modifies the Ethernet configuration of the HomeWorks® QS processor
INTEGRATIONID gets information of the integration id or serial number of a device
RESET resets the HomeWorks® QS processor
58
Lutron integration protocol
®
HomeWorks® QS (continued)
Integration Access Points
HomeWorks® QS Processor
Model: HQP6-2
•
•
•
•
•
•
•
•
•
•
•
•
Why Integrate with a HomeWorks® QS Processor?
Integrating with a HomeWorks® QS Processor provides integration over Ethernet without the need
for additional equipment or interfaces.
RS-232 integration can also be accomplished using third party Ethernet to RS-232 adapters.
Integrating directly with the HomeWorks® QS Processor also provides the greatest bandwidth port
into the HomeWorks® QS system.
Integration IDs are automatically generated by the HomeWorks® QS software application (e.g., for
devices, outputs, shadegroups, timeclocks). Integration IDs can be removed to reduce processing
and traffic of unwanted messages.
Phantom Keypads allow for integration functionality to be organized on various virtual keypads that
have unlimited buttons and do not count towards link device count limits.
Integration Capabilities
Control and monitoring of output devices such as dimmers, the GRAFIK Eye®, shades and contact
closure outputs
Control and monitoring of physical or phantom keypad buttons and button status LEDs
Control and monitoring of Lutron® HVAC equipment
Control and monitoring of individual timeclocks
Control and monitoring of state variables
Monitoring of occupancy sensors
Control and monitoring of areas to activate scenes and monitor occupancy
59
Lutron integration protocol
®
HomeWorks® QS (continued)
Integration Access Points (continued)
Connection Information
Ethernet
Configuring the HomeWorks® QS processor to communicate over a network takes not only
knowledge of the HomeWorks® QS system, but of networking as well. Installers with limited
networking knowledge are advised to contact a networking professional before attempting to
connect a HomeWorks® QS processor through a network.
The installer will make any necessary configuration changes to the HomeWorks® QS processor
using the HomeWorks® QS Design Software Application and the network professional can make
any necessary changes to the networking equipment.
•
•
•
•
•
•
Dual Ethernet Port
IEEE® 802.3 Auto-Sensing 10BaseT / 100BaseTX
Supports MDI/MDIX auto-crossover (no crossover cable needed).
Female 8P8C “Computer RJ-45” socket
Green “Connect” LED, Amber “Activity” LED
Use Cat 5 cabling or better
2 Port 10/100 Ethernet Switch
TCP / IP Settings
• IP Address: Address at which the processor can be reached for integration. In most instances
when integrating to a processor, DHCP should be disabled and a static IP address should be
assigned to prevent the processor from changing IP addresses.
• Subnet Mask: In conjunction with the IP address, it defines the subnet on which the processor
communicates. Processors will be able to integrate only with devices on the same subnet.
• Gateway: Used in instances where the processor needs to communicate to the internet. Should be
set to the IP address of the device on the network connected directly to the internet—typically, the
home router.
Protocols Used for Integration
• TELNET
•
•
•
•
•
Telnet Server
Used by third party equipment (e.g., touch screen)
Used by Lutron® mobile devices (e.g., iPad and iPhone)
Limited to transferring ASCII characters
Telnet Port number is 23
Logins: Defined in the HomeWorks® QS software application
RS232
The HomeWorks® QS Processor does not have native support for RS232. An Ethernet to RS232
adapter can be used and configured to provide RS232 integration directly from the Processor if
needed.
iPhone and iPad are trademarks of Apple, Inc., registered in the U.S. and other countries.
60
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT 1, 2, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
NOTE
1. OUTPUT commands can be used to control system lighting zones, individual shades, and contact closed outputs.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number Parameters
Set (#) or Get (?) Output Level
1
Start Raising 4
Start Lowering 4
Stop Raising / Lowering 4
Flash (#) or Get (?) Flash Frequency
2
3
4
5
Set Pulse CCO (#)
6
Set (#) Venetian Shade Tilt to a
specified level
9
Set (#) Venetian Shade Tilt and Lift to a
specified level
10
Raise (#) Tilt Output Level
Lower (#) Tilt Output Level
Stop (#) Raise / Lower Tilt Output Level
Raise(#) Lift Output Level
Lower(#) Lift Output Level
Stop (#) Raise / Lower Lift Output Level
Get Horizontal Sheer Shade Region
11
12
13
14
15
16
28
Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
None
None
None
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Pulse 5 time in: SS.ss 3, SS, MM:SS, or HH:MM:SS,
or Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Tilt level in % = 0.00–100 6
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Lift 1 = 0–100 or 0.00–100.00
Tilt 1 = 0–1006 or 0.00–100.006
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
None
None
None
None
None
None
Regions: 0 = Lift, 1 = Tilt
NOTES
1. The Level/Lift/Tilt is taken as a percentage.
2. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours. For shade outputs,
the Fade parameter has no effect (since shades have fixed speeds) but it is required when specifying an optional delay.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
4. When a Raise / Lower command is issued, the output’s level will continue to go towards high end / low end until a Stop
command is received.
5. The default time is one second.
6. 50 for Horizontal Sheer Blinds.
61
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
OUTPUT Commands (continued)
Example OUTPUT Messages
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set output level to 70% (Fade = 4 sec, Delay = 2 sec)
#OUTPUT,2,1,70,4,2<CR><LF>
Raise Output
#OUTPUT,2,2<CR><LF>
Query: ?OUTPUT, Integration ID
What is the current output level?
Response 1:
?OUTPUT,2<CR><LF>
~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 48%.
~OUTPUT,2,1,48<CR><LF>
NOTE
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours. For shade outputs,
the Fade parameter has no effect (since shades have fixed speeds) but it is required when specifying an optional delay.
62
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
SHADEGRP Commands
SHADEGRP Command Formats
Operation
Integration ID (example)
#SHADEGRP, 2, Action Number, Parameters
Command
Use “SHADEGRP Command-specific fields” tables
to complete these command fields.
SHADEGRP Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set (#) or Get (?) Shade Group
Level
Start Raising 3
Start Lowering 3
Stop Raising / Lowering
Set (#) or Get (?) Current Preset
Set (#) Venetian Tilt
1
2
3
4
6
14
Set (#) Lift and Tilt for venetians
15
Raise Venetian Tilt 3
Lower Venetian Tilt 3
Stop Venetian Tilt 3
Raise Venetian Lift 3
Lower Venetian Lift 3
Stop Venetian Lift 3
Get Horizontal Sheer Shade Region
16
17
18
19
20
21
28
Parameters
Level 1 = 0–100 or 0.00–100.00
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
None
None
None
Preset Number 4 = 0–30
Level 5 = 0–100 6 or 0.00–100.00 6
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Lift 5 = 0–100 or 0.00–100.00
Tilt 5 = 0–100 6 or 0.00–100.00 6
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
None
None
None
None
None
None
Lift = 0
Tilt = 1
NOTES
1. The Fade and Delay time are optional. For shades, the Fade parameter has no effect (since shades have fixed speeds)
but it is required when specifying an optional delay. When not used, the system will use a zero-second delay. The
minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a delay time is specified
as 1.45 seconds, a value of 1.25 seconds will be used.
3. When a Raise / Lower command is issued, the shade group’s level will continue to go towards open / close until a Stop
command is received.
4. Preset 0 is the Open Preset and Preset 30 is the Closed Preset.
5. The Level is accepted as a percentage, where 100% is fully open and 0% is fully closed.
6. 50 for Horizontal Sheer Blinds.
63
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
SHADEGRP Commands (continued)
Example SHADEGRP Messages
Operation
Command String
Execute: #SHADEGRP, Integration ID, Action Number, Parameters
Set shade group to 70% (Delay = 2 sec).
#SHADEGRP,2,1,70,2<CR><LF>
Lower shade group.
#SHADEGRP,2,3<CR><LF>
Query: ?SHADEGRP, Integration ID, Action Number
What is the current active preset?
?SHADEGRP,2,6<CR><LF>
Response: ~SHADEGRP, Integration ID, Action Number, Parameters
Shade group Preset 2 is currently active.
64
~SHADEGRP,2,6,2<CR><LF>
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
TIMECLOCK Commands
TIMECLOCK Command Formats
Operation
#TIMECLOCK,2,Action Number, Parameters
Command
Use “TIMECLOCK Command-specific fields” tables
to complete these command fields.
TIMECLOCK Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Get (?) Sunrise Time
2
None
Get (?) Sunset Time
3
None
Get (?) Day’s Schedule
4
None
Execute (#) event
5
Index of the event to test. The index number of the first event
is 1; the second event is 2, and so on.
Enable/Disable Event
6
Event Index, Enable State (1 = Enable, 2 = Disable)
Example TIMECLOCK Messages
Operation
Command String
Execute: #TIMECLOCK, Integration ID, Action Number, Parameters
Execute the 3rd event of the timeclock.
#TIMECLOCK,2,5,3<CR><LF>
Query: ?TIMECLOCK, Integration ID, Action Number
What is the sunrise time?
?TIMECLOCK,2,2<CR><LF>
Response: ~TIMECLOCK, Integration ID, Action Number, Parameters
The time the sun rises.
~TIMECLOCK,2,2,05:32<CR><LF>
65
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
SYSVAR Commands
SYSVAR Command Formats
Operation
#SYSVAR,2,Action Number, Parameters
Command
Use “SYSVAR Command-specific fields” tables
to complete these command fields.
SYSVAR Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
1
State number
Set (#) or Get (?) the state
of a given variable
Example SYSVAR Messages
Operation
Command String
Execute: #SYSVAR, Integration ID, Action Number, Parameters
Set the variable state to the third state.
#SYSVAR,2,1,3<CR><LF>
Query: ?SYSVAR, Integration ID, Action Number
What is the state of the variable?
?SYSVAR,2,1<CR><LF>
Response: ~SYSVAR, Integration ID, Action Number, Parameters
The variable is in the third state.
66
~SYSVAR,2,1,3<CR><LF>
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
AREA Commands
AREA Command Formats
Operation
Integration ID (example)
#AREA 1, 2, Action Number, Parameters
Command
Use “AREA Command-specific fields” tables
to complete these command fields.
NOTE
1. AREA commands cannot be sent to areas that contain other areas, such as a floor or an entire building.
AREA Command-specific fields
Action Numbers and Parameters:
Action
Get (?) Occupancy State
Action Number
8
Parameters
3 = Occupied
4 = Unoccupied
Example AREA Messages
Operation
Command String
Execute: #AREA, Integration ID, Action Number, Parameters
Set area level to 75% (Fade = 4 sec, Delay = 2 sec)
#AREA,2,1,70,4,2<CR><LF>
Lower Area.
#AREA,2,3<CR><LF>
Query: ?AREA, Integration ID, Action Number
Is the area occupied?
?AREA,2,8<CR><LF>
What is the current active scene?
?AREA,2,6<CR><LF>
Response: ~AREA, Integration ID, Action Number, Parameters
The area is currently occupied.
~AREA,2,8,3<CR><LF>
Area Scene 2 is currently active.
~AREA,2,6,2<CR><LF>
67
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
ETHERNET Commands
ETHERNET Command Formats
Operation
#ETHERNET, Configuration Number, Parameters
Command
Use “ETHERNET Command-specific fields” tables
to complete these command fields.
ETHERNET Command-specific fields
Configuration Number and Parameters:
Description
Configuration Number
Parameters
Get (?) or Set(#) IP Address
0
IP Address (XXX.XXX.XXX.XXX)
Get (?) or Set (#) Gateway
Address
1
IP Address (XXX.XXX.XXX.XXX)
Get (?) or Set (#) Subnet Mask
2
IP Address (XXX.XXX.XXX.XXX)
Get (?) DHCP
4
None
Get (?) or Set (#) Multicast
Address
5
IP Address (XXX.XXX.XXX.XXX)
Example ETHERNET Commands
Operation
Command String
Execute: #ETHERNET, Configuration Number, Parameters
Set IP Address to 192.168.250.1
#ETHERNET,0,192.168.250.1<CR><LF>
Set Gateway Address to 10.2.4.1
#ETHERNET,1,10.2.4.1<CR><LF>
Query: ?ETHERNET, Configuration Number, Parameters
What is the IP Address?
?ETHERNET,0<CR><LF>
Response: ~DEVICE, Integration ID, Configuration Number, Parameters
The IP Address is 192.168.250.1
68
~ETHERNET,0=,192.168.250.1<CR><LF>
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
INTEGRATION ID Commands
INTEGRATION ID Command Formats
Operation
#INTEGRATIONID, Action Number, Parameters
Command
Use “INTEGRATIONID Command-specific fields” tables
to complete these command fields.
INTEGRATION ID Command-specific fields
Action Numbers and Parameters:
Description
Action Number
Parameters
Get (?) Integration ID for a Serial
Number
1
Serial Number = 8 character HEX serial number of the device
Integration ID = The integration ID to be assigned.
Get (?) Info from ID
3
Integration ID
Note: If this field is left blank, all integration IDs will be printed.
Example INTEGRATION ID Commands
Operation
Command String
Query: ?INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
?INTEGRATIONID,1,5678EFEF<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get the Integration ID for a serial number
~INTEGRATIONID,1,5678EFEF,1<CR><LF>
Query: ?INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID
command
?INTEGRATIONID,3,1<CR><LF>
Response: ~INTEGRATIONID, Action Number, Parameters
Get information about an Integration ID
command
~INTEGRATIONID,3,1,DEVICE,5678EFEF<CR><LF>
69
Lutron integration protocol
®
HomeWorks® QS (continued)
System Commands (continued)
RESET Commands
RESET Command Formats
Operation
#RESET, Action Number
Command
Use “RESET Command-specific fields” tables
to complete these command fields.
RESET Command-specific fields
Action Numbers:
Action
Resets the HomeWorks® QS processor
Action Number
0
Example RESET Commands
Operation
Command String
Execute: #RESET, Action Number
Reset the HomeWorks® QS processor
70
#RESET,0<CR><LF>
Lutron integration protocol
®
GRAFIK Eye® QS
Main Unit
Models: QSGR-, QSGRJ-, QSGRK-, QSGRM-, QSGRN-, QSGRQ-
1
2
3
4
5
6
Scene 1
Fade Time
03 Seconds
OK
Why Integrate with a GRAFIK Eye® QS?
• Control individual lights and scenes
• Query current scene and light levels
• Control LEDs of unprogrammed buttons
Integration Capabilities
•16 scenes and up to 24 controllable outputs (output count depends on model)
Supported Command Types
• DEVICE allows control and monitoring of buttons, LEDs and scenes
•OUTPUT allows control and monitoring of the dimmer device output
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
GRAFIK Eye® QS Main Unit




71
Lutron integration protocol
®
1
2
3
4
5
6
Scene 1
Fade Time
03 Seconds
OK
GRAFIK Eye® QS (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number Available Actions
Zone 1 Controller – Zone 24 Controller
Scene 1 Button
Scene 2 Button
Scene 3 Button
Scene 4 Button
Scene Off Button
Shade Column 1 Open
Shade Column 1 Preset 1
Shade Column 1 Close
Shade Column 1 Lower
Shade Column 1 Raise
Shade Column 2 Open
Shade Column 2 Preset 1
Shade Column 2 Close
Shade Column 2 Lower
Shade Column 2 Raise
Shade Column 3 Open
Shade Column 3 Preset 1
Shade Column 3 Close
Shade Column 3 Lower
Shade Column 3 Raise
1–24
70
71
76
77
83
38
39
40
41
47
44
45
46
52
53
50
51
56
57
58
Scene Controller
141
Scene 1 LED1
Scene 2 LED1
Scene 3 LED1
Scene 4 LED1
Scene Off LED1
Local CCI
Timeclock Controller
Wireless Occupancy Sensor 1 – 30
EcoSystem® Ballast Occupancy Sensor 1 – 64
201
210
219
228
237
163
166
500 – 529
700 – 763
Raise, Lower, Stop, Set Light Level
Press, Release (Scenes Activate on “Press”)
Press, Release (Scenes Activate on “Press”)
Press, Release (Scenes Activate on “Press”)
Press, Release (Scenes Activate on “Press”)
Press, Release
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Press, Release (Shades React on “Release”)
Set Current Scene, Set Zone Lock,
Set Scene Lock, Set Sequence State,
Raise, Lower, Stop, Scene Save
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Report (~) Occupied, Report (~) Unoccupied
Enable/Disable, Query Status
Report (~) Occupied, Report (~) Unoccupied
Report (~) Occupied, Report (~) Unoccupied
NOTE
1. Not supported in QS Standalone.
Continued on next page…
72
Lutron integration protocol
®
1
2
3
4
5
6
Scene 1
Fade Time
03 Seconds
OK
GRAFIK Eye® QS (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Component Numbers (continued):
Component
Component Number
LED1
Shade Column 1 Open
Shade Column 1 Preset 1 LED1
Shade Column 1 Close LED1
Shade Column 2 Open LED1
Shade Column 2 Preset 1 LED1
Shade Column 2 Close LED1
Shade Column 3 Open LED1
Shade Column 3 Preset 1 LED1
Shade Column 3 Close LED1
174
175
211
183
184
220
192
193
229
Available Actions
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
Get (?) LED state
NOTE
1. Not supported in QS Standalone.
Action Numbers and Parameters:
Action
Action Number Parameters
Press/Occupied
Release/Unoccupied
Set Current Scene 1,2
Set (#) or Get (?) LED State 3
3
4
7
9
Scene Save
Get/Set Light Level 4,5
12
14
Set Zone Lock 8
Set Scene Lock 8
Set Sequence State 8
15
16
17
Start Raising 4,5
Start Lowering 4,5
Stop Raising / Lowering 4,5
Get/Set Timeclock State
18
19
20
34
None
None
Scene
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second 2
3 = Rapid-Flash: 10 flashes every second 2
Scene
Level = 0–100 or 0.00–100.00
Fade 6 in: SS.ss 7, SS, MM:SS, or HH:MM:SSJ79 (QS Standalone
fade: maximum 4 hours)
Delay 6 in: SS.ss 7, SS, MM:SS, or HH:MM:SS (QS Standalone delay:
maximum 4 hours)
0 = Off; 1 = On
0 = Off; 1 = On
0 = Off
1 = Sequence through Scenes 1–4
2 = Sequence through Scenes 5–16
None
None
None
0 = Disabled
1 = Enabled
NOTES
The number of zone controllers available matches the number of zones a particular model supports.
1. Not supported in HomeWorks® QS.
2. Not supported in RadioRA® 2.
3.Quantum® or HomeWorks® only. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
4. Use OUTPUT command with equivalent command in RadioRA® 2.
5. Use OUTPUT command with equivalent command in HomeWorks® QS.
6. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
7. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
8. QS Standalone only.
73
Lutron integration protocol
®
1
2
3
4
5
6
Scene 1
Fade Time
03 Seconds
OK
GRAFIK Eye® QS (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set or Get Zone Level
1
Start Raising
Start Lowering
Stop Raising / Lowering
2
3
4
Parameters
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone fade: maximum 4 hours)
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone delay: maximum 4 hours)
None
None
None
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter sec. For example, if a fade time is specified as
1.31 seconds a value of 1.25 seconds will be used.
Example OUTPUT Commands
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising zone level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering zone level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
?OUTPUT,1,1<CR><LF>
Response 1: ~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (Integration ID-1) dimmer is at 20% and is then commanded to go to 100% by sending
#OUTPUT,1,1,100, the response from the system will be ~OUTPUT,1,1,100.00
74
Lutron integration protocol
®
Energi Savr NodeTM QS for DALI®
QS Model: QSNE-2DAL-D
HomeWorks® QS Model: LQSNE-2DAL-D
COM
24 V
MUX
230 V~ 50/60 Hz 100 mA
www.lutron.com
+44.(0)20.7680.4481
Power
N
MUX
Occ
QSNE-2DAL-D
Test
0,5 N∙m
DALI 1 DALI 2
Ethernet
Energi Savr NodeTM QS
Hi Temp
L
QS
Com
Photo
20 V
IR
4
Occ
2
4
Photo
2
3
IR
1
3
20 V
1
Com
QSNE-2DAL-D
®
Z096
N1771
8 mm
V
D E
Why Integrate with an Energi Savr NodeTM (ESN)?
• Control individual zones and scenes in an area
• Query current scene and light levels
Integration Capabilities
•Up to 32 areas with 16 scenes per area. Up to 32 zones across the two DALI® buses
Supported Command Types
• DEVICE allows control and monitoring of zone levels and area scenes
•OUTPUT allows control and monitoring of the dimmer device output
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
ESN QS for DALI®



75
N
24 V
MUX
MUX
QSNE-2DAL-D
Test
230 V~ 50/60 Hz 100 mA
www.lutron.com
+44.(0)20.7680.4481
Power
0,5 N∙m
DALI 1 DALI 2
Ethernet
Energi Savr NodeTM QS
Hi Temp
L
QS
COM
IR
Occ
20 V
Photo
2
4
IR
4
Occ
2
3
3
Com
1
Photo
1
20 V
®
Com
Lutron integration protocol
®
Z096
N1771
8 mm
Energi Savr NodeTM QS for DALI® (continued)
DEVICE Commands 5
V
D E
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
32 1, 2, 3
Zone 1– Zone
Area 1– Area 32 1, 3
Occupancy Sensors 1–4
301– 332
401– 432
151– 154
Available Actions
Set or Get Light Level, Raise, Lower, Stop
Set or Get Scene, Set Light Level, Raise, Lower, Stop
Report (~) Occupied
Report (~) Unoccupied
NOTES
1. Zones and areas are created and configured using the Lutron® ESN Configuration Tool on an iPhone or iPod Touch
mobile device, the Quantum® Q-DesignTM Tool, or the HomeWorks® QS Lutron® Designer. Only those areas and zones
which have been configured using one of these tools are accessible through integration.
2. Assigned zones can be given an individual Integration ID and controlled using the #OUTPUT command. For more details
on setting the output Integration ID of a zone component, see the Integration Access Point section of the system that
contains the ESN.
3. When the ESN is part of a Quantum® system, then the #AREA and #OUTPUT commands found in the Quantum®
“System Commands” section of this integration document should be used.
Action Numbers and Parameters:
Action
Action Number
Report (~) Occupied
Report (~) Unoccupied
Set or Get Current Scene
Scene Save
Set or Get Light Level
3
4
7
12
14
Set Scene Lock 4
Set Sequence State 4
16
17
Start Raising
Start Lowering
Stop Raising / Lowering
18
19
20
Parameters
None
None
Scene
Scene1
Level = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
(QS Standalone fade: maximum 90 seconds)
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
(QS Standalone delay: maximum 4 hours)
0 = Off; 1 = On
0 = Off; 1 = Sequence through Scenes 1–4;
2 = Sequence through Scenes 5–16
None
None
None
NOTES
1. Available only with Energi Savr NodeTM firmware > 6.x.
2. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter-second. For example, if a fade time is specified
as 1.31 seconds, a value of 1.25 seconds will be used.
4. QS Standalone only.
5. Not supported in HomeWorks® QS.
iPhone and iPod Touch are trademarks of Apple, Inc., registered in the U.S. and other countries.
76
N
24 V
MUX
MUX
QSNE-2DAL-D
Test
230 V~ 50/60 Hz 100 mA
www.lutron.com
+44.(0)20.7680.4481
Power
0,5 N∙m
DALI 1 DALI 2
Ethernet
Energi Savr NodeTM QS
Hi Temp
L
QS
COM
IR
Occ
20 V
Photo
2
4
IR
4
Occ
2
3
3
Com
1
Photo
1
20 V
®
Com
Lutron integration protocol
®
Z096
N1771
8 mm
Energi Savr NodeTM QS for DALI® (continued)
OUTPUT Commands
V
D E
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set or Get Zone Level
1
Start Raising
Start Lowering
Stop Raising / Lowering
2
3
4
Parameters
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone fade: maximum 90 seconds)
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone delay: maximum 4 hours)
None
None
None
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
Example OUTPUT Commands
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising zone level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering zone level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
?OUTPUT,1,1<CR><LF>
Response 1: ~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (Integration ID -1) dimmer is at 20% and is then commanded to go to 100% by sending
#OUTPUT,1,1,100 the response from the system will be ~OUTPUT,1,1,100.00
77
Lutron integration protocol
®
Energi Savr NodeTM QS
with EcoSystem®
Model: QSN-2ECO-S
Energi Savr NodeTM QS
with EcoSystem® (International)
QS Model: QSNE-2ECO-D
HomeWorks® QS Model: LQSE-2ECO-D
QSNE-2ECO-D
QSN-2ECO-S
Why Integrate with an Energi Savr NodeTM?
• Control individual zones and scenes in an area
• Query current scene and light levels
Integration Capabilities
•Up to 100 areas with 16 scenes per area. Up to 100 zones across the two EcoSystem® loops
Supported Command Types
• DEVICE allows control and monitoring of zone levels and area scenes
•OUTPUT allows control and monitoring of the dimmer device output
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
ESN QS with Ecosystem® (Int’l)
ESN with EcoSystem®
78





Lutron integration protocol
®
Energi Savr NodeTM QS
with EcoSystem® (continued)
DEVICE Commands 1
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
NOTE
1. Not Supported in HomeWorks® QS.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number Available Actions
Occupancy Sensors 1 – 4
Loop 1 Ballast Occupancy Sensors
Loop 2 Ballast Occupancy Sensors
Zone 1– Zone 100 1, 2, 3
Area 1– Area 100 1, 3
136 – 139
140 – 203
204 – 267
1001–1100
1201–1300
Report (~) Occupied, Report (~) Unoccupied
Report (~) Occupied, Report (~) Unoccupied
Report (~) Occupied, Report (~) Unoccupied
Set or Get Light Level, Raise, Lower, Stop
Set or Get Scene, Set Light Level, Raise, Lower, Stop
NOTES
1. Zones and areas are created and configured using the Lutron® ESN Configuration Tool on an iPhone or iPod Touch
mobile device, the Quantum® Q-DesignTM Tool, or the HomeWorks® QS Lutron® Designer. Only those areas and zones
which have been configured using one of these tools are accessible through integration.
2. Assigned zones can be given an individual Integration ID and controlled using the #OUTPUT command. For more details
on setting the output Integration ID of a zone component, see the Integration Access Point section of the system that
contains the ESN.
3. When the ESN is part of a Quantum® or HomeWorks® QS system, then the #AREA and #OUTPUT commands found in
the Quantum® “System Commands” section of this integration document should be used.
Action Numbers and Parameters:
Action
Action Number Parameters
Report (~) Occupied
Report (~) Unoccupied
Set or Get Current Scene
Scene Save
Set or Get Light Level
3
4
7
12
14
Set Scene Lock 4
Set Sequence State 4
16
17
Start Raising
Start Lowering
Stop Raising / Lowering
18
19
20
None
None
Scene
Scene1
Level = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
0 = Off; 1 = On
0 = Off; 1 = Sequence through Scenes 1–4;
2 = Sequence through Scenes 5–16
None
None
None
NOTES
1. Available only with Energi Savr NodeTM Firmware > 6.x.
2. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds, a value of 1.25 seconds will be used.
4. QS Standalone only.
iPhone and iPod Touch are trademarks of Apple, Inc., registered in the U.S. and other countries.
79
Lutron integration protocol
®
Energi Savr NodeTM QS
with EcoSystem® (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set or Get Zone Level
1
Start Raising
Start Lowering
Stop Raising / Lowering
2
3
4
Parameters
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone fade: maximum 2 hours)
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone delay: maximum 4 hours)
None
None
None
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
Example OUTPUT Commands
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising zone level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering zone level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
?OUTPUT,1,1<CR><LF>
Response1: ~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (Integration ID-1) dimmer is at 20% and is then commanded to go to 100% by sending
#OUTPUT,1,1,100 the response from the system will be ~OUTPUT,1,1,100.00
80
Lutron integration protocol
®
Energi Savr NodeTM QS
for 0 –10 V/Softswitch® (International)
QS Models (QSNE-): 4T10-D, 4S10-D
HomeWorks® QS Models (LQSE-): 4T10-D, 4S10-D
Energi Savr NodeTM QS
for Phase Adaptive (International)
QS Model: QSNE-4A-D
HomeWorks® QS Model: LQSE-4A-D
Energi Savr NodeTM QS
for 0 –10 V/Softswitch®
QSNE-4T10-D
Models (QSN-): 4T16-S, 4S16-S
QSN-4T16-S
QSNE-4A-D
800 W Max 500 W Max 500 W Max 500 W Max
Input
S1
S2
S3
S4
CCI
Zone 1 Zone 2 Zone 3 Zone 4
Type
Hi Temp
Prog
Power
230 V~ 50 / 60 Hz 10 A
QSNE-4A-D
Photo Occ Switch
DIN Rail Power Module
IR
Input
Option
Def
H
Opt1
M
Opt2
L
Opt3
www.lutron.com +44.(0)20.7702.0657
Why Integrate with an Energi Savr NodeTM?
• Control individual zones and scenes in an area
• Query current scene and light levels
Integration Capabilities
• Four areas with 16 scenes per area. Four zones on four independent outputs
Supported Command Types
• DEVICE allows control and monitoring of zone levels and area scenes
•OUTPUT allows control and monitoring of the dimmer device output
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
ESN 0 –10 V/Softswitch® (Int’l)
ESN QS Phase Adaptive (Int’l)
ESN 0 –10/Softswitch®








81
800 W Max 500 W Max 500 W Max 500 W Max
Input
S1
S2
S3
S4
CCI
Zone 1 Zone 2 Zone 3 Zone 4
Type
IR
Photo Occ Switch
Input
Hi Temp
Prog
Power
230 V~ 50 / 60 Hz 10 A
QSNE-4A-D
®
DIN Rail Power Module
Lutron integration protocol
Option
Def
H
Opt1
M
Opt2
L
Opt3
www.lutron.com +44.(0)20.7702.0657
Energi Savr NodeTM QS
0 –10 V/Softswitch®/Phase Adaptive (continued)
DEVICE Commands 1
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
NOTE
1. Not Supported in HomeWorks® QS.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
4 1, 2, 3
Zone 1 – Zone
Area 1 – Area 4 1, 3
Occupancy Sensor 1 – 4
Occupancy Sensor 1 – 2
5 – 8
10 –13
34 – 37
34 – 35
Available Actions
Set or Get Light Level, Raise, Lower, Stop
Set or Get Scene, Set Light Level, Raise, Lower, Stop
Report (~) Occupied, Report (~) Unoccupied
Report (~) Occupied, Report (~) Unoccupied
NOTES
1. Zones and areas are created and configured using the Lutron® ESN Configuration Tool on an iPhone or iPod Touch
mobile device, the Quantum® Q-DesignTM Tool, or the HomeWorks® QS Lutron® Designer. Only those areas and zones
which have been configured using one of these tools are accessible through integration.
2. Assigned zones can be given an individual Integration ID and controlled using the #OUTPUT command. For more details
on setting the output Integration ID of a zone component, see the Integration Access Point section of the system that
contains the ESN.
3. When the ESN is part of a Quantum® or HomeWorks® system, then the #AREA and #OUTPUT commands found in the
Quantum® “System Commands” section of this integration document should be used.
Action Numbers and Parameters:
Action
Action Number
Report (~) Occupied
Report (~) Unoccupied
Set or Get Current Scene 1
Scene Save
Set or Get Light Level
3
4
7
12
14
Set Scene Lock 1
Set Sequence State 1
16
17
Start Raising
Start Lowering
Stop Raising / Lowering
18
19
20
Parameters
None
None
Scene
Scene2
Level = 0–100 or 0.00–100.00
Fade 3 in: SS.ss 4, SS, MM:SS, or HH:MM:SS
Delay 3 in: SS.ss 4, SS, MM:SS, or HH:MM:SS
0 = Off; 1 = On
0 = Off; 1 = Sequence through Scenes 1–4;
2 = Sequence through Scenes 5–16
None
None
None
NOTES
1. QS Standalone only.
2. Available only with Energi Savr NodeTM Firmware > 6.x.
3. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
4. Fractional seconds “SS.ss” will be rounded down to the nearest quarter-second. For example, if a fade time is specified
as 1.31 seconds, a value of 1.25 seconds will be used.
iPhone and iPod Touch are trademarks of Apple, Inc., registered in the U.S. and other countries.
82
800 W Max 500 W Max 500 W Max 500 W Max
Input
S1
S2
S3
S4
CCI
Zone 1 Zone 2 Zone 3 Zone 4
Type
IR
Photo Occ Switch
Input
Hi Temp
Prog
Power
230 V~ 50 / 60 Hz 10 A
QSNE-4A-D
®
DIN Rail Power Module
Lutron integration protocol
Option
Def
H
Opt1
M
Opt2
L
Opt3
www.lutron.com +44.(0)20.7702.0657
Energi Savr NodeTM QS
0 –10 V/Softswitch®/Phase Adaptive (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set or Get Zone Level
1
Start Raising
Start Lowering
Stop Raising / Lowering
2
3
4
Parameters
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone fade: maximum 4 hours)
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
(QS Standalone delay: maximum 4 hours)
None
None
None
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
Example OUTPUT Commands
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising zone level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering zone level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
?OUTPUT,1,1<CR><LF>
Response1: ~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (Integration ID-1) dimmer is at 20% and is then commanded to go to 100% by sending
#OUTPUT,1,1,100 the response from the system will be ~OUTPUT,1,1,100.00
83
Lutron integration protocol
®
Energi Savr NodeTM QS
for Motor Module (International)
QS Model: QSE-CI-4M-D
HomeWorks® QS Model: LQSE-4M-D
LQSE-CI-4M-D
Why Integrate with an Energi Savr NodeTM?
• Allows control and monitoring of the direction and remaining travel time of the four high-voltage
outputs.
Integration Capabilities
•Up to 4 zones
Supported Command Types
• DEVICE allows control and monitoring of zone levels
•OUTPUT allows control and monitoring of the device outputs
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
ESN QS for Motor Module
84


Lutron integration protocol
®
Energi Savr NodeTM QS
for Motor Module (International) (continued)
DEVICE Commands
DEVICE Command Format
Operation
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Zone 1 – Zone 41,2
Component Number
1 – 4
Available Actions
Set or Get Light Level, Raise, Lower, Stop
NOTES
1. Assigned zones can be given an individual Integration ID and controlled using the #OUTPUT command. For more details
on setting the output Integration ID of a zone component, see the Integration Access Point section of the system that
contains the QS Motor Module.
2. When the QS Motor Module is part of a Quantum® system, then the commands found in the Quantum® “System
Commands” section of this integration document should be used.
Action Numbers and Parameters:
Action
Action Number
Set Light Level
14
Raise
Lower
Stop
18
19
20
Parameters
Level = 0–100 or 0.00–100.001
Fade 2 in: Always use 0
Delay 3 in: SS.ss 4, SS, MM:SS, or HH:MM:SS
None
None
None
NOTES
1. Setting the level to 0% will cause the output to travel in the Closed direction; setting the level to 100% will cause the
output to travel in the Open direction; setting any level from 1 – 99% will be ignored by the output. Querying its level will
report 0 or 100%, based on the last direction it moved.
2. Fade is not available for Motor Loads because they move at a constant rate. The parameter must be entered, but is
ignored.
3. The delay time is optional. When not used, the system will use a zero-second delay.
4. Fractional seconds “SS.ss” will be rounded down to the nearest quarter-second. For example, if a fade time is specified
as 1.31 seconds, a value of 1.25 seconds will be used.
85
Lutron integration protocol
®
Energi Savr NodeTM QS
for Motor Module (International) (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 3, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Set (#) / Get (?) Zone Level
1
Start Raising
Start Lowering
Stop Raising Lowering
Report Travel Time Remaining5
Motor Jog Raise6
Motor Jog Lower6
Motor 4-Stage Jog Raise6
Motor 4-Stage Jog Lower6
2
3
4
17
18
19
20
21
Parameters
Level = 0 or 100.001
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 4 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
None
None
None
Travel time in seconds: 0 – 255
None
None
None
None
NOTES
1. Setting the level to 0% will cause the output to travel in the Closed direction; setting the level to 100% will cause the
output to travel in the Open direction; setting any level from 1 – 99% will be ignored by the output. Querying its level will
report 0 or 100%, based on the last direction it moved.
2. Fade is not available for Shades because they move at a constant rate. The parameter must be entered, but is ignored.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter-second. For example, if a delay time is specified
as 1.45 seconds, a value of 1.25 seconds will be used.
4. The delay time is optional. When not used, the system will use a zero-second delay. The minimum delay time is 0.25
seconds; the maximum delay time is 4 hours.
5. If the travel time of a motor is greater than 255 seconds, the unit will report 255 until the travel time drops below that
value.
6. Not supported in QS Standalone.
86
Lutron integration protocol
®
Remote Power Module
Adaptive Phase Control Model: HW-RPM-4A
Phase Control Model: HW-RPM-4U
Quiet Fan Speed Control Model: HW-RPM-4FSQ
3-Wire Motor Control Model: HW-RPM-4M
Relay Switching Model: HW-RPM-4R
HW-RPM-4A
Why Integrate with a Remote Power Module?
• Control individual zones and scenes in an area
• Query current scene and light levels
Integration Capabilities
• Up to four zones on each remote power module
Supported Command Types
•OUTPUT allows control and monitoring of the control zone output
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Remote Power Module


87
Lutron integration protocol
®
Remote Power Module (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 6, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Set or Get Zone Level
Action Number
1
Parameters
0–100 or
0.00–100.00
SS.ss 1, SS, MM:SS, or HH:MM:SS
Start Raising
2
None
Stop Lowering
3
None
Stop Raising / Lowering
4
None
5
SS.ss 1, SS, MM:SS, or HH:MM:SS
Pulse
6
SS.ss 1, SS, MM:SS, or HH:MM:SS
Motor Jog Raise
18
None
Motor Jog Lower
19
None
Motor 4-Stage Jog Raise
20
None
Motor 4-Stage Jog Lower
21
None
Start
Flash 2
NOTES
1. Fractions are rounded up to the closest ¼ second.
2. To stop a dimmer from flashing, send it to a valid level (action 1).
88
Lutron integration protocol
®
ArchitraveTM Keypad
QS Models (QSWAS-) with Faceplate / Button Kit Models (KP5-, KP7-): DN, KP7
HomeWorks® QS Models (HQWA-) with Faceplate / Button Kit Models (KP5-, KP7-): DN, KP7
KP5-DN
KP7-DN
KP5-DW
QS
HomeWorks® QS
Button 1
Button 1
Button 2
Button 2
Button 3
Button 3
Button 4
Button 4
Button 5
Button 5
Raise
Button 6
Lower
Button 7
QS
HomeWorks® QS
Button 1
Button 1
Button 2
Button 2
Button 3
Button 3
Button 4
Button 4
Button 5
Button 5
Button 6
Button 6
Button 7
Button 7
KP7-DW
Why Integrate with an ArchitraveTM Keypad?
• Simulate a button press
• Control LEDs of unprogrammed buttons
Compatibility
ArchitraveTM
Keypads
QS Model
HomeWorks® QS Model
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System



89
Lutron integration protocol
®
ArchitraveTM Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release, Multi Tap, Hold, Hold Release
Button 2
2
Press, Release, Multi Tap, Hold, Hold Release
Button 3
3
Press, Release, Multi Tap, Hold, Hold Release
Button 4
4
Press, Release, Multi Tap, Hold, Hold Release
Button 5
5
Press, Release, Multi Tap, Hold, Hold Release
Button 6
6
Press, Release, Multi Tap, Hold, Hold Release
Button 7
7
Press, Release, Multi Tap, Hold, Hold Release
Lower
18
Press, Release, Multi Tap, Hold, Hold Release
Raise
19
Press, Release, Multi Tap, Hold, Hold Release
CCI 1
25
Press, Release
CCI 2
26
Press, Release
LED
1 1
81
Set or Get LED state
LED
2 1
82
Set or Get LED state
LED
3 1
83
Set or Get LED state
LED
4 1
84
Set or Get LED state
LED
5 1
85
Set or Get LED state
LED 6 1
86
Set or Get LED state
LED 7 1
87
Set or Get LED state
NOTE
1. Available only on units in a Quantum® or HomeWorks® system.
90
Lutron integration protocol
®
ArchitraveTM Keypad (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
Press/CCI Close
3
None
Release/CCI Open
4
None
Hold
5
None
6
None
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second 2
3 = Rapid-Flash: 10 flashes every second 2
32
None
Multi-tap
Set (#) or Get (?) LED
State 1
Hold Release 2
NOTES
1.Quantum® or HomeWorks® only. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
2. Available only on units in a Quantum® or HomeWorks® system.
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
~DEVICE,2,81,9,1<CR><LF>
91
Lutron integration protocol
®
Signature SeriesTM Keypad
QS Models (QSWAS-): 1B, 1RLD, 2B, 2BRL, 2RLD, 3B, 3BD, 3BRL, 5B, 5BRL, 7B
HomeWorks® QS 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
1RLD
1
2
3
4
3B
5
6
3BD
1
2
3
2
3
4
5BT
5
6
7
5BRL
2B
3
4
3BRL
2
3
4
2BRL
3
4
2BS
3
3BS
1
2
2
5
5
6
3BSRL
4BS
4S
1
1
3
3
5
5
1
2
3
4
7
6B
2RLD
6BRL
6
4
6
5B
2
3
4
5
6
Configuration
7B
Button 1
1
2
3
4
5
1
2
3
4
5
1
2
3
4
5
6
1
2
3
4
5
6
Button 2
1
2
3
4
5
6
7
Button 3 or Raise/Lower
Button 4
Button 5
Button 6
Button 7 or Raise/Lower
Why Integrate with a Signature SeriesTM Keypad?
• Simulate a button press
• Control LEDs of unprogrammed buttons
Compatibility
Signature SeriesTM
Keypads
QS Model
HomeWorks® QS Model
92
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System



Lutron integration protocol
®
Signature SeriesTM Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release, Multi Tap, Hold, Hold Release
Button 2
2
Press, Release, Multi Tap, Hold, Hold Release
Button 3
3
Press, Release, Multi Tap, Hold, Hold Release
Button 4
4
Press, Release, Multi Tap, Hold, Hold Release
Button 5
5
Press, Release, Multi Tap, Hold, Hold Release
Button 6
6
Press, Release, Multi Tap, Hold, Hold Release
Button 7
7
Press, Release, Multi Tap, Hold, Hold Release
Button Top Lower
16
Press, Release, Multi Tap, Hold, Hold Release
Button Top Raise
17
Press, Release, Multi Tap, Hold, Hold Release
Button Bottom Lower
18
Press, Release, Multi Tap, Hold, Hold Release
Button Bottom Raise
19
Press, Release, Multi Tap, Hold, Hold Release
CCI 1
25
Press, Release
CCI 2
26
Press, Release
LED
1 1
81
Set or Get LED state
LED
2 1
82
Set or Get LED state
LED
3 1
83
Set or Get LED state
LED 4 1
84
Set or Get LED state
LED 5 1
85
Set or Get LED state
LED 6 1
86
Set or Get LED state
7 1
87
Set or Get LED state
LED
NOTE
1. Available only on units in a Quantum® or HomeWorks® system.
93
Lutron integration protocol
®
Signature SeriesTM Keypad (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Hold
5
None
6
None
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second
3 = Rapid-Flash: 10 flashes every second
32
None
Multi-tap
Set (#) or Get (?) LED
State 1
Hold Release 2
NOTES
1.Quantum® or HomeWorks® only. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
2. Available only on units in a Quantum® or HomeWorks® system.
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
94
~DEVICE,2,81,9,1<CR><LF>
Lutron integration protocol
®
seeTouch® Keypad
QS Models (QSWS2-): 1B, 1RLD, 2B, 2BRL, 2BRLIR, 2RLD, 3B, 3BD, 3BRL, 3BRLIR, 5B, 5BRL, 5BRLIR, 7B
RadioRA® 2 Models (RRD-W): 1RLD, 2RLD, 3BD, 3BRL, 3BSRL, 4S, 5BRL, 5BRLIR, 6BRL, 7B
HomeWorks® QS 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, 7B
Clear Connect® Device Models (CCD-W): 6BRL
1B
1RLD
button 1
button 2
button 3
button 4
2B
2BRL
2BRLIR
button 2
button 3
button 4
3BD
button 1
button 2
button 3
button 3
button 4
button 3
button 4
button 3
button 4
button 1
button 2
button 3
button 4
button 5
5BRL
button 1
button 2
button 3
button 4
button 5
button 3
button 5
3BRL
3BRLIR
button 2
button 3
button 4
3BSRL
button 2
button 3
button 4
button 5
button 6
button 7
5B
2RLD
button 1
button 2
button 5
button 6
3B
2BS
4BS
button 1
button 1
button 3
button 3
button 5
button 5
button 5
button 6
4S
button 1
button 2
button 3
button 4
button 6
button 7
5BRLIR
button 1
button 2
button 3
button 4
button 5
5BIR
6B
button 1
button 2
button 3
button 4
button 5
button 1
button 2
button 3
button 4
button 5
button 6
6BRL
button 1
button 2
button 3
button 4
button 5
button 6
7B
button 1
button 2
button 3
button 4
button 5
button 6
button 7
Why Integrate with a seeTouch® Keypad?
• Simulate a button press
• Control LEDs of unprogrammed buttons
Compatibility
seeTouch®
Keypads
QS Model
RadioRA® 2 Model
HomeWorks® QS Model
Clear Connect® Device Model
QS
HomeWorks® Clear Connect®
Quantum® RadioRA® 2
Gateway System
Standalone
QS





95
Lutron integration protocol
®
seeTouch® Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release
Button 2
2
Press, Release
Button 3
3
Press, Release
Button 4
4
Press, Release
Button 5
5
Press, Release
Button 6
6
Press, Release
Button 7
7
Press, Release
Button Top Lower
16
Press, Release
Button Top Raise
17
Press, Release
Button Bottom Lower
18
Press, Release
Button Bottom Raise
19
Press, Release
CCI 1
25
Press, Release
CCI 2
26
Press, Release
LED
1 1
81
Set or Get LED state
LED
2 1
82
Set or Get LED state
LED
3 1
83
Set or Get LED state
LED 4 1
84
Set or Get LED state
LED 5 1
85
Set or Get LED state
LED 6 1
86
Set or Get LED state
7 1
87
Set or Get LED state
LED
NOTE
1. Available only on units in a Quantum® or HomeWorks® system.
96
Lutron integration protocol
®
seeTouch® Keypad (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
Press/CCI Close
3
None
Release/CCI Open
4
None
Hold
5
None
6
None
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second 1
3 = Rapid-Flash: 10 flashes every second 1
Multi-tap
Set (#) or Get (?) LED
State 1,2
NOTES
1. Available only on units in a Quantum® or HomeWorks® system.
2.Quantum® or HomeWorks® only. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
~DEVICE,2,81,9,1<CR><LF>
97
Lutron integration protocol
®
seeTouch® QS Keypad (International)
QS Models (QSWE-): 2B, 3B, 4B, 5BRL, 5BRLIR, 6BRL, 7BRL, 8BRL, 8BRLIR, 10BRL
HomeWorks® QS Models (HWQIS-NB-NONE) with Faceplate / Button Kit Models (LFS-W):
2B, 3B, 4B, 5BRL, 5BRLIR, 6BRL, 7BRL, 8BRL, 8BRLIR, 10BRL
2B
3B
4B
5BRL
button 6
button 7
button 2
button 7
button 4
button 9
button 6
button 7
button 8
button 9
button 10
button 8
button 9
button 10
Lower Raise
5BRLIR
6BRL
button 1
button 6
button 7
button 8
button 9
button 10
button 3
button 5
button 10
button 6
button 7
button 8
button 9
button 10
Lower Raise
Lower Raise
button 8
button 4
button 5
8BRLIR
button 3
button 6
button 2
Lower Raise
button 1
7BRL
8BRL
button 1
button 3
button 5
10BRL
button 6
button 7
button 8
button 9
button 10
button 1
button 2
button 3
button 4
button 5
Lower Raise
button 6
button 7
button 8
button 9
button 10
Lower Raise
Why Integrate with a seeTouch® QS Keypad?
• Simulate a button press
• Control LEDs of unprogrammed buttons
Compatibility
seeTouch® QS
Keypads (International)
QS Model
HomeWorks® QS Model
98
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System



button 6
button 7
button 8
button 9
button 10
Lower Raise
Lutron integration protocol
®
seeTouch® QS Keypad (International) (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release, Multi Tap, Hold, Hold Release
Button 2
2
Press, Release, Multi Tap, Hold, Hold Release
Button 3
3
Press, Release, Multi Tap, Hold, Hold Release
Button 4
4
Press, Release, Multi Tap, Hold, Hold Release
Button 5
5
Press, Release, Multi Tap, Hold, Hold Release
Button 6
6
Press, Release, Multi Tap, Hold, Hold Release
Button 7
7
Press, Release, Multi Tap, Hold, Hold Release
Button 8
8
Press, Release, Multi Tap, Hold, Hold Release
Button 9
9
Press, Release, Multi Tap, Hold, Hold Release
Button 10
10
Press, Release, Multi Tap, Hold, Hold Release
Lower
18
Press, Release, Multi Tap, Hold, Hold Release
Raise
19
Press, Release, Multi Tap, Hold, Hold Release
CCI 1
25
Press, Release
CCI 2
26
Press, Release
LED
11
81
Set or Get LED state
LED
21
82
Set or Get LED state
LED 31
83
Set or Get LED state
LED 41
84
Set or Get LED state
LED 51
85
Set or Get LED state
LED
61
86
Set or Get LED state
LED
71
87
Set or Get LED state
LED
81
88
Set or Get LED state
LED
91
89
Set or Get LED state
LED
101
90
Set or Get LED state
NOTE
1. Not supported in QS Standalone.
99
Lutron integration protocol
®
seeTouch® QS Keypad (International) (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
Press/CCI Close
3
None
Release/CCI Open
4
None
Hold
5
None
6
None
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every sec
3 = Rapid-Flash: 10 flashes every sec
32
None
Multi-tap
Set (#) or Get (?) LED
State 1
Hold Release2
NOTES
1. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
2. Not supported in QS Standalone.
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
100
~DEVICE,2,81,9,1<CR><LF>
Lutron integration protocol
®
Tabletop seeTouch® Keypad
RadioRA® 2 Models (RR-): T5RL, T10RL, T15RL
HomeWorks® QS Models (HQR-, HQK-, HQQ-, HQM-, HQN-):
T5RL, T10RL, T15RL, T5CRL, T10CRL, T15CRL
T5-RL
T10-RL
button 1
button 6
button 1
button 2
button 7
button 2
button 3
button 8
button 3
button 4
button 9
button 4
button 5
button 10
button 5
button 17
button 16
button 17
button 16
All ON
All OFF
All ON
All OFF
Column 3
Lower Raise
Column 3
Lower Raise
T15-RL
T15-CRL
button 11
button 6
button 1
button 11
button 6
button 1
button 12
button 7
button 2
button 12
button 7
button 2
button 13
button 8
button 3
button 13
button 8
button 3
button 14
button 9
button 4
button 14
button 9
button 4
button 15
button 10
button 5
button 15
button 10
button 5
button 17
button 16
All ON
All OFF
Column 3
Lower Raise
Column 3
Column 2
Column 1
Lower Raise Lower Raise Lower Raise
Why Integrate with a Tabletop seeTouch® Keypad?
• Simulate a button press
• Control LEDs of unprogrammed buttons
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Tabletop seeTouch®


101
Lutron integration protocol
®
Tabletop seeTouch® Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 3, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release
Button 2
2
Press, Release
Button 3
3
Press, Release
Button 4
4
Press, Release
Button 5
5
Press, Release
Button 6
6
Press, Release
Button 7
7
Press, Release
Button 8
8
Press, Release
Button 9
9
Press, Release
Button 10
10
Press, Release
Button 11
11
Press, Release
Button 12
12
Press, Release
Button 13
13
Press, Release
Button 14
14
Press, Release
Button 15
15
Press, Release
Button 16
16
Press, Release
Button 17
17
Press, Release
Column 1: Lower
20
Press, Release
Column 1: Raise
21
Press, Release
Column 2: Lower
22
Press, Release
Column 2: Raise
23
Press, Release
Column 3: Lower
24
Press, Release
Column 3: Raise
25
Press, Release
Continued on next page…
102
Lutron integration protocol
®
Tabletop seeTouch® Keypad (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Component Numbers (continued):
Component
Component Number
Available Actions
LED 1
81
Set or Get LED state
LED 2
82
Set or Get LED state
LED 3
83
Set or Get LED state
LED 4
84
Set or Get LED state
LED 5
85
Set or Get LED state
LED 6
86
Set or Get LED state
LED 7
87
Set or Get LED state
LED 8
88
Set or Get LED state
LED 9
89
Set or Get LED state
LED 10
90
Set or Get LED state
LED 11
91
Set or Get LED state
LED 12
92
Set or Get LED state
LED 13
93
Set or Get LED state
LED 14
94
Set or Get LED state
LED 15
95
Set or Get LED state
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Set (#) or Get (?) LED State
Set is for unprogrammed LEDs only
9
0 = Off
1 = On
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 3.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,3,1,3<CR><LF>
Turn On LED 1.
#DEVICE,3,81,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,3,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
~DEVICE,3,81,9,1<CR><LF>
103
Lutron integration protocol
®
Hybrid Keypad
RadioRA® 2 Models (RRD-H): 1RLD, 2RLD, 3BSRL, 4S, 5BRL, 6BRL
HomeWorks® QS Models (HQRD-H): 1RLD, 2RLD, 3BSRL, 4S, 5BRL, 6BRL
H6BRL
Why Integrate with a Hybrid Keypad?
• Turn On to specific light level or Off
• Raise / Lower light level
• Query current light level
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Hybrid Keypad
104


Lutron integration protocol
®
Hybrid Keypad (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set or Get Zone Level
1
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Start Raising
2
None
Start Lowering
3
None
Stop Raising / Lowering
4
None
5
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Start
Flashing 3, 4, 5
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
3. The system will not report a level while the output is flashing, it will instead report that it is flashing.
4. Default flash every second, unless fade time is specified (flash period is 2× fade time).
5. To stop a dimmer from flashing, send it to a valid level.
Example OUTPUT Commands
Examples presume dimmer has been assigned Integration ID 1.
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising dimmer level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering dimmer level.
#OUTPUT,1,4<CR><LF>
Start Flashing a dimmer.
#OUTPUT,1,5<CR><LF>
Start Flashing a dimmer once every 2 seconds.
#OUTPUT,1,5,1<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
Response 1, 2:
?OUTPUT,1,1<CR><LF>
~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTES
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (1) dimmer is at 20% and is then commanded to go to 100% by sending #OUTPUT,1,1,100
the response from the system will be ~OUTPUT,1,1,100.00
2. The system will not report a level while the output is flashing, it will instead report that it is flashing.
105
Lutron integration protocol
®
Hybrid Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release
Button 2
2
Press, Release
Button 3
3
Press, Release
Button 4
4
Press, Release
Button 5
5
Press, Release
Button 6
6
Press, Release
Button 7
7
Press, Release
Button Top Lower
16
Press, Release
Button Top Raise
17
Press, Release
Button Bottom Lower
18
Press, Release
Button Bottom Raise
19
Press, Release
LED 1
81
Set or Get LED state
LED 2
82
Set or Get LED state
LED 3
83
Set or Get LED state
LED 4
84
Set or Get LED state
LED 5
85
Set or Get LED state
LED 6
86
Set or Get LED state
LED 7
87
Set or Get LED state
106
Lutron integration protocol
®
Hybrid Keypad (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Set (#) or Get (?) LED State
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second 1
3 = Rapid-Flash: 10 flashes every second 1
NOTE
1. “Set” is for LEDs on unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
~DEVICE,2,81,9,1<CR><LF>
107
Lutron integration protocol
®
Pico® Wireless Control
CURRENT Models: PJ-2B, PJ-2BRL, PJ-3B, PJ-3BRL, PJ2-2B, PJ2-2BRL, PJ2-3B, PJ2-3BRL, PJ2-4B
LEGACY Models:
QS Models (QSR4P-, QSR8P-, QSRKP-, QSRMP-): 2, 2R, 3R
RadioRA® 2 Models (RRD- P): 3BRL-L, 3BRL-S
2B
2BRL
3B
3BRL
4B
Button 1
Button 1
Button 1
Button 1
Button 2
Button
Raise
Button
2
Button
Lower
Button 1
Button
Raise
Button
Lower
Button 2
Button 3
Button 3
Button 3
Button 3
Button 3
Button 4
Why Integrate with a Pico® Wireless Control?
• Simulate a button press
• Monitor button presses
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
QS Model*
1
2
RadioRA® 2 Model
Pico® PJ- Models
1
Pico® PJ2- Models
1
2,3
2,3





4
4
4
NOTES
1. In QS Standalone systems, the Pico® is integrated through its associated QSM. Refer to the QS Sensor Module (QSM)
section.
2. Can be used only when associated to a QSM.
3. PJ2-4B is supported only on QSM software version 7.28 and higher.
4. All models supported except PJ2-4B.
108
Lutron integration protocol
®
Pico® Wireless Control (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
For all Legacy models and all Current models except for PJ2-4B
Button 1
2
Press, Release
Button 2
3
Press, Release
Button 3
4
Press, Release
Button Raise
5
Press, Release
Button Lower
6
Press, Release
Button 1
8
Press, Release
Button 2
9
Press, Release
Button 3
10
Press, Release
Button 4
11
Press, Release
For PJ2-4B model only
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Example DEVICE Commands
Examples presume Pico® control has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1 (on a non-4B model).
#DEVICE,2,2,3<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
Button 1 was pressed.
~DEVICE,2,2,3<CR><LF>
109
Lutron integration protocol
®
Dynamic Keypad
Model: H
Q-J-DK420
HQ-J-DK420
Why Integrate with a Dynamic Keypad?
• Recognize a button press / release in order to control a third party device from the Dynamic Keypad’s
user interface
• Simulate a button press
• Control LEDs of unprogrammed buttons
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Dynamic Keypad
110

Lutron integration protocol
®
Dynamic Keypad (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1 (left hard button)
1
Press, Release
Button 2 (middle hard button)
2
Press, Release
Button 3 (right hard button)
3
Press, Release
Button N 1
N
Press, Release
M
Set or Get LED state
LED
M1
NOTE
1. Component Numbers for the various pages of buttons and LEDs for a Dynamic Keypad are generated by the
HomeWorks® QS Software.
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Hold
5
None
Multi-tap
6
None
Set (#) or Get (?) LED State
9
0 = Off
1 = On
2 = Normal-Flash
3 = Rapid-Flash
Example DEVICE Commands
Examples presume the Dynamic Keypad has been assigned Integration ID 23.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 118.
#DEVICE,23,118,3<CR><LF>
Turn On LED 566.
#DEVICE,23,566,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 566?
?DEVICE,23,566,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
~DEVICE,23,566,9,1<CR><LF>
111
Lutron integration protocol
®
Wallbox Input Closure Interface
Model: QSE-CI-WCI
12345678
ON
1
QSE-CI-WCI
INPUTS
ENTRADA
ENTRÉES
2
®
COM
12345678
Why Integrate with a Wallbox Input Closure Interface?
• Simulate a button press
Compatibility
QS
® Clear Connect®
Quantum® RadioRA® 2 HomeWorks
Standalone
QS
Gateway System
Wallbox Input Closure Interface
112



Lutron integration protocol
12345678
®
ON
1
QSE-CI-WCI
INPUTS
ENTRADA
ENTRÉES
Wallbox Input Closure Interface (continued)
DEVICE Commands
2
®
COM
12345678
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 2, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Button 1
1
Press, Release, Multi Tap, Hold, Hold Release
Button 2
2
Press, Release, Multi Tap, Hold, Hold Release
Button 3
3
Press, Release, Multi Tap, Hold, Hold Release
Button 4
4
Press, Release, Multi Tap, Hold, Hold Release
Button 5
5
Press, Release, Multi Tap, Hold, Hold Release
Button 6
6
Press, Release, Multi Tap, Hold, Hold Release
Button 7
7
Press, Release, Multi Tap, Hold, Hold Release
Button 8
8
Press, Release, Multi Tap, Hold, Hold Release
LED 11
81
Set or Get LED state
LED 21
82
Set or Get LED state
LED 31
83
Set or Get LED state
LED
41
84
Set or Get LED state
LED
51
85
Set or Get LED state
LED
61
86
Set or Get LED state
LED
71
87
Set or Get LED state
LED
81
88
Set or Get LED state
NOTE
1. Available only on units in a Quantum® or HomeWorks® system.
113
Lutron integration protocol
12345678
®
ON
1
QSE-CI-WCI
INPUTS
ENTRADA
ENTRÉES
Wallbox Input Closure Interface (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Action Number
Parameters
3
None
Release
4
None
Hold (only if input mode is Momentary)
5
None
Multi-tap
6
None
9
0 = Off
1 = On
2 = Normal-Flash: 1 flash every second 2
3 = Rapid-Flash: 10 flashes every second 2
32
None
Set (#) or Get (?) LED
Hold Release2
COM
12345678
Press
State 1
2
®
NOTES
1.Quantum® or HomeWorks® only. “Set” is for unprogrammed buttons and buttons with LED logic ‘Defined by Integration.’
2. Available only on units in a Quantum® or HomeWorks® system.
Example DEVICE Commands
Examples presume keypad has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3<CR><LF>
Turn On LED 5.
#DEVICE,2,85,9,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,2,81,9<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
114
~DEVICE,2,81,9,1<CR><LF>
Lutron integration protocol
®
Sivoia® QS Shade
Sivoia® QS Wireless Shade
Why Integrate with a Sivoia® QS Shade?
• Set shades to a specific level
• Query current level
Integration Capabilities
• One controllable output (use OUTPUT command)
Supported Command Types
• OUTPUT allows control and monitoring of the shade output
• SHADEGRP allows control of shade groups in a Quantum® or HomeWorks® QS system. Shade
Groups are collections of shades that operate in unison.
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Sivoia® QS Shade

Sivoia® QS Wireless Shade





Includes all roller, cellular, and drapery styles
115
Lutron integration protocol
®
Sivoia® QS Shade (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Get (?) Zone Level
1
Level 1 = 0–100 or 0.00–100.00 2
Fade 3 in: SS.ss 4, SS, MM:SS, or HH:MM:SS
Delay 5 in: SS.ss 4, SS, MM:SS, or HH:MM:SS
Start Raising
2
None
Start Lowering
3
None
Stop Raising / Lowering
4
None
NOTES
For shades, a level of 0 (or 0.00) equals closed and a level of 100 (or 100.00) equals full open.
0% = Closed; 100% = Open
Fade is not available for shades since they move at a constant rate. The parameter must be entered but is ignored.
Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a delay time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
5. The Delay time is optional. When not used, the system will use a zero-second delay. The minimum delay time is
0.25 seconds. The maximum delay time is 4 hours. Not supported in QS Standalone.
1. 2. 3. 4.
Example OUTPUT Messages
Examples presume shade has been assigned Integration ID 1.
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set shade to 75% with a 1 min 30 sec delay.
#OUTPUT,1,1,75,0,1:30<CR><LF>
Start Raising shade level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering shade level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
Response 1:
?OUTPUT,1,1<CR><LF>
~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a shade. The actual level is not transmitted while they are moving.
Example: If the Living Room Blackouts (Integration ID 1) are at 20% and are commanded to go to 100% by sending
#OUTPUT,1,1,100 the response from the system will be ~OUTPUT,1,1,100.00
116
Lutron integration protocol
®
Sivoia® QS Shade (continued)
OUTPUT Commands (continued)
SHADEGRP Command Formats
Operation
Integration ID (example)
#SHADEGRP, 2, Action Number, Parameters
Command
Use “SHADEGRP Command-specific fields” tables
to complete these command fields.
SHADEGRP Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Get (?) Shade
Group Level 1
1
Level 2 = 0–100 or 0.00–100.00
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Start Raising 4
2
None
3
None
Stop Raising / Lowering
4
None
Set (#) or Get (?)
Current Preset
6
Preset Number 5 = 0–30
Set (#) Venetian Tilt
14
Level 6 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Set (#) Lift and Tilt
for venetians
15
Lift 6 = 0–100 or 0.00–100.00
Tilt 6 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Raise Venetian Tilt 4
16
None
Tilt 4
17
None
18
None
Raise Venetian Lift 4
19
None
Lower Venetian Lift 4
20
None
Stop Venetian Lift 4
21
None
Start
Lowering 4
Lower Venetian
Stop Venetian
Tilt 4
NOTES
1. Get (?) Shade Group Level (action number 1).
2. The Fade and Delay time are optional. For shades, the Fade parameter has no effect (since shades have fixed speeds)
but it is required when specifying an optional delay. When not used, the system will use a zero-second delay. The
minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a delay time is specified
as 1.45 seconds, a value of 1.25 seconds will be used.
4. When a Raise / Lower command is issued, the shade group’s level will continue to go towards open / close until a Stop
command is received.
5. Preset 0 is the Open Preset and Preset 30 is the Closed Preset.
6. The Level is accepted as a percentage, where 100% is fully open and 0% is fully closed.
117
Lutron integration protocol
®
Sivoia® QS Venetian Blind
Sivoia® QS Wireless Venetian Blind
Why Integrate with a Sivoia® QS Venetian Blind?
• Set Venetian blind tilt, lift to specific levels
• Query current tilt, lift levels
Integration Capabilities
• One controllable output (use OUTPUT command)
Supported Command Types
• OUTPUT allows control and monitoring of the Venetian blind output
• SHADEGRP allows control of shade groups in a Quantum® or HomeWorks® QS system.
Shade Groups are collections of shades that operate in unison
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Sivoia® QS Venetian
Sivoia® QS Wireless Venetian
118





Lutron integration protocol
®
Sivoia® QS Venetian Blind (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Get (?)
Venetian lift level only
1
Lift Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 4 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Set (#) or Get (?)
Venetian tilt level only
9
Tilt Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 4 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Set (#) or Get (?)
Venetian lift & tilt level
10
Lift Level 1 = 0–100 or 0.00–100.00
Tilt Level 1 = 0–100 or 0.00–100.00
Fade 2 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Delay 4 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
Start raising Venetian tilt
11
None
Start lowering Venetian tilt
12
None
Stop Venetian tilt
13
None
Start raising Venetian lift
14
None
Start lowering Venetian lift
15
None
Stop Venetian lift
16
None
NOTES
1.
100%
75%
50%
25%
0%
Lift
Tilt
2. Fade is not available for blinds since they move at a constant rate. The parameter must be entered but is ignored.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a delay time is specified
as 1.45 seconds, a value of 1.25 seconds will be used.
4. The Delay time is optional. When not used, the system will use a zero-second delay. The minimum delay time is
0.25 seconds. The maximum delay time is 4 hours. Not supported in QS Standalone.
119
Lutron integration protocol
®
Sivoia® QS Venetian Blind (continued)
OUTPUT Commands (continued)
Example OUTPUT Messages
Examples presume shade has been assigned Integration ID 1.
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set Venetian blind to lift 0%, tilt 50%
#OUTPUT,1,10,0,50<CR><LF>
Start raising Venetian tilt.
#OUTPUT,1,11<CR><LF>
Stop raising Venetian tilt.
#OUTPUT,1,13<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the Venetian lift and tilt?
Response 1:
?OUTPUT,1,10<CR><LF>
~OUTPUT, Integration ID, Action Number, Parameters
Venetian lift level is 0%, tilt level 50%.
~OUTPUT,1,10,0.00,50.00<CR><LF>
NOTE
1. The system will report the target lift level and target tilt level of a Venetian blind. The actual levels are not transmitted
while it is moving. Example: If the Kitchen Venetian (Integration ID 1) is set at 25% lift and 75% tilt, and is
commanded to go to 100% lift and 50% tilt by sending #OUTPUT,1,10,100,50, the response from the system will be
~OUTPUT,1,10,100.00,50.00
120
Lutron integration protocol
®
Maestro® Dimmer and Plug-In Module
RadioRA® 2 Models (RRD-): 6D, 6NA, 8ANS, 8S-DV, 10D, 10ND, F6AN-DV, 3LD
RadioRA® 2 Models (RR-): 3PD, 15APS
HomeWorks® QS Models (HQRD-, HQRA): 6D, 6ND, 10D, 10ND, 6NA, F6AN-DV, 8ANS, 8S-DV
HomeWorks® QS Models (HWD-, HWA-): 6D, 6ND, 10D, 10ND, 5NE 1, 8ANS
HomeWorks® QS Models (HQR-): 3PD-1, 15APS-1, 3LD
Clear Connect® Device Models (CCD-W): 6D, 6NA, F6AN-DV, 15APS-1
NOTE
1. 5NE is not available in architectural style
6D
3PD
LUTRON
Why Integrate with a Maestro® Dimmer or Plug-In Module?
• Turn On to specific light level or Off
• Raise / Lower light level
• Query current light level
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Quantum® RadioRA® 2
Gateway System
Standalone
QS
RadioRA® 2 Model
HomeWorks® QS Model
Clear Connect® Device Model



121
Lutron integration protocol
®
Maestro® Dimmer (continued)
OUTPUT Commands
LUTRON
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set or Get Zone Level
1
Level = 0–100 or 0.00–100.00
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Start Raising
2
None
Start Lowering
3
None
Stop Raising / Lowering
4
None
5
Fade 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Delay 1 in: SS.ss 2, SS, MM:SS, or HH:MM:SS
Start
Flashing 3, 4, 5
NOTES
1. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second delay.
2. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.31 seconds a value of 1.25 seconds will be used.
3. The system will not report a level while the output is flashing, it will instead report that it is flashing.
4. Default flash every second, unless fade time is specified (flash period is 2× fade time).
5. To stop a dimmer from flashing, send it to a valid level.
Example OUTPUT Commands
Examples presume dimmer has been assigned Integration ID 1.
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set dimmer to 75% with a 1 min 30 sec fade.
#OUTPUT,1,1,75,01:30<CR><LF>
Start Raising dimmer level.
#OUTPUT,1,2<CR><LF>
Stop Raising / Lowering dimmer level.
#OUTPUT,1,4<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
Response 1:
?OUTPUT,1,1<CR><LF>
~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to 90%.
~OUTPUT,1,1,90.00<CR><LF>
NOTE
1. The system will report the target level of a dimmer while it is fading from one level to another.
The actual level is not transmitted while dimming between levels.
Example: If the “Over Sink” (1) dimmer is at 20% and is then commanded to go to 100% by sending #OUTPUT,1,1,100,
the response from the system will be ~OUTPUT,1,1,100.00
122
Lutron integration protocol
®
Maestro® Dimmer (continued)
DEVICE Commands
LUTRON
DEVICE Command Format
Operation
Integration ID (example)
#DEVICE 1, 2, Component Number, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
NOTE
1. Supported only in HomeWorks® QS 4.0 or higher.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Maestro® Tap Switch
6
Available Actions
Press, Release, Double Tap, Hold
Action Numbers and Parameters:
Action
Action Number
Parameters
Press
3
None
Release
4
None
Hold
5
None
Double Tap
6
None
Example OUTPUT Commands
Examples presume dimmer has been assigned Integration ID 2.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Button 1.
#DEVICE,2,1,3,<CR><LF>
123
Lutron integration protocol
®
Maestro® Fan Speed Control
RadioRA® 2 Models (RRD-): 2ANF
HomeWorks® QS Models (HQRD-, HQRA-, HWD-, HWA-): 2ANF
2ANF
LUTRON
LUTRON
Why Integrate with a Maestro® Fan Speed Control?
•Turn On to specific speed (High, Medium-High, Medium, Low, or Off)
• Raise / Lower fan speed
• Query current speed
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
RadioRA® 2 Fan Speed Control
HomeWorks® QS Fan Speed
Control
124


Lutron integration protocol
®
Maestro® Fan Speed Control (continued)
OUTPUT Commands
LUTRON
OUTPUT Command Format
Operation
Integration ID (example)
#OUTPUT 1, 1, Action Number, Parameters
Command
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
NOTE
1. Supported only in HomeWorks® QS 4.0 or higher and RadioRA® 2 6.0 or higher.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Set or Get Zone Level
Action Number
1
Parameters
Levels:
0 = Off
1–25% = Low
26–50% = Medium
56–75% = Medium High
76–100% = High
Example OUTPUT Commands
Examples presume dimmer has been assigned Integration ID 1.
Operation
Command String
Execute: #OUTPUT, Integration ID, Action Number, Parameters
Set fan speed to Medium High.
#OUTPUT,1,1,75<CR><LF>
Query: ?OUTPUT, Integration ID, Action Number
What is the state of the output?
?OUTPUT,1,1<CR><LF>
Response 3: ~OUTPUT, Integration ID, Action Number, Parameters
Output level is set to High.
~OUTPUT,1,1,100.00<CR><LF>
125
Lutron integration protocol
®
Visor Control Receiver
RadioRA® 2 Model: RR-VCRX
HomeWorks® QS Model: HQR-VCRX
RR-VCRX
Visor Control Receiver
Security Input
Inputs
Full
Flash
Outputs
Keypad
Visor Transmitter
Learn
Power
Inputs
9V
1
2
Outputs
Full
Flash C
1
C
2
C
3
C
4
C
Why Integrate with a Visor Control Receiver?
• Simulate a keypad press or contact closure inputs
• Control LEDs of unprogrammed buttons
• Control contact closure outputs
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Visor Control Receiver
126


Lutron integration protocol
®
Visor Control Receiver
Inputs
Security Input
Outputs
Keypad
Full
Flash
Visor Control Receiver (continued)
DEVICE Commands
Visor Transmitter
Learn
DEVICE Command Formats
Operation
Power
Inputs
9V
1
Outputs
Full
2 Flash C
1
C
2
C
3
C
4
C
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Scene 1
1
Press, Release
Scene 2
2
Press, Release
Scene 3
3
Press, Release
Scene 4
4
Press, Release
Scene 5
5
Press, Release
Scene 6
6
Press, Release
Full / Security
30
Open Input, Close Input
Security Flash
31
Open Input, Close Input
Input 1
32
Open Input, Close Input
Input 2
33
Open Input, Close Input
LED Scene 1
81
Set or Get LED state
LED Scene 2
82
Set or Get LED state
LED Scene 3
83
Set or Get LED state
LED Scene 4
84
Set or Get LED state
LED Scene 5
85
Set or Get LED state
LED Scene 6
86
Set or Get LED state
Action Numbers and Parameters:
Action
Action Number
Parameters
Press, Close Input
3
None
Release, Open Input
4
None
Set (#) or Get (?) LED State
Note: Valid for Scene LEDs only
9
0 = Off; 1 = On
127
Lutron integration protocol
Visor Control Receiver
®
Inputs
Security Input
Outputs
Keypad
Full
Flash
Visor Control Receiver (continued)
DEVICE Commands (continued)
Example DEVICE Commands
Examples presume Visor Control Receiver has been assigned Integration ID 5.
Operation
Command String
Execute: #DEVICE, Integration ID, Component Number, Action Number, Parameters
Press Scene 1.
#DEVICE,5,1,3<CR><LF>
Turn On Scene 1 LED.
#DEVICE,5,9,81,1<CR><LF>
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the state of LED 1?
?DEVICE,5,9,81<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
LED 1 is On.
128
~DEVICE,5,9,81,1<CR><LF>
Visor Transmitter
Learn
Power
Inputs
9V
1
Outputs
Full
2 Flash C
1
C
2
C
3
C
4
C
Lutron integration protocol
®
Visor Control Receiver
Inputs
Security Input
Outputs
Keypad
Full
Flash
Visor Control Receiver (continued)
OUTPUT Commands
OUTPUT Command Format
Operation
Visor Transmitter
Learn
Power
Inputs
9V
1
Outputs
Full
2 Flash C
1
C
2
C
3
C
4
C
Integration ID (example)
#OUTPUT,21, Action Number, Parameters
Command
Action number is always
1 for visor control outputs
Use “OUTPUT Command-specific fields” tables
to complete the parameter field.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Set (#) or Query (?) Output State
1
Level 1 = 0–100 or 0.00–100.00
Set Pulse CCO (#)
6
Pulse 2 time in: SS.ss 3, SS, MM:SS, or HH:MM:SS, or
Delay 4 in: SS.ss 3, SS, MM:SS, or HH:MM:SS
NOTES
1. Any level greater than 0 will close the output. When level is equal to 0 the output will open.
2. The default time is one second.
3. Fractional seconds “SS.ss” will be rounded down to the nearest quarter second. For example, if a fade time is specified
as 1.45 seconds a value of 1.25 seconds will be used.
4. The Fade and Delay time are optional. When not used, the system will use a one-second fade time with zero-second
delay. The minimum fade and delay time is 0 seconds. The maximum fade and delay time is 4 hours. For shade outputs,
the Fade parameter has no effect (since shades have fixed speeds) but it is required when specifying an optional delay.
Example OUTPUT Messages
Examples presume CCO has been assigned Integration ID 21.
Operation
Command String
Set: #OUTPUT, Integration ID, Action Number, Parameters
Set output to open.
#OUTPUT,21,1,0<CR><LF>
Set output to close.
#OUTPUT,21,1,1<CR><LF>
Query 1:
?OUTPUT, Integration ID, Action Number
What is the state of the output?
Response 2:
?OUTPUT,21,1<CR><LF>
~OUTPUT, Integration ID, Action Number
Output state is closed.
~OUTPUT,21,1,100.00<CR><LF>
NOTES
1. Momentary outputs should not be queried.
2. The system will report the target level of outputs. Any level greater than 0 means that the output is closed.
129
Lutron integration protocol
®
Radio Powr SavrTM Sensor
CURRENT Models (LRF2-, CCD-): OCR2B, VCR2B, OKLB, OHLB, OWLB, VKLB, VHLB, VWLB
LEGACY Models (LRF2-): OCRB, VCRB
LRF2-OCR2B
LRF2-OKLB
Why Integrate with a Radio Powr SavrTM Sensor?
• Monitor occupied, unoccupied status of a single sensor
Compatibility
QS
HomeWorks® Clear Connect®
Quantum® RadioRA® 2
Gateway System
Standalone
QS
Radio Powr SavrTM Sensor
130



Lutron integration protocol
®
Radio Powr SavrTM Sensor (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
~DEVICE, 19, 2, Action Number
Command
Occupied state component
is always 2 for sensors
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Occupied State
2
Available Actions
Occupied, Unoccupied
Action Numbers:
Action
Action Number
Occupied
3
Unoccupied
4
Example DEVICE Commands
Examples presume sensor has been assigned Integration ID 19.
Operation
Command String
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
Radio Powr SavrTM 19 went occupied.
~DEVICE,19,2,3<CR><LF>
Radio Powr SavrTM 19 went unoccupied.
~DEVICE,19,2,4<CR><LF>
131
Lutron integration protocol
®
HVAC Controller
MODELS (LR-): HVAC-1-WH, HWLV-HVAC, HVAC-230-S, HVAC-PLC1-CPN7120
MODELS (MWP-T-): OHW-WH-A
LR-HVAC-1-WH
LR-HVAC-230-S
LR-HVAC-PLC1-CPN7120
•
•
•
•
•
MWP-T-OHW-WH-A
Why Integrate with an HVAC Controller?
Get current temperature
Set or get heat setpoints and cool setpoints
Set or get operating mode, fan mode and Eco Mode
Get connection status to the temperature sensor
Get schedule information and hold schedules
Supported Command Types
• HVAC allows control and monitoring of the HVAC Controller
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
HVAC Controller
132


Lutron integration protocol
®
HVAC Controller (continued)
HVAC Commands
HVAC Command Format
Operation Integration ID (example)
#HVAC,21, Action Number, Parameters
Command
Use “HVAC Command-specific fields” tables
to complete these command fields.
HVAC Command-specific fields
Action Numbers and Parameters:
Action
Action Number
Parameters
Get (?) Current Temperature (°F)
1
Temperature = 32–212 °F
Set (#) or Get (?) Heat and Cool
Setpoints (°F)1
2
Set (#) or Get (?) Operating Mode
3
Set (#) or Get (?) Fan Mode
4
Heat Setpoint = 32–212 °F
Cool Setpoint = 32–212 °F
Mode (1 = Off/Protect, 2 = Heat, 3 = Cool, 4 = Auto,
5 = Em.Heat, 7= Fan, 8 = Dry)
Mode (1 = Auto, 2 = On, 3 = Cycler, 4 = No Fan,
5 = High, 6 = Medium, 7 = Low, 8 = Top)
Set (#) or Get (?) Eco (Setback) Mode
5
Mode (1 = Off, 2 = On)
Get (?) Eco Offset
6
Eco Offset = 1–11 °F
Set (#) or Get (?) Schedule Status2
7
Get (?) Temperature Sensor
Connection Status
8
Get (?) Schedule Event
9
Schedule # (1–7), Event # (1–4), HH,MM, SPH, SPC
Get (?) Schedule Day Assignment
10
Get (?) System Mode
11
Get (?) Heat and Cool Setpoints (°F)
without Eco Offset if applied
12
Set (#) Emergency Heat Available
13
Schedule#(1–7), DD(Bitmap:Sunday(Bit 0)–
Saturday(Bit 6) 1–active day, 0–inactive day)
1 = Normal
2 = Away
3 = Green
Heat Setpoint = 32 – 212 °F
Cool Setpoint = 32 – 212 °F
1 = Not Available
2 = Available
0 = Schedule Unavailable (Get “?” Only)
1 = Following Schedule (Set “#” or Get “?”)
2 = Permanent Hold (Set “#” or Get “?”)
3 = Temporary Hold (Get “?” only)
1 = All Sensors are Active
2 = Missing Sensor
3 = Wired Sensor Only
4 = No Sensor
NOTE
1. Changing the setpoint will turn Eco Mode off if it is currently on.
2. Schedule Unavailable –> Schedule not programmed or device needs date / time.
Following Schedule –> Running programmed schedule; set points from schedule.
Permanent Hold –> Schedule is not running; set points as adjusted.
Temporary Hold –> Running schedule; set points as adjusted. Returns to following schedule at next schedule event.
Continued on next page…
133
Lutron integration protocol
®
HVAC Controller (continued)
HVAC Commands (continued)
HVAC Command-specific fields (continued)
Action Numbers and Parameters (continued):
Action
Action Number
Parameters
Get (?) Call Status
14
0 = None, Last was Heat
1 = Heat Stage 1
2 = Heat Stage 1 and 2
3 = Heat Stage 1, 2 and 3
4 = Heat Stage 3
5 = None, Last was Cool
6 = Cool Stage 1
7 = Cool Stage 1 and 2
8 = Off
9 = Emergency Heat
10 = Dry
Get (?) Current Temperature (°C)1
15
Temperature = 0 –100 °C
Set (#) or Get (?) Heat and Cool Setpoints
(°C)2
Get (?) Heat and Cool Setpoints (°C)
without Eco Offset if applied2
16
Heat Setpoint = 0 –100 °C
Cool Setpoint = 0 –100 °C
Heat Setpoint = 0 –100 °C
Cool Setpoint = 0 –100 °C
17
NOTE
1.HomeWorks® QS software version 4.1 and higher.
2. Changing the setpoint will turn Eco Mode off if it is currently on.
Example HVAC Commands
Operation
Command String
Execute: #HVAC, Integration ID, Action Number, Parameters
Set Heat Setpoint to 68 °F and Cool Setpoint to 72 °F.
#HVAC,1,2,68,72<CR><LF>
Set System Mode to Cool.
#HVAC,1,3,3<CR><LF>
Turn Eco Mode On.
#HVAC,1,5,2<CR><LF>
Query: ?HVAC, Integration ID, Action Number
What is the Current Temperature?
?HVAC,1,1<CR><LF>
What is are the settings for Schedule 1, Event 2?
?HVAC,1,9,1,2<CR><LF>
What days are running Schedule 1?
?HVAC,1,10,1<CR><LF>
Response: ~HVAC, Integration ID, Action Number, Parameters
Current Temperature is 70 °F.
~HVAC,1,1,70<CR><LF>
Schedule 1, Event 2 starts at 8:00am with SPH=65,SPC=78
~HVAC,1,9,1,2,08,00,65,78<CR><LF>
Schedule 1 is being run on Monday and Tuesday.
~HVAC,1,10,1,06<CR><LF>
134
Lutron integration protocol
®
Wireless Temperature Sensor
Model: L
RF2-TWRB
Link
Test
Why Integrate with a Wireless Temperature Sensor?
• Get battery status
Note: To get current temperature, see HVAC Controller on page 132.
Additional Commands
•None
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
Wireless Temperature Sensor


135
Lutron integration protocol
®
Link
Wireless Temperature Sensor (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
?DEVICE, 1, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number
Available Actions
Battery Status
1
Get battery status
Action Numbers and Parameters:
Action
Get battery status
Action Number
22
Parameters
1 = Normal, 2 = Low
Example DEVICE Messages
Operation
Command String
Query: ?DEVICE, Integration ID, Component Number, Action Number
What is the Temperature Sensor’s Battery Status?
?DEVICE,1,1,22<CR><LF>
Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters
Temperature Sensor’s Battery is Low.
136
~DEVICE,1,1,22,2<CR><LF>
Test
Lutron integration protocol
®
QSE-IO
Model: QSE-IO
STAT
CCO 1
CCO 2
CCO 3
CCO 4
CCO 5
N
O
8 7 6 5 4 3 2 1
®
QSE-IO
24 V
100 mA
800.523.9466
+1.610.282.3800
www.lutron.com/qs
V
R
R
0-24 V
0-24 V
1A
½A
V
5 COM
CCO 5 NO
CCO 5 NC
CCO 4 NO
CCO 4 NC
3-4 COM
CCO 3 NO
CCO 3 NC
COM
CCI 5
CCI 4
CCI 3
CCI 2
CCI 1
MUX
MUX
COM
V+
CCO 2 NO
CCO 2 NC
1-2 COM
CCO 1 NO
CCO 1 NC
QS
243C IND. CONT. EQ.
4 3 2 1
Why Integrate with a QSE-IO?
• Know the state of the Contact Closure Inputs (CCIs).
• Control the state of the Contact Closure Outputs (CCOs).
Integration Capabilities
•
•
•
•
•
•
5 Contact Closure Inputs (CCIs) and 5 Contact Closure Outputs. The QSE-IO mode of operation is specified
by its DIP switch configuration.
CCI and CCO states can be polled in any DIP configuration.
CCI events can be monitored through integration in any DIP configuration.
CCI events (closures or openings of CCIs) can be ‘spoofed’ (faked) through integration in DIP configurations
where momentary CCIs are specified.
CCO events can be monitored through integration in any DIP configuration.
The CCO state logic is typically tied to the states of the CCIs or other devices on the QS link and thus, CCO
events cannot be generated through integration in most DIP configurations; the exceptions are the output
DIP configurations (e.g., Shade Output, Zone Control Output) and the Integration DIP configuration that
allows full monitoring of CCIs and control of CCOs through integration.
Occupancy events can be monitored through integration when the QSE-IO is in an Occupancy DIP
configuration.
Supported Command Types
• DEVICE allows monitoring of CCI and CCO events and polling of CCI/CCO states and in certain QSE-IO DIP
configurations, allows ‘spoofing’ of CCI events and generation of CCO events.
• OUTPUT (in certain output-oriented QSE-IO DIP configurations) allows control and monitoring of the CCOs.
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
QSE-IO



137
STAT
N
O
®
8 7 6 5 4 3 2 1
CCO 1
CCO 2
CCO 3
CCO 4
CCO 5
Lutron integration protocol
®
QSE-IO
24 V
100 mA
800.523.9466
+1.610.282.3800
www.lutron.com/qs
0-24 V
0-24 V
Integration ID (example)
#DEVICE, 5, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
1.
2.
3.
4.
Component Number Available Actions
CCI 1
1
CCI 2
2
CCI 3
3
CCI 4
4
CCI 5
5
CCO 1
11
CCO 2
12
CCO 3
13
CCO 4
14
CCO 5
15
Occupancy Sensor 1
Occupancy Sensor 2
Occupancy Sensor 3
Occupancy Sensor 4
Occupancy Sensor 5
41
42
43
44
45
Report (~) closure/opening1
Poll (?) status
Spoof (#) closure/opening2
Report (~) closure/opening1
Poll (?) status
Spoof (#)closure/opening2
Report (~) closure/opening1
Poll (?) status
Spoof (#)closure/opening2
Report (~) closure/opening1
Poll (?) status
Spoof (#)closure/opening2
Report (~) closure/opening1
Poll (?) status
Spoof (#)closure/opening2
Report (~) closure/opening3
Poll (?) status
Generate (#) closure/opening2
Report (~) closure/opening3
Poll (?) status
Generate (#) closure/opening2
Report (~) closure/opening3
Poll (?) status
Generate (#) closure/opening2
Report (~) closure/opening3
Poll (?) status
Generate (#) closure/opening2
Report (~) closure/opening3
Poll (?) status
Generate (#) closure/opening2
Report (~) occupied/unoccupied2,4
Report (~) occupied/unoccupied2,4
Report (~) occupied/unoccupied2,4
Report (~) occupied/unoccupied2,4
Report (~) occupied/unoccupied2,4
NOTES
Monitoring type 2 must be enabled (see QSE-CI-NWK-E #MONITORING section)
Feature supported in only some QSE-IO DIP configurations
Monitoring type 5 must be enabled (see QSE-CI-NWK-E #MONITORING section)
Monitoring type 6 must be enabled (see QSE-CI-NWK-E #MONITORING section)
138
V
COM
CCI 5
CCI 4
CCI 3
CCI 2
CCI 1
DEVICE Command Formats
Operation
1A
½A
5 COM
CCO 5 NO
CCO 5 NC
MUX
MUX
COM
V+
4 3 2 1
R
R
CCO 2 NO
CCO 2 NC
1-2 COM
CCO 1 NO
CCO 1 NC
QS
243C IND. CONT. EQ.
CCO 4 NO
CCO 4 NC
3-4 COM
CCO 3 NO
CCO 3 NC
QSE-IO (continued)
DEVICE Commands
V
STAT
N
O
®
8 7 6 5 4 3 2 1
CCO 1
CCO 2
CCO 3
CCO 4
CCO 5
Lutron integration protocol
®
QSE-IO
24 V
100 mA
800.523.9466
+1.610.282.3800
0-24 V
0-24 V
R
R
1A
½A
V
5 COM
CCO 5 NO
CCO 5 NC
COM
CCI 5
CCI 4
CCI 3
CCI 2
CCI 1
MUX
MUX
4 3 2 1
243C IND. CONT. EQ.
CCO 4 NO
CCO 4 NC
3-4 COM
CCO 3 NO
CCO 3 NC
QS
COM
V+
V
CCO 2 NO
CCO 2 NC
1-2 COM
CCO 1 NO
CCO 1 NC
QSE-IO (continued)
DEVICE Commands (continued)
www.lutron.com/qs
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
Report (~) Closure/Occupied
Spoof (#) Closure1
Report (~) Opening/Unoccupied
Spoof (#) Opening1
Poll (?) CCO State
Report (~) CCO State
Set (#) CCO State1
Poll (?) CCI State
Action Number
Parameters
3
None
4
None
14
None
Level (0 = Open, 100 = Close)
Level (0 = Open, 100 = Close)
None
33
NOTE
1. Feature supported in only some QSE-IO DIP configurations
139
STAT
N
O
8 7 6 5 4 3 2 1
®
CCO 1
CCO 2
CCO 3
CCO 4
CCO 5
Lutron integration protocol
®
QSE-IO
24 V
100 mA
800.523.9466
+1.610.282.3800
www.lutron.com/qs
0-24 V
0-24 V
Use “OUTPUT Command-specific fields” tables
to complete these command fields.
OUTPUT Command-specific fields
Action Numbers and Parameters:
Action
Get (?) CCO state
Report (~) CCO state
Set (#) CCO state1
Action Number
1
NOTE
1. Feature supported in only some QSE-IO DIP configurations
140
Parameters
None
Level (0 = Open, 100 = Close)
Level (0 = Open, 100 = Close)
V
COM
CCI 5
CCI 4
CCI 3
CCI 2
CCI 1
#OUTPUT, 1, Action Number, Parameters
1A
½A
5 COM
CCO 5 NO
CCO 5 NC
Integration ID (example)
Command
MUX
MUX
OUTPUT Command Formats
Operation
COM
V+
4 3 2 1
R
R
CCO 2 NO
CCO 2 NC
1-2 COM
CCO 1 NO
CCO 1 NC
QS
243C IND. CONT. EQ.
CCO 4 NO
CCO 4 NC
3-4 COM
CCO 3 NO
CCO 3 NC
QSE-IO (continued)
OUTPUT Commands
V
Lutron integration protocol
®
QS Sensor Module
Models: QSMX-, QSM2-, QSM3-, QSM4-, QSM5-, QSM6-, QSM7-
Why Integrate with a QS Sensor Module?
•
View occupancy events that occur.
Integration Capabilities
•
•
Can view occupancy events for up to 14 sensors.
Can view Pico® button Press/Release Events.
Compatibility
QS
HomeWorks® Clear Connect®
Standalone Quantum® RadioRA® 2 QS
Gateway System
QS Sensor Module

141
Lutron integration protocol
®
QS Sensor Module (continued)
DEVICE Commands
DEVICE Command Formats
Operation
Integration ID (example)
#DEVICE, 19, Component Number, Action Number, Parameters
Command
Use “DEVICE Command-specific fields” tables
to complete these command fields.
DEVICE Command-specific fields
Component Numbers:
Component
Component Number Available Actions
Wired Occupancy sensors
Wireless Occupancy sensors 1 – 10
Pico® 1 Buttons1,2
Pico® 2 Buttons1,2
Pico® 3 Buttons1,2
Pico® 4 Buttons1,2
Pico® 5 Buttons1,2
Pico® 6 Buttons1,2
Pico® 7 Buttons1,2
Pico® 8 Buttons1,2
Pico® 9 Buttons1,2
Pico® 10 Buttons1,2
1 – 4
5 – 14
61 – 651,2
82 – 861,2
103 – 1071,2
124 – 1281,2
145 – 1491,2
166 – 1701,2
187 – 1911,2
208 – 2121,2
229 – 2331,2
250 – 2541,2
Occupied, Unoccupied
Occupied, Unoccupied
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
Press, Release
NOTES
1. All models except PJ2-4B: Pico® button order (Top, Favorite, Bottom, Raise, Lower) dictates Component Number (see
Pico® 1 example, below):
Pico® 1 Button Sample Component Number
Top
Favorite
Bottom
Raise
Lower
61
62
63
64
65
2. Model PJ2-4B* only: Pico® button order is 1, 2, 3, 4 and component mapping will be as below:
Pico® 1 Button Sample Component Number
1
2
3
4
61
64
65
63
* Model PJ2-4B is supported only on QSM software version 7.28 and higher.
Continued on next page…
142
Lutron integration protocol
®
QS Sensor Module (continued)
DEVICE Commands (continued)
DEVICE Command-specific fields (continued)
Action Numbers and Parameters:
Action
(~) Report Occupied/Button Press
(~) Report Unoccupied/Button Release
Action Number
3
4
Parameters
None
None
Example DEVICE Commands
Examples presume QSM has been assigned integration ID QSMID.
Operation
Command String
Response: ~DEVICE, Integration ID, Component Number, Action Number
Wired Occupancy Sensor 1 transitions to Occupied
~DEVICE,QSMID,1,3<CR><LF>
Wired Occupancy Sensor 1 transitions to Unoccupied
~DEVICE,QSMID,1,4<CR><LF>
Wireless Occupancy Sensor 1 transitions to Occupied
~DEVICE,QSMID,5,3<CR><LF>
Wireless Occupancy Sensor 1 transitions to Unoccupied ~DEVICE,QSMID,5,4<CR><LF>
Pico® 1 Favorite button press
~DEVICE,QSMID,62,3<CR><LF>
143
Worldwide Technical and Sales Assistance
If you have questions concerning the installation or operation
of this product, call the Lutron® Technical Support Center.
Please provide the exact model number when calling.
Model number can be found on the product packaging.
Example: SZ-CI-PRG
U.S.A., Canada, and the Caribbean: 1.800.523.9466
Other countries call:
+1.610.282.3800
Fax:+1.610.282.1243
Visit us on the web at www.lutron.com
)Lutron, Lutron, Clear Connect, EcoSystem, GRAFIK Eye, HomeWorks,
Maestro, Pico, Quantum, RadioRA, seeTouch, Sivoia, and Softswitch are registered
trademarks and Architrave, Energi Savr Node, GRAFIK, Hyperion, Q-Design,
Radio Powr Savr, and Signature Series are trademarks of Lutron Electronics Co., Inc.
IEEE is a registered trademark of the Institute of Electrical and Electronics Engineers,
Inc., (IEEE). This publication is not endorsed or approved by the IEEE.
DALI is a registered trademark of ZVEI - Zentralverband Elektrotechnik-und
Elektronikindustrie e.V.
This publication is not endorsed or approved by Apple, Inc.
© 2014 – 2015 Lutron Electronics Co., Inc.
P/N 040249 Rev. R 07/2015
Lutron Electronics Co., Inc.
7200 Suter Road
Coopersburg, PA 18036 USA
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement