xbee-ruby 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 321bcafd8643eeefad99385371c041eb2b78df6c
+  data.tar.gz: cafca7e2d4bbc9b718ba7c733fc9a0c5e9b00064
+SHA512:
+  metadata.gz: dfcdfa8f34eef91c61d0f67e19063e52bdb0e2e58ca5b6196349a5000ad30d88f6c47c1dc4c2abe5f58109ee90ad65d0d9b2af141cdfe91934fff7aebfe33999
+  data.tar.gz: b47dbe7c9ffb11660284bc1cebd790964064b82d56c1433dabed054191a86a280d41974c273659e608814d1c8a7c2e8dacf81ce8340fad3eb3053086a1442561

data/lib/xbee-ruby.rb

@@ -0,0 +1,19 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'serialport'
+require 'xbee-ruby/version'
+require 'xbee-ruby/address_16'
+require 'xbee-ruby/address_64'
+require 'xbee-ruby/tx_request'
+require 'xbee-ruby/tx_response'
+require 'xbee-ruby/rx_response'
+require 'xbee-ruby/modem_status_response'
+require 'xbee-ruby/xbee'

data/lib/xbee-ruby/address_16.rb

@@ -0,0 +1,53 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/adress'
+
+module XBeeRuby
+
+	class Address16 < Address
+
+		def initialize msb, lsb
+			@address = [msb, lsb]
+		end
+
+		def self.from_s string
+			if matcher = /^(\h\h)[^\h]*(\h\h)$/.match(string)
+				self.new *(matcher[1..2].map &:hex)
+			else
+				raise ArgumentError, "#{string} is not a valid 16-bit address string"
+			end
+		end
+
+		def self.from_a array
+			if array.length == 2 && array.all? {|x| (0..255).cover? x }
+				self.new *array
+			else
+				raise ArgumentError, "#{array} is not a valid 16-bit address array"
+			end
+		end
+
+		def to_s
+			'%02x%02x' % @address
+		end
+
+		def to_a
+			@address
+		end
+
+		def == other
+			to_a == other.to_a
+		end
+
+		BROADCAST = Address16.new 0xff, 0xfe
+
+	end
+
+end

data/lib/xbee-ruby/address_64.rb

@@ -0,0 +1,53 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/adress'
+
+module XBeeRuby
+
+	class Address64 < Address
+
+		def initialize b1, b2, b3, b4, b5, b6, b7, b8
+			@address = [b1, b2, b3, b4, b5, b6, b7, b8]
+		end
+
+		def self.from_s string
+			if matcher = /^(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)[^\h]*(\h\h)$/.match(string)
+				self.new *(matcher[1..8].map &:hex)
+			else
+				raise ArgumentError, "#{string} is not a valid 64-bit address string"
+			end
+		end
+
+		def self.from_a array
+			if array.length == 8 && array.all? {|x| (0..255).cover? x }
+				self.new *array
+			else
+				raise ArgumentError, "#{array} is not a valid 64-bit address array"
+			end
+		end
+
+		def to_a
+			@address
+		end
+
+		def == other
+			to_a == other.to_a
+		end
+
+		def to_s
+			('%02x' * 8) % @address
+		end
+
+		BROADCAST = Address64.new 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff
+		COORDINATOR = Address64.new 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
+	end
+
+end

data/lib/xbee-ruby/adress.rb

@@ -0,0 +1,21 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+module XBeeRuby
+
+	class Address
+
+		def to_a
+			raise 'Override to return the address as a byte array'
+		end
+
+	end
+
+end

data/lib/xbee-ruby/modem_status_response.rb

@@ -0,0 +1,34 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/response'
+
+module XBeeRuby
+
+	class ModemStatusResponse < Response
+
+		frame_type 0x8a
+
+		attr_reader :modem_status
+
+		def initialize bytes
+			@modem_status = bytes[1]
+		end
+
+		def == other
+			other.class == ModemStatusResponse && self.modem_status == other.modem_status
+		end
+
+		def to_s
+			"ModemStatusResponse[#{super}](modem_status=0x#{modem_status})"
+		end
+	end
+
+end

data/lib/xbee-ruby/packet.rb

