mi100 0.3.0 → 0.3.1

data/lib/mi100.rb

@@ -1,3 +1,9 @@
+# mi100.rb
+# Copyright (c) 2014 Masami Yamakawa
+# 
+# This software is released under the MIT License.
+# http://opensource.org/lisenses/mit-license.php
+
 require 'mi100/version'
 require 'mi100/morsecoder'
 require 'timeout'
@@ -28,7 +34,30 @@ class Mi100
   DEFAULT_MOVE_DIRECTION  = "FORWARD"
   DEFAULT_SPIN_DIRECTION  = "RIGHT"
   
-  FREQUENCY = {DO: 262, RE: 294, MI: 330, FA: 349, SO: 392, LA: 440, SI: 494, HDO: 523}
+  FREQUENCY = { DO:   262,
+                DOS:  277,
+                RE:   294,
+                RES:  311,
+                MI:   330,
+                FA:   349,
+                FAS:  370,
+                SO:   392,
+                SOS:  415,
+                LA:   440,
+                LAS:  466,
+                SI:   494,
+                HDO:  523,
+                HDOS: 554,
+                HRE:  587,
+                HRES: 622,
+                HMI:  659,
+                HFA:  698,
+                HFAS: 740,
+                HSO:  784,
+                HSOS: 831,
+                HLA:  880,
+                HSI:  988,
+              }
   
   def initialize(dev)
     retries_left = DEFAULT_RETRIES
@@ -42,8 +71,6 @@ class Mi100
       raise
     end
     
-    @morsecoder = Morsecoder.new
-    
   end
   
   def close
@@ -175,24 +202,24 @@ class Mi100
   end
   
   def talk(str)
-    morsecode = @morsecoder.to_morse(str)
-    morsecode.each {|code| sound(code[:frequency],code[:duration])}
+    morsecoder = Morsecoder.new str
+    morsecoder.each {|frequency, duration| sound(frequency,duration)}
   end
   
-  def morsefrequency
-    @morsecoder.morsefrequency
+  def morse_frequency
+    Morsecoder.default_frequency
   end
   
-  def morsefrequency=(frequency)
-    @morsecoder.morsefrequency = frequency
+  def morse_frequency=(frequency)
+    Morsecoder.default_frequency = frequency
   end
   
-  def morseunit
-    @morsecoder.morseunit
+  def morse_unit
+    Morsecoder.default_unit
   end
   
-  def morseunit=(millisec)
-    @morsecoder.morseunit = millisec
+  def morse_unit=(millisec)
+    Morsecoder.default_unit = millisec
   end
   
   # Private methods

data/lib/mi100/morsecoder.rb

@@ -6,11 +6,12 @@
 
 class Mi100
     class Morsecoder
-    
-      attr_accessor :morseunit, :morsefrequency
-    
-      DEFAULT_MORSEUNIT_MILLIS = 50
-      DEFAULT_MORSEFREQUENCY = 4000
+      
+      DEFAULT_MORSE_UNIT_MILLIS = 50
+      DEFAULT_MORSE_FREQUENCY   = 4000
+      DEFAULT_LETTER_SPACE_DOTS = 3
+      DEFAULT_WORD_SPACE_DOTS   = 7
+      
       MORSECODE = { 
                     "1" => [1,3,3,3,3],
                     "2" => [1,1,3,3,3],
@@ -58,28 +59,63 @@ class Mi100
                     "(" => [3,1,3,3,1],
                     ")" => [3,1,3,3,1,3]
                   }
