Skip to main content

Steps (lamp.steps)

Records step count and related pedometer data. On iOS, data may come from the device pedometer or from HealthKit. On Android, data comes from Google Health Connect.

Configurationโ€‹

  • SensorSpec: lamp.steps
  • Sampling: Interval
  • Platform: iOS, Android

Available without a wearable โ€” the phone's built-in pedometer provides step data.

Usageโ€‹

Step data is collected automatically. No participant action is required.

note

When source is null (device pedometer on iOS), each event reports the running total of steps for the calendar day. When source is set (HealthKit or Health Connect), events report the step count since the last recorded event.

Dataโ€‹

Fieldsโ€‹

FieldTypeDescription
sourcestring or nullData source identifier (e.g., "com.google.android.gms"). null if from device pedometer directly.
typestringData type: "step_count", "distance", "speed", or "cadence"
unitstringUnit: "count", "meter", "meters per second", or "steps/minute"
valuenumberThe measurement value

Exampleโ€‹

{
"timestamp": 1649842803515,
"sensor": "lamp.steps",
"data": {
"source": "com.google.android.gms",
"type": "step_count",
"unit": "count",
"value": 13
}
}

Cortex Featuresโ€‹

steps (raw) โ†’ step_count (secondary)

The step_count feature accepts a data_type parameter to select between "health" (HealthKit/Health Connect), "pedometer", or "watch" sources.

View in Portal | Python SDK | API Reference