farmbot-serial 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6cb4643e76ded7ebfa9d5a162ac7054aa5b073a
-  data.tar.gz: 3ec3133a071facfc6b30c294d0028d4c2aac55a8
+  metadata.gz: 9404c763a32e2450e343004905f6be373c533d49
+  data.tar.gz: 0fc2f566b496fc2ce390e56c900faa46761eb98f
 SHA512:
-  metadata.gz: 6f4e9a3c086c1be7805b9f7a8bba936fb167c5dccb92b22ed6f065b9be4dd68e4680139a82f09c3eb8099af2ebb62d6643fc1ef8ad64d83134b562354e26f182
-  data.tar.gz: 541032dd5e2dd8462da5e1d0eba48e8ec7b555604d90b228fd64ec5a90f59fba7ed356ad04794e51b99ad3e96b27c1e0caf6431d9716a978b286e7dc888a4d04
+  metadata.gz: 1c3a981cf97cdfdf5b125e61d3850927f75741718154856ebb2638bb405858a9176356c832ea41c3268f19a97318b10fc8f158e330f91e9aef9a0f01accabf61
+  data.tar.gz: d5788707dc01441531d127a987b69417aaaa91f7054814b8ec74e06a16003355c70bce1e41f89c42422869b247fec8ac2f0e55f1d9c454d38fbb7f2e17041013

data/lib/arduino.rb

@@ -7,7 +7,6 @@ require_relative 'arduino/status'
 # Communicate with the arduino using a serial interface
 module FB
   class Arduino
-    class EmergencyStop < StandardError; end # Not yet used.
     Position = Struct.new(:x, :y, :z)
 
     attr_accessor :serial_port, :logger, :commands, :inbound_queue, :status,
@@ -63,14 +62,6 @@ module FB
       Position.new(status[:X], status[:Y], status[:Z])
     end
 
-    private
-
-    # Highest priority message when processing incoming Gcode. Use for system
-    # level status changes.
-    def parse_incoming(gcode)
-      inputs.execute(gcode)
-    end
-
     def execute_command_next_tick
       EM.next_tick do
         status.ready? ? pop_gcode_off_queue : execute_command_next_tick
@@ -93,5 +84,13 @@ module FB
         end
       end
     end
+
+  private
+
+    # Highest priority method for processing incoming Gcode. Use for system
+    # level status changes.
+    def parse_incoming(gcode)
+      inputs.execute(gcode)
+    end
   end
 end

data/lib/arduino/event_machine.rb

@@ -7,6 +7,8 @@ module FB
       attr_accessor :arduino
     end
 
+    attr_reader :q, :buffer, :bot
+
     def initialize
       @bot = self.class.arduino
       @q, @buffer = @bot.inbound_queue, ''

data/lib/arduino/incoming_handler.rb

@@ -3,8 +3,6 @@ module FB
   class IncomingHandler
     attr_reader :bot
 
-    class UnhandledGcode < StandardError; end
-
     def initialize(bot)
       @bot = bot
     end

data/lib/arduino/outgoing_handler.rb

@@ -4,8 +4,6 @@ module FB
   class OutgoingHandler
     attr_reader :bot
 
-    class UnhandledGcode < StandardError; end
-
     def initialize(bot)
       @bot = bot
     end

data/spec/fakes/fake_arduino.rb

@@ -0,0 +1,7 @@
+require_relative "fake_logger"
+require_relative "fake_serial_port"
+
+class FakeArduino < FB::Arduino
+  def initialize(serial_port: FakeSerialPort.new, logger: FakeLogger.new)
+  end
+end

data/spec/fakes/fake_logger.rb

@@ -0,0 +1,10 @@
+class FakeLogger < StringIO
+  def initialize(input = "")
+    super
+  end
+
+  def message
+    rewind
+    read.chomp
+  end
+end

data/spec/fakes/fake_serial_port.rb

@@ -0,0 +1,12 @@
+## SERIAL PORT SIMULATION
+## **********************
+class FakeSerialPort < StringIO
+  def initialize(*)
+    super("")
+  end
+
+  def message
+    rewind
+    read.chomp
+  end
+end

data/spec/lib/arduino/event_machine_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe FB::ArduinoEventMachine do
+  let(:logger) { FakeLogger.new }
+  let(:serial_port) { FakeSerialPort.new }
+  let(:bot) { FB::Arduino.new(serial_port: serial_port, logger: logger) }
+  let(:em) do
+    FB::ArduinoEventMachine.arduino = bot
+    FB::ArduinoEventMachine.new(serial_port)
+  end
+
+  it 'initializes' do
+    em
+    expect(FB::ArduinoEventMachine.arduino).to eq(bot)
+    expect(em.bot).to eq(bot)
+    expect(em.q).to eq(bot.inbound_queue)
+    expect(em.buffer).to eq('')
+  end
+
+  it 'splits incoming data' do
+    text = em.split_into_chunks "hello\r\nworld\r\n"
+    expect(text).to include("hello\r\n")
+    expect(text).to include("world\r\n")
+  end
+
+  it 'fills / clears the buffer' do
+    msg = "A1 B2 C3\r\nD4 E5 F6\r\n"
+    em.add_to_buffer("A1 B2 C3\r\nD4 E5 F6\r\n")
+    expect(em.buffer).to eq(msg)
+
+    within_event_loop do
+      #subscribe to the message queue and grab the last result.
+      em.q.subscribe { |x| @results = x }
+      em.send_buffer
+    end
+
+    expect(@results.length).to eq(2)
+    expect(@results.first.cmd.head).to eq(:A)
+    expect(@results.last.cmd.head).to eq(:D)
+
+    em.clear_buffer
+    expect(em.buffer).to eq('')
+  end
+end

