building great workout apps

HealthKit APIs and best practices

App Frameworks #WWDC16

Session 235

Building Great Workout Apps

Dash Brittain iOS Software EngineerJorge Moriñigo iOS Software Engineer

Background Running

Workout Lifecycle

Background Running

Workout Lifecycle

Activity Rings

Background Running

Workout Lifecycle

Activity Rings

Workouts in iOS 10

Background Running

Workout Lifecycle

Activity Rings

Workouts in iOS 10

Best Practices

Getting Started

HKWorkoutSession

Motion and calorimetry for activity type

HKWorkoutSession

Motion and calorimetry for activity typeActivity rings

HKWorkoutSession

Motion and calorimetry for activity typeActivity ringsShow app on wake

HKWorkoutSession

Motion and calorimetry for activity typeActivity ringsShow app on wakeBackground running

Background Running NEW

Background Running

Process sensor data

Background Running

Process sensor dataLive feedback

Background Running

Process sensor dataLive feedbackQuickly update UI

// Background Running

// WatchKit Extension Info.plist

<key>WKBackgroundModes</key>

<array>

<string>workout-processing</string>

</array>

Conserve powerBackground Running NEW

Conserve powerBackground Running

Limit background work

Limit background workApp may be suspended

Limit background workApp may be suspendedMeasure background work with tools

Limit background workApp may be suspendedMeasure background work with tools• CPU Report in Xcode

Limit background workApp may be suspendedMeasure background work with tools• CPU Report in Xcode• Time Profiler in Instruments

Limit background workApp may be suspendedMeasure background work with tools• CPU Report in Xcode• Time Profiler in Instruments• Backtrace log

Starting a Workout

Authorization

Starting a Workout

Authorization Workout Configuration

Starting a Workout

Authorization Workout Configuration

Start Workout Session

Starting a Workout

Authorization

Authorization to write• Workouts

Authorization

Authorization to read• Energy burned• Distance• Heart rate

Authorization

Authorization to read• Energy burned• Distance• Heart rate

Authorization

Getting the Most Out of HealthKit Wednesday

// Workout Configuration

var workoutConfiguration = HKWorkoutConfiguration()

workoutConfiguration.activityType = .running

workoutConfiguration.locationType = .outdoor

// Start Workout Session

let workoutSession = HKWorkoutSession(configuration: workoutConfiguration)

healthStore.start(workoutSession)

DemoSpeedySloth: Starting a Workout

Dash BrittainiOS Software Engineer

Data Collection and Control

Jorge MoriñigoiOS Software Engineer

Ending and Saving Workout

StartingWorkout

Start Observing Samples

Start Observing Events

StartingWorkout

Running

StartingWorkout

Paused

Running

StartingWorkout

Paused

Running

Observing Samples

Open query for each data type

Observing Samples

Open query for each data typeUpdate your running totals

Observing Samples

Open query for each data typeUpdate your running totalsDisplay live data

Observing Samples

Open query for each data typeUpdate your running totalsDisplay live dataNotify user of reached goals

// Observing Samples

let datePredicate = HKQuery.predicateForSamples(withStart: workoutStartDate, end: nil,

options: .strictStartDate)

let devicePredicate = HKQuery.predicateForObjects(from: [HKDevice.local()])

let queryPredicate = CompoundPredicate(andPredicateWithSubpredicates:[datePredicate,

devicePredicate])

let updateHandler: (HKAnchoredObjectQuery, [HKSample]?, [HKDeletedObject]?, HKQueryAnchor?,

NSError?) -> Void = { query, samples, deletedObjects, queryAnchor, error in

// Process samples

devicePredicate])

// Process samples

let query = HKAnchoredObjectQuery(type: quantityType,

predicate: queryPredicate,

anchor: nil,

limit: HKObjectQueryNoLimit,

resultsHandler: updateHandler)

devicePredicate])

// Process samples

anchor: nil,

query.updateHandler = updateHandler

devicePredicate])

// Process samples

anchor: nil,

