FitDataProtocol

https://fitnesskit.github.io/FitDataProtocol/
Admin
Swift implementation of the Garmin Flexible and Interoperable Data Transfer (FIT) protocol for...
Tokens:216,700
Snippets:3,600
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setup Incomplete Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Indicates that the setup is incomplete.

```swift
public static let setupIncomplete: ConnectivityCapabilities
```

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

### Install FitDataProtocol with CocoaPods

Source: https://fitnesskit.github.io/FitDataProtocol/index.html

Add this line to your Podfile to install the FitDataProtocol library using CocoaPods.

```ruby
pod 'FitDataProtocol'
```

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

### Live Track Auto Start Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Represents the Live Track auto start capability.

```swift
public static let liveTrackAutoStart: ConnectivityCapabilities
```

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

### Start Event Type

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/EventType.html

Defines the 'start' event type with a raw value of 0.

```swift
case start = 0
```

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

### Install FitDataProtocol with Swift Package Manager

Source: https://fitnesskit.github.io/FitDataProtocol/index.html

Include this dependency in your Swift Package Manager configuration to install the FitDataProtocol library.

```swift
dependencies: [
        .package(url: "https://github.com/FitnessKit/FitDataProtocol", from: "2.1.2")
    ]
```

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

### Set Start Time Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SetMessage.html

Represents the start time of the set, using the FitTime type. This property is marked with @FitFieldTime.

```swift
@FitFieldTime
private(set) public var startTime: FitTime? { get set }
```

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

### Turkish Get Up to Side Plank Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/PlankExerciseName.html

Declares the static property for 'turkishGetUpSidePlank'. Use this to represent the Turkish get up to side plank exercise.

```Swift
static var turkishGetUpSidePlank: PlankExerciseName { get }
```

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

### Weighted Turkish Get Up to Side Plank Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/PlankExerciseName.html

Declares the static property for 'weightedTurkishGetUpSidePlank'. Use this to represent the weighted version of the Turkish get up to side plank exercise.

```Swift
static var weightedTurkishGetUpSidePlank: PlankExerciseName { get }
```

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

### startPosition Field

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/LapMessage.html

Represents the starting geographical position of the lap.

```swift
private(set) public var startPosition: Position? { get set }
```

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

### Workout Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Indicates the start or stop of a workout.

```swift
case workout = 3
```

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

### LapTrigger PositionStart Case

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/LapTrigger.html

Defines the lap trigger when starting a position.

```swift
case positionStart = 3
```

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

### Completed Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/ScheduleMessage.html

Indicates if the Activity has been started. This property is settable only within the class.

```swift
@FitField
private(set) public var completed: Bool? { get set }
```

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

### CoursePoint Segment Start Case

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/CoursePoint.html

Marks the beginning of a segment on the course.

```swift
case segmentStart = 24
```

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

### Initialize VideoMessage with URL, Hosting Provider, and Duration

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/VideoMessage.html

Initializes a new instance of VideoMessage with optional URL, hosting provider, and duration parameters.

```swift
public init(url: String? = nil, hostingProvider: String? = nil, duration: Measurement<UnitDuration>? = nil)
```

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

### applicationVersion Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

Represents the Application Version for the message. It is a UInt32 type and can be get or set.

```swift
@FitField
private(set) public var applicationVersion: UInt32? { get set }
```

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

### init(withAllProperties) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeviceSettingsMessage.html

Initializes a new instance of DeviceSettingsMessage with all possible properties. This initializer is undocumented.

```swift
public required init(timeMode:backLightMode:activityTrackerEnabled:clockTime:pagesEnabled:moveAlertEnabled:dateMode:displayOrientation:mountingSide:defaultPage:autosyncMinimumSteps:autosyncMinimumTime:lactateThresholdAutodetectEnabled:bleAutoUploadEnabled:autoSyncFrequency:autoActivityDetect:numberOfScreens:smartNotificationDisplayOrientation:tapInterface:)
```

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

### init(timeStamp:messageIndex:friendlyName:weight:speedSetting:heartRateSetting:distanceSetting:powerSetting:positionSetting:temperatureSetting:localId:heightSetting:runningStepLength:walkingStepLength:gender:age:height:language:elevationSetting:weightSetting:restingHeartRate:maxRunningHeartRate:maxBikingHeartRate:maxHeartRate:) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/UserProfileMessage.html

Initializes a new instance of the UserProfileMessage class with a comprehensive set of parameters.

```swift
public required init(timeStamp:messageIndex:friendlyName:weight:speedSetting:heartRateSetting:distanceSetting:powerSetting:positionSetting:temperatureSetting:localId:heightSetting:runningStepLength:walkingStepLength:gender:age:height:language:elevationSetting:weightSetting:restingHeartRate:maxRunningHeartRate:maxBikingHeartRate:maxHeartRate:)
```

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

### Single Leg Bench Get Up Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SquatExerciseName.html

Represents the Single Leg Bench Get Up exercise.

```Swift
static var singleLegBenchGetUp: SquatExerciseName { get }
```

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

### Initialize SoftwareMessage with Parameters

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SoftwareMessage.html

Initializes a new instance of the SoftwareMessage class with optional message index, version, and part number.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        version: UInt16? = nil,
                        partNumber: String? = nil)
```

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

### CoreExerciseName Half Turkish Get Up Static Member

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/CoreExerciseName.html

Represents the 'Half Turkish Get Up' exercise type.

```swift
static var halfTurkishGetUp: CoreExerciseName { get }
```

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

### Convenience init() Constructor

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/FileIdMessage.html

Initializes a new instance of the FileIdMessage class with optional parameters for device serial number, file creation date, manufacturer, product, file number, file type, and product name.

```swift
public convenience init(deviceSerialNumber: UInt32? = nil,
                        fileCreationDate: FitTime? = nil,
                        manufacturer: Manufacturer? = nil,
                        product: UInt16? = nil,
                        fileNumber: UInt16? = nil,
                        fileType: FileType? = nil,
                        productName: String? = nil)
