cycle_analyst_logger 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa99c57d5a7f7847435d357af10d11509fd73c02
-  data.tar.gz: b6a2f5962e3f5b42306a2b8988bd307a25c75b37
+  metadata.gz: 24b86d3ddae10152675800b27ac5f8bf912ea5ac
+  data.tar.gz: 270d41a27b722386113154d05fc89c32740375c5
 SHA512:
-  metadata.gz: 6e7ba577ce1a9ce9fd7e6530a178e675e3d0fd1af56128e2c59a79bb1fb3cde66514dd7d16c79df42e046ef2f0a90222ce347f547ec1e1b0760aa8a04ad1e2e6
-  data.tar.gz: ceda4757f47b3fe2089fabea131de290e12ddb1258c192496f2b5bb83d31a66a4a891d9ffcc338cdfd42ac74252c0667fe34c4be28904667208e60e9be713cd6
+  metadata.gz: 5401db314c8ef3b9721834c8a02005bd52041891e394c22fa8a328e52456e12ff2182a3ed836e8faf6f32b41cddac57298b6dc075e0cd9e8c6771d947de291ef
+  data.tar.gz: b1504aef4be175e8a9226a2e0785aef2badbc6d4c15d06dd63b02c2284c2d954dac07816c6c577ffca3a0e14c727bc1cce79e7879700756b86e899eed5c9bd98

data/README.rdoc

@@ -8,9 +8,7 @@
 == SYNOPSIS
     cycle_analyst_logger [global options] command [command options] [arguments...]
     cycle_analyst_logger [global options] log [tty] [baudrate] [enable_phaserunner] [tty] [baudrate]
-
-== VERSION
-    0.2.0
+    cycle_analyst_logger [global options] location_from_gmx gpx_filename log_filename [output_filename]
 
 == GLOBAL OPTIONS
     -t, --tty_ca=arg         - Cycle Analyst Serial (USB) device (default: /dev/ttyUSB1)
@@ -26,6 +24,7 @@
 == COMMANDS
     help - Shows a list of commands or help for one command
     log  - Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
+    location_from_gmx, loc - Merge geo info from GMX file and log lines from log file
 
 === Attributes that are Logged
 
@@ -33,8 +32,8 @@
 * Cycle Analyst Amp Hours (Ah)
 * Cycle Analyst Volts (V)
 * Cycle Analyst Current (A)
-* Cycle Analyst Speed (Kph)
-* Cycle Analyst Distance (Km)
+* Cycle Analyst Speed (Mph)
+* Cycle Analyst Distance (Miles)
 * Cycle Analyst Motor Temp (DegC)
 * Cycle Analyst Human Cadence (RPM)
 * Cycle Analyst Human Power (W)

data/cycle_analyst_logger.gemspec

@@ -29,6 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'gli', '~> 2.17'
   spec.add_runtime_dependency 'serialport', '~> 1.3'
   spec.add_runtime_dependency 'phaserunner', '~> 0.1', '>= 0.1.5'
+  spec.add_runtime_dependency 'haversine', '~> 0.3.2'
+  spec.add_runtime_dependency 'gpx', '~> 0.9.0'
+  spec.add_runtime_dependency 'nmea_plus', '~> 1.0', '>= 1.0.20'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'

data/cycle_analyst_logger.rdoc

@@ -1,6 +1,6 @@
 == cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner
 
-v0.2.0
+v0.2.4
 
 === Global Options
 === -b|--baud_ca arg
@@ -71,6 +71,10 @@ List commands one per line, to assist with shell completion
 
 
 
+==== Command: <tt>location_from_gmx|loc </tt>
+Merge geo info from GMX file and log lines from log file
+
+
 ==== Command: <tt>log </tt>
 Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
 

data/lib/cycle_analyst_logger.rb

@@ -3,5 +3,7 @@
 
 require 'cycle_analyst_logger/gli_patch.rb'
 require 'cycle_analyst_logger/version.rb'
-require 'cycle_analyst_logger/main.rb'
+require 'cycle_analyst_logger/cli.rb'
 require 'cycle_analyst_logger/cycle_analyst.rb'
+require 'cycle_analyst_logger/gps.rb'
+require 'cycle_analyst_logger/gpx.rb'

data/lib/cycle_analyst_logger/{main.rb → cli.rb}

@@ -8,7 +8,6 @@ module CycleAnalystLogger
   end
 
   class Cli
-    attr_reader :cycle_analyst
     attr_reader :enable_phaserunner
     attr_reader :pr
     attr_reader :quiet
@@ -37,8 +36,7 @@ module CycleAnalystLogger
 
       desc 'Get PhaseRunner Logs also'
       default_value true
