papirus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 351e781013b7ce41795cefea94547ff985ac1299
+  data.tar.gz: 649bbf301e45d6f35e84538f359bd8b0868d51b9
+SHA512:
+  metadata.gz: 3514f623188b3de3dca23ac413de273b625e400114978bade812bdeb4358324bf84d8428e4bf73df3af3313764a2fc3f6f2e0d2b4ea8ae3c0e14d774fa644da9
+  data.tar.gz: 222e02a5d40b2d9bbdfd81aab137f95d8d9e9268f15de27c343db0714da4faa75cc2bfb2f20780637732875d0aa882edde7143280cbbc8285bf0d9e26f721bd9

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mischa Molhoek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Mischa Molhoek
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# papirus
+
+ruby gem to talk to the PAPiRus display
+
+## epaper fuse driver installation instructions (if you have not done that already ::)
+```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'
+systemctl enable epd-fuse.service
+systemctl start epd-fuse
+```
+## gem installation
+
+```bash
+$ gem install papirus
+```
+## usage
+
+```ruby
+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
+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
+
+#and last we dump the image as bitsteam to the display
+display.show(image.to_bit_stream)
+
+# now we could also change the circle and fast update the screen
+image.replace!(ChunkyPNG::Image.new(display.width, display.height, ChunkyPNG::Color::WHITE))
+image.circle(display.width/2, display.height/2, display.height/4)
+display.show(image.to_bit_stream, 'F')
+
+# or update the screen for multiple circles
+display.clear
+2.step(image.height/2-2, 5).each do |radius|
+    image.replace!(ChunkyPNG::Image.new(display.width, display.height, ChunkyPNG::Color::WHITE))
+    image.circle(display.width/2, display.height/2, radius)
+    display.show(image.to_bit_stream, 'F')
+end
+```
+
+## from here WIP
+
+#img loading does not work yet
+image = ChunkyPNG::Image.from_file(pngfile)
+display.show(image.to_bit_stream)
+
+# 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')

data/README.rdoc

@@ -0,0 +1,18 @@
+= papirus
+
+Description goes here.
+
+== 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.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2017 Mischa Molhoek. See LICENSE.txt for
+further details.

data/lib/chunky.rb

@@ -0,0 +1,31 @@
+require 'chunky_png'
+
+module ChunkyPNG::Canvas::StreamExporting
+    def inspect_bitstream
+        #create a simple map of the image of '0's and '1's
+        #for debugging purpuses
+        pixels.each_slice(@width).map{|row| row.each_slice(8).map{|pixels|pixels.map{|pixel| pixel == ChunkyPNG::Color::WHITE ? '0' : '1'}.join}.join(' ')}
+    end
+
+    def to_bit_stream(inverse = false)
+        #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|
+            #we create a byte with its bits set to 00000000
+            byte = 0
+            0.upto(7) do |bit|
+                #and switch the bit to 1 (or 0 if not inverse) for each pixel if it was white
+                #we have to check pixels[7-bit] as the order is right to left
+                byte |= 1 << bit if (inverse && pixels[7-bit] == ChunkyPNG::Color::WHITE) || (!inverse && pixels[7-bit] != ChunkyPNG::Color::WHITE)
+            end
+            #and add it to the output byte stream
+            bytes.push(byte)
+        end
+        #now we just need to pack all bytes into a file writable string
+        bytes.pack('C'*bytes.length)
+    end
+end

data/lib/papirus.rb

@@ -0,0 +1,65 @@
+require_relative "chunky"
+
+module PaPiRus
+    class Display
+        attr_reader :epd_path, :width, :height, :panel, :cog, :film, :auto
+        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)
+            #transver all vars to attr's
+            method(__method__).parameters.each do |type, k|
+                next unless type == :key
+                v = eval(k.to_s)
+                instance_variable_set("@#{k}", v) unless v.nil?
+            end
+            get_display_info_from_edp
+        end
+
+        def show(*args)
+            raise 'you need to al least provide raw imagedata' if args.length == 0
+            data = args[0]
+            updatemethod = args[1] || 'U'
+            File.open(File.join(@epd_path, "LE", "display#{@inverse ? '_inverse': ''}"), 'wb') do |io|
+                io.write data
+            end
+            command(updatemethod)
+        end
+
+        def fast_update()
+            command('F')
+        end
+
+        def partial_update()
+            command('P')
+        end
+
+        def update()
+            command('U')
+        end
+
+        def clear()
+            command('C')
+        end
+
+    private
+        def get_display_info_from_edp
+            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*$/)
+                    @panel, @width, @height, @cog, @film = match.captures.each_with_index.map{|val, index| index > 0 ? val.to_i : val}
+                else
+                    STDERR.puts "did not recognize screen info: #{info}, is the epd driver properly installed? have a look at the README.md to see how to install the epaper driver"
+                    exit 1
+                end
+            else
+                STDERR.puts "could not find the epd driver at #{@epd_path}, is the epd driver properly installed? have a look at the README.md to see how to install the epaper driver"
+                exit 1
+            end
+        end
+
+        def command(c)
+            f = File.new(File.join(@epd_path, "command"), "wb")
+            f.write(c)
+        end
+    end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: papirus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mischa Molhoek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- LICENSE
+- LICENSE.txt
+- README.md
+- README.rdoc
+- lib/chunky.rb
+- lib/papirus.rb
+homepage: http://github.com/mmolhoek/papirus
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: ruby gem to access the PaPiRus display
+test_files: []