```

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

### startDate Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/GoalMessage.html

Represents the start date of the goal. This property uses @FitFieldTime for time-based data mapping and is private(set) for read-only access externally.

```swift
@FitFieldTime
private(set) public var startDate: FitTime? { get set }
```

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

### Weighted Single Leg Bench Get Up Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SquatExerciseName.html

Represents the Weighted Single Leg Bench Get Up exercise.

```Swift
static var weightedSingleLegBenchGetUp: SquatExerciseName { get }
```

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

### Initializer with secondSincePowerUp

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FitTime.html

Initializes a FitTime object with the time elapsed since device power up.

```swift
public init(secondSincePowerUp: TimeInterval)
```

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

### Convenience init() Method

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/ActivityMessage.html

Initializes a new instance of the ActivityMessage class with optional parameters for various activity properties.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        totalTimerTime: Measurement<UnitDuration>? = nil,
                        localTimeStamp: FitTime? = nil,
                        numberOfSessions: UInt16? = nil,
                        activity: Activity? = nil,
                        event: Event? = nil,
                        eventType: EventType? = nil,
                        eventGroup: UInt8? = nil)
```

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

### Predefined FileType: course

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FileType.html

Represents the course file type. This is a read/write/erase file containing recorded activity data to guide a user through an activity.

```swift
static let course: FileType
```

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

### DeviceIndex Initializers

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/DeviceIndex.html

Details the available initializers for the DeviceIndex structure.

```APIDOC
## DeviceIndex Initializers

### Description
Initializes a new instance of the DeviceIndex structure.

### Initializers

- **init(isCreator:)**
  - Initializes a DeviceIndex with a creator flag.
  - Parameters:
    - `isCreator` (Bool)

- **init(index:)**
  - Initializes a DeviceIndex with a specific index value.
  - Parameters:
    - `index` (UInt8)
```

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

### Convenience init() Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WorkoutStepMessage.html

A convenience initializer for WorkoutStepMessage that allows setting multiple properties upon creation. Optional parameters are provided for flexibility.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        name: String? = nil,
                        duration: UInt32? = nil,
                        durationType: WorkoutStepDurationType? = nil,
                        target: UInt32? = nil,
                        targetLow: UInt32? = nil,
                        targetHigh: UInt32? = nil,
                        targetType: WorkoutStepTargetType? = nil,
                        category: ExerciseCategory? = nil,
                        intensity: Intensity? = nil,
                        notes: String? = nil,
                        equipment: WorkoutEquipment? = nil)
```

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

### stringValue

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/SourceType.html

Gets the string representation of the SourceType.

```APIDOC
## stringValue

### Description
Returns the string representation of the SourceType.

### Property
`var stringValue: String { get }`
```

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

### Convenience Initializer for Connectivity Settings

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/ConnectivityMessage.html

A convenience initializer that allows setting multiple connectivity-related boolean flags and the name upon instantiation. All parameters are optional.

```swift
public convenience init(bluetoothEnabled: Bool? = nil,
                        bluetoothLowEnergyEnable: Bool? = nil,
                        antEnabled: Bool? = nil,
                        name: String? = nil,
                        liveTrackingEnabled: Bool? = nil,
                        weatherConditionsEnabled: Bool? = nil,
                        weatherAlertsEnabled: Bool? = nil,
                        autoActivityUploadEnabled: Bool? = nil,
                        courseDownloadEnabled: Bool? = nil,
                        workoutDownloadEnabled: Bool? = nil,
                        gpsEphemerisDownloadEnabled: Bool? = nil,
                        incidentDetectionEnabled: Bool? = nil,
                        groupTrackEnabled: Bool? = nil)
```

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

### Convenience init() Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/CoursePointMessage.html

Initializes a new instance of CoursePointMessage with optional parameters for various course point properties.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        messageIndex: MessageIndex? = nil,
                        name: String? = nil,
                        position: Position? = nil,
                        distance: Measurement<UnitLength>? = nil,
                        pointType: CoursePoint? = nil,
                        isFavorite: Bool? = nil)
```

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

### FitFileDecoder Initialization

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FitFileDecoder.html

Initializes a new FitFileDecoder instance, optionally specifying the CRC checking strategy. Defaults to '.throws'.

```swift
public init(crcCheckingStrategy: CrcCheckingStrategy = .throws)
```

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

### SquatExerciseName Supported Exercises Static Property

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SquatExerciseName.html

Returns a list of all supported SquatExerciseName instances.

```swift
static var supportedExerciseNames: [SquatExerciseName] { get }

```

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

### SitUpExerciseName.getUpSitUp Constant

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SitUpExerciseName.html

Represents the 'Get Up Sit Up' exercise type.

```swift
static var getUpSitUp: SitUpExerciseName { get }
```

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

### Calibration Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Indicates a calibration event, which can be a start, stop, or marker.

```swift
case calibration = 36
```

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

### Convenience Initializer with Versions

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/FileCreatorMessage.html

A convenience initializer for FileCreatorMessage that allows setting the software and hardware versions. Both parameters are optional.

```swift
public convenience init(softwareVersion: UInt16? = nil, hardwareVersion: UInt8? = nil)
```

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

### Predefined FlyeExerciseName Instances

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FlyeExerciseName.html

Provides access to predefined static instances for common flye exercises.

