papirus 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3383785799a1d57bc50f8521650c4a6367eee8d
-  data.tar.gz: 2a72256c267feefdd72fcd4bff71d6dccf70f59f
+  metadata.gz: 2e4a81e5d2a007320dd5fe508cfd8f28e0136265
+  data.tar.gz: dcedbd0e7fee34467acf974839bf0cd715a1cf6b
 SHA512:
-  metadata.gz: f2ef93f982daa6ccde5d204a86205198d0ac68802e3a5bad0422e4b966fe91fee83a2b896fd4fe6da93a139293fc9cebf5f4b104b41bd40f946729e05964f390
-  data.tar.gz: 576b13337d8dbccb574e295908725ca0ccd66ac9b274f774e709a095a689887e0a31c868a4fc57df1702178d60e3a4b2231903f2a0816a26b36f0ac1af4e9852
+  metadata.gz: e5e46eda4b6c84f40fd1f7183a2ebafd5ec1cdc4c454366c73e6228f5af17975e4e79a5e438cd46a2c39cc710b0af903f289a388b3eb0a4c50934496e48aa658
+  data.tar.gz: 91e93335743a1d73742d3ad98101ffa0dfd8a00e5db9a00f593d5e53df69b018308c82b04f533bae1d433e22a5888cb6e003c847e1d8f58cede0c038578488b6

data/README.md

@@ -32,22 +32,22 @@ require 'papirus'
 display = PaPiRus::Display.new()
 ```
 
-# Playing with RMagic
+# Playing with Chunky_PNG
 
-```ruby
-require 'rmagick'
+First install chunky_png
 
-img = Magick::Image::read('/path/to/img/file.(png|jpg/etc')[0]
-# we have to translate it to a 2 bit grayscale as that is what our PaPiRus understands
-display.show(img.resize_to_fit(display.width, display.height).quantize(2, Magick::GRAYColorspace).to_blob())
+```bash
+$ (OSX) brew install chunky_png
+$ (debian/ubuntu) sudo apt-get install chunky_png
+$ (Windows) no idea (did not use windows for 20 year, yes that is possible)
+$ gem install chunky_png
 ```
 
-# Playing with Chunky_PNG
+The, start an irb session to play around
 ```ruby
-git clone https://github.com/mmolhoek/papirus
 irb
 require 'papirus'
-require_relative 'lib/chunky' # add's to_bit_stream function to chucky
+require 'papirus/chunky' # add's to_bit_stream function to chucky
 
 #lets get a clean png of the size of the display to play with using chunky_png
 image = ChunkyPNG::Image.new(display.width, display.height, ChunkyPNG::Color::WHITE)
@@ -94,11 +94,52 @@ Partial update:
 
 ```display.show(image.to_bit_stream, 'P')```
 
-## Load an image from a png file
+## Load an image from a png file with convert and chunky
+
+First, let's use Image Magick's `convert` tool to convert any image into a b/w image the way the diplay likes it
+```bash
+convert in.jpg -resize '264x176' -gravity center -extent '264x176' -colorspace gray  -colors 2 -type bilevel out.png
+```
+
+Where
+* the -resize scales the image to fit the display
+* The -gravity and -extent combination (order is important!) makes sure the image stays at the size of the display and in the centre
+* The -colorspace -colors -type combi makes the image a 1-bit grayscale b/w image
+
+Then we use chucky with our extension to show
 
 ```ruby
