escper 1.1.4 → 1.1.5

data/README.md

@@ -0,0 +1,180 @@
+Escper (read: "escaper") -- Easy printing to serial thermal printers
+=======================================================================
+
+Installation
+------------
+
+    gem install escper
+    
+Introduction
+------------
+
+Escper is a collection of essential tools that make printing of plain text and images to one or many serial thermal printers easy. Both USB and serial (RS232) printers are supported and detected automatically. Escper is useful for Ruby based Point of Sale systems that want to print receipts or tickets.
+
+While the actual printing is just writing a string to a device node inside of `/dev`, there is some preprocessing necessary. Thermal printers usually have a narrow character set, do not support UTF-8, only ASCII-8BIT. Escper makes it possible to just send UTF-8 text and it does all the conversion work under the covers. For special characters, Escper will map UTF-8 characters to the ASCII-8BIT codes that are actually supported by the currently set codepage on the printer (have a look at the user manual of your printer). The file `lib/escper/codepages.yml` is an example for matching UTF-8 codes to ASCII codes.
+
+Another tricky usecase is where text is mixed with images. Images are transformed into ESCPOS compatible printing data, which is supported by the majority of thermal printers. When mixing text and images, Escper will transform special UTF-8 characters according to the above mentioned codepages.yml file, but leave the image data unchanged.
+
+Some Point of Sale systems, especially those for restaurants, have to send tickets to several printers at the same time (e.g. kitchen, bar, etc.). Escper makes this easy. Have a look at the usage examples below.
+
+Usecase: Convert image to ESCPOS code
+------------
+
+Load Escper:
+
+    require 'escper'
+    
+The source of the image can be a file:
+
+    escpos_code = Escper::Img.new('/path/to/test.png', :file).to_s
+
+The source of the image can also be data which is uploaded from a HTML form:
+
+    escpos_code = Escper::Img.new(data.read, :blob).to_s
+    
+"Data" is a variable containing the image data of a multipart HTML form.
+    
+Alternatively, the source can be an ImageMagick canvas:
+
+    canvas = Magick::Image.new(512, 128)
+    gc = Magick::Draw.new
+    gc.stroke('black')
+    gc.stroke_width(5)
+    gc.fill('white')
+    gc.fill_opacity(0)
+    gc.stroke_antialias(false)
+    gc.stroke_linejoin('round')
+    gc.translate(-10,-39)
+    gc.scale(1.11,0.68)
+    gc.path("M 14,57 L 14,56 L 15,58 L 13,58 L 14,57 L 21,59 28,60 34,62 40,65 46,67 52,68 56,70 61,72 66,73 70,74 75,74")
+    gc.draw(canvas)
+    escpos_code = Escper::Img.new(canvas,:obj).to_s
+
+For optimal visual results, when using a file or a blob, the image 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. The Escper gem contains a test image in `examples/escper.png`.
+
+To send an image directly to a thermal receipt printer in just one line:
+
+    File.open('/dev/usb/lp0','w') { |f| f.write Escper::Img.new('/path/to/image.png').to_s }
+    
+Usecase: Print UTF-8 text to several serial printers at the same time
+------------
+
+First, create printer objects which are simply containers for data about the printer. If you develop your application in a framework like Rails, you also can use the models from this application instead of creating them from within Escper. The only requirements are that the objects respond to the methods `id`, `name`, `path`, `copies` and `codepage`.
+
+    vp1 = Escper::VendorPrinter.new :id => 1, :name => 'Printer 1 USB', :path => '/dev/usb/lp0', :copies => 1
+    vp2 = Escper::VendorPrinter.new :id => 2, :name => 'Printer 2 USB', :path => '/dev/usb/lp0', :copies => 1
+    vp3 = Escper::VendorPrinter.new :id => 3, :name => 'Printer 3 RS232', :path => '/dev/ttyUSB0', :copies => 1
+    
+`id` must be unique numbers which will be needed later during printing. `name` is an arbitrary string which is only used for logging. `path` is the path to a regular file or the device node of the thermal printer which usually lives under `/dev`. Device nodes can be of the type USB or serial (RS232). `copies` are the number of copies of pages that the printer should print. Optionally, you can pass in the key `codepage` which is a number that must correspond to one of the YAML keys in the file `codepages.yml`. By making the `codepage` a parameter of the printer model, it is possible to use several different printers from different manufacturers with different character sets at the same time.
+
+Next, initialize the printing engine of Escper by passing it an array of the printer objects. It is also possible to pass it a single printer model instead of an array:
+
+    print_engine = Escper::Printer.new 'local', [vp1, vp2, vp3]
+    
+Now, open all device nodes as specified in `new`:
+
+    print_engine.open
+    
+Once all device nodes are openend for writing, you can print text. Text must be UTF-8 encoded. The fist parameter is the `id` of the printer object that should be printed to. The second parameter, the text, will be printed immediately:
+
+    print_engine.print 1, 'print text to printer 1'
+    print_engine.print 2, 'print text to printer 1'
+    print_engine.print 3, 'print text to printer 1'
+    
+The `print` method will return an array which contains the number of bytes actually written to the device node, as well as the raw text that was written to the device node.
+    
+After printing is finished, don't forget to close the device nodes which were openened during the `open` call:
+
+    print_engine.close
+
+    
+Usecase: Print UTF8 text mixed with binary images
+------------
+
+Create a printer object:
+
+    vp1 = Escper::VendorPrinter.new :id => 1, :name => 'Printer 1 USB', :path => '/dev/usb/lp0', :copies => 1
+    
+Render images into ESCPOS, stored in variables:
+
+    image_escpos1 = Escper::Img.new('/path/to/test1.png', :file).to_s
+    image_escpos2 = Escper::Img.new('/path/to/test2.png', :file).to_s
+    
+This raw image data now must be stored in a hash, whith a unique key that gives the image a unique name:
+
+    raw_images = {:image1 => image_escpos1, :image2 => image_escpos2}
+    
+Initialize the print engine:
+
+    print_engine = Escper::Printer.new 'local', vp1
+    
+Open the printer device nodes:
+
+    print_engine.open
+    
+Print text and image at the same time:
+
+    print_engine.print 1, 'print text and image1 {::escper}image1{:/} and image 2 {::escper}image1{:/} to printer 1', raw_images
+    
+Note that the magic tag `{::escper}image_key{:/}` will be replaced by Escper with the image that is stored in the hash `raw_images` with the key `image_key`.
+
+After printing is done, close the device nodes again:
+
+    print_engine.close
+    
+
+Fallback mode
+----------------------
+
+If a device node is busy or not writable, Escper will create fallback files instead and append the print data to that file. The fallback files will have the name of the printers and will be saved inside of `/tmp`, or, when you include Escper from Rails, in the `tmp` folder of the Rails app source.
+
+Configuration
+----------------------
+
+You can configure Escper by calling in your project:
+
+    Escper.setup do |config|
+      config.codepage_file = File.join('path', 'to', 'codepages.yml')
+      config.use_safe_device_path = false
+      config.safe_device_path = File.join('path', 'to', 'outputdir')
+    end
+
+`codepage_file` specifies the path to `codepages.yml`. (for an explanation see above)
+
+`use_safe_device_path` can be set to `true` when you are running Escper on a remote server and no actual writes to device nodes should occur. In this case, all print data will be stored in regular files in the path `safe_device_path` with safe file names, which can be further processed or submitted by other programs.
+    
+Additional Features
+----------------------
+
+For additional features, please study the source code.
+
+
+Contact
+----------------------
+
+Ask for support or additional features!
+
+Red (E) Tools Ltd.
+
+office@red-e.eu
+
+www.red-e.eu
+
+
+Licence
+----------------------
+
+Copyright (C) 2011-2013  Red (E) Tools Ltd. <office@red-e.eu>
+
+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/>.

