📘

Summary:

SDK/API major version update, document version update, addition of new user guide documents.

Hello, this is Asleep.

We are pleased to inform you about our latest update, which includes various improvements and fixes, such as SDK/API major version update, document version update, addition of new user guide documents. For more details, please see below!

✨ New & Updated

🔹 Docs

Asleep Document Updated to Version 2.0!

Asleep Docs site has been updated to version 2.0.

🚫 Attention: Support for the SDK V1 in the V1.0 Docs is set to cease by the end of 2023.
🔍 Therefore, please review the V2.0 Docs immediately, check for updated content, and apply the latest version accordingly.

The new version provides additional information and guidelines to assist in your development process. We appreciate your continued use of Asleep's services. Thank you.

🔹 SDK

1. Added SDK Overview Tab
   1. An Overview page has been added where you can check the latest SDK version for each OS. It's recommended to use the latest SDK version.
   2. Go to the related page
      
2. [Reports] Structural Changes/Additions/Deletions
   1. New fields added:
      1. peculiarities, missing_data_ratio, breathing_index, breath_stages
   2. Fields removed:
      1. validity, estimated_ahi, osa_stages
   3. Breathing Pattern label update:
      1. As-is: VERY_STABLE, STABLE, UNSTABLE, VERY_UNSTABLE
      2. To-be: STABLE_BREATH, MILDLY_UNSTABLE_BREATH, MODERATELY_UNSTABLE_BREATH, SEVERELY_UNSTABLE_BREATH
   4. Go to the related page - iOS / Android
3. Addition of [Android Error Codes]
   1. Added: ERR_ANALYSE_UNAUTHORIZED, ERR_REPORT_UNAUTHORIZED
   2. Removed: ERR_ANALYSE_UNPROCESSABLE, ERR_REPORT_UNPROCESSABLE
   3. Go to the related page

📘

Go to the SDK Migration Guide

🔹API

1. [Stat Object] Change in breathing_pattern label values

   1. The label values of breathing_pattern, which inform about the instability of breathing, have been updated.
   2. Go to the related page
      

2. [Stat Object] Addition of breathing_index field, removal of former estimated_ahi field

   1. The breathing_index field, which serves the same purpose as the former estimated_ahi field but with a more appropriate name, has been added, and the estimated_ahi field has been removed.
   2. Go to the related page
      

3. [Session Object] Addition of breath_stages field, removal of former osa_stages field

   1. The breath_stages field, which serves the same purpose as the former osa_stages field but with a more appropriate name, has been added, and the osa_stages field has been removed.
   2. Go to the related page
      

4. [Call back] Addition of breath_stages field, removal of former osa_stage_list field

   1. The breath_stages field, which serves the same purpose as the former osa_stage_list field but with a more appropriate name, has been added, and the osa_stage_list field has been removed.
   2. Go to the related page
      

5. [Body] Addition of peculiarities field, removal of former validity field

   1. The former validity field provided session status but was limited in its details. Thus, the peculiarities field has been added to offer a more detailed session status.
   2. Go to the related page
      

📘

Go to the API Migration Guide

🔹User Guide

Introducing Asleep User Guide!

If you've been curious about sleep measurement services but have been unsure about where to start, worry no more! We present the Asleep User Guide, brimming with our expertise and specialized insights.

Discover how to best integrate Asleep into your service, and the new value it can bring. The guide is designed for easy navigation and will be updated continuously, with more topics being added in the future. Stay tuned!

📘 Available Now:

1. Introduction about Sleep
2. How to use in Healthcare/Wellness services
3. How to use in Sleep Tech services
4. Sleep Report Design Guide

🔖 Upcoming Updates:

1. How to use in Smart homes and smart appliances
2. How to use in Blood sugar management services
3. How to use in Fitness services

If you need further explanations on any part of the document or have any inquiries about Asleep, please feel free to contact us. We are committed to continuously striving for your convenience as we move forward as Asleep.

• For technical/development inquiries: contact [email protected] or post your questions on [Q&A page]
• For business/partnership inquiries: Ask Asleep Business Experts

Thank you.