> ## 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.

# Ryse

> Connect Ryse to KODE OS for smart shades data

> Connect Ryse to KODE OS for smart shades data integration

## Overview

Use this integration to connect Ryse SmartShade devices to KODE OS. You discover shades and poll position, status, and control-related points over REST for scheduling and daylight management.

| Property            | Value        |
| ------------------- | ------------ |
| **System Type**     | Smart Shades |
| **Communication**   | REST         |
| **Collection**      | Pull         |
| **Collection Mode** | SNAPSHOT     |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

* An active account with Ryse and access to their API or developer portal
* API key or token from the Ryse platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Ryse platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it when configuring the connector in KODE OS

## Configure Connector in KODE OS

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

| Field            | Required | Type     | Description                                              |
| ---------------- | -------- | -------- | -------------------------------------------------------- |
| **Room**         | No       | text     | The specific room this connector is associated with      |
| **URL**          | Yes      | text     | The base URL or IP address of the external system        |
| **Username**     | Yes      | text     | The username for authenticating with the external system |
| **Password**     | Yes      | password | The password for authenticating with the external system |
| **API Key**      | Yes      | password | The API key for authenticating with the external system  |
| **Region**       | Yes      | password | The cloud region where the vendor service is hosted      |
| **User Pool ID** | Yes      | password | The AWS Cognito user pool ID for authentication          |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Ryse 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 Ryse, KODE OS maps them to the following device types and data points:

### blinds

Canonical Type: `blinds`

| # | Point         | Description                                                                                                                                                               | Unit | Writable | Collection |
| - | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- | -------- | ---------- |
| 1 | `Online`      | **True** -- device is connected and reporting / **False** -- device is not responding                                                                                     | --   | No       | Polling    |
| 2 | `Position`    | Current shade/blind position                                                                                                                                              | --   | Yes      | Polling    |
| 3 | `Normal`      | **Normal** -- in resting position / **Moving Up** -- shade is raising / **Moving Down** -- shade is lowering / **Stopped Obstacle** -- movement halted due to obstruction | --   | No       | Polling    |
| 4 | `Temperature` | Current temperature reading (°C)                                                                                                                                          | °C   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including Online, Position, Normal, Temperature, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 30 seconds (min: 30 seconds, 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:

* Centralize Ryse data in your building operations dashboard
* Correlate data from this system with other building systems for comprehensive analytics

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Ensure the API key or token is valid and has not been revoked or expired in the Ryse platform.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Ryse 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 Ryse API.
  </Accordion>
</AccordionGroup>