ev3dev_ruby 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 714611949c580eb99dc736548a1443d7847338fd
-  data.tar.gz: 71d47dda55a5c83a04bd8b2ced44115cf6fe4f56
+  metadata.gz: b2ef7e22480bd273e44f7609568aa184ba03a945
+  data.tar.gz: 51ae42dde560f7bbe9e1ad5fd5c3004015feb0b5
 SHA512:
-  metadata.gz: e82d72e98a748ed4299b09024ea3a37a9c166e048b48823d6640cd8f1b7e405144fb75a53707ce90c0c462ced708ba54d50e71757bd50f1ea4b98f97e70b6a48
-  data.tar.gz: 3634570d6295b31e41c5754665607a97083d6bd5a5f94e24069ccee7427230dffb2d627a47f3bffbde73d6554291a9d2677fba18e9cfbd79be561071af944b0d
+  metadata.gz: 9b02a281fc37fc894132d6bc628615c16ea7c5992d2dd8dfa58416102d0b834aa87f18321ef1774359f5191bc098d78df775821d52aed9b6535cfcb0434ae37c
+  data.tar.gz: 0ee5e884db3ec5ef86435a65200f087b9ec18371222d6fa168ca048f8426bc87d2c856251641abf302f88dca0775e7a4c3421004ddf311a30021e83a1310d3f3

data/Display_API.md