data/escper.gemspec

@@ -6,16 +6,19 @@ Gem::Specification.new do |s|
   s.name        = "escper"
   s.version     = Escper::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Michael Franzl"]
-  s.email       = ["office@michaelfranzl.com"]
-  s.homepage    = "http://michaelfranzl.com"
-  s.summary     = %q{Converts bitmaps to the ESC/POS receipt printer command}
-  s.description = %q{}
+  s.authors     = ["Red (E) Tools Ltd."]
+  s.email       = ["office@red-e.eu"]
+  s.homepage    = "http://red-e.eu"
+  s.summary     = %q{Collection of essential tools that make printing of plain text and images to one or many serial thermal printers easy.}
+  s.description = %q{Both USB and serial (RS232) printers are supported and detected automatically. Escper is useful for Ruby based Point of Sale systems that want to print receipts or tickets.}
 
-  s.rubyforge_project = "escper"
+  #s.rubyforge_project = "escper"
 
   s.files         = `git ls-files`.split("\n")
   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')
+  s.add_dependency('serialport')
 end

data/lib/escper.rb

@@ -1,4 +1,6 @@
 require 'RMagick'
+require 'yaml'
+#require 'active_record'
 
 dir = File.dirname(__FILE__)
 Dir[File.expand_path("#{dir}/escper/*.rb")].uniq.each do |file|
@@ -6,7 +8,31 @@ Dir[File.expand_path("#{dir}/escper/*.rb")].uniq.each do |file|
 end
 
 module Escper
