papirus 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e058ef8f10445a56a69a14ae4d8044ac941548a3
-  data.tar.gz: 756b5c818963af406a77fbcf4140d93f67d2d620
+  metadata.gz: 2ea7eafaea2155d636ec9e6b712ce6310679a57e
+  data.tar.gz: 967ca7fb5503b8079e098b98f43c76e77c6d8477
 SHA512:
-  metadata.gz: 10d7c085d808892a893d3317d57490bdeed02ef2bffd5352300264ae5b37454725d89677c9c7f5b0568166926022ae049b3b2628989b56cd3cf27072711f23b2
-  data.tar.gz: fb164c0c081400db678970787ba88d7da0444fcd3cbb9875116fc79ed6bacd1411770169fda1dbc7d780597d1fa64a467b566f610b3df0dbe399e67aa53889dd
+  metadata.gz: 3f99ad2bcf1bd57e4fb8504e411718654d65c456f996eb72a8540d795e6983ad437902ae869e866983880d6ae870a6b81b3c5e7ff10e251f7481adf4c90a0d4a
+  data.tar.gz: e97870beae1b628636cba2630a0b3f0a4b2a5b5f0b6596a42ec2804c9f90223980d605a475b969e7c448c4e04cc9e94153038be8ca9f5c1565d487e42e45d91c

data/README.md

@@ -1,6 +1,8 @@
 # papirus
 
-ruby gem to talk to the PAPiRus display
+ruby gem to talk to the [PaPiRus](https://www.pi-supply.com/?s=papirus&post_type=product&tags=1&limit=5&ixwps=1) display
+
+before you start playing make sure you got the edp-fuse setup
 
 ## epaper fuse driver installation instructions (if you have not done that already ::)
 ```bash
@@ -13,6 +15,9 @@ make rpi-install EPD_IO=epd_io.h PANEL_VERSION='V231_G2'
 systemctl enable epd-fuse.service
 systemctl start epd-fuse
 ```
+
+You can find more detailed instructions [https://github.com/repaper/gratis](here)
+
 ## gem installation
 
 ```bash
@@ -25,13 +30,29 @@ require 'papirus'
 
 # first we get ourself a display
 display = PaPiRus::Display.new()
+```
 
-#lets get a clean clean png of the size of the display to play with using chunky_png
+# Playing with RMagic
+
+```
+require 'rmakgick'
+img = Magick::Image::read('mischa.jpg')[0]
+display.show(img.resize_to_fit(display.width, display.height).quantize(2, Magick::GRAYColorspace).to_blob()
+```
+
+# Playing with Chunky_PNG
+```
+require_relative "lib/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)
 #and we draw a circle on it which is about the size of the screen
 image.circle(display.width/2, display.height/2, display.height/2-2)
-# have a look at https://github.com/wvanbergen/chunky_png for more examples
+```
+
+have a look at [chunky_png](https://github.com/wvanbergen/chunky_png/wiki) for more examples
 
+```
 #and last we dump the image as bitsteam to the display
 display.show(image.to_bit_stream)
 
@@ -47,15 +68,35 @@ display.clear
     image.circle(display.width/2, display.height/2, radius)
     display.show(image.to_bit_stream, 'F')
 end
+```
+
+## there are multiple screen commands ['F', 'P', 'U', 'C']
+
+Full update (with screen cleaning):
+
+```display.show(image.to_bit_stream); display.update``` or
+
+```display.show(image.to_bit_stream, 'U')```
+
+Fast update:
+
+```display.show(image.to_bit_stream); display.fast_update```
+```display.show(image.to_bit_stream, 'F')```
 
-# there are multiple screen commands ['F', 'P', 'U', 'C']
+Partial update:
 
-* you can call `display.show(image.to_bit_stream); display.update` or `display.show(image.to_bit_stream, 'U')`
-* you can call `display.show(image.to_bit_stream); display.fast_update` or `display.show(image.to_bit_stream, 'F')`
-* you can call `display.show(image.to_bit_stream); display.partial_update` or `display.show(image.to_bit_stream, 'P')`
+```display.show(image.to_bit_stream); display.partial_update``` or
 
+```display.show(image.to_bit_stream, 'P')```
+
+## Load an image from a png file
+
+```
+image = ChunkyPNG::Image.from_file('/some/png/file/path.png')
+display.show(encode_png_pixels_to_scanline_grayscale_1bit(pixels))
 ```
-# Testing without a PAPiRus display
+
+## Testing without a PAPiRus display
 
 If you want to test the gem, but don't have your PaPiRus available, you can do the following
 
@@ -68,12 +109,15 @@ If you want to test the gem, but don't have your PaPiRus available, you can do t
 * when you run `display.show` the **fake** display /tmp/epd/LE/display is filled with your image
 * now you can use a bin editor like xxd to have a look at the result: `xxd -b /tmp/epd/LE/display`
 
-# TODO
+## TODO
 
 * make the image.to_bit_stream routine faster (as it is now to slow to do animations with partial updates)
 * add support for reading the temperature of the display
 * add support for changing the update rate
-* make the gem not depending on chunky_png
 * make load png image with chunky_png work (now output is black)
 * make a display.load(image) that takes multiple formats and figures out how to present them
 * create an issue to add your own requests :)
+
+## Other resources
+
+* [pi supply python driver](https://github.com/PiSupply/PaPiRus)

data/README.rdoc

@@ -1,9 +1,10 @@
 = papirus
 
-Description goes here.
+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
 
 == Contributing to papirus
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -14,5 +15,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2017 Mischa Molhoek. See LICENSE.txt for
-further details.
+Copyright (c) 2017 Mischa Molhoek. See LICENSE.txt for further details.

data/lib/chunky.rb

@@ -11,7 +11,6 @@ module ChunkyPNG::Canvas::StreamExporting
         #as the ChunkyPNG library works with 4 bytes data per pixel (1 byte for R, G, B and transparancy)
         #and the EDP needs 1 bit per pixel (on or off), we need some way to traverse over all pixels
         #and add a bit to a byte stream for each pixel. so
-
         bytes = []
         #for each 8 pixels (the ChunkyPNG library keeps an array of all pixels used, containing ChunkyPNG::Color elements)
         pixels.each_slice(8).map do |pixels|
@@ -26,6 +25,6 @@ module ChunkyPNG::Canvas::StreamExporting
             bytes.push(byte)
         end
         #now we just need to pack all bytes into a file writable string
-        bytes.pack('C'*bytes.length)
+        bytes.pack('C*')
     end
 end

data/lib/papirus.rb

@@ -1,5 +1,3 @@
-require_relative "chunky"
-
 module PaPiRus
     class Display
         attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto, :allowed_commands

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papirus
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mischa Molhoek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: chunky_png
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This gem can be used to talk to the PaPiRus e-paper display
 email: mischamolhoek@gmail.com
 executables: []
@@ -130,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ruby gem to access the PaPiRus display