extface 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe76bc059c789a5646a9da7fc5b40a4a56c6e67
-  data.tar.gz: 2cfadeb3180e60562574111190856e8e6a0e49d1
+  metadata.gz: cd1126c53dc93e2a74c7924b5f1d539a41a7c127
+  data.tar.gz: d9426f418c1464e4745f970d75f8b008fb3f1793
 SHA512:
-  metadata.gz: 1fe34ae4dfccfe58dec45ab0c3a6194650fe01b446e32bf66ee6c7c7331957c35122065c27740685ca003c22dbb8d4220c8c97f911651b93ca81aab2a87a6809
-  data.tar.gz: e7ecc09793575cc0f6ca1a121d8d2e0a3bc42b441ca78e05d96f0849726e078d938051298ffd5dec5929e4ecb8d70915ac3d0ed3a1c599c26fa9ca811384163f
+  metadata.gz: 09b1d1f4967722d9af90f14f6c892d769f788b7d1584c385d9ed0336f78bbdc4178127feded977132b7638d1d31c083104aecef5f31d614d57b4f2649081c77a
+  data.tar.gz: 0b353b388d3788f067cc2dd25467f6f3216de1274e8a0452982f22a658b410e9d1b9e105887d3885886042bb3a9f1a7b91b9ea54bae71b86ac0c4c38461d800a

data/app/models/extface/driver/datecs/dp25.rb

