Driver Details

Lutron myRoom

By: RTI
Updated: Sept. 11, 2018
Version: 1.03

Description:

This driver is for the Lutron myRoom lighting system using the Guestroom Control Unit (GCU-HOSP). This driver is only available for use with IP control and is intended to provide local control for a single myRoom GCU.

Version History:

Version 1.03: expands the driver to support up to ID 300, added undocumented monitoring command suppression, adjustments for monitoring routines, and improved filtering for unwanted responses.

Lutron myRoom

This driver was designed and tested with a Lutron myRoom Guestroom Control Unit (GCU) via Ethernet. Part number: GCU-HOSP

Revision History

1.0 Initial Release of the Driver.

1.01 Expanded ID support to 300 required for myRoom firmware addressing scheme.

Adjusted monitoring routines for additions to Lutron protocol.

1.02 Adjusted driver parsing to better suppress unwanted responses from Lutron processor.

1.03 Added additional undocumented monitoring calls to driver for better filtering of unwanted responses.

Connection Settings

Network (TCP)

The Ethernet connection on the myRoom GCU should be connected to the Network.

The TCP Address should match the address of the myRoom GCU. Port 23 is used for the telnet session between the driver and myRoom GCU.

TCP Username and Password are required for initializing a telnet session with the driver. The default username/password is lutron/integration.

Device Configuration Settings

Last Device ID Used

Enter the last device ID programmed in the Lutron myRoom system. The driver supports a maximum of 300 IDs but should be configured to use the least number of IDs as needed in the system. This excludes HVAC Controllers. When starting a new system file the driver defaults the Last Device ID Used to 101.

Device Variable Initialization Enabled

Enable if device variable initialization is preferred. If enabled, a polling routine is enabled in the driver to retrieve device level/status and device LED status for all IDs configured in the system. The duration in which the driver runs the polling routine is dependent on the value of the Last Device ID Used configuration field. It can take anywhere from under a minute to over 5 minutes for all variables to receive their initial values. The driver may be used during the polling process as each poll is performed every few seconds, giving time for control commands to execute. Commands such as set level commands on slider objects may have a slight interruption if performed while the polling routine is running but should not render the driver unusable.

Device Variable Initialization Shift

Enable to shift device polling mechanism to start at ID 101 instead of ID 1. If the Phantom Keypad Enabled at ID 1 is enabled the shift will still allow polling for ID 1 so that it can acquire Phantom Scene information, but then will proceed on to ID 101 instead of ID 2. This is useful in instances where the myRoom system may reserve IDs 1-100 for internal myRoom use only.

Phantom Keypad Enabled at ID 1

Enables phantom keypad use at ID1. Support for 100 buttons with 100 LED states is included for a phantom keypad at ID1 (myRoom GCU). For programming Phantom keypad scenes on the Lutron myRoom system, please refer to Lutron Training materials or contact the Lutron Integrator responsible for the system.

ID Names 1-300

ID (1-300) Name

Enter the name to be used for the Lutron Device ID. When an ID is named its corresponding variables will be displayed in Integration Designer and will be available as selection in the Driver Commands Integration ID field and System Events. If an ID is not given a name it will not be available in Integration Designer. All ID names fields default to a generic name but may be changed or deleted as needed. DO NOT name HVAC ID locations in this section. For IDs that are used with HVAC Controllers, please make sure to clear the respective ID name field.

HVAC Configuration Settings

HVAC Active

If HVAC control is to be used, make sure this selection is enabled.

HVAC Setpoint Set Time

Sets the time delay between adjusting the setpoint temps and when the driver actually sends the setpoint temp adjustment to the Lutron myRoom system. This helps speed up the apparent setpoint adjustment capabilities.

HVAC Controller Count

Enter the number of HVAC Controllers setup in the Lutron myRoom system. This field will determine the number of HVAC Controller Name and ID fields exposed in the driver. Up to 10 HVAC controllers are supported.

HVAC Controller Names and IDs

HVAC Controller (1-10) Name

Enter the name to be used for the Lutron HVAC Controller ID.

HVAC Controller ID

Enter the Lutron HVAC Controller ID corresponding to the HVAC Controller Name field.

- Once an HVAC Controller Name and ID is entered the corresponding variables will be displayed in Integration Designer and will be available as selection in the Driver Commands HVAC Controller field and System Events.

Driver Notes

- The Lutron myRoom GCU must be addressed to ID 1.

- This driver is intended to provide local control for a single myRoom GCU. Each instance of the driver is meant to communicate to a single myRoom GCU directly, meaning if multiple myRoom GCUs are in an entire building complex, a driver instance is required for each GCU. In many cases each area that has a myRoom GCU will have its own XP processor for controlling local sources, so only one instance of the driver will be required for the local control of the myRoom GCU.

- Building management of multiple myRoom GCU devices is NOT supported through this driver or through RTI and must be accomplished through the Lutron myRoom Vue App.

- By default, the driver only initializes HVAC variables (if applicable) and sets appropriate system monitoring during initialization. All other device variables are filled in when the specified device state changes unless the Device Variable Initialization Enabled field is checked.

- Driver initialization will happen upon a system reboot or when the driver cannot re-establish a connection to the Lutron system for approximately one minute.

- The driver will report as disconnected when the Lutron system actually closes the connection. It should however reconnect and login as soon as the disconnect is triggered by the Lutron system. If the driver fails to reconnect within approximately one minute of the disconnect, the driver will be required to re-initialize once it can re-establish a connection.

- The driver automatically executes a trickle poll upon initialization. The time it takes to acquire all device values is dependent on the number of devices configured in the driver.