CharacteristicTreadmillData

@available(swift 3.1)
@available(iOS 10.0, tvOS 10.0, watchOS 3.0, macOS 10.12, *)
final public class CharacteristicTreadmillData : Characteristic
extension CharacteristicTreadmillData: Hashable
extension CharacteristicTreadmillData: Equatable

BLE Treadmill Data Characteristic

The Treadmill Data characteristic is used to send training-related data to the Client from a treadmill (Server).

  • Characteristic Name

    Declaration

    Swift

    public static var name: String { get }

  • Characteristic UUID

    Declaration

    Swift

    public static var uuidString: String { get }

  • Name of the Characteristic

    Declaration

    Swift

    public var name: String { get }

  • Characteristic UUID String

    Declaration

    Swift

    public var uuidString: String { get }

  • Instantaneous Speed

    Declaration

    Swift

    private(set) public var instantaneousSpeed: FitnessMachineSpeedType? { get }

  • Average Speed

    Declaration

    Swift

    private(set) public var averageSpeed: FitnessMachineSpeedType? { get }

  • Total Distance

    Declaration

    Swift

    private(set) public var totalDistance: Measurement<UnitLength>? { get }

  • Inclination

    Declaration

    Swift

    private(set) public var inclination: FitnessMachineInclinationType? { get }

  • Ramp Angle Setting

    Declaration

    Swift

    private(set) public var rampAngle: Measurement<UnitAngle>? { get }

  • Positive Elevation Gain

    Declaration

    Swift

    private(set) public var positiveElevationGain: Measurement<UnitLength>? { get }

  • Negative Elevation Gain

    Declaration

    Swift

    private(set) public var negativeElevationGain: Measurement<UnitLength>? { get }

  • Instantaneous Pace

    Declaration

    Swift

    private(set) public var instantaneousPace: Measurement<UnitSpeed>? { get }

  • Average Pace

    Declaration

    Swift

    private(set) public var averagePace: Measurement<UnitSpeed>? { get }

  • Energy Information

    Declaration

    Swift

    private(set) public var energy: FitnessMachineEnergy { get }

  • Heart Rate

    Declaration

    Swift

    private(set) public var heartRate: Measurement<UnitCadence>? { get }

  • Metabolic Equivalent

    Declaration

    Swift

    private(set) public var metabolicEquivalent: Double? { get }

  • Time Information

    Declaration

    Swift

    private(set) public var time: FitnessMachineTime { get }

  • Force on Belt

    Declaration

    Swift

    private(set) public var forceOnBelt: Measurement<UnitForce>? { get }

  • Power Output

    Declaration

    Swift

    private(set) public var powerOutput: FitnessMachinePowerType? { get }

  • Creates Treadmill Data Characteristic

    Declaration

    Swift

    public init(instantaneousSpeed: FitnessMachineSpeedType?,
            averageSpeed: FitnessMachineSpeedType?,
            totalDistance: Measurement<UnitLength>?,
            inclination: FitnessMachineInclinationType?,
            rampAngle: Measurement<UnitAngle>?,
            positiveElevationGain: Measurement<UnitLength>?,
            negativeElevationGain: Measurement<UnitLength>?,
            instantaneousPace: Measurement<UnitSpeed>?,
            averagePace: Measurement<UnitSpeed>?,
            energy: FitnessMachineEnergy,
            heartRate: UInt8?,
            metabolicEquivalent: Double?,
            time: FitnessMachineTime,
            forceOnBelt: Measurement<UnitForce>?,
            powerOutput: FitnessMachinePowerType?)

    Parameters

    instantaneousSpeed

    Instantaneous Speed
    averageSpeed

    Average Speed
    totalDistance

    Total Distance
    inclination

    Inclination
    rampAngle

    Ramp Angle Setting
    positiveElevationGain

    Positive Elevation Gain
    negativeElevationGain

    Negative Elevation Gain
    instantaneousPace

    Instantaneous Pace
    averagePace

    Average Pace
    energy

    Energy Information
    heartRate

    Heart Rate
    metabolicEquivalent

    Metabolic Equivalent
    time

    Time Information
    forceOnBelt

    Force on Belt
    powerOutput

    Power Output

  • Decodes Characteristic Data into Characteristic

    Declaration

    Swift

    public class func decode<C>(with data: Data) -> Result<C, BluetoothDecodeError> where C : Characteristic

    Parameters

    data

    Characteristic Data

    Return Value

    Characteristic Result

  • Encodes the Characteristic into Data

    Declaration

    Swift

    public func encode() -> Result<Data, BluetoothEncodeError>

    Return Value

    Characteristic Data Result

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    Never call finalize() on hasher. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    public func hash(into hasher: inout Hasher)

    Parameters

    hasher

    The hasher to use when combining the components of this instance.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    public static func == (lhs: CharacteristicTreadmillData, rhs: CharacteristicTreadmillData) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.