fit-file-parser 2.3.3 → 3.0.1

package/dist/cjs/fit_types.d.ts

@@ -16,7 +16,7 @@ export interface MessageIndex {
     selected: boolean;
 }
 export type File = 'device' | 'settings' | 'sport' | 'activity' | 'workout' | 'course' | 'schedules' | 'weight' | 'totals' | 'goals' | 'blood_pressure' | 'monitoring_a' | 'activity_summary' | 'monitoring_daily' | 'monitoring_b' | 'segment' | 'segment_list' | 'exd_configuration' | 'mfg_range_min' | 'mfg_range_max';
-export type MesgNum = 'file_id' | 'capabilities' | 'device_settings' | 'user_profile' | 'hrm_profile' | 'sdm_profile' | 'bike_profile' | 'zones_target' | 'hr_zone' | 'power_zone' | 'met_zone' | 'sport' | 'goal' | 'session' | 'lap' | 'record' | 'event' | 'device_info' | 'workout' | 'workout_step' | 'schedule' | 'weight_scale' | 'course' | 'course_point' | 'totals' | 'activity' | 'software' | 'file_capabilities' | 'mesg_capabilities' | 'field_capabilities' | 'file_creator' | 'blood_pressure' | 'speed_zone' | 'monitoring' | 'training_file' | 'hrv' | 'ant_rx' | 'ant_tx' | 'ant_channel_id' | 'length' | 'monitoring_info' | 'pad' | 'slave_device' | 'connectivity' | 'weather_conditions' | 'weather_alert' | 'cadence_zone' | 'hr' | 'activity_metrics' | 'segment_lap' | 'memo_glob' | 'segment_id' | 'segment_leaderboard_entry' | 'segment_point' | 'segment_file' | 'workout_session' | 'watchface_settings' | 'gps_metadata' | 'camera_event' | 'timestamp_correlation' | 'gyroscope_data' | 'accelerometer_data' | 'three_d_sensor_calibration' | 'video_frame' | 'obdii_data' | 'nmea_sentence' | 'aviation_attitude' | 'video' | 'video_title' | 'video_description' | 'video_clip' | 'exd_screen_configuration' | 'exd_data_field_configuration' | 'exd_data_concept_configuration' | 'field_description' | 'developer_data_id' | 'magnetometer_data' | 'barometer_data' | 'one_d_sensor_calibration' | 'time_in_zone' | 'set' | 'stress_level' | 'dive_settings' | 'dive_gas' | 'dive_alarm' | 'exercise_title' | 'dive_summary' | 'jump' | 'climb_pro' | 'tank_update' | 'tank_summary' | 'o_hr_settings' | 'mfg_range_min' | 'mfg_range_max' | 'definition';
+export type MesgNum = 'file_id' | 'capabilities' | 'device_settings' | 'user_profile' | 'hrm_profile' | 'sdm_profile' | 'bike_profile' | 'zones_target' | 'hr_zone' | 'power_zone' | 'met_zone' | 'sport' | 'goal' | 'session' | 'lap' | 'record' | 'event' | 'device_info' | 'workout' | 'workout_step' | 'schedule' | 'weight_scale' | 'course' | 'course_point' | 'totals' | 'activity' | 'software' | 'file_capabilities' | 'mesg_capabilities' | 'field_capabilities' | 'file_creator' | 'blood_pressure' | 'speed_zone' | 'monitoring' | 'training_file' | 'hrv' | 'user_metrics' | 'ant_rx' | 'ant_tx' | 'ant_channel_id' | 'length' | 'monitoring_info' | 'pad' | 'slave_device' | 'connectivity' | 'weather_conditions' | 'weather_alert' | 'cadence_zone' | 'hr' | 'activity_metrics' | 'segment_lap' | 'memo_glob' | 'segment_id' | 'segment_leaderboard_entry' | 'segment_point' | 'segment_file' | 'workout_session' | 'watchface_settings' | 'gps_metadata' | 'camera_event' | 'timestamp_correlation' | 'gyroscope_data' | 'accelerometer_data' | 'three_d_sensor_calibration' | 'video_frame' | 'obdii_data' | 'nmea_sentence' | 'aviation_attitude' | 'video' | 'video_title' | 'video_description' | 'video_clip' | 'exd_screen_configuration' | 'exd_data_field_configuration' | 'exd_data_concept_configuration' | 'field_description' | 'developer_data_id' | 'magnetometer_data' | 'barometer_data' | 'one_d_sensor_calibration' | 'time_in_zone' | 'set' | 'stress_level' | 'dive_settings' | 'dive_gas' | 'dive_alarm' | 'exercise_title' | 'dive_summary' | 'jump' | 'split' | 'split_summary' | 'climb_pro' | 'tank_update' | 'tank_summary' | 'o_hr_settings' | 'mfg_range_min' | 'mfg_range_max' | 'definition';
 export type Checksum = 'clear' | 'ok';
 export type FileFlags = '0' | 'read' | 'write' | 'erase';
 export type MesgCount = 'num_per_file' | 'max_per_file' | 'max_per_file_type';
