Ultrahuman Ring

Reads health metrics from Ultrahuman Ring via the Partner API

Current Release
0.1.13
Developer
SmarterPapa
License
MIT

SmarterPapa

Ultrahuman

ioBroker.ultrahuman

Current adapter version: 0.1.13

Ultrahuman Ring Adapter for ioBroker

This adapter reads health metrics from your Ultrahuman Ring via the Ultrahuman Partner API and creates ioBroker objects you can use in visualizations, scripts, and automations.

Detailed guide (German): Ultrahuman Ring im ioBroker – Schlaf, HRV & Gesundheitsdaten (SmarterPapa.de) — installation, all data points, automation examples, FAQ.

Source code: GitHub

Maintainers: Enable Trusted Publishers for iobroker.ultrahuman (this GitHub repo). Releases use ioBroker/testing-action-deploy@v1 on Node.js 24 with OIDC only (no npm-token). See testing-action-deploy#19.

Installation

Install the adapter via the ioBroker Admin interface:

  1. Open Adapters in ioBroker Admin
  2. Search for ultrahuman
  3. Click Install

Available metrics

ChannelStateDescriptionUnit
sleepbedtimeStartTime you went to bedISO 8601
sleepbedtimeEndTime you got upISO 8601
sleeptimeInBedTotal time in bedmin
sleeptimeAsleepTotal time asleepmin
sleeptimeToFallAsleepHow long it took to fall asleepmin
sleepsleepEfficiencySleep efficiency%
sleepsleepScoreSleep score
sleepsleepQualitySleep quality (excellent/good/fair/poor)
sleepremSleepREM sleep durationmin
sleepdeepSleepDeep sleep durationmin
sleeplightSleepLight sleep durationmin
sleeprestorativeSleepRestorative sleep (REM + deep)%
sleepsleepCyclesFull sleep cycles
heartrestingHRResting heart rate (sleep)bpm
heartnightRHRNight resting heart ratebpm
heartlastReadingLast HR readingbpm
heartavg / min / maxHeart rate statisticsbpm
hearttrendHeart rate trend
hrvaverageAverage HRVms
hrvsleepHRVAverage sleep HRVms
hrvmin / maxHRV statisticsms
hrvtrendHRV trend
spo2avg / min / maxBlood oxygen statistics%
temperaturelastReadingLast skin temperature°C
temperatureavg / min / maxTemperature statistics°C
activitystepsTotal steps todaysteps
activitystepsAvgAverage stepssteps
activityactiveMinutesActive minutesmin
activitymovementIndexMovement index
activityrecoveryIndexRecovery index
activityvo2MaxVO2 maxml/kg/min
infoconnectionAPI connection statusboolean
infolastUpdateLast successful updateISO 8601

Prerequisites

You need access to the Ultrahuman Partner API:

  1. Send an email to feedback@ultrahuman.com and request API access for personal use.
  2. You will receive an API Key and an Access Code.
  3. In the Ultrahuman app, go to Profile > Settings > Partner ID and enter the Access Code.
  4. Configure the API Key and your account email in the adapter settings.

Configuration

SettingDescriptionDefault
API SecretYour Ultrahuman Partner API authorization key
User EmailEmail address linked to your Ultrahuman account
Polling IntervalHow often to fetch data (minutes)30

The minimum polling interval is 5 minutes. Since ring data syncs periodically (not in real-time), 30 minutes is recommended.

Support

If you find this adapter useful, consider supporting the development:

ko-fi

Acknowledgments

API integration based on ultrahuman-dashboard by Matt Krainski (MIT License).

Changelog

0.1.13 (2026-04-11)

  • Deploy uses Node.js 24 with testing-action-deploy@v1; Trusted Publishing only (no npm-token), per maintainer note on testing-action-deploy#19

0.1.12 (2026-04-10)

  • 0.1.12: testing-action-deploy@v1 with npm-token again (OIDC-only path breaks on ubuntu-latest during global npm upgrade); README documents W3019 trade-off
  • common.news trimmed to seven entries (W1032); 0.1.3 moved to history only via CHANGELOG_OLD.md

0.1.11 (2026-04-09)

  • GitHub Releases: ioBroker/testing-action-deploy@v1 with granular NPM_TOKEN (Bypass 2FA)
  • Changelog lists 0.1.11 here; older releases in CHANGELOG_OLD.md
  • Dependabot default cooldown 7 days; includes 0.1.90.1.10 fixes (integration tests, Admin jsonConfig)

0.1.8 (2026-03-27)

  • io-package.json common.news reduced to 7 entries (ioBroker repository checker W1032)

0.1.7 (2026-03-26)

  • Package homepage (npm) points to the detailed German blog guide on SmarterPapa.de
  • README and ioBroker Admin (About tab) link to the same article; GitHub remains the repository URL

Older versions: CHANGELOG_OLD.md.

License

MIT License — see LICENSE for details.

Copyright (c) 2026 SmarterPapa