@@ -0,0 +1,352 @@
+module Extface
+  class Driver::Datecs::Dp25 < Extface::Driver::Base::Fiscal
+    NAME = 'Datecs DP25'.freeze
+    
+    RESPONSE_TIMEOUT = 3  #seconds
+    INVALID_FRAME_RETRIES = 6  #count (bad length, bad checksum)
+    ACKS_MAX_WAIT = 60 #count / nothing is forever
+    NAKS_MAX_COUNT = 3 #count
+    BAD_SEQ_MAX_COUNT = 3
+    NO_RESP_MAX_COUNT = 3
+    
+    TAX_GROUPS_MAP = {
+      1 => "\xc0",
+      2 => "\xc1",
+      3 => "\xc2",
+      4 => "\xc3",
+      5 => "\xc4",
+      6 => "\xc5",
+      7 => "\xc6",
+      8 => "\xc7"
+    }
+    
+    PAYMENT_TYPE_MAP = {
+      1 => "P",
+      2 => "N",
+      3 => "C",
+      4 => "D",
+      5 => "B"
+    }
+
+    include Extface::Driver::Datecs::CommandsV1
+
+    def handle(buffer)
+      #if i = buffer.index(/[\x03\x16\x15]/)   # find position of frame possible delimiter
+      if i = buffer.index("\x03") || buffer.index("\x16") || buffer.index("\x15")
+        rpush buffer[0..i]                    # this will make data available for #pull(timeout) method
+        return i+1                            # return number of bytes processed
+      end
+    end
+    
+    #tests
+    def non_fiscal_test
+      device.session("Non Fiscal Text") do |s|
+        s.notify "Printing Non Fiscal Text"
+        s.open_non_fiscal_doc
+        s.print "********************************"
+        s.print "Extface Print Test".center(32)
+        s.print "********************************"
+        s.fsend Printer::PAPER_MOVE, "1"
+        s.print "Driver: " + "#{self.class::NAME}".truncate(24)
+        s.close_non_fiscal_doc
+        s.notify "Printing finished"
+      end
+    end
+    
+    def fiscal_test
+      sale_and_pay_items_session([
+        SaleItem.new( price: 0.01, text1: "Extface Test" )
+      ])
+    end
+    
+    #reports
+    def z_report_session
+      device.session("Z Report") do |s|
+        s.notify "Z Report Start"
+        s.fsend Closure::DAY_FIN_REPORT, "0"
+        s.notify "Z Report End"
+      end
+    end
+    
+    def x_report_session
+      device.session("X Report") do |s|
+        s.notify "X Report Start"
+        s.fsend Closure::DAY_FIN_REPORT, "2"
+        s.notify "X Report End"
+      end
+    end
+    
+    def period_report_session(from, to, detailed = true)
+      device.session("Period Report #{ '(detailed)' if detailed }") do |s|
+        s.notify "Period Report Start #{ '(detailed)' if detailed }"
+        s.fsend detailed ? Reports::REPORT_FP_BY_DATE : Reports::COMPACT_REPORT_FP_BY_DATE, "#{from.strftime('%d%m%y')},#{to.strftime('%d%m%y')}"
+        s.notify "Period Report End"
+      end
+    end
+    
+    #print
+    def open_non_fiscal_doc
+      fsend Sales::START_NON_FISCAL_DOC
+      @print_session = true
+    end
+    
+    def print(text) #up to 38 sybols, TODO check
+      raise "Not in print session" unless @print_session
+      fsend Sales::PRINT_NON_FISCAL_TEXT, text
+    end
+    
+    def close_non_fiscal_doc
+      fsend Sales::END_NON_FISCAL_DOC
+      @print_session = false
+    end
+    
+    def check_status
+      flush #clear receive buffer
+      fsend(Info::GET_STATUS, 'X') # get 6 bytes status
+      errors.empty?
+    end
+    
+    #fiscal
+    def open_fiscal_doc(operator = "1", password = "1")
+      fsend Sales::START_FISCAL_DOC, "#{operator.presence || "1"},#{password.presence || "1"},1"
+      @fiscal_session = true
+    end
+    
+    def close_fiscal_doc
+      raise "Not in fiscal session" unless @fiscal_session
+      fsend Sales::END_FISCAL_DOC
+      @fiscal_session = false
+    end
+    
+    def add_sale(sale_item)
+      raise "Not in fiscal session" unless @fiscal_session
+      fsend Sales::SALE_AND_SHOW, build_sale_data(sale_item)
+    end
+    
+    def add_comment(text)
+      raise "Not in fiscal session" unless @fiscal_session
+    end
+    
+    def add_payment(value = nil, type_num = nil)
+      raise "Not in fiscal session" unless @fiscal_session
+      payment_data = "".tap() do |data|
+                            data << "\t"
+                            data << PAYMENT_TYPE_MAP[type_num || 1]
+                            data << ("%.2f" % value) unless value.blank?
+                          end
+      fsend(Sales::TOTAL, payment_data)
+    end
+    
+    def total_payment
+      raise "Not in fiscal session" unless @fiscal_session
+      fsend(Sales::TOTAL, "\t")
+    end
+    
+    #basket
+    def sale_and_pay_items_session(items = [], operator = "1", password = "1")
+      device.session("Fiscal Doc") do |s|
+        s.notify "Fiscal Doc Start"
+        s.open_fiscal_doc
+        s.notify "Register Sale"
+        items.each do |item|
+          s.add_sale(item)
+        end
+        s.notify "Register Payment"
+        s.total_payment
+        s.notify "Close Fiscal Receipt"
+        s.close_fiscal_doc
+        s.notify "Fiscal Doc End"
+      end
+    end
+    
+    def cancel_doc_session
+      device.session("Doc cancel") do |s|
+        s.notify "Doc Cancel Start"
+        s.fsend Sales::CANCEL_FISCAL_DOC
+        s.paper_cut
+        s.notify "Doc Cancel End"
+      end
+    end
+    
+    #common
+    def fsend(cmd, data = "") #return data or nil
+      packet_data = build_packet(cmd, data) #store packet to be able to re-transmit it with the same sequence number
+      result = false
+      invalid_frames = 0 #counter for bad responses
+      nak_messages = 0 #counter for rejected packets (should re-transmit the packet)
+      no_resp = 0
+      flush #prevent double packet response issue like daisy driver
+      push packet_data #send packet
+      ACKS_MAX_WAIT.times do |retries|
+        errors.clear
+        if resp = frecv(RESPONSE_TIMEOUT)
+          if resp.valid?
+            human_status_errors(resp.status)
+            if errors.empty?
+              result = resp.data
+              break
+            else
+              raise errors.full_messages.join(',')
+            end
+          else #ack, nak or bad
+            if resp.nak?
+              nak_messages += 1
+              if nak_messages > NAKS_MAX_COUNT
+                errors.add :base, "#{NAKS_MAX_COUNT} NAKs Received. Abort!"
+                break
+              end
+            elsif !resp.ack?
+              invalid_frames += 1
+              if invalid_frames > INVALID_FRAME_RETRIES
+                errors.add :base, "#{INVALID_FRAME_RETRIES} Broken Packets Received. Abort!"
+                break
+              end
+            end
+            push packet_data unless resp.ack?
+          end
+        else
+          no_resp += 1
+          if no_resp > NO_RESP_MAX_COUNT
+            p "No reply in #{NO_RESP_MAX_COUNT * RESPONSE_TIMEOUT} seconds. Abort!"
+            errors.add :base, "No reply in #{NO_RESP_MAX_COUNT * RESPONSE_TIMEOUT} seconds. Abort!"
+            return result
+          end
+        end
+        errors.add :base, "#{ACKS_MAX_WAIT} ACKs Received. Abort!"
+      end
+      return result
+    end
+    
+    def frecv(timeout) # return Frame or nil
+      rframe = nil
+      BAD_SEQ_MAX_COUNT.times do
+        errors.clear
+        if frame_bytes = pull(timeout)
+          rframe = Frame.new(frame_bytes.b)
+          if rframe.seq.nil? || rframe.seq.ord == sequence_number(false) #accept only current sequence number as reply
+            break
+          else
+            errors.add :base, "Sequence mismatch"
+            p "Invalid sequence (expected: #{sequence_number(false).to_s(16)}, got: #{rframe.seq.ord.to_s(16)})"
+            rframe = nil #invalidate mismatch sequence frame for the last retry
+          end
+        else
+          errors.add :base, "No data received from device"
+          break
+        end
+      end
+      return rframe
+    end
+    
+    def build_packet(cmd, data = "")
+      "".b.tap() do |packet|
+        packet << STX                     #Preamble. 1 byte long. Value: 01H.
+        packet << 0x20 + 4 + data.b.length  #Number of bytes from <01> preamble (excluded) to <05> (included) plus the fixed offset of 20H
+        packet << sequence_number         #Sequence number of the frame. Length : 1 byte. Value: 20H – FFH.
+        packet << cmd                     #Length: 1 byte. Value: 20H - 7FH.
+        packet << data.b                  #Length: 0 - 218 bytes for Host to printer
+        packet << PA1                     #Post-amble. Length: 1 byte. Value: 05H.
+        packet << Frame.bcc(packet[1..-1])#Control sum (0000H-FFFFH). Length: 4 bytes. Value of each byte: 30H-3FH
+        packet << ETX                     #Terminator. Length: 1 byte. Value: 03H.
+      end
+    end
+    
+    def paper_cut
+      device.session('Paper Cut') do |s|
+        s.push build_packet(Printer::PAPER_CUT)
+      end
+    end
+    
+    def human_status_errors(status) #6 bytes status
+      status_0 = status[0].ord
+      errors.add :base, "Fiscal Device General Error" unless (status_0 & 0x20).zero?
+      errors.add :base, "Invalid Command" unless (status_0 & 0x02).zero?
+      errors.add :base, "Date & Time Not Set" unless (status_0 & 0x04).zero?
+      errors.add :base, "Syntax Error" unless (status_0 & 0x01).zero?
+      status_1 = status[1].ord
+      errors.add :base, "Unpermitted Command In This Mode" unless (status_1 & 0x02).zero?
+      errors.add :base, "Field Overflow" unless (status_1 & 0x01).zero?
+    end
+    
+    private
+      def build_sale_data(item)
+        "".b.tap() do |data|
+          data << item.text1.truncate(30) unless item.text1.blank?
+          data << "\x0a#{text2}" unless item.text2.blank?
+          data << "\t"
+          data << TAX_GROUPS_MAP[item.tax_group || 2]
+          data << ("%.2f" % item.price)
+          data << "*#{item.qty.to_s}" unless item.qty.blank?
+          data << ",#{item.percent}" unless item.percent.blank?
+          data << ",;#{'%.2f' % item.neto}" unless item.neto.blank?
+        end
+      end
+      
+      def sequence_number(increment = true)
+        @seq ||= 0x1f
+        @seq += 1 if increment
+        @seq = 0x1f if @seq == 0x7f
+        @seq
+      end
+      
+      class Frame
+        include ActiveModel::Validations
+        attr_reader :frame, :len, :seq, :cmd, :data, :status, :bcc
+        
+        validates_presence_of :frame#, unless: :unpacked?
+        validate :bcc_validation
+        validate :len_validation
+        
+        def initialize(buffer)
+          if match = buffer.match(/\x01(.{1})(.{1})(.{1})(.*)\x04(.{6})\x05(.{4})\x03/nm)
+            @frame = match.to_a.first
+            @len, @seq, @cmd, @data, @status, @bcc = match.captures
+          else
+            if buffer[/^\x16+$/] # only ACKs
+              @ack = true
+            elsif buffer.index("\x15")
+              @nak = true
+            end
+          end
+        end
+        
+        def ack?; !!@ack; end #should wait, response is yet to come
+        
+        def nak?; !!@nak; end #should retry command with same seq
+        
+        private
+
+          def unpacked? # is it packed or unpacked message?
+            @ack || @nak
+          end
+
+          def bcc_validation
+            unless unpacked? || frame.blank?
+              calc_bcc = self.class.bcc frame[1..-6]
+              errors.add(:bcc, I18n.t('errors.messages.invalid')) if bcc != calc_bcc
+            end
+          end
+          
+          def len_validation
+            unless unpacked? || frame.blank?
+              errors.add(:len, I18n.t('errors.messages.invalid')) if frame.nil? || len.ord != (frame[1..-6].length + 0x20)
+            end
+          end
+        
+          class << self
+            def bcc(buffer)
+              sum = 0
+              buffer.each_byte do |byte|
+                sum += byte
+              end
+              "".tap() do |bcc|
+                4.times do |halfbyte|
+                  bcc.insert 0, (0x30 + ((sum >> (halfbyte*4)) & 0x0f)).chr
+                end
+              end
+            end
+          end
+      end
+
+  end
+end

