Class: Fit4Ruby::Activity

Inherits:
FitDataRecord show all
Defined in:
lib/fit4ruby/Activity.rb

Overview

This is the most important class of this library. It holds references to all other data structures. Each of the objects it references are direct equivalents of the message record structures used in the FIT file.

Constant Summary

Constants inherited from FitDataRecord

FitDataRecord::RecordOrder

Instance Attribute Summary collapse

Attributes inherited from FitDataRecord

#message

Instance Method Summary collapse

Methods inherited from FitDataRecord

#<=>, #get, #get_as, #inspect, #set, #set_field_values

Methods included from Converters

#conversion_factor, #fit_time_to_time, #secsToDHMS, #secsToHM, #secsToHMS, #speedToPace, #time_to_fit_time

Constructor Details

#initialize(field_values = {}) ⇒ Activity

Create a new Activity object.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/fit4ruby/Activity.rb', line 50

def initialize(field_values = {})
  super('activity')
  @meta_field_units['total_gps_distance'] = 'm'
  @num_sessions = 0

  @file_id = FileId.new
  @field_descriptions = []
  @developer_data_ids = []
  @epo_data = nil
  @file_creator = FileCreator.new
  @device_infos = []
  @sensor_settings = []
  @data_sources = []
  @user_data = []
  @user_profiles = []
  @physiological_metrics = []
  @events = []
  @sessions = []
  @laps = []
  @lengths = []
  @records = []
  @hrv = []
  @heart_rate_zones = []
  @personal_records = []

  @cur_session_laps = []

  @cur_lap_records = []
  @cur_lap_lengths = []

  @cur_length_records = []

  @lap_counter = 1
  @length_counter = 1

  set_field_values(field_values)
end

Instance Attribute Details

#data_sourcesObject

Returns the value of attribute data_sources.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def data_sources
  @data_sources
end

#developer_data_idsObject

Returns the value of attribute developer_data_ids.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def developer_data_ids
  @developer_data_ids
end

#device_infosObject

Returns the value of attribute device_infos.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def device_infos
  @device_infos
end

#epo_dataObject

Returns the value of attribute epo_data.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def epo_data
  @epo_data
end

#eventsObject

Returns the value of attribute events.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def events
  @events
end

#field_descriptionsObject

Returns the value of attribute field_descriptions.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def field_descriptions
  @field_descriptions
end

#file_creatorObject

Returns the value of attribute file_creator.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def file_creator
  @file_creator
end

#file_idObject

Returns the value of attribute file_id.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def file_id
  @file_id
end

#heart_rate_zonesObject

Returns the value of attribute heart_rate_zones.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def heart_rate_zones
  @heart_rate_zones
end

#hrvObject

Returns the value of attribute hrv.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def hrv
  @hrv
end

#lapsObject

Returns the value of attribute laps.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def laps
  @laps
end

#lengthsObject

Returns the value of attribute lengths.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def lengths
  @lengths
end

#personal_recordsObject

Returns the value of attribute personal_records.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def personal_records
  @personal_records
end

#physiological_metricsObject

Returns the value of attribute physiological_metrics.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def physiological_metrics
  @physiological_metrics
end

#recordsObject

Returns the value of attribute records.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def records
  @records
end

#sensor_settingsObject

Returns the value of attribute sensor_settings.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def sensor_settings
  @sensor_settings
end

#sessionsObject

Returns the value of attribute sessions.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def sessions
  @sessions
end

#user_dataObject

Returns the value of attribute user_data.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def user_data
  @user_data
end

#user_profilesObject

Returns the value of attribute user_profiles.



41
42
43
# File 'lib/fit4ruby/Activity.rb', line 41

def user_profiles
  @user_profiles
end

Instance Method Details

#==(a) ⇒ TrueClass/FalseClass

Check if the current Activity is equal to the passed Activity. otherwise false.

Parameters:

  • a (Activity)

    Activity to compare this Activity with.

Returns:

  • (TrueClass/FalseClass)

    true if both Activities are equal,



