ruby-xbee 1.1.0 → 1.2.0

data/lib/module_config.rb

@@ -73,5 +73,22 @@ module XBee
         super("NI", default)
       end
     end
+
+    class ApiEnableMode < RFModuleParameter
+      def initialize(default = 0x01)
+        unless default == 0x01 or default == 0x02
+          raise "XBee AP parameter range can be 1-2; 1 = API-enabled; 2 = API-enabled (with escaped control characters)"
+        end
+        super("AP", default)
+      end
+
+      def in_symbol
+        unless self.value == 0x01 or self.value == 0x02
+          raise "XBee AP parameter invalid range! Valid range 1-2; Set to: #{self.value}"
+        end
+        return :API1 if self.value == 0x01
+        return :API2 if self.value == 0x02
+      end
+    end
   end
 end

data/lib/ruby_xbee.rb

@@ -66,12 +66,12 @@ module XBee
   # 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_accessor :xbee_serialport, :xbee_uart_config, :guard_time, :command_mode_timeout, :command_character, :node_discover_timeout, :node_identifier, :operation_mode, :api_mode, :transmission_mode
     attr_reader :serial_number, :hardware_rev, :firmware_rev
 
     def version
@@ -86,10 +86,10 @@ module XBee
         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"
+        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)"
+        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 )
@@ -100,6 +100,7 @@ module XBee
       @node_discover_timeout = NodeDiscoverTimeout.new
       @node_identifier = NodeIdentifier.new
       @operation_mode = operation_mode
+      @api_mode = ApiEnableMode.new
       @transmission_mode = transmission_mode
     end
 
@@ -123,7 +124,7 @@ module XBee
       case type
         when :short
           1200
-        when :long 
+        when :long
           3000
         else 3000
       end

data/test/ruby_xbee_api_frame_eac_test.rb

