### Live Track Auto Start Capability

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/ConnectivityCapabilities.html

Represents the capability for Live Track auto start.

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

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

### EventType: start

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/EventType.html

Represents the start event. Raw value is 0.

```swift
case start = 0
```

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

### startDate Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/GoalMessage.html

Represents the start date of the goal. This property is marked with @FitFieldTime for FIT protocol integration.

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

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

### Turkish Get Up to Side Plank

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PlankExerciseName.html

Represents the Turkish Get Up to Side Plank exercise. This combines the Turkish Get Up movement with a side plank.

```APIDOC
## Turkish Get Up to Side Plank

### Description
Represents the Turkish Get Up to Side Plank exercise. This combines the Turkish Get Up movement with a side plank.

### Declaration

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

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

### Initialize VideoMessage (Custom)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/VideoMessage.html

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

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

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

### Weighted Turkish Get Up to Side Plank

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PlankExerciseName.html

Represents the Weighted Turkish Get Up to Side Plank exercise. This variation adds weight to the Turkish Get Up to Side Plank.

```APIDOC
## Weighted Turkish Get Up to Side Plank

### Description
Represents the Weighted Turkish Get Up to Side Plank exercise. This variation adds weight to the Turkish Get Up to Side Plank.

### Declaration

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

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

### liveTrackAutoStart

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/ConnectivityCapabilities.html

Indicates support for Live Track auto-start functionality.

```APIDOC
## liveTrackAutoStart

### Description
Indicates support for Live Track auto-start functionality.

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

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

### VideoMessage Initialization

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/VideoMessage.html

Initializes a new VideoMessage instance. You can optionally provide the URL, hosting provider, and duration.

```APIDOC
## VideoMessage(url:hostingProvider:duration:)

### Description
Initializes a new VideoMessage instance with optional video details.

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

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```swift
let videoMessage = VideoMessage(url: "https://example.com/video.mp4", hostingProvider: "ExampleProvider", duration: Measurement(value: 120, unit: .seconds))
```

### Response
#### Success Response (200)
None (initialization method)

#### Response Example
None
```

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

### FitTime Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FitTime.html

This snippet outlines the available initializers for the FitTime structure, used to create instances with specific time values.

```APIDOC
## FitTime Initializers

### Description
Provides information on how to initialize `FitTime` objects.

### Initializers

*   **init(date:isLocal:)**
    *   Initializes a `FitTime` object with a given `Date` and an optional `isLocal` flag.
    *   `date`: The `Date` to initialize with.
    *   `isLocal`: A boolean indicating if the date is local (defaults to `false`).

*   **init(secondSincePowerUp:)**
    *   Initializes a `FitTime` object using a time interval since device power up.
    *   `secondSincePowerUp`: The `TimeInterval` representing time since power up.
```

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

### TotalsMessage convenience init(...) 

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/TotalsMessage.html

Initializes a new instance of TotalsMessage with optional parameters for various properties.

```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)
```

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

### CoursePoint Segment Start Case

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/CoursePoint.html

Represents the start of a course segment. Corresponds to value 24.

```swift
case segmentStart = 24
```

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

### ScheduleMessage Completed Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/ScheduleMessage.html

Indicates whether the scheduled activity has been started. True if the Activity has been started.

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

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

### instantInput

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/ConnectivityCapabilities.html

Indicates support for instant input.

```APIDOC
## instantInput

### Description
Indicates support for instant input.

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

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

### Install FitDataProtocol via CocoaPods

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/README.md

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

```ruby
pod 'FitDataProtocol'
```

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

### DeviceIndex Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/DeviceIndex.html

Initializers for the DeviceIndex structure allow for creating instances based on whether the device is a creator or by providing a specific index value.

```APIDOC
## DeviceIndex Initializers

### Description
Provides methods to initialize a DeviceIndex instance.

### Initializers

- **init(isCreator:)**
  - Initializes a DeviceIndex with a boolean indicating if it's the file creator.
  - Parameters:
    - **isCreator** (Bool) - True if the device is the file creator, false otherwise.

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

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

### Turkish Get Up to Side Plank Declaration

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PlankExerciseName.html

Represents the Turkish Get Up to Side Plank exercise. This is a static property of PlankExerciseName.

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

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

### Single Leg Bench Get Up Declaration

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/SquatExerciseName.html

Represents the 'Single Leg Bench Get Up' exercise. Use this constant to identify the exercise.

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

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

### StanceTime Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/StanceTime.html

Initializes a new StanceTime instance with provided percent, time, and balance values.

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

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

### Weighted Turkish Get Up to Side Plank Declaration

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PlankExerciseName.html

Represents the weighted version of the Turkish Get Up to Side Plank exercise. This is a static property of PlankExerciseName.

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

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

### FileType Properties and Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FileType.html

This snippet outlines the properties and initializer available for the FileType structure, including its raw value, a manufacturing type check, and how to initialize it.

```APIDOC
## FileType