```APIDOC
## Predefined FlyeExerciseName Instances

### Description
Provides static properties for accessing predefined exercise names of the flye type.

### Properties
- **cableCrossover** (FlyeExerciseName) - Represents the Cable Crossover exercise.
- **declineDumbbellFlye** (FlyeExerciseName) - Represents the Decline Dumbbell Flye exercise.
- **dumbbellFlye** (FlyeExerciseName) - Represents the Dumbbell Flye exercise.
- **inclineDumbbellFlye** (FlyeExerciseName) - Represents the Incline Dumbbell Flye exercise.
- **kettlebellFlye** (FlyeExerciseName) - Represents the Kettlebell Flye exercise.
- **kneelingRearFlye** (FlyeExerciseName) - Represents the Kneeling Rear Flye exercise.
- **singleArmStandingCableReverseFlye** (FlyeExerciseName) - Represents the Single Arm Standing Cable Reverse Flye exercise.
- **swissBallDumbbellFlye** (FlyeExerciseName) - Represents the Swiss Ball Dumbbell Flye exercise.
```

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

### HipStabilityExerciseName Supported Exercises

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/HipStabilityExerciseName.html

Returns a list of all supported HipStabilityExerciseName instances.

```swift
static var supportedExerciseNames: [HipStabilityExerciseName] { get }

```

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

### SitUpExerciseName.weightedGetUpSitUp Constant

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SitUpExerciseName.html

Represents the 'Weighted Get Up Sit Up' exercise type.

```swift
static var weightedGetUpSitUp: SitUpExerciseName { get }
```

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

### init(manufacturer:product:) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SlaveDeviceMessage.html

A convenience initializer for SlaveDeviceMessage that allows setting the manufacturer and product.

```swift
public convenience init(manufacturer: Manufacturer? = nil, product: UInt16? = nil)
```

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

### Initializer with Capabilities

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/CapabilitiesMessage.html

Initializes a new instance of CapabilitiesMessage with specified language, sport, workout, and connectivity capabilities. All parameters are optional.

```swift
public init(languages: LanguageCapabilities? = nil,
            sports: SportCapabilities? = nil,
            workouts: WorkoutCapabilities? = nil,
            connectivity: ConnectivityCapabilities? = nil)
```

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

### SquatExerciseName Static Methods

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SquatExerciseName.html

Details static methods for creating and retrieving SquatExerciseName objects, including a list of all supported squat exercise names.

```APIDOC
## SquatExerciseName Static Methods

### Description
Details static methods for creating and retrieving SquatExerciseName objects, including a list of all supported squat exercise names.

### Methods
#### `static func create(rawValue: UInt16) -> SquatExerciseName?`
Creates a `ExerciseName` Object from a raw value.

##### Parameters
- `rawValue` (UInt16) - The raw value representing the exercise number.

##### Returns
An optional `SquatExerciseName` object if the raw value is valid, otherwise nil.

#### `static var supportedExerciseNames: [SquatExerciseName]`
Provides a list of all supported `SquatExerciseName` objects.
```

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

### instantInput

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Represents the instant input capability for connectivity.

```APIDOC
## instantInput

### Description
Represents the instant input capability for connectivity.

### Declaration
Swift
```swift
public static let instantInput: ConnectivityCapabilities
```
```

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

### dataIndex Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

Represents the Data Index for the message. It is a UInt8 type and can be get or set.

```swift
@FitField
private(set) public var dataIndex: UInt8? { get set }
```

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

### manufacturer Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

Represents the Manufacturer associated with the message. It is of type Manufacturer and can be get or set.

```swift
@FitField
private(set) public var manufacturer: Manufacturer? { get set }
```

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

### WorkoutMessage Initializer (Convenience)

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WorkoutMessage.html

A convenience initializer for WorkoutMessage, allowing optional parameters for workout details.

```swift
public convenience init(workoutName: String? = nil,
                        numberOfValidSteps: UInt16? = nil,
                        poolLength: Measurement<UnitLength>? = nil,
                        poolLengthUnit: MeasurementDisplayType? = nil,
                        sport: Sport? = nil,
                        subSport: SubSport? = nil,
                        capabilities: WorkoutCapabilities? = nil)
```

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

### applicationId Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

Represents the Application ID for the message. It is a Data type and can be get or set.

```swift
@FitField
private(set) public var applicationId: Data? { get set }
```

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

### init(stressLevel:timeCalculated:) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/StressLevelMessage.html

Initializes StressLevelMessage with optional stressLevel and timeCalculated values.

```swift
public init(stressLevel: Int16? = nil, timeCalculated: FitTime? = nil)
```

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

### Full Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SessionMessage.html

Declares a comprehensive initializer for SessionMessage, accepting numerous parameters to configure a session.

```Swift
public required init(timeStamp:messageIndex:event:eventType:startTime:startPosition:sport:subSport:totalElapsedTime:totalTimerTime:totalDistance:totalCycles:totalCalories:totalFatCalories:averageSpeed:maximumSpeed:averageHeartRate:maximumHeartRate:averageCadence:maximumCadence:averagePower:maximumPower:totalAscent:totalDescent:totalTrainingEffect:firstLapIndex:numberOfLaps:eventGroup:trigger:necPosition:swcPosition:normalizedPower:averageStrokeDistance:swimStroke:poolLength:poolLengthUnit:thresholdPower:activeLengths:totalWork:averageAltitude:maximumAltitude:gpsAccuracy:averageGrade:averagePositiveGrade:averageNegitiveGrade:maximumPositiveGrade:maximumNegitiveGrade:averageTemperature:maximumTemperature:totalMovingTime:averagePositiveVerticalSpeed:averageNegitiveVerticalSpeed:maximumPositiveVerticalSpeed:maximumNegitiveVerticalSpeed:minimumHeartRate:averageLapTime:bestLapIndex:minimumAltitude:score:opponentName:maximumBallSpeed:averageBallSpeed:averageVerticalOscillation:averageStanceTime:averageSaturatedHemoglobinPercent:saturatedHemoglobinPercent:averageTorqueEffectiveness:averagePedalSmoothness:sportIndex:timeStanding:standCount:averageStepLength:totalAnaerobicTrainingEffect:averageAscentSpeed:totalGrit:totalFlow:jumpCount:averageGrit:averageFlow:)
```

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

