cycle_analyst_logger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8478f82cab17da96da04e8c35ed5aa6750e64c0c
-  data.tar.gz: 3af24ab892c6e44a41437e7fa102ea3353d3312c
+  metadata.gz: c14b7775ea0c3bb48e42d175c8848aa3098630e0
+  data.tar.gz: 48aee7dce5942646f3e9e6d10591ac4da3116d7b
 SHA512:
-  metadata.gz: 20df1ddea9c110826aaa289fcee22a225754a396f3716fb7dd8aed38d50dcaac024931d0621e1a66c07040541175f320eb7a80313ecb3d44446b5516a8983edd
-  data.tar.gz: 9d23d596fd87c9c8b598ee994ddf550e25a6067813c2d98e4f92c5849137aaa1827ce5e36d2978ab33bd9a192f455aeab5c3f72610fc4b9bdc8a2ed0fd9b7ad3
+  metadata.gz: a132b986dc5239b4a9b396bcd745b60710f8112fdd420ff66ffff5cf169e96e14ab3675951124ac581aafd89bf9a05c35c2fe53df8fe5b9e5f8c669887b78bd1
+  data.tar.gz: 035e128d2bd96f8df6a765e09bbd7a8595135ff11f904d8d3183af72aba7fbf968371289582002d523a344139fe4153f17ad145312d37302e2a73ace241c1a40

data/README.rdoc

@@ -1,27 +1,30 @@
 = cycle_analyst_logger
 
 == NAME
-    cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3
+    cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner
 
 == 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
 
 == 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
+    -t, --tty_ca=arg         - Cycle Analyst Serial (USB) device (default: /dev/ttyUSB1)
+    -b, --baud_ca=arg        - Cycle Analyst Serial port baudrate (default: 9600)
+    --enable_phaserunner=arg - Get PhaseRunner Logs also (default: true)
+    --tty_pr=arg             - Phaserunner Serial (USB) device (default: /dev/ttyUSB0)
+    --baud_pr=arg            - Phaserunner Serial port baudrate (default: 115200)
+    -l, --loop_count=arg     - How many lines to read (default: forever)
+    --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]
+    log  - Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
 
-=== COMMAND OPTIONS
-    -l, --line_count=arg - How many lines to read (default: forever)
 
 :include:cycle_analyst_logger.rdoc
 

data/cycle_analyst_logger.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Read and store log output from the Grin Cycle Analyst and Phaserunner}
+  spec.description   = %q{Read and store log output from the Grin Cycle Analyst and optionally Phaserunner}
   spec.homepage      = "https://github.com/rberger/cycle_analyst_logger"
   spec.license       = "MIT"
 
@@ -27,11 +27,12 @@ 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.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 'rdoc', '~> 0', '>= 5.0.0'
   spec.add_development_dependency 'aruba', '~> 0.14'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/cycle_analyst_logger.rdoc

@@ -1,22 +1,50 @@
-== cycle_analyst_logger - Describe your application here
+== cycle_analyst_logger - Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner
 
-v0.0.1
+v0.2.0
 
 === Global Options
-=== -b|--baudrate arg
+=== -b|--baud_ca arg
 
-Serial port baudrate
+Cycle Analyst Serial port baudrate
 
 [Default Value] 9600
 
 
-=== -t|--tty arg
+=== --baud_pr arg
 
-Serial (USB) device
+Phaserunner Serial port baudrate
+
+[Default Value] 115200
+
+
+=== --enable_phaserunner arg
+
+Get PhaseRunner Logs also
+
+[Default Value] true
+
+
+=== -l|--loop_count arg
+
+How many lines to read
+
+[Default Value] forever
+
+
+=== -t|--tty_ca arg
+
+Cycle Analyst Serial (USB) device
 
 [Default Value] /dev/ttyUSB1
 
 
+=== --tty_pr arg
+
+Phaserunner Serial (USB) device
+
+[Default Value] /dev/ttyUSB0
+
+
 === --help
 Show this message
 
@@ -44,14 +72,6 @@ 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
+Capture the logging output of the Cycle Analyst and optionally Phaserunner to a file
 
 

data/lib/cycle_analyst_logger/cycle_analyst.rb

@@ -1,13 +1,28 @@
 require 'time'
 require 'serialport'
+require 'phaserunner'
 
 module CycleAnalystLogger
   class CycleAnalyst
+    # Cycle Analyst serial port Baudrate
     attr_reader :baudrate
+
+    # Cycle Analyst serial port name
     attr_reader :tty
+
+    # Hash that describes the names, values and units of the Cycle Analyst log data
     attr_reader :dict
+
+    # Handle from the SerialPort object
     attr_reader :serial_io
-    
+
+    # If the phaeserunner should be read
+    attr_reader :enable_phaserunner
+
+    # Handle of the Phaserunner::Modbus object
+    attr_reader :phaserunner
+
+    # 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 },
@@ -25,45 +40,60 @@ module CycleAnalystLogger
       13 => { address: 12, name: "Limit Flags", units: "bit flags", scale: 1}
     }
 
