-
Deliver workout insights with HealthKit workout zones
HealthKit makes it easier to provide workout insights — like heart rate and cycling power zones — in your app. Learn to leverage the built-in, personalized zones or create custom ones. Discover how to use the current zone and time spent in each zone to provide meaningful guidance during and after workouts.
Chapters
- 0:01 - Introduction
- 2:17 - Accessing workout zones
- 6:19 - Live zone updates
- 8:11 - Preferred zones
- 9:00 - Custom zones
Resources
-
Search this video…
-
-
3:54 - Reading Heart Rate Zones from a completed workout
// Read heart rate zones from the completed workout if let heartRateZoneGroup = workout.zoneGroupsByType?[HKQuantityType(.heartRate)] { let zones = ZoneDisplayData( zoneCount: heartRateZoneGroup.configuration.zones.count, currentZoneIndex: nil, durations: heartRateZoneGroup.zoneDurations.map(\.duration) ) -
7:57 - Handling Live Zone Updates
func workoutBuilder(_ workoutBuilder: HKLiveWorkoutBuilder, didUpdateWorkoutZone zoneUpdate: HKLiveWorkoutZoneUpdate) { guard let zoneGroup = zoneUpdate.zoneGroup else { return } if let currentIndex = zoneUpdate.currentZoneDuration?.zone.index { let data = ZoneDisplayData( zoneCount: zoneGroup.configuration.zones.count, currentZoneIndex: currentIndex, durations: zoneGroup.zoneDurations.map(\.duration) ) Task { @MainActor in self.heartRateZones = data } } } -
9:19 - Check if Preferred Zone has been set
if try await builder.zoneConfiguration(for: HKQuantityType(.heartRate)) == nil { -
9:24 - Create Zone Boundaries
let defaultHeartRateZoneThresholds = [91.0, 114.0, 136.0, 158.0] let bpmUnit = HKUnit.count().unitDivided(by: HKUnit.minute()) let boundaries = defaultHeartRateZoneThresholds.map( {HKQuantity(unit: bpmUnit, doubleValue:$0)} ) -
9:33 - Create Default Workout Zone Configuration
let heartRate = HKQuantityType(.heartRate) let defaultConfiguration = try HKWorkoutZoneConfiguration(quantityType: heartRate, zoneBoundaries: boundaries) -
9:58 - Set Custom Zone Configuration
try await builder.setCustomZoneConfiguration(defaultConfiguration, for: heartRate) } -
10:03 - Begin Data Collection
// Begin data collection let startDate = Date() try await builder.beginCollection(at: startDate)
-
-
- 0:01 - Introduction
Workout zones turn biometric data into actionable training guidance, helping people understand their effort and intensity in a workout. In iOS and watchOS 27, heart rate and cycling power zone support is built directly into HealthKit, providing a new way to help people train smarter.
- 2:17 - Accessing workout zones
Use the zoneGroupsByType dictionary on a completed HKWorkout or HKWorkoutActivity to access the zones for a particular HKQuantityType, like heart rate. Explore the HKWorkoutConfiguration (describing the quantity type, source, and contiguous zone boundaries) and an array of zone durations which represents the time spent in each zone during the workout. This data can be used to provide meaningful insights, like rendering a post-workout zone chart or classifying effort.
- 6:19 - Live zone updates
To receive real-time notifications when someone's heart rate changes into a new zone during a workout, adopt the didUpdateWorkoutZone method on HKLiveWorkoutDelegate. Each update includes the current and previous zone, the cumulative zone data with running totals for the workout, and a timestamp of the last processed sample. Use these zone updates to provide timely guidance in a workout, like highlight the active zone and send an alert if someone drifts from their target zones.
- 8:11 - Preferred zones
HealthKit uses the preferred zone thresholds from Health Settings by default, which can either be automatically calculated from user metrics like age and resting heart rate, or then be manually configured. These settings sync across devices. Before starting a workout that will consider zones information, query for a preferred zone configuration on HKHealthStore or HKWorkoutBuilder to confirm one has been set.
- 9:00 - Custom zones
When your app uses a proprietary zone model, rather than the preferred zones from Health Settings, configure each workout with a custom HKWorkoutZoneConfiguration. Create the configuration and supply it to the HKWorkoutBuilder before calling beginCollection. Custom configurations are scoped to individual workouts and not persisted by HealthKit.