### developerId Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

Represents the Developer ID for the message. It is a Data type and can be get or set.

```swift
@FitField
private(set) public var developerId: Data? { get set }
```

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

### StanceTime Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/StanceTime.html

Initializes a new StanceTime instance with optional percent, time, and balance measurements.

```swift
public init(percent: Measurement<UnitPercent>?,
            time: Measurement<UnitDuration>?,
            balance: Measurement<UnitPercent>?) 
```

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

### Off Course Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Indicates an off-course event, used for starting or stopping within Group 0.

```swift
case offCourse = 7
```

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

### RunExerciseName Creation and Types

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/RunExerciseName.html

Details on how to create RunExerciseName objects and access predefined exercise types.

```APIDOC
## RunExerciseName Creation and Types

### create(rawValue:)

**Description**: Creates a `ExerciseName` object from a raw UInt16 value.

**Declaration**: `static func create(rawValue: UInt16) -> RunExerciseName?`

**Parameters**:
- `rawValue` (UInt16): The raw value to create the `ExerciseName` object from.

**Return Value**: An optional `RunExerciseName` object if the raw value is valid, otherwise nil.

### Exercise Types

**run**: Represents the 'Run' exercise type.
**Declaration**: `static var run: RunExerciseName { get }`

**walk**: Represents the 'Walk' exercise type.
**Declaration**: `static var walk: RunExerciseName { get }`

**jog**: Represents the 'Jog' exercise type.
**Declaration**: `static var jog: RunExerciseName { get }`

**sprint**: Represents the 'Sprint' exercise type.
**Declaration**: `static var sprint: RunExerciseName { get }`
```

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

### Workout Step Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Marks the start at the beginning of a workout and the stop at the end of each workout step.

```swift
case workoutStep = 4
```

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

### Convenience init() Method

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/HeartrateProfileMessage.html

Initializes a new instance of HeartrateProfileMessage with optional parameters for message index, enabled status, ANT ID, HRV logging, and transmission type.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        enabled: Bool? = nil,
                        antID: UInt16? = nil,
                        logHrv: Bool? = nil,
                        transmissionType: TransmissionType? = nil)
```

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

### FitField Wrapped Value Declaration

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/FitField.html

The actual wrapped value of the FIT field, which can be get and set.

```swift
public var wrappedValue: T? { get set }
```

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

### ExerciseNameType Category Property

Source: https://fitnesskit.github.io/FitDataProtocol/Protocols/ExerciseNameType.html

Represents the category of the exercise. Use this property to get the exercise's category.

```swift
var catagory: ExerciseCategory { get }
```

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

### Bike Profile Message - Convenience Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/BikeProfileMessage.html

A convenience initializer for the Bike Profile Message with numerous parameters for detailed configuration.

```Swift
public convenience init(messageIndex: MessageIndex? = nil,
                        name: String? = nil,
                        sport: Sport? = nil,
                        subSport: SubSport? = nil,
                        odometer: Measurement<UnitLength>? = nil,
                        speedAntId: UInt16? = nil,
                        cadenceAntId: UInt16? = nil,
                        speedCadenceAntId: UInt16? = nil,
                        powerAntId: UInt16? = nil,
                        customWheelSize: Measurement<UnitLength>? = nil,
                        autoWheelSize: Measurement<UnitLength>? = nil,
                        bikeWeight: Measurement<UnitMass>? = nil,
                        powerCalibrationFactor: Measurement<UnitPercent>? = nil,
                        autoWheelCalibration: Bool? = nil,
                        autoPowerZero: Bool? = nil,
                        id: UInt8?,
                        speedEnabled: Bool? = nil,
                        cadenceEnabled: Bool? = nil,
                        speedCadenceEnabled: Bool? = nil,
                        powerEnabled: Bool? = nil,
                        crankLength: Measurement<UnitLength>? = nil,
                        enbled: Bool? = nil,
                        speedTransmissionType: TransmissionType? = nil,
                        cadenceTransmissionType: TransmissionType? = nil,
                        speedCadenceTransmissionType: TransmissionType? = nil,
                        powerTransmissionType: TransmissionType? = nil,
                        odometerRollover: UInt8? = nil,
                        frontGears: UInt8? = nil,
                        frontGearTeeth: [UInt8]? = nil,
                        rearGears: UInt8? = nil,
                        rearGearTeeth: [UInt8]? = nil,
                        shimanoDi2Enabled: Bool? = nil)
```

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

### init(messageIndex:stepName:category:exerciseName:) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/ExerciseTitleMessage.html

A convenience initializer for ExerciseTitleMessage that allows setting multiple properties upon creation. Default values are provided for optional parameters.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        stepName: String? = nil,
                        category: ExerciseCategory? = nil,
                        exerciseName: ExerciseNameType? = nil)
```

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

### Get Global Message Number

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/CapabilitiesMessage.html

Returns the FIT Message Global Number for the CapabilitiesMessage. This is a class method.

```swift
public override class func globalMessageNumber() -> UInt16
```

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

