nxt 0.3.0 → 0.5.0

data/spec/telegrams/commands/direct_command_reply_spec.rb

@@ -0,0 +1,7 @@
+require './spec/helper'
+
+require './lib/telegrams/commands/direct_command_reply'
+
+describe DirectCommandReply do
+
+end

data/spec/telegrams/commands/direct_command_spec.rb

@@ -0,0 +1,34 @@
+require './spec/helper'
+
+require './lib/telegrams/commands/direct_command'
+
+
+describe DirectCommand do
+  before do
+    @command = DirectCommand.new
+  end
+
+  it "must have a command type of 0x00" do
+    @command.type.must_equal 0x00
+  end
+
+  it "must start out with its type at the first byte" do
+    @command.as_bytes[0].must_equal @command.type
+  end
+
+  describe "when NOT wanting to wait for a reply" do
+    it "must have a first byte of 0x80" do
+      no_wait_command = DirectCommand.new false
+      no_wait_command.as_bytes[0].must_equal 0x80
+    end
+  end
+
+  it "must have a readable command property" do
+    @command.command
+  end
+
+  it "must default command to nil" do
+    @command.command.must_be_nil
+  end
+end
+

data/spec/telegrams/commands/system/get_device_info_spec.rb

@@ -0,0 +1,16 @@
+require './spec/helper'
+require './lib/telegrams/commands/system/get_device_info'
+
+describe GetDeviceInfo do
+  it "must not accept a require_response override" do
+    -> { GetDeviceInfo.new false }.must_raise ArgumentError
+  end
+
+  it "must require a response" do
+    GetDeviceInfo.new.require_response?.must_equal true
+  end
+
+  it "must have a command of 0x9B" do
+    GetDeviceInfo.new.command.must_equal 0x9B
+  end
+end

data/spec/telegrams/commands/system/replies/get_device_info_reply_spec.rb

@@ -0,0 +1,63 @@
+require './spec/helper'
+require './lib/telegrams/commands/system/replies/get_device_info_reply'
+
+def get_msb_and_lsb(number)
+  lsb = number & 0xff
+  msb = (number >> 8) & 0xff
+  { :msb => msb, :lsb => lsb }
+end
+
+describe GetDeviceInfoReply do
+  before do
+    reply_to_command_status_bytes = [0x02, 0x9B, 0x00]
+    @nxt_brick_name = "MyNXTBrick"
+    nxt_brick_name_bytes = @nxt_brick_name.ljust(15, "\0").unpack("C*")
+    @bt_address = "\x01\x02\x03\x04\x05\x06\x00"
+    bt_address_bytes = @bt_address.unpack('C*')
+    @signal_strength = 100
+    signal_strength_hash = get_msb_and_lsb(@signal_strength)
+
+    @free_user_flash_memory = 512  # 0.5 KB
+    free_user_flash_memory_hash = get_msb_and_lsb(@free_user_flash_memory)
+
+    @reply_bytes = reply_to_command_status_bytes # 0-2
+    @reply_bytes = @reply_bytes.concat nxt_brick_name_bytes # 3-17
+    @reply_bytes = @reply_bytes.concat bt_address_bytes # 18-24
+    @reply_bytes = @reply_bytes << signal_strength_hash[:lsb] # 25
+    @reply_bytes = @reply_bytes.concat [0x00, 0x00] # 26-27 more lsb's
+    @reply_bytes = @reply_bytes << signal_strength_hash[:msb] # 28
+    @reply_bytes = @reply_bytes << free_user_flash_memory_hash[:lsb] # 29
+    @reply_bytes = @reply_bytes << free_user_flash_memory_hash[:msb]# 30
+    @reply_bytes = @reply_bytes.concat [0x00, 0x00] # 31-32
+
+    @reply = GetDeviceInfoReply.new(@reply_bytes)
+  end
+
+  describe "when constructing the get device info reply" do
+    it "must raise an argument exception if the command is not get device user info" do
+      @reply_bytes[1] = 0x00
+      -> { GetDeviceInfoReply.new(@reply_bytes) }.must_raise ArgumentError
+    end
+
+    it "must be successful with successful reply" do
+      @reply.success?.must_equal true
+    end
+
+    it "must set the nxt_brick_name" do
+      @reply.nxt_brick_name.must_equal @nxt_brick_name
+    end
+
+    it "must set the Bluetooth Address bt_address property" do
+      @reply.bt_address.must_equal "btspp://010203040506"
+    end
+
+    it "must set the signal_strength" do
+      @reply.signal_strength.must_equal @signal_strength
+    end
+
+    it "must set the free_user_flash_memory_bytes" do
+      @reply.free_user_flash_memory_bytes.must_equal @free_user_flash_memory
+    end
+  end
+
+end