@@ -0,0 +1,132 @@
+$: << File.dirname(__FILE__)
+require 'ruby_xbee_api_frame_test'
+# Test cases for ZigBee Explicit Addressing Command (Frame Type: 0x11)
+# Test cases to cover the construction/sending and receiving/decoding
+# scenarios.
+class ExplicitAddressingCommand < RubyXbeeApiFrameTest
+
+	##
+	# Explicit Addressing ZigBee Command Frame (0x11)
+	# This allows ZigBee application layer fields (endpoint and cluster ID) to be specified for a data transmission.
+	# Here we send a valid OTA start request without encryption and OTA password set to broadcast destination network
+	# +----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------+
+	# |___________Header___________|______________________________________________________________Frame_____________________________________________________________|      |
+	# | SDelim | DlenMSB | DlenLSB | Type | ID | 64-bitDestination  | Dest16 | SrcEndPnt | DestEndPnt | ClusterID | ProfileID | BCRadius | Options |  Data Payload  | CSum |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------+-----------+----------+---------+----------------+------+
+	# |  0x7e  |   0x00  |   0x15  | 0x11 |0x10| 0x0101010101010ABC | 0xfffe |    0xE8   |    0xE8    |   0x1000  |   0xC105  |   0x00   |  0x00   |      0x00      | 0x6F |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------------------+----------+---------+----------------+------+
+	def test_eac_receive_ota_init_no_password
+		Thread.fork(@server.accept) do |client|
+			f = [ 0x7E, 0x00, 0x15, 0x11, 0x10, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x0A, 0xBC, 0xFF, 0xFE, 0xE8, 0xE8, 0x10, 0x00, 0xC1, 0x05, 0x00, 0x00, 0x00, 0x6F ]
+			client.write(f.pack("c*"))
+			client.close
+		end
+
+
+		xbee_frame = XBee::Frame.new(@s)
+		assert_equal("\x10\x01\x01\x01\x01\x01\x01\x0A\xBC\xFF\xFE\xE8\xE8\x10\x00\xC1\x05\x00\x00\x00".force_encoding("iso-8859-1"), xbee_frame.cmd_data.force_encoding("iso-8859-1"))
+		assert_equal(0x11, xbee_frame.api_identifier)
+	end
+
+	##
+	# Explicit Addressing ZigBee Command Frame (0x11)
+	# This allows ZigBee application layer fields (endpoint and cluster ID) to be specified for a data transmission.
+	# Here we send a valid OTA start request without encryption and OTA password set to broadcast destination network
+	# +----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------+
+	# |___________Header___________|______________________________________________________________Frame_____________________________________________________________|      |
+	# | SDelim | DlenMSB | DlenLSB | Type | ID | 64-bitDestination  | Dest16 | SrcEndPnt | DestEndPnt | ClusterID | ProfileID | BCRadius | Options |  Data Payload  | CSum |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------+-----------+----------+---------+----------------+------+
+	# |  0x7e  |   0x00  |   0x15  | 0x11 |0x10| 0x0101010101010ABC | 0xfffe |    0xE8   |    0xE8    |   0x1000  |   0xC105  |   0x00   |  0x00   |      0x00      | 0x6F |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------------------+----------+---------+----------------+------+
+	def test_eac_create_ota_init_no_password_default_payload_pack
+		Thread.fork(@server.accept) do |client|
+			frame = XBee::Frame::ExplicitAddressingCommand.new(0x10, 0x0101010101010ABC, 0x0000fffe, 0xE8, 0xE8, 0x1000, 0xC105, 0x00, 0x00)
+			client.write(frame._dump)
+			client.close
+		end
+
+		xbee_frame = XBee::Frame.new(@s)
+		assert_equal("\x10\x01\x01\x01\x01\x01\x01\x0A\xBC\xFF\xFE\xE8\xE8\x10\x00\xC1\x05\x00\x00\x00".force_encoding("iso-8859-1"), xbee_frame.cmd_data.force_encoding("iso-8859-1"))
+		assert_equal(0x11, xbee_frame.api_identifier)
+
+		# Build the frame from the received data
+		frame = XBee::Frame::ExplicitAddressingCommand.new()
+		frame.cmd_data = xbee_frame.cmd_data
+
+		assert_equal 0x10, frame.frame_id
+		assert_equal 0x0101010101010ABC, frame.destination_address
+		assert_equal 0xfffe, frame.destination_network
+		assert_equal 0xE8, frame.source_endpoint
+		assert_equal 0xE8, frame.destination_endpoint
+		assert_equal 0x1000, frame.cluster_id
+		assert_equal 0xc105, frame.profile_id
+		assert_equal 0x00, frame.broadcast_radius
+		assert_equal 0x00, frame.transmit_options
+		assert_equal "\0", frame.payload
+
+	end
+
+	##
+	# Explicit Addressing ZigBee Command Frame (0x11)
+	# This allows ZigBee application layer fields (endpoint and cluster ID) to be specified for a data transmission.
+	# Here we send a valid OTA start request without encryption and OTA password set to broadcast destination network
+	# +----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------+
+	# |___________Header___________|______________________________________________________________Frame_____________________________________________________________|      |
+	# | SDelim | DlenMSB | DlenLSB | Type | ID | 64-bitDestination  | Dest16 | SrcEndPnt | DestEndPnt | ClusterID | ProfileID | BCRadius | Options |  Data Payload  | CSum |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------+-----------+----------+---------+----------------+------+
+	# |  0x7e  |   0x00  |   0x15  | 0x11 |0x10| 0x0101010101010ABC | 0xfffe |    0xE8   |    0xE8    |   0x1000  |   0xC105  |   0x00   |  0x00   |      0x00      | 0x6F |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------------------+----------+---------+----------------+------+
+	# This is an interesting packet because in AP2 (with escaped control characters) The Frame Type gets escaped
+	def test_eac_create_ota_init_no_password_default_payload_pack_ap2
+		Thread.fork(@server.accept) do |client|
+			frame = XBee::Frame::ExplicitAddressingCommand.new(0x10, 0x0101010101010ABC, 0x0000fffe, 0xE8, 0xE8, 0x1000, 0xC105, 0x00, 0x00)
+			client.write(frame._dump(:API2))
+			client.close
+		end
+
+		xbee_frame = XBee::Frame.new(@s, :API2)
+		assert_equal("\x10\x01\x01\x01\x01\x01\x01\x0A\xBC\xFF\xFE\xE8\xE8\x10\x00\xC1\x05\x00\x00\x00".force_encoding("iso-8859-1"), xbee_frame.cmd_data.force_encoding("iso-8859-1"))
+		assert_equal(0x11, xbee_frame.api_identifier)
+
+		# Build the frame from the received data
+		frame = XBee::Frame::ExplicitAddressingCommand.new()
+		frame.cmd_data = xbee_frame.cmd_data
+
+		assert_equal 0x10, frame.frame_id
+		assert_equal 0x0101010101010ABC, frame.destination_address
+		assert_equal 0xfffe, frame.destination_network
+		assert_equal 0xE8, frame.source_endpoint
+		assert_equal 0xE8, frame.destination_endpoint
+		assert_equal 0x1000, frame.cluster_id
+		assert_equal 0xc105, frame.profile_id
+		assert_equal 0x00, frame.broadcast_radius
+		assert_equal 0x00, frame.transmit_options
+		assert_equal "\0", frame.payload
+
+	end
+
+	##
+	# Explicit Addressing ZigBee Command Frame (0x11)
+	# This allows ZigBee application layer fields (endpoint and cluster ID) to be specified for a data transmission.
+	# Here we send a valid OTA start request without encryption and OTA password set to broadcast destination network
+	# +----------------------------+--------------------------------------------------------------------------------------------------------------------------------+------+
+	# |___________Header___________|______________________________________________________________Frame_____________________________________________________________|      |
+	# | SDelim | DlenMSB | DlenLSB | Type | ID | 64-bitDestination  | Dest16 | SrcEndPnt | DestEndPnt | ClusterID | ProfileID | BCRadius | Options |  Data Payload  | CSum |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------+-----------+----------+---------+----------------+------+
+	# |  0x7e  |   0x00  |   0x15  | 0x11 |0x10| 0x0101010101010ABC | 0xfffe |    0xE8   |    0xE8    |   0x1000  |   0xC105  |   0x00   |  0x00   |      0x00      | 0x6F |
+	# +--------+---------+---------+------+----+--------------------+--------+-----------+------------+-----------------------+----------+---------+----------------+------+
+	# Here we send the packet in AP2 mode (escaped) but receive the packet in AP1 mode (unescaped) - the world should collapse because of bad checksum
+	def test_eac_create_ota_init_no_password_default_payload_pack_ap2
+		Thread.fork(@server.accept) do |client|
+			frame = XBee::Frame::ExplicitAddressingCommand.new(0x10, 0x0101010101010ABC, 0x0000fffe, 0xE8, 0xE8, 0x1000, 0xC105, 0x00, 0x00)
+			client.write(frame._dump(:API2))
+			client.close
+		end
+
+		runtimeerror_raised = assert_raises(RuntimeError) {
+			xbee_frame = XBee::Frame.new(@s)
+		}
+		assert_equal("Bad checksum - data discarded", runtimeerror_raised.message)
+
+	end
+end

