### startExercise

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarTrainingSessionApi.html

Start an exercise session on the device.

```APIDOC
## startExercise

### Description
Start an exercise session on the device.

### Method
Asynchronous

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
None

#### Response Example
None

### Throws
See `[PolarErrors](../Enums/PolarErrors.html)` for possible errors invoked.
```

--------------------------------

### CocoaPods Installation Command

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/sources/iOS/ios-communications/README.md

After updating your Podfile, run this command to install or update the CocoaPods dependencies.

```bash
$ pod install
```

--------------------------------

### getStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarActivitySamplesData.html

Retrieves the start time of the activity samples.

```APIDOC
## getStartTime

### Description
Returns the `LocalDateTime` representing the start time of this activity sample data.

### Returns
*   `LocalDateTime` - The start time of the samples.
```

--------------------------------

### getStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarActivitySamplesData.html

Retrieves the start time of the activity samples.

```APIDOC
## getStartTime

### Description
Retrieves the start time of the activity samples.

### Returns
*   **LocalDateTime** - The start time.
```

--------------------------------

### monitorPPNotifications

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/index-files/index-13.html

start raw pp monitoring

```APIDOC
## monitorPPNotifications(java.lang.Boolean)

### Description
start raw pp monitoring

### Method
N/A (SDK method)

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
N/A

#### Response Example
N/A
```

--------------------------------

### setStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarActivitySamplesData.html

Sets the start time for the activity samples.

```APIDOC
## setStartTime

### Description
Sets the start time for the activity samples.

### Parameters
*   **startTime** (LocalDateTime) - The start time to set.
```

--------------------------------

### setStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarActivitySamplesData.html

Sets the start time for the activity samples.

```APIDOC
## setStartTime

### Description
Sets the start time for this activity sample data.

### Parameters
*   **startTime** (`LocalDateTime`) - The new start time to set.
```

--------------------------------

### Offline Exercise Start Result: Success

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Enums/OfflineExerciseStartResultType.html

Represents a successful start of an offline exercise session.

```swift
case success
```

--------------------------------

### isFtuDone

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarBleApi.html

Checks if the First Time Use setup has been completed for the specified device.

```APIDOC
## isFtuDone

### Description
Check if the First Time Use has been done for the given device.

### Parameters
#### Path Parameters
- **identifier** (String) - Description of the device identifier

### Method
[Method Signature]
```kotlin
abstract fun isFtuDone(identifier: String): Boolean
```
```

--------------------------------

### Start Offline Exercise V2

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOfflineExerciseV2Api.html

Initiates an offline exercise session on the device. The result indicates the success or failure of starting the exercise.

```swift
func startOfflineExerciseV2(identifier: String) async throws -> OfflineExerciseStartResult
```

--------------------------------

### getStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarPpiDataSample.html

Retrieves the start time of the PPI data sample session.

```APIDOC
## getStartTime

### Description
Retrieves the start time of the sample session.

### Method
GET

### Endpoint
PolarPpiDataSample.getStartTime()

### Returns
*   **LocalTime** - The start time of the sample session.
```

--------------------------------

### Offline Exercise Start Result: SDK Mode

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Enums/OfflineExerciseStartResultType.html

Indicates that the device is currently in SDK mode and cannot start an exercise.

```swift
case sdkMode
```

--------------------------------

### startTemperatureStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Temperature data stream. Requires FEATURE_POLAR_ONLINE_STREAMING. It is recommended to query available settings using requestStreamSettings before starting.

```APIDOC
## startTemperatureStreaming

### Description
Start Temperature data stream. Temperature stream is stopped if the connection is closed, error occurs during start or flow collection is cancelled. Requires feature [FEATURE_POLAR_ONLINE_STREAMING](PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_ONLINE_STREAMING). Before starting the stream it is recommended to query the available settings using [requestStreamSettings](PolarOnlineStreamingApi.html#requestStreamSettings(java.lang.String,com.polar.sdk.api.PolarBleApi.PolarDeviceDataType)).

### Method
abstract Flow<[PolarTemperatureData](model/PolarTemperatureData.html)> [startTemperatureStreaming](PolarOnlineStreamingApi.html#startTemperatureStreaming(java.lang.String,com.polar.sdk.api.model.PolarSensorSetting))

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** ([PolarSensorSetting](model/PolarSensorSetting.html)) - Required - settings to be used to start streaming

### Returns
Flow of [PolarTemperatureData](model/PolarTemperatureData.html)
```

--------------------------------

### startExercise

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarTrainingSessionApi.html

Start an exercise session on the device. Requires FEATURE_POLAR_TRAINING_DATA.

```APIDOC
## startExercise

### Description
Start an exercise session on the device.

### Method
abstract

### Parameters
#### Path Parameters
- **identifier** (String) - Description not available
- **profile** (PolarExerciseSession.SportProfile) - Description not available

### Return Type
Unit
```

--------------------------------

### startMeasurement

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/pmd/BlePMDClient.html

Start a measurement of the given type with specified settings.

```APIDOC
## startMeasurement

### Description
Start measurement of the given type.

### Parameters
* `type` (PmdMeasurementType) - The type of measurement to start.
* `setting` (PmdSetting) - The settings for the measurement.
* `recordingType` (PmdRecordingType) - The type of recording.
* `secret` (PmdSecret) - The secret required to start the measurement.

### Returns
Unknown class 'Error' on error.
```

--------------------------------

### System Start Trigger Mode

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingTriggerMode.html

Represents the mode where offline recording is triggered by the system start event. This is useful for automatic recording upon device power-on.

```swift
case triggerSystemStart
```

--------------------------------

### getStartTime

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/PolarOfflineRecordingData.html

Retrieves the time when the recording was started in UTC.

