Skip to content

Document Apple Health sensors #1368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aero-oli wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document Apple Health sensors #1368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5e7a61
Document Apple Health sensors
aero-oli Jul 2, 2026
d4b8b29
Update Apple Health sensor enablement docs
aero-oli Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/core/sensors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ Not all ![iOS](/assets/iOS.svg) sensors are enabled by default. If you don't see
| `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.health_steps` | None | The number of steps recorded in Apple Health since midnight local time. |
| `sensor.location_permission` | None | The current location permission that was selected by the user. The permission can be set via the location permission popup or modified in the iOS settings. |
| `sensor.sim_1` | [See Below](#cellular-provider-sensor) | Name of your cellular provider. |
| `sensor.sim_2` | [See Below](#cellular-provider-sensor) | Name of your cellular provider. |
Expand Down Expand Up @@ -691,6 +693,18 @@ The pedometer sensors provide step-counting data from the device\'s built-in mot
![Android](/assets/android.svg) Android users will only have a `sensor.steps` entity which will represent the total number of steps taken since the last device reboot. A recommended approach to getting your daily step count is to use the [Utility Meter integration](https://www.home-assistant.io/integrations/utility_meter) with `cycle: daily`. This sensor will update during the normal sensor update interval and makes use of the [Motion Sensor](https://developer.android.com/guide/topics/sensors/sensors_motion?hl=en). This sensor requires the [Activity Recognition permission](https://developer.android.com/reference/android/Manifest.permission#ACTIVITY_RECOGNITION).


## Apple Health sensors
![iOS](/assets/iOS.svg)<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 use them, go to **Companion App Settings** > **Sensors**, request Apple Health access, allow the requested Health permissions, and enable the individual Apple Health sensors you want to share.

Apple Health sensors update with the normal iOS sensor update cycle. They do not enable HealthKit background delivery.

| 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. |


## Phone sensors

### Data network type sensor
Expand Down