@@ -0,0 +1,128 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+module XBeeRuby
+
+	class Packet
+
+		START_BYTE = 0x7e
+		ESCAPE = 0x7d
+		XON = 0x11
+		XOFF = 0x13
+
+		def self.special_byte? byte
+			[START_BYTE, ESCAPE, XON, XOFF].include? byte
+		end
+
+		def self.checksum bytes
+			255 - bytes.reduce(&:+) % 256
+		end
+
+		def self.unescape bytes
+			bytes.inject([]) do |unescaped, b|
+				if unescaped.last == ESCAPE
+					unescaped.pop
+					unescaped << (0x20 ^ b)
+				else
+					unescaped << b
+				end
+			end
+		end
+
+		def self.from_bytes bytes
+			if bytes.length < 4
+				raise ArgumentError, "Packet is too short (only #{bytes.length} bytes)"
+			end
+			if bytes[0] != START_BYTE
+				raise ArgumentError, 'Missing start byte'
+			end
+			data = [START_BYTE] + unescape(bytes[1..-1])
+			length = (data[1] << 8) + data[2]
+			if length != data.length - 4
+				raise ArgumentError, "Expected data length to be #{length} but was #{data.length - 4}"
+			end
+			crc = checksum(data[3..-2])
+			if crc != data[-1]
+				raise ArgumentError, "Expected checksum to be 0x#{crc.to_s 16} but was 0x#{data[-1].to_s 16}"
+			end
+			self.new data[3..-2]
+		end
+
+		def self.next_unescaped_byte bytes
+			byte = bytes.next
+			if byte == ESCAPE then
+				0x20 ^ bytes.next
+			else
+				byte
+			end
+		end
+
+		def self.from_byte_enum bytes
+			begin
+				loop until bytes.next == Packet::START_BYTE
+				length = (next_unescaped_byte(bytes) << 8) + next_unescaped_byte(bytes)
+			rescue
+				raise IOError, 'Packet is too short, unable to read length fields'
+			end
+			begin
+				data = (1..length).map { next_unescaped_byte bytes }
+			rescue
+				raise IOError, "Expected data length to be #{length} but got fewer bytes"
+			end
+			begin
+				crc = next_unescaped_byte bytes
+			rescue
+				raise IOError, 'Packet is too short, unable to read checksum'
+			end
+			if crc != Packet::checksum(data) then
+				raise IOError, "Excpected checksum to be 0x#{Packet::checksum(data).to_s 16} but was 0x#{crc.to_s 16}"
+			end
+			Packet.new data
+		end
+
+		def initialize data
+			@data = data
+		end
+
+		def data
+			@data
+		end
+
+		def length
+			@data.length
+		end
+
+		def checksum
+			Packet.checksum @data
+		end
+
+		def bytes
+			[START_BYTE, length >> 8, length & 0xff] + @data + [checksum]
+		end
+
+		def bytes_escaped
+			[START_BYTE] + bytes[1..-1].flat_map { |b|
+				if Packet.special_byte?(b) then
+					[ESCAPE, 0x20 ^ b]
+				else
+					b
+				end }
+		end
+
+		def == other
+			self.data == other.data
+		end
+
+		def to_s
+			'Packet [' + data.map { |b| "0x#{b.to_s 16}" }.join(', ') + ']'
+		end
+	end
+
+end

data/lib/xbee-ruby/request.rb

@@ -0,0 +1,42 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+module XBeeRuby
+
+	class Request
+
+		@@frame_id = 1
+
+		def self.next_frame_id
+			@@frame_id.tap do |id|
+				@@frame_id = (id + 1) % 256
+			end
+		end
+
+		attr_reader :frame_id
+		attr_reader :frame_type
+
+		def initialize frame_type = 0
+			@frame_id = Request.next_frame_id
+			@frame_type = frame_type
+		end
+
+		def frame_data
+			raise 'Override to return frame data as a byte array'
+		end
+
+		def packet
+			Packet.new([frame_type, frame_id] + frame_data)
+		end
+
+	end
+
+end
+

data/lib/xbee-ruby/response.rb

@@ -0,0 +1,32 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+module XBeeRuby
+
+	class Response
+
+		@@response_types = {}
+
+		def self.frame_type type
+			@@response_types[type] = self
+		end
+
+		def self.from_packet packet
+			@@response_types[packet.data[0]].new packet.data rescue raise IOError, "Unknown response type 0x#{packet.data[0].to_s 16}"
+		end
+
+		def to_s
+			'Response'
+		end
+
+	end
+
+end
+

data/lib/xbee-ruby/rx_response.rb

@@ -0,0 +1,43 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/response'
+
+module XBeeRuby
+
+
+	class RxResponse < Response
+
+		frame_type 0x90
+
+		attr_reader :address64
+		attr_reader :address16
+		attr_reader :receive_options
+		attr_reader :data
+
+		def initialize bytes
+			@address64 = Address64.new *bytes[1..8]
+			@address16 = Address16.new *bytes[9..10]
+			@receive_options = bytes[11]
+			@data = bytes[12..-1]
+		end
+
+		def == other
+			other.class == RxResponse && self.address64 == other.address64 &&
+					self.address16 == other.address16 && self.receive_options == other.receive_options
+		end
+
+		def to_s
+			"RxResponse[#{super}](address64=0x#{address64}, address16=0x#{address16}, receive_otions=#{receive_options})"
+		end
+	end
+
+end
+

data/lib/xbee-ruby/tx_request.rb