data/spec/telegrams/commands/system_command_spec.rb

@@ -0,0 +1,26 @@
+require './spec/helper'
+
+require './lib/telegrams/commands/system_command'
+
+
+describe SystemCommand do
+  before do
+    @command = SystemCommand.new
+  end
+
+  it "must have a command type of 0x01" do
+    @command.type.must_equal 0x01
+  end
+
+  it "must start out with its type at the first byte" do
+    @command.as_bytes[0].must_equal @command.type
+  end
+
+  describe "when NOT wanting to wait for a reply" do
+    it "must have a first byte of 0x81" do
+      no_wait_command = SystemCommand.new false
+      no_wait_command.as_bytes[0].must_equal 0x81
+    end
+  end
+end
+

data/spec/telegrams/no_message_reply_spec.rb

@@ -0,0 +1,12 @@
+require './spec/helper'
+require './lib/telegrams/no_message_reply'
+
+describe NoMessageReply do
+  it "should accept the bytes as the argument to the constructor" do
+    NoMessageReply.new([0x02, 0x11, 0x00]).type.must_equal 0x02
+  end
+
+  it "should return an empty string, even if the message bytes are present" do
+    NoMessageReply.new([0x02, 0x11, 0x00, 0x01, 0x02]).message.must_equal ''
+  end
+end

data/spec/telegrams/reply_spec.rb

@@ -0,0 +1,63 @@
+require './spec/helper'
+
+require './lib/telegrams/reply'
+
+describe Reply do
+  before do
+    @reply = Reply.new([0x02, 0x11, 0x00])
+  end
+  describe "when constructing a reply" do
+    it "must have a command type of 0x02, which is reply" do
+      @reply.type.must_equal 0x02
+    end
+
+    it "must raise an ArgumentError if the bytes is null" do
+      -> { Reply.new(nil) }.must_raise ArgumentError
+    end
+
+    it "must raise an ArgumentError if the bytes is less than 3 length (type, command, status)" do
+      -> { Reply.new([0x02, 0x00]) }.must_raise ArgumentError
+    end
+
+    it "must raise an ArgumentError if it is not a reply telegram" do
+      -> { Reply.new([0x01, 0x01, 0x00]) }.must_raise ArgumentError
+    end
+
+  end
+
+  describe "#success?" do
+    it "must return true when status is 0x00" do
+      @reply.success?.must_equal true
+    end
+
+    it "must return false when the status is not 0x00" do
+      Reply.new([0x02, 0x11, 0x01]).success?.must_equal false
+    end
+  end
+
+  describe "#message_bytes" do
+    it "must have an empty array when there is no message" do
+      @reply.message_bytes.must_equal []
+    end
+
+    it "must have the 4th through remaining message bytes when there is a message" do
+      Reply.new([0x02, 0x11, 0x00, 0x01, 0x02]).message_bytes.must_equal [0x01, 0x02]
+    end
+  end
+
+  describe "#message" do
+    it "must just return the bytes of the message in the base Reply class" do
+      Reply.new([0x02, 0x11, 0x00, 0x01, 0x02]).message.must_equal [0x01, 0x02]
+    end
+  end
+
+  describe "#status_description" do
+    it "must return empty string if there is no matching code" do
+      Reply.new([0x02, 0x11, 0xfa]).status_description.must_equal ''
+    end
+
+    it "must return the string for the status when there is a matching code" do
+      Reply.new([0x02, 0x11, 0x00]).status_description.must_equal 'Success'
+    end
+  end
+end

data/spec/telegrams/respondable_telegram_spec.rb

@@ -0,0 +1,66 @@
+require './spec/helper'
+
+require './lib/telegrams/respondable_telegram'
+
+class MockRespondableTelegram < RespondableTelegram
+  def initialize(response_required=true)
+    super
+    @type = 0x06
+    @command = 0x07
+  end
+end
+
+
+describe RespondableTelegram do
+  before do
+    @telegram = RespondableTelegram.new
+  end
+
+  describe "when using the require_password? property" do
+    it "can access the require_response? property" do
+      @telegram.require_response?
+    end
+
+    it "defaults require_response? to true" do
+      @telegram.require_response?.must_equal true
+    end
+
+    it "can change require_response? default through initializer" do
+      t = RespondableTelegram.new false
+      t.require_response?.must_equal false
+    end
+
+    it "can set the require_response directly" do
+      @telegram.require_response = false
+      @telegram.require_response?.must_equal false
+    end
+  end
+
+  it "must have a readable command property" do
+    @telegram.command
+  end
+
+  it "must default command to nil" do
+    @telegram.command.must_be_nil
+  end
+
+  describe "when using the telegram as a collection of bytes" do
+    describe "when wanting a reply from this telegram" do
+      it "will leave the type in the first byte field alone" do
+        mrt = MockRespondableTelegram.new true
+        mrt.as_bytes[0].must_equal 0x06
+      end
+    end
+    describe "when NOT wanting to wait for a reply" do
+      it "will mask the type with 0x80 to indicate NOT to wait for a reply" do
+        mrt = MockRespondableTelegram.new false
+        mrt.as_bytes[0].must_equal 0x86
+      end
+    end
+
+    it "must have the command as the second byte" do
+      mrt = MockRespondableTelegram.new
+      mrt.as_bytes[1].must_equal 0x07
+    end
+  end
+end