### Timer Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Represents the timer event, used for starting or stopping all timer-related activities within Group 0.

```swift
case timer = 0
```

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

### Convenience init() Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/TotalsMessage.html

Initializes a new instance of TotalsMessage with optional parameters for various total metrics. This is a convenience initializer.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        messageIndex: MessageIndex? = nil,
                        timerTime: Measurement<UnitDuration>? = nil,
                        distance: Measurement<UnitLength>? = nil,
                        calories: Measurement<UnitEnergy>? = nil,
                        sport: Sport? = nil,
                        elapsedTime: Measurement<UnitDuration>? = nil,
                        sessions: UInt16? = nil,
                        activeTime: Measurement<UnitDuration>? = nil)
```

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

### ExerciseNameType Number Property

Source: https://fitnesskit.github.io/FitDataProtocol/Protocols/ExerciseNameType.html

Represents the exercise number from the FIT standard. Use this property to get the numerical identifier.

```swift
var number: UInt16 { get }
```

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

### Convenience Initializer for WeightScaleMessage

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WeightScaleMessage.html

This is a convenience initializer that allows creating a WeightScaleMessage with multiple properties pre-set. Optional parameters allow for partial initialization.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        weight: Weight? = nil,
                        percentFat: Measurement<UnitPercent>? = nil,
                        percentHydration: Measurement<UnitPercent>? = nil,
                        visceralFatMass: Measurement<UnitMass>? = nil,
                        boneMass: Measurement<UnitMass>? = nil,
                        muscleMass: Measurement<UnitMass>? = nil,
                        basalMet: Measurement<UnitEnergy>? = nil,
                        physiqueRating: UInt8? = nil,
                        activeMet: Measurement<UnitEnergy>? = nil,
                        metabolicAge: Measurement<UnitDuration>? = nil,
                        visceralFatRating: UInt8? = nil,
                        userProfileIndex: MessageIndex? = nil)
```

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

### ExerciseNameType Name Property

Source: https://fitnesskit.github.io/FitDataProtocol/Protocols/ExerciseNameType.html

Represents the name of the exercise. Use this property to get the exercise's string name.

```swift
var name: String { get }
```

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

### Initialize FieldDescriptionMessage (Convenience)

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/FieldDescriptionMessage.html

Initializes a new instance of FieldDescriptionMessage with provided values for all its properties. This is a convenience initializer.

```swift
public convenience init(dataIndex: UInt8?,
                        definitionNumber: UInt8?,
                        fieldName: String?,
                        baseInfo: BaseTypeData?,
                        units: String?,
                        baseUnits: BaseUnitType?,
                        messageNumber: UInt16?,
                        fieldNumber: UInt8?)
```

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

### Predefined FileType: workout

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FileType.html

Represents the workout file type. This is a read/write/erase file that describes a structured activity and guides a user through it.

```swift
static let workout: FileType
```

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

### Convenience Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SportMessage.html

A convenience initializer for creating a SportMessage with optional name, sport, and subSport values.

```swift
public convenience init(name: String? = nil, sport: Sport? = nil, subSport: SubSport? = nil)
```

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

### Elevation Low Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a low elevation alert. It starts or stops when in an alert condition within Group 0.

```swift
case elevationLowAlert = 46
```

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

### Convenience init() Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WeatherAlertMessage.html

Convenience initializer for WeatherAlertMessage allowing optional initialization of all properties. Defaults are provided for each parameter.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        reportID: String? = nil,
                        issueTime: FitTime? = nil,
                        expireTime: FitTime? = nil,
                        severity: WeatherSeverity? = nil,
                        alertType: WeatherSeverityType? = nil)
```

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

### Elevation High Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a high elevation alert. It starts or stops when in an alert condition within Group 0.

```swift
case elevationHighAlert = 45
```

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

### Power Low Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a low power alert. It starts or stops when in an alert condition within Group 0.

```swift
case powerLowAlert = 20
```

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

### CrunchExerciseName Supported Exercises

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/CrunchExerciseName.html

A static property returning a list of all supported CrunchExerciseName instances.

```swift
static var supportedExerciseNames: [CrunchExerciseName] { get }
```

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

### Convenience Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/MetZoneMessage.html

A convenience initializer for MetZoneMessage that allows setting messageIndex, heartRate, calories, and fatCalories. Default values are provided for optional parameters.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        heartRate: UInt8? = nil,
                        calories: Measurement<UnitEnergy>? = nil,
                        fatCalories: Measurement<UnitEnergy>? = nil)
```

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

### Power High Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a high power alert. It starts or stops when in an alert condition within Group 0.

```swift
case powerHighAlert = 19
```

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

### Supported Exercise Names

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/RunExerciseName.html

Provides a static list of all supported RunExerciseName instances.

```swift
static var supportedExerciseNames: [RunExerciseName] { get }
```

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

### Cadence Low Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a low cadence alert. It starts or stops when in an alert condition within Group 0.

```swift
case cadenceLowAlert = 18
```

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

### Instant Input Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Represents the instant input connectivity capability.

```swift
public static let instantInput: ConnectivityCapabilities
```

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

### Cadence High Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a high cadence alert. It starts or stops when in an alert condition within Group 0.

```swift
case cadenceHighAlert = 17
```

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

### Convenience Initializer with Parameters

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/EventMessage.html

A convenience initializer for EventMessage that accepts optional timeStamp, event, eventType, and eventGroup parameters.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        event: Event? = nil,
                        eventType: EventType? = nil,
                        eventGroup: UInt8? = nil)
