Structures

The following structures are available globally.

  • Data class representing a received device-to-host notification.

    See more

    Declaration

    Swift

    public struct PolarD2HNotificationData : Equatable

  • Contains the result information returned when starting an offline exercise session.

    All methods require the SDK feature PolarBleSdkFeature.FEATURE_POLAR_OFFLINE_EXERCISE_V2 and the device must support the dm_exercise capability.

    See more

    Declaration

    Swift

    public struct OfflineExerciseStartResult

  • Undocumented

    See more

    Declaration

    Swift

    public struct LedConfig

  • Undocumented

    See more

    Declaration

    Swift

    public struct LogConfig

  • Undocumented

    See more

    Declaration

    Swift

    public struct AutomaticSamples : Codable

  • Available settings for one Derived Measurement Settings Group returned by the device.

    Obtain an instance by calling PolarDerivedMeasurementApi.requestDerivedMeasurementSettingsGroup.

    See more

    Declaration

    Swift

    public struct PolarDerivedMeasurementSettingsGroup : Sendable

    Parameters

    groupId

    the Derived Measurement Settings Group ID advertised by the device
    sourceTypes

    the source measurement data types supported by this group
    sourceSampleRates

    the source measurement sample rates (Hz) available in this group
    timeWindowOptions

    the derived measurement time window durations (ms) available in this group. The time window defines the output cadence: e.g. 1000 ms → 1 Hz derived output.
    supportedMethods

    the derived measurement methods supported in this group. Any non-empty subset of supportedMethods may be selected when starting a recording.

  • Selected settings for starting a derived offline recording.

    Any non-empty subset of the supported methods may be requested simultaneously. Each selected method appends its result values to every derived sample.

    See more

    Declaration

    Swift

    public struct PolarDerivedMeasurementSettings : Sendable

    Parameters

    groupId

    Derived Measurement Settings Group ID obtained from the device
    sourceMeasurementType

    source sensor data type to derive from (e.g. ACC)
    sourceSampleRate

    source sensor sample rate in Hz (e.g. 50)
    timeWindowMs

    output cadence in milliseconds (e.g. 1000 for 1 Hz)
    selectedMethods

    non-empty set of methods to apply; results are concatenated per sample

  • One derived-measurement sample produced per time window (e.g. 1 sample/s with 1 000 ms window).

    methodValues maps each active PolarDerivedMeasurementMethod to its output values:

    • Component methods (DOWNSAMPLE, MIN, MAX, AVG, STD for a 3-axis source) → [x, y, z]

    • Scalar methods (NORM, MIN_OF_NORMS, MAX_OF_NORMS, STD_OF_NORMS, NORM_OF_STDS) → [v]

    See more

    Declaration

    Swift

    public struct PolarDerivedSample : Sendable

    Parameters

    timeStamp

    sample timestamp in nanoseconds, corresponds to end of the time window
    activeMethods

    the set of methods active for this recording
    methodValues

    output values per active method; absent key means method was not active

  • Container for a list of derived ACC samples.

    See more

    Declaration

    Swift

    public struct PolarDerivedAccData : Sendable

  • Represents a log file fetched from a Polar device.

    • path: the file path on the device (e.g. “/ERRORLOG.BPB”)
    • data: the raw file contents
    See more

    Declaration

    Swift

    public struct PolarDeviceLog

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarDiskSpaceData

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarFirstTimeUseConfig

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarPhysicalConfiguration : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarOfflineRecordingProgress

  • Polar offline recording entry container.

    See more

    Declaration

    Swift

    public struct PolarOfflineRecordingEntry : Equatable

  • Polar offline recording trigger

    See more

    Declaration

    Swift

    public struct PolarOfflineRecordingTrigger

  • Polar recording secret is used to encrypt the recording.

    See more

    Declaration

    Swift

    public struct PolarRecordingSecret

  • polar sensor settings class

    See more

    Declaration

    Swift

    public struct PolarSensorSetting
    extension PolarSensorSetting: CustomStringConvertible

  • Model for SPO2 test data retrieved from a Polar device.

    See more

    Declaration

    Swift

    public struct PolarSpo2TestData : Encodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarTrainingSessionReference : Equatable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarTrainingSession

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarExercise : Equatable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarTrainingSessionProgress

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarUserDeviceSettingsData : Identifiable

  • Watch face configuration containing the ordered list of enabled complications.

    See more

    Declaration

    Swift

    public struct PolarWatchFaceConfig

  • Undocumented

    See more

    Declaration

    Swift

    public struct UserIdentifierType

  • Undocumented

    See more

    Declaration

    Swift

    public struct Polar247HrSamplesData : Codable

  • Polar Peak-to-peak interval data

    Date

    date of the PPi activity data
    • samples: PPi samples from sensor as PolarPpiDataSample object
    See more

    Declaration

    Swift

    public struct Polar247PPiSamplesData : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarActivityDayData : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarCaloriesData : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarDailySummary : Codable

  • Undocumented

    Declaration

    Swift

    public struct PolarActivityGoalSummary : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarActiveTimeData : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarActiveTime : Codable, Equatable

  • Distance for given date.

    See more

    Declaration

    Swift

    public struct PolarDistanceData : Codable

  • Steps count for given date.

    See more

    Declaration

    Swift

    public struct PolarStepsData : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarNightlyRechargeData : Encodable

  • Lists REST API services and corresponding paths

    Declaration

    Swift

    public struct PolarDeviceRestApiServices : Decodable

  • Describes specific service API per SAGRFC95

    See more

    Declaration

    Swift

    public struct PolarDeviceRestApiServiceDescription : Decodable

  • Undocumented

    See more

    Declaration

    Swift

    public struct PolarPlainDate
    extension PolarPlainDate: CustomStringConvertible
    extension PolarPlainDate: ExpressibleByStringLiteral
    extension PolarPlainDate: Decodable
    extension PolarPlainDate: Encodable