search

nitobuendia / oura-custom-component

Oura Custom Component for Home-Assistant. Adds Oura Ring sleep information.
108 stars 25 forks source link

[Maintenance] Upgrade to Oura API v2 #15

Closed nitobuendia closed 1 year ago

nitobuendia commented 2 years ago

Oura has released Oura API Version 2. We would need to upgrade before the sunset of v1. This may also affect feature requests on #10 and #14 which might be best implemented in the new version directly to avoid double work.

nitobuendia commented 2 years ago

Sunset seems to be somewhen in 2023 (tbc). There's still time to upgrade. Migration guide is not up yet, we can wait for that for ease of migration.

Yersi88 commented 2 years ago

I like the idea of switching to 2.0 API as the old one is not able to get all the data from Ring Gen3 such as 24/7 heartrate.

nitobuendia commented 2 years ago

Just checked and the v2 API does not support all features yet. In particular, the most critical endpoint on the current implementation is sleep. As of right now, sleep data is not available on the v2 API:

Sleep period is a nearly continuous, longish period of time spent lying down in bed. Sleep is currently available in the V1 API. We plan to release sleep with the V2 API in the near future. Click here for V1 API documentation.

Ideally, we should do the migration of Auth + Readiness + Sleep at once, so putting this off until all the endpoints are ready.

guildencrantz commented 2 years ago

Looks like everything's there now? Sleep no longer has the v1 link, nor do any of the other endpoints. I haven't validated.

nitobuendia commented 2 years ago

Yes, @guildencrantz - it looks like so. Thanks for being on top.

I will try to have a look, as I do intend to migrate to the new API. It may take a few weeks, though.

nitobuendia commented 1 year ago

This work has been started and more or less completed. It currently sits in an unpublished branch, but I should be releasing it in the next days and merging it once it is ready.

nitobuendia commented 1 year ago

This is now completed on branch oura-v2. The code is still experimental and subject to change. It will be merged after adding other sensors (e.g. #10) and data points.

The new component requires a different configuration, so if you want to use it, you may want to completely reinstall it from scratch until it's ready.