data/spec/telegrams/telegram_spec.rb

@@ -0,0 +1,38 @@
+require './spec/helper'
+
+require './lib/telegrams/telegram'
+
+describe Telegram do
+  before do
+    @telegram = Telegram.new
+    @type_value = 0x77
+    @telegram.instance_eval("@type = #{@type_value}")
+  end
+
+
+  describe "when accessing the type property" do
+    it "allows read access" do
+      @telegram.type.must_equal @type_value
+    end
+
+    it "does not allow write access" do
+      -> { @telegram.type = "biz buzz" }.must_raise NoMethodError
+      @telegram.type.must_equal @type_value
+    end
+  end
+
+
+  describe "when getting the telegram as bytes" do
+    it "must return the type value as the first element of the array" do
+      @telegram.as_bytes[0].must_equal @type_value
+    end
+  end
+
+
+  describe "when working with a telegram" do
+    it "specifies a maximum size of 64 bytes" do
+      @telegram.max_size_in_bytes.must_equal 64
+    end
+  end
+
+end

metadata

@@ -1,21 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: nxt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Tony Heupel
-- Nathan Kleyn <nathan@unfinitydesign.com>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-09 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serialport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,165 +20,149 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.4
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.2
-- !ruby/object:Gem::Dependency
-  name: ruby-usb
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.2.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.8.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.8.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.8.4
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.0
-description: Control an NXT 2.0 See http://github.com/tchype/ruby-nxt for more information.
-email: tony@heupel.org
+        version: '0.9'
+description: Control a Lego Minstorms NXT 2.0 Brick See http://github.com/tchype/ruby-nxt
+  for more information.
+email: tony@heupel.net
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.markdown
+- README.md
 files:
-- README.markdown
-- Rakefile
-- lib/nxt/commands/base.rb
-- lib/nxt/commands/input.rb
-- lib/nxt/commands/output.rb
-- lib/nxt/commands/program.rb
-- lib/nxt/commands/sound.rb
-- lib/nxt/commands/tone.rb
-- lib/nxt/connectors/base.rb
-- lib/nxt/connectors/input/color.rb
-- lib/nxt/connectors/input/touch.rb
-- lib/nxt/connectors/input/ultrasonic.rb
-- lib/nxt/connectors/output/motor.rb
-- lib/nxt/errors.rb
-- lib/nxt/exceptions.rb
-- lib/nxt/interfaces/base.rb
-- lib/nxt/interfaces/serial_port.rb
-- lib/nxt/interfaces/usb.rb
-- lib/nxt/nxt_brick.rb
-- lib/nxt/patches/module.rb
-- lib/nxt/patches/string.rb
-- lib/nxt/utils/accessors.rb
+- README.md
+- lib/communication/bluetooth_communication.rb
+- lib/communication/serial_port_profile.rb
 - lib/nxt.rb
