knx 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da3886255a22b8e72fe4843c9d572b8f55d0f24f
-  data.tar.gz: f13f7c99aa45592be334abe8d5fda818ed4a03a5
+  metadata.gz: b473b3ace06e05014aeebd7733497c6d81888edc
+  data.tar.gz: ac2690060bcb3352653117b86e97d693661f39bc
 SHA512:
-  metadata.gz: 1edd50db73644cc37edb56cdf2ac87375f39af1945df6ad957eb5dea19976a5c4d1545297fc754b51d66bc5e5a8c19544a4fe35645d1565e9b203a95e30df39f
-  data.tar.gz: 9146bc461808c8f06c56a5b3e256052ff95cb0ef0bb62d7eeac31e1b76e188f6f1ea560962a5a9a4efacab2b9ac4543ddcdc8bf6438c833894941cb0cc5e2ad7
+  metadata.gz: 1bc24fe48e8c95ec347067b8cd269ba2a0a772f1c19939d5546e1709c28c2312f58bae4df387f21a67f400d980278d1ddb81730f8fe85cdf64bcdadc67f9dd8c
+  data.tar.gz: 7d3762824d58560470b127dbfe3b533fccce6961c6d8c455099f5d8c2fe25f52de58493a75e3959f3f75578463cce644c46698b56bc3f7a5a2deee86cf563dfb

data/README.md

