xbee 1.0.2

data/lib/xbee/frames/transmit_status.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require_relative 'identified_frame'
+
+module XBee
+	module Frames
+		# When a Transmit Request (0x10, 0x11) completes, the device sends a Transmit Status message out of
+		# the serial interface. This message indicates if the Transmit Request was successful or if it failed.
+		class TransmitStatus < IdentifiedFrame
+			api_id 0x8b
+
+			attr_accessor :address16
+			attr_accessor :retry_count
+			attr_accessor :delivery_status
+			attr_accessor :discovery_status
+
+
+			DELIVERY_STATUSES = {
+				0x00 => 'Success',
+				0x01 => 'MAC ACK Failure',
+				0x02 => 'CCA Failure',
+				0x15 => 'Invalid destination endpoint',
+				0x21 => 'Network ACK Failure',
+				0x22 => 'Not Joined to Network',
+				0x23 => 'Self-addressed',
+				0x24 => 'Address Not Found',
+				0x25 => 'Route Not Found',
+				0x26 => 'Broadcast source failed to hear a neighbor relay the message',
+				0x2B => 'Invalid binding table index',
+				0x2C => 'Resource error lack of free buffers, timers, etc.',
+				0x2D => 'Attempted broadcast with APS transmission',
+				0x2E => 'Attempted unicast with APS transmission, but EE=0',
+				0x32 => 'Resource error lack of free buffers, timers, etc.',
+				0x74 => 'Data payload too large',
+				0x75 => 'Indirect message unrequested',
+			}.freeze
+
+			DISCOVERY_STATUSES = {
+				0x00 => 'No Discovery Overhead',
+				0x01 => 'Address Discovery',
+				0x02 => 'Route Discovery',
+				0x03 => 'Address and Route',
+				0x40 => 'Extended Timeout Discovery',
+			}.freeze
+
+
+			def initialize(packet: nil)
+				super
+
+				if @parse_bytes
+					@address16 = Address16.new *@parse_bytes.shift(2)
+					@retry_count = @parse_bytes.shift
+					@delivery_status = @parse_bytes.shift
+					@discovery_status = @parse_bytes.shift
+				end
+			end
+
+
+			def bytes
+				super + (address16 || [0xff, 0xfd]).to_a + [retry_count || 0x00] + [delivery_status || 0x00] + [discovery_status || 0x00]
+			end
+		end
+	end
+end

data/lib/xbee/frames/unidentified_addressed_frame.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative 'frame'
+
+module XBee
+	module Frames
+		class UnidentifiedAddressedFrame < Frame
+			attr_accessor :address16
+			attr_accessor :address64
+
+
+			def initialize(packet: nil)
+				super
+
+				if @parse_bytes
+					@address64 = Address64.new *@parse_bytes.shift(8)
+					@address16 = Address16.new *@parse_bytes.shift(2)
+				end
+			end
+
+
+			def bytes
+				super + (address64 || Address64.from_array([0] * 8)).to_a + (address16 || Address16.new(0, 0)).to_a
+			end
+		end
+	end
+end

data/lib/xbee/frames/xbee_sensor_read_indicator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require_relative 'frame'
+require_relative '../bytes'
+
+module XBee
+	module Frames
+		# When the device receives a sensor sample (from a Digi 1-wire sensor adapter), it is sent out the serial
+		# port using this message type (when AO=0).
+		class XBeeSensorReadIndicator < Frame
+			api_id 0x94
+
+			attr_accessor :address64
+			attr_accessor :address16
+			attr_accessor :options
+			attr_accessor :one_wire_sensors
+			attr_accessor :analog_values # Array of 4 integers
+			attr_accessor :temperature
+
+
+			def initialize(packet: nil)
+				super
+
+				if @parse_bytes
+					@address64 = Address64.new *@parse_bytes.shift(8)
+					@address16 = Address16.new *@parse_bytes.shift(2)
+					@options = @parse_bytes.shift
+					@one_wire_sensors = @parse_bytes.shift
+					@analog_values = [
+						Bytes.unsigned_int_from_array(@parse_bytes.shift(2)),
+						Bytes.unsigned_int_from_array(@parse_bytes.shift(2)),
+						Bytes.unsigned_int_from_array(@parse_bytes.shift(2)),
+						Bytes.unsigned_int_from_array(@parse_bytes.shift(2)),
+					]
+					@temperature = Bytes.unsigned_int_from_array(@parse_bytes.shift(2))
+				end
+			end
+
+
+			def bytes
+				super +
+					(address64 || Address64::COORDINATOR).to_a +
+					(address16 || Address16::COORDINATOR).to_a +
+					[options || 0x00] +
+					[one_wire_sensors || 0x00] +
+					((analog_values || [0xffff] * 4).map { |v| Bytes.array_from_unsigned_int(v, 2) }.reduce(:+))+
+					Bytes.array_from_unsigned_int(temperature || 0x0, 2)
+			end
+		end
+	end
+end

