【Swift】HealthKitの睡眠データを取得して表示する

HealthKitの睡眠（SleepAnalysis）データを取得・表示する方法について記載します。

Xcodeで HealthKit の設定を行っていない場合は、以下の設定も行ってください。

HealthKitデータの読み込み・書き込みの設定方法について

睡眠データの取得方法

環境

・iOS14.4

・Xcode 12.4

デモ

最後に記載しているコードを実行すると以下のように表示されます。

1 や 0 は睡眠の状態を表しています。

inBed: 0
asleep: 1

状態の定義は、こちらのサイトに記載されています。

HKCategoryValueSleepAnalysis

ポイント１：権限のリクエスト

権限のリクエストには “HKCategoryTypeIdentifier.sleepAnalysis” を指定します。

let healthStore = HKHealthStore()
let readTypes = Set([
    HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!
])

healthStore.requestAuthorization(toShare: [], read: readTypes, completion: { success, error in
    
    if success == false {
        print("データにアクセスできません")
        return
    }
    
    // 睡眠データを取得
})

let healthStore = HKHealthStore()

let readTypes = Set([

HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!

])

healthStore.requestAuthorization(toShare: [], read: readTypes, completion: { success, error in

if success == false {

print("データにアクセスできません")

return

}

// 睡眠データを取得

})

ポイント２：睡眠データの取得

権限のリクエストが成功した場合、睡眠データを取得することができます。
次のように、HKSampleQuery を生成し実行するとデータを取得できます。

// 睡眠データを取得
let query = HKSampleQuery(sampleType: HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!,
                                predicate: HKQuery.predicateForSamples(withStart: fromDate, end: toDate, options: []),
                                limit: HKObjectQueryNoLimit,
                                sortDescriptors: [NSSortDescriptor(key: HKSampleSortIdentifierEndDate, ascending: true)]){ (query, results, error) in
    
    guard error == nil else { print("error"); return }
    
    if let tmpResults = results as? [HKCategorySample] {
        // 取得したデータを格納
    }
}
healthStore.execute(query)

// 睡眠データを取得

let query = HKSampleQuery(sampleType: HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!,

predicate: HKQuery.predicateForSamples(withStart: fromDate, end: toDate, options: []),

limit: HKObjectQueryNoLimit,

sortDescriptors: [NSSortDescriptor(key: HKSampleSortIdentifierEndDate, ascending: true)]){ (query, results, error) in

guard error == nil else { print("error"); return }

if let tmpResults = results as? [HKCategorySample] {

// 取得したデータを格納

}

healthStore.execute(query)

サンプルコード

サンプルコードは次の構成になっています。

ContentView.swift
取得データをリストで表示します。
ContentViewModel で格納される dataSource配列の値を参照してリストを生成します。

ContentViewModel.swift
睡眠データを取得します。
取得した睡眠データは、１データずつ ListRowItem構造体に格納し、dataSource配列に追加します。

ListRowItem.swift
取得した睡眠データを格納するための構造体です。

ContentView.swift

import SwiftUI

struct ContentView: View {
    
    @ObservedObject var contentVM: ContentViewModel
    let dateformatter = DateFormatter()
    init(){
        
        contentVM = ContentViewModel()

        dateformatter.timeZone = TimeZone(identifier: "Asia/Tokyo")
        dateformatter.locale = Locale(identifier: "ja_JP")
        dateformatter.dateFormat = "yyyy/MM/dd HH:mm:ss"
        
        // 睡眠データを取得する関数を呼ぶ（引数は期間）
        contentVM.get(
            fromDate: dateformatter.date(from: "2020/12/01 00:00:00")!,
            toDate: dateformatter.date(from: "2021/01/01 23:59:59")!
        )
    }
    
    var body: some View {
        NavigationView {
            List {
                if contentVM.dataSource.count == 0 {
                    Text("データがありません。")
                } else {
                    ForEach( contentVM.dataSource ){ item in
                        HStack{
                            Text(dateformatter.string(from: item.datetime))
                            Text(" \(item.sleepStatus)")
                        }
                    }
                }
            }.navigationBarTitle(Text("睡眠一覧"), displayMode: .inline)
        }
    }
}

struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView()
    }
}

import SwiftUI