```

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

### Speed Low Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a low speed alert. It starts or stops when in an alert condition within Group 0.

```swift
case speedLowAlert = 16
```

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

### Speed High Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a high speed alert. It starts or stops when in an alert condition within Group 0.

```swift
case speedHighAlert = 15
```

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

### Convenience init() Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/GoalMessage.html

Initializes a new instance of the GoalMessage class with optional parameters for various goal attributes. This initializer allows for setting multiple properties at once.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        startDate: FitTime? = nil,
                        endDate: FitTime? = nil,
                        sport: Sport? = nil,
                        subSport: SubSport? = nil,
                        goalType: Goal? = nil,
                        goalValue: UInt32? = nil,
                        repeatGoal: Bool? = nil,
                        targetValue: UInt32? = nil,
                        recurrence: GoalRecurrence? = nil,
                        recurrenceValue: UInt16? = nil,
                        enabled: Bool? = nil,
                        source: GoalSource? = nil)
```

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

### Physique RatingUnit Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/RatingUnit.html

Provides access to the Physique RatingUnit. Use this static property to get the RatingUnit instance for physique ratings.

```swift
public class var physique: RatingUnit { get }
```

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

### CourseMessage Convenience Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/CourseMessage.html

Initializes a new instance of CourseMessage with optional parameters for name, capabilities, sport, and subSport.

```swift
public convenience init(name: String? = nil,
                        capabilities: Capabilities? = nil,
                        sport: Sport? = nil,
                        subSport: SubSport? = nil)
```

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

### ConnectivityMessage Properties

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/ConnectivityMessage.html

This snippet outlines the properties available in the ConnectivityMessage class, which allow users to get and set various connectivity-related settings.

```APIDOC
## ConnectivityMessage Properties

### Description
Provides access to various connectivity settings and states.

### Properties

- **bluetoothEnabled** (Bool?) - Indicates if Bluetooth is enabled.
- **bluetoothLowEnergyEnable** (Bool?) - Indicates if Bluetooth Low Energy is enabled.
- **antEnabled** (Bool?) - Indicates if ANT is enabled.
- **name** (String?) - The name associated with the connectivity.
- **liveTrackingEnabled** (Bool?) - Indicates if live tracking is enabled.
- **weatherConditionsEnabled** (Bool?) - Indicates if weather conditions are enabled.
- **weatherAlertsEnabled** (Bool?) - Indicates if weather alerts are enabled.
- **autoActivityUploadEnabled** (Bool?) - Indicates if automatic activity upload is enabled.
- **courseDownloadEnabled** (Bool?) - Indicates if course download is enabled.
- **workoutDownloadEnabled** (Bool?) - Indicates if workout download is enabled.
- **gpsEphemerisDownloadEnabled** (Bool?) - Indicates if GPS ephemeris download is enabled.
- **incidentDetectionEnabled** (Bool?) - Indicates if incident detection is enabled.
- **groupTrackEnabled** (Bool?) - Indicates if group tracking is enabled.

### Methods

- **globalMessageNumber()** - Returns the FIT Message Global Number for this message type.
- **init()** - Initializes a new instance of ConnectivityMessage.
- **init(bluetoothEnabled:bluetoothLowEnergyEnable:antEnabled:name:liveTrackingEnabled:weatherConditionsEnabled:weatherAlertsEnabled:autoActivityUploadEnabled:courseDownloadEnabled:workoutDownloadEnabled:gpsEphemerisDownloadEnabled:incidentDetectionEnabled:groupTrackEnabled:)** - Initializes a new instance with provided connectivity settings.
```

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

### Supported Exercise Names

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/WarmUpExerciseName.html

Returns a list of all supported WarmUpExerciseName instances.

```swift
static var supportedExerciseNames: [WarmUpExerciseName] { get }
```

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

### Calorie Duration Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a calorie duration alert. It starts if enabled mid-activity and stops when the duration is reached. It can also be disabled.

```swift
case calorieDurationAlert = 25
```

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

### LungeExerciseName Supported Exercises

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/LungeExerciseName.html

Returns a list of all supported LungeExerciseName instances.

```swift
static var supportedExerciseNames: [LungeExerciseName] { get }
```

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

### init(messageIndex:name:highLevel:) Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/CadenceZoneMessage.html

Initializes a new instance of CadenceZoneMessage with optional message index, name, and high-level cadence values.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        name: String? = nil,
                        highLevel: UInt8? = nil)
```

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

### Distance Duration Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a distance duration alert. It starts if enabled mid-activity and stops when the duration is reached. It can also be disabled.

```swift
case distanceDurationAlert = 24
```

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

### Time Duration Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a time duration alert. It starts if enabled mid-activity and stops when the duration is reached. It can also be disabled.

```swift
case timeDurationAlert = 23
```

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

### Device Initiates Sync Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Indicates the device is in control of initiating all syncs.

```swift
public static let deviceInitiatesSync: ConnectivityCapabilities
```

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

### HR Low Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a low heart rate alert. It starts or stops when in an alert condition within Group 0.

```swift
case hrLowAlert = 14
```

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

### DeviceIndex Initializer with index

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/DeviceIndex.html

Initializes a DeviceIndex instance with a specific index value.

```swift
public init(index: UInt8)
```

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

### HR High Alert Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Triggers a high heart rate alert. It starts or stops when in an alert condition within Group 0.

```swift
case hrHighAlert = 13
```

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

### LanguageCapabilities Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/LanguageCapabilities.html

Initializer for the LanguageCapabilities struct, accepting all language bit fields.

```swift
public init(bits0: LanguageBits0?,
            bits1: LanguageBits1?,
            bits2: LanguageBits2?,
            bits3: LanguageBits3?,
            bits4: LanguageBits4)