query.updateHandler = updateHandler

healthStore.execute(query)

Notify user of reached goalObserving Samples

Play haptic to alert user

Play haptic to alert userUpdate UI to reflect reached goal

WKInterfaceDevice.current().play(.notification)

Observing Events

Timestamps to highlight point in session

Observing Events

Timestamps to highlight point in sessionSome events created by your app

Observing Events

Timestamps to highlight point in sessionSome events created by your appSome events created by HealthKit

Observing Events

Timestamps to highlight point in sessionSome events created by your appSome events created by HealthKit

protocol HKWorkoutSessionDelegate

func workoutSession(_ workoutSession: HKWorkoutSession, didGenerate event: HKWorkoutEvent)

Laps and Markers NEW

HKWorkoutEventType.lap

HKWorkoutEventType.marker

Create to store in a workout

Create to store in a workoutTimestamps for graphs and statistics

Create to store in a workoutTimestamps for graphs and statisticsLaps for equal distance partitions

Create to store in a workoutTimestamps for graphs and statisticsLaps for equal distance partitionsMarkers for arbitrary points

Pausing and Resuming

Users stop their activity

Users stop their activityPause workouts to save power and space

Users stop their activityPause workouts to save power and spaceIgnore data while paused

Users stop their activityPause workouts to save power and spaceIgnore data while pausedHealthKit responds with pause/resume events

Users stop their activityPause workouts to save power and spaceIgnore data while pausedHealthKit responds with pause/resume eventsAfter pause event, you will stop receiving new events

Pausing and Resuming NEW

