ruby-xbee 1.1.0

data/lib/ruby_xbee.rb

@@ -0,0 +1,134 @@
+# == Synopsis
+# xbee.rb - A Ruby class for manipulating an XBee via the serial communication port of the host
+#
+# this code is designed for the following XBee modules:
+#   IEEE® 802.15.4 OEM RF Modules by Digi International
+#   Series 1 XBee and XBee Pro modules
+#
+# :title: xbee.rb - A Ruby class for manipulating an XBee via the serial communication port of the host
+#
+# == Copyright
+#
+# Copyright (C) 2008-2009 360VL, Inc. and Landon Cox
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License version 3 for more details.
+#
+# You should have received a copy of the GNU Affero General Public License along with this program.
+# If not, see http://www.gnu.org/licenses/
+#
+# You can learn more about Ruby::XBee and other projects at http://sawdust.see-do.org
+#
+# see Digi product manual: "Product Manual v1.xCx - 802.15.4 Protocol"
+# for details on the operation of XBee series 1 modules.
+
+require 'date'
+require 'pp'
+
+require 'rubygems'
+gem 'serialport'
+require 'serialport'
+
+require 'module_config'
+
+module XBee
+
+  ##
+  # supports legacy API, command-mode interface
+  def XBee.new( xbee_usbdev_str, baud, data_bits, stop_bits, parity )
+    require 'legacy/command_mode'
+    BaseCommandModeInterface.new(xbee_usbdev_str, baud, data_bits, stop_bits, parity)
+  end
+
+  ##
+  # a method for getting results from any Ruby SerialPort object. Not ideal, but seems effective enough.
+  def getresults( sp, echo = true )
+    results = ""
+    while (c = sp.getc) do
+      if ( !echo.nil? && echo )
+        putc c
+      end
+      results += "#{c.chr}"
+    end
+
+    # deal with multiple lines
+    results.gsub!( "\r", "\n")
+  end
+
+
+  ##
+  # This is it, the base class where it all starts. Command mode or API mode, version 1 or version 2, all XBees descend
+  # from this class.
+  class RFModule
+  
+    VERSION = "2.1"
+  
+    include XBee
+    include Config
+    attr_accessor :xbee_serialport, :xbee_uart_config, :guard_time, :command_mode_timeout, :command_character, :node_discover_timeout, :node_identifier, :operation_mode, :transmission_mode
+    attr_reader :serial_number, :hardware_rev, :firmware_rev
+
+    def version
+      VERSION
+    end
+
+    ##
+    # This is the way we instantiate XBee modules now, via this factory method. It will ultimately autodetect what
+    # flavor of XBee module we're using and return the most appropriate subclass to control that module.
+    def initialize(xbee_usbdev_str = "/dev/tty.usbserial-A7004nmf", uart_config = XBeeUARTConfig.new, operation_mode = :AT, transmission_mode = :SYNC)
+      unless uart_config.kind_of?(XBeeUARTConfig)
+        raise "uart_config must be an instance of XBeeUARTConfig for this to work"
+      end
+      unless operation_mode == :AT || operation_mode == :API
+        raise "XBee operation_mode must be either AT or API"
+      end
+      unless transmission_mode == :SYNC || transmission_mode == :ASYNC
+        raise "XBee transmission_mode must be either SYNC (Synchronous) or ASYNC (Asynchronous)"
+      end
+      self.xbee_uart_config = uart_config
+      @xbee_serialport = SerialPort.new( xbee_usbdev_str, uart_config.baud, uart_config.data_bits, uart_config.stop_bits, uart_config.parity )
+      @xbee_serialport.read_timeout = self.read_timeout(:short)
+      @guard_time = GuardTime.new
+      @command_mode_timeout= CommandModeTimeout.new
+      @command_character = CommandCharacter.new
+      @node_discover_timeout = NodeDiscoverTimeout.new
+      @node_identifier = NodeIdentifier.new
+      @operation_mode = operation_mode
+      @transmission_mode = transmission_mode
+    end
+
+    def in_command_mode
+      sleep self.guard_time.in_seconds
+      @xbee_serialport.write(self.command_character.value * 3)
+      sleep self.guard_time.in_seconds
+      @xbee_serialport.read(3)
+      # actually do some work now ...
+      yield if block_given?
+      # Exit command mode
+      @xbee_serialport.write("ATCN\r")
+      @xbee_serialport.read(3)
+    end
+
+    ##
+    # XBee response times vary based on both hardware and firmware versions. These
+    # constants may need to be adjusted for your devices, but these will
+    # work fine for most cases.  The unit of time for a timeout constant is ms
+    def read_timeout(type = :short)
+      case type
+        when :short
+          1200
+        when :long 
+          3000
+        else 3000
+      end
+    end
+  end
+end  # module XBee
+
+require 'apimode/xbee_api'