@@ -105,6 +105,7 @@ export type SegmentLapStatus = 'end' | 'fail';
 export type SegmentLeaderboardType = 'overall' | 'personal_best' | 'connections' | 'group' | 'challenger' | 'kom' | 'qom' | 'pr' | 'goal' | 'rival' | 'club_leader';
 export type SegmentDeleteStatus = 'do_not_delete' | 'delete_one' | 'delete_all';
 export type SegmentSelectionType = 'starred' | 'suggested';
+export type SplitType = 'ascent_split' | 'descent_split' | 'interval_active' | 'interval_rest' | 'interval_warmup' | 'interval_cooldown' | 'interval_recovery' | 'interval_other' | 'climb_active' | 'climb_rest' | 'surf_active' | 'run_active' | 'run_rest' | 'workout_round' | 'rwd_run' | 'rwd_walk' | 'windsurf_active' | 'rwd_stand' | 'transition' | 'ski_lift_split' | 'ski_run_split';
 export type SourceType = 'ant' | 'antplus' | 'bluetooth' | 'bluetooth_low_energy' | 'wifi' | 'local';
 export type DisplayOrientation = 'auto' | 'portrait' | 'landscape' | 'portrait_flipped' | 'landscape_flipped';
 export type WorkoutEquipment = 'none' | 'swim_fins' | 'swim_kickboard' | 'swim_paddles' | 'swim_pull_buoy' | 'swim_snorkel';
