phaserunner 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87c1d0249d18a43fb7e048a536af0bc908ab5dbe
-  data.tar.gz: 2bb48bc573a75916c5e2b2429474c5168f44b092
+  metadata.gz: b1dcf2ac4e83fe77fc1eb60f4992253de50c9ace
+  data.tar.gz: 91728742cf1a696bc2570ee28d0dde63b9f9e1da
 SHA512:
-  metadata.gz: 708604d673edf3de8125d7fc87ee1bf546b2827c911a7deecee69948ac741ec917ca73270d578e0c5b5571c6519387fe9445091f40d4fc75fffa56ddaadce8ae
-  data.tar.gz: 077551a923681d39bf69c82440ba29f21f105ba8426b611546e07aa4ecd226721164b6e8d0903ef4f2b4e37ed311afed2e879353ab9368af6d0f05cf77a79a3e
+  metadata.gz: ca1bdc6f822340a8a0033411951b4fdcb7b3e1c5469749e671ac5461f97576936ec2c7667708eaa861c30e363586332205ac54995545e1f1a96b91c5152cf41d
+  data.tar.gz: fc303b29ccee47bd3e1504925ced6935215f21b7d780106b7e2844b05e2acab4f088a93d01dbeb13f0c037b7e58585de8cffce571decff9ef424ca0ee648d08f

data/lib/phaserunner/main.rb

@@ -3,17 +3,23 @@ require 'json'
 require 'pp'
 
 module Phaserunner
+  # Handle Ctl-C exit
+  trap "SIGINT" do
+    puts "Exiting"
+    exit 130
+  end
 
   class Cli
     attr_reader :modbus
     attr_reader :dict
     attr_reader :loop
+    attr_reader :quiet
     attr_reader :phaserunnerOutFd
 
     include GLI::App
 
     def main
-      program_desc 'Read values from the Grin PhaseRunner Controller for logging'
+      program_desc 'Read values from the Grin PhaseRunner Controller primarily for logging'
 
       version Phaserunner::VERSION
 
@@ -42,10 +48,12 @@ module Phaserunner
       flag [:d, :dictionary_file]
 
       desc 'Loop the command n times'
-      default_value 10
+      default_value :forever
       arg 'loop', :optional
-      flag [:l, :loop], type: Integer
-      # flag [:l, :loop], :desc => 'Loop the command n times', :type => Integer
+      flag [:l, :loop]
+
+      desc 'Do not output to stdout'
+      switch [:q, :quiet]
 
       desc 'Read a single or multiple adjacent registers from and address'
       arg_name 'register_address'
@@ -59,33 +67,28 @@ module Phaserunner
           address = args[0].to_i
           count = args[1].to_i
           node = dict[address]
-          puts modbus.range_address_header(address, count).join(",")
+          puts modbus.range_address_header(address, count).join(",") unless quiet
           (0..loop).each do |i|
-            puts modbus.read_raw_range(address, count).join(",")
+            puts modbus.read_raw_range(address, count).join(",") unless quiet
           end
         end
       end
 
-      desc 'Logs a range plus bulk sparse set of registers with multiple addresses to stdout and file'
+      desc 'Logs interesting Phaserunner registers to stdout and file'
       long_desc %q(Logs interesting Phaserunner registers to stdout and a CSV file. File name in the form: phaserunner.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv)
       command :log do |log|
-        log.desc 'Do not output to stdout'
-        log.switch [:q, :quiet]
         log.action do |global_options, options, args|
-          quiet = options[:quiet]
-          start_address = 258
-          count = 12
-          misc_addresses =[277,334]
-          header = modbus.bulk_log_header(start_address, count, misc_addresses)
-          data = modbus.bulk_log_data(start_address, count, misc_addresses)
+          header = modbus.bulk_log_header
+          data = modbus.bulk_log_data
 
