Document Apple Health sensors - #1368
Open
aero-oli wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documents newly added iOS Apple Health (HealthKit) sensor entities in the Companion App documentation by adding them to the main sensor list and introducing a dedicated “Apple Health sensors” section that explains opt-in behavior and update cadence.
Changes:
- Added
sensor.health_stepsandsensor.health_resting_heart_rateto the iOS sensor list. - Added a new “Apple Health sensors” section describing enablement requirements (opt-in + Apple Health read permission) and update behavior.
|
|
||
| ## Apple Health sensors | ||
| <br /> | ||
| <span class='beta'>BETA</span> Apple Health sensors read health and fitness data from HealthKit. They are opt-in and require Apple Health read permission. To enable them, go to **Companion App Settings** > **Sensors**, enable **Apple Health Sensors**, and allow the requested Health permissions. |
| | `sensor.distance` | None | The estimated distance walked by the user since midnight local time. Units: meters, m | | ||
| | `sensor.floors_ascended` | None | The approximate number of floors ascended by walking since midnight local time. | | ||
| | `sensor.floors_descended` | None | The approximate number of floors descended by walking. Since | | ||
| | `sensor.health_resting_heart_rate` | None | The latest resting heart rate value available from Apple Health. Units: beats per minute, bpm | |
| | Sensor | Description | | ||
| | --------- | --------- | | ||
| | `sensor.health_steps` | The number of steps recorded in Apple Health since midnight local time. | | ||
| | `sensor.health_resting_heart_rate` | The latest resting heart rate value available from the last 7 days. | |
bgoncal
added a commit
to home-assistant/iOS
that referenced
this pull request
Jul 28, 2026
<!-- Thank you for submitting a Pull Request and helping to improve Home Assistant. Please complete the following sections to help the processing and review of your changes. Please do not delete anything from this template. --> ## Summary Adds optional HealthKit-backed iOS sensors so selected health metrics can be exposed through the existing Home Assistant sensor webhook flow. This includes: - HealthKit authorization and sensor value collection for supported health metrics. - A persisted app setting for enabling/disabling HealthKit sensors. - Sensors settings UI wiring so the HealthKit group appears alongside existing sensor controls. - The required HealthKit entitlement and usage description. - Unit coverage for HealthKit sensor encoding/collection behavior and the sensor list view model wiring. ## Screenshots <img width="1206" height="2622" alt="serve-sim-screenshot-2026-07-24T17-13-15-427" src="https://github.com/user-attachments/assets/708cf53a-7427-4b6c-99b8-d42e992b056b" /> <img width="1206" height="2622" alt="serve-sim-screenshot-2026-07-24T17-14-53-623" src="https://github.com/user-attachments/assets/15ef99ce-6a0f-49e0-8b25-af27900ce3df" /> <img width="1206" height="2622" alt="serve-sim-screenshot-2026-07-24T17-15-12-007" src="https://github.com/user-attachments/assets/0fc4090d-ce5e-4cfe-8034-828ac8c635a0" /> ## Link to pull request in Documentation repository Documentation: home-assistant/companion.home-assistant#1368 ## Any other notes Validation: CI passed on the fork PR, including lint, unused-string checks, SwiftLint disable checks, and the test job: https://github.com/aero-oli/iOS/actions/runs/28614134149 --------- Co-authored-by: Bruno Pantaleão Gonçalves <5808343+bgoncal@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed change
Documents the new iOS Apple Health sensors added by home-assistant/iOS#4923.
This updates the sensors page with the new HealthKit-backed sensor entities, explains that the feature is opt-in, notes the required Apple Health read permission, and describes the normal iOS sensor update behavior.
Type of change
Checklist
Additional information
Validation:
NPM_CONFIG_CACHE=/private/tmp/npm-cache npx --yes yarn@1.22.22 buildcompleted successfully.