```APIDOC
## getStartTime

### Description
Retrieves the time when the recording was started in UTC.

### Method
N/A (This is a getter method)

### Endpoint
N/A

### Parameters
None

### Response
#### Success Response
- **startTime** (LocalDateTime) - The time recording was started in UTC time.
```

--------------------------------

### PolarFirstTimeUseConfig.init

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Structs/PolarFirstTimeUseConfig.html

Initializes a PolarFirstTimeUseConfig object with all the necessary parameters for first-time device setup.

```APIDOC
## init

### Description
Initializes a PolarFirstTimeUseConfig object with all the necessary parameters for first-time device setup.

### Parameters
- **gender** (Gender) - The gender of the user.
- **birthDate** (Date) - The birth date of the user.
- **height** (Float) - The height of the user in centimeters.
- **weight** (Float) - The weight of the user in kilograms.
- **maxHeartRate** (Int) - The maximum heart rate of the user.
- **vo2Max** (Int) - The VO2 Max value of the user.
- **restingHeartRate** (Int) - The resting heart rate of the user.
- **trainingBackground** (TrainingBackground) - The training background of the user.
- **deviceTime** (String) - The current time on the device.
- **typicalDay** (TypicalDay) - The user's typical day activities.
- **sleepGoalMinutes** (Int) - The user's sleep goal in minutes.
```

--------------------------------

### Step Samples

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/PolarActivitySamplesData.html

Methods to get and set step samples.

```APIDOC
## getStepSamples

### Description
Retrieves the list of step samples.

### Method
`getStepSamples()`

### Returns
List<Integer> - A list of step sample values.
```

```APIDOC
## setStepSamples

### Description
Sets the list of step samples.

### Method
`setStepSamples(List<Integer> stepSamples)`

### Parameters
*   **stepSamples** (List<Integer>) - The list of step sample values to set.
```

--------------------------------

### startPpiStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOnlineStreamingApi.html

Starts the PPI (Pulse to Pulse interval) stream for a given device identifier. The stream stops if the connection closes, an error occurs, or the stream is disposed. Note that there is a delay before the PPI data stream starts.

