Lutron Integration Protocol Installation Directions
2014-07-04
: Pdf 437972-Installationsheet 437972-InstallationSheet 027557 Batch5 unilog
Open the PDF directly: View PDF .
Page Count: 143
Download | |
Open PDF In Browser | View PDF |
Lutron ® integration protocol revision O 10 April 2014 Lutron integration protocol ® Updates new to this release 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) 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) Continued on next page… 2 Lutron integration protocol ® Updates new to this release of the Lutron® Integration Protocol (continued) Revision Update: O (continued) 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) Energi Savr NodeTM QS for 0 –10V/Softswitch®/Phase Adaptive (Phase Adaptive models added) • 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) Continued on next page… 3 Lutron integration protocol ® Updates new to this release of the Lutron® Integration Protocol (continued) Revision Update: O (continued) 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) Architrave 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 • 4 Lutron integration protocol ® Revisions to previous releases of the Lutron® Integration Protocol • Revision Update: N • • • Integrator’s Reference – DEVICE Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9, 10 – OUTPUT Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12, 13 – MONITORING Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 – SYSTEM Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Quantum® System Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50, 53 GRAFIK Eye® QS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70, 71 Pico® wireless controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 • HVAC Controller Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 • Integrator’s Reference – Compatibility Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 – GROUP Command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 RadioRA® 2 System Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Clear Connect® Gateway System Commands and Features. . . . . . . . . . . . . . . . . . . 41 • • Revision Update: M Revision Update: L 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. . . . . . . . . . . . . . . . 33 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 asand line feed is shown as . 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 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 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 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 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 ( , ASCII 13) and a new line ( , 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 Response: ~ GROUP, Integration ID, Action Number, Parameters Occ group 1 is occupied ~GROUP,1,3,3 Occ group 1 is unknown ~GROUP,1,3,255 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 Parameter count mismatch. ~ERROR,1 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 Object does not exist ~ERROR,2 Invalid Action: The action does not exist for this command Send invalid action (4321) to Area 2 #AREA,2,4321 Invalid action number ~ERROR,3 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 Parameter data out of range ~ERROR,4 Parameter data malformed: The parameter data given was not formatted properly Set Time to 12:23:24:25 #SYSTEM,1,12:23:24:25 Invalid action number ~ERROR,5 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 What actions are available for #OUTPUT? ?HELP,#OUTPUT How is “Raise” used for #OUTPUT? ?HELP,#OUTPUT,2 Response: ~HELP, Help Information The list of all Integration Commands. #OUTPUT,?OUTPUT,#DEVICE,?DEVICE,#AREA, ?AREA,#TIMECLOCK,?TIMECLOCK,#SYSTEM, ?SYSTEM,#MONITORING,?MONITORING, The help information for the #OUTPUT command. ~HELP, #OUTPUT requires action<1–6> 1 = Set Level / Position 2 = Start Raising 3 = Start Lowering 4 = Stop Raising / Lowering 6 = Pulse USAGE: #OUTPUT, , , The help information for the “Raise” action (#OUTPUT). ~HELP, #OUTPUT, start raising output level USAGE: #OUTPUT, , 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 Set date to June 1, 2009. #SYSTEM,2,06/01/2009 Query: ?SYSTEM, Action Number What is the system time? ?SYSTEM,1 What is the system date? ?SYSTEM,2 Response: ~SYSTEM, Action Number, Parameters The system time is 11:05 AM. ~SYSTEM,1,11:05:00 The system date is July 3, 2009. ~SYSTEM,2,07/03/2009 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: Subnet Mask: Gateway: 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 Set Gateway Address to 10.2.4.1 #ETHERNET,1,10.2.4.1 Query: ?ETHERNET, Configuration Number, Parameters What is the IP Address? ?ETHERNET,0 What is the Login Information for user 1? ?ETHERNET,3,1 What is the Login Information for ALL users? (Note: 0 = ALL) ?ETHERNET,3,0 Response: ~DEVICE, Integration ID, Configuration Number, Parameters The IP Address is 192.168.250.1 ~ETHERNET,0=,192.168.250.1 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 Response: ~INTEGRATIONID, Action Number, Parameters Set the Integration ID for a serial number ~INTEGRATIONID,1,1234ABCD,kitchen dimmer Execute: ?INTEGRATIONID, Action Number, Parameters Get the Integration ID for a serial number ?INTEGRATIONID,1,5678EFEF Response: ~INTEGRATIONID, Action Number, Parameters Get the Integration ID for a serial number ~INTEGRATIONID,1,5678EFEF,living room keypad Execute: #INTEGRATIONID, Action Number, Parameters Change the Integration ID #INTEGRATIONID,2,diningroomlights1,diningroomaccents Response: ~INTEGRATIONID, Action Number, Parameters Change the Integration ID ~INTEGRATIONID,2,diningroomlights1,diningroomaccents Execute: ?INTEGRATIONID, Action Number, Parameters Get information about an Integration ID command ?INTEGRATIONID,3,livingroomkeypad Response: ~INTEGRATIONID, Action Number, Parameters Get information about an Integration ID command ~INTEGRATIONID,3,livingroomkeypad,DEVICE,5678EFEF 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 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 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 Restore NWK to factory defaults #RESET,1 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 ~PROGRAMMING,1,1,1,living room sheer,0,100 #PROGRAMMING,1,2,5,kitchen venetian,0,0,50 28 ~PROGRAMMING,1,2,5,kitchen venetian,0,0,50 #PROGRAMMING,1,3,6,kitchen venetian,0,75 ~PROGRAMMING,1,3,6,kitchen venetian,0,75 #PROGRAMMING,1,4,7,kitchen venetian,0,15 ~PROGRAMMING,1,4,7,kitchen venetian,0,15 #PROGRAMMING,1,2,1,dining room blackout,0,50 ~PROGRAMMING,1,2,1,dining room blackout,0,50 #PROGRAMMING,1,5,4,1 ~PROGRAMMING,1,5,4,1 #PROGRAMMING,1,0,3 Repeat command to clear all phantom button programming #PROGRAMMING,1,0,3 ~PROGRAMMING,1,0,3 #PROGRAMMING,1,6,3 ~PROGRAMMING,1,6,3 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 Display programming of all phantom buttons ?PROGRAMMING,1 Display Stop-If-Moving configuration of phantom button 5 ?PROGRAMMING,1,5,4 Display Stop-If-Moving configuration of all phantom buttons ?PROGRAMMING,1,0,4 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 #DEVICE,1,2,14,50 #DEVICE,1,3,23,50,25 30 #DEVICE,1,4,24,50 #DEVICE,1,5,25,25 #DEVICE,1,6,18 #DEVICE,1,7,19 #DEVICE,1,8,20 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 • IP Address: • Subnet Mask: • Gateway: 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 Release Button 1 #DEVICE,4,1,4 Turn On LED 1. #DEVICE,4,101,9 Query: ?DEVICE, Integration ID, Component Number, Action Number What is the state of LED 1? ?DEVICE,4,101,9 Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters LED 1 is On. 34 ~DEVICE,4,101,9,1 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 Response: ~ GROUP, Integration ID, Action Number, Parameters Occ group 1 is occupied ~GROUP,1,3,3 Occ group 1 is unknown ~GROUP,1,3,255 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 Enable Event Monitoring. #MONITORING,2,1 Query: ?MONITORING, Monitoring Type Is Diagnostic Monitoring disabled? ?MONITORING,1 Response: ~MONITORING, Monitoring Type, Action Number Diagnostic Monitoring is disabled. 36 ~MONITORING,1,2 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 Query: ?TIMECLOCK, Integration ID, Action Number What is the sunrise time? ?TIMECLOCK,4,2 Response: ~TIMECLOCK, Integration ID, Action Number, Parameters The time the sun rises. ~TIMECLOCK,4,2,05:32 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 IP Address: Subnet Mask: Gateway: 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= &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- ” 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 Release Button. 1 #DEVICE,4,1,4 Turn On LED 1. #DEVICE,4,101,9 Query: ?DEVICE, Integration ID, Component Number, Action Number What is the state of LED 1? ?DEVICE,4,101,9 Response: ~DEVICE, Integration ID, Component Number, Action Number, Parameters LED 1 is On. 42 ~DEVICE,4,101,9,1 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 Response: ~ GROUP, Integration ID, Action Number, Parameters Occ group 1 is occupied ~GROUP,1,3,3 Occ group 1 is unknown ~GROUP,1,3,255 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: Subnet Mask: Gateway: 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 Set Gateway Address to 10.2.4.1 #ETHERNET,1,10.2.4.1 Query: ?ETHERNET, Configuration Number, Parameters What is the IP Address? ?ETHERNET,0 What is the Login Information for user 1? ?ETHERNET,3,1 What is the Login Information for ALL users? ?ETHERNET,3,0 (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 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 Response: ~INTEGRATIONID, Action Number, Parameters Get the Integration ID for a serial number ~INTEGRATIONID,1,5678EFEF,1 Execute: ?INTEGRATIONID, Action Number, Parameters Get information about an Integration ID command ?INTEGRATIONID,3,1 Response: ~INTEGRATIONID, Action Number, Parameters Get information about an Integration ID command ~INTEGRATIONID,3,1,DEVICE,5678EFEF 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 Restore NWK to factory defaults #RESET,1