farmbot-serial 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 873981048eab4aa88fcf4cacae9f3c88de7a4073
-  data.tar.gz: c56dc431685db09f7238cf2ae7285acc1cc05f9c
+  metadata.gz: 11e0f51d8ab86f321618b7624b564390dea98f8a
+  data.tar.gz: b4ee5f17fc86632387f3bbe853637eed6ee16d60
 SHA512:
-  metadata.gz: 31f5d25c1b2fcd205b240b4d8f8bfcad3adde8be560f288db9f8d14c0a31cc800420c0fe9b5b92d2f7dd1f2a345082362ad83bb62f0a9e88077ec121eb33b772
-  data.tar.gz: 138d3fc9b44b824a3081656fbcfd994aa0cd3e4bcbd6d4400f5bb25bb3f67169bad4eade7f9d123c00438c1cb3d66e262a9beab7ead0db4d4a3fe54a6fbb4d6e
+  metadata.gz: cdaaf0a5772e4c18e1f8236ac9c02af0747150caf715c42e08dd8f506ec8e0795f7268d70997b599f38790ac7beefd4ba1951693433ae96b408d4080e6a50637
+  data.tar.gz: ad07522eb174172366067978f59979a965d208b4c3b5d4f5b82ebcf87a03a2fb89ba3a94d9f3fef382b92ff811a148d4cd0eca6f0f9fe6ed0d9820324126552d

data/.gitignore

@@ -43,3 +43,4 @@ snippets.rb
 tmp/**/*
 *.rb~
 Gemfile.lock
+idea.rb

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/lib/arduino.rb

@@ -0,0 +1,41 @@
+## HARDWARE INTERFACE
+## ******************
+
+# Communicate with the arduino using a serial interface
+# All information is exchanged using a variation of g-code
+# Parameters are stored in the database
+module FB
+  class Arduino
+    class EmergencyStop < StandardError; end # Not yet used.
+
+    attr_reader :serial_port, :logger
+
+    # Initial and provide a serial object, as well as an IO object to send
+    # log messages to. Default SerialPort is DefaultSerialPort. Default logger
+    # is STDOUT
+    def initialize(serial_port = DefaultSerialPort.new, logger = STDOUT)
+      @serial_port, @logger = serial_port, logger
+    end
+
+    # Log to screen/file/IO stream
+    def log(message)
+      logger.puts(message)
+    end
+
+    # Handle incoming text from arduino into pi
+    def read(string)
+      log "RECEIVED #{string}"
+    end
+
+    # Send outgoing test to arduino from pi
+    def write(string)
+      serial_port.puts string
+      log "SENT #{string}"
+    end
+
+    # Handle loss of serial connection
+    def disconnect
+      log "Connection to device lost"
+    end
+  end
+end

data/lib/arduino_event_machine.rb

@@ -0,0 +1,20 @@
+require 'eventmachine'
+module FB
+  # Class that is fed into event machine's event loop to handle incoming serial
+  # messages asynchronously via EM.attach(). See: EM.attach
+  class ArduinoEventMachine < EventMachine::Connection
+    class << self
+      attr_accessor :arduino
+    end
+
+    def receive_data(data)
+      self.class.arduino.read(data)
+    end
+
+    # Gets called when the connection breaks.
+    def unbind
+      self.class.arduino.disconnect
+      EM.stop
+    end
+  end
+end

data/lib/default_serial_port.rb

@@ -0,0 +1,19 @@
+require 'serialport'
+
+# This object creates a Serial IO with sane default, since most FarmBot setups
+# follow the same serial configuration setup.
+class DefaultSerialPort < SerialPort
+  COM_PORT = '/dev/ttyACM0'
+  OPTIONS  = { "baud"         => 115200,
+               "data_bits"    => 8,
+               "stop_bits"    => 1,
+               "parity"       => SerialPort::NONE,
+               "flow_control" => SerialPort::SOFT }
+
+  # Why `def self::new()`? it was defined that way in the parent class,
+  # therefore, I can't call super in #initialize().
+  def self::new(com = COM_PORT, conf = OPTIONS)
+    super
+  end
+end
+