data/lib/xbee/packet.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module XBee
+	class Packet
+		START_BYTE = 0x7E
+		ESCAPE = 0x7D
+		XON = 0x11
+		XOFF = 0x13
+
+		ESCAPE_XOR = 0x20
+
+		ESCAPE_BYTES = [
+			START_BYTE, ESCAPE, XON, XOFF
+		].freeze
+
+		class << self
+			# @param byte [Integer]
+			def special_byte?(byte)
+				ESCAPE_BYTES.include? byte
+			end
+
+
+			def checksum(bytes)
+				255 - bytes.reduce(&:+) % 256
+			end
+
+
+			# Escapes an array of bytes. Ignores the first byte unless ignore_first_byte is set to false in the options hash.
+			# @param bytes [Array<Integer>] The array of bytes to escape.
+			# @param options [Hash] Options hash.
+			# @option options [Boolean] :ignore_first_byte If the first byte should be ignored (usually true for handling an entire packet since the first byte is START_BYTE). Default true.
+			# @return [Array<Integer>] Escaped bytes.
+			def escape(bytes, options = {})
+				ignore_first_byte = options.fetch :ignore_first_byte, true
+
+				prepend = []
+				if ignore_first_byte
+					bytes = bytes.dup
+					prepend = [bytes.shift]
+				end
+
+				prepend + bytes.reduce([]) do |escaped, b|
+					if ESCAPE_BYTES.include?(b)
+						escaped << ESCAPE
+						escaped << (ESCAPE_XOR ^ b)
+					else
+						escaped << b
+					end
+				end
+			end
+
+
+			# When provided a byte array that has escaped data, this returns a new byte array with just the raw data.
+			# @param bytes [Array<Integer>] Array of bytes to unescape.
+			# @return [Array<Integer>] Array of unescaped bytes.
+			def unescape(bytes)
+				byte_escaped = false
+				bytes.reduce([]) do |unescaped, b|
+					if byte_escaped
+						unescaped << (0x20 ^ b)
+						byte_escaped = false
+					else
+						if b == ESCAPE
+							byte_escaped = true
+						else
+							unescaped << b
+						end
+					end
+					unescaped
+				end
+			end
+
+
+			def 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
+				new data[3..-2]
+			end
+
+
+			def next_unescaped_byte(bytes)
+				byte = bytes.next
+				if byte == ESCAPE
+					0x20 ^ bytes.next
+				else
+					byte
+				end
+			end
+
+
+			def from_byte_enum(bytes)
+				begin
+					loop until bytes.next == 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 != checksum(data)
+					raise IOError, "Expected checksum to be 0x#{checksum(data).to_s 16} but was 0x#{crc.to_s 16}"
+				end
+				new data
+			end
+		end
+
+
+		# @param data [Array<Integer>] Byte array
+		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 do |b|
+				if self.class.special_byte?(b)
+					[ESCAPE, 0x20 ^ b]
+				else
+					b
+				end
+			end
+		end
+
+
+		def ==(other)
+			data == other.data
+		end
+
+
+		def to_s
+			'Packet [' + data.map { |b| "0x#{b.to_s 16}" }.join(', ') + ']'
+		end
+	end
+end

data/lib/xbee/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module XBee
+	VERSION = '1.0.2'
+end