@@ -465,6 +466,9 @@ export interface ParsedSession {
     workout_feel?: number;
     workout_rpe?: number;
     resting_calories?: number;
+    beginning_potential_stamina?: number;
+    ending_potential_stamina?: number;
+    min_stamina?: number;
     timestamp: string;
     message_index?: MessageIndex;
     laps?: ParsedLap[];
@@ -648,6 +652,8 @@ export interface ParsedRecord {
     n2_load?: number;
     grit?: number;
     flow?: number;
+    potential_stamina?: number;
+    stamina?: number;
     timestamp: string;
 }
 export interface ParsedEvent {
@@ -762,6 +768,8 @@ export interface ParsedActivity {
     developer_data_ids?: ParsedDeveloperDataId[];
     field_descriptions?: ParsedFieldDescription[];
     sports?: ParsedSport[];
+    splits?: ParsedSplit[];
+    split_summaries?: ParsedSplitSummary[];
 }
 export interface ParsedSoftware {
     version?: number;
@@ -841,6 +849,22 @@ export interface ParsedMonitoring {
 export interface ParsedHrv {
     time?: number[];
 }
+export interface ParsedUserMetrics {
+    vo2_max?: number;
+    age?: number;
+    height?: number;
+    weight?: number;
+    gender?: Gender;
+    max_heart_rate?: number;
+    remaining_recovery_time?: number;
+    lthr?: number;
+    ltpower?: number;
+    ltspeed?: number;
+    start_of_activity?: string;
+    first_vo2_max?: number;
+    end_of_previous_activity?: string;
+    timestamp: string;
+}
 export interface ParsedLength {
     event?: Event;
     event_type?: EventType;
@@ -994,6 +1018,48 @@ export interface ParsedJump {
     enhanced_speed?: number;
     timestamp: string;
 }
+export interface ParsedSplit {
+    split_type?: SplitType;
+    total_elapsed_time?: number;
+    total_timer_time?: number;
+    total_distance?: number;
+    avg_speed?: number;
+    start_time: string;
+    total_ascent?: number;
+    total_descent?: number;
+    start_position_lat?: number;
+    start_position_long?: number;
+    end_position_lat?: number;
+    end_position_long?: number;
+    max_speed?: number;
+    avg_vert_speed?: number;
+    end_time?: string;
+    total_calories?: number;
+    start_elevation?: number;
+    active_time?: number;
+    beginning_potential_stamina?: number;
+    ending_potential_stamina?: number;
+    min_stamina?: number;
+    total_moving_time?: number;
+    message_index?: MessageIndex;
+}
+export interface ParsedSplitSummary {
+    split_type?: SplitType;
+    num_splits?: number;
+    total_timer_time?: number;
+    total_distance?: number;
+    avg_speed?: number;
+    max_speed?: number;
+    total_ascent?: number;
+    total_descent?: number;
+    avg_heart_rate?: number;
+    max_heart_rate?: number;
+    avg_vert_speed?: number;
+    total_calories?: number;
+    active_time?: number;
+    total_moving_time?: number;
+    message_index?: MessageIndex;
+}
 export interface ParsedTankUpdate {
     sensor?: number;
     pressure?: number;
@@ -1038,6 +1104,9 @@ export interface ParsedFit {
     tank_updates?: ParsedTankUpdate[];
     tank_summaries?: ParsedTankSummary[];
     jumps?: ParsedJump[];
+    splits?: ParsedSplit[];
+    split_summaries?: ParsedSplitSummary[];
     time_in_zone?: ParsedTimeInZone[];
     activity_metrics?: ParsedActivityMetrics[];
+    user_metrics?: ParsedUserMetrics[];
 }

package/dist/cjs/type_generator.js

@@ -180,6 +180,8 @@ function generateAdditionalFields(msg) {
             developer_data_ids: 'parsed_developer_data_id',
             field_descriptions: 'parsed_field_description',
             sports: 'parsed_sport',
+            splits: 'parsed_split',
+            split_summaries: 'parsed_split_summary',
         };
         return Object.keys(props).map(prop => generateArrayProperty(prop, typescript_1.default.factory.createTypeReferenceNode(snakeToCamel(props[prop]))));
     }
@@ -209,8 +211,11 @@ function generateFitType() {
         tank_updates: 'parsed_tank_update',
         tank_summaries: 'parsed_tank_summary',
         jumps: 'parsed_jump',
+        splits: 'parsed_split',
+        split_summaries: 'parsed_split_summary',
         time_in_zone: 'parsed_time_in_zone',
         activity_metrics: 'parsed_activity_metrics',
+        user_metrics: 'parsed_user_metrics',
     };
     const referenceProperties = {
         file_creator: 'parsed_file_creator',

package/dist/fit-parser.js

@@ -100,8 +100,11 @@ export default class FitParser {
         const tank_updates = [];
         const tank_summaries = [];
         const jumps = [];
+        const splits = [];
+        const split_summaries = [];
         const time_in_zone = [];
         const activity_metrics = [];
+        const user_metrics = [];
         let loopIndex = headerLength;
         const messageTypes = [];
         const developerFields = [];
@@ -200,12 +203,21 @@ export default class FitParser {
                 case 'jump':
                     jumps.push(message);
                     break;
+                case 'split':
+                    splits.push(message);
+                    break;
+                case 'split_summary':
+                    split_summaries.push(message);
+                    break;
                 case 'time_in_zone':
                     time_in_zone.push(message);
                     break;
                 case 'activity_metrics':
                     activity_metrics.push(message);
                     break;
+                case 'user_metrics':
+                    user_metrics.push(message);
+                    break;
                 default:
                     if (messageType !== '') {
                         fitObj[messageType] = message;
@@ -226,8 +238,11 @@ export default class FitParser {
         fitObj.tank_updates = tank_updates;
         fitObj.tank_summaries = tank_summaries;
         fitObj.jumps = jumps;
+        fitObj.splits = splits;
+        fitObj.split_summaries = split_summaries;
         fitObj.time_in_zone = time_in_zone;
         fitObj.activity_metrics = activity_metrics;
+        fitObj.user_metrics = user_metrics;
         if (isCascadeNeeded) {
             laps = mapDataIntoLap(laps, 'records', records);
             laps = mapDataIntoLap(laps, 'lengths', lengths);
@@ -236,7 +251,9 @@ export default class FitParser {
                 sessions,
                 events,
                 hrv,
-                device_infos, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports });
+                device_infos, developer_data_ids: applications, field_descriptions: fieldDescriptions, sports,
+                splits,
+                split_summaries });
         }
         if (!isModeCascade) {
             fitObj.sessions = sessions;

package/dist/fit.js

@@ -1773,6 +1773,27 @@ export const FIT = {
                 offset: 0,
                 units: 'kcal',
             },
+            205: {
+                field: 'beginning_potential_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            206: {
+                field: 'ending_potential_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            207: {
+                field: 'min_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
             214: {
                 field: 'avg_grit',
                 type: 'float32',
@@ -3001,6 +3022,292 @@ export const FIT = {
                 offset: 0,
                 units: 'percent',
             },
+            137: {
+                field: 'potential_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            138: {
+                field: 'stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+        },
+        312: {
+            name: 'split',
+            254: {
+                field: 'message_index',
+                type: 'message_index',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            0: {
+                field: 'split_type',
+                type: 'split_type',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            1: {
+                field: 'total_elapsed_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            2: {
+                field: 'total_timer_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            3: {
+                field: 'total_distance',
+                type: 'uint32',
+                scale: 100,
+                offset: 0,
+                units: 'm',
+            },
+            4: {
+                field: 'avg_speed',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            9: {
+                field: 'start_time',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            13: {
+                field: 'total_ascent',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'm',
+            },
+            14: {
+                field: 'total_descent',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'm',
+            },
+            21: {
+                field: 'start_position_lat',
+                type: 'sint32',
+                scale: null,
+                offset: 0,
+                units: 'semicircles',
+            },
+            22: {
+                field: 'start_position_long',
+                type: 'sint32',
+                scale: null,
+                offset: 0,
+                units: 'semicircles',
+            },
+            23: {
+                field: 'end_position_lat',
+                type: 'sint32',
+                scale: null,
+                offset: 0,
+                units: 'semicircles',
+            },
+            24: {
+                field: 'end_position_long',
+                type: 'sint32',
+                scale: null,
+                offset: 0,
+                units: 'semicircles',
+            },
+            25: {
+                field: 'max_speed',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            26: {
+                field: 'avg_vert_speed',
+                type: 'sint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            27: {
+                field: 'end_time',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            28: {
+                field: 'total_calories',
+                type: 'uint32',
+                scale: null,
+                offset: 0,
+                units: 'kcal',
+            },
+            74: {
+                field: 'start_elevation',
+                type: 'uint32',
+                scale: 5,
+                offset: -500,
+                units: 'm',
+            },
+            78: {
+                field: 'active_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            107: {
+                field: 'beginning_potential_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            108: {
+                field: 'ending_potential_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            109: {
+                field: 'min_stamina',
+                type: 'uint8',
+                scale: 1,
+                offset: 0,
+                units: 'percent',
+            },
+            110: {
+                field: 'total_moving_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+        },
+        313: {
+            name: 'split_summary',
+            254: {
+                field: 'message_index',
+                type: 'message_index',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            0: {
+                field: 'split_type',
+                type: 'split_type',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            3: {
+                field: 'num_splits',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            4: {
+                field: 'total_timer_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            5: {
+                field: 'total_distance',
+                type: 'uint32',
+                scale: 100,
+                offset: 0,
+                units: 'm',
+            },
+            6: {
+                field: 'avg_speed',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            7: {
+                field: 'max_speed',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            8: {
+                field: 'total_ascent',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'm',
+            },
+            9: {
+                field: 'total_descent',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'm',
+            },
+            10: {
+                field: 'avg_heart_rate',
+                type: 'uint8',
+                scale: null,
+                offset: 0,
+                units: 'bpm',
+            },
+            11: {
+                field: 'max_heart_rate',
+                type: 'uint8',
+                scale: null,
+                offset: 0,
+                units: 'bpm',
+            },
+            12: {
+                field: 'avg_vert_speed',
+                type: 'sint32',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            13: {
+                field: 'total_calories',
+                type: 'uint32',
+                scale: null,
+                offset: 0,
+                units: 'kcal',
+            },
+            65: {
+                field: 'active_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
+            77: {
+                field: 'total_moving_time',
+                type: 'uint32',
+                scale: 1000,
+                offset: 0,
+                units: 's',
+            },
         },
         285: {
             name: 'jump',
@@ -4131,6 +4438,109 @@ export const FIT = {
                 units: 'counts',
             },
         },
+        // Undocumented Garmin user metrics message. Observed in activity FIT files exported
+        // from Garmin Connect and displayed by fitfileviewer as "User Metrics".
+        79: {
+            name: 'user_metrics',
+            253: {
+                field: 'timestamp',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            0: {
+                field: 'vo2_max',
+                type: 'uint16',
+                scale: 1024 / 3.5,
+                offset: 0,
+                units: 'ml/kg/min',
+            },
+            1: {
+                field: 'age',
+                type: 'uint8',
+                scale: null,
+                offset: 0,
+                units: 'years',
+            },
+            2: {
+                field: 'height',
+                type: 'uint8',
+                scale: 100,
+                offset: 0,
+                units: 'm',
+            },
+            3: {
+                field: 'weight',
+                type: 'uint16',
+                scale: 10,
+                offset: 0,
+                units: 'kg',
+            },
+            4: {
+                field: 'gender',
+                type: 'gender',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            6: {
+                field: 'max_heart_rate',
+                type: 'uint8',
+                scale: null,
+                offset: 0,
+                units: 'bpm',
+            },
+            8: {
+                field: 'remaining_recovery_time',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            11: {
+                field: 'lthr',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'bpm',
+            },
+            12: {
+                field: 'ltpower',
+                type: 'uint16',
+                scale: null,
+                offset: 0,
+                units: 'watts',
+            },
+            13: {
+                field: 'ltspeed',
+                type: 'uint16',
+                scale: 1000,
+                offset: 0,
+                units: 'm/s',
+            },
+            16: {
+                field: 'start_of_activity',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+            19: {
+                field: 'first_vo2_max',
+                type: 'uint32',
+                scale: 65536 / 3.5,
+                offset: 0,
+                units: 'ml/kg/min',
+            },
+            35: {
+                field: 'end_of_previous_activity',
+                type: 'date_time',
+                scale: null,
+                offset: 0,
+                units: '',
+            },
+        },
         103: {
             name: 'monitoring_info',
             253: {
@@ -4927,6 +5337,7 @@ export const FIT = {
             55: 'monitoring',
             72: 'training_file',
             78: 'hrv',
+            79: 'user_metrics',
             80: 'ant_rx',
             81: 'ant_tx',
             82: 'ant_channel_id',
@@ -4978,6 +5389,8 @@ export const FIT = {
             264: 'exercise_title',
             268: 'dive_summary',
             285: 'jump',
+            312: 'split',
+            313: 'split_summary',
             317: 'climb_pro',
             319: 'tank_update',
             323: 'tank_summary',
@@ -6494,6 +6907,29 @@ export const FIT = {
             0: 'starred',
             1: 'suggested',
         },
+        split_type: {
+            1: 'ascent_split',
+            2: 'descent_split',
+            3: 'interval_active',
+            4: 'interval_rest',
+            5: 'interval_warmup',
+            6: 'interval_cooldown',
+            7: 'interval_recovery',
+            8: 'interval_other',
+            9: 'climb_active',
+            10: 'climb_rest',
+            11: 'surf_active',
+            12: 'run_active',
+            13: 'run_rest',
+            14: 'workout_round',
+            17: 'rwd_run',
+            18: 'rwd_walk',
+            21: 'windsurf_active',
+            22: 'rwd_stand',
+            23: 'transition',
+            28: 'ski_lift_split',
+            29: 'ski_run_split',
+        },
         source_type: {
             0: 'ant',
             1: 'antplus',