ruby-sml 0.2

data/lib/ruby-sml/sml-publicclose.rb

@@ -0,0 +1,51 @@
+require 'ruby-sml/nilclass-mixin'
+
+module SML
+  module PublicClose
+
+    class Request
+      attr_accessor :global_signature
+
+      def initialize(global_signature)
+        @global_signature = global_signature
+      end
+
+      def self.construct(array_rep)
+        return nil if array_rep.nil?
+        return SML::PublicClose::Request.new(array_rep.shift)
+      end
+
+      def self.pconstruct(o={})
+        return SML::PublicClose::Request.new(o[:global_signature])
+      end
+
+      def to_a
+        return [] << global_signature
+      end
+
+    end
+    
+    class Response
+      attr_accessor :global_signature
+
+      def initialize(global_signature)
+        @global_signature = global_signature
+      end
+
+      def self.construct(array_rep)
+        return nil if array_rep.nil?
+        return SML::PublicClose::Response.new(array_rep.shift)
+      end
+
+      def self.pconstruct(o={})
+        return SML::PublicClose::Response.new(o[:global_signature])
+      end
+
+      def to_a
+        return [] << global_signature
+      end
+
+    end
+
+  end
+end

data/lib/ruby-sml/sml-publicopen.rb

@@ -0,0 +1,84 @@
+require 'ruby-sml/nilclass-mixin'
+require 'ruby-sml/sml-time'
+
+module SML
+  module PublicOpen
+
+    class Request
+      attr_accessor :codepage, :client_id, :request_file_id, :server_id, :username, :password, :sml_version
+
+      def initialize(codepage, client_id, request_file_id, server_id, username, password, sml_version)
+        @codepage = codepage
+        @client_id = client_id
+        @request_file_id = request_file_id
+        @server_id = server_id
+        @username = username
+        @password = password
+        @sml_version = sml_version
+      end
+
+      def self.construct(array_rep)
+        return nil if array_rep.nil?
+        codepage = array_rep.shift
+        client_id = array_rep.shift
+        request_file_id = array_rep.shift
+        server_id = array_rep.shift
+        username = array_rep.shift
+        password = array_rep.shift
+        sml_version = array_rep.shift
+        array_rep.shift unless sml_version.nil?
+
+        return SML::PublicOpen::Request.new(codepage, client_id, request_file_id, server_id, username, password, sml_version)
+      end
+
+      def self.pconstruct(o={})
+        return SML::PublicOpen::Request.new(o[:codepage], o[:client_id], o[:request_file_id], o[:server_id], o[:username], o[:password], o[:sml_version])
+      end
+
+      def to_a
+        result = [] << codepage << client_id << request_file_id << server_id << username << password << sml_version
+        result << :uint8 unless sml_version.nil?
+        return result
+      end
+      
+    end
+
+    class Response
+      attr_accessor :codepage, :client_id, :request_file_id, :server_id, :reference_time, :sml_version
+
+      def initialize(codepage, client_id, request_file_id, server_id, reference_time, sml_version)
+        @codepage = codepage
+        @client_id = client_id
+        @request_file_id = request_file_id
+        @server_id = server_id
+        @reference_time = reference_time
+        @sml_version = sml_version
+      end
+
+      def self.construct(array_rep)
+        return nil if array_rep.nil?
+        codepage = array_rep.shift
+        client_id = array_rep.shift
+        request_file_id = array_rep.shift
+        server_id = array_rep.shift
+        reference_time = SML::Time.construct(array_rep.shift)
+        sml_version = array_rep.shift
+        array_rep.shift unless sml_version.nil?
+
+        return SML::PublicOpen::Response.new(codepage, client_id, request_file_id, server_id, reference_time, sml_version)
+      end
+
+      def self.pconstruct(o={})
+        return SML::PublicOpen::Response.new(o[:codepage], o[:client_id], o[:request_file_id], o[:server_id], o[:reference_time], o[:sml_version])
+      end
+
+      def to_a
+        result = [] << codepage << client_id << request_file_id << server_id << reference_time.to_a << sml_version
+        result << :uint8 unless sml_version.nil?
+        return result
+      end
+
+    end
+
+  end
+end