data/lib/farmbot-serial.rb

@@ -1,9 +1,5 @@
 require 'serialport'
-require 'serial_port_sim'
-require 'status'
-require 'arduino_default_params'
-require 'hardware_interface_arduino'
-require 'hardware_interface_param'
-require 'hardware_interface'
-require 'hardware_interface_arduino_values_received'
-require 'hardware_interface_arduino_write_status'
+
+require_relative 'default_serial_port'
+require_relative 'arduino_event_machine'
+require_relative 'arduino'

data/lib/hardware_interface_arduino_values_received.rb

@@ -1,21 +1,15 @@
-module Fb
+module FB
+  # Rename to StatusIndicator or StatusRegister
   class HardwareInterfaceArduinoValuesReceived
 
-    attr_accessor :code
-    attr_accessor :text
-    attr_accessor :external_info
+    attr_accessor :code, :text, :external_info
 
-    # value holders with the name used in the serial 
+    # 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
-    attr_accessor :ya, :yb
-    attr_accessor :za, :zb
+    attr_accessor :p , :v, :x , :y , :z, :xa, :xb, :ya, :yb, :za, :zb
 
 
     def initialize
-
       @p  = -1
       @v  = 0
       @x  = 0
@@ -30,32 +24,34 @@ module Fb
       @text = ''
       @code = 0
     end
-
+    # Change name to []=?
     def load_parameter(name, value)
-
+      name = name.upcase.to_sym
       case name
-        when 'P'
+        when :P
           @p  = value
-        when 'V'
+        when :V
           @v  = value
-        when 'XA'
+        when :XA
           @xa = value
-        when 'XB'
+        when :XB
           @xb = value
-        when 'YA'
+        when :YA
           @ya = value
-        when 'YB'
+        when :YB
           @yb = value
-        when 'ZA'
+        when :ZA
           @za = value
-        when 'ZB'
+        when :ZB
           @zb = value
-        when 'X'
+        when :X
           @x  = value
-        when 'Y'
+        when :Y
           @y  = value
-        when 'Z'
+        when :Z
           @z  = value
+        else
+          raise "Unknown status symbol '#{name}'"
       end
     end
 

data/lib/outbound_message.rb

@@ -0,0 +1,58 @@
+# An outbound (Pi -> Arduino) status message.
+# Originally HardwareInterfaceArduinoWriteStatus
+class OutboundMessage
+
+  attr_accessor :done, :code, :received, :start, :log, :onscreen, :text,
+                :params, :timeout
+
+  def initialize(text)
+    @text     = text
+    @done     = 0
+    @code     = ''
+    @received = ''
+    @text     = ''
+    @params   = ''
+    @log      = false
+    @onscreen = false
+    @start    = Time.now
+    @timeout  = 5
+  end
+
+  def parse_response!
+    # get the parameter and data part
+    @code   = received[0..2].upcase
+    @params = received[3..-1].to_s.upcase.strip
+  end
+
+  # handle the incoming message depending on the first code number
+  #
+  def process_code_and_params
+
+  # process the feedback
+  case self.code
+
+  # command received by arduino
+  when 'R01'
+    self.timeout = 90
+  # command is finished
+  when 'R02'
+    self.done = 1
+    @is_done = true
+  # command is finished with errors
+  when 'R03'
+    self.done = 1
+    @is_done = true
+  # command is still ongoing
+  when 'R04'
+    self.start = Time.now
+    self.timeout = 90
+  # specific feedback that is processes separately
+  else
+    process_value(self.code,self.params)
+  end
+
+  self.received = ''
+
+  end
+
+end

data/spec/fixtures/stub_serial_port.rb

@@ -0,0 +1,19 @@
+## SERIAL PORT SIMULATION
+## **********************
+
+# Used for unit tests
+
+module FB
+  class StubSerialPort
+    def initialize(comm_port, parameters)
+    end
+
+    def write(text)
+      text
+    end
+
+    def read(characters)
+      characters
+    end
+  end
+end

data/spec/lib/ramps_arduino_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
-describe Fb::HardwareInterfaceArduino do
+describe FB::HardwareInterfaceArduino do
 
   before do