@@ -1,7 +1,7 @@
 # Ruby KNX
 
 Constructs [KNX standard](https://en.wikipedia.org/wiki/KNX_(standard)) datagrams that make it easy to communicate with devices on KNX networks.
-It does not implement the transport layer so you can use it with naitive ruby, eventmachine, celluloid or the like.
+It does not implement the transport layer so you can use it with native ruby, eventmachine, celluloid or the like.
 
 [![Build Status](https://travis-ci.org/acaprojects/ruby-knx.svg?branch=master)](https://travis-ci.org/acaprojects/ruby-knx)
 

data/knx.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
     s.name        = "knx"
-    s.version     = '1.0.0'
+    s.version     = '1.0.1'
     s.authors     = ["Stephen von Takach"]
     s.email       = ["steve@cotag.me"]
     s.licenses    = ["MIT"]

data/lib/knx.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'bindata'
 
@@ -14,7 +15,7 @@ class KNX
         no_repeat: true,
         broadcast: true,
         hop_count: 6,
-        msg_code: :send_datagram
+        msg_code: :data_indicator
     }
 
     def initialize(options = {})

data/lib/knx/address.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     # ------------------------

data/lib/knx/cemi.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     # APCI type
@@ -7,25 +8,81 @@ class KNX
         group_resp:  1,
         group_write: 2,
 
-        individual_write: 3,
-        individual_read:  4,
-        individual_resp:  5,
+        individual_write: 0x0C0,
+        individual_read:  0x100,
+        individual_resp:  0x140,
 
         adc_read: 6,
-        adc_resp: 7,
+        adc_resp: 0x1C0,
 
-        memory_read:  8,
-        memory_resp:  9,
-        memory_write: 10,
+        sys_net_param_read: 0x1C4,
+        sys_net_param_resp: 0x1C9,
+        sys_net_param_write: 0x1CA,
 
-        user_msg: 11,
+        memory_read:  0x020,
+        memory_resp:  0x024,
+        memory_write: 0x028,
 
-        descriptor_read: 12,
-        descriptor_resp: 13,
+        user_memory_read: 0x2C0,
+        user_memory_resp: 0x2C1,
+        user_memory_write: 0x2C2,
 
-        restart: 14,
-        escape:  15
+        user_manufacturer_info_read: 0x2C5,
+        user_manufacturer_info_resp: 0x2C6,
+
+        function_property_command: 0x2C7,
+        function_property_state_read: 0x2C8,
+        function_property_state_resp: 0x2C9,
+
+        device_descriptor_read: 0x300,
+        device_descriptor_resp: 0x340,
+
+        restart: 0x380,
+        escape: 0x3C0,  # Not sure about this one
+
+        authorize_request: 0x3D1,
+        authorize_resp: 0x3D2,
+
+        key_write: 0x3D3,
+        key_resp: 0x3D4,
+
+        property_value_read: 0x3D5,
+        property_value_resp: 0x3D6,
+        property_value_write: 0x3D7,
+
+        property_description_read: 0x3D8,
+        property_description_resp: 0x3D9,
+
+        network_param_read: 0x3DA,
+        network_param_resp: 0x3DB,
+
+        individual_serial_num_read:  0x3DC,
+        individual_serial_num_resp:  0x3DD,
+        individual_serial_num_write: 0x3DF,
+
+        domain_write: 0x3E0,
+        domain_read: 0x3E1,
+        domain_resp: 0x3E2,
+        domain_selective_read: 0x3E3,
+
+        network_param_write: 0x3E4,
+
+        link_read: 0x3E5,
+        link_resp: 0x3E6,
+        link_write: 0x3E7,
+
+        group_prop_value_read: 0x3E8,
+        group_prop_value_resp: 0x3E9,
+        group_prop_value_write: 0x3EA,
+        group_prop_value_info: 0x3EB,
+
+        domain_serial_num_read:  0x3EC,
+        domain_serial_num_resp:  0x3ED,
+        domain_serial_num_write: 0x3EE,
+
+        filesystem_info: 0x3F0
     }
+    ActionType.merge!(ActionType.invert)
 
     TpciType = {
         unnumbered_data: 0b00,
@@ -35,7 +92,29 @@ class KNX
     }
 
     MsgCode = {
-        send_datagram: 0x29
+        raw_request: 0x10,
+        data_request: 0x11,
+        poll_data_request: 0x13,
+        poll_data_connection: 0x25,
+        data_indicator: 0x29,
+        busmon_indicator: 0x2B,
+        raw_indicator: 0x2D,
+        data_connection: 0x2E,
+        raw_connection: 0x2F,
+        data_connection_request: 0x41,
+        data_individual_request: 0x4A,
+        data_connection_indicator: 0x89,
+        data_individual_indicator: 0x94,
+        reset_indicator: 0xF0,
+        reset_request: 0xF1,
+        propwrite_connection: 0xF5,
+        propwrite_request: 0xF6,
+        propinfo_indicator: 0xF7,
+        func_prop_com_request: 0xF8,
+        func_prop_stat_read_request: 0xF9,
+        func_prop_com_connection: 0xFA,
+        prop_read_connection: 0xFB,
+        prop_read_request: 0xFC
     }
 
     Priority = {
@@ -44,6 +123,20 @@ class KNX
         high: 2,
         low: 3
     }
+
+    ErrorCodes = {
+        0x00 => "Unspecified Error",
+        0x01 => "Out of range",
+        0x02 => "Out of maxrange",
+        0x03 => "Out of minrange",
+        0x04 => "Memory Error",
+        0x05 => "Read only",
+        0x06 => "Illegal command",
+        0x07 => "Void DP",
+        0x08 => "Type conflict",
+        0x09 => "Prop. Index range error",
+        0x0A => "Value temporarily not writeable"
+    }
     
 
     # CEMI == Common External Message Interface
@@ -216,5 +309,35 @@ class KNX
         bit4 :tpci_seq_num # Sequence number when tpci is sequenced
         bit4 :apci # application protocol control information (What we trying to do: Read, write, respond etc)
         bit6 :data # Or the tail end of APCI depending on the message type
+
+
+        # Applies 2 byte APCI value where required
+        #
+        # @param val [Symbol, Fixnum, Integer] the value or symbol representing the APCI value
+        # @return [true, false] returns true if data is available for storage
+        def apply_apci(val, data = nil)
+            value = if val.is_a?(Symbol)
+                ActionType[val]
+            else
+                val
+            end
+
+            if value > 15
+                self.apci = (value >> 6) & 0b1111
+                self.data = value & 0b111111
+                false
+            else
+                self.apci = value
+                if data && data[0] && data[0] <= 0b111111
+                    self.data = data[0]
+                    true
+                else
+                    self.data = 0
+                    false
+                end
+            end
+        rescue => e
+            raise ArgumentError, "Bad apci value: #{data}"
+        end
     end
 end

data/lib/knx/datagram.rb

@@ -1,27 +1,22 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
-    DatagramBuilder = Struct.new(:header, :cemi, :source_address, :destination_address, :data) do
+    DatagramBuilder = Struct.new(:header, :cemi, :source_address, :destination_address, :data, :action_type) do
 
         def to_binary_s
-            data_array = self.data
+            resp = if @cemi.apply_apci(self.action_type, self.data) && self.data
+                @cemi.data_length = self.data.length
 
-            resp = if present? data_array
-                @cemi.data_length = data_array.length
-
-                if data_array[0] <= 0b111111
-                    @cemi.data = data_array[0]
-                    if data_array.length > 1
-                        data_array[1..-1].pack('C')
-                    else
-                        String.new
-                    end
+                if self.data.length > 1
+                    self.data[1..-1].pack('C')
                 else
-                    @cemi.data = 0
-                    data_array.pack('C')
+                    String.new
                 end
+            elsif present?(self.data)
+                @cemi.data_length = self.data.length
+                self.data.pack('C')
             else
-                @cemi.data = 0
                 @cemi.data_length = 0
                 String.new
             end
@@ -59,6 +54,7 @@ class KNX
             @cemi.hop_count = options[:hop_count]
 
             @header = Header.new
+            @header.version = 0x10
             if options[:request_type]
                 @header.request_type = RequestTypes[options[:request_type]]
             else
@@ -93,15 +89,11 @@ class KNX
             super(address, options)
 
             # Set the protocol control information
-            @cemi.apci = @address.is_group? ? ActionType[:group_write] : ActionType[:individual_write]
+            self.action_type = @address.is_group? ? :group_write : :individual_write
+            @cemi.apply_apci(self.action_type, data_array)
             @cemi.tpci = TpciType[:unnumbered_data]
 
-            # To attempt save a byte we try to cram the first byte into the APCI field
             if present? data_array
-                if data_array[0] <= 0b111111
-                    @cemi.data = data_array[0]
-                end
-                
                 @cemi.data_length = data_array.length
                 self.data = data_array
             end
@@ -113,7 +105,8 @@ class KNX
             super(address, options)
 
             # Set the protocol control information
-            @cemi.apci = @address.is_group? ? ActionType[:group_read] : ActionType[:individual_read]
+            self.action_type = @address.is_group? ? :group_read : :individual_read
+            @cemi.apply_apci(self.action_type)
             @cemi.tpci = TpciType[:unnumbered_data]
         end
     end
@@ -134,6 +127,10 @@ class KNX
             self.data = raw_data[17..(@header.request_length - 1)].bytes
             if @cemi.data_length > self.data.length
                 self.data.unshift @cemi.data
+                self.action_type = ActionType[@cemi.apci]
+            else
+                acpi = @cemi.data | (@cemi.apci << 6)
+                self.action_type = ActionType[acpi] || ActionType[@cemi.apci]
             end
 
             self.source_address = IndividualAddress.parse(@cemi.source_address.to_i)

data/lib/knx/header.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     RequestTypes = {
@@ -17,7 +18,13 @@ class KNX
         tunnelling_request: 0x0420,
         tunnelling_ack: 0x0421,
         routing_indication: 0x0530,
-        routing_lost_message: 0x0531
+        routing_lost_message: 0x0531,
+
+        routing_busy: 0x0532,
+        remote_diagnostic_request: 0x0740,
+        remote_diagnostic_response: 0x0741,
+        remote_basic_config_request: 0x0742,
+        remote_reset_request: 0x0743
     }
 
     # http://www.openremote.org/display/forums/KNX+IP+Connection+Headers
@@ -25,7 +32,7 @@ class KNX
         endian :big
 
         uint8  :header_length,  value: 0x06  # Length 6 (always for version 1)
-        uint8  :version,        value: 0x10  # Version 1
+        uint8  :version
         uint16 :request_type
         uint16 :request_length
     end

data/lib/knx/object_server.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'bindata'
 

data/lib/knx/object_server/datagram.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     class ObjectServer
@@ -64,14 +65,15 @@ class KNX
 
             def to_binary_s
                 self.header.item_count = @data.length if @data.length > 0
-                resp = "#{self.connection.to_binary_s}#{self.header.to_binary_s}"
+                resp = String.new "#{self.connection.to_binary_s}#{self.header.to_binary_s}"
 
                 @data.each do |item|
                     resp << item.to_binary_s
                 end
 
                 self.knx_header.request_length = resp.length + 6
-                "#{self.knx_header.to_binary_s}#{resp}"
+                resp.prepend self.knx_header.to_binary_s
+                resp
             end
 
             def add_action(index, data: nil, **options)
@@ -86,7 +88,7 @@ class KNX
                     if data.is_a? String
                         req.value = data
                     else
-                        req.value = ''
+                        req.value = String.new
                         req.value << data
                     end
                 end

data/lib/knx/object_server/object_header.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     class ObjectServer

data/lib/knx/object_server/request_item.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     class ObjectServer

data/lib/knx/object_server/status_item.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 class KNX
     class ObjectServer

data/spec/knx_spec.rb

@@ -30,9 +30,14 @@ describe "knx protocol helper" do
 
     it "should generate byte action requests" do
         datagram = @knx.action('1/2/0', 20)
-        expect(datagram.to_binary_s).to eq("\x06\x10\x050\x00\x11)\x00\xBC\xE0\x00\x01\n\x00\x01\x00\x94")
+        expect(datagram.to_binary_s).to eq("\x06\x10\x05\x30\x00\x11\x29\x00\xBC\xE0\x00\x01\n\x00\x01\x00\x94")
 
         datagram = @knx.action('1/2/0', 240)
-        expect(datagram.to_binary_s).to eq("\x06\x10\x050\x00\x12)\x00\xBC\xE0\x00\x01\n\x00\x01\x00\x80\xF0")
+        expect(datagram.to_binary_s).to eq("\x06\x10\x05\x30\x00\x12\x29\x00\xBC\xE0\x00\x01\n\x00\x01\x00\x80\xF0")
+    end
+
+    it "should generate status requests" do
+        datagram = @knx.status('1/2/1')
+        expect(datagram.to_binary_s).to eq("\x06\x10\x05\x30\x00\x11\x29\x00\xBC\xE0\x00\x01\n\x01\x00\x00\x00")
     end
 end

data/spec/object_server_spec.rb

@@ -1,4 +1,5 @@
-#encoding: ASCII-8BIT
+# encoding: ASCII-8BIT
+# frozen_string_literal: true
 
 require 'knx/object_server'
 
@@ -9,8 +10,8 @@ describe "object server protocol helper" do
     end
 
     it "should parse and generate the same string" do
-        datagram = @knx.read("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
-        expect(datagram.to_binary_s).to eq("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
+        datagram = @knx.read("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
 
         expect(datagram.data[0].id).to eq(2)
         expect(datagram.data[0].value).to eq("\x01")
@@ -18,17 +19,22 @@ describe "object server protocol helper" do
 
     it "should generate single bit action requests" do
         datagram = @knx.action(1, false)
-        expect(datagram.to_binary_s).to eq("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x01\x00\x01\x00\x01\x03\x01\x00")
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x01\x00\x01\x00\x01\x03\x01\x00")
 
         datagram = @knx.action(2, true)
-        expect(datagram.to_binary_s).to eq("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x02\x00\x01\x00\x02\x03\x01\x01")
     end
 
     it "should generate byte action requests" do
         datagram = @knx.action(3, 20)
-        expect(datagram.to_binary_s).to eq("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x03\x00\x01\x00\x03\x03\x01\x14")
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x03\x00\x01\x00\x03\x03\x01\x14")
 
         datagram = @knx.action(4, 240)
-        expect(datagram.to_binary_s).to eq("\x06\x10\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x04\x00\x01\x00\x04\x03\x01\xF0")
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x15\x04\x00\x00\x00\xF0\x06\x00\x04\x00\x01\x00\x04\x03\x01\xF0")
+    end
+
+    it "should generate status requests" do
+        datagram = @knx.status(3)
+        expect(datagram.to_binary_s).to eq("\x06\x20\xF0\x80\x00\x11\x04\x00\x00\x00\xF0\x05\x00\x03\x00\x01\x01")
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knx
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stephen von Takach