466
467
468
469
470
471
472
473
474
475
476
477
478
479
# File 'lib/fit4ruby/Activity.rb', line 466

def ==(a)
  super(a) && @file_id == a.file_id &&
    @file_creator == a.file_creator &&
    @field_descriptions == a.field_descriptions &&
    @developer_data_ids == a.developer_data_ids &&
    @device_infos == a.device_infos &&
    @sensor_settings == a.sensor_settings &&
    @data_sources == a.data_sources &&
    @physiological_metrics == a.physiological_metrics &&
    @user_profiles == a.user_profiles &&
    @heart_rate_zones == a.heart_rate_zones &&
    @events == a.events &&
    @sessions == a.sessions && personal_records == a.personal_records
end

#aggregateObject

Call this method to update the aggregated data fields stored in Lap, Length, and Session objects.



227
228
229
230
231
# File 'lib/fit4ruby/Activity.rb', line 227

def aggregate
  @laps.each { |l| l.aggregate }
  @lengths.each { |l| l.aggregate }
  @sessions.each { |s| s.aggregate }
end

#avg_speedObject

Convenience method that averages the speed over all sessions.



234
235
236
237
238
239
240
241
242
# File 'lib/fit4ruby/Activity.rb', line 234

def avg_speed
  speed = 0.0
  @sessions.each do |s|
    if (spd = s.avg_speed || s.enhanced_avg_speed)
      speed += spd
    end
  end
  speed / @sessions.length
end

#checkObject

Perform some basic logical checks on the object and all references sub objects. Any errors will be reported via the Log object.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/fit4ruby/Activity.rb', line 90

def check
  unless @timestamp && @timestamp >= Time.parse('1990-01-01T00:00:00+00:00')
    Log.fatal "Activity has no valid timestamp"
  end
  unless @total_timer_time
    Log.fatal "Activity has no valid total_timer_time"
  end
  unless @device_infos.length > 0
    Log.fatal "Activity must have at least one device_info section"
  end
  @device_infos.each.with_index { |d, index| d.check(index) }
  @sensor_settings.each.with_index { |s, index| s.check(index) }
  unless @num_sessions == @sessions.count
    Log.fatal "Activity record requires #{@num_sessions}, but "
              "#{@sessions.length} session records were found in the "
              "FIT file."
  end

  # Records must have consecutively growing timestamps and distances.
  ts = Time.parse('1989-12-31')
  distance = nil
  invalid_records = []
  @records.each_with_index do |r, idx|
    Log.fatal "Record has no timestamp" unless r.timestamp
    if r.timestamp < ts
      Log.fatal "Record has earlier timestamp than previous record"
    end
    if r.distance
      if distance && r.distance < distance
        # Normally this should be a fatal error as the FIT file is clearly
        # broken. Unfortunately, the Skiing/Boarding app in the Fenix3
        # produces such broken FIT files. So we just warn about this
        # problem and discard the earlier records.
        Log.error "Record #{r.timestamp} has smaller distance " +
                  "(#{r.distance}) than an earlier record (#{distance})."
        # Index of the list record to be discarded.
        (idx - 1).downto(0) do |i|
          if (ri = @records[i]).distance > r.distance
            # This is just an approximation. It looks like the app adds
            # records to the FIT file for runs that it meant to discard.
            # Maybe the two successive time start events are a better
            # criteria. But this workaround works for now.
            invalid_records << ri
          else
            # All broken records have been found.
            break
          end
        end
      end
      distance = r.distance
    end
    ts = r.timestamp
  end
  unless invalid_records.empty?
    # Delete all the broken records from the @records Array.
    Log.warn "Discarding #{invalid_records.length} earlier records"
    @records.delete_if { |r| invalid_records.include?(r) }
  end

  # Laps must have a consecutively growing message index.
  @laps.each.with_index do |lap, index|
    lap.check(index, self)
    # If we have heart rate zone records, there should be one for each
    # lap
    @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
  end

  # Lengths must have a consecutively growing message index.
  @lengths.each.with_index do |length, index|
    length.check(index)
    # If we have heart rate zone records, there should be one for each
    # length
    @heart_rate_zones[index].check(index) if @heart_rate_zones[index]
  end

  @sessions.each { |s| s.check(self) }