-    Fb::HardwareInterface.current.status = Fb::Status.new
+    FB::HardwareInterface.current.status = FB::Status.new
 
-    @ramps = Fb::HardwareInterfaceArduino.new(true)
+    @ramps = FB::HardwareInterfaceArduino.new(true)
 
-    @ramps_param = Fb::HardwareInterfaceParam.new
+    @ramps_param = FB::HardwareInterfaceParam.new
     @ramps.ramps_param = @ramps_param
   end
 
@@ -27,12 +27,12 @@ describe Fb::HardwareInterfaceArduino do
 
   it "execute_command with causing an error"  do
 
-    Fb::HardwareInterface.current.status = nil
+    FB::HardwareInterface.current.status = nil
 
     @ramps.serial_port.rts = 0
     @ramps.execute_command(nil,nil,nil)
 
-    Fb::HardwareInterface.current.status = Fb::Status.new
+    FB::HardwareInterface.current.status = FB::Status.new
 
     expect { @ramps }.to_not raise_error
 
@@ -183,7 +183,7 @@ describe Fb::HardwareInterfaceArduino do
 
     @ramps.process_code_and_params(write_status)
 
-    expect(Fb::HardwareInterface.current.status.device_version).to eq(write_status.params)
+    expect(FB::HardwareInterface.current.status.device_version).to eq(write_status.params)
 
   end
 
@@ -214,14 +214,14 @@ describe Fb::HardwareInterfaceArduino do
 
   it "emergency stop off" do
     @ramps.serial_port.test_serial_write = ""
-    Fb::HardwareInterface.current.status.emergency_stop = false
+    FB::HardwareInterface.current.status.emergency_stop = false
     @ramps.check_emergency_stop
     expect(@ramps.serial_port.test_serial_write).to eq("")
   end
 
   it "emergency stop on" do
     @ramps.serial_port.test_serial_write = ""
-    Fb::HardwareInterface.current.status.emergency_stop = true
+    FB::HardwareInterface.current.status.emergency_stop = true
     @ramps.check_emergency_stop
     expect(@ramps.serial_port.test_serial_write).to eq("E\n")
   end
@@ -239,7 +239,7 @@ describe Fb::HardwareInterfaceArduino do
 
   it "process value split two letters" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = "ZA1 ZB2 XA3 XB4 YA5 YB6"
     @ramps.process_value_split(code, params, text)
@@ -254,7 +254,7 @@ describe Fb::HardwareInterfaceArduino do
 
   it "process value split one letters" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R99"
     text = "P1 V2 X3 Y4 Z5"
     @ramps.process_value_split(code, params, text)
@@ -275,7 +275,7 @@ describe Fb::HardwareInterfaceArduino do
     code = "R21"
     text = "P#{param} V#{value}"
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R21(params,code)
 
@@ -293,7 +293,7 @@ describe Fb::HardwareInterfaceArduino do
     code = "R23"
     text = "P#{param} V#{value}"
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R23(params,code)
 
@@ -314,7 +314,7 @@ describe Fb::HardwareInterfaceArduino do
 
     @ramps.external_info = exinf
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R41(params,code)
 