-  mattr_accessor :codepage_file, :use_safe_device_path, :safe_device_path
+  #mattr_accessor :codepage_file, :use_safe_device_path, :safe_device_path
+  
+  def self.codepage_file
+    @@codepage_file
+  end
+  
+  def self.codepage_file=(codepage_file)
+    @@codepage_file = codepage_file
+  end
+  
+  def self.use_safe_device_path
+    @@use_safe_device_path
+  end
+  
+  def self.use_safe_device_path=(use_safe_device_path)
+    @@use_safe_device_path = use_safe_device_path
+  end
+  
+  def self.safe_device_path
+    @@safe_device_path
+  end
+  
+  def self.safe_device_path=(safe_device_path)
+    @@safe_device_path = safe_device_path
+  end
 
   @@codepage_file = File.join(File.dirname(__FILE__), 'escper', 'codepages.yml')
   @@use_safe_device_path = false

data/lib/escper/log.rb

@@ -0,0 +1,9 @@
+module Escper
+  def self.log(text)
+    if defined?(ActiveRecord)
+      ActiveRecord::Base.logger.info text
+    else
+      puts text
+    end
+  end
+end

data/lib/escper/printer.rb

@@ -2,19 +2,24 @@ 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, subdomain=nil)
+    def initialize(mode='local', vendor_printers=nil, subdomain=nil)
       @mode = mode
       @subdomain = subdomain
       @open_printers = Hash.new
       @codepages_lookup = YAML::load(File.read(Escper.codepage_file))
       @file_mode = 'wb'
-      if vendor_printers.kind_of?(ActiveRecord::Relation) or vendor_printers.kind_of?(Array)
+      if defined?(Rails)
+        @fallback_root_path = Rails.root
+      else
+        @fallback_root_path = '/'
+      end
+      if vendor_printers.kind_of?(Array) or (defined?(ActiveRecord) == true and vendor_printers.kind_of?(ActiveRecord::Relation))
         @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"
+        puts "No VendorPrinters specified. Creating a set of temporary printers with common 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|
@@ -25,8 +30,8 @@ module Escper
 
     def print(printer_id, text, raw_text_insertations={})
       return if @open_printers == {}
-      ActiveRecord::Base.logger.info "[PRINTING]============"
-      ActiveRecord::Base.logger.info "[PRINTING]PRINTING..."
+      Escper.log "[PRINTING]============"
+      Escper.log "[PRINTING]PRINTING..."
       printer = @open_printers[printer_id]
       raise 'Mismatch between open_printers and printer_id' if printer.nil?
 
@@ -34,15 +39,16 @@ module Escper
       codepage ||= 0
       output_text = Printer.merge_texts(text, raw_text_insertations, codepage)
       
-      ActiveRecord::Base.logger.info "[PRINTING]  Printing on #{ printer[:name] } @ #{ printer[:device].inspect }."
+      Escper.log "[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
+        Escper.log "[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
+      Escper.log "[PRINTING]  #{ output_text[0..60] }"
       return bytes_written, output_text
     end
     
@@ -57,8 +63,8 @@ module Escper
     end
 
     def identify(chartest=nil)
-      ActiveRecord::Base.logger.info "[PRINTING]============"
-      ActiveRecord::Base.logger.info "[PRINTING]TESTING Printers..."
+      Escper.log "[PRINTING]============"
+      Escper.log "[PRINTING]TESTING Printers..."
       open
       @open_printers.each do |id, value|
         init = "\e@"
@@ -70,7 +76,7 @@ module Escper
         "#{ value[:name] }\r\n" +
         "#{ value[:device].inspect }"
         
-        ActiveRecord::Base.logger.info "[PRINTING]  Testing #{value[:device].inspect }"
+        Escper.log "[PRINTING]  Testing #{value[:device].inspect }"
         if chartest
           print(id, init + Escper::Asciifier.all_chars + cut)
         else
@@ -82,8 +88,8 @@ module Escper
     end
 
     def open
-      ActiveRecord::Base.logger.info "[PRINTING]============"
-      ActiveRecord::Base.logger.info "[PRINTING]OPEN Printers..."
+      Escper.log "[PRINTING]============"
+      Escper.log "[PRINTING]OPEN Printers..."
       @vendor_printers.size.times do |i|
         p = @vendor_printers[i]
         name = p.name
@@ -96,60 +102,60 @@ module Escper
           @file_mode = 'ab'
         end
 
-        ActiveRecord::Base.logger.info "[PRINTING]  Trying to open #{ name } @ #{ path } ..."
+        Escper.log "[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, :codepage => codepage }
-          ActiveRecord::Base.logger.info "[PRINTING]    Success for SerialPort: #{ printer.inspect }"
+          Escper.log "[PRINTING]    Success for SerialPort: #{ printer.inspect }"
           next
         rescue Exception => e