### Description
Represents different file types within the FitDataProtocol.

### Properties

- **rawValue** (UInt8) - Raw Value for File Type
- **isManufacturingType** (Bool) - Manufacturing Specific Range Check

### Initializer

#### `init(rawValue: UInt8)`
Initializes a FileType with a raw value.

- **_rawValue_** (UInt8) - Raw File Type Number (ex: 4 == Activity)
```

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

### DeviceInfoMessage Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/DeviceInfoMessage.html

Initializes a new instance of DeviceInfoMessage with various optional parameters for detailed device configuration.

```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)
```

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

### Weighted Single Leg Bench Get Up Declaration

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/SquatExerciseName.html

Represents the 'Weighted Single Leg Bench Get Up' exercise. Use this constant to identify the exercise.

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

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

### Initialize MetZoneMessage with Parameters

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/MetZoneMessage.html

Initializes a new instance of the MetZoneMessage class with optional parameters for message index, heart rate, calories, and fat calories. This is a convenience initializer.

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

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

### Workout Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/Event.html

Indicates the start or stop of a workout. Used for workout tracking.

```swift
case workout = 3
```

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

### Initialize CourseMessage with Parameters

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/CourseMessage.html

Initializes a new instance of the CourseMessage class 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)
```

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

### Timer Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/Event.html

Represents the start or stop of a timer. Used in Group 0.

```swift
case timer = 0
```

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

### Supported Sports Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/CapabilitiesMessage.html

A property to get or set the supported sports. It is private to the set.

```swift
private(set) public var sports: SportCapabilities? { get set }
```

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

### Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/UserProfileMessage.html

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

```swift
public convenience init(timeStamp: FitTime? = nil,
                        messageIndex: MessageIndex? = nil,
                        friendlyName: String? = nil,
                        weight: Measurement<UnitMass>? = nil,
                        speedSetting: MeasurementDisplayType? = nil,
                        heartRateSetting: HeartRateDisplayType? = nil,
                        distanceSetting: PositionDisplayType? = nil,
```

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

### Supported Languages Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/CapabilitiesMessage.html

A property to get or set the supported languages. It is private to the set.

```swift
private(set) public var languages: LanguageCapabilities? { get set }
```

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

### Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/HeartRateZoneMessage.html

Initializes a new instance of HeartRateZoneMessage with optional message index, name, and heart rate values.

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

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

### Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/DeveloperDataIdMessage.html

Initializes a new instance of DeveloperDataIdMessage with optional parameters for developerId, applicationId, applicationVersion, manufacturer, and dataIndex.

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

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

### Calibration Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/Event.html

Represents a calibration event. This event can signify start, stop, or a marker.

```swift
case calibration = 36
```

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

### FitTime Initializer with Second Since Power Up

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FitTime.html

Initializes a FitTime instance using the time elapsed since the device powered up.

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

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

### Clean

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Clean exercise. Use this static property to get the corresponding enum value.

```Swift
static var clean: OlympicLiftExerciseName { get }
```

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

### Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the basic Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lunge: LungeExerciseName { get }
```

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

### VideoMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/VideoMessage.html

This snippet outlines the initializers for the VideoMessage class, allowing for object creation with or without initial property values.

```APIDOC
## VideoMessage Initializers

### Initializers

*   **init()** - Undocumented initializer.
*   **init(url:hostingProvider:duration:)** - Initializes a VideoMessage with optional URL, hosting provider, and duration.
```

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

### init(crcCheckingStrategy:dataMergingStrategy:)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FitFileMerger.html

Initializes a new FitFileMerger with specified CRC checking and data merging strategies. Defaults are applied if not provided.

```APIDOC
## init(crcCheckingStrategy:dataMergingStrategy:)

### Description
Initializes a new FitFileMerger with specified CRC checking and data merging strategies. Defaults are applied if not provided.