end

#ending_hrObject

Return the heart rate when the activity recording was last stopped.



245
246
247
# File 'lib/fit4ruby/Activity.rb', line 245

def ending_hr
  @records.empty? ? nil : @records[-1].heart_rate
end

#new_data_sources(field_values = {}) ⇒ SourceData

Add a new SourceData to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • (SourceData)


369
370
371
# File 'lib/fit4ruby/Activity.rb', line 369

def new_data_sources(field_values = {})
  new_fit_data_record('data_sources', field_values)
end

#new_developer_data_id(field_values = {}) ⇒ DeveloperDataId

Add a new DeveloperDataId to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



344
345
346
# File 'lib/fit4ruby/Activity.rb', line 344

def new_developer_data_id(field_values = {})
  new_fit_data_record('developer_data_id', field_values)
end

#new_device_info(field_values = {}) ⇒ DeviceInfo

Add a new DeviceInfo to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



361
362
363
# File 'lib/fit4ruby/Activity.rb', line 361

def new_device_info(field_values = {})
  new_fit_data_record('device_info', field_values)
end

#new_event(field_values = {}) ⇒ Event

Add a new Event to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



401
402
403
# File 'lib/fit4ruby/Activity.rb', line 401

def new_event(field_values = {})
  new_fit_data_record('event', field_values)
end

#new_field_description(field_values = {}) ⇒ FieldDescription

Add a new FieldDescription to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



336
337
338
# File 'lib/fit4ruby/Activity.rb', line 336

def new_field_description(field_values = {})
  new_fit_data_record('field_description', field_values)
end

#new_file_creator(field_values = {}) ⇒ FileCreator

Add a new FileCreator to the Activity. It will replace any previously added FileCreator object.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



353
354
355
# File 'lib/fit4ruby/Activity.rb', line 353

def new_file_creator(field_values = {})
  new_fit_data_record('file_creator', field_values)
end

#new_file_id(field_values = {}) ⇒ FileId

Add a new FileId to the Activity. It will replace any previously added FileId object.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



328
329
330
# File 'lib/fit4ruby/Activity.rb', line 328

def new_file_id(field_values = {})
  new_fit_data_record('file_id', field_values)
end

#new_fit_data_record(record_type, field_values = {}) ⇒ Object

Create a new FitDataRecord.

Parameters:

  • record_type (String)

    Type that identifies the FitDataRecord derived class to create.

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • FitDataRecord



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/fit4ruby/Activity.rb', line 487

def new_fit_data_record(record_type, field_values = {})
  case record_type
  when 'file_id'
    @file_id = (record = FileId.new(field_values))
  when 'field_description'
    @field_descriptions << (record = FieldDescription.new(field_values))
  when 'developer_data_id'
    @developer_data_ids << (record = DeveloperDataId.new(field_values))
  when 'epo_data'
    @epo_data = (record = EPO_Data.new(field_values))
  when 'file_creator'
    @file_creator = (record = FileCreator.new(field_values))
  when 'device_info'
    @device_infos << (record = DeviceInfo.new(field_values))
  when 'sensor_settings'
    @sensor_settings << (record = SensorSettings.new(field_values))
  when 'data_sources'
    @data_sources << (record = DataSources.new(field_values))
  when 'user_data'
    @user_data << (record = UserData.new(field_values))
  when 'user_profile'
    @user_profiles << (record = UserProfile.new(field_values))
  when 'physiological_metrics'
    @physiological_metrics <<
      (record = PhysiologicalMetrics.new(field_values))
  when 'event'
    @events << (record = Event.new(field_values))
  when 'session'
    unless @cur_lap_records.empty?
      # Copy selected fields from section to lap.
      lap_field_values = {}
      [ :timestamp, :sport ].each do |f|
        lap_field_values[f] = field_values[f] if field_values.include?(f)
      end
      # Ensure that all previous records have been assigned to a lap.
      record = create_new_lap(lap_field_values)
    end
    @num_sessions += 1
    @sessions << (record = Session.new(@cur_session_laps, @lap_counter,
                                       field_values))
    @cur_session_laps = []
  when 'lap'
    record = create_new_lap(field_values)
  when 'length'
    record = create_new_length(field_values)
  when 'record'
    record = Record.new(field_values)
    @cur_lap_records << record
    @cur_length_records << record
    @records << record
  when 'hrv'
    @hrv << (record = HRV.new(field_values))
  when 'heart_rate_zones'
    @heart_rate_zones << (record = HeartRateZones.new(field_values))
  when 'personal_records'
    @personal_records << (record = PersonalRecords.new(field_values))
  else
    record = nil
  end

  record
