public enum SleepStage

  1. Object
  2. Enum<SleepStage>
  3. SleepStage

ImplementsComparable<SleepStage>

One stage within a SleepSample. The values mirror Health Connect’s eight stage constants; the iOS mapping is noted per value.

Not every source reports stages. Check SleepSample.hasStageDetail() before drawing a hypnogram – a session recorded by a phone rather than a watch will only say “asleep”.

Enum constants

UNKNOWNThe source did not classify this span.
AWAKEAwake during the sleep session.
AWAKE_IN_BEDAwake but in bed, before or after sleeping.
OUT_OF_BEDOut of bed during the session.
ASLEEP_UNSPECIFIEDAsleep, with no stage breakdown available.
LIGHTLight sleep, as Health Connect classifies it – the N1 and N2 stages.
COREApple’s “core” sleep, from HealthKit asleepCore (iOS 16+).
DEEPDeep sleep.
REMREM sleep.

Methods

public static SleepStage[] values()
public static SleepStage valueOf(String name)

Inherited methods

From Enum

clone, setEnumValues, getEnumValues, valueOf, equals, hashCode, toString, compareTo, name, ordinal, getDeclaringClass

From Object

getClass, notify, notifyAll, wait, wait, wait

Enum constant details

UNKNOWN

UNKNOWN
The source did not classify this span.

AWAKE

AWAKE
Awake during the sleep session. HealthKit awake.

AWAKE_IN_BED

AWAKE_IN_BED
Awake but in bed, before or after sleeping. HealthKit inBed.

OUT_OF_BED

OUT_OF_BED
Out of bed during the session. Android only – HealthKit has no equivalent and never reports it.

ASLEEP_UNSPECIFIED

ASLEEP_UNSPECIFIED
Asleep, with no stage breakdown available. HealthKit asleepUnspecified, and the only asleep value iOS reported before iOS 16.

LIGHT

LIGHT

Light sleep, as Health Connect classifies it – the N1 and N2 stages.

HealthKit does not report this. Its nearest value is asleepCore, which arrives as CORE rather than being folded in here.

CORE

CORE

Apple’s “core” sleep, from HealthKit asleepCore (iOS 16+).

Its own value rather than a synonym for LIGHT. This used to be mapped there with the approximation written into the javadoc, and a documented approximation is still a value the caller cannot tell from a real one: an app drawing a hypnogram, or comparing a night on iOS with a night on Android, was handed Apple’s classification labelled as the clinical one.

Apple’s core is a vendor classification and is not clinically identical to N1+N2. If your reading of the two is the same, treat them the same; the API will not do it for you.

DEEP

DEEP
Deep sleep. HealthKit asleepDeep, iOS 16+.

REM

REM
REM sleep. HealthKit asleepREM, iOS 16+.

Method details

values

public static SleepStage[] values()

valueOf

public static SleepStage valueOf(String name)