### Parameters
- **crcCheckingStrategy** (CrcCheckingStrategy) - Optional - The strategy to use for CRC Checking. Defaults to `.throws`.
- **dataMergingStrategy** (DataMergingStrategy) - Optional - The strategy to use for Data Merging. Defaults to `.default`.
```

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

### ValidityStrategy None

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FitFileEncoder/ValidityStrategy.html

The default strategy. Assumes the user knows which messages should be included for each file type.

```Swift
case none
```

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

### Off Course Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/Event.html

Represents an 'off course' event, used to start or stop tracking in Group 0.

```swift
case offCourse = 7
```

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

### create(rawValue:)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PushUpExerciseName.html

Creates a PushUpExerciseName object from a raw UInt16 value.

```APIDOC
## create(rawValue:)

### Description
Creates an ExerciseName object from a raw UInt16 value.

### Method
static create(rawValue: UInt16) -> PushUpExerciseName?

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

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

### Weighted Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Weighted Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var weightedLunge: LungeExerciseName { get }
```

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

### Lawnmower Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Lawnmower Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lawnmowerLunge: LungeExerciseName { get }
```

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

### FitTime Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FitTime.html

Initialize a FitTime instance using a Date and an optional local flag, or using a time interval since power up.

```swift
public init(date: Date, isLocal: Bool = false)
```

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

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

### Weight Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/Weight.html

Initializes a new Weight instance with a given weight measurement and a boolean indicating if it's being calculated.

```swift
public init(weight: Measurement<UnitMass>?, calculating: Bool)
```

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

### Gunslinger Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Gunslinger Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var gungslingerLunge: LungeExerciseName { get }
```

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

### FitFileDecoder Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FitFileDecoder.html

Initializes a FitFileDecoder with a specified CRC checking strategy. The strategy defaults to '.throws'.

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

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

### Dumbbell Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Dumbbell Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var dumbbellLunge: LungeExerciseName { get }
```

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

### connectIQWidgetDownload

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/ConnectivityCapabilities.html

Indicates support for downloading Connect IQ widgets.

```APIDOC
## connectIQWidgetDownload

### Description
Indicates support for downloading Connect IQ widgets.

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

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

### Connectivity Supported Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/CapabilitiesMessage.html

A property to get or set the supported connectivity capabilities. It is marked with @FitField and private to the set.

```swift
@FitField
        private(set) public var connectivity: ConnectivityCapabilities? { get set }
```

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

### DeviceSettingsMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/DeviceSettingsMessage.html

This section describes the initializers available for the DeviceSettingsMessage.

```APIDOC
## DeviceSettingsMessage Initializers

### Description
Initializes a new instance of DeviceSettingsMessage.

### Initializers
- **init()** - Initializes an instance with default values.
- **init(timeMode:backLightMode:activityTrackerEnabled:clockTime:pagesEnabled:moveAlertEnabled:dateMode:displayOrientation:mountingSide:defaultPage:autosyncMinimumSteps:autosyncMinimumTime:lactateThresholdAutodetectEnabled:bleAutoUploadEnabled:autoSyncFrequency:autoActivityDetect:numberOfScreens:smartNotificationDisplayOrientation:tapInterface:)** - Initializes an instance with specified device settings.
```

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

### Workouts Supported Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/CapabilitiesMessage.html

A property to get or set the supported workout capabilities. It is marked with @FitField and private to the set.

```swift
@FitField
        private(set) public var workouts: WorkoutCapabilities? { get set }
```

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

### Convenience Initializer for Device Settings

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/DeviceSettingsMessage.html

Initializes DeviceSettingsMessage with various configurable properties. All parameters are optional.

```Swift
public convenience init(timeMode: TimeMode? = nil,
                                backLightMode: BacklightMode? = nil,
                                activityTrackerEnabled: Bool? = nil,
                                clockTime: FitTime? = nil,
                                pagesEnabled: Enabled? = nil,
                                moveAlertEnabled: Bool? = nil,
                                dateMode: DateMode? = nil,
                                displayOrientation: DisplayOrientation? = nil,
                                mountingSide: Side? = nil,
                                defaultPage: Enabled? = nil,
                                autosyncMinimumSteps: UInt16? = nil,
                                autosyncMinimumTime: Measurement<UnitDuration>? = nil,
                                lactateThresholdAutodetectEnabled: Bool? = nil,
                                bleAutoUploadEnabled: Bool? = nil,
                                autoSyncFrequency: AutoSyncFrequency? = nil,
                                autoActivityDetect: AutoActivityDetect? = nil,
                                numberOfScreens: UInt8? = nil,
                                smartNotificationDisplayOrientation: DisplayOrientation? = nil,
                                tapInterface: Switch? = nil)
