Interface PolarOnlineStreamingApi
-
- All Implemented Interfaces:
public interface PolarOnlineStreamingApi
Online steaming API.
Online streaming makes it possible to stream live online data from Polar device.
Requires features FEATURE_POLAR_ONLINE_STREAMING
Note, online streaming is supported by VeritySense, H10 and OH1 devices
-
-
Method Summary
Modifier and Type Method Description abstract Single<Set<PolarBleApi.PolarDeviceDataType>>
getAvailableOnlineStreamDataTypes(String identifier)
Get the data types available in this device for online streaming abstract Single<PolarSensorSetting>
requestStreamSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)
Request the online stream settings available in current operation mode. abstract Single<PolarSensorSetting>
requestFullStreamSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)
Request the settings available in the device. abstract Flowable<PolarHrData>
startHrStreaming(String identifier)
Start heart rate stream. abstract Completable
stopHrStreaming(String identifier)
Stops heart rate stream. abstract Flowable<PolarEcgData>
startEcgStreaming(String identifier, PolarSensorSetting sensorSetting)
Start the ECG (Electrocardiography) stream. abstract Flowable<PolarAccelerometerData>
startAccStreaming(String identifier, PolarSensorSetting sensorSetting)
Start ACC (Accelerometer) stream. abstract Flowable<PolarPpgData>
startPpgStreaming(String identifier, PolarSensorSetting sensorSetting)
Start optical sensor PPG (Photoplethysmography) stream. abstract Flowable<PolarPpiData>
startPpiStreaming(String identifier)
Start PPI (Pulse to Pulse interval) stream. abstract Flowable<PolarMagnetometerData>
startMagnetometerStreaming(String identifier, PolarSensorSetting sensorSetting)
Start magnetometer stream. abstract Flowable<PolarGyroData>
startGyroStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Gyro stream. abstract Flowable<PolarPressureData>
startPressureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Pressure data stream. abstract Flowable<PolarLocationData>
startLocationStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Location data stream. abstract Flowable<PolarTemperatureData>
startTemperatureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Temperature data stream. abstract Flowable<PolarTemperatureData>
startSkinTemperatureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Skin Temperature data stream. abstract Unit
)>stopStreaming(String identifier, <Error class: unknown class> type)
-
-
Method Detail
-
getAvailableOnlineStreamDataTypes
abstract Single<Set<PolarBleApi.PolarDeviceDataType>> getAvailableOnlineStreamDataTypes(String identifier)
Get the data types available in this device for online streaming
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt address- Returns:
Single Produces: <BR></BR> - onSuccess the set of available online streaming data types in this device <BR></BR> - onError status request failed
-
requestStreamSettings
abstract Single<PolarSensorSetting> requestStreamSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)
Request the online stream settings available in current operation mode. This request shall be used before the stream is started to decide currently available settings. The available settings depend on the state of the device. For example, if any stream(s) or optical heart rate measurement is already enabled, then the device may limit the offer of possible settings for other stream feature.
- Parameters:
identifier
- polar device id or bt addressfeature
- the stream feature of interest- Returns:
Single stream
-
requestFullStreamSettings
abstract Single<PolarSensorSetting> requestFullStreamSettings(String identifier, PolarBleApi.PolarDeviceDataType feature)
Request the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.
Note, This request is supported only by Polar Verity Sense (starting from firmware 1.1.5)
- Parameters:
identifier
- polar device id or bt addressfeature
- the stream feature of interest- Returns:
Single stream
-
startHrStreaming
abstract Flowable<PolarHrData> startHrStreaming(String identifier)
Start heart rate stream. Heart rate stream is stopped if the connection is closed, error occurs or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt address- Returns:
Flowable stream of heart rate data. Produces: <BR></BR> - onNext PolarHrData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
stopHrStreaming
abstract Completable stopHrStreaming(String identifier)
Stops heart rate stream.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt address- Returns:
Completable Returns complete upon successful heart rate measurement stopping or an error
-
startEcgStreaming
abstract Flowable<PolarEcgData> startEcgStreaming(String identifier, PolarSensorSetting sensorSetting)
Start the ECG (Electrocardiography) stream. ECG stream is stopped if the connection is closed, error occurs or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of PolarEcgData Produces: <BR></BR> - onNext PolarEcgData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless stream is further configured
-
startAccStreaming
abstract Flowable<PolarAccelerometerData> startAccStreaming(String identifier, PolarSensorSetting sensorSetting)
Start ACC (Accelerometer) stream. ACC stream is stopped if the connection is closed, error occurs or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of PolarAccelerometerData Produces: <BR></BR> - onNext PolarAccelerometerData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless stream is further configured
-
startPpgStreaming
abstract Flowable<PolarPpgData> startPpgStreaming(String identifier, PolarSensorSetting sensorSetting)
Start optical sensor PPG (Photoplethysmography) stream. PPG stream is stopped if the connection is closed, error occurs or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of OHR PPG data. Produces: <BR></BR> - onNext PolarPpgData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startPpiStreaming
abstract Flowable<PolarPpiData> startPpiStreaming(String identifier)
Start PPI (Pulse to Pulse interval) stream. PPI stream is stopped if the connection is closed, error occurs or stream is disposed. Notice that there is a delay before PPI data stream starts.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt address- Returns:
Flowable stream of OHR PPI data. Produces: <BR></BR> - onNext PolarPpiData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startMagnetometerStreaming
abstract Flowable<PolarMagnetometerData> startMagnetometerStreaming(String identifier, PolarSensorSetting sensorSetting)
Start magnetometer stream. Magnetometer stream is stopped if the connection is closed, error occurs or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of magnetometer data. Produces: <BR></BR> - onNext PolarMagnetometerData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startGyroStreaming
abstract Flowable<PolarGyroData> startGyroStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Gyro stream. Gyro stream is stopped if the connection is closed, error occurs during start or stream is disposed.
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of gyroscope data. Produces: <BR></BR> - onNext PolarGyroData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startPressureStreaming
abstract Flowable<PolarPressureData> startPressureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Pressure data stream. Pressure data stream is stopped if the connection is closed, error occurs during start or stream is disposed. Requires feature .FEATURE_POLAR_ONLINE_STREAMING. Before starting the stream it is recommended to query the available settings using .requestStreamSettings
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of barometer data. Produces: <BR></BR> - onNext PolarPressureData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startLocationStreaming
abstract Flowable<PolarLocationData> startLocationStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Location data stream. Location stream is stopped if the connection is closed, error occurs during start or stream is disposed. Requires feature .FEATURE_POLAR_ONLINE_STREAMING. Before starting the stream it is recommended to query the available settings using .requestStreamSettings
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of location data. Produces: <BR></BR> - onNext PolarLocationData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startTemperatureStreaming
abstract Flowable<PolarTemperatureData> startTemperatureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Temperature data stream. Temperature stream is stopped if the connection is closed, error occurs during start or stream is disposed. Requires feature .FEATURE_POLAR_ONLINE_STREAMING. Before starting the stream it is recommended to query the available settings using .requestStreamSettings
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of temperature data. Produces: <BR></BR> - onNext PolarTemperatureData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
startSkinTemperatureStreaming
abstract Flowable<PolarTemperatureData> startSkinTemperatureStreaming(String identifier, PolarSensorSetting sensorSetting)
Start Skin Temperature data stream. SkinTemperature stream is stopped if the connection is closed, error occurs during start or stream is disposed. Requires feature .FEATURE_POLAR_ONLINE_STREAMING. Before starting the stream it is recommended to query the available settings using .requestStreamSettings
- Parameters:
identifier
- Polar device id found printed on the sensor/device or bt addresssensorSetting
- settings to be used to start streaming- Returns:
Flowable stream of temperature data. Produces: <BR></BR> - onNext PolarTemperatureData <BR></BR> - onError error for possible errors invoked <BR></BR> - onComplete non produced unless the stream is further configured
-
stopStreaming
abstract Unit )>stopStreaming(String identifier, <Error class: unknown class> type)
-
-
-
-