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.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
- Log in to the Ryse platform or admin console
- Navigate to the API settings, developer section, or account settings
- Generate a new API key or token
- Copy the key and store it securely — you will need it when configuring the connector in KODE OS
Configure Connector in KODE OS
- Navigate to Data Sources in your building
- Click API Catalog and search for Ryse
- Click + Add Datasource
- Fill in the fields below and complete the three-page setup flow
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.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
What Data You Get
Point History
Time-series readings including Online, Position, Normal, Temperature, collected at regular intervals from connected devicesPolling Schedule
- Point History — Default polling: 30 seconds (min: 30 seconds, max: 1 hours)
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
Authentication or connection error
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.
Discovery returns no devices
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.
Data collection stops or gaps appear
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.