```APIDOC
## startPpiStreaming(_:)

### Description
Starts the PPI (Pulse to Pulse interval) stream for a given device identifier. The stream stops if the connection closes, an error occurs, or the stream is disposed. Note that there is a delay before the PPI data stream starts.

### Method
Swift

### Endpoint
AsyncThrowingStream<PolarPpiData, Error>

### Parameters
#### Path Parameters
* **identifier** (String) - Required - Polar device id or device address

### Return Value
* onNext: for every air packet received. see `[PolarPpiData](../Typealiases.html#/s:11PolarBleSdk0A7PpiDataa)`
* onError: see `[PolarErrors](../Enums/PolarErrors.html)` for possible errors invoked
```

--------------------------------

### authenticate

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/BleDeviceSession.html

Starts the pairing and optionally bonding procedure with the device.

```APIDOC
## authenticate

### Description
Starts the pairing and optionally bonding procedure with the device.

### Method
POST (Implied)

### Endpoint
N/A (SDK Method)

### Returns
- **Deferred<List<UUID>>** - A deferred object that resolves to a list of UUIDs upon completion.
```

--------------------------------

### SampleType

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Enums.html

Sample types for H10 recording start.

```APIDOC
## Enum: SampleType

### Description
Sample types for H10 recording start.

### Declaration
```swift
public enum SampleType : Int
```
```

--------------------------------

### init(client:)

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Classes/PolarBackupManager.html

Initializes the PolarBackupManager with a BlePsFtpClient.

```APIDOC
## init(client:)

### Description
Initializes the PolarBackupManager with a BlePsFtpClient.

### Declaration
Swift

```swift
public init(client: BlePsFtpClient)
```
```

--------------------------------

### Get Offline Recording Trigger Setup

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOfflineRecordingApi.html

Retrieves the current offline recording trigger setup from a Polar device. Requires the PolarBleSdkFeature.feature_polar_offline_recording feature. This function can throw PolarErrors.

```swift
func getOfflineRecordingTriggerSetup(_ identifier: String) async throws -> PolarOfflineRecordingTrigger
```

--------------------------------

### startRecording

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/index-files/index-19.html

Requests to start recording data. This function is part of the PolarH10OfflineExerciseApi.

```APIDOC
## startRecording(java.lang.String, java.lang.String, com.polar.sdk.api.PolarH10OfflineExerciseApi.RecordingInterval, com.polar.sdk.api.PolarH10OfflineExerciseApi.SampleType)

### Description
Requests to start recording data. This function is part of the PolarH10OfflineExerciseApi.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
* **deviceId** (String) - Description not available in source.
* **transactionId** (String) - Description not available in source.
* **recordingInterval** (com.polar.sdk.api.PolarH10OfflineExerciseApi.RecordingInterval) - Description not available in source.
* **sampleType** (com.polar.sdk.api.PolarH10OfflineExerciseApi.SampleType) - Description not available in source.

### Request Example
Not available in source.

### Response
Success Response: Description not available in source.

### Response Example
Not available in source.
```

--------------------------------

### Get Offline Recording Trigger Setup

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOfflineRecordingApi.html

Retrieves the current configuration for offline recording triggers set on the Polar device. This operation requires the FEATURE_POLAR_OFFLINE_RECORDING SDK feature.

```APIDOC
## getOfflineRecordingTriggerSetup

### Description
Retrieves the current offline recording trigger setup from the Polar device. Requires the `FEATURE_POLAR_OFFLINE_RECORDING` SDK feature.

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device ID.

### Returns
- **PolarOfflineRecordingTrigger** - The current trigger setup.
```

--------------------------------

### startSDKMode

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/pmd/BlePMDClient.html

Requests the device to start SDK mode. This is a prerequisite for certain measurement functionalities.

```APIDOC
## startSDKMode

### Description
Request to start SDK mode.

### Method
(Implicitly a method call in the SDK)

### Parameters
None
```

--------------------------------

### Offline Recording Operations (Async Throws)

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/documentation/MigrationGuide8.0.0-iOS.md

Wrap offline recording operations like get, start, stop, remove, and settings requests in a Task or call from an async context.

```swift
let data = try await api.getOfflineRecord("deviceId", entry: entry, secret: nil)
try await api.startOfflineRecording("deviceId", feature: .acc, settings: settings, secret: nil)
```

--------------------------------

### getStartTime()

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/activity/Polar247HrSamples.html

Retrieves the start time of the 24/7 heart rate samples.

```APIDOC
## getStartTime()

### Description
Returns the start time of the heart rate samples.

### Returns
*   (LocalTime) - The start time.
```

--------------------------------

### initialize

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/polar/BlePolarDeviceCapabilitiesUtility.html

Initializes the device capabilities configuration. This method should be called once before querying any device capabilities.

```APIDOC
## initialize

### Description
Initializes the device capabilities configuration. This method should be called once before querying any device capabilities.

### Method
static

### Parameters
#### Path Parameters
- **context** (Context) - Required - The Android context to use for initialization.

### Response
#### Success Response
- **Unit** - Indicates successful initialization.
```

--------------------------------

### FirmwareUpdateStatus.PreparingDeviceForFwUpdate Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/FirmwareUpdateStatus.PreparingDeviceForFwUpdate.html

Initializes a new instance of the FirmwareUpdateStatus.PreparingDeviceForFwUpdate class with optional details.

```APIDOC
## FirmwareUpdateStatus.PreparingDeviceForFwUpdate(String details)

### Description
Constructs a new FirmwareUpdateStatus.PreparingDeviceForFwUpdate object.

### Parameters
#### Path Parameters
- **details** (String) - Required - Extra details about the preparation state, if any.
```

--------------------------------

### Offline Exercise Start Result: Other

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Enums/OfflineExerciseStartResultType.html

Represents any other unspecified outcome when attempting to start an offline exercise.

```swift
case other
```

--------------------------------

### Implement PolarBleApiObserver Protocols

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/README.md

Set up a class to observe device events and implement the required PolarBleApi protocols. Initialize the PolarBleApiDefaultImpl with desired features and set up observers. Ensure to replace the placeholder device ID with your actual device ID.

```swift
class MyController: UIViewController,
                    PolarBleApiObserver,
                    PolarBleApiPowerStateObserver,
                    PolarBleApiDeviceInfoObserver,
                    PolarBleApiDeviceFeaturesObserver {
    // NOTICE only FEATURE_HR is enabled, to enable more features add them to the Set
    // e.g. [.feature_hr, .feature_battery_info]
    var api = PolarBleApiDefaultImpl.polarImplementation(DispatchQueue.main, 
                                                          features: [.feature_hr])
    let disposeBag = DisposeBag()
    var deviceId = "0A3BA92B" // TODO replace this with your device id

    override func viewDidLoad() {
        super.viewDidLoad()
        api.observer = self
        api.powerStateObserver = self
        api.deviceFeaturesObserver = self
        api.deviceInfoObserver = self
    }

    func deviceConnecting(_ polarDeviceInfo: PolarDeviceInfo) {
        print("DEVICE CONNECTING: \(polarDeviceInfo)")
    }
    
    func deviceConnected(_ polarDeviceInfo: PolarDeviceInfo) {
        print("DEVICE CONNECTED: \(polarDeviceInfo)")
    }
    
    func deviceDisconnected(_ polarDeviceInfo: PolarDeviceInfo, pairingError: Bool) {
        print("DISCONNECTED: \(polarDeviceInfo)")
    }
    
    func batteryLevelReceived(_ identifier: String, batteryLevel: UInt) {
        print("battery level updated: \(batteryLevel)")
    }
    
    func disInformationReceived(_ identifier: String, uuid: CBUUID, value: String) {
        print("dis info: \(uuid.uuidString) value: \(value)")
    }
    
    func bleSdkFeatureReady(_ identifier: String, feature: PolarBleSdkFeature) {
        print("Feature \(feature) is ready.")
        if feature == .feature_hr {
            // Start HR streaming when feature is ready
            api.startHrStreaming(identifier)
                .observe(on: MainScheduler.instance)
                .subscribe(onNext: { hrData in
                    for sample in hrData.samples {
                        print("HR: \(sample.hr) rrsMs: \(sample.rrsMs)")
                    }
                })
                .disposed(by: disposeBag)
        }
    }
    
    func blePowerOn() {
        print("BLE ON")
    }
    
    func blePowerOff() {
        print("BLE OFF")
    }
        
}
```

--------------------------------

### Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/psftp/BlePsFtpClient.html

Initializes a new instance of the BlePsFtpClient.

```APIDOC
## BlePsFtpClient

### Description
Initializes a new instance of the BlePsFtpClient.

### Parameters
* **txInterface** ([BleGattTxInterface](../../BleGattTxInterface.html)) - The interface for transmitting data over BLE.
```

--------------------------------

### startOfflineRecording

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOfflineRecordingApi.html

Starts an offline recording session on the Polar device.

```APIDOC
## startOfflineRecording(identifier: String, feature: PolarBleApi.PolarDeviceDataType, settings: PolarSensorSetting, secret: PolarRecordingSecret)

### Description
Start offline recording.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **identifier** (String) - Description: Device identifier.
- **feature** (PolarBleApi.PolarDeviceDataType) - Description: The feature to record.
- **settings** (PolarSensorSetting) - Description: The sensor settings for the recording.
- **secret** (PolarRecordingSecret) - Description: The secret required to start the recording.
```

--------------------------------

### OfflineExerciseStartResult Class

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/package-summary.html

Result of starting an offline exercise. Contains details about the outcome of an offline exercise start attempt.

```APIDOC
## Class OfflineExerciseStartResult

### Description
Result of starting an offline exercise.

### Usage
This class provides information about whether starting an offline exercise was successful and any associated details.
```

--------------------------------

### StartResult Enum

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/package-summary.html

Possible results of starting an offline exercise. An enumeration of possible outcomes when starting an offline exercise.

```APIDOC
## Enum StartResult

### Description
Possible results of starting an offline exercise.

### Usage
This enum represents the different outcomes that can occur when attempting to start an offline exercise.
```

--------------------------------

### FirmwareUpdateStatus.WritingFwUpdatePackage Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/FirmwareUpdateStatus.WritingFwUpdatePackage.html

Initializes a new instance of the FirmwareUpdateStatus.WritingFwUpdatePackage class with optional details.

```APIDOC
## FirmwareUpdateStatus.WritingFwUpdatePackage(String details)

### Description
Initializes a new instance of the FirmwareUpdateStatus.WritingFwUpdatePackage class.

### Parameters
* **details** (String) - Required - Extra details about the firmware update package writing process.
```

--------------------------------

### startLocationStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Location data stream. Requires FEATURE_POLAR_ONLINE_STREAMING. It is recommended to query available settings using requestStreamSettings before starting.

```APIDOC
## startLocationStreaming

### Description
Starts the Location data stream. Location stream is stopped if the connection is closed, error occurs during start or flow collection is cancelled. Requires feature [FEATURE_POLAR_ONLINE_STREAMING](PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_ONLINE_STREAMING). Before starting the stream it is recommended to query the available settings using [requestStreamSettings](PolarOnlineStreamingApi.html#requestStreamSettings(java.lang.String,com.polar.sdk.api.PolarBleApi.PolarDeviceDataType)).

### Method
abstract Flow<[PolarLocationData](model/PolarLocationData.html)> [startLocationStreaming](PolarOnlineStreamingApi.html#startLocationStreaming(java.lang.String,com.polar.sdk.api.model.PolarSensorSetting))

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** ([PolarSensorSetting](model/PolarSensorSetting.html)) - Required - settings to be used to start streaming

### Returns
Flow of [PolarLocationData](model/PolarLocationData.html)
```

--------------------------------

### startPressureStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Pressure data stream. Requires FEATURE_POLAR_ONLINE_STREAMING. It is recommended to query available settings using requestStreamSettings before starting.

```APIDOC
## startPressureStreaming

### Description
Starts the Pressure data stream. Pressure data stream is stopped if the connection is closed, error occurs during start or flow collection is cancelled. Requires feature [FEATURE_POLAR_ONLINE_STREAMING](PolarBleApi.PolarBleSdkFeature.html#FEATURE_POLAR_ONLINE_STREAMING). Before starting the stream it is recommended to query the available settings using [requestStreamSettings](PolarOnlineStreamingApi.html#requestStreamSettings(java.lang.String,com.polar.sdk.api.PolarBleApi.PolarDeviceDataType)).

### Method
abstract Flow<[PolarPressureData](model/PolarPressureData.html)> [startPressureStreaming](PolarOnlineStreamingApi.html#startPressureStreaming(java.lang.String,com.polar.sdk.api.model.PolarSensorSetting))

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** ([PolarSensorSetting](model/PolarSensorSetting.html)) - Required - settings to be used to start streaming

### Returns
Flow of [PolarPressureData](model/PolarPressureData.html)
```

--------------------------------

### FetchingFwUpdatePackage Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/FirmwareUpdateStatus.FetchingFwUpdatePackage.html

Constructs a new FetchingFwUpdatePackage with provided details.

```APIDOC
## FirmwareUpdateStatus.FetchingFwUpdatePackage(String details)

### Description
Constructs a new instance of the FetchingFwUpdatePackage class.

### Parameters
* **details** (String) - Required - Extra details about the fetching process.
```

--------------------------------

### startGyroStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Gyroscope data stream. The stream is stopped if the connection is closed, an error occurs during start, or flow collection is cancelled.

```APIDOC
## startGyroStreaming

### Description
Starts the Gyroscope data stream. The stream is stopped if the connection is closed, an error occurs during start, or flow collection is cancelled.

### Method
abstract Flow<[PolarGyroData](model/PolarGyroData.html)> [startGyroStreaming](PolarOnlineStreamingApi.html#startGyroStreaming(java.lang.String,com.polar.sdk.api.model.PolarSensorSetting))

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** ([PolarSensorSetting](model/PolarSensorSetting.html)) - Required - settings to be used to start streaming

### Returns
Flow of [PolarGyroData](model/PolarGyroData.html)
```

--------------------------------

### startMagnetometerStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Magnetometer data stream. The stream is stopped if the connection is closed, an error occurs during start, or flow collection is cancelled.

```APIDOC
## startMagnetometerStreaming

### Description
Starts the Magnetometer data stream. The stream is stopped if the connection is closed, an error occurs during start, or flow collection is cancelled.

### Method
abstract Flow<[PolarMagnetometerData](model/PolarMagnetometerData.html)> [startMagnetometerStreaming](PolarOnlineStreamingApi.html#startMagnetometerStreaming(java.lang.String,com.polar.sdk.api.model.PolarSensorSetting))

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** ([PolarSensorSetting](model/PolarSensorSetting.html)) - Required - settings to be used to start streaming

### Returns
Flow of [PolarMagnetometerData](model/PolarMagnetometerData.html)
```

--------------------------------

### LedConfig Initializer

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Structs/LedConfig.html

Initializes a new LedConfig instance. This initializer is currently undocumented.

```APIDOC
## init(sdkModeLedEnabled:ppiModeLedEnabled:)

### Description
Initializes a new LedConfig instance. This initializer is currently undocumented.

### Parameters
#### Path Parameters
* **sdkModeLedEnabled** (Bool) - Description not available.
* **ppiModeLedEnabled** (Bool) - Description not available.

### Declaration
```swift
public init(sdkModeLedEnabled: Bool, ppiModeLedEnabled: Bool)
```
```

--------------------------------

### Exercise Start Trigger Mode

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Enums/PolarOfflineRecordingTriggerMode.html

Represents the mode where offline recording is triggered by the start of an exercise. This is ideal for capturing data during physical activities.

```swift
case triggerExerciseStart
```

--------------------------------

### CocoaPods Installation for iOS Communications

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/sources/iOS/ios-communications/README.md

Use this snippet to add the iOS Communications library to your project via CocoaPods. Ensure you have CocoaPods installed and configured.

```ruby
source 'https://github.com/CocoaPods/Specs.git'

use_frameworks!

target 'YOUR_TARGET_NAME' do
    pod 'iOSCommunications', '~> 14.1.6'
end
```

--------------------------------

### BleGapClient Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/BleGapClient.html

Initializes a new instance of the BleGapClient class.

```APIDOC
## BleGapClient Constructor

### Description
Initializes a new instance of the BleGapClient class.

### Parameters
* **txInterface** (BleGattTxInterface) - The interface for transmitting data over GATT.
```

--------------------------------

### Unable to Start Streaming Error

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Enums/PolarErrors.html

Signifies that the SDK failed to initiate a data streaming session. Use this when encountering issues starting sensor data streams.

```swift
case unableToStartStreaming
```

--------------------------------

### searchForDevice with filter

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarBleApi.html

Starts searching for BLE devices with a specific name prefix filter. This allows you to narrow down the search to devices with names starting with the provided string.

```APIDOC
## searchForDevice

### Description
Starts searching for BLE devices when subscribed, filtering by a device name prefix. The search continues as long as the observable is subscribed or an error occurs. Each found device is emitted only once. By default, it searches only for Polar devices, but this behavior can be controlled using `.setPolarFilter`. If `.setPolarFilter` is set to false, it searches for any BLE heart rate capable devices.

### Method
`Flow<PolarDeviceInfo> searchForDevice(String withDeviceNameFilterPrefix)`

### Parameters
#### Path Parameters
* **withDeviceNameFilterPrefix** (String) - Optional - Filters returned devices based on the given device name prefix string. Defaults to "Polar".
```

--------------------------------

### clientsReady

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/BleDeviceSession.html

Helper to combine all available/desired clients ready. Optionally checks connection status.

```APIDOC
## clientsReady

### Description
Helper to combine all available/desired clients ready. Optionally checks connection status.

### Method
GET (Implied)

### Endpoint
N/A (SDK Method)

### Parameters
#### Query Parameters
- **checkConnection** (Boolean) - Optional - Whether to check the connection status.
```

--------------------------------

### Start Offline Recording

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOfflineRecordingApi.html

Starts an offline recording for a specified feature on the device. Optional settings and encryption secrets can be provided. This function is asynchronous and may throw errors.

```swift
func startOfflineRecording(_ identifier: String, feature: PolarDeviceDataType, settings: PolarSensorSetting?, secret: PolarRecordingSecret?) async throws
```

--------------------------------

### startPpiStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the PPI (Pulse to Pulse interval) stream for a given device identifier.

```APIDOC
## startPpiStreaming

### Description
Starts the PPI (Pulse to Pulse interval) stream.

### Method Signature
`startPpiStreaming(identifier: String)`

### Parameters
*   **identifier** (String) - The unique identifier for the device.
```

--------------------------------

### search

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/BleDeviceListener.html

Starts a BLE scan to detect nearby devices. It can optionally fetch known devices. Produces notifications when advertisements are detected or propagates an error if the scan fails to start.

```APIDOC
## search(fetchKnownDevices: Boolean)

### Description
Starts a BLE scan to detect nearby devices. It can optionally fetch known devices. Produces notifications when advertisements are detected or propagates an error if the scan fails to start.

### Parameters
#### Query Parameters
- **fetchKnownDevices** (Boolean) - Optional - If true, the scan will also attempt to fetch known devices.

### Produces
- **onNext**: When a advertisement has been detected.
- **onError**: If scan start fails, propagates `BleStartScanError` with an error code.
- **onCompleted**: Not produced.
```

--------------------------------

### startMeasurement

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/pmd/BlePMDClient.html

Starts a PMD measurement of the specified type with the given settings and secret.

```APIDOC
## startMeasurement

### Description
Starts a PMD measurement of the specified type with the given settings and secret.

### Method
N/A (Method signature provided)

### Endpoint
N/A (SDK method)

### Parameters
#### Path Parameters
- **type** (`PmdMeasurementType`) - Description: The type of PMD measurement to start.
- **setting** (`PmdSetting`) - Description: The settings for the measurement.
- **recordingType** (`PmdRecordingType`) - Description: The type of recording for the measurement.
- **secret** (`PmdSecret`) - Description: The secret required to start the measurement.
```

--------------------------------

### Start Exercise Session

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarTrainingSessionApi.html

Starts an exercise session on the Polar device. Requires the Polar device ID or BT address and the desired sport profile. This API requires the feature_polar_training_data SDK feature.

```swift
func startExercise(identifier: String, profile: PolarExerciseSession.SportProfile) async throws
```

--------------------------------

### PolarFirmwareVersionInfo Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/PolarFirmwareVersionInfo.html

Constructs a new PolarFirmwareVersionInfo object with the specified firmware version, device model name, and hardware code.

```APIDOC
## PolarFirmwareVersionInfo Constructor

### Description
Constructs a new PolarFirmwareVersionInfo object.

### Parameters
*   **deviceFwVersion** (String) - The firmware version of the device.
*   **deviceModelName** (String) - The model name of the device.
*   **deviceHardwareCode** (String) - The hardware code of the device.
```

--------------------------------

### OfflineExerciseStartResultType Enum Cases

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Enums/OfflineExerciseStartResultType.html

Represents the possible outcomes when attempting to start an offline exercise session on a supported Polar device. Use these cases to handle different results from the exercise start operation.

```swift
case success
```

```swift
case exerciseOngoing
```

```swift
case lowBattery
```

```swift
case sdkMode
```

```swift
case unknownSport
```

```swift
case other
```

--------------------------------

### clientReady

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/pmd/BlePMDClient.html

Indicates that the client is ready and optionally checks the connection status.

```APIDOC
## clientReady

### Description
Indicates that the client is ready and optionally checks the connection status.

### Method
(Implicitly a method call in the SDK)

### Parameters
#### Path Parameters
- **checkConnection** (Boolean) - Required - Flag to check connection status.
```

--------------------------------

### Start Heart Rate Streaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOnlineStreamingApi.html

Starts streaming heart rate data from a Polar device. The stream will stop if the connection is closed, an error occurs, or the stream is disposed. Requires the `feature_hr` SDK feature.

```swift
func startHrStreaming(_ identifier: String) -> AsyncThrowingStream<PolarHrData, Error>
```

--------------------------------

### getAdvertisementTimeStamp

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/advertisement/BleAdvertisementContent.html

Gets the timestamp of the advertisement.

```APIDOC
## getAdvertisementTimeStamp

### Description
Gets the timestamp of the advertisement.

### Method
GET

### Endpoint
/BleAdvertisementContent/getAdvertisementTimeStamp

### Returns
- **Long** - The advertisement timestamp.
```

--------------------------------

### getDetails Method

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/FirmwareUpdateStatus.PreparingDeviceForFwUpdate.html

Retrieves the details associated with the PreparingDeviceForFwUpdate status.

```APIDOC
## String getDetails()

### Description
Gets the details string for the current firmware update status.

### Returns
- **String** - The details of the preparation state.
```

--------------------------------

### PolarFirstTimeUseConfig Initialization

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Structs/PolarFirstTimeUseConfig.html

Initializes a `PolarFirstTimeUseConfig` object with detailed user and device information for first-time setup.

```APIDOC
## `init`

### Description
Initializes a `PolarFirstTimeUseConfig` object with detailed user and device information for first-time setup.

### Parameters

- **gender** (Gender) - Description of the user's gender.
- **birthDate** (Date) - The user's date of birth.
- **height** (Float) - The user's height in centimeters.
- **weight** (Float) - The user's weight in kilograms.
- **maxHeartRate** (Int) - The user's maximum heart rate.
- **vo2Max** (Int) - The user's VO2 Max value.
- **restingHeartRate** (Int) - The user's resting heart rate.
- **trainingBackground** (TrainingBackground) - The user's training background.
- **deviceTime** (String) - The current time on the device.
- **typicalDay** (TypicalDay) - Description of the user's typical day.
- **sleepGoalMinutes** (Int) - The user's desired sleep duration in minutes.
```

--------------------------------

### Start Accelerometer Streaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOnlineStreamingApi.html

Starts streaming accelerometer data from a Polar device. The stream will stop if the connection is closed, an error occurs, or the stream is disposed. Requires the `feature_polar_online_streaming` SDK feature and specific sensor settings.

```swift
func startAccStreaming(_ identifier: String, settings: PolarSensorSetting) -> AsyncThrowingStream<PolarAccData, Error>
```

--------------------------------

### PolarOfflineRecordingResult.Complete Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/PolarOfflineRecordingResult.Complete.html

Initializes a new instance of the PolarOfflineRecordingResult.Complete class with the downloaded recording data.

```APIDOC
## PolarOfflineRecordingResult.Complete Constructor

### Description
Initializes a new instance of the `PolarOfflineRecordingResult.Complete` class.

### Parameters
*   **data** (`PolarOfflineRecordingData`) - The downloaded offline recording data.
```

--------------------------------

### Start ECG Streaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Protocols/PolarOnlineStreamingApi.html

Starts streaming ECG data from a Polar device. The stream will stop if the connection is closed, an error occurs, or the stream is disposed. Requires the `feature_polar_online_streaming` SDK feature and specific sensor settings.

```swift
func startEcgStreaming(_ identifier: String, settings: PolarSensorSetting) -> AsyncThrowingStream<PolarEcgData, Error>
```

--------------------------------

### PmdSetting Constructors

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/gatt/client/pmd/PmdSetting.html

Constructors for initializing PmdSetting objects. One constructor takes a byte array representing raw data, and another takes a map of selected settings.

```APIDOC
## PmdSetting Constructors

### `PmdSetting(ByteArray data)`

Initializes a PmdSetting object from a byte array.

### `PmdSetting(Map<PmdSetting.PmdSettingType, Integer> selected)`

Initializes a PmdSetting object with a provided map of selected settings.
```

--------------------------------

### startPpiStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the PPI (Pulse to Pulse interval) stream from a Polar device. The stream is stopped automatically if the connection is closed, an error occurs, or the flow collection is cancelled. Note that there is a delay before the PPI data stream starts.

```APIDOC
## startPpiStreaming

### Description
Start PPI (Pulse to Pulse interval) stream. PPI stream is stopped if the connection is closed, error occurs or flow collection is cancelled. Notice that there is a delay before PPI data stream starts.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```kotlin
polarOnlineStreamingApi.startPpiStreaming(identifier)
```

### Response
#### Success Response
Returns a Flow of [PolarPpiData](model/PolarPpiData.html).

#### Response Example
```kotlin
// Example of collecting PPI data
launch {
    polarOnlineStreamingApi.startPpiStreaming(identifier).collect { ppiData ->
        // Process ppiData
    }
}
```
```

--------------------------------

### PolarDeviceRestApiServiceDescription Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/restapi/PolarDeviceRestApiServiceDescription.html

Initializes a new instance of the PolarDeviceRestApiServiceDescription class with a provided dictionary.

```APIDOC
## PolarDeviceRestApiServiceDescription Constructor

### Description
Initializes a new instance of the PolarDeviceRestApiServiceDescription class.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Signature
`PolarDeviceRestApiServiceDescription(Map<String, Object> dictionary)`

### Parameters
*   **dictionary** (Map<String, Object>) - A map containing service API descriptions.
```

--------------------------------

### BleAdvertisementContent Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/advertisement/BleAdvertisementContent.html

Initializes a new instance of the BleAdvertisementContent class.

```APIDOC
## BleAdvertisementContent()

### Description
Initializes a new instance of the BleAdvertisementContent class.

### Constructor
BleAdvertisementContent()
```

--------------------------------

### FirmwareUpdateResponse Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/http/fwu/FirmwareUpdateResponse.html

Initializes a new instance of the FirmwareUpdateResponse class with the specified firmware version and file URL.

```APIDOC
## FirmwareUpdateResponse Constructor

### Description
Initializes a new instance of the FirmwareUpdateResponse class.

### Parameters
*   **version** (String) - Required - The firmware version.
*   **fileUrl** (String) - Required - The URL of the firmware file.
```

--------------------------------

### Project Structure

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/README.md

Overview of the directory structure for the Polar BLE SDK project.

```bash
├── sources/            # SDK source code (Android + iOS)
├── examples/           # Example apps for Android and iOS utilizing most of the features from sdk
├── demos/              # Contains Android ecg demo application
├── documentation/      # SDK documentation and product guides
├── technical_documentation/  # Technical specs and diagrams
└── docs/               # Generated API documentation
```

--------------------------------

### getRssi

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/advertisement/BleAdvertisementContent.html

Gets the RSSI value of the advertisement.

```APIDOC
## getRssi

### Description
Gets the RSSI value of the advertisement.

### Method
GET

### Endpoint
/BleAdvertisementContent/getRssi

### Returns
- **Integer** - The RSSI value.
```

--------------------------------

### getAdvertisementEventType

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/advertisement/BleAdvertisementContent.html

Gets the event type of the advertisement.

```APIDOC
## getAdvertisementEventType

### Description
Gets the event type of the advertisement.

### Method
GET

### Endpoint
/BleAdvertisementContent/getAdvertisementEventType

### Returns
- **BleUtils.EVENT_TYPE** - The advertisement event type.
```

--------------------------------

### DeviceCapabilitiesConfig Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/polar/BlePolarDeviceCapabilitiesUtility.DeviceCapabilitiesConfig.html

Initializes a new instance of the DeviceCapabilitiesConfig class.

```APIDOC
## DeviceCapabilitiesConfig Constructor

### Description
Initializes a new instance of the DeviceCapabilitiesConfig class with version, devices, and defaults.

### Parameters
*   **version** (String) - The version of the device capabilities configuration.
*   **devices** (Map<String, BlePolarDeviceCapabilitiesUtility.DeviceCapabilities>) - A map of device identifiers to their capabilities.
*   **defaults** (BlePolarDeviceCapabilitiesUtility.DefaultsSection) - The default settings section for the capabilities.
```

--------------------------------

### LedConfig Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/LedConfig.html

Initializes a new LedConfig object with specified SDK mode and PPI mode LED enabled states.

```APIDOC
## LedConfig Constructor

### Description
Initializes a new LedConfig object.

### Parameters
*   **sdkModeLedEnabled** (Boolean) - Determines if the LED is enabled for SDK mode.
*   **ppiModeLedEnabled** (Boolean) - Determines if the LED is enabled for PPI mode.
```

--------------------------------

### getName

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/advertisement/BleAdvertisementContent.html

Gets the name from the advertisement data.

```APIDOC
## getName

### Description
Gets the name from the advertisement data.

### Method
GET

### Endpoint
/BleAdvertisementContent/getName

### Returns
- **String** - The name from the advertisement data.
```

--------------------------------

### startPpiStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/docsets/PolarBleSdk.docset/Contents/Resources/Documents/Protocols/PolarOnlineStreamingApi.html

Starts the PPI (Pulse to Pulse interval) stream for a Polar device. The stream will stop if the connection is closed, an error occurs, or the stream is disposed. There is a delay before the PPI data stream starts. Requires the `feature_polar_online_streaming` SDK feature.

```APIDOC
## startPpiStreaming(_:)

### Description
Starts the 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.

### Requires
SDK feature(s): `PolarBleSdkFeature.feature_polar_online_streaming`

### Method Signature
```swift
func startPpiStreaming(_ identifier: String) -> AsyncThrowingStream<PolarPpiData, Error>
```

### Parameters
- `identifier` (String) - Polar device id or device address

### Return Value
- `onNext`: for every air packet received. see `PolarPpiData`
- `onError`: see `PolarErrors` for possible errors invoked
```

--------------------------------

### DeviceCapabilities Constructor

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/polar/BlePolarDeviceCapabilitiesUtility.DeviceCapabilities.html

Initializes a new instance of the DeviceCapabilities class with specified device capabilities.

```APIDOC
## BlePolarDeviceCapabilitiesUtility.DeviceCapabilities(fileSystemType, recordingSupported, firmwareUpdateSupported, isDeviceSensor, activityDataSupported)

### Description
Constructs a DeviceCapabilities object to store information about a Polar device's features.

### Parameters
#### Constructor Parameters
- **fileSystemType** (String) - The type of the file system on the device.
- **recordingSupported** (Boolean) - Indicates if recording is supported by the device.
- **firmwareUpdateSupported** (Boolean) - Indicates if firmware updates are supported by the device.
- **isDeviceSensor** (Boolean) - Indicates if the device functions as a sensor.
- **activityDataSupported** (Boolean) - Indicates if activity data is supported by the device.
```

--------------------------------

### SDLogConfig Initialization

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Structs/SDLogConfig.html

Initializes a new instance of SDLogConfig with various logging options. All parameters are optional.

```APIDOC
## init(ppiLogEnabled:accelerationLogEnabled:caloriesLogEnabled:gpsLogEnabled:gpsNmeaLogEnabled:magnetometerLogEnabled:tapLogEnabled:barometerLogEnabled:gyroscopeLogEnabled:sleepLogEnabled:slopeLogEnabled:ambientLightLogEnabled:tlrLogEnabled:ondemandLogEnabled:capsenseLogEnabled:fusionLogEnabled:metLogEnabled:ohrLogEnabled:verticalAccLogEnabled:amdLogEnabled:skinTemperatureLogEnabled:compassLogEnabled:speed3DLogEnabled:logTrigger:magnetometerFrequency:)

### Description
Initializes a new instance of SDLogConfig with various logging options. All parameters are optional.

### Parameters
#### Initializer Parameters
- **ppiLogEnabled** (Bool?) - Optional - Enables or disables PPI logging.
- **accelerationLogEnabled** (Bool?) - Optional - Enables or disables acceleration logging.
- **caloriesLogEnabled** (Bool?) - Optional - Enables or disables calories logging.
- **gpsLogEnabled** (Bool?) - Optional - Enables or disables GPS logging.
- **gpsNmeaLogEnabled** (Bool?) - Optional - Enables or disables GPS NMEA logging.
- **magnetometerLogEnabled** (Bool?) - Optional - Enables or disables magnetometer logging.
- **tapLogEnabled** (Bool?) - Optional - Enables or disables tap logging.
- **barometerLogEnabled** (Bool?) - Optional - Enables or disables barometer logging.
- **gyroscopeLogEnabled** (Bool?) - Optional - Enables or disables gyroscope logging.
- **sleepLogEnabled** (Bool?) - Optional - Enables or disables sleep logging.
- **slopeLogEnabled** (Bool?) - Optional - Enables or disables slope logging.
- **ambientLightLogEnabled** (Bool?) - Optional - Enables or disables ambient light logging.
- **tlrLogEnabled** (Bool?) - Optional - Enables or disables TLR logging.
- **ondemandLogEnabled** (Bool?) - Optional - Enables or disables on-demand logging.
- **capsenseLogEnabled** (Bool?) - Optional - Enables or disables CAPSENSE logging.
- **fusionLogEnabled** (Bool?) - Optional - Enables or disables fusion logging.
- **metLogEnabled** (Bool?) - Optional - Enables or disables MET logging.
- **ohrLogEnabled** (Bool?) - Optional - Enables or disables Ohr logging.
- **verticalAccLogEnabled** (Bool?) - Optional - Enables or disables vertical acceleration logging.
- **amdLogEnabled** (Bool?) - Optional - Enables or disables AMD logging.
- **skinTemperatureLogEnabled** (Bool?) - Optional - Enables or disables skin temperature logging.
- **compassLogEnabled** (Bool?) - Optional - Enables or disables compass logging.
- **speed3DLogEnabled** (Bool?) - Optional - Enables or disables 3D speed logging.
- **logTrigger** (Int?) - Optional - Sets the log trigger value.
- **magnetometerFrequency** (Int?) - Optional - Sets the magnetometer frequency.
```

--------------------------------

### startSkinTemperatureStreaming

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/PolarOnlineStreamingApi.html

Starts the Skin Temperature data stream. The stream will stop if the connection is closed, an error occurs, or the flow collection is cancelled. Requires the FEATURE_POLAR_ONLINE_STREAMING feature. It's recommended to request stream settings using requestStreamSettings before starting.

```APIDOC
## startSkinTemperatureStreaming

### Description
Starts the Skin Temperature data stream. The stream will stop if the connection is closed, an error occurs, or the flow collection is cancelled. Requires the FEATURE_POLAR_ONLINE_STREAMING feature. It's recommended to request stream settings using requestStreamSettings before starting.

### Method Signature
abstract Flow<PolarTemperatureData> startSkinTemperatureStreaming(String identifier, PolarSensorSetting sensorSetting)

### Parameters
#### Path Parameters
- **identifier** (String) - Required - Polar device id found printed on the sensor/device or bt address
- **sensorSetting** (PolarSensorSetting) - Required - settings to be used to start streaming

### Returns
Flow of [PolarTemperatureData]
```

--------------------------------

### clientsReady

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/androidcommunications/api/ble/model/BleDeviceSession.html

A helper method to consolidate the readiness of all available or desired Bluetooth Low Energy clients. It can optionally check the initial connection status.

```APIDOC
## clientsReady

### Description
A helper method to consolidate the readiness of all available or desired Bluetooth Low Energy clients. It can optionally check the initial connection status.

### Method
final

### Parameters
#### Path Parameters
- **checkConnection** (Boolean) - Description: check initial connection

### Returns
- **Unit** - Helper to combine all available/desired clients ready.
```

--------------------------------

### getDetails Method

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-android/com/polar/sdk/api/model/CheckFirmwareUpdateStatus.CheckFwUpdateNotAvailable.html

Retrieves the details explaining why no firmware update is available.

```APIDOC
## getDetails()

### Description
Returns the details associated with the firmware update status.

### Returns
* **String** - The details explaining why no firmware update is available.
```

--------------------------------

### RecordingInterval

Source: https://github.com/polarofficial/polar-ble-sdk/blob/master/docs/polar-sdk-ios/Enums.html

Recoding intervals for H10 recording start.

```APIDOC
## Enum: RecordingInterval

### Description
Recoding intervals for H10 recording start.

### Declaration
```swift
public enum RecordingInterval : Int
```
```