CharacteristicStepClimberData

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

BLE Step Climber Data Characteristic

The Step Climber Data characteristic is used to send training-related data to the Client from a step climber (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 }

  • Floors

    Declaration

    Swift

    private(set) public var floors: UInt16? { get }

  • Step Count

    Declaration

    Swift

    private(set) public var stepCount: UInt16? { get }

  • Step Per Minute

    Declaration

    Swift

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

  • Average Step Rate

    Declaration

    Swift

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

  • Positive Elevation Gain

    Declaration

    Swift

    private(set) public var positiveElevationGain: Measurement<UnitLength>? { 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 }

  • Creates Step Climber Data Characteristic

    Declaration

    Swift

    public init(floors: UInt16?,
            stepCount: UInt16?,
            stepsPerMinute: Measurement<UnitCadence>?,
            averageStepRate: Measurement<UnitCadence>?,
            positiveElevationGain: Measurement<UnitLength>?,
            energy: FitnessMachineEnergy,
            heartRate: UInt8?,
            metabolicEquivalent: Double?,
            time: FitnessMachineTime)

    Parameters

    floors

    Floors climbed
    stepCount

    Step Count
    stepsPerMinute

    Step Per Minute
    averageStepRate

    Average Step Rate
    positiveElevationGain

    Positive Elevation Gain
    energy

    Energy Information
    heartRate

    Heart Rate
    metabolicEquivalent

    Metabolic Equivalent
    time

    Time Information

  • 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: CharacteristicStepClimberData, rhs: CharacteristicStepClimberData) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.