data/test/ruby_xbee_test.rb

@@ -0,0 +1,20 @@
+$: << File.dirname(__FILE__)
+require 'test_helper'
+require 'version'
+
+# The most simple test there can possibly BE, let's check constant for constant
+class RubyXbeeTest < MiniTest::Unit::TestCase
+  def setup
+      @xbee_version_major = ::XBee::Version::MAJOR
+      @xbee_version_minor = ::XBee::Version::MINOR
+      @xbee_version_patch = ::XBee::Version::PATCH
+      @xbee_version_string = ::XBee::Version::STRING
+  end
+
+  def test_version_matches_testsuite
+    assert_equal 1, @xbee_version_major
+    assert_equal 1, @xbee_version_minor
+    assert_equal 0, @xbee_version_patch
+    assert_equal '1.1.0', @xbee_version_string
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'versioncheck'
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+rb_vc = VersionCheck.rubyversion
+if !rb_vc.have_version?(2,0)
+  require 'simplecov'
+  SimpleCov.command_name 'MiniTest'
+  SimpleCov.start
+end
+
+MiniTest::Reporters.use!
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'bin'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'ruby_xbee'
+require 'coveralls'
+
+Coveralls.wear!

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: ruby-xbee
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Landon Cox
+- Mike Ashmore
+- Sten Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: A Ruby XBee gem
+email: exile@chamber.ee
+executables:
+- apicontrol.rb
+- apilisten.rb
+- ruby-xbee.rb
+- xbeeconfigure.rb
+- xbeedio.rb
+- xbeeinfo.rb
+- xbeelisten.rb
+- xbeesend.rb
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- agpl.txt
+- README.rdoc
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- agpl.txt
+- bin/apicontrol.rb
+- bin/apilisten.rb
+- bin/ruby-xbee.rb
+- bin/xbeeconfigure.rb
+- bin/xbeedio.rb
+- bin/xbeeinfo.rb
+- bin/xbeelisten.rb
+- bin/xbeesend.rb
+- lib/apimode/at_commands.rb
+- lib/apimode/frame/at_command.rb
+- lib/apimode/frame/at_command_response.rb
+- lib/apimode/frame/explicit_addressing_command.rb
+- lib/apimode/frame/explicit_rx_indicator.rb
+- lib/apimode/frame/frame.rb
+- lib/apimode/frame/modem_status.rb
+- lib/apimode/frame/receive_packet.rb
+- lib/apimode/frame/remote_command_request.rb
+- lib/apimode/frame/remote_command_response.rb
+- lib/apimode/frame/transmit_request.rb
+- lib/apimode/frame/transmit_status.rb
+- lib/apimode/xbee_api.rb
+- lib/legacy/command_mode.rb
+- lib/module_config.rb
+- lib/ruby_xbee.rb
+- test/ruby_xbee_test.rb
+- test/test_helper.rb
+homepage: http://github.com/exsilium/ruby-xbee
+licenses:
+- AGPL
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Controlling an XBee module from Ruby either in AT (Transparent) or API mode.
+  Both Series 1 and Series 2 radio modules are supported.
+test_files:
+- test/ruby_xbee_test.rb
+- test/test_helper.rb