data/lib/ruby-sml/sml-setprocparameter.rb

@@ -0,0 +1,37 @@
+require 'ruby-sml/nilclass-mixin'
+require 'ruby-sml/sml-treepath'
+require 'ruby-sml/sml-tree'
+
+module SML
+  module SetProcParameter
+    
+    class Request
+      attr_accessor :server_id, :username, :password, :parameter_treepath, :parameter_tree
+      
+      def initialize(server_id, username, password, parameter_treepath, parameter_tree)
+        @server_id = server_id
+        @username = username
+        @password = password
+        @parameter_treepath = parameter_treepath
+        @parameter_tree = parameter_tree
+      end
+
+      def self.construct(array_rep)
+        return nil if array_rep.nil?
+        server_id = array_rep.shift
+        username = array_rep.shift
+        password = array_rep.shift
+        parameter_treepath = SML::Treepath.construct(array_rep.shift)
+        parameter_tree = SML::Tree.construct(array_rep.shift)
+
+        return nil if (parameter_treepath.nil? or parameter_tree.nil?)
+        return SML::SetProcParameter::Request.new(server_id, username, password, parameter_treepath, parameter_tree)
+      end
+      def to_a
+        return [] << server_id << username << password << parameter_treepath.to_a << parameter_tree.to_a
+      end
+
+    end
+    
+  end
+end

data/lib/ruby-sml/sml-time.rb

@@ -0,0 +1,46 @@
+require 'ruby-sml/nilclass-mixin'
+
+module SML
+
+  class Time
+    attr_accessor :type, :value
+
+    def initialize(type, value)
+      @type = type
+      @value = value
+    end
+
+    def self.construct(array_rep)
+      return nil if array_rep.nil?
+      choice = array_rep.shift
+      array_rep.shift unless choice.nil?
+      type = case choice
+             when 0x01
+               :seconds_index
+             when 0x02
+               :timestamp
+             end
+      value = array_rep.shift
+      array_rep.shift unless value.nil?
+
+      return SML::Time.new(type, value)
+    end
+
+    def self.pconstruct(o={})
+      return SML::Time.new(o[:type], o[:value])
+    end
+
+    def to_a
+      choice = case type
+               when :seconds_index
+                 0x01
+               when :timestamp
+                 0x02
+               end
+
+      return [] << choice << :uint8 << value << :uint32
+    end
+
+  end
+
+end

data/lib/ruby-sml/sml-tree.rb

@@ -0,0 +1,42 @@
+require 'ruby-sml/nilclass-mixin'
+require 'ruby-sml/sml-procparametervalue'
+
+module SML
+
+  class Tree
+    attr_accessor :parameter_name, :parameter_value, :child_list
+
+    def initialize(parameter_name, parameter_value, child_list)
+      @parameter_name = parameter_name
+      @parameter_value = parameter_value
+      @child_list = child_list
+    end
+
+    def self.construct(array_rep)
+      return nil if array_rep.nil?
+      parameter_name = array_rep.shift
+      parameter_value = SML::ProcParameterValue.construct(array_rep.shift)
+      child_list = []
+      child_list_array_rep = array_rep.shift
+      unless child_list_array_rep.nil?
+        child_list_array_rep.each do |entry_array_rep|
+          entry = SML::Tree.construct(entry_array_rep)
+          return nil if entry.nil?
+          child_list << entry
+        end
+      end
+
+      return SML::Tree.new(parameter_name, parameter_value, child_list)
+    end
+    def to_a
+      child_list_array = []
+      child_list.each do |entry|
+        child_list_array << entry.to_a
+      end
+
+      return [] << parameter_name << SML::ProcParameterValue.to_a(parameter_value) << child_list_array
+    end
+
+  end
+
+end

data/lib/ruby-sml/sml-treepath.rb

@@ -0,0 +1,24 @@
+require 'ruby-sml/nilclass-mixin'
+
+module SML
+
+  class Treepath
+    attr_accessor :path_entry
+
+    def initialize(path_entry)
+      @path_entry = path_entry
+    end
+
+    def self.construct(array_rep)
+      return nil if array_rep.nil?
+      path_entry = array_rep.shift
+      
+      return SML::Treepath.new(path_entry)
+    end
+    def to_a
+      return [] << path_entry
+    end
+
+  end
+
+end

data/lib/ruby-sml/sml-tupelentry.rb

@@ -0,0 +1,105 @@
+require 'ruby-sml/nilclass-mixin'
+require 'ruby-sml/sml-time'
+
+module SML
+
+  class TupelEntry
+    attr_accessor :server_id, :seconds_index, :status, :unit_pa, :scaler_pa, :value_pa, :unit_r1, :scaler_r1, :value_r1, :unit_r4, :scaler_r4, :value_r4, :signature_pa_r1_r4, :unit_ma, :scaler_ma, :value_ma, :unit_r2, :scaler_r2, :value_r2, :unit_r3, :scaler_r3, :value_r3, :signature_ma_r2_r3
+
+    def initialize(server_id, seconds_index, status, unit_pa, scaler_pa, value_pa, unit_r1, scaler_r1, value_r1, unit_r4, scaler_r4, value_r4, signature_pa_r1_r4, unit_ma, scaler_ma, value_ma, unit_r2, scaler_r2, value_r2, unit_r3, scaler_r3, value_r3, signature_ma_r2_r3)
+      @server_id = server_id
+      @seconds_index = seconds_index
+      @status = status
+
+      @unit_pa = unit_pa
+      @scaler_pa = scaler_pa
+      @value_pa = value_pa
+
+      @unit_r1 = unit_r1
+      @scaler_r1 = scaler_r1
+      @value_r1 = value_r1
+
+      @unit_r4 = unit_r4
+      @scaler_r4 = scaler_r4
+      @value_r4 = value_r4
+
+      @signature_pa_r1_r4 = signature_pa_r1_r4
+
+      @unit_ma = unit_ma
+      @scaler_ma = scaler_ma
+      @value_ma = value_ma
+      
+      @unit_r2 = unit_r2
+      @scaler_r2 = scaler_r2
+      @value_r2 = value_r2
+      
+      @unit_r3 = unit_r3
+      @scaler_r3 = scaler_r3
+      @value_r3 = value_r3
+
+      @signature_ma_r2_r3 = signature_ma_r2_r3
+    end
+
+    def self.construct(array_rep)
+      return nil if array_rep.nil?
+      server_id = array_rep.shift
+      seconds_index = SML::Time.construct(array_rep.shift)
+      status = array_rep.shift
+      array_rep.shift
+
+      unit_pa = array_rep.shift
+      array_rep.shift
+      scaler_pa = array_rep.shift
+      array_rep.shift
+      value_pa = array_rep.shift
+      array_rep.shift
+
+      unit_r1 = array_rep.shift
+      array_rep.shift
+      scaler_r1 = array_rep.shift
+      array_rep.shift
+      value_r1 = array_rep.shift
+      array_rep.shift
+
+      unit_r4 = array_rep.shift
+      array_rep.shift
+      scaler_r4 = array_rep.shift
+      array_rep.shift
+      value_r4 = array_rep.shift
+      array_rep.shift
+
+      signature_pa_r1_r4 = array_rep.shift
+
+      unit_ma = array_rep.shift
+      array_rep.shift
+      scaler_ma = array_rep.shift
+      array_rep.shift
+      value_ma = array_rep.shift
+      array_rep.shift
+      
+      unit_r2 = array_rep.shift
+      array_rep.shift
+      scaler_r2 = array_rep.shift
+      array_rep.shift
+      value_r2 = array_rep.shift
+      array_rep.shift
+      
+      unit_r3 = array_rep.shift
+      array_rep.shift
+      scaler_r3 = array_rep.shift
+      array_rep.shift
+      value_r3 = array_rep.shift
+      array_rep.shift
+
+      signature_ma_r2_r3 = array_rep.shift
+
+      return nil if seconds_index.nil?
+      return SML::TupelEntry.new(server_id, seconds_index, status, unit_pa, scaler_pa, value_pa, unit_r1, scaler_r1, value_r1, unit_r4, scaler_r4, value_r4, signature_pa_r1_r4, unit_ma, scaler_ma, value_ma, unit_r2, scaler_r2, value_r2, unit_r3, scaler_r3, value_r3, signature_ma_r2_r3)
+    end
+    def to_a
+      return [] << server_id << seconds_index.to_a << status << :uint64 << unit_pa << :uint8 << scaler_pa << :int8 << value_pa << :int64 << unit_r1 << :uint8 << scaler_r1 << :int8 << value_r1 << :int64 << unit_r4 << :uint8 << scaler_r4 << :int8 << value_r4 << :int64 << signature_pa_r1_r4 << unit_ma << :uint8 << scaler_ma << :int8 << value_ma << :int64 << unit_r2 << :uint8 << scaler_r2 << :int8 << value_r2 << :int64 << unit_r3 << :uint8 << scaler_r3 << :int8 << value_r3 << :int64 << signature_ma_r2_r3
+    end
+
+  end
+
+end

data/lib/ruby-sml/sml-valueentry.rb

@@ -0,0 +1,29 @@
+require 'ruby-sml/nilclass-mixin'
+
+module SML
+  
+  class ValueEntry
+    attr_accessor :value, :value_type, :signature
+    
+    def initialize(value, value_type, signature)
+      @value = value
+      @value_type = value_type
+      @signature = signature
+    end
+
+    def self.construct(array_rep)
+      return nil if array_rep.nil?
+      value = array_rep.shift
+      value_type = array_rep.shift
+      signature = array_rep.shift
+
+      return nil if value.nil?
+      return SML::ValueEntry.new(value, value_type, signature)
+    end
+    def to_a
+      return [] << value << value_type << signature
+    end
+
+  end
+
+end

data/lib/ruby-sml/transport-binary.rb

@@ -0,0 +1,158 @@
+require 'ruby-sml/crc16'
+
+require 'stringio'
+
+module SML
+
+  class BinaryTransport
+
+    def self.readfile(io)
+      file = String.new
+      received_checksum_bytes = String.new
+      raw = String.new
+      
+      while not io.eof?
+        bytes_raw = io.read(4)
+        raw << bytes_raw
+        bytes = bytes_raw.unpack('N')[0]
+        if bytes == 0x1b1b1b1b
+          escape = []
+          4.times do
+            byte = io.read(1)
+            raw << byte
+            escape.push(byte.unpack('C')[0])
+          end
+          escape_return, padding_length = handle_escape(escape)
+          case escape_return
+          when 1
+            4.times do
+              file << [0x1b].pack('C')
+            end
+          when String
+            received_checksum_bytes = escape_return
+            break
+          end
+        else
+          file << [bytes].pack('N')
+        end
+      end
+
+      # calculate CRC16 over all received bytes (except last 2 - they contain the checksum itself)
+      raw.chop!.chop!
+      calculated_checksum = CRC16.crc16(raw)
+      calculated_checksum = (calculated_checksum ^ 0xffff)
+      calculated_checksum = ((calculated_checksum & 0xff00) >> 8) | ((calculated_checksum & 0x00ff) << 8)
+      # unpack the checksum we received
+      received_checksum = received_checksum_bytes.unpack('n')[0]
+
+      return nil unless calculated_checksum == received_checksum
+      return file[0..-(padding_length+1)]
+    end
+    def self.readstring(data)
+      io = StringIO.new(data)
+      end_of_transmission_found = false
+      file = String.new
+      received_checksum_bytes = String.new
+      raw = String.new
+      
+      while not io.eof?
+        bytes_raw = io.read(4)
+        raw << bytes_raw
+        bytes = bytes_raw.unpack('N')[0]
+        if bytes == 0x1b1b1b1b
+          escape = []
+          4.times do
+            byte = io.read(1)
+            raw << byte
+            escape.push(byte.unpack('C')[0])
+          end
+          escape_return, padding_length = handle_escape(escape)
+          case escape_return
+          when 1
+            4.times do
+              file << [0x1b].pack('C')
+            end
+          when String
+            received_checksum_bytes = escape_return
+            end_of_transmission_found = true
+            break
+          end
+        else
+          file << [bytes].pack('N')
+        end
+      end
+
+      return [nil, nil, data] unless end_of_transmission_found
+
+      # calculate CRC16 over all received bytes (except last 2 - they contain the checksum itself)
+      raw.chop!.chop!
+      calculated_checksum = CRC16.crc16(raw)
+      calculated_checksum = (calculated_checksum ^ 0xffff)
+      calculated_checksum = ((calculated_checksum & 0xff00) >> 8) | ((calculated_checksum & 0x00ff) << 8)
+      # unpack the checksum we received
+      received_checksum = received_checksum_bytes.unpack('n')[0]
+
+      return [nil, false, data[io.pos..-1]] unless calculated_checksum == received_checksum
+      return [file[0..-(padding_length+1)], true, data[io.pos..-1]]
+    end
+    def self.writefile(io, file)
+      source = String.new(file)
+      result = String.new
+
+      # add transport begin header
+      result << [0x1b1b1b1b, 0x01010101].pack('NN')
+
+      while not source.empty?
+        value = source.unpack('N')[0]
+        if value == 0x1b1b1b1b
+          result << [0x1b1b1b1b].pack('N')
+          result << source.slice!(0,4)
+        else
+          result << source.slice!(0,1)
+        end
+      end
+
+      # calculate padding length
+      padding_length = (4-(file.length % 4)) % 4
+
+      # add padding
+      padding_length.times do
+        result << 0x00
+      end
+      # add transmission end header
+      result << [0x1b1b1b1b, 0x1a, padding_length].pack('NCC')
+
+      # calculate checksum
+      checksum = CRC16.crc16(result)
+      checksum = (checksum ^ 0xffff)
+      result << [(checksum & 0x00ff), ((checksum >> 8) & 0x00ff)].pack('CC')
+
+      io << result
+    end
+
+    def self.handle_escape(bytes)
+#      print "escape sequence: "
+      if bytes[0] == 0x01 and bytes[1] == 0x01 and bytes[2] == 0x01 and bytes[3] == 0x01
+#        puts "data transmission v1"
+      elsif bytes[0] == 0x1a
+#        puts "end of data transmission (padding: #{bytes[1]}, checksum: 0x#{bytes[2].to_s(16)}#{bytes[3].to_s(16)})"
+        return "" << bytes[2] << bytes[3], bytes[1]
+      elsif bytes[0] == 0x02
+#        puts "data transmission v2"
+      elsif bytes[0] == 0x03
+#        puts "v2 set timeout"
+      elsif bytes[0] == 0x04
+#        puts "v2 set block size"
+      elsif bytes[0] == 0x1b and bytes[1] == 0x1b and bytes[2] == 0x1b and bytes[3] == 0x1b
+#        puts "literal escape :("
+        return 1, 0
+      else
+#        print "unknown ["
+#        print "0x%08x" % escape
+#        puts "]"
+      end
+      return 0, 0
+    end
+  end
+
+end