class HKHealthStore {

func pause(_ workoutSession: HKWorkoutSession)

func resume(_ workoutSession: HKWorkoutSession)

Pausing and Resuming NEW

class HKHealthStore {

func pause(_ workoutSession: HKWorkoutSession)

func resume(_ workoutSession: HKWorkoutSession)

HKWorkoutEventType.pause

HKWorkoutEventType.resume

Motion Events for Running Workouts NEW

HKWorkoutEventType.motionPaused

HKWorkoutEventType.motionResumed

Motion Events for Running Workouts

Watch detects when motion pauses or resumes

Watch detects when motion pauses or resumesStop collecting data

Watch detects when motion pauses or resumesStop collecting dataDon’t need to manual pause

Watch detects when motion pauses or resumesStop collecting dataDon’t need to manual pause Only for HKWorkoutActivityTypeRunning

DemoSpeedySloth: Data Collection and Control

Ending and Saving

Workouts in Activity NEW

Workouts in Activity

Activity workout list

Workouts in Activity

Activity workout listActivity Move ring

Ending and Saving

EndWorkout Session

Ending and Saving

EndWorkout Session

SaveWorkout

Ending and Saving

EndWorkout Session

SaveWorkout

Add Samplesto Workout

Ending and Saving

Ending an HKWorkoutSession

healthStore.end(workoutSession)

Ending an HKWorkoutSession

healthStore.end(workoutSession)

func workoutSession(_ workoutSession: HKWorkoutSession,

didChangeTo toState: HKWorkoutSessionState,

from fromState: HKWorkoutSessionState,

date: Date) {

if toState == .ended {

// Workout ended, time to save

// Save Workout

let workout = HKWorkout(

// Save Workout

let workout = HKWorkout( activityType: config.activityType,

// Save Workout

start: startDate,

activityType: config.activityType,

// Save Workout

start: startDate,

end: endDate,

// Save Workout

start: startDate,

end: endDate,

workoutEvents: events,

// Save Workout

start: startDate,

end: endDate,

totalEnergyBurned: totalEnergyBurned,

// Save Workout

start: startDate,

end: endDate,

totalDistance: totalDistance,

// Save Workout

start: startDate,

end: endDate,

metadata: [HKMetadataKeyIndoorWorkout: isIndoor])

// Save Workout

start: startDate,

end: endDate,

metadata: [HKMetadataKeyIndoorWorkout: isIndoor])

healthStore.save(workout) { (success, error) in

// Workout saved

Add Samples to Workout

Creates an association

Creates an associationQuery later for graphs

Creates an associationQuery later for graphsActivity Move ring credit

Creates an associationQuery later for graphsActivity Move ring creditMatch totals on HKWorkout

// Add Samples to Workout

healthStore.add(samples, to: workout) { (success, error) in

// Samples added

DemoSpeedySloth: Ending and Saving

Workouts in iOS 10

Workout apps have parent iPhone application

Workouts in iOS 10

Workout apps have parent iPhone applicationWatchConnectivity for messaging when Apple Watch app is running

Workouts in iOS 10

Workout apps have parent iPhone applicationWatchConnectivity for messaging when Apple Watch app is runningBackground running

Workouts in iOS 10

Workout apps have parent iPhone applicationWatchConnectivity for messaging when Apple Watch app is runningBackground runningStart a workout from iPhone

Workouts in iOS 10

Workout apps have parent iPhone applicationWatchConnectivity for messaging when Apple Watch app is runningBackground runningStart a workout from iPhoneNo user intervention on Apple Watch

Workouts in iOS 10

HKWorkoutConfiguration

iPhone App

Workouts in iOS 10

HKWorkoutConfiguration

iPhone App Apple Watch App

Workouts in iOS 10

HKWorkoutConfigurationStart

HKWorkoutSession

Workouts in iOS 10

HKWorkoutConfigurationStart

HKWorkoutSession

<key>UIBackgroundModes</key>

<array>

<string>workout-processing</string>

</array>

workoutSession.delegate = self

// Starting Workout from iPhone

// Apple Watch App

// iPhone App

if wcSession.activationState == .activated && wcSession.isWatchAppInstalled {

// iPhone App

healthStore.startWatchApp(with: workoutConfiguration) { (success, error) in

// iPhone App

healthStore.startWatchApp(with: workoutConfiguration) { (success, error) in

// iPhone App

// Apple Watch App

func handle(_ workoutConfiguration: HKWorkoutConfiguration) {

class ExtensionDelegate: WKExtensionDelegate {

// Apple Watch App

class ExtensionDelegate: WKExtensionDelegate {

// Apple Watch App

DemoSpeedySloth: iPhone App

Best Practices

Ensure Apple Watch app is functional when iPhone is unreachable

Best Practices

Ensure Apple Watch app is functional when iPhone is unreachable• Keep session running when losing connectivity

Best Practices

Ensure Apple Watch app is functional when iPhone is unreachable• Keep session running when losing connectivity• Use HealthKit distance when GPS is unavailable

Best Practices

User should be able to begin workout on Apple Watch or iPhone

Best Practices

User should be able to begin workout on Apple Watch or iPhoneDisplay workouts from other sources

Best Practices

User should be able to begin workout on Apple Watch or iPhoneDisplay workouts from other sourcesDon’t display deleted workouts

Summary

Background running

Summary

Background runningContribute to Activity rings

Summary

Background runningContribute to Activity ringsStart workout from Apple Watch or iPhone

More Information

https://developer.apple.com/wwdc16/235

Related Sessions

Getting the Most out of HealthKit Wednesday

Health and Fitness with Core Motion Thursday

Introducing HealthKit WWDC 2014

Designing Accessories for iOS and OS X WWDC 2014

What’s New in HealthKit WWDC 2015

building great workout apps

Documents

great apps review

cis13: deliver secure apps with great experiences

the great housing workout -...

beyond touchscreens: designing great tv apps

yoga mats: best yoga workout can get great abs in weeks

five great travel apps

workout with other fitness apps this fi tness machine has...

great vibration. home of the 20 minute workout!!!!

a great full body workout you can perform at home

great keek apps

great single page apps need great backends

7 great-language-learning-apps

great nook apps for libraries

building insanely great apps and companies

4 steps to great xplat apps (m

how to design and build great apps

nglightning + angular2 + lightning design system = great...

mtb endurance workout...

10 great fitness phone apps

creating great apps - recent proceedings