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.



49
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
 
# File 'lib/fit4ruby/Activity.rb', line 49

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 = []
  @records = []
  @hrv = []
  @heart_rate_zones = []
  @personal_records = []

  @cur_session_laps = []
  @cur_lap_records = []

  @lap_counter = 1

  set_field_values(field_values)
end

Instance Attribute Details

#data_sources ⇒ Object

Returns the value of attribute data_sources.



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

def data_sources
  @data_sources
end

#developer_data_ids ⇒ Object

Returns the value of attribute developer_data_ids.



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

def developer_data_ids
  @developer_data_ids
end

#device_infos ⇒ Object

Returns the value of attribute device_infos.



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

def device_infos
  @device_infos
end

#epo_data ⇒ Object

Returns the value of attribute epo_data.



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

def epo_data
  @epo_data
end

#events ⇒ Object

Returns the value of attribute events.



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

def events
  @events
end

#field_descriptions ⇒ Object

Returns the value of attribute field_descriptions.



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

def field_descriptions
  @field_descriptions
end

#file_creator ⇒ Object

Returns the value of attribute file_creator.



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

def file_creator
  @file_creator
end

#file_id ⇒ Object

Returns the value of attribute file_id.



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

def file_id
  @file_id
end

#heart_rate_zones ⇒ Object

Returns the value of attribute heart_rate_zones.



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

def heart_rate_zones
  @heart_rate_zones
end

#hrv ⇒ Object

Returns the value of attribute hrv.



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

def hrv
  @hrv
end

#laps ⇒ Object

Returns the value of attribute laps.



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

def laps
  @laps
end

#personal_records ⇒ Object

Returns the value of attribute personal_records.



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

def personal_records
  @personal_records
end

#physiological_metrics ⇒ Object

Returns the value of attribute physiological_metrics.



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

def physiological_metrics
  @physiological_metrics
end

#records ⇒ Object

Returns the value of attribute records.



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

def records
  @records
end

#sensor_settings ⇒ Object

Returns the value of attribute sensor_settings.



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

def sensor_settings
  @sensor_settings
end

#sessions ⇒ Object

Returns the value of attribute sessions.



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

def sessions
  @sessions
end

#user_data ⇒ Object

Returns the value of attribute user_data.



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

def user_data
  @user_data
end

#user_profiles ⇒ Object

Returns the value of attribute user_profiles.



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

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,



435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/fit4ruby/Activity.rb', line 435

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

#aggregate ⇒ Object

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



211
212
213
214
 
# File 'lib/fit4ruby/Activity.rb', line 211

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

#avg_speed ⇒ Object

Convenience method that averages the speed over all sessions.



217
218
219
220
221
 
# File 'lib/fit4ruby/Activity.rb', line 217

def avg_speed
  speed = 0.0
  @sessions.each { |s| speed += s.avg_speed if s.avg_speed }
  speed / @sessions.length
end

#check ⇒ Object

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



83
84
85
86
87
88
89
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
 
# File 'lib/fit4ruby/Activity.rb', line 83

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)
    # 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
  @sessions.each { |s| s.check(self) }
end

#ending_hr ⇒ Object

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



224
225
226
 
# File 'lib/fit4ruby/Activity.rb', line 224

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) 


348
349
350
 
# File 'lib/fit4ruby/Activity.rb', line 348

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:



323
324
325
 
# File 'lib/fit4ruby/Activity.rb', line 323

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:



340
341
342
 
# File 'lib/fit4ruby/Activity.rb', line 340

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:



380
381
382
 
# File 'lib/fit4ruby/Activity.rb', line 380

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:



315
316
317
 
# File 'lib/fit4ruby/Activity.rb', line 315

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:



332
333
334
 
# File 'lib/fit4ruby/Activity.rb', line 332

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:



307
308
309
 
# File 'lib/fit4ruby/Activity.rb', line 307

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



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
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
 
# File 'lib/fit4ruby/Activity.rb', line 456

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 'record'
    @cur_lap_records << (record = Record.new(field_values))
    @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:



411
412
413
 
# File 'lib/fit4ruby/Activity.rb', line 411

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:



403
404
405
 
# File 'lib/fit4ruby/Activity.rb', line 403

def new_lap(field_values = {})
  new_fit_data_record('lap', 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) 


419
420
421
 
# File 'lib/fit4ruby/Activity.rb', line 419

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:



372
373
374
 
# File 'lib/fit4ruby/Activity.rb', line 372

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:



427
428
429
 
# File 'lib/fit4ruby/Activity.rb', line 427

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:



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

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:



356
357
358
 
# File 'lib/fit4ruby/Activity.rb', line 356

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:



364
365
366
 
# File 'lib/fit4ruby/Activity.rb', line 364

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

#recovery_hr ⇒ Object

Return the measured recovery heart rate.



229
230
231
232
233
234
235
 
# File 'lib/fit4ruby/Activity.rb', line 229

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

  nil
end

#recovery_info ⇒ Object

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

Returns:

  • remaining recovery time in seconds.



239
240
241
242
243
244
245
 
# File 'lib/fit4ruby/Activity.rb', line 239

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

  nil
end

#recovery_time ⇒ Object

Returns the predicted recovery time needed after this activity.

Returns:

  • recovery time in seconds.



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

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

  nil
end

#sport ⇒ Object

Returns the sport type of this activity.



274
275
276
 
# File 'lib/fit4ruby/Activity.rb', line 274

def sport
  @sessions[0].sport
end

#sub_sport ⇒ Object

Returns the sport subtype of this activity.



279
280
281
 
# File 'lib/fit4ruby/Activity.rb', line 279

def sub_sport
  @sessions[0].sub_sport
end

#total_distance ⇒ Object

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



154
155
156
157
158
 
# File 'lib/fit4ruby/Activity.rb', line 154

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

#total_gps_distance ⇒ Object

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.



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
 
# File 'lib/fit4ruby/Activity.rb', line 163

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

#vo2max ⇒ Object

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/fit4ruby/Activity.rb', line 259

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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/fit4ruby/Activity.rb', line 287

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 + @heart_rate_zones +
   @personal_records).sort.each do |s|
    s.write(io, id_mapper)
  end
  super
end