@@ -333,103 +333,103 @@ describe Fb::HardwareInterfaceArduino do
 
   it "process value R81 XA" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA1 XB0 YA0 YB0 ZA0 ZB0 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(true)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
 
   end
 
   it "process value R81 XB" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB1 YA0 YB0 ZA0 ZB0 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(true)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
 
   end
 
   it "process value R81 YA" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA1 YB0 ZA0 ZB0 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(true)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
 
   end
 
   it "process value R81 YB" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA0 YB1 ZA0 ZB0 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(true)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
 
   end
 
   it "process value R81 ZA" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA0 YB0 ZA1 ZB0 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(true)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(false)
 
   end
 
   it "process value R81 ZB" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA0 YB0 ZA0 ZB1 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R81(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
 
   end
 
@@ -439,19 +439,19 @@ describe Fb::HardwareInterfaceArduino do
     y = rand(9999999).to_i
     z = rand(9999999).to_i
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R82"
     text = "X#{x} Y#{y} Z#{z}"
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_R82(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_current_x_steps).to eq(x)
-    expect(Fb::HardwareInterface.current.status.info_current_y_steps).to eq(y)
-    expect(Fb::HardwareInterface.current.status.info_current_z_steps).to eq(z)
+    expect(FB::HardwareInterface.current.status.info_current_x_steps).to eq(x)
+    expect(FB::HardwareInterface.current.status.info_current_y_steps).to eq(y)
+    expect(FB::HardwareInterface.current.status.info_current_z_steps).to eq(z)
 
-    expect(Fb::HardwareInterface.current.status.info_current_x      ).to eq(x / @ramps_param.axis_x_steps_per_unit)
-    expect(Fb::HardwareInterface.current.status.info_current_y      ).to eq(y / @ramps_param.axis_y_steps_per_unit)
-    expect(Fb::HardwareInterface.current.status.info_current_z      ).to eq(z / @ramps_param.axis_z_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_x      ).to eq(x / @ramps_param.axis_x_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_y      ).to eq(y / @ramps_param.axis_y_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_z      ).to eq(z / @ramps_param.axis_z_steps_per_unit)
 
   end
 
@@ -461,7 +461,7 @@ describe Fb::HardwareInterfaceArduino do
 
     @ramps.process_value_process_R83(code, text)
 
-    expect(Fb::HardwareInterface.current.status.device_version).to eq(text)
+    expect(FB::HardwareInterface.current.status.device_version).to eq(text)
   end
 
 
@@ -502,7 +502,7 @@ describe Fb::HardwareInterfaceArduino do
     code = "R21"
     text = "P#{param} V#{value}"
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_process_param_list(params,code)
 
@@ -521,7 +521,7 @@ describe Fb::HardwareInterfaceArduino do
     code = "R23"
     text = "P#{param} V#{value}"
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_process_param_list(params,code)
 
@@ -544,7 +544,7 @@ describe Fb::HardwareInterfaceArduino do
 
     @ramps.external_info = exinf
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_process_param_list(params,code)
 
@@ -568,7 +568,7 @@ describe Fb::HardwareInterfaceArduino do
 
     @ramps.process_value_process_R83(code, text)
 
-    expect(Fb::HardwareInterface.current.status.device_version).to eq(text)
+    expect(FB::HardwareInterface.current.status.device_version).to eq(text)
 
   end
 
@@ -615,34 +615,34 @@ describe Fb::HardwareInterfaceArduino do
 
   it "process value 3" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA0 YB0 ZA0 ZB1 "
     @ramps.process_value(code,text)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
 
   end
 
   it "process value named parameters 1" do
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R81"
     text = " XA0 XB0 YA0 YB0 ZA0 ZB1 "
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_process_named_params(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
-    expect(Fb::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_x_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_y_b).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_a).to eq(false)
+    expect(FB::HardwareInterface.current.status.info_end_stop_z_b).to eq(true)
 
   end
 
@@ -652,19 +652,19 @@ describe Fb::HardwareInterfaceArduino do
     y = rand(9999999).to_i
     z = rand(9999999).to_i
 
-    params = Fb::HardwareInterfaceArduinoValuesReceived.new
+    params = FB::HardwareInterfaceArduinoValuesReceived.new
     code = "R82"
     text = "X#{x} Y#{y} Z#{z}"
     @ramps.process_value_split(code, params, text)
     @ramps.process_value_process_named_params(params,code)
 
-    expect(Fb::HardwareInterface.current.status.info_current_x_steps).to eq(x)
-    expect(Fb::HardwareInterface.current.status.info_current_y_steps).to eq(y)
-    expect(Fb::HardwareInterface.current.status.info_current_z_steps).to eq(z)
+    expect(FB::HardwareInterface.current.status.info_current_x_steps).to eq(x)
+    expect(FB::HardwareInterface.current.status.info_current_y_steps).to eq(y)
+    expect(FB::HardwareInterface.current.status.info_current_z_steps).to eq(z)
 
-    expect(Fb::HardwareInterface.current.status.info_current_x      ).to eq(x / @ramps_param.axis_x_steps_per_unit)
-    expect(Fb::HardwareInterface.current.status.info_current_y      ).to eq(y / @ramps_param.axis_y_steps_per_unit)
-    expect(Fb::HardwareInterface.current.status.info_current_z      ).to eq(z / @ramps_param.axis_z_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_x      ).to eq(x / @ramps_param.axis_x_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_y      ).to eq(y / @ramps_param.axis_y_steps_per_unit)
+    expect(FB::HardwareInterface.current.status.info_current_z      ).to eq(z / @ramps_param.axis_z_steps_per_unit)
 
   end
 

data/spec/lib/ramps_arduino_values_received_spec.rb

@@ -1,18 +1,18 @@
 require 'spec_helper'
-describe Fb::HardwareInterfaceArduinoValuesReceived do
+describe FB::HardwareInterfaceArduinoValuesReceived do
 
   before do
 
 
 
 
-    Fb::HardwareInterface.current.status = Fb::Status.new
+    FB::HardwareInterface.current.status = FB::Status.new
 
-    @ramps = Fb::HardwareInterfaceArduinoValuesReceived.new()
+    @ramps = FB::HardwareInterfaceArduinoValuesReceived.new()
 
-    #@ramps = Fb::HardwareInterfaceArduino.new(true)
+    #@ramps = FB::HardwareInterfaceArduino.new(true)
 
-    #@ramps_param = Fb::HardwareInterfaceParam.new
+    #@ramps_param = FB::HardwareInterfaceParam.new
     #@ramps.ramps_param = @ramps_param
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-serial
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Tim Evers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: serialport
   requirement: !ruby/object:Gem::Requirement
@@ -103,15 +117,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- Gemfile
+- ".rspec"
 - README.md
 - Rakefile
-- farmbot-serial.gemspec
+- lib/arduino.rb
+- lib/arduino_event_machine.rb
+- lib/default_serial_port.rb
 - lib/farmbot-serial.rb
-- lib/hardware_interface_arduino.rb
 - lib/hardware_interface_arduino_values_received.rb
-- lib/hardware_interface_write_status.rb
-- lib/serial_port_sim.rb
+- lib/outbound_message.rb
+- spec/fixtures/stub_serial_port.rb
 - spec/lib/ramps_arduino_spec.rb
 - spec/lib/ramps_arduino_values_received_spec.rb
 - spec/spec_helper.rb
@@ -141,6 +156,7 @@ signing_key:
 specification_version: 4
 summary: Serial library for Farmbot
 test_files:
+- spec/fixtures/stub_serial_port.rb
 - spec/lib/ramps_arduino_spec.rb
 - spec/lib/ramps_arduino_values_received_spec.rb
 - spec/spec_helper.rb

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rspec'
-gem 'pry'
-gem 'simplecov'
-gem 'serialport'

data/farmbot-serial.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |spec|
-  spec.name          = "farmbot-serial"
-  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"
-  spec.summary       = "Serial library for Farmbot"
-  spec.homepage      = "http://github.com/farmbot/farmbot-serial"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler"#,    "~> 1.3"
-  spec.add_development_dependency "rake"#,       "~> 10.4"
-  spec.add_development_dependency "rspec"#,      "~> 3.2"
-  spec.add_development_dependency "pry"#,        "~> 0.10"
-  spec.add_development_dependency "simplecov"#,  "~> 0.9"
-
-  spec.add_runtime_dependency     "serialport"#, "~> 1.3"
-end

data/lib/hardware_interface_arduino.rb

@@ -1,245 +0,0 @@
-## HARDWARE INTERFACE
-## ******************
-
-# Communicate with the arduino using a serial interface
-# All information is exchanged using a variation of g-code
-# Parameters are stored in the database
-module Fb
-  class HardwareInterfaceArduino
-
-    attr_accessor :serial_port
- 
-    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      
-
-      # connect to arduino
-      connect_board()
-
-      @external_info     = ""
-      @return_values     = Queue.new
-
-      @is_busy           = false
-      @is_error          = false
-      @is_done           = false
-
-    end
-
-    ## ARDUINO HANLDING
-    ## ****************
-
-    # connect to the serial port and start communicating with the arduino/firmata protocol
-    #
-    def connect_board
-
-      parameters =
-      {
-        "baud"         => 115200,
-        "data_bits"    => 8,
-        "stop_bits"    => 1,
-        "parity"       => SerialPort::NONE,
-        "flow_control" => SerialPort::SOFT
-      }
-
-      comm_port = '/dev/ttyACM0'
-      @serial_port = SerialPort.new(comm_port, parameters) if @test_mode == false
-      @serial_port = SerialPortSim.new(comm_port, parameters) if @test_mode == true
-
-    end
-
-    # write a command to the robot
-    #
-    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
-
-      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
-      rescue => e
-        handle_execution_exception(e)
-      end
-    end
-
-
-    def create_write_status(text, log, onscreen)
-      write_status = Fb::HardwareInterfaceArduinoWriteStatus.new
-      write_status.text     = text
-      write_status.log      = log
-
-      write_status.onscreen = onscreen
-      write_status
-    end
-
-    def handle_execution_exception(e)
-      puts("ST: serial error\n#{e.message}\n#{e.backtrace.inspect}")
-      @serial_port.rts = 1
-      connect_board
-      @is_error = true
-    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
-    #
-    def process_feedback(write_status)
-      i = @serial_port.read(1)
-
-      if i != nil
-        i.each_char do |c|
-          process_characters(write_status, c)
-        end
-      else
-        sleep 0.001 if @test_mode == false
-      end
-    end
-
-    # keep incoming characters in a buffer until it is a complete string
-    #
-    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
-      end
-    end
-
-    # handle the incoming message depending on the first code number
-    #
-    def process_code_and_params(write_status)
-
-      # process the feedback
-      case write_status.code
-
-        # command received by arduino
-        when 'R01'
-          write_status.timeout = 90
-
-        # 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
-          write_status.timeout = 90
-
-        # specific feedback that is processes separately
-        else
-          process_value(write_status.code,write_status.params)
-      end
-
-      write_status.received = ''
-
-    end
-
-    # empty the input buffer so no old data is processed
-    #
-    def clean_serial_buffer
-      while (@serial_port.read(1) != nil)
-      end
-    end
-
-    # write something to the serial port
-    def serial_port_write(text)
-      @serial_port.write( text )
-    end
-
-    # if there is an emergency stop, immediately write it to the arduino
-    #
-    def emergency_stop
-     serial_port_write( "E\n" )
-    end
-
-    # write to log
-    #
-    def log_incoming_text(write_status)
-      puts "RD: #{write_status.received}" if write_status.onscreen
-    end
-
-    # process values received from arduino
-    #
-    def process_value(code,text)
-
-      # get all parameters in the current text
-      return_value = process_value_split(code, text)
-
-      # save the list for the client
-      @return_values << return_value
-
-    end
-
-    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|
-
-        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_name  = param[0..0].to_s
-          par_value = param[1..-1].to_i
-        end
-
-        params.load_parameter(par_name, par_value)
-
-      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('x')
-    end
-  end
-end

data/lib/hardware_interface_write_status.rb

@@ -1,35 +0,0 @@
-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

data/lib/serial_port_sim.rb

@@ -1,31 +0,0 @@
-## SERIAL PORT SIMULATION
-## **********************
-
-# Used for unit tests
-
-module Fb
-  class SerialPortSim
-    attr_accessor :rts, :read_timeout, :test_serial_read, :test_serial_write
-
-    def initialize(comm_port, parameters)
-      @test_serial_read  = ""
-      @test_serial_write = ""
-    end
-
-    def write(text)
-      @test_serial_write = text
-    end
-
-    def read(characters)
-      i = nil
-      @test_serial_read = nil if @test_serial_read == ""
-
-      if @test_serial_read != nil
-        i = @test_serial_read[0]
-        @test_serial_read = @test_serial_read[1..-1]
-      end
-      i
-    end
-
-  end
-end