Skip to main content

Sleep (lamp.sleep)

Reports sleep stage data, generally sourced from a smartwatch via the device's health platform.

Configuration​

  • SensorSpec: lamp.sleep
  • Sampling: Continuous (events synced from health platform)
  • Platform: iOS (HealthKit), Android (Health Connect)
  • Typical source: Apple Watch, WearOS watch
  • Requirements: Connected wearable with sleep tracking; health platform permissions granted

Configure via the Sensors tab. See Wearable Setup for pairing instructions.

Usage​

Sleep data is recorded by the wearable during sleep periods and synced to the phone's health platform. mindLAMP reads from the health platform and uploads to the server. No participant action is required beyond wearing the watch to bed.

Data​

Fields​

FieldTypeDescription
valueinteger0 = in bed, 1 = asleep, 2 = awake
representationstring"in_bed", "in_sleep", or "in_awake"
durationintegerDuration of the state in milliseconds
sourcestringData source (e.g., "com.apple.health")

Example​

{
  "timestamp": 1636639670000,
  "sensor": "lamp.sleep",
  "data": {
    "value": 0,
    "source": "com.apple.health.CACD64E0-EE17-4430-9B0B-5255F09075DE",
    "representation": "in_bed",
    "duration": 12523000
  }
}

Cortex Features​

sleep (raw) → healthkit_sleep_duration (secondary)

Accepts a duration_type parameter: "in_bed", "in_sleep", or "in_awake".

View in Portal | Python SDK | API Reference