struct ContentView: View {

@ObservedObject var contentVM: ContentViewModel

let dateformatter = DateFormatter()

init(){

contentVM = ContentViewModel()

dateformatter.timeZone = TimeZone(identifier: "Asia/Tokyo")

dateformatter.locale = Locale(identifier: "ja_JP")

dateformatter.dateFormat = "yyyy/MM/dd HH:mm:ss"

// 睡眠データを取得する関数を呼ぶ（引数は期間）

contentVM.get(

fromDate: dateformatter.date(from: "2020/12/01 00:00:00")!,

toDate: dateformatter.date(from: "2021/01/01 23:59:59")!

)

}

var body: some View {

NavigationView {

List {

if contentVM.dataSource.count == 0 {

Text("データがありません。")

} else {

ForEach( contentVM.dataSource ){ item in

HStack{

Text(dateformatter.string(from: item.datetime))

Text(" \(item.sleepStatus)")

}

}.navigationBarTitle(Text("睡眠一覧"), displayMode: .inline)

}

struct ContentView_Previews: PreviewProvider {

static var previews: some View {

ContentView()

}

ContentViewModel.swift

import SwiftUI
import Combine
import HealthKit

class ContentViewModel: ObservableObject, Identifiable {

    @Published var dataSource:[ListRowItem] = []
    
    func get( fromDate: Date, toDate: Date)  {

        let healthStore = HKHealthStore()
        let readTypes = Set([
            HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!
        ])
        
        healthStore.requestAuthorization(toShare: [], read: readTypes, completion: { success, error in
            
            if success == false {
                print("データにアクセスできません")
                return
            }
            
            // 睡眠データを取得
            let query = HKSampleQuery(sampleType: HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!,
                                           predicate: HKQuery.predicateForSamples(withStart: fromDate, end: toDate, options: []),
                                           limit: HKObjectQueryNoLimit,
                                           sortDescriptors: [NSSortDescriptor(key: HKSampleSortIdentifierEndDate, ascending: true)]){ (query, results, error) in
                
                guard error == nil else { print("error"); return }
                
                if let tmpResults = results as? [HKCategorySample] {
                    
                    // 取得したデータを１件ずつ ListRowItem 構造体に格納
                    // ListRowItemは、dataSource配列に追加します。ViewのListでは、この dataSource配列を参照して睡眠状態を表示します。
                    for item in tmpResults {

                        let listItem = ListRowItem(
                            id: item.uuid.uuidString,
                            datetime: item.endDate,
                            sleepStatus: item.value.description
                        )

                        self.dataSource.append(listItem)
                    }
                }
            }
            healthStore.execute(query)
        })
    }
}

import SwiftUI

import Combine

import HealthKit

class ContentViewModel: ObservableObject, Identifiable {

@Published var dataSource:[ListRowItem] = []

func get( fromDate: Date, toDate: Date) {

let healthStore = HKHealthStore()

let readTypes = Set([

HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!

])

healthStore.requestAuthorization(toShare: [], read: readTypes, completion: { success, error in

if success == false {

print("データにアクセスできません")

return

}

// 睡眠データを取得

let query = HKSampleQuery(sampleType: HKObjectType.categoryType(forIdentifier: HKCategoryTypeIdentifier.sleepAnalysis)!,

predicate: HKQuery.predicateForSamples(withStart: fromDate, end: toDate, options: []),

limit: HKObjectQueryNoLimit,

sortDescriptors: [NSSortDescriptor(key: HKSampleSortIdentifierEndDate, ascending: true)]){ (query, results, error) in

guard error == nil else { print("error"); return }

if let tmpResults = results as? [HKCategorySample] {

// 取得したデータを１件ずつ ListRowItem 構造体に格納

// ListRowItemは、dataSource配列に追加します。ViewのListでは、この dataSource配列を参照して睡眠状態を表示します。

for item in tmpResults {

let listItem = ListRowItem(

id: item.uuid.uuidString,

datetime: item.endDate,

sleepStatus: item.value.description

)

self.dataSource.append(listItem)

}

healthStore.execute(query)

})

}

ListRowItem.swift

import SwiftUI

struct ListRowItem: Identifiable {
    var id: String
    var datetime: Date
    var sleepStatus: String
}

import SwiftUI

struct ListRowItem: Identifiable {

var id: String

var datetime: Date

var sleepStatus: String

}