data/lib/xbee/xbee.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+require 'semantic_logger'
+
+require_relative 'packet'
+require_relative 'frames/at_command'
+require_relative 'frames/at_command_queue_parameter_value'
+require_relative 'frames/at_command_response'
+require_relative 'frames/create_source_route'
+require_relative 'frames/data_sample_rx_indicator'
+require_relative 'frames/explicit_addressing_command'
+require_relative 'frames/explicit_rx_indicator'
+require_relative 'frames/many_to_one_route_request_indicator'
+require_relative 'frames/modem_status'
+require_relative 'frames/node_identification_indicator'
+require_relative 'frames/over_the_air_firmware_update_status'
+require_relative 'frames/receive_packet'
+require_relative 'frames/remote_at_command_request'
+require_relative 'frames/remote_at_command_response'
+require_relative 'frames/route_record_indicator'
+require_relative 'frames/transmit_request'
+require_relative 'frames/transmit_status'
+require_relative 'frames/xbee_sensor_read_indicator'
+
+
+module XBee
+	# Either specify the port and serial parameters
+	#
+	#   xbee = XBee::Xbee.new device_path: '/dev/ttyUSB0', rate: 9600
+	#
+	# or pass in a SerialPort like object
+	#
+	#   xbee = XBee::XBee.new io: some_serial_mockup_for_testing
+	#
+	class XBee
+		include SemanticLogger::Loggable
+
+		def initialize(device_path: '/dev/ttyUSB0', rate: 115200, io: nil)
+			@device_path = device_path
+			@rate = rate
+			@io = io
+			@connected = false
+			@logger = nil
+		end
+
+
+		def open
+			@io ||= SerialPort.new @device_path, @rate
+			@io_input = Enumerator.new do |y|
+				loop do
+					y.yield @io.readbyte
+				end
+			end
+			@connected = true
+		end
+
+
+		def close
+			@io.close if @io
+			@connected = false
+		end
+
+
+		def connected?
+			@connected
+		end
+		alias :open? :connected?
+
+
+		def write_packet(packet)
+			@io.write packet.bytes_escaped.pack('C*').force_encoding('ascii')
+			@io.flush
+		end
+
+
+		def write_frame(frame)
+			if frame.packet
+				# TODO: Is it right to assume the packet is in sync with the frame?
+				write_packet frame.packet
+			else
+				packet = frame.to_packet
+				write_packet packet
+			end
+		end
+
+
+		def write_request(request)
+			logger.measure_trace('Packet sent.', payload: { bytes: request.packet.bytes }) do
+				write_packet request.packet
+			end
+		end
+
+
+		def read_packet
+			Packet.from_byte_enum(@io_input).tap do |packet|
+				logger.trace 'Packet received.', bytes: packet.bytes
+			end
+		end
+
+
+		def read_frame
+			Frames::Frame.from_packet read_packet
+		end
+
+
+		def io=(io)
+			@io = io
+		end
+	end
+end

data/xbee.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xbee/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'xbee'
+	spec.version = XBee::VERSION
+	spec.description = 'A Ruby API for sending/receiving API frames with Digi XBee RF Modules.'
+	spec.summary = 'A Ruby API for Digi XBee RF Modules.'
+	spec.email = 'rubygems-xbee@aarontc.com'
+	spec.authors = ['Dirk Grappendorf (http://www.grappendorf.net)', 'Aaron Ten Clay (https://aarontc.com)']
+	spec.homepage = 'https://github.com/IdleEngineers/xbee'
+	spec.license = 'MIT'
+	spec.metadata = {
+		'issue_tracker' => 'https://work.techtonium.com/jira/browse/XBEE',
+	}
+
+	spec.files = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	spec.bindir = 'exe'
+	spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler', '~> 1'
+	spec.add_development_dependency 'minitest', '~> 5'
+	spec.add_development_dependency 'minitest-ci', '~> 3'
+	spec.add_development_dependency 'minitest-reporters', '~> 1'
+	spec.add_development_dependency 'rake', '~> 10'
+	spec.add_development_dependency 'rr', '~> 1'
+	spec.add_development_dependency 'simplecov', '~> 0'
+	spec.add_development_dependency 'simplecov-rcov', '~> 0'
+	spec.add_development_dependency 'trollop', '~> 2'
+
+	spec.add_dependency 'serialport', '~> 1'
+	spec.add_dependency 'semantic_logger', '~> 4'
+end