end

#new_heart_rate_zones(field_values = {}) ⇒ HeartRateZones

Add a new HeartRateZones record to the Activity.

Parameters:

  • field_values (Heash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



442
443
444
# File 'lib/fit4ruby/Activity.rb', line 442

def new_heart_rate_zones(field_values = {})
  new_fit_data_record('heart_rate_zones', field_values)
end

#new_lap(field_values = {}) ⇒ Lap

Add a new Lap to the Activity. All previoulsy added Record objects are associated with this Lap unless they have been associated with another Lap before.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



424
425
426
# File 'lib/fit4ruby/Activity.rb', line 424

def new_lap(field_values = {})
  new_fit_data_record('lap', field_values)
end

#new_length(field_values = {}) ⇒ Length

Add a new Length to the Activity. All previoulsy added Record objects are associated with this Length unless they have been associated with another Length before.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



434
435
436
# File 'lib/fit4ruby/Activity.rb', line 434

def new_length(field_values = {})
  new_fit_data_record('length', field_values)
end

#new_personal_record(field_values = {}) ⇒ PersonalRecord

Add a new PersonalRecord to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:

  • (PersonalRecord)


450
451
452
# File 'lib/fit4ruby/Activity.rb', line 450

def new_personal_record(field_values = {})
  new_fit_data_record('personal_record', field_values)
end

#new_physiological_metrics(field_values = {}) ⇒ PhysiologicalMetrics

Add a new PhysiologicalMetrics to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



393
394
395
# File 'lib/fit4ruby/Activity.rb', line 393

def new_physiological_metrics(field_values = {})
  new_fit_data_record('physiological_metrics', field_values)
end

#new_record(field_values = {}) ⇒ Record

Add a new Record to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



458
459
460
# File 'lib/fit4ruby/Activity.rb', line 458

def new_record(field_values = {})
  new_fit_data_record('record', field_values)
end

#new_session(field_values = {}) ⇒ Session

Add a new Session to the Activity. All previously added Lap objects are associated with this Session unless they have been associated with another Session before. If there are any Record objects that have not yet been associated with a Lap, a new lap will be created and the Record objects will be associated with this Lap. The Lap will be associated with the newly created Session.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



414
415
416
# File 'lib/fit4ruby/Activity.rb', line 414

def new_session(field_values = {})
  new_fit_data_record('session', field_values)
end

#new_user_data(field_values = {}) ⇒ UserData

Add a new UserData to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



377
378
379
# File 'lib/fit4ruby/Activity.rb', line 377

def new_user_data(field_values = {})
  new_fit_data_record('user_data', field_values)
end

#new_user_profile(field_values = {}) ⇒ UserProfile

Add a new UserProfile to the Activity.

Parameters:

  • field_values (Hash) (defaults to: {})

    A Hash that provides initial values for certain fields of the FitDataRecord.

Returns:



385
386
387
# File 'lib/fit4ruby/Activity.rb', line 385

def (field_values = {})
  new_fit_data_record('user_profile', field_values)
end

#recovery_hrObject

Return the measured recovery heart rate.



250
251
252
253
254
255
256
# File 'lib/fit4ruby/Activity.rb', line 250

def recovery_hr
  @events.each do |e|
    return e.recovery_hr if e.event == 'recovery_hr'
  end

  nil
end

#recovery_infoObject

Returns the remaining recovery time at the start of the activity.

Returns:

  • remaining recovery time in seconds.



260
261
262
263
264
265
266
# File 'lib/fit4ruby/Activity.rb', line 260

def recovery_info
  @events.each do |e|
    return e.recovery_info if e.event == 'recovery_info'
  end

  nil
end

#recovery_timeObject

Returns the predicted recovery time needed after this activity.

Returns:

  • recovery time in seconds.



270
271
272
273
274
275
276
# File 'lib/fit4ruby/Activity.rb', line 270

def recovery_time
  @events.each do |e|
    return e.recovery_time if e.event == 'recovery_time'
  end

  nil
end

#sportObject

Returns the sport type of this activity.



295
296
297
# File 'lib/fit4ruby/Activity.rb', line 295

def sport
  @sessions[0].sport
end

#sub_sportObject

Returns the sport subtype of this activity.



300
301
302
# File 'lib/fit4ruby/Activity.rb', line 300

def sub_sport
  @sessions[0].sub_sport
end

#total_distanceObject

Convenience method that aggregates all the distances from the included sessions.



170
171
172
173
174
# File 'lib/fit4ruby/Activity.rb', line 170

def total_distance
  d = 0.0
  @sessions.each { |s| d += s.total_distance }
  d
end

#total_gps_distanceObject

Total distance convered by this activity purely computed by the GPS coordinates. This may differ from the distance computed by the device as it can be based on a purely calibrated footpod.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/fit4ruby/Activity.rb', line 179

def total_gps_distance
  timer_stops = []
  # Generate a list of all timestamps where the timer was stopped.
  @events.each do |e|
    if e.event == 'timer' && e.event_type == 'stop_all'
      timer_stops << e.timestamp
    end
  end

  # The first record of a FIT file can already have a distance associated
  # with it. The GPS location of the first record is not where the start
  # button was pressed. This introduces a slight inaccurcy when computing
  # the total distance purely on the GPS coordinates found in the records.
  d = 0.0
  last_lat = last_long = nil
  last_timestamp = nil

  # Iterate over all the records and accumlate the distances between the
  # neiboring coordinates.
  @records.each do |r|
    if (lat = r.position_lat) && (long = r.position_long)
      if last_lat && last_long
        distance = Fit4Ruby::GeoMath.distance(last_lat, last_long,
                                              lat, long)
        d += distance
      end
      if last_timestamp
        speed = distance / (r.timestamp - last_timestamp)
      end
      if timer_stops[0] == r.timestamp
        # If a stop event was found for this record timestamp we clear the
        # last_* values so that the distance covered while being stopped
        # is not added to the total.
        last_lat = last_long = nil
        last_timestamp = nil
        timer_stops.shift
      else
        last_lat = lat
        last_long = long
        last_timestamp = r.timestamp
      end
    end
  end
  d
end

#vo2maxObject

Returns the computed VO2max value. This value is computed by the device based on multiple previous activities.



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/fit4ruby/Activity.rb', line 280

def vo2max
  # First check the event log for a vo2max reporting event.
  @events.each do |e|
    return e.vo2max if e.event == 'vo2max'
  end
  # Then check the user_data entries for a metmax entry. METmax * 3.5
  # is same value as VO2max.
  @user_data.each do |u|
    return u.metmax * 3.5 if u.metmax
  end

  nil
end

#write(io, id_mapper) ⇒ Object

Write the Activity data to a file.

Parameters:

  • io (IO)

    File reference

  • id_mapper (FitMessageIdMapper)

    Maps global FIT record types to local ones.



308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/fit4ruby/Activity.rb', line 308

def write(io, id_mapper)
  @file_id.write(io, id_mapper)
  @file_creator.write(io, id_mapper)

  (@field_descriptions + @developer_data_ids +
   @device_infos + @sensor_settings +
   @data_sources + @user_profiles +
   @physiological_metrics + @events +
   @sessions + @laps + @records + @lengths +
   @heart_rate_zones + @personal_records).sort.each do |s|
    s.write(io, id_mapper)
  end
  super
end