```

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

### Convenience Initializer for DeviceInfoMessage

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeviceInfoMessage.html

A convenience initializer for DeviceInfoMessage that allows setting various properties with optional default values.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        serialNumber: UInt32? = nil,
                        cumulativeOpTime: Measurement<UnitDuration>? = nil,
                        productName: String? = nil,
                        manufacturer: Manufacturer? = nil,
                        product: UInt16? = nil,
                        softwareVersion: UInt16? = nil,
                        hardwareVersion: UInt8? = nil,
                        batteryVoltage: Measurement<UnitElectricPotentialDifference>? = nil,
                        batteryStatus: BatteryStatus? = nil,
                        deviceNumber: UInt16? = nil,
                        deviceType: DeviceType? = nil,
                        deviceIndex: DeviceIndex? = nil,
                        sensorDescription: String? = nil,
                        bodylocation: BodyLocation? = nil,
                        transmissionType: TransmissionType? = nil,
                        antNetwork: NetworkType? = nil,
                        source: SourceType? = nil)
```

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

### Course Download Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Represents the capability for downloading courses.

```swift
public static let courseDownload: ConnectivityCapabilities
```

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

### Leader Time Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SegmentPointMessage.html

An array of accumulated times for each leader board member to reach the described point. This value is zero for all members at the segment's start.

```swift
public var leaderTime: [Measurement<UnitDuration>]? { get }
```

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

### Visceral Fat RatingUnit Property

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/RatingUnit.html

Provides access to the Visceral Fat RatingUnit. Use this static property to get the RatingUnit instance for visceral fat ratings.

```swift
public class var visceralFat: RatingUnit { get }
```

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

### HipSwingExerciseName Supported Exercises

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/HipSwingExerciseName.html

Returns a list of all supported HipSwingExerciseName instances.

```swift
static var supportedExerciseNames: [HipSwingExerciseName] { get }
```

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

### SetMessage

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/SetMessage.html

Represents a set of exercise data, providing properties for duration, repetitions, weight, type, start time, category, exercise name, display units, and indexing.

```APIDOC
## SetMessage

### Description
Represents a set of exercise data, providing properties for duration, repetitions, weight, type, start time, category, exercise name, display units, and indexing.

### Properties

- **globalMessageNumber()**: FIT Message Global Number. Returns the global message number for this set.
- **duration** (Measurement<UnitDuration>?): Set Duration. The duration of the set.
- **repetitions** (UInt16?): Repetitions. The number of repetitions performed in the set.
- **weight** (Measurement<UnitMass>?): Weight. The weight used in the set.
- **setType** (SetType?): Set Type. The type of set performed.
- **startTime** (FitTime?): Start Time of the Set. The time when the set started.
- **category** (ExerciseCategory?): Exercise Category. The category of the exercise.
- **exerciseName** (ExerciseNameType?): Exercise Name. The name of the exercise.
- **weightDisplayUnit** (BaseUnitType?): Weight Display Unit. The unit used for displaying weight.
- **messageIndex** (MessageIndex?): Message Index. The index of the message.
- **workoutSetpIndex** (MessageIndex?): Workout Step Index. The index of the workout step.
- **timeStamp** (FitTime?): Timestamp. The timestamp of the set message.

### Initializers

- **init()**: Undocumented initializer.
- **init(timeStamp:duration:repetitions:weight:setType:startTime:category:exerciseName:weightDisplayUnit:messageIndex:workoutSetpIndex:)**: Initializes a SetMessage with optional parameters for all its properties.
```

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

### ValidityStrategy None Option

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/FitFileEncoder/ValidityStrategy.html

The 'none' strategy is the default, assuming correct message inclusion for the file type.

```swift
case none
```

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

### Virtual Partner Pace Event

Source: https://fitnesskit.github.io/FitDataProtocol/Enums/Event.html

Indicates changes in Virtual Partner Pace. It starts at the beginning of an activity if VP is enabled, when VP pace is changed, or when VP is enabled mid-activity.

```swift
case virtualPatnerPace = 12
```

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

### PushUpExerciseName Static Methods

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/PushUpExerciseName.html

This section details the static methods available for the PushUpExerciseName structure.

```APIDOC
## PushUpExerciseName Static Methods

### `supportedExerciseNames`

**Description**: List of Supported ExerciseNames.

**Declaration**: Swift
```swift
static var supportedExerciseNames: [PushUpExerciseName] { get }
```

### `create(rawValue:)`

**Description**: Creates a ExerciseName Object.

**Declaration**: Swift
```swift
static func create(rawValue: UInt16) -> PushUpExerciseName?
```

#### Parameters

`_ rawValue` | `exerciseNumber`
---|---

#### Return Value

ExerciseName Object
```

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

### Encode FIT Files with No Validity Checks

Source: https://fitnesskit.github.io/FitDataProtocol/index.html

Encodes FIT file messages using FitFileEncoder with no data validity checks. This example shows how to create an ActivityMessage and a FileIdMessage, then encode them.

```swift
let activity = ActivityMessage(timeStamp: FitTime(date: Date()),
                               totalTimerTime: nil,
                               localTimeStamp: nil,
                               numberOfSessions: nil,
                               activity: Activity.multisport,
                               event: nil,
                               eventType: nil,
                               eventGroup: nil)


let fieldId = FileIdMessage(deviceSerialNumber: nil,
                            fileCreationDate: time,
                            manufacturer: Manufacturer.garmin,
                            product: nil,
                            fileNumber: nil,
                            fileType: FileType.activity,
                            productName: nil)

let encoder = FitFileEncoder(dataValidityStrategy: .none)

let result = encoder.encode(fildIdMessage: fiel, messages: [activity])
switch result {
case .success(let encodedData):
    print(encodedData as NSData)
    /// you can save off the file data
case .failure(let error):
    print(error.localizedDescription)
}
```

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