data/app/models/extface/driver/datecs/fp550.rb

@@ -241,10 +241,10 @@ module Extface
     def build_packet(cmd, data = "")
       "".b.tap() do |packet|
         packet << STX                     #Preamble. 1 byte long. Value: 01H.
-        packet << 0x20 + 4 + data.length  #Number of bytes from <01> preamble (excluded) to <05> (included) plus the fixed offset of 20H
+        packet << 0x20 + 4 + data.b.length  #Number of bytes from <01> preamble (excluded) to <05> (included) plus the fixed offset of 20H
         packet << sequence_number         #Sequence number of the frame. Length : 1 byte. Value: 20H – FFH.
         packet << cmd                     #Length: 1 byte. Value: 20H - 7FH.
-        packet << data                    #Length: 0 - 218 bytes for Host to printer
+        packet << data.b                  #Length: 0 - 218 bytes for Host to printer
         packet << PA1                     #Post-amble. Length: 1 byte. Value: 05H.
         packet << Frame.bcc(packet[1..-1])#Control sum (0000H-FFFFH). Length: 4 bytes. Value of each byte: 30H-3FH
         packet << ETX                     #Terminator. Length: 1 byte. Value: 03H.
@@ -270,8 +270,8 @@ module Extface
     
     private
       def build_sale_data(item)
