Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stanfordspezi/spezihealthkit
HealthKit module of the Stanford Spezi framework
https://github.com/stanfordspezi/spezihealthkit
healthkit ios spezi stanford swiftui
Last synced: 3 months ago
JSON representation
HealthKit module of the Stanford Spezi framework
- Host: GitHub
- URL: https://github.com/stanfordspezi/spezihealthkit
- Owner: StanfordSpezi
- License: mit
- Created: 2023-04-12T22:56:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-11T22:13:16.000Z (about 1 year ago)
- Last Synced: 2023-12-19T17:44:21.810Z (about 1 year ago)
- Topics: healthkit, ios, spezi, stanford, swiftui
- Language: Swift
- Homepage: https://swiftpackageindex.com/StanfordSpezi/SpeziHealthKit/documentation/
- Size: 65.4 KB
- Stars: 10
- Watchers: 9
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Spezi HealthKit
[](https://github.com/StanfordSpezi/SpeziHealthKit/actions/workflows/build-and-test.yml)
[](https://codecov.io/gh/StanfordSpezi/SpeziHealthKit)
[](https://doi.org/10.5281/zenodo.7824636)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziHealthKit)
[](https://swiftpackageindex.com/StanfordSpezi/SpeziHealthKit)
Simplifies access to HealthKit samples ranging from single, anchored, and background queries.
## Overview
The Spezi HealthKit module simplifies access to HealthKit samples ranging from single, anchored, and background queries.
### Setup
You need to add the Spezi HealthKit Swift package to
[your app in Xcode](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app) or
[Swift package](https://developer.apple.com/documentation/xcode/creating-a-standalone-swift-package-with-xcode#Add-a-dependency-on-another-Swift-package).
> Important: If your application is not yet configured to use Spezi, follow the
[Spezi setup article](https://swiftpackageindex.com/stanfordspezi/spezi/documentation/spezi/initial-setup) and set up the core Spezi infrastructure.
### Example
Before you configure the ``HealthKit`` module, make sure your `Standard` in your Spezi Application conforms to the ``HealthKitConstraint`` protocol to receive HealthKit data.
The [`add(sample:)`](https://swiftpackageindex.com/stanfordspezi/spezihealthkit/documentation/spezihealthkit/healthkitconstraint/add(sample:)) function is triggered once for every newly collected HealthKit sample, and the [`remove(sample:)`](https://swiftpackageindex.com/stanfordspezi/spezihealthkit/documentation/spezihealthkit/healthkitconstraint/remove(sample:)) function
```swift
actor ExampleStandard: Standard, HealthKitConstraint {
// Add the newly collected HKSample to your application.
func add(sample: HKSample) async {
// ...
}
// Remove the deleted HKSample from your application.
func remove(sample: HKDeletedObject) {
// ...
}
}
```
Then, you can configure the ``HealthKit`` module in the configuration section of your `SpeziAppDelegate`.
Provide ``HealthKitDataSourceDescription`` to define the data collection.
You can, e.g., use ``CollectSample`` to collect a wide variety of `HKSampleTypes`:
```swift
class ExampleAppDelegate: SpeziAppDelegate {
override var configuration: Configuration {
Configuration(standard: ExampleStandard()) {
if HKHealthStore.isHealthDataAvailable() {
HealthKit {
CollectSample(
HKQuantityType.electrocardiogramType(),
deliverySetting: .background(.manual)
)
CollectSample(
HKQuantityType(.stepCount),
deliverySetting: .background(.automatic)
)
CollectSample(
HKQuantityType(.pushCount),
deliverySetting: .anchorQuery(.manual)
)
CollectSample(
HKQuantityType(.activeEnergyBurned),
deliverySetting: .anchorQuery(.automatic)
)
CollectSample(
HKQuantityType(.restingHeartRate),
deliverySetting: .manual()
)
}
}
}
}
}
```
For more information, please refer to the [API documentation](https://swiftpackageindex.com/StanfordSpezi/SpeziHealthKit/documentation).
## The Spezi Template Application
The [Spezi Template Application](https://github.com/StanfordSpezi/SpeziTemplateApplication) provides a great starting point and example using the `SpeziHealthKit` module.
## Contributing
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md) and the [contributor covenant code of conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) first.
## License
This project is licensed under the MIT License. See [Licenses](https://github.com/StanfordSpezi/SpeziHealthKit/tree/main/LICENSES) for more information.