```

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

### Split Jerk

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Split Jerk exercise. Use this static property to get the corresponding enum value.

```Swift
static var splitJerk: OlympicLiftExerciseName { get }
```

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

### Push Jerk

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Push Jerk exercise. Use this static property to get the corresponding enum value.

```Swift
static var pushJerk: OlympicLiftExerciseName { get }
```

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

### SoftwareMessage Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/SoftwareMessage.html

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

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

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

### Dumbbell Clean

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Dumbbell Clean exercise. Use this static property to get the corresponding enum value.

```Swift
static var dumbbellClean: OlympicLiftExerciseName { get }
```

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

### WorkoutStepMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/WorkoutStepMessage.html

This snippet shows the available initializers for the WorkoutStepMessage class.

```APIDOC
## WorkoutStepMessage Initializers

### Description
Initializes a new instance of the WorkoutStepMessage class.

### Initializers

- **init()** - Undocumented initializer.
- **init(messageIndex:name:duration:durationType:target:targetLow:targetHigh:targetType:category:intensity:notes:equipment:)** - Undocumented initializer with multiple parameters.
```

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

### Barbell Snatch

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Snatch exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellSnatch: OlympicLiftExerciseName { get }
```

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

### Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/FileCapabilitiesMessage.html

Initializes a new instance of FileCapabilitiesMessage with optional parameters for message index, file type, file flags, directory, max count, and max size.

```swift
public convenience init(messageIndex: MessageIndex? = nil,
                                fileType: FileType? = nil,
                                fileFlags: FitFileFlag? = nil,
                                directory: String? = nil,
                                maxCount: UInt16? = nil,
                                maxSize: UInt32? = nil)
```

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

### Clean and Jerk

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Clean and Jerk exercise. Use this static property to get the corresponding enum value.

```Swift
static var cleanJerk: OlympicLiftExerciseName { get }
```

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

### Instant Input Capability

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/ConnectivityCapabilities.html

Represents the Instant Input capability.

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

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

### extdConfiguration

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FileType.html

Represents Extended Configuration files. Supports read and write operations.

```APIDOC
## extdConfiguration

### Description
Extd Configuration files. Supports read/write/erase operations.

### Declaration
```swift
static let extdConfiguration: FileType
```
```

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

### Elevation Low Alert Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/Event.html

Represents an elevation low alert event. It starts and stops when in the alert condition.

```swift
case elevationLowAlert = 46
```

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

### Initialize CourseMessage

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/CourseMessage.html

Initializes a new instance of the CourseMessage class. This is a required initializer.

```swift
public required init()
```

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

### Elevation High Alert Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/Event.html

Represents an elevation high alert event. It starts and stops when in the alert condition.

```swift
case elevationHighAlert = 45
```

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

### FitTime Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FitTime.html

The FitTime structure can be initialized using a Date and an optional boolean for local time, or by specifying the time since power up.

```APIDOC
## FitTime Initializers

### Description
Initializes a FitTime object.

### Initializers

- **init(date: Date, isLocal: Bool = false)**: Initializes with a specific date and a flag for local time.
- **init(secondSincePowerUp: TimeInterval)**: Initializes with the time elapsed since device power up.
```

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

### Workout Step Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/Event.html

Marks the start of a workout step or the end of each step. Used for detailed workout progression.

```swift
case workoutStep = 4
```

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

### DeviceIndex Initializer (isCreator)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/DeviceIndex.html

Initializes a DeviceIndex instance, specifying if it is a file creator.

```swift
public init(isCreator: Bool)
```

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

### Get String Value of SourceType

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/SourceType.html

Provides a string representation of the SourceType. This computed property is useful for debugging and display purposes.

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

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

### Get Global Message Number for CourseMessage

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/CourseMessage.html

Retrieves the FIT message global number for the CourseMessage class. This is a static method.

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

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

### JumpMessage Initializer with Parameters

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/JumpMessage.html

Initializes a new JumpMessage instance with provided jump data.

```swift
public init(timeStamp: FitTime? = nil,
              distance: Measurement<UnitLength>? = nil,
              height: Measurement<UnitLength>? = nil,
              rotations: UInt8? = nil,
              hangTime: Measurement<UnitDuration>? = nil,
              score: Float32? = nil,
              position: Position? = nil,
              speed: Measurement<UnitSpeed>? = nil)
```

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

### Offset Dumbbell Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Offset Dumbbell Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var offsetDumbbellLunge: LungeExerciseName { get }
```

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

### Connect IQ Widget Download Capability

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/ConnectivityCapabilities.html

Represents the capability for Connect IQ widget downloads.

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

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

### Lunge with Side Bend

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Lunge with Side Bend exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lungeSideBend: LungeExerciseName { get }
```

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

