Lutron Integration Protocol GUIDE (040249) Maestro 040249
User Manual: maestro
Open the PDF directly: View PDF
.
Page Count: 160
| Download | |
| Open PDF In Browser | View PDF |
Lutron integration protocol revision V 29 August 2017 Lutron integration protocol Updates new to this release of the Lutron Integration Protocol Revision Update: V • • • • • • • • • • • • • • • • Global Changes Adjusted formatting of Set (#), Get (?), and Report (~) operations so they are shown the same way consistently throughout the entire document Changed “/” to “or” to provide better clarity throughout the entire document Moved most of the footnote references to left column of tables throughout the entire document Integrator’s Reference Added footnotes #4-5 to bottom of page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Added footnote #4 to bottom of page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 QS Standalone Added footnotes #3-4 to bottom of page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Temperature Controls Updated footnote #6. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Deleted footnotes #7-8 and renumbered footnote #9 to #7 . . . . . . . . . . . . . . . . . . . 142 Added new footnote #8 to bottom of page. . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Added footnote #7 to bottom of page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Added second note to bottom of page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Palladiom Thermostat Added footnote #2 to bottom of page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 QSE-IO Reordered parameters for action number 14. . . . . . . . . . . . . . . . . . . . . . . . . . 151 Reordered parameters for action number 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Customer Assistance Updated model number example to more recent product . . . . . . . . . . . . . . . . . . . . 156 Added phone number for Mexico . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Revisions to previous releases of the Lutron Integration Protocol Revision Update: U • Temperature Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . New model added: HQWT-T-HW. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . – Footnote added to the bottom of the page. . . . . . . . . . . . . . . . . . . . . . . . . . – Added footnotes #4-9 to the bottom of the page. . . . . . . . . . . . . . . . . . . . . . . – Action modified: Get (?) Call Status #9. . . . . . . . . . . . . . . . . . . . . . . . . . . . – Added footnotes #4-6 to the bottom of the page. . . . . . . . . . . . . . . . . . . . . . . – Added operation: Set Heat setpoint to 18.5 C and cool setpoint to 21.5 C. . . . . . . . . . – Added the last 3 queries in the table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . – Added the last 3 responses in the table . . . . . . . . . . . . . . . . . . . . . . . . . . . . – Footnote added to the bottom of the page. . . . . . . . . . . . . . . . . . . . . . . . . . 141 141 141 142 143 143 144 144 144 144 Revision Update: T • • Integrator’s Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Footnote #4 was added to the description “Partition Wall” in the Monitoring Type table . . . . . 12 Footnote #4 was added to the bottom of the page. . . . . . . . . . . . . . . . . . . . . . . . 12 Continued on next page… ii Lutron integration protocol • “and HomeWorks” was added to Footnote #3 at the bottom of the page . . . . . . . . . . . . 12 Revision Update: S • • • • • • • • • About Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 New explanation added: Inter-Message Delays. . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Integrator’s Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 DEVICE: Command Summary (Action Numbers and Parameters) . . . . . . . . . . . . . . . . . 6 – Actions added: Set or Get Active LED Level (#36); Set or Get Inactive LED Level (#37) – “Applies only to Palladiom keypads” note added (note 7) DEVICE: Command Summary (HomeWorks QS Button Type and Integration Requirements). . . . 7 – “myRoom plus” added to title. HVAC: Command Summary - New pages added . . . . . . . . . . . . . . . . . . . . . . . . 10 HomeWorks QS System Overview – Energi Savr Node QS was changed to HomeWorks QS in the index. . . . . . . . . . . . . . 46 myRoom plus – New system section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 GRAFIK Eye QS DEVICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 – “myRoom plus” was added to notes (note 1 and 5) Energi Savr Node QS for Dali® – “HomeWorks QS/myRoom Power Module for Dali®” was added to the page heading. . . . . 78 – “HomeWorks QS/myRoom Power Module for Dali®” was added to the compatibility chart. . . 78 – “myRoom Lutron Designer” was added to note 2 under Component Numbers. . . . . . . . . 79 Energi Savr Node QS with EcoSystem – “HomeWorks QS/myRoom Power Module with EcoSystem” was added to the page heading. . . 81 – “HomeWorks QS/myRoom/Power Module/EcoSystem” was added to the Compatibility Chart . . 81 DEVICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 – DEVICE Command Formats - “/myRoom plus” was added to note 1. – DEVICE Command-specific fields: - “/myRoom plus” was added to note 3. Energi Savr Node QS for 0-10 V/Softswitch/Phase Adaptive – “HomeWorks QS/myRoom Power Module with 0-10 V/Softswitch/Phase Adaptive” was added to the page heading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 DEVICE Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 – DEVICE Command Formats - “/myRoom plus” was added to note 1. – DEVICE Command-specific fields: - “/myRoom plus” was added to note 3. Energi Savr Node QS for Motor Module – “HomeWorks QS/myRoom Power Module for Motor Module” was added to the page heading . . 87 – “HomeWorks QS/myRoom/Power Module for Motor Module” was added to the Compatibility Chart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Low-Capacity Switching/Phase-Adaptive DIN Power Module (1A/output) – New product section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Palladiom Keypad – New product section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 HVAC Controller Model deleted: MWP-T-OHW-WH-A. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Model number changed: LR-HVAC-PLC1-CPN7120 to LR-HWLV-HVAC . . . . . . . . . . . . 141 Palladiom Thermostat – New product section added. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 iii Lutron integration protocol Table of Contents About Integration Integration Operations . . . . . . . . . . . . . . . 1 Operation Characters . . . . . . . . . . . . . . . . 1 Command Types. . . . . . . . . . . . . . . . . . 1 Command Structure . . . . . . . . . . . . . . . . 1 Command Termination. . . . . . . . . . . . . . . 1 Command and Control Examples . . . . . . . . . . 2 Integration Access Points . . . . . . . . . . . . . . 3 Command Rules and Formatting. . . . . . . . . . 3 Intermessage Delays. . . . . . . . . . . . . . . . 3 Integrator’s Reference Compatibility Matrix . . . . . . . . . . . . . . . . . 4 Device Command Summary. . . . . . . . . . . . 5 Output Command Summary. . . . . . . . . . . . 8 Group Command Summary. . . . . . . . . . . . . 9 HVAC Command Summary . . . . . . . . . . . . 10 Monitoring Command Summary . . . . . . . . . .12 Error Command Summary. . . . . . . . . . . . .13 Help Command Summary . . . . . . . . . . . . .14 System Command Summary. . . . . . . . . . . .15 QS Standalone System Overview. . . . . . . . . . . . . . . . . .16 Integration Access Points . . . . . . . . . . . . . 17 System Commands. . . . . . . . . . . . . . . . 19 RadioRA 2 System Overview. . . . . . . . . . . . . . . . . .27 Integration Access Points . . . . . . . . . . . . . 28 System Commands. . . . . . . . . . . . . . . . 30 Quantum System Overview. . . . . . . . . . . . . . . . . .34 Integration Access Points . . . . . . . . . . . . . 35 System Commands. . . . . . . . . . . . . . . . 37 HomeWorks QS System Overview. . . . . . . . . . . . . . . . . .46 Integration Access Points . . . . . . . . . . . . . 48 System Commands. . . . . . . . . . . . . . . . 50 myRoom plus System Overview. . . . . . . . . . . . . . . . . .60 Integration Access Points . . . . . . . . . . . . . 62 System Commands. . . . . . . . . . . . . . . . 64 iv Devices GRAFIK Eye QS. . . . . . . . . . . . . . . . . . 74 Energi Savr Node QS / DALI® . . . . . . . . . . . .78 HomeWorks QS / myRoom Power Module / DALI® . . . . . . . . . . 78 Energi Savr Node QS / EcoSystem . . . . . . . . .81 Energi Savr Node QS / EcoSystem (Int’l) . . . . . . 81 HomeWorks QS / myRoom Power Module / EcoSystem . . . . . . . 81 Energi Savr Node QS / 0 –10 V/ Softswitch (Int’l) . . 84 Energi Savr Node QS / Phase-Adaptive (Int’l) . . . .84 Energi Savr Node QS / 0 –10 V/ Softswitch . . . . .84 HomeWorks QS / myRoom Power Module / 0 –10 V/Softswitch / Phase-Adaptive . . . . . . . .84 Energi Savr Node QS/Motor Module (Int’l) . . . . . 87 HomeWorks QS / myRoom Power Module / Motor Module . . . . . . . . . . . . . . . . . . . 87 Remote Power Module. . . . . . . . . . . . . . .90 Low-Capacity Switching DIN Power Module (1A/output). . . . . . . . . . . . . . . . . . . . .92 Low-Capacity Phase-Adaptive DIN Power Module (1A/output). . . . . . . . . . . . . . . . .92 Palladiom Keypad. . . . . . . . . . . . . . . . . 95 Architrave Keypad . . . . . . . . . . . . . . . . .98 Signature Series Keypad. . . . . . . . . . . . . 101 seeTouch Keypad . . . . . . . . . . . . . . . . 104 seeTouch QS International Keypad. . . . . . . . 107 Tabletop seeTouch Keypad. . . . . . . . . . . . 110 Pico Wireless Control. . . . . . . . . . . . . . .113 Hybrid Keypad. . . . . . . . . . . . . . . . . . 115 Dynamic Keypad. . . . . . . . . . . . . . . . . 119 Wallbox Input Closure Interface. . . . . . . . . .121 Sivoia QS Shade. . . . . . . . . . . . . . . . . 124 Sivoia QS Venetian Blind. . . . . . . . . . . . . 127 Maestro Dimmer and Plug-In Module. . . . . . .130 Maestro Fan Speed Control . . . . . . . . . . . 133 Visor Control Receiver . . . . . . . . . . . . . . 135 Radio Powr Savr Sensor. . . . . . . . . . . . . 139 Temperature Controls . . . . . . . . . . . . . . 141 Palladiom Thermostat . . . . . . . . . . . . . . 145 Wireless Temperature Sensor . . . . . . . . . . 147 QSE-IO Control Interface. . . . . . . . . . . . . 149 QS Sensor Module (QSM) . . . . . . . . . . . . 153 Contact Information . . . . . . . . . . . . . . . 156 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 (#, ?, or ~) 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 . Continued on next page… 1 Lutron integration protocol About Integration (continued) Command and Control 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 Integration ID #OUTPUT 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 Integration ID #DEVICE 2 Command-specific fields Component Number Action Number 4 3 Query Examples 3) This command requests the output level for a dimmer (3). ?OUTPUT,3,1 Command Integration ID Command-specific fields Action ?OUTPUT 3 1 Monitoring Examples 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 2 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 Inter-Message Delays Inbound and outbound messages with the Integration Protocol will experience system delays during normal operation. The following shows the minimum delays expected: Command Type Minimum Inter-Message Delay Command and Control: These commands start with “#” Query: These commands start with “?”1 100 ms 1500 ms NOTE 1. Integration systems should be designed to utilize Monitoring commands to maintain an up-to-date view of the current system state. 3 Lutron integration protocol Integrator’s Reference COMPATIBILITY MATRIX Integration Access Point Compatibility Matrix QS Standalone Quantum QS Network Interface RadioRA 2 Main Repeater HomeWorks QS Processor myRoom (GCU-HOSP) Processor RadioRA 2 HomeWorks QS myRoom plus Device Compatibility Matrix QS Standalone Quantum GRAFIK Eye QS Energi Savr Node QS/DALI® Energi Savr Node QS/ EcoSystem Energi Savr Node QS/ EcoSystem (Int’l) Energi Savr Node QS/0 –10 V/ Softswitch (Int’l) Energi Savr Node QS/ Phase-Adaptive (Int’l) Energi Savr Node QS/0 –10 V/ Softswitch Energi Savr Node QS/ Motor Module (Int’l) Remote Power Module Low-Capacity Switching DIN Power Module (1A/output) Low-Capacity Phase-Adaptive DIN Power Module (1A/output) Palladiom Keypad Palladiom Thermostat Architrave Keypad Signature Series Keypad seeTouch Keypad seeTouch QS Keypad (Int’l) Tabletop seeTouch Keypad Pico Wireless Control Hybrid Keypad Dynamic Keypad Wallbox Input Closure Interface Sivoia QS Shade Sivoia QS Wireless Shade Sivoia QS Venetian Blind Sivoia QS Wireless Venetian Blind Maestro Dimmer and Plug-In Module Maestro Fan Speed Control Visor Control Receiver Radio Powr Savr Sensor HVAC Controller Wireless Temperature Sensor QS Input/Output Control Interface QS Sensor Module 4 RadioRA 2 HomeWorks QS myRoom plus 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 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 1 None Set (#) Disable 1 2 None Set (#) Press, Close, or Occupied 3 None Set (#) Release, Open, or Unoccupied 4 None 5 None 6 None 7 Scene Set (#) or Get (?) LED State 9 0 = Off 1 = On 2 = Normal Flash2 3 = Rapid Flash2 Set (#) or Get (?) Light Level 3 14 0–100 or 0.00–100.00 Set (#) Set (#) Hold 2 Set (#) Multi-tap 2 Set (#) or Get (?) Current Scene 1,2 SS.ss, SS, MM:SS, or HH:MM:SS SS.ss, SS, MM:SS, or HH:MM:SS NOTES 1. Quantum 2.7 and higher. 2. Not supported in RadioRA 2. 3. Not supported by Quantum. Continued on next page… 5 Lutron integration protocol Integrator’s Reference (continued) DEVICE: Command Summary (continued) DEVICE Command-specific fields (continued) Action Numbers and Parameters: Action Action Number Lock 1,2,3 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 Set (#) Start Raising 3,4,5 18 None 19 None 20 None Set (#) or Get (?) Zone Set (#) Start Lowering 3,4,5 Set (#) Stop Raising or Lowering 3,4,5 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 % Set (#) Hold or Release2 32 None Set (#) GRAFIK Eye QS Timeclock state 34 0 = Disabled 1 = Enabled Get (?) Query CCI state 8 35 None 36 0 –100% 37 0 –100% Set (#) or Get (?) Active LED Level 7 Set (#) or Get (?) Inactive LED 1. 2. 3. 4. 5. 6. 7. 8. Level 7 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. Applies only to Palladiom keypads. Requires NWK firmware 8.47 or newer for QS Standalone systems. 6 Parameters Lutron integration protocol Integrator’s Reference (continued) DEVICE: Command Summary (continued) HomeWorks / myRoom plus 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) — — — — — — — — — — — — — Continued on next page… 7 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 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 Set (#) Start Raising Set (#) Start Lowering Set (#) Stop Raising or Lowering Set (#) Start Flashing 2 Set (#) Pulse Time Set (#) or Get (?) tilt level 3,4 2 3 4 5 6 9 Set (#) or Get (?) lift & tilt level 4 10 Set (#) Start Raising Tilt 4 Set (#) Start Lowering Tilt 4 Set (#) Stop Raising or Lowering Tilt 4 Set (#) Start Raising Lift 4 Set (#) Start Lowering Lift 4 Set (#) Stop Raising or Lowering Lift 4 Set (#) DMX Color or Level Settings 7, 8 Set (#) Motor Jog Raise 7, 9 Set (#) Motor Jog Lower 7, 9 Set (#) Motor 4-Stage Jog Raise 7, 9 Set (#) Motor 4-Stage Jog Lower 7, 9 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 None None None None None Color / level index: 0–255 / 0.00–100.00 None None None None 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. 8 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 Use “GROUP Command-specific fields” tables to complete these command fields. Command NOTE 1. Not supported in QS Standalone. GROUP Command-specific fields Occupancy States: Description Value Occupied 3 Unoccupied 4 Unknown 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 Continued on next page… 9 Lutron integration protocol Integrator’s Reference (continued) HVAC: Command Summary HVAC Integration commands allow the user to access the HVAC components and features of the system. The user can modify HVAC parameters like the operating mode, fan mode etc., as well as monitor the changes to these parameters as they occur in the system. 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: 1 Action Action Number (°F) 5 Parameters 1 Temperature = 32–212 °F Set (#) or Get (?) Heat and Cool Setpoints (°F) 2, 4, 5 2 Set (#) or Get (?) Operating Mode 3 Set (#) or Get (?) Fan Mode 4 Setpoint Heat (SPH) = 32–212 °F Setpoint Cool (SPC) = 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 (?) Current Temperature Set (#) or Get (?) Schedule Status 3 7 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 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 5 12 Get (?) 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 Setpoint Heat (SPH) = 32 – 212 °F Setpoint Cool (SPC) = 32 – 212 °F 1 = Not Available 2 = Available NOTES 1. These commands are supported only for HomeWorks QS, RadioRA 2, myRoom Plus. 2. Changing the setpoint will turn Eco Mode off if it is currently on. 3. 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. 4. To leave a parameter unchanged, use “255” as the value for that parameter when ending the command. 5. Allow for reported temperature values to be zero padded, with up to 3 digits before the decimal point, and 2 digits after. – Possible reported values of 5 °C: “005”, “05”, “5”, “005.”, “005.”, “5.”, “005.0”, “05.0”, “5.0”, “005.00”, “05.00”, “5.00” – Possible reported values of 5.5 °C: “005.5”, “05.5”, “5.5”, “005.50”, “05.50”, “5.50” – Possible reported values of 21 °C: “021”, “21”, “021.0”, “21.0, “021.00,” “21.00” – Possible reported values of 21.5 °C: “021.5”, “21.5”, “021.50”, “21.50” 10 Lutron integration protocol Integrator’s Reference (continued) HVAC: Command Summary (continued) HVAC Command-specific fields (continued) Action Numbers and Parameters (continued): Action 1. 2. 3. 4. Action Number Parameters Set (#) or 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 Set (#) or Get (?) Current Temperature (°C)1, 4 15 Temperature = 0 –100 °C Set (#) or Get (?) Heat and Cool Setpoints (°C)2, 3, 4 Get (?) Heat and Cool Setpoints (°C) without Eco Offset if applied2, 4 Set (#) or Get (?) Single Setpoint (°F) and Drifts 3, 4 Set (#) or Get (?) Single Setpoint (°C) and Drifts 3, 4 16 Setpoint Heat (SPH) = 0 –100 °C Setpoint Cool (SPC) = 0 –100 °C Setpoint Heat (SPH) = 0 –100 °C Setpoint Cool (SPC) = 0 –100 °C Single Setpoint = Negative Drift = 32 –212 °F 0 –15 °F Single Setpoint = Negative Drift = 0 –100 °C 0 – 8 °C 17 18 19 Positive Drift = 0 –15 °F Positive Drift = 0 – 8 °C NOTES HomeWorks QS software version 4.1 and higher. Changing the setpoint will turn Eco Mode off if it is currently on. To leave a parameter unchanged, use “255” as the value for that parameter when ending the command. Allow for reported temperature values to be zero padded, with up to 3 digits before the decimal point, and 2 digits after. – Possible reported values of 5 °C: “005”, “05”, “5”, “005.”, “005.”, “5.”, “005.0”, “05.0”, “5.0”, “005.00”, “05.00”, “5.00” – Possible reported values of 5.5 °C: “005.5”, “05.5”, “5.5”, “005.50”, “05.50”, “5.50” – Possible reported values of 21 °C: “021”, “21”, “021.0”, “21.0, “021.00,” “21.00” – Possible reported values of 21.5 °C: “021.5”, “21.5”, “021.50”, “21.50” 11 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 Set (#) or Get (?) Diagnostic Monitoring Set (#) or Get (?) Event Monitoring Set (#) or Get (?) Button Monitoring Set (#) or Get (?) LED Monitoring1 Set (#) or Get (?) Zone Monitoring Set (#) or Get (?) Occupancy Set (#) or Get (?) Scene # Set (#) or Get (?) System Variable Set (#) or Get (?) Reply State (if disabled, all messages FROM the integration access point will cease) Set (#) or Get (?) Prompt State (if disabled, the prompt will not be printed to the terminal) Set (#) or Get (?) Venetian Tilt2 Set (#) or Get (?) Sequence Monitoring 1 Set (#) or Get (?) HVAC Monitoring 1,2 Set (#) or Get (?) Mode Monitoring 1,2 Set (#) or Get (?) Shade Group Monitoring 3 Set (#) or Get (?) Partition Wall 3,4 Set (#) or Get (?) State of All Monitoring (except Reply and Prompt) 1. 2. 3. 4. NOTES Not supported in QS Standalone. Not compatible with Quantum. Not supported in RadioRA 2 and HomeWorks QS. Not supported via QSE-CI-NWK-E in Quantum. Action Numbers: Action Action Number Enable 1 Disable 2 12 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 Report (~) Parameter count mismatch 1 Report (~) Object does not exist 2 Report (~) Invalid action number 3 Report (~) Parameter data out of range 4 Report (~) Parameter data malformed 5 Report (~) 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 Continued on next page… 13 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, , 14 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 1. Use “SYSTEM Command-specific fields” tables to complete these command fields. NOTE Not supported in QS Standalone. SYSTEM Command-specific fields Action Numbers and Parameters: Action 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/YYYY 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 1. 2. 3. Action Number Shed 3 NOTES The system time must be entered in 24 hour format. The Time Zone is referenced to GMT. 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 15 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 Node 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 Energi Savr Node QS/DALI® Energi Savr Node QS/EcoSystem Energi Savr Node QS/EcoSystem (Int’l) Energi Savr Node QS/0 –10 V/Softswitch (Int’l) Energi Savr Node QS/Phase-Adaptive (Int’l) Energi Savr Node QS/0 –10 V/Softswitch Energi Savr Node QS/Motor Module (Int’l) Architrave Keypad Signature Series Keypad seeTouch Keypad seeTouch QS Keypad (Int’l) Pico Wireless Control Wallbox Input Closure Interface Sivoia QS Shade Sivoia QS Wireless Shade Sivoia QS Venetian Blind Sivoia QS Wireless Venetian Blind QS Input/Output Control Interface QS Sensor Module 16 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 Continued on next page… 17 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 18 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 Set (#) or Get (?) IP Address 0 Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) Gateway Address 1 Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) Subnet Mask 2 Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) 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 Continued on next page… 19 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. Set (#) 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 20 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 Continued on next page… 21 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 Set (#) restart the device 0 Set (#) restore to factory defaults 1 Set (#) 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 22 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 1. 2. 3. 4. Action Number Parameters Set (#) add programming to a phantom button 1 Set (#) add scene programming to a phantom button 2 Set (#) clear programming from a phantom button 3 3 Set (#) configure Stop-If-Moving functionality 4 4 0 = Stop-If-Moving Off 1 = Stop-If-Moving On Set (#) add programming to a phantom button (Venetian blind, lift and tilt levels) 5 Set (#) add programming to a phantom button (Venetian blind, tilt only) 6 Set (#) add programming to a phantom button (Venetian blind, lift only) 7 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 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 Node area 2) c) Scene Number None NOTES A maximum of 500 programming assignments can be made in the QSE-CI-NWK-E. Not available for Shades. If a device’s Zone is already assigned to the button, you cannot program a Scene for that button. If a Scene is already programmed for this button for a device, you cannot program another Zone for this button. Use button number 0 to clear programming from all buttons. Use button number 0 to configure Stop-If-Moving functionality on all buttons. Continued on next page… 23 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 24 ~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 Get (?) display programming of a specific phantom button 1 Get (?) display Stop-If-Moving configuration of a specific phantom button 2 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 NOTES 1. To display programming of all phantom buttons, leave the button number field blank. 2. To display Stop-If-Moving configuration of all phantom buttons, use button number 0. Continued on next page… 25 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 Set (#) activate the phantom button preset Set (#) a custom level of the shades, lighting zones programmed to the phantom button 1 Set (#) Start Raising Shades 2 Set (#) Start Lowering Shades 2 Set (#) Stop Raising or Lowering Shades Set (#) a custom lift and tilt level of venetian blinds programmed to the phantom button 1 Set (#) a custom lift level only of venetian blinds programmed to the phantom button 1 Set (#) a custom tilt level only of venetian blinds programmed to the phantom button 1 Action Number Parameters 3 14 None Level: The level the shades will go to 1 18 19 20 23 24 None None None Lift level % Tilt level % Lift level % 25 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 26 #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 GRAFIK Eye QS seeTouch Keypad Tabletop seeTouch Keypad Pico Wireless Control Hybrid Keypad Sivoia QS Shade Sivoia QS WirelessShade Sivoia QS Venetian Blind Sivoia QS Wireless Venetian Blind Maestro Dimmer and Plug-In Module Maestro Fan Speed Control Visor Control Receiver Radio Powr Savr Sensor HVAC Controller Wireless Temperature Sensor Continued on next page… 27 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 MUX • MUX • COM 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 28 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 • Inclusive Software will allow up to a total of 10 additional logins • 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 Continued on next page… 29 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 Set (#) Press 3 None Set (#) 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. 30 ~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 Use “GROUP Command-specific fields” tables to complete these command fields. Command GROUP Command-specific fields Occupancy States: Description Value Occupied 3 Unoccupied 4 Unknown 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 Continued on next page… 31 Lutron integration protocol USB Main Repeater Repeater Status 1 M 2 3 4 Communication RF Setup RadioRA 2 (continued) System Commands (continued) MONITORING Commands COM MUX MUX 9V N/C Power Repeater Link 1 2 3 4 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 Set (#) or Get (?) Diagnostic Monitoring 1 Set (#) or Get (?) Button Monitoring (if enabled, button actions will be reported) 3 Set (#) or Get (?) LED Monitoring (if enabled, LED states will be reported) 4 Set (#) or Get (?) Zone Monitoring (if enabled, zone levels will be reported, i.e. dimmer, shade, contact closure output level) 5 Set (#) or Get (?) Reply State (if disabled, all messages FROM the integration access point will cease) 11 Set (#) or Get (?) 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. 32 Wired Test ~MONITORING,1,2 Add Integrate RS232 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 1. 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 Set (#) Execute Indexed 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. Set (#) Indexed Event as Enabled or Disabled 6 Event Index, Enable State (1 = Enable, 2 = Disable) NOTE 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 33 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 GRAFIK 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 Energi Savr Node QS/DALI® Energi Savr Node QS/EcoSystem Energi Savr Node QS/EcoSystem (Int’l) Energi Savr Node QS/0 –10 V/Softswitch (Int’l) Energi Savr Node QS/Phase-Adaptive (Int’l) Energi Savr Node QS/0 –10 V/Softswitch Remote Power Module Palladiom Keypad Architrave Keypad Signature Series Keypad seeTouch Keypad seeTouch QS Keypad (Int’l) Pico Wireless Control Wallbox Input Closure Interface Sivoia QS Shade Sivoia QS Wireless Shade QS Input/Output Control Interface 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. Continued on next page… 34 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 35 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 Continued on next page… 36 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 (#) or Get (?) IP Address 0 IP Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) Gateway Address 1 IP Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) Subnet Mask 2 IP Address (XXX.XXX.XXX.XXX) Set (#) or Get (?) 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 ~ETHERNET,0,192.168.250.1 37 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 Continued on next page… 38 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 Set (#) restart the device 0 Set (#) 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 39 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 1. 2. Use “AREA Command-specific fields” tables to complete these command fields. NOTES 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-Design software (Integration Tab) or Quantum Integration Report for details of what areas are available for control and monitoring. 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 Set (#) Start Raising 4 Set (#) Start Lowering 4 Set (#) Stop Raising or 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 Set (#) or Get (?) Occupied Level or Scene Set (#) or Get (?) Unoccupied Level or Scene Set (#) or Get (?) Hyperion Shadow Sensor Override State9 12 13 26 Set (#) or Get (?) Hyperion 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 The Level is accepted as a percentage. 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. Continued on next page… 9. Quantum 2.7 and higher. 1. 2. 40 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 Lower Area #AREA,2,3 Query: ?AREA, Integration ID, Action Number Is the area occupied? ?AREA,2,8 What is the current active scene? ?AREA,2,6 Response: ~AREA, Integration ID, Action Number, Parameters The area is currently occupied ~AREA,2,8,3 Area Scene 2 is currently active ~AREA,2,6,2 41 Lutron integration protocol Quantum (continued) System Commands (continued) SHADEGRP Commands SHADEGRP Command Formats Integration ID (example) Operation #SHADEGRP 1, 2, Action Number, Parameters Command 1. Use “SHADEGRP Command-specific fields” tables to complete these command fields. NOTE 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-Design 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 3. 4. 5. 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 Set (#) Start Raising 4 2 None Lowering 4 3 None Set (#) Stop Raising or Lowering 4 None Set (#) or Get (?) Current Preset 6 Preset Number 5 = 0–30 Set (#) Start 1. 2. Action Number NOTES The Level is accepted as a percentage, where 100% is fully open and 0% is fully closed. 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. 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. 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. 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 Lower shade group. #SHADEGRP,2,3 Query: ?SHADEGRP, Integration ID, Action Number What is the current active preset? ?SHADEGRP,2,6 Response: ~SHADEGRP, Integration ID, Action Number, Parameters Shade group Preset 2 is currently active. ~SHADEGRP,2,6,2 Continued on next page… 42 Lutron integration protocol Quantum (continued) System Commands (continued) OUTPUT Commands OUTPUT Command Format Operation Integration ID (example) #OUTPUT 1, 2, Action Number, Parameters Use “OUTPUT Command-specific fields” tables to complete these command fields. Command 1. NOTE 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 Set (#) Start Raising 4 2 None 3 None Set (#) Stop Raising or Lowering 4 4 None Set (#) Pulse Time 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 or Level Settings 6 17 Color / level index: 0–255 0.00–100.00 5 Set (#) Motor Jog Raise 6, 7 18 None Lower 6, 7 Set (#) Start Lowering 4 19 None Raise 6, 7 20 None Set (#) Motor 4-Stage Jog Lower 6, 7 21 None Set (#) Motor Jog Set (#) Motor 4-Stage Jog NOTES The Level is taken as a percentage. 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. 1. 2. 43 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 Raise Output #OUTPUT,2,2