+    # CycleAnalyst New
     def initialize(opts)
-      @baudrate = opts[:baudrate]
-      @tty = opts[:tty]
+      @baudrate = opts[:baud_ca]
+      @tty = opts[:tty_ca]
       @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
     end
 
+    # Forms the proper header line
+    # @return [String] of a printable CSV header line
     def logs_header
-      dict.map do |(address, node)|
+      hdr = dict.map do |(address, node)|
         "#{node[:name]} (#{node[:units]})"
-      end.join(",")
+      end
+      if enable_phaserunner
+        hdr += phaserunner.bulk_log_header.map { |name| "PR #{name}" }
+      end
+      hdr.join(',')
     end
 
+    # Converts a TSV string into an array
     def tsv2array(line)
-      line.split("\t")
+      line.strip.split("\t")
     end
 
-    # Get line from serial port and send to file
+    # Get line from Cycle Analyst serial port, optionally also the Phaserunner and send to stdout and 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 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, line_count, quiet)
+    def get_logs(output_fd, loop_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
+      serial_io.each_line.with_index do |line, idx|
+        output = (
+          [Time.now.utc.round(10).iso8601(6)] +
+          tsv2array(line)
+        )
+        output += phaserunner.bulk_log_data if enable_phaserunner
+        output_line = output.flatten.join(',')
+
+        puts output_line unless 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
+        break if idx >= loop_count
       end
     end
   end

data/lib/cycle_analyst_logger/main.rb

@@ -1,14 +1,23 @@
 require 'gli'
 
 module CycleAnalystLogger
+  # Handle Ctl-C exit
+  trap "SIGINT" do
+    puts "Exiting"
+    exit 130
+  end
 
   class Cli
-    attr_reader :ca
+    attr_reader :cycle_analyst
+    attr_reader :enable_phaserunner
+    attr_reader :pr
+    attr_reader :quiet
+    attr_reader :loop_count
 
     include GLI::App
 
     def main
-      program_desc 'Store the streaming data log output of a Grin Cycle Analyst V3'
+      program_desc 'Store the streaming data log output of a Grin Cycle Analyst V3 and optionally a Phaserunner'
 
       version CycleAnalystLogger::VERSION
 
@@ -16,30 +25,44 @@ module CycleAnalystLogger
       arguments :strict
       sort_help :manually
 
-      desc 'Serial (USB) device'
+      desc 'Cycle Analyst Serial (USB) device'
       default_value '/dev/ttyUSB1'
       arg 'tty', :optional
-      flag [:t, :tty]
+      flag [:t, :tty_ca]
 
-      desc 'Serial port baudrate'
+      desc 'Cycle Analyst Serial port baudrate'
       default_value 9600
       arg 'baudrate', :optional
-      flag [:b, :baudrate]
+      flag [:b, :baud_ca]
+
+      desc 'Get PhaseRunner Logs also'
+      default_value true
+      arg 'enable_phaserunner', :optional
+      flag [:enable_phaserunner]
+
+      desc 'Phaserunner Serial (USB) device'
+      default_value '/dev/ttyUSB0'
+      arg 'tty', :optional
+      flag [:tty_pr]
+
+      desc 'Phaserunner Serial port baudrate'
+      default_value 115200
+      arg 'baudrate', :optional
+      flag [:baud_pr]
+
+      desc "How many lines to read"
+      default_value :forever
+      flag [:l, :loop_count]
 
       desc 'Do not output to stdout'
       switch [:q, :quiet]
 
-      desc 'Capture the logging output of the CA to a file'
+      desc 'Capture the logging output of the Cycle Analyst and optionally Phaserunner 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)
+          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)
         end
       end
 
@@ -49,7 +72,15 @@ module CycleAnalystLogger
         # chosen command
         # Use skips_pre before a command to skip this block
         # on that command only
-        @ca = CycleAnalyst.new(global)
+        @quiet = global[:quiet]
+        # Handle that loop_count can be :forever or an Integer
+        @loop_count = if global[:loop_count] == :forever
+                        Float::INFINITY
+                      else
+                        global[:loop_count].to_i
+                      end
+        @enable_phaserunner = global[:enable_phaserunner]
+        @cycle_analyst = CycleAnalyst.new(global)
       end
 
       post do |global,command,options,args|

data/lib/cycle_analyst_logger/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cycle_analyst_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert J. Berger
@@ -38,6 +38,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: phaserunner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +104,22 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +148,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Read and store log output from the Grin Cycle Analyst
+description: Read and store log output from the Grin Cycle Analyst and optionally
+  Phaserunner
 email:
 - rberger@ibd.com
 executables:
@@ -173,5 +200,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Read and store log output from the Grin Cycle Analyst
+summary: Read and store log output from the Grin Cycle Analyst and Phaserunner
 test_files: []