+          # Generate and output header line
           hdr = %Q(Timestamp,#{header.join(",")})
-          puts hdr if not quiet
+          puts hdr unless quiet
           phaserunnerOutFd.puts hdr
 
           (0..loop).each do |i| 
             str = %Q(#{Time.now.utc.round(10).iso8601(6)},#{data.join(",")})
-            puts str if not quiet
+            puts str unless quiet
             phaserunnerOutFd.puts str
             sleep 0.2
           end
@@ -100,7 +103,13 @@ module Phaserunner
         # on that command only
         @modbus = Modbus.new(global)
         @dict = @modbus.dict
-        @loop = global[:loop]
+        # Handle that loop can be :forever or an Integer
+        if global[:loop] == :forever
+          @loop = Float::INFINITY
+        else
+          @loop = global[:loop].to_i
+        end
+        @quiet = global[:quiet]
         @phaserunnerOutFd = File.open("phaserunner.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv", 'w')
       end
 

data/lib/phaserunner/modbus.rb

@@ -5,6 +5,13 @@ require 'asi_bod'
 module Phaserunner
   # Methods for communicating with the Modbus interface to the Phaserunner
   class Modbus
+    # The registers of interest for logging
+    # First a range
+    REGISTERS_START_ADDRESS = 258
+    REGISTERS_COUNT = 12
+    # Sparse Registers of interest
+    REGISTERS_MISC =[277,334]
+
     # Contains the Grin Phaesrunner Modbus Dictionary
     # @params [Hash<Integer, Hash>] dict The Dictionary with a key for each register address
     # @option dict [String] :name Name of the register
@@ -18,6 +25,10 @@ module Phaserunner
     # @option dict [Stirng] :type Further info on how to interpret the value
     attr_reader :dict
 
+    attr_reader :registers_start_address
+    attr_reader :registers_count
+    attr_reader :registers_misc
+
     # Returns the path to the default BODm.json file
     def self.default_file_path
       AsiBod::Bod.default_file_path
@@ -36,6 +47,9 @@ module Phaserunner
       opts.each_pair do |name, value|
         self.class.send(:attr_accessor, name)
         instance_variable_set("@#{name}", value)
+        @registers_start_address = REGISTERS_START_ADDRESS
+        @registers_count = REGISTERS_COUNT
+        @registers_misc = REGISTERS_MISC
       end
 
       @bod = AsiBod::Bod.new(bod_file: dictionary_file)
@@ -70,20 +84,20 @@ module Phaserunner
     end
 
     # More optimized data fetch. Gets an address range + misc individual addresses
-    # @param start_address [Integer] Initial address of the range
-    # @param count [Integer] Count of addresses in range
-    # @param misc_addresses [Array<Integer>] List of misc individual addresses
+    # @param start_address [Integer] Initial address of the range. Optional, has a default
+    # @param count [Integer] Count of addresses in range. Optional, has a default
+    # @param misc_addresses [Array<Integer>] List of misc individual addresses. Optional, has a default
     # @return [Array<Integer>] List of the register values in the order requested
-    def bulk_log_data(start_address, count, misc_addresses)
+    def bulk_log_data(start_address=registers_start_address, count=registers_count, misc_addresses=registers_misc)
       read_raw_range(start_address, count) + read_addresses(misc_addresses)
     end
 
     # Get the headers for the bulk_log data
-    # @param start_address [Integer] Initial address of the range
-    # @param count [Integer] Count of addresses in range
-    # @param misc_addresses [Array<Integer>] List of misc individual addresses
+    # @param start_address [Integer] Initial address of the range. Optional, has a default
+    # @param count [Integer] Count of addresses in range. Optional, has a default
+    # @param misc_addresses [Array<Integer>] List of misc individual addresses.  Optional, has a default
     # @return [Array<String>] Array of the headers
-    def bulk_log_header(start_address, count, misc_addresses)
+    def bulk_log_header(start_address=registers_start_address, count=registers_count, misc_addresses=registers_misc)
       range_address_header(start_address, count) +
         bulk_addresses_header(misc_addresses)
     end

data/lib/phaserunner/version.rb

@@ -1,3 +1,3 @@
 module Phaserunner
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phaserunner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Robert J. Berger