xbee 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8610d87b16c2a9335c2ce72be4dc5a602aff5f10
+  data.tar.gz: 4844015c3481f1de20c56b61361b87d546ab5a78
+SHA512:
+  metadata.gz: 509e9b13d5baddcae59ba5193763840aa88f0cd7e4212294bb85405ab4c9af5ca6b4f703263d36af06d2d4020d19e620dbb03808082cef22477a16b2ee786f5a
+  data.tar.gz: 0e3895e30803d0e1708a701ae823220118bd8ebd02fabc12474c2690fadc8eeef62064c942393173fd02b3303852aa2b2fa98dd491f1ca05d4aa17d2653caca9

data/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_size = tab
+indent_style = tab
+#tab_width = 4
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,25 @@
+# IntelliJ
+/.idea
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+
+
+# Sublime
+*.sublime-workspace

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012-2013 Dirk Grappendorf, www.grappendorf.net
+Copyright (c) 2017 Aaron Ten Clay, https://aarontc.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+XBee
+====
+
+A Ruby API for XBee ZigBee-RF-Modules
+-------------------------------------
+
+This gem is forked from the original XBee-Ruby gem. Because major API changes are being made a new name is appropriate.
+
+See the `examples/` directory for some working examples with slightly more complexity than the samples below.
+
+The `spec/` directory is left over from the forked gem, and will be converted to Minitest in the near future.
+
+Example: Transmit a packet to another node
+------------------------------------------
+
+	xbee = XBee::XBee.new device_path: '/dev/ttyUSB0', rate: 115200
+	xbee.open
+	request = XBee::Frames::RemoteATCommandRequest.new
+	request.address64 = XBee::Address64.from_string '0013A232408BACE4'
+	request.at_command = 'NI'
+	request.id = 0x01
+	xbee.write_frame request
+	puts xbee.read_frame
+	xbee.close
+
+Example: Receive packets
+------------------------
+
+	xbee = XBee::XBee.new port: '/dev/ttyUSB0', rate: 115200
+	xbee.open
+	loop do
+		frame = xbee.read_frame
+		puts "Frame received: #{frame.inspect}"
+	end
+
+Contributing
+------------
+All development happens via Git using the [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model. The canonical source location is
+[XBee Bitbucket](https://work.techtonium.com/bitbucket/projects/XBEE). This repository is automatically mirrored to [GitHub](https://github.com/IdleEngineers/xbee).
+
+If you find a bug or have a feature request, please create an issue in the [XBee issue tracker](https://work.techtonium.com/jira/browse/XBEE).
+
+
+License
+-------
+
+The XBee code is licensed under the the MIT License
+
+You find the license in the attached LICENSE.txt file

data/examples/check_and_set_destination_address.rb

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'timeout'
+require_relative '../lib/xbee'
+
+class CheckAndSetDestinationAddress
+	def run
+		xbee = XBee::XBee.new device_path: '/dev/ttyUSB0', rate: 115200
+		xbee.open
+
+		# First get Identifier
+		request = XBee::Frames::RemoteATCommandRequest.new
+		request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+		request.at_command = 'NI'
+		request.id = 0x01
+		puts "Transmitting frame: #{request.inspect}"
+		xbee.write_frame request
+		Timeout.timeout(10) do
+			loop do
+				response = xbee.read_frame
+				if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+					if response.address64 == request.address64
+						@ni = response.data.pack('C*')
+						puts format('Got node identity from %s: %s', request.address64.to_s, response.data.pack('C*'))
+						break
+					else
+						puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+					end
+				end
+				puts "Got response we don't need: #{response}"
+			end
+		end
+
+
+		# Now get destination address
+		request = XBee::Frames::RemoteATCommandRequest.new
+		request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+		request.at_command = 'DH'
+		request.id = 0x02
+		puts "Transmitting frame: #{request.inspect}"
+		xbee.write_frame request
+		Timeout.timeout(10) do
+			loop do
+				response = xbee.read_frame
+				if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+					if response.address64 == request.address64
+						puts format('Got DH from %s: %s', request.address64.to_s, response.data)
+						@dh = response.data
+						break
+					else
+						puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+					end
+				end
+				puts "Got response we don't need: #{response}"
+			end
+		end
+
+		request = XBee::Frames::RemoteATCommandRequest.new
+		request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+		request.at_command = 'DL'
+		request.id = 0x03
+		puts "Transmitting frame: #{request.inspect}"
+		xbee.write_frame request
+		Timeout.timeout(10) do
+			loop do
+				response = xbee.read_frame
+				if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+					if response.address64 == request.address64
+						puts format('Got DL from %s: %s', request.address64.to_s, response.data)
+						@dl = response.data
+						break
+					else
+						puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+					end
+				end
+				puts "Got response we don't need: #{response}"
+			end
+		end
+
+		@dest = XBee::Address64.new *@dh, *@dl
+		puts "Node #{@ni.inspect} Destination: #{@dest}"
+		# @target = XBee::Address64::COORDINATOR
+		@target = XBee::Address64.from_string '0013A20040B79952'
+
+		unless @dest == @target
+			puts "Updating destination address to be #{@target}..."
+			request = XBee::Frames::RemoteATCommandRequest.new
+			request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+			request.at_command = 'DH'
+			request.command_parameter = @target.to_a[0..3]
+			request.id = 0x04
+			puts "Transmitting frame: #{request.inspect}"
+			xbee.write_frame request
+			Timeout.timeout(10) do
+				loop do
+					response = xbee.read_frame
+					if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+						if response.address64 == request.address64
+							puts format('Got DH from %s: %s', request.address64.to_s, response.data)
+							@dl = response.data
+							break
+						else
+							puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+						end
+					end
+					puts "Got response we don't need: #{response}"
+				end
+			end
+
+			request = XBee::Frames::RemoteATCommandRequest.new
+			request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+			request.at_command = 'DL'
+			request.command_parameter = @target.to_a[4..7]
+			request.id = 0x05
+			puts "Transmitting frame: #{request.inspect}"
+			xbee.write_frame request
+			Timeout.timeout(10) do
+				loop do
+					response = xbee.read_frame
+					if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+						if response.address64 == request.address64
+							puts format('Got DL from %s: %s', request.address64.to_s, response.data)
+							@dl = response.data
+							break
+						else
+							puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+						end
+					end
+					puts "Got response we don't need: #{response}"
+				end
+			end
+
+			request = XBee::Frames::RemoteATCommandRequest.new
+			request.address64 = XBee::Address64.from_string '0013A200408BACE4'
+			request.at_command = 'AC'
+			request.id = 0x06
+			puts "Transmitting frame: #{request.inspect}"
+			xbee.write_frame request
+			Timeout.timeout(10) do
+				loop do
+					response = xbee.read_frame
+					if response.is_a?(XBee::Frames::RemoteATCommandResponse)
+						if response.address64 == request.address64
+							puts format('Got AC from %s: %s', request.address64.to_s, response.data)
+							@dl = response.data
+							break
+						else
+							puts format('Got response from wrong node %s: %s', request.address64.to_s, response.data.pack('C*'))
+						end
+					end
+					puts "Got response we don't need: #{response}"
+				end
+			end
+		end
+
+	ensure
+		xbee.close
+	end
+end
+
+CheckAndSetDestinationAddress.new.run if $0 == __FILE__

data/examples/read_frames.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+require 'bundler/setup'
+require 'semantic_logger'
+require 'trollop'
+
+@options = Trollop.options do
+	opt :device, 'Path to serial device', default: '/dev/ttyUSB0', type: :string
+	opt :baud, 'Baud rate for XBee radio', default: 115200, type: :integer
+	opt :log_path, 'Path for log file', default: nil, type: :string
+	opt :log_level, 'Logging level - trace, debug, info, warn, error, fatal', default: 'debug', type: :string, callback: lambda { |s| raise Trollop::CommandlineError, 'Invalid logging level specified' unless SemanticLogger::LEVELS.include? s.to_sym}
+end
+
+SemanticLogger.default_level = @options.log_level.to_sym
+SemanticLogger.add_appender file_name: @options.log_path, formatter: :color if @options.log_path
+SemanticLogger.add_appender io: $stdout, formatter: :color
+
+
+require 'xbee'
+
+class ReadFrames
+	include SemanticLogger::Loggable
+
+
+	def initialize(device_path: @options.device, rate: @options.baud)
+		@device_path = device_path
+		@rate = rate
+	end
+
+
+	def run
+		xbee = XBee::XBee.new device_path: @device_path, rate: @rate
+		xbee.open
+		loop do
+			frame = xbee.read_frame
+			logger.info 'Frame received.', frame: frame
+		end
+	end
+end
+
+if $0 == __FILE__
+	reader = ReadFrames.new device_path: @options.device, rate: @options.baud
+	reader.run
+end

data/examples/response_parser_throughput.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../lib/xbee'
+
+class FakeIO
+	def initialize
+		@queue = Queue.new
+	end
+
+	def readbyte
+		if @queue.empty?
+			load_queue
+		end
+		@queue.pop
+	end
+
+	def load_queue
+		[0x7e, 0x00, 0x07, 0x8b, 0x02, 0x79, 0x38, 0x00, 0x00, 0x00, 0xc1].each do |b|
+			@queue.push b
+		end
+	end
+end
+
+xbee = XBee::XBee.new io: FakeIO.new
+xbee.open
+num_reads = 0
+start_time = Time.now.to_f
+end_time = start_time + 10
+puts 'Reading responses from a faked serial connection for 10 seconds'
+while Time.now.to_f < end_time
+	xbee.read_frame
+	num_reads += 1
+end
+puts 'Done'
+puts "#{num_reads / 10.0} per second"

data/lib/xbee.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'serialport'
+
+require_relative 'xbee/version'
+require_relative 'xbee/xbee'

data/lib/xbee/address.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module XBee
+	class Address
+		include Comparable
+
+
+		def <=>(other)
+			to_a <=> other.to_a
+		end
+
+
+		def ==(other)
+			to_a == other.to_a
+		end
+
+
+		def to_a
+			@bytes
+		end
+
+	end
+end

data/lib/xbee/address_16.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require_relative 'address'
+
+module XBee
+	class Address16 < Address
+		def initialize(msb, lsb)
+			@bytes = [msb, lsb]
+		end
+
+
+		class << self
+			def from_string(string)
+				if (matcher = /^(\h\h)[^\h]*(\h\h)$/.match(string))
+					new *(matcher[1..2].map &:hex)
+				else
+					raise ArgumentError, "#{string} is not a valid 16-bit address string"
+				end
+			end
+
+
+			def from_array(array)
+				if array.length == 2 && array.all? { |x| (0..255).cover? x }
+					new *array
+				else
+					raise ArgumentError, "#{array.inspect} is not a valid 16-bit address array"
+				end
+			end
+		end
+
+
+		def to_s
+			'%02x%02x' % @bytes
+		end
+
+
+		BROADCAST = new(0xff, 0xfe).freeze
+		COORDINATOR = new(0x00, 0x00).freeze
+	end
+end