@@ -0,0 +1,124 @@
+# EV3 Display (LCD)
+
+## Display Specifications
+* Mode  : 178 x 128 pixel  
+* LineLength  : 24 bytes (192 bits)  
+* Geometry  : 1 (1 bit per pixel)  
+* Type  : PACKED PIXELS  
+* Visual  : MONO01 (0: white, 1: black)  
+* Frame Buffer directory  : /dev/fb0  
+* Frame Buffer size     : 24 * 128 = 3072 bytes  
+* 178 bits in a line (192 bits) and 128 rows are actually displayed
+
+## Image File Format
+Image file must be 192 x 128 pixel .mono format  
+(raw bi-level bitmap in least-significant-byte(LSB) first order)
+
+### .mono format
+see [ImageMagick: Supported Image Formats](http://www.imagemagick.org/script/formats.php)
+
+## Ev3dev::Screen Class
+Screen Class only supports the 192 x 128 pixel .mono image file format
+
+- \#initialize
+
+ creates an accessible instance variable @imgs (blank array)
+
+- \#load(image_file)
+
+ loads image file and adds to the array @imgs  
+ (file should be the 192 x 128 pixel .mono format)
+
+- \#load_blank
+
+ adds blank image (white image) to the array @imgs
+
+- \#show
+
+ shows the @imgs[0] image to the EV3 LCD display and shifts the array @imgs (if @imgs.size >= 2)
+
+- \#show_blank
+
+ displays the blank image (white image) and the array @imgs is unchanged
+
+
+## Ev3dev::Image Class
+Image Class converts various size and format image files to the EV3 display format (192 x 128 pixel .mono format).  
+And it can also create text images.
+
+It requires [RMagick](https://github.com/rmagick/rmagick) gem ([ImageMagick](http://www.imagemagick.org/) Ruby binding).  
+To install [RMagick](https://github.com/rmagick/rmagick):
+```
+robot@ev3dev:~$ sudo apt-get update
+robot@ev3dev:~$ sudo apt-get install ruby-rmagick
+(or ~$ sudo gem install rmagick -N -V)
+```
+
+
+- \#initialize(image_file)
+
+ loads image file and converts the EV3 display format (192 x 128 pixel .mono format), or creates a blank image (if no arguments)
+
+- \#save(output_file)
+
+ saves the image_file (output file name should be '.mono')
+
+
+- \#text(x, y, size, string)
+
+ creates a text image
+ - x; x position of text
+ - y; y position of text
+ - size; font size
+ - string; text string
+
+
+## How to create the EV3 display format (192 x 128 pixel .mono format) file on PC
+
+### ImageMagick
+1. Install ImageMagick
+
+ see [ImageMagick site](http://www.imagemagick.org/)
+
+2. Terminal command
+```
+$ convert -resize 192x128! original_file.jpg converted_file.mono
+#converted_file_name must have .mono
+```
+
+
+-  Display the .mono file on PC  
+it requires X Window System (or [XQuartz](https://www.xquartz.org) for Mac)
+```
+$ display -size 192x128 converted_file.mono
+```
+
+### RMagick (ImageMagick Ruby binding)
+
+1. Install ImageMagick and RMagick
+
+ see [ImageMagick site](http://www.imagemagick.org/) and [RMagick site](https://github.com/rmagick/rmagick)
+
+2. Ruby Program
+```ruby
+require 'RMagick'
+target_image =  Magick::Image.read('original_file.jpg').first
+target_image.resize_to_fill!(192, 128)
+target_image.write('converted_file.mono') #converted_file_name must have .mono
+target_image.destroy!
+```
+
+
+-  Display the .mono file on PC  
+it requires X Window System (or [XQuartz](https://www.xquartz.org) for Mac)
+```ruby
+require 'RMagick'
+mono_image = Magick::Image.read('converted_file.mono') { self.size = "192x128" }.first
+mono_image.display
+```
+
+## More Info
+
+ - Also checkout examples
+
+ - [Using the EV3 LCD - ev3dev.org ](http://www.ev3dev.org/docs/tutorials/using-ev3-lcd/)

data/README.md

@@ -1,9 +1,14 @@
 # ev3dev ruby binding for LEGO Mindstorms EV3
 
 
-ev3dev_ruby is a gem to controll sensors and motors on EV3 using Ruby.
+ev3dev_ruby is a gem to controll sensors and motors on EV3 using Ruby on ev3dev OS.  
+ev3dev OS is a Debian Linux-based operating system for LEGO Mindstroms EV3.
 
-- [ev3dev](http://www.ev3dev.org) version; ev3dev-jessie-2015-12-30 or later
+- [ev3dev OS](http://www.ev3dev.org) version; ev3dev-jessie-2015-12-30
+
+
+## Install ev3dev OS
+See [ev3dev OS website](http://www.ev3dev.org)
 
 
 ## Install ev3dev_ruby on EV3
@@ -15,11 +20,10 @@ SSH remote access to the EV3 from PC
 $ ssh robot@ev3dev.local
 ```
 
-
-
 then
 
 ```
+robot@ev3dev:~$ sudo apt-get update
 robot@ev3dev:~$ sudo gem install ev3dev_ruby
 ```
 
@@ -118,12 +122,14 @@ irb(main):012:0>
   - [LED Transient Trigger](https://www.kernel.org/doc/Documentation/leds/ledtrig-transient.txt)
   - Original Led Class APIs are added. Checkout examples.
 - [Buttons](http://www.ev3dev.org/docs/tutorials/using-ev3-buttons/)
+- [Display](http://www.ev3dev.org/docs/tutorials/using-ev3-lcd/)
+  - Original Screen Class and Image Class APIs are added. See Display_API.md and examples.
 
-#### These EV3 devices below are not supported yet.
+#### The EV3 device below are not supported yet.
 
-- [LCD](http://www.ev3dev.org/docs/tutorials/using-ev3-lcd/)
 - [Bluetooth](https://github.com/ev3dev/ev3dev/wiki/Using-Bluetooth)
 
 
 ## More Info
+
 - [Getting Started with ev3dev - ev3dev.org](http://www.ev3dev.org/docs/getting-started/)

data/lib/ev3dev.rb

@@ -7,6 +7,8 @@ require 'ev3dev/battery'
 require 'ev3dev/sound'
 require 'ev3dev/led'
 require 'ev3dev/button'
+require 'ev3dev/screen'
+require 'ev3dev/image'
 
 module Ev3dev
 end

data/lib/ev3dev/battery.rb

@@ -2,7 +2,7 @@ module Ev3dev
   class Battery < Device
     PATH = "/sys/class/power_supply"
 
-    def initialize()
+    def initialize
       Dir.glob("#{PATH}/*").each do |path|
         if File.exist?("#{path}/voltage_now")
           super path

data/lib/ev3dev/button.rb

@@ -19,7 +19,7 @@ module Ev3dev
     BUF_LEN = (KEY_MAX + 7) / 8
     PATH = "/dev/input/by-path/platform-gpio-keys.0-event"
 
-    def initialize()
+    def initialize
       raise "couldn't find LED attributes" unless File.exist?(PATH)
       @buttons = {up: KEY_UP, down: KEY_DOWN, left: KEY_LEFT, right: KEY_RIGHT, enter: KEY_ENTER, back: KEY_BACK}
     end

data/lib/ev3dev/image.rb

@@ -0,0 +1,41 @@
+# You should install ImageMagick and its Ruby binding gem RMagick.
+# robot@ev3dev:~$ sudo apt-get update
+# robot@ev3dev:~$ sudo apt-get install ruby-rmagick
+# (or ~$ sudo gem install rmagick -N -V)
+
+module Ev3dev
+  class Image
+    def initialize(*args)
+      require 'RMagick'
+
+      case args.size
+      when 0
+        @image = Magick::Image.new(192, 128){ self.format = 'mono'}
+      when 1
+        image_file = args.first
+
+        if image_file.end_with?('.mono')
+          @image = Magick::Image.read(image_file){ self.size = "192x128" }.first
+        else
+          @image = Magick::Image.read(image_file).first
+          @image.format = 'mono'
+          @image.resize_to_fill!(192, 128)
+        end
+      else
+        raise "ArgumentError: wrong number of arguments 0 or 1"
+      end
+    end
+
+    # resize EV3 Screen(192 x 128) and .mono image format
+    # output file name should be '.mono'
+    def save(output_file)
+      @image.write(output_file)
+      @image.destroy!
+    end
+
+    def text(x, y, size, string)
+      draw = Magick::Draw.new
+      draw.annotate(@image, 0, 0, x, y, string){self.pointsize = size}
+    end
+  end
+end

data/lib/ev3dev/led.rb

@@ -10,7 +10,7 @@ module Ev3dev
 
     MAX_BRIGHTNESS     = 255
 
-    def initialize()
+    def initialize
       raise "couldn't find LED attributes" unless File.exist?(PATH)
 
       @left_green   = set_led_path("left" , "green")
@@ -25,32 +25,32 @@ module Ev3dev
       @paths = @default_paths
     end
 
-    def left()
+    def left
       @paths = @left_paths
       self
     end
 
-    def right()
+    def right
       @paths = @right_paths
       self
     end
 
-    def left_green()
+    def left_green
       @paths = [@left_green]
       self
     end
 
-    def left_red()
+    def left_red
       @paths = [@left_red]
       self
     end
 
-    def right_green()
+    def right_green
       @paths = [@right_green]
       self
     end
 
-    def right_red()
+    def right_red
       @paths = [@right_red]
       self
     end
@@ -63,7 +63,7 @@ module Ev3dev
       @paths = @default_paths
     end
 
-    def off()
+    def off
       self.on(0, 0)
     end
 
@@ -116,7 +116,7 @@ module Ev3dev
       @paths = @default_paths
     end
 
-    def flash()
+    def flash
       raise "couldn't specify the left/right green/red LED" if @paths.size != 1
       path = @paths[0]
       write_value_to_file(path, "activate", 1)
@@ -178,5 +178,3 @@ module Ev3dev
     end
   end
 end
-
-

data/lib/ev3dev/screen.rb

@@ -0,0 +1,55 @@
+# http://www.ev3dev.org/docs/tutorials/using-ev3-lcd/
+# LCD Mode      : 178 x 128 pixel
+#     LineLength: 24 bytes (192 bits)
+#     Geometry  : 1 (1 bit per pixel)
+#     Type      : PACKED PIXELS
+#     Visual    : MONO01 (0: white, 1: black)
+# Frame Buffer directory: /dev/fb0
+# Frame Buffer size     : 24 * 128 = 3072 bytes
+# 178 bits in a line (192 bits) and 128 rows are actually displayed
+#
+# image_file must be 192 x 128 pixel .mono format
+# (raw bi-level bitmap in least-significant-byte(LSB) first order)
+# http://www.imagemagick.org/script/formats.php
+
+
+module Ev3dev
+  class Screen
+    PATH = "/dev/fb0"
+
+    FRAME_BUFFER_SIZE = 3072   # 24 line length * 128 rows
+    BLANK_IMAGE = Array.new(FRAME_BUFFER_SIZE){ 0 }.pack("C*")
+
+    attr_accessor :imgs
+
+    def initialize
+      raise "couldn't find screen attributes" unless File.exist?(PATH)
+      @imgs = []
+    end
+
+    def load(image_file)
+      raise "couldn't load a image file except .mono format" unless image_file.end_with?('.mono')
+
+      file_size = File.size(image_file)
+      raise "file size:#{file_size} is not correct:(#{FRAME_BUFFER_SIZE})" unless file_size == FRAME_BUFFER_SIZE
+
+      @imgs << File.binread(image_file)
+    end
+
+    def load_blank
+      @imgs << BLANK_IMAGE
+    end
+
+    def show
+      if @imgs.size >= 2
+        File.binwrite(PATH, @imgs.shift)
+      else
+        File.binwrite(PATH, @imgs.first)
+      end
+    end
+
+    def show_blank
+      File.binwrite(PATH, BLANK_IMAGE)
+    end
+  end
+end

data/lib/ev3dev/sound.rb

@@ -2,7 +2,7 @@ module Ev3dev
   class Sound < Device
     PATH = "/sys/devices/platform"
 
-    def initialize()
+    def initialize
       Dir.glob("#{PATH}/*").each do |path|
         if File.exist?("#{path}/tone")
           super path

data/lib/ev3dev/version.rb

@@ -1,3 +1,3 @@
 module Ev3dev
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ev3dev_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - quake wang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Display_API.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -56,8 +57,10 @@ files:
 - lib/ev3dev/battery.rb
 - lib/ev3dev/button.rb
 - lib/ev3dev/device.rb
+- lib/ev3dev/image.rb
 - lib/ev3dev/led.rb
 - lib/ev3dev/motor.rb
+- lib/ev3dev/screen.rb
 - lib/ev3dev/sensor.rb
 - lib/ev3dev/sound.rb
 - lib/ev3dev/version.rb