Type Aliases

The following type aliases are available globally.

  • Polar device info

    - deviceId = polar device id or UUID for 3rd party sensors
- rssi = RSSI (Received Signal Strength Indicator) value from advertisement
- name = local name from advertisement
- connectable = true adv type is connectable

    Declaration

    Swift

    public typealias PolarDeviceInfo = (deviceId: String, address: UUID, rssi: Int, name: String, connectable: Bool)

  • deviceInfo: see #PolarDeviceInfo ,

    - hr: in BPM
- batteryStatus: true battery ok

    Declaration

    Swift

    public typealias PolarHrBroadcastData = (deviceInfo: PolarDeviceInfo, hr: UInt8, batteryStatus: Bool)

  • Polar hr data

    - hr in BPM
- ppgQuality PPG signal quality of the real time HR between 0 and 100
- correctedHr Corrected value of the real time HR value. 0 if unavailable.
- rrsMs RR interval in ms. R is a the top highest peak in the QRS complex of the ECG wave and RR is the interval between successive Rs.
- contactStatus true if the sensor has contact (with a measurable surface e.g. skin)
- contactStatusSupported true if the sensor supports contact status
- rrAvailable true if RR data is available.

    Declaration

    Swift

    public typealias PolarHrData = [(hr: UInt8, ppgQuality: UInt8, correctedHr: UInt8, rrsMs: [Int], rrAvailable: Bool, contactStatus: Bool, contactStatusSupported: Bool)]

  • Polar Ecg data

    - samples: Acceleration samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - voltage value in µVolts

    Declaration

    Swift

    public typealias PolarEcgData = ([(timeStamp: UInt64, voltage: Int32)])

  • Polar acc data

    - samples: Acceleration samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - x axis value in millig (including gravity)
    - y axis value in millig (including gravity)
    - z axis value in millig (including gravity)

    Declaration

    Swift

    public typealias PolarAccData = ([(timeStamp: UInt64, x: Int32, y: Int32, z: Int32)])

  • Polar gyro data

    - samples: Gyroscope samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - x axis value in deg/sec
    - y axis value in deg/sec
    - z axis value in deg/sec

    Declaration

    Swift

    public typealias PolarGyroData = ([(timeStamp: UInt64, x: Float, y: Float, z: Float)])

  • Polar magnetometer data

    - samples: Magnetometer samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - x axis value in Gauss
    - y axis value in Gauss
    - z axis value in Gauss

    Declaration

    Swift

    public typealias PolarMagnetometerData = ([(timeStamp: UInt64, x: Float, y: Float, z: Float)])

  • Polar Temperature data

    - timestamp: Last sample timestamp in nanoseconds. The epoch of timestamp is 1.1.2000
- samples: Temperature samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - temperature value in celsius

    Declaration

    Swift

    public typealias PolarTemperatureData = (timeStamp: UInt64, samples: [(timeStamp: UInt64, temperature: Float)])

  • Polar Pressure data

    - timestamp: Last sample timestamp in nanoseconds. The epoch of timestamp is 1.1.2000
- samples: Pressure samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - pressure value in bar

    Declaration

    Swift

    public typealias PolarPressureData = (timeStamp: UInt64, samples: [(timeStamp: UInt64, pressure: Float)])

  • Polar PPG data

    - type: type of data, which varies based on what is type of optical sensor used in the device
- samples: Photoplethysmography samples
    - timeStamp: moment sample is taken in nanoseconds. The epoch of timestamp is 1.1.2000
    - channelSamples is the PPG (Photoplethysmography) raw value received from the optical sensor. Based on [OhrDataType] the amount of channels varies. Typically ppg(n) channel + n ambient(s).

    Declaration

    Swift

    public typealias PolarPpgData = (type: PpgDataType, samples: [(timeStamp: UInt64, channelSamples: [Int32])])

  • Polar ppi data

    - Deprecated: timestamp always 0
- samples: PPI samples
    - hr in BPM
    - ppInMs Pulse to Pulse interval in milliseconds. The value indicates the quality of PP-intervals. When error estimate is below 10ms the PP-intervals are probably very accurate. Error estimate values over 30ms may be caused by movement artefact or too loose sensor-skin contact.
    - ppErrorEstimate estimate of the expected absolute error in PP-interval in milliseconds
    - blockerBit = 1 if PP measurement was invalid due to acceleration or other reason
    - skinContactStatus = 0 if the device detects poor or no contact with the skin
    - skinContactSupported = 1 if the Sensor Contact feature is supported.

    Declaration

    Swift

    public typealias PolarPpiData = (timeStamp: UInt64, samples: [(timeStamp: UInt64, hr: Int, ppInMs: UInt16, ppErrorEstimate: UInt16, blockerBit: Int, skinContactStatus: Int, skinContactSupported: Int)])

  • Polar exercise entry

    - path: Resource location in the device,
- date: Entry date and time. Only OH1 and Polar Verity Sense supports date and time
- entryId: unique identifier

    Declaration

    Swift

    public typealias PolarExerciseEntry = (path: String, date: Date, entryId: String)

  • Polar Exercise Data

    - interval: in seconds
- samples: List of HR or RR samples in BPM

    Declaration

    Swift

    public typealias PolarExerciseData = (interval: UInt32, samples: [UInt32])

  • Polar Recording status

    - ongoing: true recording running
- entryId: unique identifier

    Declaration

    Swift

    public typealias PolarRecordingStatus = (ongoing: Bool, entryId: String)