-image = ChunkyPNG::Image.from_file('/some/png/file/path.png')
-display.show(encode_png_pixels_to_scanline_grayscale_1bit(pixels))
+irb
+require 'papirus'
+require 'papirus/chunky'
+display = PaPiRus::Display.new()
+image = ChunkyPNG::Image.from_file('out.png')
+display.show(image.to_bit_stream(true))
+```
+result:
+![that's me](https://raw.githubusercontent.com/mmolhoek/papirus/master/example_output.jpg)
+
+# Playing with RMagic (does not work yet), did not figure out right command
+
+First install rmagick
+
+```bash
+$ # install native Image Magick library
+$ (OSX) brew install imagemagick@6 && brew link imagemagick@6 --force
+$ (debian/ubuntu) sudo apt-get install imagemagick
+$ (Windows) no idea (did not use windows for 20 year, yes that is possible)
+$ # install the gem that talks to the native Image Magick library
+$ gem install rmagick
+```
+
+The, start an irb session to play around
+```ruby
+require 'papirus'
+require 'papirus/rmagick'
+
+display = PaPiRus::Display.new()
+img = Magick::Image::read('/path/to/img/file.(png|jpg|etc').first
+img.to_papirus(display)
 ```
 
 ## Testing without a PAPiRus display

data/README.rdoc

@@ -1,7 +1,7 @@
 = papirus
 
 This gem can be used to communicate with the {PaPiRus}[https://github.com/PiSupply/PaPiRus] display.
-Checkout {GitHub}[http://github.com/mmolhoek/papirus] for examples
+Checkout {GitHub}[http://github.com/mmolhoek/papirus] for examples and documentation
 
 == Contributing to papirus
 

data/lib/papirus.rb

@@ -1,6 +1,8 @@
 module PaPiRus
+    # The {PaPiRus::Display} can be use to send image data to the
+    # epd fuse driver
     class Display
-        attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto, :allowed_commands
+        attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto, :allowed_commands, :display_path
         attr_accessor :rotation, :inverse, :image
 
         def initialize(epd_path: '/dev/epd', width: 200, height: 96, panel: 'EPD 2.0', cog: 0, film: 0, auto: false, inverse: false, rotation: 0)
@@ -53,6 +55,7 @@ module PaPiRus
             #and update the properties accordingly
             if File.exists?(File.join(@epd_path, 'panel'))
                 info = File.read(File.join(@epd_path, 'panel'))
+                @display_path = File.join([@epd_path, 'LE', 'display'])
                 if match = info.match(/^([A-Za-z]+\s+\d+\.\d+)\s+(\d+)x(\d+)\s+COG\s+(\d+)\s+FILM\s+(\d+)\s*$/)
                     @panel, @width, @height, @cog, @film = match.captures.each_with_index.map{|val, index| index > 0 ? val.to_i : val}
                 else

data/lib/papirus/rmagick.rb

@@ -0,0 +1,28 @@
+require 'rmagick'
+
+class Magick::Image
+    # Send's any image to the PAPiRus display, if it is found
+    # image is rescaled to fit the display (positioning it mid center)
+    # @param display[PaPiRus::Display] The {PaPiRus::Display} object
+    def to_papirus(display)
+        # Resize to fit the screen
+        resized = resize_to_fit(display.width, display.height)
+        # Reduce the image to a limited number of colors for a "poster" effect, brings it donw to 4-bit 16 colors
+        posterized = resized.posterize(2)
+        #now, as the display expects a file with all pixels set, we need to extend the image to the display size
+        #if it is smaller in either width or height or both
+        if (posterize.columns != display.width or posterize.rows != display.height)
+            # extent fill color
+            posterized.background_color = "#FFFFFF"
+            # calculate necessary translation to center image on background
+            x = (posterized.columns - display.width) / 2
+            y = (posterized.rows - display.height) / 2
+            # now, 'extent' the image to the correct size with the image centered
+            posterized = posterized.extent(display.width, display.height, x, y)
+        end
+        # Now, make grayscale with only 2 colors, b/w, brings it down to 1-bit 2 colors
+        quantized = posterized.quantize(2, Magick::GRAYColorspace)
+        #return the raw image data
+        quantized.write(display.display_path){self.format='DIB'} #DIB=Device Independant Binary, as in , no headers, just raw data
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papirus
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mischa Molhoek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -96,6 +96,7 @@ files:
 - README.rdoc
 - lib/papirus.rb
 - lib/papirus/chunky.rb
+- lib/papirus/rmagick.rb
 homepage: http://github.com/mmolhoek/papirus
 licenses:
 - MIT
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: ruby gem to access the PaPiRus display