Это руководство совместимо с Health Connect версии 1.1.0-alpha11 .
Health Connect предоставляет тип данных запланированных упражнений , позволяющий тренировочным приложениям писать планы тренировок и считывать планы тренировок с помощью приложений для тренировок. Записанные упражнения (тренировки) можно считывать для персонализированного анализа производительности, чтобы помочь пользователям достичь своих целей тренировок.
Наличие функции
Чтобы определить, поддерживает ли устройство пользователя планы тренировок в Health Connect, проверьте доступность FEATURE_PLANNED_EXERCISE
на клиенте:
if (healthConnectClient
.features
.getFeatureStatus(
HealthConnectFeatures.FEATURE_PLANNED_EXERCISE
) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE) {
// Feature is available
} else {
// Feature isn't available
}
Более подробную информацию см. в разделе «Проверка доступности функций» .
Требуемые разрешения
Доступ к планам обучения защищен следующими разрешениями:
-
android.permission.health.READ_PLANNED_EXERCISE
-
android.permission.health.WRITE_PLANNED_EXERCISE
Объявите эти разрешения в Play Console для вашего приложения, а также в манифесте вашего приложения:
<application>
<uses-permission
android:name="android.permission.health.READ_PLANNED_EXERCISE" />
<uses-permission
android:name="android.permission.health.WRITE_PLANNED_EXERCISE" />
...
</application>
Вы несете ответственность за объявление всех соответствующих разрешений, которые вы собираетесь использовать в своих устройствах и приложениях. Вы также должны проверить, что каждое разрешение было предоставлено пользователем перед использованием.
Запросить разрешения у пользователя
После создания экземпляра клиента ваше приложение должно запросить разрешения у пользователя. Пользователи должны иметь возможность предоставлять или отклонять разрешения в любое время.
Для этого создайте набор разрешений для требуемых типов данных. Убедитесь, что разрешения в наборе сначала объявлены в вашем манифесте Android.
// Create a set of permissions for required data types
val PERMISSIONS =
setOf(
HealthPermission.getReadPermission(HeartRateRecord::class),
HealthPermission.getWritePermission(HeartRateRecord::class),
HealthPermission.getReadPermission(PlannedExerciseSessionRecord::class),
HealthPermission.getWritePermission(PlannedExerciseSessionRecord::class),
HealthPermission.getReadPermission(ExerciseSessionRecord::class),
HealthPermission.getWritePermission(ExerciseSessionRecord::class)
)
Используйте getGrantedPermissions
, чтобы узнать, предоставлены ли вашему приложению требуемые разрешения. Если нет, используйте createRequestPermissionResultContract
, чтобы запросить эти разрешения. Это отобразит экран разрешений Health Connect.
// Create the permissions launcher
val requestPermissionActivityContract = PermissionController.createRequestPermissionResultContract()
val requestPermissions = registerForActivityResult(requestPermissionActivityContract) { granted ->
if (granted.containsAll(PERMISSIONS)) {
// Permissions successfully granted
} else {
// Lack of required permissions
}
}
suspend fun checkPermissionsAndRun(healthConnectClient: HealthConnectClient) {
val granted = healthConnectClient.permissionController.getGrantedPermissions()
if (granted.containsAll(PERMISSIONS)) {
// Permissions already granted; proceed with inserting or reading data
} else {
requestPermissions.launch(PERMISSIONS)
}
}
Поскольку пользователи могут предоставлять или отзывать разрешения в любое время, вашему приложению необходимо периодически проверять наличие предоставленных разрешений и обрабатывать сценарии, в которых разрешение теряется.
Связанные разрешения
Планы тренировок связаны с сеансами упражнений . Поэтому пользователь должен дать разрешение на использование каждого типа записи, связанного с планом тренировок, чтобы в полной мере использовать эту функцию Health Connect.
Например, если план тренировок измеряет частоту сердечных сокращений пользователя во время серии пробежек, разработчику может потребоваться объявить следующие разрешения, а пользователю — предоставить их, чтобы записать сеанс упражнений и прочитать результаты для последующей оценки:
-
android.permission.health.READ_EXERCISE
-
android.permission.health.READ_EXERCISE_ROUTES
-
android.permission.health.READ_HEART_RATE
-
android.permission.health.WRITE_EXERCISE
-
android.permission.health.WRITE_EXERCISE_ROUTE
-
android.permission.health.WRITE_HEART_RATE
Однако часто приложение, которое создает планы тренировок и оценивает производительность по планам, не совпадает с приложением, которое использует планы тренировок и записывает фактические данные упражнений. В зависимости от типа приложения не все разрешения на чтение и запись могут потребоваться. Например, вам могут понадобиться только эти разрешения для каждого типа приложения:
Приложение для плана тренировок | Приложение для тренировок |
---|---|
WRITE_PLANNED_EXERCISE | READ_PLANNED_EXERCISE |
READ_EXERCISE | WRITE_EXERCISE |
READ_EXERCISE_ROUTES | WRITE_EXERCISE_ROUTE |
READ_HEART_RATE | WRITE_HEART_RATE |
Информация, включенная в запись запланированной тренировки
- Название сессии.
- Список запланированных блоков упражнений .
- Время начала и окончания сеанса.
- Тип упражнения.
- Примечания к занятию.
- Метаданные.
- Идентификатор завершенного сеанса упражнений — записывается автоматически после завершения сеанса упражнений, связанного с этим запланированным сеансом упражнений.
Информация, включенная в запись запланированного блока упражнений
Запланированный блок упражнений содержит список этапов упражнений, способствующих повторению различных групп шагов (например, выполните последовательность сгибаний рук, берпи и скручиваний пять раз подряд).
- Описание блока.
- Список запланированных этапов упражнений .
- Количество повторений.
Информация, включенная в запись запланированных шагов упражнений
- Описание шага.
- Категория упражнений .
- Тип упражнения .
- Список целей производительности .
- Цель завершения .
Поддерживаемые агрегации
Для этого типа данных не поддерживается агрегация.
Пример использования
Предположим, пользователь планирует 90-минутную пробежку через два дня. Эта пробежка будет включать три круга вокруг озера с целевым пульсом от 90 до 110 ударов в минуту.
- Пользователь определяет в приложении плана тренировок запланированную сессию тренировок, которая включает в себя следующее:
- Планируемое начало и конец пробега
- Вид упражнения (бег)
- Количество кругов (повторений)
- Целевой показатель частоты сердечных сокращений (от 90 до 110 ударов в минуту)
- Эта информация группируется в блоки упражнений и шаги и записывается в Health Connect приложением плана тренировок как
PlannedExerciseSessionRecord
. - Пользователь выполняет запланированный сеанс (бег).
- Данные об упражнениях, относящиеся к сеансу, регистрируются либо:
- С помощью носимого устройства во время сеанса. Например, частота сердечных сокращений. Эти данные записываются в Health Connect как тип записи для активности. В этом случае
HeartRateRecord
. - Вручную пользователем после сеанса. Например, указание начала и окончания фактического забега. Эти данные записываются в Health Connect как
ExerciseSessionRecord
.
- С помощью носимого устройства во время сеанса. Например, частота сердечных сокращений. Эти данные записываются в Health Connect как тип записи для активности. В этом случае
- Позднее приложение плана тренировок считывает данные из Health Connect, чтобы оценить фактические результаты по сравнению с целями, установленными пользователем в запланированной сессии упражнений.
Планируйте упражнения и ставьте цели
Пользователь может планировать свои упражнения в будущем и устанавливать цели. Запишите это в Health Connect как запланированную сессию упражнений .
В примере, описанном в Пример использования , пользователь планирует 90-минутную пробежку через два дня. Эта пробежка будет включать три круга вокруг озера с целевым пульсом от 90 до 110 ударов в минуту.
Подобный фрагмент можно найти в обработчике форм для приложения, которое регистрирует запланированные сеансы упражнений в Health Connect. Его также можно найти в точке приема для интеграций, например, с сервисом, который предлагает обучение.
// Ensure the user has granted all necessary permissions for this task
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.contains(
HealthPermission.getWritePermission(PlannedExerciseSessionRecord::class))) {
// The user hasn't granted the app permission to write planned exercise session data.
return
}
val plannedDuration = Duration.ofMinutes(90)
val plannedStartDate = LocalDate.now().plusDays(2)
val plannedExerciseSessionRecord = PlannedExerciseSessionRecord(
startDate = plannedStartDate,
duration = plannedDuration,
exerciseType = ExerciseSessionRecord.EXERCISE_TYPE_RUNNING,
blocks = listOf(
PlannedExerciseBlock(
repetitions = 1, steps = listOf(
PlannedExerciseStep(
exerciseType = ExerciseSegment.EXERCISE_SEGMENT_TYPE_RUNNING,
exercisePhase = PlannedExerciseStep.EXERCISE_PHASE_ACTIVE,
completionGoal = ExerciseCompletionGoal.RepetitionsGoal(repetitions = 3),
performanceTargets = listOf(
ExercisePerformanceTarget.HeartRateTarget(
minHeartRate = 90.0, maxHeartRate = 110.0
)
)
),
), description = "Three laps around the lake"
)
),
title = "Run at lake",
notes = null,
metadata = Metadata.manualEntry(
device = Device(type = Device.Companion.TYPE_PHONE)
)
)
val insertedPlannedExerciseSessions =
healthConnectClient.insertRecords(listOf(plannedExerciseSessionRecord)).recordIdsList
val insertedPlannedExerciseSessionId = insertedPlannedExerciseSessions.first()
Регистрируйте данные об упражнениях и активности
Два дня спустя пользователь регистрирует реальную сессию упражнений. Запишите это в Health Connect как сессию упражнений .
В этом примере продолжительность сеанса пользователя точно совпала с запланированной.
Следующий фрагмент можно найти в обработчике форм для приложения, которое регистрирует сеансы упражнений в Health Connect. Его также можно найти в обработчиках приема и экспорта данных для носимых устройств, способных обнаруживать и регистрировать сеансы упражнений.
insertedPlannedExerciseSessionId
здесь повторно используется из предыдущего примера. В реальном приложении идентификатор будет определяться пользователем, выбирающим запланированную сессию упражнений из списка существующих сессий.
// Ensure the user has granted all necessary permissions for this task
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.contains(
HealthPermission.getWritePermission(ExerciseSessionRecord::class))) {
// The user doesn't granted the app permission to write exercise session data.
return
}
val sessionDuration = Duration.ofMinutes(90)
val sessionEndTime = Instant.now()
val sessionStartTime = sessionEndTime.minus(sessionDuration)
val exerciseSessionRecord = ExerciseSessionRecord(
startTime = sessionStartTime,
startZoneOffset = ZoneOffset.UTC,
endTime = sessionEndTime,
endZoneOffset = ZoneOffset.UTC,
exerciseType = ExerciseSessionRecord.EXERCISE_TYPE_RUNNING,
segments = listOf(
ExerciseSegment(
startTime = sessionStartTime,
endTime = sessionEndTime,
repetitions = 3,
segmentType = ExerciseSegment.EXERCISE_SEGMENT_TYPE_RUNNING
)
),
title = "Run at lake",
plannedExerciseSessionId = insertedPlannedExerciseSessionId,
metadata = Metadata.manualEntry(
device = Device(type = Device.Companion.TYPE_PHONE)
)
)
val insertedExerciseSessions =
healthConnectClient.insertRecords(listOf(exerciseSessionRecord))
Носимое устройство также регистрирует частоту сердечных сокращений во время бега. Следующий фрагмент может быть использован для создания записей в целевом диапазоне.
В реальном приложении основные части этого фрагмента можно найти в обработчике сообщений от носимого устройства, который будет записывать данные измерений в Health Connect после их получения.
// Ensure the user has granted all necessary permissions for this task
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.contains(
HealthPermission.getWritePermission(HeartRateRecord::class))) {
// The user doesn't granted the app permission to write heart rate record data.
return
}
val samples = mutableListOf<HeartRateRecord.Sample>()
var currentTime = sessionStartTime
while (currentTime.isBefore(sessionEndTime)) {
val bpm = Random.nextInt(21) + 90
val heartRateRecord = HeartRateRecord.Sample(
time = currentTime,
beatsPerMinute = bpm.toLong(),
)
samples.add(heartRateRecord)
currentTime = currentTime.plusSeconds(180)
}
val heartRateRecord = HeartRateRecord(
startTime = sessionStartTime,
startZoneOffset = ZoneOffset.UTC,
endTime = sessionEndTime,
endZoneOffset = ZoneOffset.UTC,
samples = samples,
metadata = Metadata.autoRecorded(
device = Device(type = Device.Companion.TYPE_WATCH)
)
)
val insertedHeartRateRecords = healthConnectClient.insertRecords(listOf(heartRateRecord))
Оценить целевые показатели производительности
На следующий день после тренировки пользователя вы можете получить записанные данные об упражнениях, проверить наличие запланированных целей по упражнениям и оценить дополнительные типы данных, чтобы определить, были ли достигнуты поставленные цели.
Подобный фрагмент, скорее всего, можно найти в периодическом задании по оценке целевых показателей производительности или при загрузке списка упражнений и отображении уведомления о целевых показателях производительности в приложении.
// Ensure the user has granted all necessary permissions for this task
val grantedPermissions =
healthConnectClient.permissionController.getGrantedPermissions()
if (!grantedPermissions.containsAll(
listOf(
HealthPermission.getReadPermission(ExerciseSessionRecord::class),
HealthPermission.getReadPermission(PlannedExerciseSessionRecord::class),
HealthPermission.getReadPermission(HeartRateRecord::class)
)
)
) {
// The user doesn't granted the app permission to read exercise session record data.
return
}
val searchDuration = Duration.ofDays(1)
val searchEndTime = Instant.now()
val searchStartTime = searchEndTime.minus(searchDuration)
val response = healthConnectClient.readRecords(
ReadRecordsRequest<ExerciseSessionRecord>(
timeRangeFilter = TimeRangeFilter.between(searchStartTime, searchEndTime)
)
)
for (exerciseRecord in response.records) {
val plannedExerciseRecordId = exerciseRecord.plannedExerciseSessionId
val plannedExerciseRecord =
if (plannedExerciseRecordId == null) null else healthConnectClient.readRecord(
PlannedExerciseSessionRecord::class, plannedExerciseRecordId
).record
if (plannedExerciseRecord != null) {
val aggregateRequest = AggregateRequest(
metrics = setOf(HeartRateRecord.BPM_AVG),
timeRangeFilter = TimeRangeFilter.between(
exerciseRecord.startTime, exerciseRecord.endTime
),
)
val aggregationResult = healthConnectClient.aggregate(aggregateRequest)
val maxBpm = aggregationResult[HeartRateRecord.BPM_MAX]
val minBpm = aggregationResult[HeartRateRecord.BPM_MIN]
if (maxBpm != null && minBpm != null) {
plannedExerciseRecord.blocks.forEach { block ->
block.steps.forEach { step ->
step.performanceTargets.forEach { target ->
when (target) {
is ExercisePerformanceTarget.HeartRateTarget -> {
val minTarget = target.minHeartRate
val maxTarget = target.maxHeartRate
if(
minBpm >= minTarget && maxBpm <= maxTarget
) {
// Success!
}
}
// Handle more target types
}
}
}
}
}
}
}
}