-      arg 'enable_phaserunner', :optional
-      flag [:enable_phaserunner]
+      switch [:enable_phaserunner]
 
       desc 'Phaserunner Serial (USB) device'
       default_value '/dev/ttyUSB0'
@@ -50,6 +48,20 @@ module CycleAnalystLogger
       arg 'baudrate', :optional
       flag [:baud_pr]
 
+      desc 'Get Gps Logs also'
+      default_value true
+      switch [:enable_gps]
+
+      desc 'Gps Serial (USB) device'
+      default_value '/dev/ttyUSB2'
+      arg 'tty', :optional
+      flag [:tty_gps]
+
+      desc 'Gps Serial port baudrate'
+      default_value 115200
+      arg 'baudrate', :optional
+      flag [:baud_gps]
+
       desc "How many lines to read"
       default_value :forever
       flag [:l, :loop_count]
@@ -57,12 +69,26 @@ module CycleAnalystLogger
       desc 'Do not output to stdout'
       switch [:q, :quiet]
 
-      desc 'Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file'
+      desc 'Log the Cycle Analyst and optionally GPS and Phaserunner to a file'
       command :log do |log|
         log.action do |global_options, options, args|
-          filename = "cycle_analyst.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv"
-          output_fd = File.open(filename, 'w')
-          cycle_analyst.get_logs(output_fd, loop_count, quiet)
+          cycle_analyst = CycleAnalyst.new(global_options)
+          cycle_analyst.get_logs(loop_count, quiet)
+        end
+      end
+
+      desc 'Merge geo info from GMX file and log lines from log file'
+      arg :gpx_filename
+      arg :log_filename
+      arg :output_filename, :optional
+      command [:location_from_gmx, :loc]  do |location_from_gmx|
+        location_from_gmx.action do |global_options, options, args|
+          gpx_filename = args[0]
+          log_filename = args[1]
+          output_filename = args[2]
+
+          gpx = Gpx.new(gpx_filename)
+          gpx.merge_location(log_filename, output_filename)
         end
       end
 
@@ -80,7 +106,8 @@ module CycleAnalystLogger
                         global[:loop_count].to_i
                       end
         @enable_phaserunner = global[:enable_phaserunner]
-        @cycle_analyst = CycleAnalyst.new(global)
+        @enable_gps = global[:enable_gps]
+        true
       end
 
       post do |global,command,options,args|

data/lib/cycle_analyst_logger/cycle_analyst.rb

@@ -16,19 +16,28 @@ module CycleAnalystLogger
     # Handle from the SerialPort object
     attr_reader :serial_io
 
-    # If the phaeserunner should be read
+    # If the phaserunner should be read
     attr_reader :enable_phaserunner
 
     # Handle of the Phaserunner::Modbus object
     attr_reader :phaserunner
 