data/spec/lib/arduino_spec.rb

@@ -1,15 +1,22 @@
 require 'spec_helper'
 
 describe FB::Arduino do
-  let(:logger) { StringIO.new("") }
+  let(:logger) { FakeLogger.new }
+  let(:serial_port) { FakeSerialPort.new }
   let(:bot) do
-    FB::Arduino.new(serial_port: StubSerialPort.new(0, 0),
-                    logger: logger)
+    FB::Arduino.new(serial_port: serial_port, logger: logger)
   end
 
+
+  it "logs" do
+    bot.log 'Hello, world!'
+    expect(logger.message).to eq('Hello, world!')
+  end
+
+
   it "initializes" do
     expect(bot).to be_kind_of(FB::Arduino)
-    expect(bot.serial_port).to be_kind_of(StubSerialPort)
+    expect(bot.serial_port).to be_kind_of(FakeSerialPort)
     expect(bot.logger).to be_kind_of(StringIO)
     expect(bot.commands).to be_kind_of(FB::OutgoingHandler)
     expect(bot.inbound_queue).to be_kind_of(EM::Channel)
@@ -19,9 +26,51 @@ describe FB::Arduino do
 
   it 'prints to the logger object' do
     bot.log "Hello, World!"
-    bot.logger.rewind
-    expect(bot.logger.gets.chomp).to eq("Hello, World!")
+    expect(logger.message).to eq("Hello, World!")
   end
 
+  it 'writes to outbound command queue' do
+    bot.write("A1 B2 C3")
+    expect(bot.outbound_queue).to include("A1 B2 C3")
+  end
+
+  it "sets change/message/close callbacks" do
+    yowza = ->{ bot.log "QQQ" }
+    bot.onmessage(&yowza)
+    bot.onclose(&yowza)
+    bot.onchange(&yowza)
+    expect(bot.instance_variable_get(:@onmessage)).to be(yowza)
+    expect(bot.instance_variable_get(:@onclose)).to be(yowza)
+    expect(bot.instance_variable_get(:@onchange)).to be(yowza)
+  end
+
+  it "calls onclose callback via disconnect()" do
+    calls = []
+    bot.onclose { calls << "Hey!" }
+    bot.disconnect
+    expect(logger.message).to eq("Connection to device lost")
+    expect(calls.length).to eq(1)
+    expect(calls).to include("Hey!")
+  end
+
+  it "reports current_position" do
+    bot.status[:x] = 1
+    bot.status[:y] = 2
+    bot.status[:z] = 3
+    expect(bot.current_position.x).to eq(1)
+    expect(bot.current_position.y).to eq(2)
+    expect(bot.current_position.z).to eq(3)
+  end
+
+  it "pops gcode off queue" do
+    command = FB::Gcode.new { "A1 B2 C3" }
+    bot.outbound_queue.push(command)
+    expect(bot.outbound_queue.length).to eq(1)
+    within_event_loop { bot.pop_gcode_off_queue }
+    expect(bot.outbound_queue.length).to eq(0)
+    expect(serial_port.message).to eq("A1 B2 C3")
+    expect(bot.status.ready?).to be_falsey
+    expect(bot.status[:last]).to eq(:unknown)
+  end
 end
 

data/spec/spec_helper.rb

@@ -5,10 +5,16 @@ SimpleCov.start do
 end
 require 'pry'
 require 'farmbot-serial'
-require_relative 'fixtures/stub_serial_port'
+
+require_relative 'fakes/fake_serial_port'
+require_relative 'fakes/fake_logger'
+require_relative 'fakes/fake_arduino'
+
 RSpec.configure do |config|
 end
 
+# This is used for testing things that require an event loop. Once run, you can
+# observe / make assertions on side effects.
 def within_event_loop
   EM.run do
     yield

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farmbot-serial
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Tim Evers
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,8 +130,10 @@ files:
 - lib/farmbot-serial.rb
 - lib/gcode.rb
 - lib/gcode.yml
-- spec/fixtures/stub_logger.rb
-- spec/fixtures/stub_serial_port.rb
+- spec/fakes/fake_arduino.rb
+- spec/fakes/fake_logger.rb
+- spec/fakes/fake_serial_port.rb
+- spec/lib/arduino/event_machine_spec.rb
 - spec/lib/arduino/status_spec.rb
 - spec/lib/arduino_spec.rb
 - spec/lib/gcode_spec.rb
@@ -161,8 +163,10 @@ signing_key:
 specification_version: 4
 summary: Serial library for Farmbot
 test_files:
-- spec/fixtures/stub_logger.rb
-- spec/fixtures/stub_serial_port.rb
+- spec/fakes/fake_arduino.rb
+- spec/fakes/fake_logger.rb
+- spec/fakes/fake_serial_port.rb
+- spec/lib/arduino/event_machine_spec.rb
 - spec/lib/arduino/status_spec.rb
 - spec/lib/arduino_spec.rb
 - spec/lib/gcode_spec.rb

data/spec/fixtures/stub_logger.rb

@@ -1,5 +0,0 @@
-class StubLogger < StringIO
-  def initialize("")
-    super
-  end
-end

data/spec/fixtures/stub_serial_port.rb

@@ -1,6 +0,0 @@
-## SERIAL PORT SIMULATION
-## **********************
-class StubSerialPort < StringIO
-  def initialize(comm_port, parameters)
-  end
-end