escper 1.0.4 → 1.0.5

data/README

@@ -13,22 +13,18 @@ Or if you read the image from an image upload form in Rails, do this:
 
     Escper::Image.new(data.read, :blob).to_s
 
-... where "data" is a variable containing the image data of a multipart HTML form.
-
-Or if you have an Magick::Image already loaded, call it like this:
-
-    Escper::Image.new(magickobject, :object)
+where "data" is a variable containing the image data of a multipart HTML form.
 
 
 For optimal visual results, image.png should previously be converted to an indexed, black and white 1-bit palette image. In Gimp, click on "Image -> Mode -> Indexed..." and select "Use black and white (1-bit) palette". For dithering, choose "Floyd-Steinberg (reduced color bleeding)". The image size depends on the resolution of the printer.
 
 To send an image directly to a thermal receipt printer:
 
-    File.open('/dev/usb/lp0','w') { |f| f.write Escper::Image.new('image.png', :file).to_s }
+    File.open('/dev/usb/lp0','w') { |f| f.write Escper::Image.new('image.png').to_s }
 
 == Licence
 
-Copyright (C) 2011-2012  Michael Franzl <office@michaelfranzl.com>
+Copyright (C) 2011-2012  Michael Franzl <michael@billgastro.com>
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as

data/escper.gemspec

@@ -18,6 +18,4 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
-  s.add_dependency "rmagick"
 end

data/lib/escper.rb

@@ -1,73 +1,16 @@
-# Escper -- Convert an image to ESCPOS commands for thermal printers
-# Copyright (C) 2011-2012  Michael Franzl <michael@billgastro.com>
-# 
-# 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/>.
-
 require 'RMagick'
 
-module Escper
-  class Image
-    def initialize(source, type)
-      if type == :file
-        @image = Magick::Image.read(source).first
-      elsif type == :blob
-        @image = Magick::Image.from_blob(source).first
-      elsif type == :object
-        @image = source
-      end
-      @x = (@image.columns / 8.0).round
-      @y = (@image.rows / 8.0).round
-      @x = 1 if @x.zero?
-      @y = 1 if @y.zero?
-    end
-
-    def convert
-      @image = @image.quantize 2, Magick::GRAYColorspace
-    end
-
-    def crop
-      @image = @image.extent @x * 8, @y * 8
-    end
+dir = File.dirname(__FILE__)
+Dir[File.expand_path("#{dir}/escper/*.rb")].uniq.each do |file|
+  require file
+end
 
-    def to_a
-      @image.export_pixels
-    end
+module Escper
+  mattr_accessor :codepage_file
 
-    def to_s
-      self.convert
-      self.crop
-      colorarray = self.to_a
-      bits = []
-      mask = 0x80
-      i = 0
-      temp = 0
-      (@x * @y * 8 * 3 * 8).times do |j|
-        next unless (j % 3).zero?
-        temp |= mask if colorarray[j] == 0 # put 1 in place if black
-        mask = mask >> 1
-        i += 3
-        if i == 24
-	        bits << temp
-	        mask = 0x80
-	        i = 0
-	        temp = 0
-        end
-      end
-      result = bits.collect{ |b| b.chr }.join
-      escpos = "\x1D\x76\x30\x00#{@x.chr}\x00#{(@y*8).chr}\x00#{ result }"
-      escpos.force_encoding('ISO-8859-15')
-      return escpos
-    end
+  @@codepage_file = File.join(File.dirname(__FILE__), 'escper', 'codepages.yml')
+  
+  def self.setup
+    yield self
   end
 end

data/lib/escper/asciifier.rb

