Giter Club home page Giter Club logo

escpos's Introduction

Escpos

A ruby implementation of ESC/POS (thermal) printer command specification.

Installation

Add this line to your application's Gemfile:

gem 'escpos'

# see https://github.com/escpos/escpos-image
gem 'escpos-image' # add this if you want to print PNG images

And then execute:

$ bundle

Or install it yourself as:

$ gem install escpos

Examples

Usage

@printer = Escpos::Printer.new
@printer.write "Some text"

@printer.to_escpos # returns ESC/POS data ready to be sent to printer
# on linux this can be piped directly to /dev/usb/lp0
# with network printer sent directly to printer socket
# with serial port printer it can be sent directly to the serial port

@printer.to_base64 # returns base64 encoded ESC/POS data

# using report class

# my_report.rb:
class MyReport < Escpos::Report
  def item(text)
    @count ||= 0
    @count += 1
    quad_text "#{@count}. #{text}"
  end
end
<% # my_report.erb: %>
<%= item "First item" %>
<%= item "Second item" %>
<%= item "Third item" %>
# usage:

report = MyReport.new 'path/to/my_report.erb'
@printer.write report.render
@printer.cut!
# @printer.to_escpos or @printer.to_base64 contains resulting ESC/POS data

Available helper methods

  • text: Normal text formatting
  • encode: Encode text for the printer
  • encoding, set_encoding, set_printer_encoding: Set printer encoding
  • double_height: Double height text
  • quad_text, big, title, header, double_width_double_height, double_height_double_width: Double width & Double height text
  • double_width: Double width text
  • underline, u: Underlined text
  • underline2, u2: Stronger underlined text
  • bold, b: Bold text
  • left: Align to left
  • right: Align to right
  • center: Align to center
  • invert, inverted: Color inverted text
  • black, default_color, color_black, black_color: Default Color (Usually black)
  • red, alt_color, alternative_color, color_red, red_color: Alternative Color (Usually Red)
  • barcode: Print barcode
  • partial_cut: Partially cut the paper (may not be available on all devices)
  • cut: Fully cut the paper (may not be available on all devices)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/escpos/escpos.

  1. Fork it ( https://github.com/escpos/escpos/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

escpos's People

Contributors

svoboda-jan avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.