Skip to content

Ruby gem to convert images to usable & printable ZPL code

License

Notifications You must be signed in to change notification settings

mtking2/img2zpl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

img2zpl

gem downloads

Ruby library to convert images to usable & printable ZPL code

Installation

Add the gem to your Gemfile:

gem 'img2zpl'

And then run bundle install

Or install it yourself with:

gem install img2zpl

Usage

require 'img2zpl'

img = Img2Zpl::Image.open('foo.jpg')
zpl = img.to_zpl #=> "^GFA, ... ^FS"

Using ImageMagick commands

The Img2Zpl::Image class inherits from the MiniMagick::Image class provied by the minimagick gem. So you have the same control when it comes to modifying the image before converting to ZPL.

Example:

img = Img2Zpl::Image.open('foo.png')

img.flatten
img.trim
img.resize '100x100'

zpl = img.to_zpl

Options

When calling the .to_zpl method there a number of optional parameters you can pass to further customize the resulting image:

  • black_threshold: A value between 0 and 1 that sets the darkness threshold which determines how dark a pixel should be in order to become black in the resulting b/w image. Use larger value for a more saturated image and smaller value for a less saturated one. Default: 0.5
  • invert: set to true to invert which pixels are set to black and which are set to white.
  • compress: set to false to not perform the ACSII compression in the resulting ^GF string. For larger images the uncompressed string can become very long, so use caution.

Example:

zpl = img.to_zpl black_threshold: 0.65, invert: true

Contributing

See CONTRIBUTING.md

Copyright

© 2019, Michael King and Contributors.

MIT License, see LICENSE