@@ -0,0 +1,42 @@
+module Escper
+  class Asciifier
+    def initialize(codepage)
+      @codepage = codepage
+      @codepage_lookup_yaml = YAML::load(File.read(Escper.codepage_file))
+    end
+    
+    def self.all_chars
+      out = "\e@" # Initialize Printer
+      out.encode!('ascii-8bit')
+      20.upto(255) { |i| out += i.to_s(16) + i.chr + ' ' }
+      out += "\n\n\n\n\n\n" +
+      "\x1D\x56\x00" # paper cut
+      return out
+    end
+    
+    def process(text)
+      output = ''
+      output.encode 'ASCII-8BIT'
+      0.upto(text.length - 1) do |i|
+        char_utf8 = text[i]
+        char_ascii = text[i].force_encoding('ASCII-8BIT')
+        if char_ascii.length == 1
+          output += char_ascii
+        else
+          output += codepage_lookup(char_utf8)
+        end      
+      end
+      return output
+    end
+    
+    def codepage_lookup(char)
+      output = @codepage_lookup_yaml[@codepage][char]
+      if output
+        output = output.chr
+      else
+        output = '?'
+      end
+      return output.force_encoding('ASCII-8BIT')
+    end
+  end
+end

data/lib/escper/codepages.yml

@@ -0,0 +1,26 @@
+---
+# Codepage 0 corresponds to the codepage 0 of Metapace T family of thermal printers
+0:
+  ä: 0x84
+  ü: 0x81
+  ö: 0x94
+  Ä: 0x8E
+  Ü: 0x9A
+  Ö: 0x99
+  é: 0x82
+  è: 0x8A
+  ú: 0xA3
+  ù: 0x97
+  á: 0xA0
+  à: 0x85
+  í: 0xA1
+  ì: 0x8D
+  ó: 0xA2
+  ò: 0x95
+  â: 0x83
+  ê: 0x88
+  î: 0x8C
+  ô: 0x93
+  û: 0x96
+  ñ: 0xA4
+  ß: 0xE1

data/lib/escper/image.rb

@@ -0,0 +1,67 @@
+module Escper
+  class Image
+    def initialize(data, type)
+      if type == :file
+        @image = convert(Magick::Image.read(data).first)
+      elsif type == :blob
+        @image = convert(Magick::Image.from_blob(data).first)
+      end
+    end
+
+    def convert(img=nil)
+      if img.nil? and @image
+        @image = @image.quantize 2, Magick::GRAYColorspace
+        @image = crop(@image)
+        return @image
+      else
+        img = img.quantize 2, Magick::GRAYColorspace
+        img = crop(img)
+        return img
+      end
+    end
+
+    def crop(image)
+      @x = (image.columns / 8.0).round
+      @y = (image.rows / 8.0).round
+      @x = 1 if @x == 0
+      @y = 1 if @y == 0
+      image = image.extent @x * 8, @y * 8
+      return image
+    end
+
+    def to_a
+      colorarray = @image.export_pixels
+      return colorarray
+    end
+
+    def to_s
+      colorarray = self.to_a
+      bits = []
+      mask = 0x80
+      i = 0
+      temp = 0
+      (@x * @y * 8 * 3 * 8).times do |j|
+        next unless (j % 3).zero?
+        temp |= mask if colorarray[j] == 0 # put 1 in place if black
+        mask = mask >> 1 # shift mask
+        i += 3
+        if i == 24
+          bits << temp
+          mask = 0x80
+          i = 0
+          temp = 0
+        end
+      end
+      result = bits.collect{ |b| b.chr }.join
+      escpos = ''
+      escpos.encode! 'ASCII-8BIT'
+      escpos += "\x1D\x76\x30\x00" +
+          @x.chr +
+          "\x00" +
+          (@y*8).chr +
+          "\x00" +
+          result
+      return escpos
+    end
+  end
+end

data/lib/escper/printer.rb