-        "".tap() do |data|
-          data << item.text1 unless item.text1.blank?
+        "".b.tap() do |data|
+          data << item.text1.truncate(30) unless item.text1.blank?
           data << "\x0a#{text2}" unless item.text2.blank?
           data << "\t"
           data << TAX_GROUPS_MAP[item.tax_group || 2]
@@ -349,4 +349,4 @@ module Extface
       end
 
   end
-end
+end

data/app/views/extface/driver/datecs/dp25/_control.html.erb

@@ -0,0 +1,12 @@
+
+<%= button_to 'Paper Cut', fiscal_device_path(@device), remote: true, name: :paper_cut, value: true, class: 'btn btn-warning'  %>
+
+<%= button_to 'Non Fiscal Test', fiscal_device_path(@device), remote: true, name: :non_fiscal_test, value: true, class: 'btn btn-warning' %>
+
+<%= button_to 'Fiscal Test', fiscal_device_path(@device), remote: true, name: :fiscal_test, value: true, class: 'btn btn-warning' %>
+
+<%= button_to 'X Report', fiscal_device_path(@device), remote: true, name: :x_report, value: true, class: 'btn btn-warning' %>
+<%= button_to 'Z Report', fiscal_device_path(@device), remote: true, name: :z_report, value: true, class: 'btn btn-warning' %>
+
+<%= button_to 'Cancel Fiscal Doc', fiscal_device_path(@device), remote: true, name: :cancel_fiscal_doc, value: true, class: 'btn btn-danger' %>
+