### WarmUpExerciseName Supported List

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/WarmUpExerciseName.html

Returns a list of all supported WarmUpExerciseName instances.

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

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

### Lunge with Diagonal Reach

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Lunge with Diagonal Reach exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lungeDiagonalReach: LungeExerciseName { get }
```

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

### Lunge with Arm Reach

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Lunge with Arm Reach exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lungeArmReach: LungeExerciseName { get }
```

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

### audioPrompts

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/ConnectivityCapabilities.html

Indicates support for audio prompts.

```APIDOC
## audioPrompts

### Description
Indicates support for audio prompts.

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

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

### RunExerciseName Create Method

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/RunExerciseName.html

Creates a RunExerciseName object from a raw UInt16 value. Returns an optional RunExerciseName.

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

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

### Dumbbell Side Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Dumbbell Side Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var dumbbellSideLunge: LungeExerciseName { get }
```

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

### UserProfileMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/UserProfileMessage.html

Details the available initializers for creating instances of UserProfileMessage.

```APIDOC
## UserProfileMessage Initializers

### Description
Initializes a new instance of the UserProfileMessage class.

### Initializers
- **init()**: Undocumented initializer.
- **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:)**: Undocumented initializer with numerous parameters.
```

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

### Dumbbell Lunge and Rotation

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Dumbbell Lunge and Rotation exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var dumbbellLungeRotation: LungeExerciseName { get }
```

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

### Dumbbell Diagonal Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Dumbbell Diagonal Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var dumbbellDiagonalLunge: LungeExerciseName { get }
```

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

### FileCapabilitiesMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/FileCapabilitiesMessage.html

This section describes the initializers available for creating instances of the FileCapabilitiesMessage class.

```APIDOC
## FileCapabilitiesMessage Initializers

### init()

Undocumented initializer.

### init(messageIndex:fileType:fileFlags:directory:maxCount:maxSize:)

Convenience initializer for creating a FileCapabilitiesMessage with specified properties.

- **messageIndex** (MessageIndex?) - Optional - The message index.
- **fileType** (FileType?) - Optional - The file type.
- **fileFlags** (FitFileFlag?) - Optional - The file flags.
- **directory** (String?) - Optional - The directory path.
- **maxCount** (UInt16?) - Optional - The maximum count.
- **maxSize** (UInt32?) - Optional - The maximum size.
```

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

### Dumbbell Hang Pull

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Dumbbell Hang Pull exercise. Use this static property to get the corresponding enum value.

```Swift
static var dumbbellHangPull: OlympicLiftExerciseName { get }
```

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

### Initialize FileCreatorMessage with Versions

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/FileCreatorMessage.html

Initializes a new instance of FileCreatorMessage with optional software and hardware versions.

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

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

### Barbell Split Jerk

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Split Jerk exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellSplitJerk: OlympicLiftExerciseName { get }
```

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

### DeviceIndex Initializer (index)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/DeviceIndex.html

Initializes a DeviceIndex instance with a specific index value.

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

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

### Barbell High Pull

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell High Pull exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellHighPull: OlympicLiftExerciseName { get }
```

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

### ExerciseTitleMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/ExerciseTitleMessage.html

This snippet outlines the initializers for the ExerciseTitleMessage class, allowing for the creation of new instances with specified properties.

```APIDOC
## ExerciseTitleMessage Initializers

### Initializers

*   **init()** - Initializes a new instance of ExerciseTitleMessage.
*   **init(messageIndex:stepName:category:exerciseName:)** - Initializes a new instance of ExerciseTitleMessage with provided values for message index, step name, category, and exercise name.
```

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

### Initializer with Stress Level and Time

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/StressLevelMessage.html

Initializes a new StressLevelMessage with optional stress level and time calculated values.

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

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

### Barbell Hang Pull

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Hang Pull exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellHangPull: OlympicLiftExerciseName { get }
```

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

### SquatExerciseName Static Properties and Methods

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/SquatExerciseName.html

This section details the static properties and methods available for the SquatExerciseName structure.

```APIDOC
## SquatExerciseName Static Members

### Static Properties

*   **supportedExerciseNames** ([SquatExerciseName]) - A list of all supported SquatExerciseName instances.

### Static Methods

*   **create(rawValue:)** (SquatExerciseName?) -> Creates a SquatExerciseName object from a raw UInt16 value.
    
    #### Parameters
    
    *   `rawValue` (UInt16) - The raw value to create the ExerciseName object from.
    
    #### Return Value
    
    An optional SquatExerciseName object if the raw value is valid, otherwise nil.
