Driver Details

Lutron Vive

By: RTI
Updated: Dec. 8, 2023
Version: 1.11

Lutron is an industry leading Lighting Solution provider, with multiple best-in-class product lines. The Vive product line is a cloud-connected wireless lighting control system for smart buildings. Helping make both new and existing commercial buildings efficient, comfortable, and productive.

  • Control over all Lighting, Shades, and Controllers.
  • Auto-Configuration to easily pull the loads and controllers into Integration Designer.
  • Commands to set levels, turn on and offloads, and press buttons on controllers.
  • Events for when lights turn on and off.
  • Events for button presses on a controller.

 

Version History:

Version 1.0: Initial Release

Version 1.1: Added support for scenes

Version 1.11: Fixed an issue where scenes were not being received properly when processor restarted without updated informaton from Integraton Designer

Lutron Vive

Lutron | Vive | IP Only | Version 1.0

Introduction & Manufacturer Profile

Lutron is an industry leading Lighting Solution provider, with multiple best-in-class products. This driver controls specifically the Lutron Vive line of products intended for use in commercial installs.

Version History

Verison 1.0: Initial Release

Version 1.1: Added support for scenes

Version 1.11: Fixed an issue where scenes were not being received properly when processor restarted without updated information from Integration Designer.

Driver Features

This driver allows for control over all Lighting, Shades, and Controllers installed with the Vive system. It features Auto-Configuration to easily pull the loads, and controllers into Integration Designer, giving the programmer easy access to add whatever devices are needed to be controlled via RTI. This driver gives commands to set levels, turn on and off loads, and press buttons on controllers. It also provides events for when lights turn on and off, as well as when buttons on controllers are pressed. Added in version 1.1 is the control of scenes. To add activate scene functions to your project, simply add the Scenes source, and now you will have a list control for all scenes, and individual commands for activating each scene.

System Requirements & Prerequisites

RTI System Requirements

Integration Designer: 11.3.1

XP FW: 23.3.31

ManufacturerDevice Requirements

Vive processor

Driver Configuration

Connection Type:

IP

– To connect to the device you will need to set up 2 API connections in the Lutron Vive app. These API connections will be added as touchpanels, you need 1 connection for Integration Designer to the Lutron system, and 1 connection for the RTI Processor to the lutron system. More details on how to setup this connection can be found under the “Connect To The Lutron System” section of this document.

Stop Timer Interval:

This setting is used for the raise/lower commands, it is intended to be set 20-30ms higher then the repeat rate on the buttons themselves, from our testing this gives the best performance. However the raise/lower endpoints are quite finicky, both with control from Lutronweb interface, and via the Driver. These commands are available, but not suggested for use.

Template Page Name:

This driver does not have a default template page added, as it is intended to be used with the Lighting page, which covers multiple lights. It is recomended that you add the Lighting page as a pageset seperately, and then point the layers to the sources added for control. This will be a more efficient workflow then having the lighting page get added to every device from the Lutron driver, and having to delete all of them.

Connect To The Lutron System

Integration Designer to Lutron:

1. Setup API integration in Lutron Vive app, as a touch panel.

2. Fill in IP Address in Driver Properties, and press Connect to Lutron Processor

3. When prompted fill in the One Time password from the Lutron App into the dialogue box in Integration Designer ** Note: This password is only valid for a short period of time from creation **

4. Integration Designer and the Lutron system are now paired, they should be able to communicate freely now. Sources will appear in the “Add Workspace Items” menu.

If you experience issues connecting to the Lutron processor after the initial conenction, use the “Reset Authentication” button, create a new Lutron API Integration, and repeat the above steps.

Processor to Lutron:

This step requires a keypad page to be created on the RTI interface, an example is provided in the sample file, however due to the way the authentication is completed it is required to have that keypad in the customer file, so that the processor does not get wiped. The page can be removed or disabled after authentication is complete, but it is crucial that the file used for authentication is the same as the one used for control later.

1. Setup keypad page, using the sample file provided as an example.

2. Setup a 2nd API integration in Lutron Vive app, as a touch panel.

3. Send file to processor.

4. Wait for the “Login Required” variable to report True

5. Type in the One Time Password from the Lutron Vive app ** Note: This password is only valid for a short period of time from creation **

6. “Login Required” should now be false, if not check that the password in the app is still valid, and try again.

7. After “Login Required” is false, the control of the unit should be working as expected.

If you experience issues connecting to the Lutron processor after the initial conenction, use the “Erase Pairing Data” function in the driver, create a new Lutron API Integration, and repeat the above steps.

If you would like more detailed steps, including images, please see the Integration Guide on Lutron Vive, provided in the download folder along side this driver.

Using Scenes

When using scenes you have 2 options for control via scenes.

Button Control:

When using this method of controlling scenes, all scenes that are defined at the time of pressing “Connect to Lutron Processor” will receive macros that can be added to buttons, they will also be tagged for convience when programming as “Activate (Scene Name)”

List Control:

When using this method of controlling scenes you do gain the benefit of the end user being able to create and sort scenes in the Lutron app, and the RTI Scene List on their interface will update in real time. To use this list it will be tagged “Scene List”.

Limitations

Does not currently support Occupency Sensors, or Thermostats.

System Testing

Integration Designer: 11.4.1

XP Processor Model: XP-3

XP Processor Firmware: 23.5.11

Device Model(s): HJS-0, FCJS-ECO

Device FW: 1.15.06

Support Contact

Remote Technologies Inc.

Phone Number: +1 952-253-3100

Email: support@rticontrol.com