papirus 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 351e781013b7ce41795cefea94547ff985ac1299
-  data.tar.gz: 649bbf301e45d6f35e84538f359bd8b0868d51b9
+  metadata.gz: e058ef8f10445a56a69a14ae4d8044ac941548a3
+  data.tar.gz: 756b5c818963af406a77fbcf4140d93f67d2d620
 SHA512:
-  metadata.gz: 3514f623188b3de3dca23ac413de273b625e400114978bade812bdeb4358324bf84d8428e4bf73df3af3313764a2fc3f6f2e0d2b4ea8ae3c0e14d774fa644da9
-  data.tar.gz: 222e02a5d40b2d9bbdfd81aab137f95d8d9e9268f15de27c343db0714da4faa75cc2bfb2f20780637732875d0aa882edde7143280cbbc8285bf0d9e26f721bd9
+  metadata.gz: 10d7c085d808892a893d3317d57490bdeed02ef2bffd5352300264ae5b37454725d89677c9c7f5b0568166926022ae049b3b2628989b56cd3cf27072711f23b2
+  data.tar.gz: fb164c0c081400db678970787ba88d7da0444fcd3cbb9875116fc79ed6bacd1411770169fda1dbc7d780597d1fa64a467b566f610b3df0dbe399e67aa53889dd

data/README.md

@@ -6,10 +6,7 @@ ruby gem to talk to the PAPiRus display
 ```bash
 sudo apt-get install libfuse-dev -y
 
-mkdir /tmp/papirus
-cd /tmp/papirus
 git clone https://github.com/repaper/gratis.git
-
 cd gratis
 make rpi EPD_IO=epd_io.h PANEL_VERSION='V231_G2'
 make rpi-install EPD_IO=epd_io.h PANEL_VERSION='V231_G2'
@@ -50,21 +47,33 @@ display.clear
     image.circle(display.width/2, display.height/2, radius)
     display.show(image.to_bit_stream, 'F')
 end
-```
 
-## from here WIP
+# there are multiple screen commands ['F', 'P', 'U', 'C']
 
-#img loading does not work yet
-image = ChunkyPNG::Image.from_file(pngfile)
-display.show(image.to_bit_stream)
+* 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')`
 
-# more control
-display = PaPiRus::Display.new()
-display.load(imagefile)
-
-display.update #or
-display.fast_update #or
-display.partial_update
-
-#or when testing to a temp file (run createtestepd.sh to create paths in /tmp)
-display = PaPiRus::Display.new(epd_path: '/tmp/epd')
+```
+# Testing without a PAPiRus display
+
+If you want to test the gem, but don't have your PaPiRus available, you can do the following
+
+* clone this repo
+* run the createtestepd.sh script that is in the repo which creates the needed files and folders in /tmp/epd
+* start irb
+* require 'papirus'
+* display = PaPiRus::Display.new(epd_path: '/tmp/epd')
+* play with the examples above
+* 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
+
+* 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 :)

data/lib/papirus.rb

@@ -2,7 +2,7 @@ require_relative "chunky"
 
 module PaPiRus
     class Display
-        attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto
+        attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto, :allowed_commands
         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)
@@ -12,6 +12,7 @@ module PaPiRus
                 v = eval(k.to_s)
                 instance_variable_set("@#{k}", v) unless v.nil?
             end
+            @allowed_commands = ['F', 'P', 'U', 'C']
             get_display_info_from_edp
         end
 
@@ -22,7 +23,7 @@ module PaPiRus
             File.open(File.join(@epd_path, "LE", "display#{@inverse ? '_inverse': ''}"), 'wb') do |io|
                 io.write data
             end
-            command(updatemethod)
+            command(@allowed_commands.include?(updatemethod) ? updatemethod : 'U')
         end
 
         def fast_update()
@@ -41,8 +42,17 @@ module PaPiRus
             command('C')
         end
 
+        def command(c)
+            raise "command #{c} does not exist" unless @allowed_commands.include?(c)
+            File.open(File.join(@epd_path, "command"), "wb") do |io|
+                io.write(c)
+            end
+        end
+
     private
         def get_display_info_from_edp
+            #now we will read the info of the installed display
+            #and update the properties accordingly
             if File.exists?(File.join(@epd_path, 'panel'))
                 info = File.read(File.join(@epd_path, 'panel'))
                 if match = info.match(/^([A-Za-z]+\s+\d+\.\d+)\s+(\d+)x(\d+)\s+COG\s+(\d+)\s+FILM\s+(\d+)\s*$/)
@@ -57,9 +67,5 @@ module PaPiRus
             end
         end
 
-        def command(c)
-            f = File.new(File.join(@epd_path, "command"), "wb")
-            f.write(c)
-        end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papirus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mischa Molhoek