```

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

### Barbell Squat Clean

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Squat Clean exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellSquatClean: OlympicLiftExerciseName { get }
```

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

### Barbell Power Snatch

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Power Snatch exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellPowerSnatch: OlympicLiftExerciseName { get }
```

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

### Convenience Initializer for GoalMessage

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/GoalMessage.html

Initializes a new instance of GoalMessage with specified properties. All properties are optional and default to nil.

```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)
```

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

### Barbell Power Clean

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/OlympicLiftExerciseName.html

Represents the Barbell Power Clean exercise. Use this static property to get the corresponding enum value.

```Swift
static var barbellPowerClean: OlympicLiftExerciseName { get }
```

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

### GoalMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/GoalMessage.html

This snippet shows the available initializers for the GoalMessage class.

```APIDOC
## GoalMessage Initializers

### Description

Initializes a new instance of the GoalMessage class.

### Initializers

- **init()**
  - Undocumented initializer.

- **init(messageIndex:startDate:endDate:sport:subSport:goalType:goalValue:repeatGoal:targetValue:recurrence:recurrenceValue:enabled:source:)**
  - Undocumented convenience initializer that allows setting all properties upon creation.
```

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

### SquatExerciseName Properties and Methods

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/SquatExerciseName.html

Provides details on the properties and static methods available for the SquatExerciseName structure.

```APIDOC
## SquatExerciseName

### Description
Represents a Squat exercise name within the FitDataProtocol. This structure conforms to the `ExerciseName` protocol and is hashable.

### Properties

*   **catagory** (ExerciseCategory) - Read-only. Returns the category type of the exercise.
*   **name** (String) - Read-only, private-set. Returns the name of the exercise.
*   **number** (UInt16) - Read-only, private-set. Returns the number associated with the exercise name.

### Type Aliases

*   **ExerciseNameType** (SquatExerciseName) - An alias for `SquatExerciseName`, representing the exercise name type.

### Static Properties

*   **supportedExerciseNames** ([SquatExerciseName]) - Read-only. A static property that returns an array of all supported `SquatExerciseName` instances.

### Static Methods

## create(rawValue:)

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

### Method

static func create(rawValue: UInt16) -> SquatExerciseName?

### Parameters

#### Path Parameters

*   **rawValue** (UInt16) - The raw value to create the `SquatExerciseName` from.

### Return Value

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

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

### Accessing UnitFitFlow Instance

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/UnitFitFlow.html

Use the static 'flow' property to get an instance of UnitFitFlow. This is the primary way to interact with the UnitFitFlow class.

```swift
public class var flow: UnitFitFlow { get }
```

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

### Calorie Duration Alert Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/Event.html

Represents a calorie duration alert event. It starts if enabled mid-activity and stops when the duration is reached.

```swift
case calorieDurationAlert = 25
```

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

### CoursePointMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/CoursePointMessage.html

This snippet shows the available initializers for the CoursePointMessage class, including a default initializer and a convenience initializer for setting multiple properties.

```APIDOC
## CoursePointMessage Initializers

### Description
Initializers for creating `CoursePointMessage` objects.

### Initializers

*   `init()` - Default initializer.
*   `init(timeStamp:messageIndex:name:position:distance:pointType:isFavorite:)` - Convenience initializer to set multiple properties at once.
```

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

### Distance Duration Alert Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Enums/Event.html

Represents a distance duration alert event. It starts if enabled mid-activity and stops when the duration is reached.

```swift
case distanceDurationAlert = 24
```

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

### Supported HyperextensionExerciseNames

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/HyperextensionExerciseName.html

Returns a list of all supported hyperextension exercise names.

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

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

### Time Duration Alert Event

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Enums/Event.html

Handles time duration alerts. Starts if enabled mid-activity and stops when the duration is reached or disabled.

```swift
case timeDurationAlert = 23
```

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

### Initialize FitFileEncoder

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FitFileEncoder.html

Initializes a FitFileEncoder with a specified data validity strategy. Defaults to .none if not provided.

```swift
public init(dataValidityStrategy: ValidityStrategy = .none)
```

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

### WarmUpExerciseName Properties and Methods

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/WarmUpExerciseName.html

This snippet details the properties and static methods available for the WarmUpExerciseName structure, allowing for the representation and creation of warm-up exercise names.