+    # If the gps should be read
+    attr_reader :enable_gps
+
+    # Handle of the Gps object
+    attr_reader :gps
+
+    # Shared data for gps data
+    attr_reader :gps_data
+
     # Hash definition that describes the names, values and units of the Cycle Analyst log data
     CA_DICT = {
       0 => {address: 0, name: "Amp Hours", units: "Ah", scale: 1},
       1 => { address: 1, name: "Volts", units: "V", scale: 1 },
       2 => { address: 2, name: "Current", units: "A", scale: 1},
-      3 => { address: 3, name: "Speed", units: "Kph", scale: 1},
-      4 => { address: 4, name: "Distance", units: "Km", scale: 1},
+      3 => { address: 3, name: "Speed", units: "Mph", scale: 1},
+      4 => { address: 4, name: "Distance", units: "Miles", scale: 1},
       5 => { address: 5, name: "Motor Temp", units: "DegC", scale: 1},
       6 => { address: 6, name: "Human Cadence", units: "RPM", scale: 1},
       7 => { address: 7, name: "Human Power", units: "W", scale: 1},
@@ -47,22 +56,35 @@ module CycleAnalystLogger
       @dict = CA_DICT
       @serial_io = SerialPort.new @tty, @baudrate, 8, 1
       @enable_phaserunner = opts[:enable_phaserunner]
+
       if @enable_phaserunner
         @phaserunner = Phaserunner::Modbus.new(
           tty: opts[:tty_pr], baudrate: opts[:baud_pr]
         )
       end
+
+      @enable_gps = opts[:enable_gps]
+
+      if @enable_gps
+        @gps_data = {}
+        @gps = Gps.new(@gps_data, {tty: opts[:tty_gps], baudrate: opts[:baud_gps]})
+      end
     end
 
     # Forms the proper header line
     # @return [String] of a printable CSV header line
-    def logs_header
+    def log_header
       hdr = dict.map do |(address, node)|
         "#{node[:name]} (#{node[:units]})"
       end
       if enable_phaserunner
         hdr += phaserunner.bulk_log_header.map { |name| "PR #{name}" }
       end
+
+      if enable_gps
+        hdr += gps.log_header
+      end
+
       hdr.join(',')
     end
 
@@ -75,9 +97,14 @@ module CycleAnalystLogger
     # @param output_fd [File] File Descriptor of the output file to write to. Don't write to file if nil
     # @param loop_count [Integer, Symbol] Number of lines to output, or forever if :forever
     # @param quite [Boolean] Don't output to stdout if true
-    def get_logs(output_fd, loop_count, quiet)
+    def get_logs(loop_count, quiet)
+      filename = "cycle_analyst.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv"
+      output_fd = File.open(filename, 'w')
+
+      gps_thread = Thread.new { gps.run } if enable_gps
+
       line_number = 0
-      hdr = %Q(Timestamp,#{logs_header})
+      hdr = %Q(Timestamp,#{log_header})
 
       puts hdr if not quiet
       output_fd.puts hdr if output_fd
@@ -87,7 +114,11 @@ module CycleAnalystLogger
           [Time.now.utc.round(10).iso8601(6)] +
           tsv2array(line)
         )
+
         output += phaserunner.bulk_log_data if enable_phaserunner
+        #puts "gps_data: #{gps.log_data.inspect}"
+        output += gps.log_data if enable_gps
+
         output_line = output.flatten.join(',')
 
         puts output_line unless quiet

data/lib/cycle_analyst_logger/gps.rb

@@ -0,0 +1,85 @@
+require 'nmea_plus'
+require 'pp'
+
+module CycleAnalystLogger
+
+  class Gps
+    DEFAULTS = {
+      tty: '/dev/ttyUSB2',
+      baudrate: 115200
+    }
+
+    GPS_DICT = {
+      0 => {address: 0, name: 'Time', key: :time, units: nil, scale: 1},
+      1 => {address: 1, name: 'Latitude', key: :latitude, units: 'degrees', scale: 1},
+      2 => {address: 2, name: 'Longitude', key: :longitude, units: 'degrees', scale: 1},
+      3 => {address: 3, name: 'Altitude', key: :altitude, units: 'meters', scale: 1},
+      4 => {address: 4, name: 'Speed', key: :speed, units: 'kph', scale: 1},
+      5 => {address: 5, name: 'Fix Quality', key: :fix_quality, units: nil, scale: 1},
+      6 => {address: 6, name: 'Satellites', key: :satellites, units: nil, scale: 1},
+      7 => {address: 7, name: 'Geoid Height', key: :geoid_height, units: nil, scale: 1},
+      8 => {address: 8, name: 'Horizontal Dilution', key: :horizontal_dilution, units: nil, scale: 1},
+      9 => {address: 9, name: 'Faa Mode', key: :faa_mode, units: nil, scale: 1}
+    }
+
+    attr_reader :tty
+    attr_reader :baudrate
+    attr_reader :serial_io
+    attr_reader :dict
+    attr_reader :pre_data
+    attr_reader :shared_data
+    attr_reader :source_decoder
+
+    def initialize(shared_data, opts = {})
+      final_opts = DEFAULTS.merge(opts)
+      @tty = final_opts[:tty]
+      @baudrate = final_opts[:baudrate]
+      @serial_io = SerialPort.new @tty, @baudrate, 8, 1
+      @dict = GPS_DICT
+      @pre_data = {}
+      @shared_data = shared_data
+      @source_decoder = NMEAPlus::SourceDecoder.new(@serial_io)
+    end
+
+    def run
+      source_decoder.each_complete_message do |message|
+        case message.data_type
+        when 'GNGGA'
+          pre_data[:time] = message.fix_time
+          pre_data[:latitude] = message.latitude
+          pre_data[:longitude] = message.longitude
+          pre_data[:altitude] = message.altitude
+          pre_data[:dgps_station_id] = message.dgps_station_id
+          pre_data[:fix_quality] = message.fix_quality
+          pre_data[:geoid_height] = message.geoid_height
+          pre_data[:horizontal_dilution] = message.horizontal_dilution
+          pre_data[:satellites] = message.satellites
+          pre_data[:seconds_since_last_update] = message.seconds_since_last_update
+        when 'GNVTG'
+          pre_data[:speed_kmh] = message.speed_kmh
+          pre_data[:speed_knots] = message.speed_knots
+          pre_data[:faa_mode] = message.faa_mode
+          pre_data[:track_degrees_magnetic] = message.track_degrees_magnetic
+          pre_data[:track_degrees_true] = message.track_degrees_true
+          # Has to be a copy since shared_data is really a reference to an
+          # instance variable in the outer thread.
+          pre_data.each_pair { |k,v| shared_data[k] = v}
+        else
+          next
+        end
+      end
+    end
+
+    def log_header
+      dict.map do |(address, node)|
+        node[:name] + (node[:units] ? " (#{node[:units]})" : '')
+      end
+    end
+
+    def log_data
+     dict.map do |address, node|
+        shared_data[node[:key]]
+      end
+    end
+  end
+end

data/lib/cycle_analyst_logger/gpx.rb

@@ -0,0 +1,97 @@
+require 'haversine'
+require 'gpx'
+
+module CycleAnalystLogger
+  class Gpx
+    attr_reader :gpx
+    # The clean info needed from the gpx
+    # @return [Hash<Time, Hash>] points The points organized by Timestamp.
+    # * :time (Hash<Symbol, Float) The Point Atrributes
+    #   * :timestamp (Time) in seconds resolution
+    #   * :lattitude (Float)
+    #   * :longitude (Float)
+    #   * :elevation (Float)
+    #   * :speed (Float)
+    attr_reader :points
+
+    def initialize(filename)
+      @gpx = GPX::GPXFile.new(gpx_file: filename)
+      @points = gpx.tracks.flat_map(&:points).each_with_object({}) do |point, memo|
+        memo[point.time] = {
+          timestamp: point.time,
+          lattitude: point.lat,
+          longitude: point.lon,
+          elevation: point.elevation,
+          speed: point.speed
+        }
+      end
+    end
+
+    # Checks if the input is a valid Time String
+    # @param input [String] Potential Time Stamp or invalid string
+    # @return [Time, nil] Returns a Time object based on the input if it was valid. Otherwise returns nil
+    def valid_timestamp(input)
+      begin
+        Time.parse(input)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Finds the point that is close to the timestamp input.
+    #   If there is no point with the same time, it returns the last point
+    #   Also calculates the speed between the last point and this point and adds it to the response hash
+    # @param timestamp [Time] Timestamp to find. Will round to nearest second
+    def closest_point_in_time(timestamp)
+      point = if (point = points[timestamp.round(0)])
+                # Handle initial case
+                @last_point = point unless @last_point
+
+                if point[:timestamp] == @last_point[:timestamp]
+                  @last_point 
+                else # Its a new point so calculate speed and return the new point
+                  duration = point[:timestamp] - @last_point[:timestamp]
+                  distance = Haversine.distance(@last_point[:lattitude], @last_point[:longitude], point[:lattitude], point[:longitude]).to_miles
+                  speed_mph = (distance / duration) * 3600 # Convert miles / second to miles per hour
+                  @last_point = point.merge(speed: speed_mph)
+                end
+
+              else # Could not find a point with a matching timestamp so use the last_point (were probably not moving or Strava not recording)
+                @last_point.merge(speed: 0.0)
+              end
+    end
+
+    def merge_location(log_filename, output_filename = nil)
+      # Get the proper output File descriptor
+      out_fd = if output_filename
+                 File.open(output_filename, 'w')
+               else
+                 $stdout.dup
+               end
+
+      File.readlines(log_filename).each.with_index do |log_line, idx|
+        log_record = log_line.split(',')
+        if idx == 0
+          out_fd.puts 'Timestamp,Lattitude,Longitude,Elevation (feet),Speed (mph),' +
+                      log_record[1..-1].join(',')
+          next
+        end
+
+        # Check that the line has a valid timestamp, skip this line if it isn't
+        next unless (timestamp = valid_timestamp log_record[0])
+
+        # Get the point from GPX that is closest to the timestamp from the log
+        if (point = closest_point_in_time(timestamp))
+          lattitude = point[:lattitude]
+          longitude = point[:longitude]
+          elevation = point[:elevation]
+          speed = point[:speed]
+        else
+          lattitude = longitude = elevation = speed = nil
+        end
+        out_fd.puts "#{log_record[0]},#{lattitude},#{longitude},#{elevation},#{speed}," +
+                    log_record[1..-1].join(',')
+      end
+    end
+  end
+end

data/lib/cycle_analyst_logger/version.rb

@@ -1,3 +1,3 @@
 module CycleAnalystLogger
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cycle_analyst_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert J. Berger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -58,6 +58,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: haversine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: gpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: nmea_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.20
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,9 +210,11 @@ files:
 - cycle_analyst_logger.rdoc
 - exe/cycle_analyst_logger
 - lib/cycle_analyst_logger.rb
+- lib/cycle_analyst_logger/cli.rb
 - lib/cycle_analyst_logger/cycle_analyst.rb
 - lib/cycle_analyst_logger/gli_patch.rb
-- lib/cycle_analyst_logger/main.rb
+- lib/cycle_analyst_logger/gps.rb
+- lib/cycle_analyst_logger/gpx.rb
 - lib/cycle_analyst_logger/version.rb
 - todo.txt
 homepage: https://github.com/rberger/cycle_analyst_logger