> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lutron Vive

> Connect Lutron Vive to KODE OS for lighting data

> Connect Lutron Vive to KODE OS for lighting data integration

## Overview

Use this integration to connect Lutron Vive to KODE OS. You can discover sensors, remotes, and related devices, pull snapshot lighting data over TCP/IP, and track zone-level state from Data Sources.

| Property            | Value    |
| ------------------- | -------- |
| **System Type**     | Lighting |
| **Communication**   | TCP/IP   |
| **Collection**      | Pull     |
| **Collection Mode** | SNAPSHOT |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

* Network access to the Lutron Vive controller or device
* The IP address and port of the on-site system
* Login credentials for the Lutron Vive system
* KODE OS environment with access to Data Sources

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Lutron Vive**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field                           | Required | Type     | Description                                              |
| ------------------------------- | -------- | -------- | -------------------------------------------------------- |
| **IP Address**                  | Yes      | text     | The IP address of the on-site controller or device       |
| **Port**                        | Yes      | text     | The port number for connecting to the system             |
| **Pairing Port**                | Yes      | text     | The port used for device pairing                         |
| **Password**                    | Yes      | password | The password for authenticating with the external system |
| **Kode Production Certificate** | Yes      | password | The production SSL certificate for secure communication  |
| **Kode Private Key**            | Yes      | password | The private key for SSL authentication                   |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Lutron Vive system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## Devices and Points

When you discover devices from Lutron Vive, KODE OS maps them to the following device types and data points:

### Presence / Occupancy Sensor

Canonical Type: `presenceDetection`

| # | Point                      | Description                                               | Unit  | Writable | Ontology Field     | Collection |
| - | -------------------------- | --------------------------------------------------------- | ----- | -------- | ------------------ | ---------- |
| 1 | `availability`             | **Unknown** / **Mixed** / **Available** / **UnAvailable** | --    | No       | --                 | Polling    |
| 2 | `failedTransfers_count`    | Cumulative count of events                                | count | No       | --                 | Polling    |
| 3 | `batteryStatus_levelState` | Device battery level                                      | --    | No       | --                 | Polling    |
| 4 | `occupancyStatus`          | Current occupancy status of the space                     | --    | No       | `occupancy_status` | Polling    |

### Lighting Fixture

Canonical Type: `lighting`

| # | Point                   | Description                                 | Unit  | Writable | Ontology Field          | Collection |
| - | ----------------------- | ------------------------------------------- | ----- | -------- | ----------------------- | ---------- |
| 1 | `level`                 | Current level value                         | %     | No       | `run_percentage_sensor` | Polling    |
| 2 | `instantaneousPower`    | Current instantaneous power consumption (W) | watts | No       | `run_power_sensor`      | Polling    |
| 3 | `instantaneousMaxPower` | Peak instantaneous power consumption (W)    | watts | No       | `run_power_sensor`      | Polling    |
| 4 | `switchedLevel`         | **Off** / **On**                            | --    | No       | `run_command`           | Polling    |
| 5 | `ccoLevel`              | **Closed** / **Open**                       | --    | No       | `run_command`           | Polling    |
| 6 | `receptacleLevel`       | **Off** / **On**                            | --    | No       | `run_command`           | Polling    |

## What Data You Get

### Point History

Time-series readings including availability, failedTransfers\_count, batteryStatus\_levelState, occupancyStatus, level, instantaneousPower, instantaneousMaxPower, switchedLevel, and 2 more, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 1 minutes (min: 1 minutes, max: 1 hours)

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Use Cases

Once connected, this integration enables you to:

* Monitor lighting system status, energy usage, and occupancy-driven behavior
* Coordinate lighting schedules with HVAC and building automation systems
* Track lighting energy consumption and identify optimization opportunities

## Troubleshooting

<AccordionGroup>
  <Accordion title="Cannot connect to controller">
    Verify the IP address and port are correct. Ensure the Lutron Vive controller is powered on and connected to the network. Check that firewalls allow inbound connections on the configured port from the KODE OS server.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Lutron Vive system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Lutron Vive API.
  </Accordion>
</AccordionGroup>