data/lib/extface/version.rb

@@ -1,3 +1,3 @@
 module Extface
-  VERSION = "0.5.9"
+  VERSION = "0.6.0"
 end

data/test/dummy/log/extface/1033518405/aura80.log

@@ -1,61 +1,11 @@
-# Logfile created on 2016-08-30 20:10:05 -0400 by logger.rb/44203
-D, [2016-08-30T20:10:05.445384 #10681] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:10:43.555111 #10749] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:12:21.189809 #10888] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:12:47.637313 #10956] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:13:03.193540 #11002] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:13:04.239676 #11002] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:13:14.243196 #11002] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:13:44.485910 #11097] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:13:47.566834 #11097] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:13:57.568682 #11097] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:14:16.703247 #11185] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:15:06.313416 #11278] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:17:07.375733 #11444] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:17:24.647971 #11493] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:18:37.464329 #11616] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:19:20.679790 #11685] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:21:02.922394 #11869] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:21:32.495893 #11940] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:22:00.172068 #11996] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:22:30.752293 #12059] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:23:11.439869 #12131] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:25:12.466082 #12347] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:25:13.544813 #12347] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:25:36.772943 #12409] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:25:37.826787 #12409] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:26:08.174733 #12492] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:26:09.309872 #12492] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:26:25.326032 #12549] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:26:26.422158 #12549] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:30:26.748199 #12939] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:30:27.768289 #12939] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:30:37.770416 #12939] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:30:47.797936 #12939] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:30:48.838943 #12939] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:31:48.872915 #13113] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:31:49.905292 #13113] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:31:49.912748 #13113] DEBUG -- : --> 1B 69
-D, [2016-08-30T20:31:51.017460 #13113] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:31:52.122170 #13113] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:32:18.631939 #13201] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:32:19.685756 #13201] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:32:19.691691 #13201] DEBUG -- : --> 1B 69
-D, [2016-08-30T20:32:20.805019 #13201] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:32:21.901567 #13201] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:32:58.169297 #13288] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:32:59.194279 #13288] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:32:59.200145 #13288] DEBUG -- : --> 1B 69
-D, [2016-08-30T20:33:00.306228 #13288] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:33:01.409001 #13288] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:33:54.473995 #13365] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:33:55.558490 #13365] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
-D, [2016-08-30T20:33:55.564694 #13365] DEBUG -- : --> 1B 69
-D, [2016-08-30T20:33:57.764655 #13365] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:34:07.768330 #13365] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:34:59.749887 #13488] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:35:09.752793 #13488] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:35:52.810287 #13603] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:36:02.812555 #13603] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:42:42.680478 #14028] DEBUG -- : --> 1D 72 49
-D, [2016-08-30T20:42:52.680945 #14028] DEBUG -- : --> 1D 72 49
+# Logfile created on 2017-03-28 20:49:40 -0400 by logger.rb/44203
+D, [2017-03-28T20:49:40.028578 #9345] DEBUG -- : --> 1D 72 49
+D, [2017-03-28T20:49:41.104858 #9345] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
+D, [2017-03-28T20:49:41.110390 #9345] DEBUG -- : --> 1B 69
+D, [2017-03-28T20:49:42.173477 #9345] DEBUG -- : --> 1D 72 49
+D, [2017-03-28T20:49:43.268342 #9345] DEBUG -- : --> 1D 72 49
+D, [2017-03-28T20:51:06.085122 #9490] DEBUG -- : --> 1D 72 49
+D, [2017-03-28T20:51:07.158484 #9490] DEBUG -- : --> 0D 0A 0D 0A 0D 0A
+D, [2017-03-28T20:51:07.161589 #9490] DEBUG -- : --> 1B 69
+D, [2017-03-28T20:51:08.278707 #9490] DEBUG -- : --> 1D 72 49
+D, [2017-03-28T20:51:09.379386 #9490] DEBUG -- : --> 1D 72 49