```APIDOC
## WarmUpExerciseName

### Description
Represents a warm-up exercise name within the FitDataProtocol.

### Properties

*   **catagory** (ExerciseCategory) - Gets the exercise category type.
*   **name** (String) - Gets the exercise name.
*   **number** (UInt16) - Gets the exercise name number.

### Static Properties

*   **supportedExerciseNames** ([WarmUpExerciseName]) - Gets a list of all supported warm-up exercise names.

### Static Methods

## create(rawValue:)

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

### Method

Static Function

### Parameters

#### Path Parameters

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

### Return Value

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

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

### Install FitDataProtocol via Swift Package Manager

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/README.md

Add the FitDataProtocol package to your project's dependencies in Swift Package Manager.

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

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

### LanguageCapabilities Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LanguageCapabilities.html

Initializes a LanguageCapabilities instance with optional bit fields for language capabilities. Bits 0 through 3 are optional, while bits4 is required.

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

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

### Kettlebell Flye Exercise Name

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FlyeExerciseName.html

Represents the 'Kettlebell Flye' exercise type. Use this static property to get the corresponding FlyeExerciseName value.

```swift
static var kettlebellFlye: FlyeExerciseName { get }
```

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

### Convenience Initializer for RecordMessage

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/RecordMessage.html

Initializes a new instance of RecordMessage with a comprehensive set of optional parameters.

```swift
public convenience init(timeStamp: FitTime? = nil,
                                position: Position? = nil,
                                distance: Measurement<UnitLength>? = nil,
                                timeFromCourse: Measurement<UnitDuration>? = nil,
                                cycles: UInt8? = nil,
                                totalCycles: UInt32? = nil,
                                accumulatedPower: Measurement<UnitPower>? = nil,
                                altitude: Measurement<UnitLength>? = nil,
                                speed: Measurement<UnitSpeed>? = nil,
                                power: Measurement<UnitPower>? = nil,
                                leftRightBalance: LeftRightBalance? = nil,
                                gpsAccuracy: UInt8? = nil,
                                verticalSpeed: Measurement<UnitSpeed>? = nil,
                                calories: Measurement<UnitEnergy>? = nil,
                                verticalOscillation: StanceTime? = nil,
                                stanceTime: StanceTime? = nil,
                                heartRate: Measurement<Unit<UnitLabel>>? = nil,
                                cadence: Measurement<UnitCadence>? = nil,
                                grade: Measurement<UnitPercent>? = nil,
                                resistance: Measurement<UnitPercent>? = nil,
                                cycleLength: Measurement<UnitLength>? = nil,
                                temperature: Measurement<UnitTemperature>? = nil,
                                activity: ActivityType? = nil,
                                torqueEffectiveness: TorqueEffectiveness? = nil,
                                pedalSmoothness: PedalSmoothness? = nil,
                                stroke: Stroke? = nil,
                                zone: UInt8? = nil,
                                ballSpeed: Measurement<Unit<UnitLabel>>? = nil,
                                fractionalCadence: Measurement<Unit<UnitLabel>>? = nil,
                                saturatedHemoglobinPercent: HemoglobinPercent? = nil,
                                minMaxSaturatedHemoglobinPercent: HemoglobinPercent? = nil,
                                deviceIndex: DeviceIndex? = nil,
                                grit: Measurement<UnitFitGrit>? = nil,
                                flow: Measurement<UnitFitFlow>? = nil)
```

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

### Dumbbell Flye Exercise Name

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FlyeExerciseName.html

Represents the 'Dumbbell Flye' exercise type. Use this static property to get the corresponding FlyeExerciseName value.

```swift
static var dumbbellFlye: FlyeExerciseName { get }
```

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

### Cable Crossover Exercise Name

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FlyeExerciseName.html

Represents the 'Cable Crossover' exercise type. Use this static property to get the corresponding FlyeExerciseName value.

```swift
static var cableCrossover: FlyeExerciseName { get }
```

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

### MetZoneMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/MetZoneMessage.html

This section describes the available initializers for the MetZoneMessage class, including the default initializer and a convenience initializer for setting multiple properties.

```APIDOC
## MetZoneMessage Initializers

### init()

Undocumented.

#### Declaration

```swift
public required init()
```

### init(messageIndex:heartRate:calories:fatCalories:)

Undocumented.

#### Declaration

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

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

### SessionMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/SessionMessage.html

Provides documentation for the initializers of the SessionMessage class.