-- spec/matchers.rb
-- spec/nxt/connectors/output/motor_spec.rb
-- spec/nxt/interfaces/serial_port_spec.rb
-- spec/nxt/nxt_brick_spec.rb
-- spec/spec_helper.rb
+- lib/ruby-nxt.sublime-project
+- lib/ruby-nxt.sublime-workspace
+- lib/telegrams/commands/direct/get_battery_level.rb
+- lib/telegrams/commands/direct/get_current_program_name.rb
+- lib/telegrams/commands/direct/get_input_values.rb
+- lib/telegrams/commands/direct/keep_alive.rb
+- lib/telegrams/commands/direct/ls_get_status.rb
+- lib/telegrams/commands/direct/ls_read.rb
+- lib/telegrams/commands/direct/ls_write.rb
+- lib/telegrams/commands/direct/message_read.rb
+- lib/telegrams/commands/direct/message_write.rb
+- lib/telegrams/commands/direct/output_state.rb
+- lib/telegrams/commands/direct/play_sound_file.rb
+- lib/telegrams/commands/direct/play_tone.rb
+- lib/telegrams/commands/direct/replies/get_battery_level_reply.rb
+- lib/telegrams/commands/direct/replies/get_current_program_name_reply.rb
+- lib/telegrams/commands/direct/replies/play_sound_file_reply.rb
+- lib/telegrams/commands/direct/replies/play_tone_reply.rb
+- lib/telegrams/commands/direct/replies/reset_motor_position_reply.rb
+- lib/telegrams/commands/direct/replies/set_input_mode_reply.rb
+- lib/telegrams/commands/direct/replies/set_output_state_reply.rb
+- lib/telegrams/commands/direct/replies/start_program_reply.rb
+- lib/telegrams/commands/direct/replies/stop_program_reply.rb
+- lib/telegrams/commands/direct/replies/stop_sound_playback_reply.rb
+- lib/telegrams/commands/direct/reset_input_scaled_value.rb
+- lib/telegrams/commands/direct/reset_motor_position.rb
+- lib/telegrams/commands/direct/set_input_mode.rb
+- lib/telegrams/commands/direct/set_output_state.rb
+- lib/telegrams/commands/direct/start_program.rb
+- lib/telegrams/commands/direct/stop_program.rb
+- lib/telegrams/commands/direct/stop_sound_playback.rb
+- lib/telegrams/commands/direct_command.rb
+- lib/telegrams/commands/direct_command_reply.rb
+- lib/telegrams/commands/message_translator.rb
+- lib/telegrams/commands/system/get_device_info.rb
+- lib/telegrams/commands/system/replies/get_device_info_reply.rb
+- lib/telegrams/commands/system_command.rb
+- lib/telegrams/messages/error.rb
+- lib/telegrams/messages/message.rb
+- lib/telegrams/messages/success.rb
+- lib/telegrams/no_message_reply.rb
+- lib/telegrams/reply.rb
+- lib/telegrams/respondable_telegram.rb
+- lib/telegrams/telegram.rb
+- spec/communication/bluetooth_communication_spec.rb
+- spec/communication/serial_port_profile_spec.rb
+- spec/helper.rb
+- spec/nxt_spec.rb
+- spec/telegrams/commands/direct/get_battery_level_spec.rb
+- spec/telegrams/commands/direct/get_current_program_name_spec.rb
+- spec/telegrams/commands/direct/output_state_spec.rb
+- spec/telegrams/commands/direct/play_sound_file_spec.rb
+- spec/telegrams/commands/direct/play_tone_spec.rb
+- spec/telegrams/commands/direct/replies/get_battery_level_reply_spec.rb
+- spec/telegrams/commands/direct/replies/get_current_program_name_reply_spec.rb
+- spec/telegrams/commands/direct/replies/play_sound_file_reply_spec.rb
+- spec/telegrams/commands/direct/replies/play_tone_reply_spec.rb
+- spec/telegrams/commands/direct/replies/reset_motor_position_reply_spec.rb
+- spec/telegrams/commands/direct/replies/set_input_mode_reply_spec.rb
+- spec/telegrams/commands/direct/replies/set_output_state_reply_spec.rb
+- spec/telegrams/commands/direct/replies/start_program_reply_spec.rb
+- spec/telegrams/commands/direct/replies/stop_program_reply_spec.rb
+- spec/telegrams/commands/direct/replies/stop_sound_playback_reply_spec.rb
+- spec/telegrams/commands/direct/reset_motor_position_spec.rb
+- spec/telegrams/commands/direct/set_input_mode_spec.rb
+- spec/telegrams/commands/direct/set_output_state_spec.rb
+- spec/telegrams/commands/direct/start_program_spec.rb
+- spec/telegrams/commands/direct/stop_program_spec.rb
+- spec/telegrams/commands/direct/stop_sound_playback_spec.rb
+- spec/telegrams/commands/direct_command_reply_spec.rb
+- spec/telegrams/commands/direct_command_spec.rb
+- spec/telegrams/commands/system/get_device_info_spec.rb
+- spec/telegrams/commands/system/replies/get_device_info_reply_spec.rb
+- spec/telegrams/commands/system_command_spec.rb
+- spec/telegrams/no_message_reply_spec.rb
+- spec/telegrams/reply_spec.rb
+- spec/telegrams/respondable_telegram_spec.rb
+- spec/telegrams/telegram_spec.rb
 homepage: http://github.com/tchype/ruby-nxt
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: Control an NXT 2.0
+specification_version: 4
+summary: Control a Lego Minstorms NXT 2.0 Brick
 test_files: []
-has_rdoc: