orion6_rep 0.2.6

data/lib/orion6_rep/employee_get.rb

@@ -0,0 +1,112 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/multi_message_command"
+
+module Orion6Rep
+  class EmployeeGet < Command
+    def initialize(first_employee, employees_number, equipment_number, host_address, tcp_port = 3000)
+      raise "employees_number must be from 1 to 11" if employees_number > 12 || employees_number < 1
+      @first_employee = first_employee
+      @employees_number = employees_number
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = (employees_number*RETURNED_RECORD_SIZE)+4+3
+    end
+
+    private
+    GET_EMPLOYEE_COMMAND = 0x86
+    EMPLOYEE_FIELD_SIZE  = 0x1
+    EMPLOYEE_FIELD_QUANTITY = 0x9
+    # TODO: find what is this constant. It's the size of something, perhaps?
+    UNKNOWN_CONSTANT = 0x72
+    RETURNED_RECORD_SIZE = 87
+
+    def get_command
+      GET_EMPLOYEE_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      EMPLOYEE_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      EMPLOYEE_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      def internal_crc_check(data)
+        crc_check(data[3..6])
+      end
+
+      # this data can change:
+      data = [0x02, 0x00, 0x04, 0x98]
+      data << divide_by_256(@first_employee)
+      data << (@first_employee & 255)
+      data << @employees_number
+      data << internal_crc_check(data)
+      data << 0x03
+      data << crc_check(data)
+    end
+
+    def get_data_from_response(payload)
+      # first byte is aways 2... I don't known why...
+      # The next two bytes are probably the record quantity, in big-endian.
+      record_quantity = (payload[1].ord*256 + payload[2].ord)
+
+      # byte #4 it's the beggining of the data:
+      start_offset = 4
+
+      # the end of the data is the size plus the start minus two, since the REP
+      # send the CRC at the end of the data and array starts at zero. The last
+      # two bytes appear to be the end data marker and a useless 3.
+      end_offset = record_quantity + start_offset - crc_size - 1
+
+      raw_data = payload[start_offset..end_offset]
+      slices = slice_raw_data(raw_data)
+
+      data = []
+      slices.each do |slice|
+        # the fields are separated by a comma, and the registration comes with a
+        # extra number at the end, so drop them:
+        registration, name, pis_number = slice.unpack("A20x2A52xA12")
+        data << {:name => name.to_s.strip, :registration => registration, :pis_number => pis_number}
+      end
+      data
+    end
+
+    def slice_raw_data(raw_data)
+      slices = []
+      index = 0
+      while index < raw_data.size
+        slice_start = index
+        slice_end = slice_start + RETURNED_RECORD_SIZE - 1
+        slices << raw_data[slice_start..slice_end]
+        index = slice_end + 1
+      end
+      slices
+    end
+  end
+end

data/lib/orion6_rep/employee_quantity_get.rb

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/multi_message_command"
+
+module Orion6Rep
+  class EmployeeQuantityGet < Command
+    def initialize(equipment_number, host_address, tcp_port = 3000)
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = 9
+    end
+
+    private
+    GET_EMPLOYEE_QUANTITY_COMMAND = 0x86
+    UNKNOWN_CONSTANT = 0x72
+    EMPLOYEE_FIELD_SIZE  = 0x1
+    EMPLOYEE_FIELD_QUANTITY = 0x6
+    RETURNED_RECORD_SIZE = 87
+
+    def get_command
+      GET_EMPLOYEE_QUANTITY_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      EMPLOYEE_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      EMPLOYEE_FIELD_QUANTITY
+    end
+
+    def get_sleep_time
+      1
+    end
+
+    def generate_command_data
+      # this data is probably imutable:
+      data = [0x02, 0x00, 0x01, 0x97, 0x97, 0x03]
+      #      [   2,    0,    1,  151,  151,    3]
+      data << crc_check(data)
+      data
+    end
+
+    def get_data_from_response(payload)
+      # First byte is aways 2... I don't known why...
+      # The next two bytes are probably the record quantity, in big-endian.
+      record_quantity = (payload[1].ord*256 + payload[2].ord)
+
+      # The next three bytes appear to be the employee quantity, in big-endian:
+      raw_data = payload[3..(3+record_quantity)]
+      employee_quantity = (raw_data[0].ord << 16)+(raw_data[1].ord << 8)+ raw_data[2].ord
+
+      # The last three bytes appear to be a CRC XOR for the data, a useless 3
+      # and the XOR CRC for the whole payload
+      employee_quantity
+    end
+  end
+end

data/lib/orion6_rep/employee_set.rb

@@ -0,0 +1,104 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/command"
+
+module Orion6Rep
+  class EmployeeSet < Command
+    def initialize(operation_type, registration, pis_number, name, equipment_number, host_address, tcp_port = 3000)
+      set_operation_type(operation_type)
+      @registration = registration
+      @pis_number = pis_number
+      @name = name
+
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+
+      @reponse_size = 7 # just send the data and receive the ok
+    end
+
+    def set_operation_type(operation_type)
+      case operation_type
+      when :add
+        @operation_type = 0x31
+      when :edit
+        @operation_type = 0x32
+      when :remove
+        @operation_type = 0x33
+      else
+        raise "Unknown employee operation type received: #{operation_type.to_s}"
+      end
+    end
+
+    private
+    SET_EMPLOYEE_COMMAND = 0x86
+    UNKNOWN_CONSTANT = 0x72
+    EMPLOYEE_FIELD_SIZE  = 0x1
+    EMPLOYEE_FIELD_QUANTITY = 0x5E
+
+    def get_command
+      SET_EMPLOYEE_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      EMPLOYEE_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      EMPLOYEE_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      def internal_crc_check(data)
+        # crc check for the employee data:
+        crc_check(data[3..88])
+      end
+
+      # TODO: find out what is the meaning of the data in the array below:
+      data = [0x02, 0x00, 0x59, 0x95]
+
+      data += get_employee_data
+      data << internal_crc_check(data)
+      # unknown
+      data += [0x03]
+      data << crc_check(data)
+    end
+
+    def get_employee_data
+      data = [@operation_type]
+      data += @registration.to_s.rjust(20, "0").unpack("C*")
+      # This is probably the digital check byte; ignore it:
+      data += "0".unpack("C*")
+      data += ",".unpack("C*") # comma separating the fields
+      data += @name.to_s.ljust(52, " ").unpack("C*")
+      data += ",".unpack("C*") # comma separating the fields
+      data += @pis_number.to_s.rjust(12, "0").unpack("C*")
+      data
+    end
+
+    def get_data_from_response(payload)
+      true
+    end
+  end
+end

data/lib/orion6_rep/employer_get.rb

@@ -0,0 +1,84 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/multi_message_command"
+
+module Orion6Rep
+  class EmployerGet < MultiMessageCommand
+    def initialize(equipment_number, host_address, tcp_port = 3000)
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+    end
+
+    private
+    GET_EMPLOYER_COMMAND = 128
+    EMPLOYER_FIELD_SIZE  = 255
+    EMPLOYER_FIELD_QUANTITY = 263
+
+    def get_command
+      @command ||= GET_EMPLOYER_COMMAND
+    end
+
+    def get_field_size
+      EMPLOYER_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      EMPLOYER_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      []
+    end
+
+    def get_expected_response_size
+      first_message_sent? ? 17 : 264
+    end
+
+    # Here is how the data comes from the REP:
+    # 0 - Document type:
+    #   49 ('1'): CNPJ
+    #   50 ('2'): CPF
+    # 1-14 - Document number (in hexadecimal long)
+    # 15-26 - CEI Document (in hexadecimal long)
+    # 27-176 - Company name
+    # 177-261 - Company location
+    def get_data_from_response(payload)
+      hash = {}
+
+      doc_type_code, document_number, cei_document, company_name, company_location = payload.unpack("CA14A12A150A84")
+
+      case doc_type_code
+      when 49
+        hash[:document_type] = :cnpj
+      when 50
+        hash[:document_type] = :cpf
+      else
+        raise "Unknown document type received: #{doc_type_code}"
+      end
+
+      hash[:document_number] = document_number
+      hash[:cei_document] = cei_document
+      hash[:company_name] = company_name.strip
+      hash[:company_location] = company_location.strip
+      hash
+    end
+  end
+end

data/lib/orion6_rep/employer_set.rb

@@ -0,0 +1,90 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/multi_message_command"
+
+module Orion6Rep
+  class EmployerSet < Command
+    def initialize(employer_name, employer_location, document_type, document_number, cei_number, equipment_number, host_address, tcp_port = 3000)
+      @employer_name = employer_name
+      @employer_location = employer_location
+      @document_type = document_type
+      @document_number = document_number
+      @cei_number = cei_number
+
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = 0
+    end
+
+    private
+    SET_EMPLOYER_COMMAND = 143
+    EMPLOYER_FIELD_SIZE  = 1
+    EMPLOYER_FIELD_QUANTITY = 263
+
+    def get_command
+      SET_EMPLOYER_COMMAND
+    end
+
+    def get_field_size
+      EMPLOYER_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      EMPLOYER_FIELD_QUANTITY
+    end
+
+    # Here is how the data goes to the REP:
+    # 0 - 1
+    # 1 - Document type:
+    #   1: CNPJ
+    #   2: CPF
+    # 2-15 - Document number (in hexadecimal long)
+    # 16-27 - CEI Document (in hexadecimal long)
+    # 28-177 - Company name
+    # 178-263 - Company location
+    def generate_command_data
+      data = [1] # TODO: find out why this one is needed.
+
+      # get document type:
+      case @document_type
+      when :cnpj
+        data << 49
+      when :cpf
+        data << 50
+      else
+        raise "Unknown document type received: #{@document_type}"
+      end
+
+      data += @document_number.to_s.rjust(14, "0").unpack("C*")
+      data += @cei_number.to_s.rjust(12, "0").unpack("C*")
+      data += @employer_name.to_s.ljust(150, 0.chr).unpack("C*")
+      data += @employer_location.to_s.ljust(85, 0.chr).unpack("C*")
+      data << crc_check(data)
+
+      data
+    end
+
+    def get_data_from_response(payload)
+      true
+    end
+  end
+end

data/lib/orion6_rep/get_serial_number.rb

@@ -0,0 +1,64 @@
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require "orion6_rep/command"
+
+module Orion6Rep
+  class GetSerialNumber < Command
+    def initialize(equipment_number, host_address, tcp_port = 3000)
+      @equipment_number = equipment_number
+      @host_address = host_address
+      @tcp_port = tcp_port
+      @reponse_size = RETURNED_RECORD_SIZE
+    end
+
+    private
+    GET_SERIAL_NUMBER_COMMAND = 0x97
+    # TODO: find what is this constant. It's the size of something, perhaps?
+    UNKNOWN_CONSTANT = 0x00
+    SERIAL_NUMBER_FIELD_SIZE  = 0x108
+    SERIAL_NUMBER_FIELD_QUANTITY = 0x2a
+    RETURNED_RECORD_SIZE = 9
+
+    def get_command
+      GET_SERIAL_NUMBER_COMMAND
+    end
+
+    def get_unknown_constant
+      UNKNOWN_CONSTANT
+    end
+
+    def get_field_size
+      SERIAL_NUMBER_FIELD_SIZE
+    end
+
+    def get_field_quantity
+      SERIAL_NUMBER_FIELD_QUANTITY
+    end
+
+    def generate_command_data
+      # No data in this command:
+      []
+    end
+
+    def get_data_from_response(payload)
+      convert_to_integer_as_big_endian(payload.unpack("C*")).to_s.rjust(17, "0")
+    end
+  end
+end

data/lib/orion6_rep/interface.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# Adapted from
+# http://blog.frameos.org/2006/12/09/getting-network-interface-addresses-using-ioctl-pure-ruby-2/
+# in 23/02/2011.
+
+require 'socket'
+require 'system/getifaddrs'
+
+module Orion6Rep
+  module Interface
+    # From bits/ioctls.h
+    SIOCGIFHWADDR  = 0x8927 # Get hardware address
+    SIOCGIFADDR    = 0x8915 # Get PA address
+    SIOCGIFBRDADDR = 0x8919 # Get broadcast PA address
+
+    class << self
+      def get_active_interfaces_names
+        System.get_ifaddrs.keys.collect{|iface| iface.to_s}
+      end
+
+      def hw_address(iface)
+        socket = Socket.new(Socket::AF_INET, Socket::SOCK_DGRAM, 0)
+        buf = [iface, ""].pack('a16h16')
+        socket.ioctl(SIOCGIFHWADDR, buf)
+        socket.close
+        to_etheraddr(buf[18..23])
+      end
+
+      def ip_address(iface)
+        socket = UDPSocket.new
+        buf = [iface, ""].pack('a16h16')
+        socket.ioctl(SIOCGIFADDR, buf)
+        socket.close
+        to_ipaddr4(buf[20..23])
+      end
+
+      def broadcast_address(iface)
+        socket = UDPSocket.new
+        buf = [iface, ""].pack('a16h16')
+        socket.ioctl(SIOCGIFBRDADDR, buf)
+        socket.close
+        to_ipaddr4(buf[20..23])
+      end
+
+      private
+      def to_ipaddr4(string)
+        string.unpack("CCCC").join(".")
+      end
+
+      def to_etheraddr(string)
+        string.unpack("H2H2H2H2H2H2").join(":")
+      end
+    end
+  end
+end