data/test/ruby_xbee_api_frame_erxi_test.rb

@@ -0,0 +1,54 @@
+$: << File.dirname(__FILE__)
+require 'ruby_xbee_api_frame_test'
+# Test cases for ZigBee Explicit Rx Indicator (Frame Type: 0x91)
+# Test cases to cover the construction/sending and receiving/decoding
+# scenarios.
+class ExplicitRxIndicator < RubyXbeeApiFrameTest
+	##
+  # ZigBee Explicit Rx Indicator - (0x91) When the modem receives a ZigBee RF packet
+  # it is sent out the UART using this message type (when AO=1).
+  # +----------------------------+----------------------------------------------------------------------------------------------------------------+------+
+  # |___________Header___________|_____________________________________________________Frame______________________________________________________|      |
+  # | SDelim | DlenMSB | DlenLSB | Type | 64-bit Source Addr | Src.16 | SrcEndPnt | DestEndPnt | ClusterID | ProfileID | Options |  Data Payload  | CSum |
+  # +--------+---------+---------+------+--------------------+--------+-----------+------------+-----------+-----------+---------+----------------+------+
+  # |  0x7E  |   0x00  |   0x13  | 0x91 | 0x1234567890ABCDEF | 0x1234 |    0xE8   |    0xE8    |   0x0011  |   0xC105  |   0x01  |      0x43      | 0x32 |
+  # +--------+---------+---------+------+--------------------+--------+-----------+------------+-----------+-----------+---------+----------------+------+
+  # This frame is sent in response to type ZigBee Explicit Addressing Command (Frame Type: 0x11). The cluster 0x0011 is used by Digi as Virtual serial line
+  # And use for example in OTA firmware upgrade
+  def test_zigbee_explicit_rx_indicator_xmodem_start
+    Thread.fork(@server.accept) do |client|
+      f = [ 0x7E, 0x00, 0x13, 0x91, 0x12, 0x34, 0x56, 0x78, 0x90, 0xAB, 0xCD, 0xEF,
+            0x12, 0x34, 0xE8, 0xE8, 0x00, 0x11, 0xC1, 0x05, 0x01, 0x43, 0x32 ]
+      client.write(f.pack("c*"))
+      client.close
+    end
+
+    xbee_frame = XBee::Frame.new(@s)
+
+    assert_equal 0x91, xbee_frame.api_identifier
+		assert_equal 0x1234567890ABCDEF, xbee_frame.source_address
+		assert_equal 0x1234, xbee_frame.source_network
+		assert_equal 0xE8, xbee_frame.source_endpoint
+		assert_equal 0xE8, xbee_frame.destination_endpoint
+		assert_equal 0x0011, xbee_frame.cluster_id
+		assert_equal 0xc105, xbee_frame.profile_id
+		assert_equal 0x01, xbee_frame.receive_options
+		assert_equal "C".force_encoding("iso-8859-1"), xbee_frame.received_data.force_encoding("iso-8859-1")
+
+
+		# Let's construct a frame from scratch and use the data previously received
+		frame = XBee::Frame::ExplicitRxIndicator.new
+		frame.cmd_data = xbee_frame.cmd_data
+
+		assert_equal frame.api_identifier, xbee_frame.api_identifier
+		assert_equal frame.source_address, xbee_frame.source_address
+		assert_equal frame.source_network, xbee_frame.source_network
+		assert_equal frame.source_endpoint, xbee_frame.source_endpoint
+		assert_equal frame.destination_endpoint, xbee_frame.destination_endpoint
+		assert_equal frame.cluster_id, xbee_frame.cluster_id
+		assert_equal frame.profile_id, xbee_frame.profile_id
+		assert_equal frame.receive_options, xbee_frame.receive_options
+		assert_equal frame.received_data, xbee_frame.received_data
+		
+  end
+end