@@ -0,0 +1,40 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/request'
+
+module XBeeRuby
+
+	class TxRequest < Request
+
+		attr_reader :address64
+		attr_reader :address16
+		attr_reader :data
+		attr_reader :options
+		attr_reader :radius
+
+		def initialize address64, data, opt = {}
+			super 0x10
+			@address64 = address64
+			@data = data
+			@frame_id = Request.next_frame_id
+			@address16 = opt[:address16] || Address16::BROADCAST
+			@options = opt[:options] || 0
+			@radius = opt[:radius] || 0
+		end
+
+		def frame_data
+			@address64.to_a + @address16.to_a + [@radius, @options] + @data
+		end
+
+	end
+
+end
+

data/lib/xbee-ruby/tx_response.rb

@@ -0,0 +1,46 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/response'
+
+module XBeeRuby
+
+	class TxResponse < Response
+
+		frame_type 0x8b
+
+		attr_reader :frame_id
+		attr_reader :address16
+		attr_reader :retry_count
+		attr_reader :delivery_status
+		attr_reader :discovery_status
+
+		def initialize bytes
+			@frame_id = bytes[1]
+			@address16 = Address16.new *bytes[2..3]
+			@retry_count = bytes[4]
+			@delivery_status = bytes[5]
+			@discovery_status = bytes[6]
+		end
+
+		def == other
+			other.class == TxResponse && self.address16 == other.address16 &&
+					self.retry_count == other.retry_count && self.delivery_status == other.delivery_status &&
+					self.discovery_status == other.discovery_status
+		end
+
+		def to_s
+			"TxResponse[#{super}](address16=0x#{address16}, retry_count=#{retry_count}, " +
+					"delivery_status=#{delivery_status}, discovery_status=#{discovery_status})"
+		end
+	end
+
+end
+

data/lib/xbee-ruby/version.rb

@@ -0,0 +1,15 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+module XBeeRuby
+
+	VERSION = '0.0.3'
+
+end

data/lib/xbee-ruby/xbee.rb

@@ -0,0 +1,85 @@
+=begin
+
+This file is part of the xbee-ruby gem.
+
+Copyright 2013-2014 Dirk Grappendorf, www.grappendorf.net
+
+Licensed under the The MIT License (MIT)
+
+=end
+
+require 'xbee-ruby/packet'
+
+module XBeeRuby
+
+	class XBee
+
+		# Either specify the port and serial parameters
+		#
+		#   xbee = XBeeRuby::Xbee.new port: '/dev/ttyUSB0', rate: 9600
+		#
+		# or pass in a SerialPort like object
+		#
+		#   xbee = XBeeRuby::XBee.new serial: some_serial_mockup_for_testing
+		#
+		def initialize port: '/dev/ttyUSB0', rate: 9600, serial: nil
+			@port = port
+			@rate = rate
+			@serial = serial
+			@connected = false
+			@logger = nil
+		end
+
+		def open
+			@serial ||= SerialPort.new @port, @rate
+			@serial_input = Enumerator.new { |y| loop do
+				y.yield @serial.readbyte
+			end }
+			@connected = true
+		end
+
+		def close
+			@serial.close if @serial
+			@connected = false
+		end
+
+		def connected?
+			@connected
+		end
+
+		alias :open? :connected?
+
+		def write_packet packet
+			@serial.write packet.bytes_escaped.pack('C*').force_encoding('ascii')
+			@serial.flush
+		end
+
+		def write_request request
+			write_packet request.packet
+			log { "Packet sent: #{request.packet.bytes.map { |b| b.to_s(16) }.join(',')}" }
+		end
+
+		def read_packet
+			Packet.from_byte_enum(@serial_input).tap do |packet|
+				log { "Packet received: #{packet.bytes.map { |b| b.to_s(16) }.join(',')}" }
+			end
+		end
+
+		def read_response
+			Response.from_packet read_packet
+		end
+
+		def serial= io
+			@serial = io
+		end
+
+		def logger= logger
+			@logger = logger
+		end
+
+		def log
+			@logger.call yield if @logger
+		end
+	end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: xbee-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Dirk Grappendorf (http://www.grappendorf.net)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+    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 API for Digi XBee RF Modules
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xbee-ruby.rb
+- lib/xbee-ruby/address_16.rb
+- lib/xbee-ruby/address_64.rb
+- lib/xbee-ruby/adress.rb
+- lib/xbee-ruby/modem_status_response.rb
+- lib/xbee-ruby/packet.rb
+- lib/xbee-ruby/request.rb
+- lib/xbee-ruby/response.rb
+- lib/xbee-ruby/rx_response.rb
+- lib/xbee-ruby/tx_request.rb
+- lib/xbee-ruby/tx_response.rb
+- lib/xbee-ruby/version.rb
+- lib/xbee-ruby/xbee.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0
+signing_key: 
+specification_version: 4
+summary: A Ruby API for Digi XBee RF Modules
+test_files: []