farmbot-serial 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07780e1523d04161c781211ba25173ffa6e51db0
-  data.tar.gz: f2677ab821c15c5664f099d7afd7e51805b2f2b2
+  metadata.gz: 873981048eab4aa88fcf4cacae9f3c88de7a4073
+  data.tar.gz: c56dc431685db09f7238cf2ae7285acc1cc05f9c
 SHA512:
-  metadata.gz: 34dffc021c50794f21635582f35c102f6199c9ee349bb53f496ec9b15655c702ba4f01725c713366b1cd4611b588fa47212bd7346418ad08aa85b25cdbd9cc09
-  data.tar.gz: 6f5bc299b55e95d3083c255d0f30d13f7b7db18b3a36740a61cc4d923f6f4e14f4f73fb367d1b6198293ebcc1660b845ffd96225e0480099240fa83a6ded11c6
+  metadata.gz: 31f5d25c1b2fcd205b240b4d8f8bfcad3adde8be560f288db9f8d14c0a31cc800420c0fe9b5b92d2f7dd1f2a345082362ad83bb62f0a9e88077ec121eb33b772
+  data.tar.gz: 138d3fc9b44b824a3081656fbcfd994aa0cd3e4bcbd6d4400f5bb25bb3f67169bad4eade7f9d123c00438c1cb3d66e262a9beab7ead0db4d4a3fe54a6fbb4d6e

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 *.swp
 .bundle/*

data/farmbot-serial.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "farmbot-serial"
-  spec.version       = '0.0.1' # TODO: Fb::Serial::VERSION
+  spec.version       = '0.0.2' # TODO: Fb::VERSION
   spec.authors       = ["Tim Evers", "Rick Carlino"]
   spec.email         = ["rick.carlino@gmail.com"]
   spec.description   = "Serial library for Farmbot"
@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"#,        "~> 0.10"
   spec.add_development_dependency "simplecov"#,  "~> 0.9"
 
-  spec.add_runtime_dependency        "serialport"#, "~> 1.3"
+  spec.add_runtime_dependency     "serialport"#, "~> 1.3"
 end

data/lib/hardware_interface_arduino.rb

@@ -7,22 +7,28 @@
 module Fb
   class HardwareInterfaceArduino
 
-    attr_accessor :ramps_param, :ramps_main
-    #attr_accessor :test_serial_read, :test_serial_write
     attr_accessor :serial_port
-    attr_accessor :external_info
+ 
+    attr_reader :is_busy
+    attr_reader :is_error
+    attr_reader :is_done
+    attr_reader :return_values
 
     # initialize the interface
     #
     def initialize(test_mode)
-      @status_debug_msg = $debug_msg
-
-      @test_mode         = test_mode
+      @status_debug_msg  = $debug_msg
+      @test_mode         = test_mode      
 
       # connect to arduino
       connect_board()
 
-      @external_info         = ""
+      @external_info     = ""
+      @return_values     = Queue.new
+
+      @is_busy           = false
+      @is_error          = false
+      @is_done           = false
 
     end
 
@@ -50,32 +56,37 @@ module Fb
 
     # write a command to the robot
     #
-    def execute_command(text, log, onscreen)
+    def write_command(text, log, onscreen)
       begin
 
         write_status = create_write_status(text, log, onscreen)
+        write_to_serial(write_status)
+        
+        @parameters = []
+        @is_busy    = true
+        @is_error   = false
 
-  #puts @serial_port.test_serial_read
-        prepare_serial_port(write_status)
-  #puts @serial_port.test_serial_read
-
-        # wait until the arduino responds
-        while(write_status.is_busy())
+      rescue => e
+        handle_execution_exception(e)
+      end
+    end
 
+    # check the responses from the robot
+    #
+    def check_command_execution
+      begin
+        if Time.now - write_status.start < write_status.timeout and @is_done == 0
+          @is_error = true
+        else
           check_emergency_stop
           process_feedback(write_status)
-
         end
-
-        log_result_of_execution(write_status)
-
       rescue => e
-  #puts 'exception received'
-  #puts e
         handle_execution_exception(e)
       end
     end
 
+
     def create_write_status(text, log, onscreen)
       write_status = Fb::HardwareInterfaceArduinoWriteStatus.new
       write_status.text     = text
@@ -89,18 +100,16 @@ module Fb
       puts("ST: serial error\n#{e.message}\n#{e.backtrace.inspect}")
       @serial_port.rts = 1
       connect_board
-      sleep 5 if @test_mode == false
+      @is_error = true
     end
 
-    def log_result_of_execution(write_status)
-
-      # log things if needed
-      if write_status.done == 1
-        puts 'ST: done' if write_status.onscreen
-      else
-        puts 'ST: timeout'
-        sleep 5 if @test_mode == false
-      end
+    # set the serial port ready to send and write the text
+    #
+    def write_to_serial(write_status)
+      puts "WR: #{write_status.text}" if write_status.onscreen
+      @serial_port.read_timeout = 2
+      clean_serial_buffer() if @test_mode == false
+      serial_port_write( "#{write_status.text}\n" )
     end
 
     # receive all characters coming from the serial port
@@ -108,31 +117,24 @@ module Fb
     def process_feedback(write_status)
       i = @serial_port.read(1)
 
-  #print "-#{i}"
-  #print "#{i}"
-
       if i != nil
         i.each_char do |c|
-
-          add_and_process_characters(write_status, c)
-
+          process_characters(write_status, c)
         end
       else
         sleep 0.001 if @test_mode == false
-        #write_status.done = 1 if @test_mode == true
       end
     end
 
     # keep incoming characters in a buffer until it is a complete string
     #
-    def add_and_process_characters(write_status, c)
+    def process_characters(write_status, c)
 
       if c == "\r" or c == "\n"
         if write_status.received.length >= 3
           log_incoming_text(write_status)
           write_status.split_received
           process_code_and_params(write_status)
-
         end
       else
         write_status.received = write_status.received + c
@@ -153,11 +155,11 @@ module Fb
         # command is finished
         when 'R02'
           write_status.done = 1
-
+          @is_done = true
         # command is finished with errors
         when 'R03'
           write_status.done = 1
-
+          @is_done = true
         # command is still ongoing
         when 'R04'
           write_status.start = Time.now
@@ -172,15 +174,6 @@ module Fb
 
     end
 
-    # set the serial port ready to send
-    #
-    def prepare_serial_port(write_status)
-      puts "WR: #{write_status.text}" if write_status.onscreen
-      @serial_port.read_timeout = 2
-      clean_serial_buffer() if @test_mode == false
-      serial_port_write( "#{write_status.text}\n" )
-    end
-
     # empty the input buffer so no old data is processed
     #
     def clean_serial_buffer
@@ -195,10 +188,8 @@ module Fb
 
     # if there is an emergency stop, immediately write it to the arduino
     #
-    def check_emergency_stop
-      if (Fb::HardwareInterface.current.status.emergency_stop)
-       serial_port_write( "E\n" )
-      end
+    def emergency_stop
+     serial_port_write( "E\n" )
     end
 
     # write to log
@@ -211,136 +202,44 @@ module Fb
     #
     def process_value(code,text)
 
-      params = Fb::HardwareInterfaceArduinoValuesReceived.new
-
-      process_value_split(code, params, text)
+      # get all parameters in the current text
+      return_value = process_value_split(code, text)
 
-      # depending on the report code, process the values
-      # this is done by reading parameter names and their values
-      # and respong on it as needed
-
-      process_value_process_param_list(params,code)
-      process_value_process_named_params(params,code)
-      process_value_process_text(code,text)
+      # save the list for the client
+      @return_values << return_value
 
     end
 
-    def process_value_split(code, params, text)
+    def process_value_split(code, text)
+
+      params = Fb::HardwareInterfaceArduinoValuesReceived.new
+      params.code = code
+      params.text = text
 
       # get all separate parameters from the text
       text.split(' ').each do |param|
 
-        if code == "R81"
-         # this is the only code that uses two letter parameters
-          par_code  = param[0..1].to_s
+        case code 
+	when "R81"
+          # this is the only code that uses two letter parameters
+          par_name  = param[0..1].to_s
           par_value = param[2..-1].to_i
         else
-          par_code  = param[0..0].to_s
+          par_name  = param[0..0].to_s
           par_value = param[1..-1].to_i
         end
 
-        params.load_parameter(par_code, par_value)
-
-      end
-
-    end
-
-    def process_value_process_param_list(params,code)
-      #if params.p != 0
-        process_value_R21(params,code)
-        process_value_R23(params,code)
-        process_value_R41(params,code)
-      #end
-    end
-
-
-    # Process report parameter value
-    #
-    def process_value_R21(params,code)
-      if code == 'R21'
-        param = @ramps_param.get_param_by_id(params.p)
-        if param != nil
-          param['value_ar'] = params.v
-        end
-      end
-    end
-
-    # Process report parameter value and save to database
-    #
-    def process_value_R23(params,code)
-      if code == 'R23'
-        param = @ramps_param.get_param_by_id(params.p)
-        if param != nil
-          @ramps_param.save_param_value(params.p, :by_id, :from_db, params.v)
-        end
-      end
-    end
-
-    # Process report pin values
-    #
-    def process_value_R41(params,code)
-      raise 'Not implemented.'
-    end
-
-    def process_value_process_named_params(params,code)
-      process_value_R81(params,code)
-      process_value_R82(params,code)
-    end
-
-    # Process report end stops
-    #
-    def process_value_R81(params,code)
-      if code == 'R81'
-        Fb::HardwareInterface.current.status.info_end_stop_x_a = (params.xa == 1)
-        Fb::HardwareInterface.current.status.info_end_stop_x_b = (params.xb == 1)
-        Fb::HardwareInterface.current.status.info_end_stop_y_a = (params.ya == 1)
-        Fb::HardwareInterface.current.status.info_end_stop_y_b = (params.yb == 1)
-        Fb::HardwareInterface.current.status.info_end_stop_z_a = (params.za == 1)
-        Fb::HardwareInterface.current.status.info_end_stop_z_b = (params.zb == 1)
-      end
-    end
-
-    # Process report position
-    def process_value_R82(params,code)
-      if code == 'R82'
-
-        Fb::HardwareInterface.current.status.info_current_x_steps = params.x
-        Fb::HardwareInterface.current.status.info_current_x       = params.x / @ramps_param.axis_x_steps_per_unit
-
-        Fb::HardwareInterface.current.status.info_current_y_steps = params.y
-        Fb::HardwareInterface.current.status.info_current_y       = params.y / @ramps_param.axis_y_steps_per_unit
+        params.load_parameter(par_name, par_value)
 
-        Fb::HardwareInterface.current.status.info_current_z_steps = params.z
-        Fb::HardwareInterface.current.status.info_current_z       = params.z / @ramps_param.axis_z_steps_per_unit
-
-      end
-    end
-
-    def process_value_process_text(code,text)
-      process_value_process_R83(code,text)
-      process_value_process_R99(code,text)
-    end
-
-    # Process report software version
-    #
-    def process_value_process_R83(code,text)
-      if code == 'R83'
-          Fb::HardwareInterface.current.status.device_version = text
       end
-    end
 
-    # Process report of a debug comment
-    #
-    def process_value_process_R99(code,text)
-      if code == 'R99'
-          puts ">#{text}<"
-      end
+      return params
     end
 
     def puts(*)
       # Too many messages in the test buffer right now. Will delete this later.
       # just disabling it for now.
-      STDOUT.print('╳')
+      STDOUT.print('x')
     end
   end
 end

data/lib/hardware_interface_arduino_values_received.rb

@@ -1,6 +1,12 @@
 module Fb
   class HardwareInterfaceArduinoValuesReceived
 
+    attr_accessor :code
+    attr_accessor :text
+    attr_accessor :external_info
+
+    # value holders with the name used in the serial 
+    # communucation as they are received from arduino
     attr_accessor :p , :v
     attr_accessor :x , :y , :z
     attr_accessor :xa, :xb
@@ -21,7 +27,8 @@ module Fb
       @yb = 0
       @za = 0
       @zb = 0
-
+      @text = ''
+      @code = 0
     end
 
     def load_parameter(name, value)

data/lib/hardware_interface_write_status.rb

@@ -0,0 +1,35 @@
+class HardwareInterfaceArduinoWriteStatus
+
+  attr_accessor :done
+  attr_accessor :code
+  attr_accessor :received
+  attr_accessor :start
+  attr_accessor :log
+  attr_accessor :onscreen
+  attr_accessor :text
+  attr_accessor :params
+  attr_accessor :timeout
+
+  def initialize
+    @done     = 0
+    @code     = ''
+    @received = ''
+    @text     = ''
+    @params   = ''
+    @log      = false
+    @onscreen = false
+    @start    = Time.now
+    @timeout  = 5
+  end
+
+#  def is_busy
+#    Time.now - @start < @timeout and @done == 0
+#  end
+
+  def split_received
+    # get the parameter and data part
+    @code   = received[0..2].upcase
+    @params = received[3..-1].to_s.upcase.strip
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-serial
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tim Evers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,20 +107,13 @@ files:
 - README.md
 - Rakefile
 - farmbot-serial.gemspec
-- lib/arduino_default_params.rb
 - lib/farmbot-serial.rb
-- lib/hardware_interface.rb
 - lib/hardware_interface_arduino.rb
 - lib/hardware_interface_arduino_values_received.rb
-- lib/hardware_interface_arduino_write_status.rb
-- lib/hardware_interface_param.rb
+- lib/hardware_interface_write_status.rb
 - lib/serial_port_sim.rb
-- lib/status.rb
 - spec/lib/ramps_arduino_spec.rb
 - spec/lib/ramps_arduino_values_received_spec.rb
-- spec/lib/ramps_arduino_write_status_spec.rb
-- spec/lib/ramps_param_spec.rb
-- spec/lib/ramps_spec.rb
 - spec/spec_helper.rb
 - testcommands.csv
 homepage: http://github.com/farmbot/farmbot-serial
@@ -150,7 +143,4 @@ summary: Serial library for Farmbot
 test_files:
 - spec/lib/ramps_arduino_spec.rb
 - spec/lib/ramps_arduino_values_received_spec.rb
-- spec/lib/ramps_arduino_write_status_spec.rb
-- spec/lib/ramps_param_spec.rb
-- spec/lib/ramps_spec.rb
 - spec/spec_helper.rb