Interface PolarSleepApi
-
- All Implemented Interfaces:
public interface PolarSleepApiPolar sleep API. Requires feature FEATURE_POLAR_SLEEP_DATA
-
-
Method Summary
Modifier and Type Method Description abstract BooleangetSleepRecordingState(String identifier, Long timeoutMs)Get sleep recording state. abstract Flow<BooleanArray>observeSleepRecordingState(String identifier)Observe sleep recording state. abstract PolarSleepRecordingStatusgetSleepRecordingStatus(String identifier, Long timeoutMs)Get sleep recording status. abstract Flow<Array<PolarSleepRecordingStatus>>observeSleepRecordingStatus(String identifier)Observe sleep recording status. abstract UnitstopSleepRecording(String identifier)Stop sleep recording. abstract List<PolarSleepData>getSleep(String identifier, LocalDate fromDate, LocalDate toDate)Get sleep stages and duration for a given period. -
-
Method Detail
-
getSleepRecordingState
@Deprecated(message = "Use getSleepRecordingStatus, which reports unknown state instead of off", replaceWith = @ReplaceWith(imports = {}, expression = "getSleepRecordingStatus(identifier, timeoutMs)")) abstract Boolean getSleepRecordingState(String identifier, Long timeoutMs)
Get sleep recording state. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT addresstimeoutMs- maximum time in milliseconds to wait for the state.- Returns:
boolean value indicating if sleep recording is ongoing
-
observeSleepRecordingState
@Deprecated(message = "Use observeSleepRecordingStatus, which reports unknown state instead of off", replaceWith = @ReplaceWith(imports = {}, expression = "observeSleepRecordingStatus(identifier)")) abstract Flow<BooleanArray> observeSleepRecordingState(String identifier)
Observe sleep recording state. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT address- Returns:
Flow of boolean values indicating if sleep recording is ongoing
-
getSleepRecordingStatus
abstract PolarSleepRecordingStatus getSleepRecordingStatus(String identifier, Long timeoutMs)
Get sleep recording status. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT addresstimeoutMs- maximum time in milliseconds to wait for the status.- Returns:
PolarSleepRecordingStatus. PolarSleepRecordingStatus.UNKNOWN means the device did not report the state.
-
observeSleepRecordingStatus
abstract Flow<Array<PolarSleepRecordingStatus>> observeSleepRecordingStatus(String identifier)
Observe sleep recording status. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT address- Returns:
Flow of PolarSleepRecordingStatus batches. PolarSleepRecordingStatus.UNKNOWN means the device did not report the state.
-
stopSleepRecording
abstract Unit stopSleepRecording(String identifier)
Stop sleep recording. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT address
-
getSleep
abstract List<PolarSleepData> getSleep(String identifier, LocalDate fromDate, LocalDate toDate)
Get sleep stages and duration for a given period. Requires feature PolarBleApi.PolarBleSdkFeature.FEATURE_POLAR_SLEEP_DATA
- Parameters:
identifier- The Polar device ID or BT address.fromDate- The starting date of the period to retrieve sleep data from.toDate- The ending date of the period to retrieve sleep data from.- Returns:
list of PolarSleepData representing the sleep data for the specified period.
-
-
-
-