Documentation

Download the DataKit SDK installer from the link provided in your license confirmation email. Run the installer and follow the on-screen instructions. Installation requires administrator privileges. If you encounter an error during installation, refer to Error Code Reference in Appendix B. Appendix B is available to Enterprise customers.

Launch DataKit SDK. You will be prompted to activate your license. Enter your license key exactly as provided — the key is case-sensitive and contains no ambiguous characters, though several characters may appear similar depending on your display font. If activation fails, ensure your internet connection is active and that your firewall is not blocking RISE™ license servers. A list of RISE™ license server IP addresses for firewall configuration is available upon written request to the RISE™ Developer Support team. Response time: 15 business days. The SDK phones home on every launch for license verification. This is disclosed in the EULA, Section 31. It cannot be disabled.

Once activated, select File > Open and navigate to your .rsm file. .rsm files are typically located on the USB drive delivered with your RISE™ Standard Data Package. If the USB drive is not recognized by your system, ensure your operating system is compatible with the DataKit SDK. The Compatibility Matrix is available to registered DataKit SDK customers. Allow 4–8 minutes for initial file loading on non-recommended hardware configurations. This is expected behavior.

Your RSDP contains data in the following categories, visible in the DataKit SDK Data Category Browser: — Sleep & Biometric Data — Device & Performance Data — Environmental Data — Navigation Route Data — Push Mode Session Logs — RISE™ Index History — Occupancy Data (currently unavailable — see Known Issues) — Relationship Inference Data (access varies by package tier) — Audio Classification Results (Pro and Enterprise only) — Restricted Categories (visible as "Restricted" — DataKit Enterprise required) Categories marked Restricted contain data RISE™ collects but is not currently providing access to. The categories exist. Their contents are not available at this time.

Coming soon. The DataKit SDK API Reference will be published in a future documentation update. An estimated publication date is not available. Enterprise customers may submit API reference questions to the Developer Support email. Response time: 15 business days.

— Date filter displays incorrect results for dates after January 1, 2019. Workaround: filter by session ID instead. Session ID format documentation is forthcoming. — Application may take 4–8 minutes to load on some systems. This is expected behavior. — The RISE™ Index Viewer may display a score of 0 on first launch. This resolves after the application has been open for 24 hours. Do not close the application during this period. — Audio files (.rsma) opened in DataKit Pro may play at incorrect speeds on certain hardware. The playback speed control is located in the View menu (DataKit Pro v1.4.2 and above). Version 1.4.2 release date: not yet available. — The application crashes when navigating to the Occupancy Data category. Workaround: do not navigate to the Occupancy Data category. A fix is planned. No timeline is available. — On macOS, the application may request microphone access during installation. This is unrelated to any functional feature. Decline or approve — behavior is identical either way.

Developer support is available to registered DataKit SDK customers via email. Support email: developer-support@riseawake.com Response time: 15 business days Enterprise: 15 business days (prioritized) When contacting support, please include: your license key, DataKit SDK version number, your operating system name and version (if unsupported, this information updates the Compatibility Matrix), a detailed description of the issue, and your RISE™ account number. Support tickets submitted without all required information will be closed and the customer asked to resubmit. This resets the 15 business day response clock.