-          ActiveRecord::Base.logger.info "[PRINTING]    Failed to open as SerialPort: #{ e.inspect }"
+          Escper.log "[PRINTING]    Failed to open as SerialPort: #{ e.inspect }"
         end
 
         begin
           printer = File.open path, @file_mode
           @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer, :codepage => codepage }
-          ActiveRecord::Base.logger.info "[PRINTING]    Success for File: #{ printer.inspect }"
+          Escper.log "[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."
+          Escper.log "[PRINTING]    The File #{ path } is already open."
+          Escper.log "[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 }"
+            Escper.log "[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."
+              Escper.log "[PRINTING]      Reused."
               @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => val[:device], :codepage => codepage }
               break
             end
           end
           unless @open_printers.has_key? p.id
-            path = File.join(Rails.root, 'tmp')
+            path = File.join(@fallback_root_path, 'tmp')
             printer = File.open(File.join(path, "#{ p.id }-#{ name }-fallback-busy.salor"), @file_mode)
             @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer, :codepage => codepage }
-            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."
+            Escper.log "[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
-          path = File.join(Rails.root, 'tmp')
+          path = File.join(@fallback_root_path, 'tmp')
           printer = File.open(File.join(path, "#{ p.id }-#{ name }-fallback-notbusy.salor"), @file_mode)
           @open_printers.merge! pid => { :name => name, :path => path, :copies => p.copies, :device => printer, :codepage => codepage }
-          ActiveRecord::Base.logger.info "[PRINTING]    Failed to open as either SerialPort or USB File and resource is NOT busy. Created #{ printer.inspect } instead."
+          Escper.log "[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..."
+      Escper.log "[PRINTING]============"
+      Escper.log "[PRINTING]CLOSING Printers..."
       @open_printers.each do |key, value|
         begin
           value[:device].close
-          ActiveRecord::Base.logger.info "[PRINTING]  Closing  #{ value[:name] } @ #{ value[:device].inspect }"
+          Escper.log "[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 }"
+          Escper.log "[PRINTING]  Error during closing of #{ value[:device] }: #{ e.inspect }"
         end
       end
     end

data/lib/escper/vendor_printer.rb

@@ -0,0 +1,52 @@
+module Escper
+  class VendorPrinter
+
+    def initialize(attrs)
+      @name = attrs[:name]
+      @path = attrs[:path]
+      @copies = attrs[:copies]
+      @codepage = attrs[:codepage]
+      @id = attrs[:id]
+    end
+    
+    def name
+      @name
+    end
+    
+    def name=(name)
+      @name = name
+    end
+    
+    def path
+      @path
+    end
+    
+    def path=(path)
+      @path = path
+    end
+    
+    def copies
+      @copies
+    end
+    
+    def copies=(copies)
+      @copies = copies
+    end
+    
+    def codepage
+      @codepage
+    end
+    
+    def codepage=(codepage)
+      @codepage = codepage
+    end
+    
+    def id
+      @id
+    end
+    
+    def id=(id)
+      @id = id
+    end
+  end
+end

data/lib/escper/version.rb

@@ -1,3 +1,3 @@
 module Escper
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

metadata

@@ -1,36 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: escper
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
   prerelease: 
 platform: ruby
 authors:
-- Michael Franzl
+- Red (E) Tools Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-29 00:00:00.000000000 Z
-dependencies: []
-description: ''
+date: 2013-03-04 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'
+- !ruby/object:Gem::Dependency
+  name: serialport
+  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'
+description: Both USB and serial (RS232) printers are supported and detected automatically.
+  Escper is useful for Ruby based Point of Sale systems that want to print receipts
+  or tickets.
 email:
-- office@michaelfranzl.com
+- office@red-e.eu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- README.md
 - Rakefile
 - escper.gemspec
+- examples/test.png
 - lib/escper.rb
 - lib/escper/asciifier.rb
 - lib/escper/codepages.yml
 - lib/escper/image.rb
+- lib/escper/log.rb
 - lib/escper/printer.rb
-- lib/escper/test.png
+- lib/escper/vendor_printer.rb
 - lib/escper/version.rb
-homepage: http://michaelfranzl.com
+homepage: http://red-e.eu
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -49,9 +85,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: escper
-rubygems_version: 1.8.11
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Converts bitmaps to the ESC/POS receipt printer command
+summary: Collection of essential tools that make printing of plain text and images
+  to one or many serial thermal printers easy.
 test_files: []

data/README

@@ -1,40 +0,0 @@
-= Escper (read: "escaper") -- Convert an image to ESCPOS commands for thermal receipt printers
-
-== Usage:
-
-    gem install escper
-
-Test it in a Ruby script:
-
-    require 'escper'
-    puts Escper::Image.new('test.png', :file).to_s
-
-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.
-
-
-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').to_s }
-
-== Licence
-
-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/>.