-  
-      def initialize
-        @morseunit = DEFAULT_MORSEUNIT_MILLIS
-        @morsefrequency = DEFAULT_MORSEFREQUENCY
-      end
-    
-      def to_morse(str)
-        morsecode = []
-        str.split(//).each do |char|
-          code = MORSECODE[char.upcase]
-          if code
-            code.each do |dots|
-              morsecode << {frequency: @morsefrequency, duration: @morseunit * dots}
-              morsecode << {frequency: false, duration: @morseunit * dots}
+                  
+      
+      @default_unit = DEFAULT_MORSE_UNIT_MILLIS
+      @default_frequency = DEFAULT_MORSE_FREQUENCY
+      @default_letter_space = DEFAULT_LETTER_SPACE_DOTS
+      @default_word_space = DEFAULT_WORD_SPACE_DOTS
+      
+      class << self
+      
+        attr_accessor :default_unit, :default_frequency
+        
+        def to_morse_from(the_str, frequency = @default_frequency, unit = @default_unit)
+          letter_space = @default_letter_space
+          word_space = @default_word_space
+          morsecode = []
+
+          the_str.to_s.split(//).each do |char|
+            code = MORSECODE[char.upcase]
+            if code
+              code.each do |dots|
+                morsecode << {frequency: frequency, duration: unit * dots}
+                morsecode << {frequency: false, duration: unit * dots}
+              end
+              morsecode << {frequency: false, duration: unit * letter_space}
+            else
+              morsecode << {frequency: false, duration: unit * word_space}
             end
-            morsecode << {frequency: false, duration: morseunit * 3}
-          else
-            morsecode << {frequency: false, duration: morseunit * 7}
           end
+          
+          morsecode
         end
-        morsecode
+        
+        def reset
+          @default_unit = DEFAULT_MORSE_UNIT_MILLIS
+          @default_frequency = DEFAULT_MORSE_FREQUENCY
+          @default_letter_space = DEFAULT_LETTER_SPACE_DOTS
+          @default_word_space = DEFAULT_WORD_SPACE_DOTS
+        end
+        
+      end
+      
+      attr_accessor :str, :unit, :frequency
+      
+      def initialize(str="HELLO WORLD", frequency = Morsecoder.default_frequency, unit=Morsecoder.default_unit)
+        @str = str
+        @frequency = frequency
+        @unit = unit
       end
       
+      def to_morse
+        frequency = @frequency
+        unit = @unit
+        Morsecoder.to_morse_from(@str, frequency, unit)
+      end
+      
+      def each
+        to_morse.each {|code| yield(code[:frequency], code[:duration])}
+      end
     end
 end

data/lib/mi100/version.rb

@@ -1,3 +1,3 @@
 class Mi100
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/mi100_spec.rb

@@ -1,11 +1,252 @@
 require 'spec_helper'
 
 describe Mi100 do
+
   it 'should have a version number' do
-    Mi100::VERSION.should_not be_nil
+    expect(Mi100::VERSION).not_to be nil
+  end
+
+  before :each do
+    Mi100.any_instance.stub(:initialize_serialport)
+  end
+
+  it 'should create the instance' do
+    mi100 = Mi100.new "COM5"
+    expect(mi100).to be_a Mi100
   end
+  
+  it 'should send "H" on :ping' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_PING,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.ping).to eq(["H",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("H")
+  end
+  
+  it 'should send "H" and return rounded power level on :power' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_GET_POWER_LEVEL,1188])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.power).to eq(1.19)
+    expect(mi100).to have_received(:send_command_get_response).with("H")
+  end
+  
+  it 'should send "P" and get light level on :light' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_GET_LIGHT,1188])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.light).to eq(1188)
+    expect(mi100).to have_received(:send_command_get_response).with("P")
+  end
+  
+  it 'should send "F,duration" on :move with "FORWARD"' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_FORWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move "FORWARD").to eq(["F",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("F,300")
+  end
+  
+  it 'should send "B,duration" on move "BACKWARD"' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_BACKWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move "BACKWARD").to eq(["B",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("B,300")
+  end  
 
-  it 'should do something useful' do
-    false.should be_true
+  it 'should send "R,140" on spin "RIGHT"' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_RIGHT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin "RIGHT").to eq(["R",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("R,140")
+  end
+
+  it 'should send "L,140" on spin "LEFT"' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_LEFT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin "LEFT").to eq(["L",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("L,140")
+  end
+
+  it 'should send "F,duration" on move_forward duration' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_FORWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move_forward 500).to eq(["F",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("F,500")
+  end
+
+  it 'should send "B,duration" move_backward duration' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_BACKWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move_backward 500).to eq(["B",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("B,500")
+  end
+  
+  it 'should send "R,duration" spin_right duration' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_RIGHT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin_right 500).to eq(["R",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("R,500")
+  end
+  
+  it 'should send "L,duration" on spin_left duration' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_LEFT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin_left 500).to eq(["L",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("L,500")
+  end
+  
+  it 'should send "F, 300" on movef' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_FORWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.movef).to eq(["F",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("F,300")
+  end
+  
+  it 'should send "B,300" on moveb' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_MOVE_BACKWARD,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.moveb).to eq(["B",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("B,300")
+  end  
+
+  it 'should send "R,140" spinr' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_RIGHT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spinr).to eq(["R",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("R,140")
+  end
+
+  it 'should send "L,140" on spinl' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_SPIN_LEFT,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spinl).to eq(["L",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("L,140")
+  end
+
+  it 'should send "F,duration" on move_forward! duration in async (via sendln)' do
+    Mi100.any_instance.stub(:sendln => 6)
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move_forward! 500).to eq(6)
+    expect(mi100).to have_received(:sendln).with("F,500")
+  end
+  
+  it 'should send "B,duration" on move_backward! duration in async' do
+    Mi100.any_instance.stub(:sendln => 6)
+    mi100 = Mi100.new "COM5"
+    expect(mi100.move_backward! 500).to eq(6)
+    expect(mi100).to have_received(:sendln).with("B,500")
+  end
+  
+   it 'should send "R,duration" on spin_right! duration in async' do
+    Mi100.any_instance.stub(:sendln => 6)
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin_right! 500).to eq(6)
+    expect(mi100).to have_received(:sendln).with("R,500")
+  end
+  
+  it 'should send "L,duration" on spin_left! duration in async' do
+    Mi100.any_instance.stub(:sendln => 6)
+    mi100 = Mi100.new "COM5"
+    expect(mi100.spin_left! 500).to eq(6)
+    expect(mi100).to have_received(:sendln).with("L,500")
+  end 
+
+  it 'should send "D,100, 50, 50,duration on blink 100,50,50,duration' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_BLINK_LED,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.blink 100,50,50,100).to eq(["D",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("D,100,50,50,100")
+  end
+
+  it 'should send "S" on stop' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_STOP,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.stop).to eq(["S",1234])
+    expect(mi100).to have_received(:send_command_get_response).with("S")
+  end
+
+  it 'should send "T,random frequency, 300" on tone' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_TONE,1234])
+    mi100 = Mi100.new "COM5"
+    expect(mi100.tone).to eq(["T",1234])
+    expect(mi100).to have_received(:send_command_get_response).with(/T,\d{2,4},300/)
+  end
+  
+  it 'should limit minimum tone frequency to 28 on tome' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_TONE,1234])
+    mi100 = Mi100.new "COM5"
+    mi100.tone 20, 500
+    expect(mi100).to have_received(:send_command_get_response).with("T,28,500")
+  end
+  
+  it 'should send "T,440,1000" on sound "la", 1000' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_TONE,1234])
+    mi100 = Mi100.new "COM5"
+    mi100.sound "la",1000
+    expect(mi100).to have_received(:send_command_get_response).with("T,440,1000")
+  end  
+
+  it 'sound should not call tone with false frequency' do
+    mi100 = Mi100.new "COM5"
+    mi100.stub(:tone)
+    mi100.sound false, 300
+    expect(mi100).not_to have_received(:tone)
+  end  
+
+  it 'should send three good tones on good' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_TONE,1234])
+    mi100 = Mi100.new "COM5"
+    mi100.good
+    expect(mi100).to have_received(:send_command_get_response).exactly(3).times
+  end   
+  
+  it 'should send one bad tone on bad' do
+    Mi100.any_instance.stub(:send_command_get_response => [Mi100::CMD_TONE,1234])
+    mi100 = Mi100.new "COM5"
+    mi100.bad
+    expect(mi100).to have_received(:send_command_get_response).once
+  end  
+  
+  it 'should talk morse code' do
+    mi100 = Mi100.new "COM5"
+    mi100.stub(:tone)
+    mi100.talk "sos"
+    expect(mi100).to have_received(:tone).exactly(6).times.with(4000,50)
+    expect(mi100).to have_received(:tone).exactly(3).times.with(4000,150)
+  end  
+  
+  it 'should access to morse_frequency' do
+    mi100 = Mi100.new "COM5"
+    expect(mi100.morse_frequency).to eq(4000)
+    expect(mi100.morse_frequency = 440).to eq(440)
+    expect(mi100.morse_frequency).to eq(440)
+  end    
+  
+  it 'should access to morse_unit' do
+    mi100 = Mi100.new "COM5"
+    expect(mi100.morse_unit).to eq(50)
+    expect(mi100.morse_unit = 100).to eq(100)
+    expect(mi100.morse_unit).to eq(100)
+  end
+  
+  it 'should talk with new default frequency and unit' do
+    mi100 = Mi100.new "COM5"
+    mi100.stub(:tone)
+    mi100.talk "sos"
+    expect(mi100).to have_received(:tone).exactly(6).times.with(440,100)
+    expect(mi100).to have_received(:tone).exactly(3).times.with(440,300)
+  end  
+  
+  it 'should reset default frequency and unit' do
+    Mi100::Morsecoder.reset
+    expect(Mi100::Morsecoder.default_frequency).to eq(4000)
+    expect(Mi100::Morsecoder.default_unit).to eq(50)
+    mi100 = Mi100.new "COM5"
+    expect(mi100.morse_frequency).to eq(4000)
+    expect(mi100.morse_unit).to eq(50)
   end
+  
+  it 'should provide Morsecode.to_morse_from class method converting the string to the morse code array' do
+    morsecode = Mi100::Morsecoder.to_morse_from "sos"
+    expect(morsecode.size).to eq(21)
+    expect(morsecode[0]).to eq ({:frequency=>4000, :duration=>50})
+  end  
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mi100
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000Z
+date: 2014-03-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &16038924 !ruby/object:Gem::Requirement
+  requirement: &16171272 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *16038924
+  version_requirements: *16171272
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16038672 !ruby/object:Gem::Requirement
+  requirement: &16171020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16038672
+  version_requirements: *16171020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16038396 !ruby/object:Gem::Requirement
+  requirement: &16170744 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16038396
+  version_requirements: *16170744
 description: A ruby gem for controlling MI100 of monoxit through bluetooth virtual
   serial port.
 email: