phaserunner 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1dcf2ac4e83fe77fc1eb60f4992253de50c9ace
-  data.tar.gz: 91728742cf1a696bc2570ee28d0dde63b9f9e1da
+  metadata.gz: f1406fca710360c306fc0d61dceb3af3bcbe63a4
+  data.tar.gz: 49ca014e29aa8589963bf6e6b2f7bf8d0aeed6c2
 SHA512:
-  metadata.gz: ca1bdc6f822340a8a0033411951b4fdcb7b3e1c5469749e671ac5461f97576936ec2c7667708eaa861c30e363586332205ac54995545e1f1a96b91c5152cf41d
-  data.tar.gz: fc303b29ccee47bd3e1504925ced6935215f21b7d780106b7e2844b05e2acab4f088a93d01dbeb13f0c037b7e58585de8cffce571decff9ef424ca0ee648d08f
+  metadata.gz: 4cffb4f5821f8c2bc9142534cc4634faf964d4948200c4816e50276135bf2099e70fbd07b6d8c992312f0a7c72707ac33ad98acb9a367b10950754346d317046
+  data.tar.gz: 640c45d6fa70cd28e0f3fddedfd890347b78e77be25fd33a93fde48d7c61b3723fba4f011b97080b34d87a014c4f144b56083b842436461d6028dbc8bfffdc0b

data/lib/phaserunner/main.rb

@@ -9,15 +9,16 @@ module Phaserunner
     exit 130
   end
 
+  # Handle the CLI
   class Cli
     attr_reader :modbus
     attr_reader :dict
-    attr_reader :loop
+    attr_reader :loop_count
     attr_reader :quiet
-    attr_reader :phaserunnerOutFd
 
     include GLI::App
 
+    # Does all the CLI work
     def main
       program_desc 'Read values from the Grin PhaseRunner Controller primarily for logging'
 
@@ -49,8 +50,8 @@ module Phaserunner
 
       desc 'Loop the command n times'
       default_value :forever
-      arg 'loop', :optional
-      flag [:l, :loop]
+      arg 'loop_count', :optional
+      flag [:l, :loop_count]
 
       desc 'Do not output to stdout'
       switch [:q, :quiet]
@@ -68,7 +69,7 @@ module Phaserunner
           count = args[1].to_i
           node = dict[address]
           puts modbus.range_address_header(address, count).join(",") unless quiet
-          (0..loop).each do |i|
+          (0..loop_count).each do |i|
             puts modbus.read_raw_range(address, count).join(",") unless quiet
           end
         end
@@ -78,18 +79,20 @@ module Phaserunner
       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.action do |global_options, options, args|
+          filename = "phaserunner.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv"
+          output_fd = File.open(filename, 'w')
           header = modbus.bulk_log_header
           data = modbus.bulk_log_data
 
           # Generate and output header line
           hdr = %Q(Timestamp,#{header.join(",")})
           puts hdr unless quiet
-          phaserunnerOutFd.puts hdr
+          output_fd.puts hdr
 
-          (0..loop).each do |i| 
+          (0..loop_count).each do |i| 
             str = %Q(#{Time.now.utc.round(10).iso8601(6)},#{data.join(",")})
             puts str unless quiet
-            phaserunnerOutFd.puts str
+            output_fd.puts str
             sleep 0.2
           end
         end
@@ -103,14 +106,13 @@ module Phaserunner
         # on that command only
         @modbus = Modbus.new(global)
         @dict = @modbus.dict
-        # Handle that loop can be :forever or an Integer
-        if global[:loop] == :forever
-          @loop = Float::INFINITY
-        else
-          @loop = global[:loop].to_i
-        end
+        # 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
         @quiet = global[:quiet]
-        @phaserunnerOutFd = File.open("phaserunner.#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.csv", 'w')
       end
 
       post do |global,command,options,args|

data/lib/phaserunner/modbus.rb

@@ -5,12 +5,37 @@ require 'asi_bod'
 module Phaserunner
   # Methods for communicating with the Modbus interface to the Phaserunner
   class Modbus
+
+    # Returns the path to the default BODm.json file
+    def self.default_file_path
+      AsiBod::Bod.default_file_path
+    end
+
+    DEFAULTS = {
+      tty: '/dev/ttyUSB0',
+      baudrate: 115200,
+      slave_id: 1,
+      dictionary_file: default_file_path,
+      loop_count: :forever,
+      quiet: false,
+      registers_start_address: 258,
+      registers_count: 12,
+      registers_misc: [277,334]
+    }
+
+    attr_reader :tty
+    attr_reader :baudrate
+    attr_reader :slave_id
+    attr_reader :dictionary_file
+    attr_reader :loop_count
+    attr_reader :quiet
+
     # The registers of interest for logging
     # First a range
-    REGISTERS_START_ADDRESS = 258
-    REGISTERS_COUNT = 12
+    attr_reader :registers_start_address
+    attr_reader :registers_count
     # Sparse Registers of interest
-    REGISTERS_MISC =[277,334]
+    attr_reader :registers_misc
 
     # Contains the Grin Phaesrunner Modbus Dictionary
     # @params [Hash<Integer, Hash>] dict The Dictionary with a key for each register address
@@ -25,39 +50,32 @@ 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
-    end
+    attr_reader :bod
 
     # New Modbus
     #  Converts the opts hash into Class Instance Variables (attr_readers)
     #  Reads the JSON Grin Phaserunner Modbus Dictionary into a Hash
     # @params opts [Hash] comes from the CLI
     def initialize(opts)
+      # Start with defaults and allow input args to override them
+      final_opts = DEFAULTS.merge opts
+
       # Converts each key of the opts hash from the CLI into individual class attr_readers.
       # So they are now available to the rest of this Class as instance variables.
       # The key of the hash becomes the name of the instance variable.
       # They are available to all the methods of this class
       # See https://stackoverflow.com/a/7527916/38841
-      opts.each_pair do |name, value|
+      final_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
 
+      # A few other Instance Variables
       @bod = AsiBod::Bod.new(bod_file: dictionary_file)
       @dict = @bod.hash_data
     end
 
     def read_raw_range(start_address, count)
-      #puts("Reading from #{dict[start_address][:name]} scale: #{dict[start_address][:scale]} units: #{dict[start_address][:units]}")
       cl = ::ModBus::RTUClient.new(tty, baudrate)
       cl.with_slave(slave_id) do |slave|
         slave.read_holding_registers(start_address, count)
@@ -88,7 +106,9 @@ module Phaserunner
     # @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=registers_start_address, count=registers_count, misc_addresses=registers_misc)
+    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
 
@@ -97,10 +117,11 @@ module Phaserunner
     # @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=registers_start_address, count=registers_count, misc_addresses=registers_misc)
+    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
   end
 end
-

data/lib/phaserunner/version.rb

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

metadata

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