@@ -0,0 +1,158 @@
+module Escper
+  class Printer
+    # mode can be local or sass
+    # vendor_printers can either be a single VendorPrinter object, or an Array of VendorPrinter objects, or an ActiveRecord Relation containing VendorPrinter objects.
+    def initialize(mode, vendor_printers = nil)
+      @mode = mode
+      @open_printers = Hash.new
+      @codepages_lookup = YAML::load(File.read(Escper.codepage_file))
+      if vendor_printers.kind_of?(ActiveRecord::Relation) or vendor_printers.kind_of?(Array)
+        @vendor_printers = vendor_printers
+      elsif vendor_printers.kind_of? VendorPrinter
+        @vendor_printers = [vendor_printers]
+      else
+        # If no available VendorPrinters are initialized, create a set of temporary VendorPrinters with usual device paths.
+        puts "No VendorPrinters specified. Creating a set of temporary printers with usual device paths"
+        paths = ['/dev/ttyUSB0', '/dev/ttyUSB1', '/dev/ttyUSB2', '/dev/usb/lp0', '/dev/usb/lp1', '/dev/usb/lp2', '/dev/salor-hospitality-front', '/dev/salor-hospitality-top', '/dev/salor-hospitality-back-top-left', '/dev/salor-hospitality-back-top-right', '/dev/salor-hospitality-back-bottom-left', '/dev/salor-hospitality-back-bottom-right']
+        @vendor_printers = Array.new
+        paths.size.times do |i|
+          @vendor_printers << VendorPrinter.new(:name => paths[i].gsub(/^.*\//,''), :path => paths[i], :copies => 1, :codepage => 0)
+        end
+      end
+    end
+
+    def print(printer_id, text, raw_text_insertations={})
+      return if @open_printers == {}
+      ActiveRecord::Base.logger.info "[PRINTING]============"
+      ActiveRecord::Base.logger.info "[PRINTING]PRINTING..."
+      printer = @open_printers[printer_id]
+      raise 'Mismatch between open_printers and printer_id' if printer.nil?
+
+      codepage = printer[:codepage]
+      codepage ||= 0
+      output_text = merge_texts(text, raw_text_insertations, codepage)
+      
+      ActiveRecord::Base.logger.info "[PRINTING]  Printing on #{ printer[:name] } @ #{ printer[:device].inspect }."
+      bytes_written = nil
+      printer[:copies].times do |i|
+        # The method .write works both for SerialPort object and File object, so we don't have to distinguish here.
+        bytes_written = @open_printers[printer_id][:device].write output_text
+        ActiveRecord::Base.logger.info "[PRINTING]ERROR: Byte count mismatch: sent #{text.length} written #{bytes_written}" unless output_text.length == bytes_written
+      end
+      # The method .flush works both for SerialPort object and File object, so we don't have to distinguish here. It is not really neccessary, since the close method will theoretically flush also.
+      @open_printers[printer_id][:device].flush
+      return bytes_written, output_text
+    end
+    
+    def merge_texts(text, raw_text_insertations, codepage)
+      asciifier = Escper::Asciifier.new(codepage)
+      asciified_text = asciifier.process(text)
+      raw_text_insertations.each do |key, value|
+        markup = "{::escper}#{key.to_s}{:/}".encode('ASCII-8BIT')
+        asciified_text.gsub!(markup, value)
+      end
+      return asciified_text
+    end
+
+    def identify(chartest=nil)
+      ActiveRecord::Base.logger.info "[PRINTING]============"
+      ActiveRecord::Base.logger.info "[PRINTING]TESTING Printers..."
+      open
+      @open_printers.each do |id, value|
+        init = "\e@"
+        cut = "\n\n\n\n\n\n" + "\x1D\x56\x00"
+        testtext =
+        "\e!\x38" +  # double tall, double wide, bold
+        "#{ I18n.t :printing_test }\r\n" +
+        "\e!\x00" +  # Font A
+        "#{ value[:name] }\r\n" +
+        "#{ value[:device].inspect }"
+        
+        ActiveRecord::Base.logger.info "[PRINTING]  Testing #{value[:device].inspect }"
+        if chartest
+          print(id, init + self.all_chars + cut)
+        else
+          ascifiier = Escper::Asciifier.new(value[:codepage])
+          print(id, init + ascifiier.process(testtext) + cut)
+        end
+      end
+      close
+    end
+
+    def open
+      ActiveRecord::Base.logger.info "[PRINTING]============"
+      ActiveRecord::Base.logger.info "[PRINTING]OPEN Printers..."
+      @vendor_printers.size.times do |i|
+        p = @vendor_printers[i]
+        name = p.name
+        path = p.path
+        if @mode != 'local' and SalorHospitality::Application::SH_DEBIAN_SITEID != 'none'
+          path = File.join('/', 'var', 'lib', 'salor-hospitality', SalorHospitality::Application::SH_DEBIAN_SITEID, 'public', 'uploads', "#{path}.salor")
+        end
+        ActiveRecord::Base.logger.info "[PRINTING]  Trying to open #{ name } @ #{ path } ..."
+        pid = p.id ? p.id : i
+        begin
+          printer = SerialPort.new path, 9600
+          @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer }
+          ActiveRecord::Base.logger.info "[PRINTING]    Success for SerialPort: #{ printer.inspect }"
+          next
+        rescue Exception => e
+          ActiveRecord::Base.logger.info "[PRINTING]    Failed to open as SerialPort: #{ e.inspect }"
+        end
+
+        begin
+          printer = File.open path, 'wb'
+          @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer }
+          ActiveRecord::Base.logger.info "[PRINTING]    Success for File: #{ printer.inspect }"
+          next
+        rescue Errno::EBUSY
+          ActiveRecord::Base.logger.info "[PRINTING]    The File #{ path } is already open."
+          ActiveRecord::Base.logger.info "[PRINTING]      Trying to reuse already opened printers."
+          previously_opened_printers = @open_printers.clone
+          previously_opened_printers.each do |key, val|
+            ActiveRecord::Base.logger.info "[PRINTING]      Trying to reuse already opened File #{ key }: #{ val.inspect }"
+            if val[:path] == p[:path] and val[:device].class == File
+              ActiveRecord::Base.logger.info "[PRINTING]      Reused."
+              @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => val[:device] }
+              break
+            end
+          end
+          unless @open_printers.has_key? p.id
+            if SalorHospitality::Application::SH_DEBIAN_SITEID == 'none'
+              path = File.join(Rails.root, 'tmp')
+            else
+              path = File.join('/', 'var', 'lib', 'salor-hospitality', SalorHospitality::Application::SH_DEBIAN_SITEID)
+            end
+            printer = File.open(File.join(path, "#{ p.id }-#{ name }-fallback-busy.salor"), 'wb')
+            @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer }
+            ActiveRecord::Base.logger.info "[PRINTING]      Failed to open as either SerialPort or USB File and resource IS busy. This should not have happened. Created #{ printer.inspect } instead."
+          end
+          next
+        rescue Exception => e
+          if SalorHospitality::Application::SH_DEBIAN_SITEID == 'none'
+            path = File.join(Rails.root, 'tmp')
+          else
+            path = File.join('/', 'var', 'lib', 'salor-hospitality', SalorHospitality::Application::SH_DEBIAN_SITEID)
+          end
+          printer = File.open(File.join(path, "#{ p.id }-#{ name }-fallback-notbusy.salor"), 'wb')
+          @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer }
+          ActiveRecord::Base.logger.info "[PRINTING]    Failed to open as either SerialPort or USB File and resource is NOT busy. Created #{ printer.inspect } instead."
+        end
+      end
+    end
+
+    def close
+      ActiveRecord::Base.logger.info "[PRINTING]============"
+      ActiveRecord::Base.logger.info "[PRINTING]CLOSING Printers..."
+      @open_printers.each do |key, value|
+        begin
+          value[:device].close
+          ActiveRecord::Base.logger.info "[PRINTING]  Closing  #{ value[:name] } @ #{ value[:device].inspect }"
+          @open_printers.delete(key)
+        rescue Exception => e
+          ActiveRecord::Base.logger.info "[PRINTING]  Error during closing of #{ value[:device] }: #{ e.inspect }"
+        end
+      end
+    end
+  end
+end

data/lib/escper/version.rb

@@ -1,3 +1,3 @@
 module Escper
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: escper
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rmagick
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies: []
 description: ''
 email:
 - office@michaelfranzl.com
@@ -40,6 +24,10 @@ files:
 - Rakefile
 - escper.gemspec
 - lib/escper.rb
+- lib/escper/asciifier.rb
+- lib/escper/codepages.yml
+- lib/escper/image.rb
+- lib/escper/printer.rb
 - lib/escper/test.png
 - lib/escper/version.rb
 homepage: http://michaelfranzl.com
@@ -62,7 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: escper
-rubygems_version: 1.8.24
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Converts bitmaps to the ESC/POS receipt printer command