```APIDOC
## SessionMessage Initializers

### Description
Documentation for the initializers of the `SessionMessage` class.

### Initializers

*   **init()**
    *   Description: Initializes a `SessionMessage` with a default `sportIndex`.
    *   Declaration: `public required init()`

*   **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:)**
    *   Description: Undocumented initializer for `SessionMessage`.
    *   Declaration: `public convenience init(timeStamp: FitTime? = nil, messageIndex: MessageIndex? = nil, event: Event? = nil, eventType: EventType? = nil, startTime: FitTime? = nil, startPosition: Position? = nil, sport: Sport? = nil, subSport: SubSport? = nil, totalElapsedTime: Measurement<UnitDuration>? = nil, totalTimerTime: Measurement<UnitDuration>? = nil, ...)`
```

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

### Accessing kiloGrit Unit

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/UnitFitGrit.html

Use this static property to get the `UnitFitGrit` instance representing kiloGrit. This is the primary way to access the unit for calculations.

```swift
public class var kiloGrit: UnitFitGrit { get }
```

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

### Weighted Swiss Ball Crunch

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/CrunchExerciseName.html

Represents the weighted Swiss ball crunch exercise. Use this static property to get the enum case.

```swift
static var weightedSwissBallCrunch: CrunchExerciseName { get }
```

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

### CapabilitiesMessage Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/CapabilitiesMessage.html

Initializes a CapabilitiesMessage with optional language, sport, workout, and connectivity capabilities.

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

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

### WeatherAlertMessage Initializers

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Classes/WeatherAlertMessage.html

This snippet shows the available initializers for the WeatherAlertMessage class, allowing for object creation with or without initial values.

```APIDOC
## WeatherAlertMessage Initializers

### Description
Initializes a new instance of the WeatherAlertMessage class.

### Initializers

*   **init()** - Initializes an empty WeatherAlertMessage.
*   **init(timeStamp:reportID:issueTime:expireTime:severity:alertType:)** - Initializes a WeatherAlertMessage with provided values for timestamp, report ID, issue time, expire time, severity, and alert type. All parameters are optional.
```

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

### FitFieldDimension Wrapped Value Property

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/FitFieldDimension.html

Represents the wrapped value of the property wrapper, which is an optional Measurement of type U. This property can be get and set.

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

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

### PlyoExerciseName Supported Exercises

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/PlyoExerciseName.html

Retrieves a list of all supported PlyoExerciseName instances.

```APIDOC
## PlyoExerciseName Supported Exercises

### Description
Returns a list of all exercise names that are supported by the PlyoExerciseName type.

### Declaration

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

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

### Workout File Type

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FileType.html

Represents the workout file, which is read/write/erase and supports multiple files. Use this to describe structured activities and guide users through them.

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

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

### Overhead Bulgarian Split Squat

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Overhead Bulgarian Split Squat exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var overheadBulgarianSplitSquat: LungeExerciseName { get }
```

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

### activitySummary

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/FileType.html

Represents Activity Summary files, which are a compact version of activity files. Supports read and erase operations.

```APIDOC
## activitySummary

### Description
Activity Summary files are a compact version of the activity file. Supports read/erase operations.

### Declaration
```swift
static let activitySummary: FileType
```
```

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

### Offset Dumbbell Reverse Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Offset Dumbbell Reverse Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var offsetDumbbellReverseLunge: LungeExerciseName { get }
```

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

### FlyeExerciseName.create(rawValue:)

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/FlyeExerciseName.html

Creates a FlyeExerciseName object from a raw UInt16 value.

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

### Description
Creates an `ExerciseName` object from a raw UInt16 value.

### Declaration
```swift
static func create(rawValue: UInt16) -> FlyeExerciseName?
```

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

### Return Value
An optional `FlyeExerciseName` object if the raw value is valid, otherwise nil.
```

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

### PushUpExerciseName Create Method

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Structs/PushUpExerciseName.html

A static method to create a PushUpExerciseName object from a raw UInt16 value. Returns an optional PushUpExerciseName.

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

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

### Low Side to Side Lunge

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Low Side to Side Lunge exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lowSideToSideLunge: LungeExerciseName { get }
```

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

### Low Lunge with Isometric Adduction

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/docsets/FitDataProtocol.docset/Contents/Resources/Documents/Structs/LungeExerciseName.html

Represents the Low Lunge with Isometric Adduction exercise. Use this static property to get the corresponding `LungeExerciseName` instance.

```swift
static var lowLungeIsometricAdduction: LungeExerciseName { get }
```

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

### Convenience Initializer

Source: https://github.com/fitnesskit/fitdataprotocol/blob/master/docs/Classes/CadenceZoneMessage.html

A convenience initializer for CadenceZoneMessage that allows setting the messageIndex, name, and highLevel. Default values are provided for optional parameters.

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