cycle_analyst_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8478f82cab17da96da04e8c35ed5aa6750e64c0c
+  data.tar.gz: 3af24ab892c6e44a41437e7fa102ea3353d3312c
+SHA512:
+  metadata.gz: 20df1ddea9c110826aaa289fcee22a225754a396f3716fb7dd8aed38d50dcaac024931d0621e1a66c07040541175f320eb7a80313ecb3d44446b5516a8983edd
+  data.tar.gz: 9d23d596fd87c9c8b598ee994ddf550e25a6067813c2d98e4f92c5849137aaa1827ce5e36d2978ab33bd9a192f455aeab5c3f72610fc4b9bdc8a2ed0fd9b7ad3

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/html/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*.csv
+*.log

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.rdoc

@@ -0,0 +1,27 @@
+= cycle_analyst_logger
+
+== NAME
+    cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3
+
+== SYNOPSIS
+    cycle_analyst_logger [global options] command [command options] [arguments...]
+
+== GLOBAL OPTIONS
+    -t, --tty=arg      - Serial (USB) device (default: /dev/ttyUSB1)
+    -b, --baudrate=arg - Serial port baudrate (default: 9600)
+    --version          - Display the program version
+    -q, --[no-]quiet   - Do not output to stdout
+    --help             - Show this message
+
+== COMMANDS
+    help - Shows a list of commands or help for one command
+    log  - Capture the logging output of the CA to a file
+
+=== log - Capture the logging output of the CA to a file
+    cycle_analyst_logger [global options] log [command options] [tty] [baudrate]
+
+=== COMMAND OPTIONS
+    -l, --line_count=arg - How many lines to read (default: forever)
+
+:include:cycle_analyst_logger.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('cycle_analyst_logger.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/cycle_analyst_logger.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cycle_analyst_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cycle_analyst_logger"
+  spec.version       = CycleAnalystLogger::VERSION
+  spec.authors       = ["Robert J. Berger"]
+  spec.email         = ["rberger@ibd.com"]
+
+  spec.summary       = %q{Read and store log output from the Grin Cycle Analyst}
+  spec.description   = %q{Read and store log output from the Grin Cycle Analyst}
+  spec.homepage      = "https://github.com/rberger/cycle_analyst_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['README.rdoc', 'cycle_analyst_logger.rdoc']
+  spec.rdoc_options << '--title' << 'cycle_analyst_logger' << '--main' << 'README.rdoc' << '-ri'
+
+  spec.add_runtime_dependency 'gli', '~> 2.17'
+  spec.add_runtime_dependency 'serialport', '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'aruba', '~> 0.14'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/cycle_analyst_logger.rdoc

@@ -0,0 +1,57 @@
+== cycle_analyst_logger - Describe your application here
+
+v0.0.1
+
+=== Global Options
+=== -b|--baudrate arg
+
+Serial port baudrate
+
+[Default Value] 9600
+
+
+=== -t|--tty arg
+
+Serial (USB) device
+
+[Default Value] /dev/ttyUSB1
+
+
+=== --help
+Show this message
+
+
+
+=== -q|--[no-]quiet
+Do not output to stdout
+
+
+
+=== --version
+Display the program version
+
+
+
+=== Commands
+==== Command: <tt>help  command</tt>
+Shows a list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+===== Options
+===== -c
+List commands one per line, to assist with shell completion
+
+
+
+==== Command: <tt>log </tt>
+Capture the logging output of the CA to a file
+
+
+===== Options
+===== -l|--line_count arg
+
+How many lines to read
+
+[Default Value] forever
+
+

data/exe/cycle_analyst_logger

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'cycle_analyst_logger'
+
+cli = CycleAnalystLogger::Cli.new
+cli.main

data/lib/cycle_analyst_logger.rb

@@ -0,0 +1,7 @@
+# Add requires for other files you add to your project here, so
+# you just need to require this one file in your bin file
+
+require 'cycle_analyst_logger/gli_patch.rb'
+require 'cycle_analyst_logger/version.rb'
+require 'cycle_analyst_logger/main.rb'
+require 'cycle_analyst_logger/cycle_analyst.rb'

data/lib/cycle_analyst_logger/cycle_analyst.rb

@@ -0,0 +1,70 @@
+require 'time'
+require 'serialport'
+
+module CycleAnalystLogger
+  class CycleAnalyst
+    attr_reader :baudrate
+    attr_reader :tty
+    attr_reader :dict
+    attr_reader :serial_io
+    
+    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},
+      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},
+      8 => { address: 8, name: "Human Torque", units: "Nm", scale: 1},
+      9 => { address: 9, name: "Throttle In", units: "V", scale: 1},
+      10 => { address: 10, name: "Throttle Out", units: "V", scale: 1},
+      11 => { address: 11, name:  "AuxA", units: "", scale: 1},
+      12 => { address: 11, name:  "AuxD", units: "", scale: 1},
+      13 => { address: 12, name: "Limit Flags", units: "bit flags", scale: 1}
+    }
+
+    def initialize(opts)
+      @baudrate = opts[:baudrate]
+      @tty = opts[:tty]
+      @dict = CA_DICT
+      @serial_io = SerialPort.new @tty, @baudrate, 8, 1
+    end
+
+    def logs_header
+      dict.map do |(address, node)|
+        "#{node[:name]} (#{node[:units]})"
+      end.join(",")
+    end
+
+    def tsv2array(line)
+      line.split("\t")
+    end
+
+    # Get line from serial port and send to file
+    # @param output_fd [File] File Descriptor of the output file to write to. Don't write to file if nil
+    # @param line_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, line_count, quiet)
+      line_number = 0
+      hdr = %Q(Timestamp,#{logs_header})
+
+      puts hdr if not quiet
+      output_fd.puts hdr if output_fd
+
+      serial_io.each_line do |line|
+        output_line = %Q(#{Time.now.utc.round(10).iso8601(6)},#{tsv2array(line).join(",")})
+        puts output_line if not quiet
+        output_fd.puts output_line if output_fd
+
+        # Determine if we go forever
+        if (line_count != :forever)
+          # If not, then quit when we reach count lines
+          line_number +=1
+          break if line_number >= line_count
+        end
+      end
+    end
+  end
+end

data/lib/cycle_analyst_logger/gli_patch.rb

@@ -0,0 +1,13 @@
+# Work around a bug with the RdocDocumentListener
+# Fix rdoc formatter #201
+# https://github.com/davetron5000/gli/pull/201#issuecomment-195385509
+require 'gli'
+module RdocDocumentListenerAppFix
+  def initialize(_global_options,_options,_arguments,app)
+    super
+    @app = app
+  end
+end
+class GLI::Commands::RdocDocumentListener
+  prepend RdocDocumentListenerAppFix
+end

data/lib/cycle_analyst_logger/main.rb

@@ -0,0 +1,70 @@
+require 'gli'
+
+module CycleAnalystLogger
+
+  class Cli
+    attr_reader :ca
+
+    include GLI::App
+
+    def main
+      program_desc 'Store the streaming data log output of a Grin Cycle Analyst V3'
+
+      version CycleAnalystLogger::VERSION
+
+      subcommand_option_handling :normal
+      arguments :strict
+      sort_help :manually
+
+      desc 'Serial (USB) device'
+      default_value '/dev/ttyUSB1'
+      arg 'tty', :optional
+      flag [:t, :tty]
+
+      desc 'Serial port baudrate'
+      default_value 9600
+      arg 'baudrate', :optional
+      flag [:b, :baudrate]
+
+      desc 'Do not output to stdout'
+      switch [:q, :quiet]
+
+      desc 'Capture the logging output of the CA to a file'
+      command :log do |log|
+        log.desc "How many lines to read"
+        log.default_value :forever
+        log.flag [:l, :line_count]
+
+        log.action do |global_options, options, args|
+          quiet = global_options[:quiet]
+          line_count = options[:line_count]
+          output_fd = File.open("cycle_analyst.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv", 'w')
+          ca.get_logs(output_fd, line_count, quiet)
+        end
+      end
+
+      pre do |global,command,options,args|
+        # Pre logic here
+        # Return true to proceed; false to abort and not call the
+        # chosen command
+        # Use skips_pre before a command to skip this block
+        # on that command only
+        @ca = CycleAnalyst.new(global)
+      end
+
+      post do |global,command,options,args|
+        # Post logic here
+        # Use skips_post before a command to skip this
+        # block on that command only
+      end
+
+      on_error do |exception|
+        # Error logic here
+        # return false to skip default error handling
+        true
+      end
+
+      exit run(ARGV)
+    end
+  end
+end

data/lib/cycle_analyst_logger/version.rb

@@ -0,0 +1,3 @@
+module CycleAnalystLogger
+  VERSION = '0.1.1'
+end

data/todo.txt

@@ -0,0 +1,14 @@
+Ah
+Volts
+Amps
+Speed (Kph)
+Distance (Km)
+Motor Temp (DegC)
+Human RPM (cadence)
+Human Power (Watts)
+Human Torque (Nm)
+Throtle In (Volts)
+Throtle Out (Volts)
+Acceleration
+Limit Flags (preset #, Thr Fault, Ebrake, LVC, Limit flags)
+

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: cycle_analyst_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Robert J. Berger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Read and store log output from the Grin Cycle Analyst
+email:
+- rberger@ibd.com
+executables:
+- cycle_analyst_logger
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- cycle_analyst_logger.rdoc
+files:
+- ".gitignore"
+- Gemfile
+- README.rdoc
+- Rakefile
+- cycle_analyst_logger.gemspec
+- cycle_analyst_logger.rdoc
+- exe/cycle_analyst_logger
+- lib/cycle_analyst_logger.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/version.rb
+- todo.txt
+homepage: https://github.com/rberger/cycle_analyst_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- cycle_analyst_logger
+- "--main"
+- README.rdoc
+- "-ri"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Read and store log output from the Grin Cycle Analyst
+test_files: []