### TotalBodyExerciseName Static Methods

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/TotalBodyExerciseName.html

This section covers static methods for creating and retrieving TotalBodyExerciseName instances, including a general creation method and specific exercise type accessors.

```APIDOC
## TotalBodyExerciseName Static Methods

### Description
Provides static methods for creating and accessing specific exercise names.

### Methods
#### `create(rawValue:)`
Creates a `ExerciseName` Object.

- **Parameters**
  - `rawValue` (UInt16) - The raw value representing the exercise number.

- **Returns**
  - `TotalBodyExerciseName?` - An optional `TotalBodyExerciseName` object if the raw value is valid, otherwise nil.

#### `supportedExerciseNames`
List of Supported ExerciseNames.

- **Returns**
  - `[TotalBodyExerciseName]` - An array of all supported `TotalBodyExerciseName` instances.

### Exercise Types
#### `burpee`
Burpee exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `weightedBurpee`
Weighted Burpee exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `burpeeBoxJump`
Burpee Box Jump exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `weightedBurpeeBoxJump`
Weighted Burpee Box Jump exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `highPullBurpee`
High Pull Burpee exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `manMakers`
Man Makers exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `oneArmBurpee`
One Arm Burpee exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `squatThrusts`
Squat Thrusts exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `weightedSquatThrusts`
Weighted Squat Thrusts exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `squatPlankPushUp`
Squat Plank Push Up exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `weightedSquatPlankPushUp`
Weighted Squat Plank Push Up exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `standingTRotationBalance`
Standing T Rotation Balance exercise name.

- **Returns**
  - `TotalBodyExerciseName`

#### `weightedStandingTRotationBalance`
Weighted Standing T Rotation Balance exercise name.

- **Returns**
  - `TotalBodyExerciseName`
```

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

### SportBits6 Floor Climbing Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/SportCapabilities/SportBits6.html

Represents the 'Floor Climbing' capability within the SportBits6 set. Note: This example shows SportBits5, implying a potential type mismatch or related structure.

```swift
public static let floorClimbing: SportCapabilities.SportBits5
```

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

### Convenience Initializer

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/DeveloperDataIdMessage.html

A convenience initializer for DeveloperDataIdMessage that allows setting various properties upon creation. Default values are provided for all parameters.

```swift
public convenience init(developerId: Data? = nil,
                        applicationId: Data? = nil,
                        applicationVersion: UInt32? = nil,
                        manufacturer: Manufacturer? = nil,
                        dataIndex: UInt8? = nil)
```

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

### Initialize WatchfaceSettingsMessage with Parameters

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WatchfaceSettingsMessage.html

Initializes a new instance of WatchfaceSettingsMessage with optional message index, mode, and layout. This is an undocumented initializer.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                        mode: WatchfaceMode? = nil,
                        layout: WatchfaceLayout? = nil)
```

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

### Connect IQ Widget Download Connectivity Capability

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/ConnectivityCapabilities.html

Represents the capability for Connect IQ widget downloads.

```swift
public static let connectIQWidgetDownload: ConnectivityCapabilities
```

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

### HipRaiseExerciseName Supported Exercises

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/HipRaiseExerciseName.html

Returns a list of all supported HipRaiseExerciseName instances.

```swift
static var supportedExerciseNames: [HipRaiseExerciseName] { get }
```

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

### Weight Equality Comparison

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/Weight.html

Describes how to compare two Weight instances for equality.

```APIDOC
## Weight Equality Comparison

### Description
Returns a Boolean value indicating whether two `Weight` instances are equal. Equality is the inverse of inequality.

### Method
`static func == (lhs: Weight, rhs: Weight) -> Bool`

### Parameters
*   **lhs** (Weight) - A value to compare.
*   **rhs** (Weight) - Another value to compare.

### Return Value
`Bool` - `true` if the weights are equal, `false` otherwise.
```

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

### HipStabilityExerciseName.create(rawValue:)

Source: https://fitnesskit.github.io/FitDataProtocol/Structs/HipStabilityExerciseName.html

A static method to create a `HipStabilityExerciseName` object from a raw UInt16 value.

```APIDOC
## HipStabilityExerciseName.create(rawValue:)

### Description
Creates a `HipStabilityExerciseName` object from a raw UInt16 value.

### Method
`static func create(rawValue: UInt16) -> HipStabilityExerciseName?`

### Parameters
- **rawValue** (UInt16): The raw value representing the exercise number.
```

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

### Convenience Initializer for WeatherConditionsMessage

Source: https://fitnesskit.github.io/FitDataProtocol/Classes/WeatherConditionsMessage.html

A convenience initializer allowing for the creation of a WeatherConditionsMessage with various weather-related properties.

```swift
public convenience init(timeStamp: FitTime? = nil,
                        report: WeatherReport? = nil,
                        temperature: Measurement<UnitTemperature>? = nil,
                        condition: WeatherStatus? = nil,
                        windDirection: Measurement<UnitAngle>? = nil,
                        windSpeed: Measurement<UnitSpeed>? = nil,
                        precipitationProbability: UInt8? = nil,
                        feelsLikeTemperature: Measurement<UnitTemperature>? = nil,
                        relativeHumidity: UInt8? = nil,
                        location: String? = nil,
                        observedTime: FitTime? = nil,
                        observedLocation: Position? = nil,
                        dayOfWeek: DayOfWeek? = nil,
                        highTemperature: Measurement<UnitTemperature>? = nil,
                        lowTemperature: Measurement<UnitTemperature>? = nil)
```
Tokens:
Raw