Interface PolarBleTelemetryApi
-
- All Implemented Interfaces:
public interface PolarBleTelemetryApiPolar Telemetry API for streaming telemetry data from devices. Requires feature FEATURE_TELEMETRY
-
-
Method Summary
Modifier and Type Method Description abstract DeviceTelemetryConfigurationgetDeviceTelemetryConfiguration(String identifier, PolarDeviceTelemetryType telemetryType)abstract Flow<DeviceTelemetryEvent>startTelemetry(String identifier, PolarDeviceTelemetryType telemetryType)NOTE: this is an experimental API intended for Polar internal use only. abstract BooleanstopTelemetry(String identifier, PolarDeviceTelemetryType telemetryType)NOTE: this is an experimental API intended for Polar internal use only. abstract DeviceTelemetrySupportgetAvailableTelemetryTypes(String identifier)NOTE: this is an experimental API intended for Polar internal use only. -
-
Method Detail
-
getDeviceTelemetryConfiguration
abstract DeviceTelemetryConfiguration getDeviceTelemetryConfiguration(String identifier, PolarDeviceTelemetryType telemetryType)
-
startTelemetry
abstract Flow<DeviceTelemetryEvent> startTelemetry(String identifier, PolarDeviceTelemetryType telemetryType)
NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API. Start telemetry data stream from the device. Stream emits
DeviceTelemetryEventas soon as telemetry data arrives from device.- Parameters:
identifier- : Polar device ID or BT address.- Returns:
Flow of that emits one
DeviceTelemetryEventper received telemetry data item from device.
-
stopTelemetry
abstract Boolean stopTelemetry(String identifier, PolarDeviceTelemetryType telemetryType)
NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API. Stop receiving telemetry data from the device.
- Parameters:
identifier- : Polar device ID or BT address.- Returns:
true if the device supports telemetry data streaming and the streaming was stopped successfully, false otherwise.
-
getAvailableTelemetryTypes
abstract DeviceTelemetrySupport getAvailableTelemetryTypes(String identifier)
NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API. Stop receiving telemetry data from the device.
Returns all telemetry types supported by this SDK for the given device.
- Parameters:
identifier- : Polar device ID or BT address.- Returns:
DeviceTelemetrySupport containing a list of PolarDeviceTelemetryType that are available for the given device. DeviceTelemetrySupport is empty container if the device does not support any telemetry types or if there was an error during reading telemetry configuration.
-
-
-
-