SSD1306 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f6bdd49eb64a9f801a61eb64b7135a148ea3f03
-  data.tar.gz: 962e75ce784a53d16171ae9b9b83ab1d6f970d6c
+  metadata.gz: 9b72c1225182fe4b68f84c697098533da9ec29e8
+  data.tar.gz: 792815951029ec30523482333453a4dbaa7a66d4
 SHA512:
-  metadata.gz: f5d166a8a28ba37a08e73a11a56dbf1c60954601aff8125cade56c268e17d8fdd28521691e3f7c0c4a2f7edb5e11e4dff5981cbda794534fcd6802cb087f38b3
-  data.tar.gz: 261705f1e7e3ffe51360734d60ecca7893f297c1dfe7d4f70fc954d7bd5e5b23cac4ce6d17cc100c56765a88720a6838576d69df9f6906e3da362b421e6d9b5d
+  metadata.gz: b5f1b3ae71467695c79177221262d6bdad627d73d9ebbe69b877bd729a073897de7e6e9631a46d5269606574e207c4b603d62f967a52b12cc180e136a2b42e4b
+  data.tar.gz: c47d2cdfaad24d25a7c083c45074a2e6542cf42f409c307b58315606d66f7eb0880bf2d87eb6162343d3da3c24584b423f5cb75a07531676f89355b714d60cb9

data/README.md

@@ -1,8 +1,6 @@
 # SSD1306
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/SSD1306`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a library for the SSD1306 OLED Display written in Ruby.  It was inspired by Adafruit's libraries written in Python and C.  Much of the original logic was simply ported from their Python library, but in addition this Ruby library provides additional functionality such as `print` and `println` helpers.  The library also features simple image parsing.
 
 ## Installation
 
@@ -22,7 +20,55 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Using the library is simple.  To start with, require the library and initialize the display:
+
+```ruby
+require 'SSD1306'
+disp = SSD1306::Display.new
+```
+
+The default options are suitable for the Raspberry Pi and a 128x64 display.  These can be overridden by specifying values like so:
+
+```ruby
+disp = SSD1306::Display.new(protocol: :i2c, path: '/dev/i2c-1', address: 0x3C, width: 128, height: 64)
+```
+
+Writing text on the display is simple:
+
+```ruby
+disp.println "This is my IP Address:"
+disp.println "" # The same as disp.print "\n"
+disp.font_size 2
+disp.println ip_address
+disp.display!
+```
+
+You can also display monochrome images:
+
+```ruby
+include Magick  # RMagick is a dependency
+image = Image.read("path/to/my/image.png").first # Image.read returns an array
+
+disp.image(image) # Pass in an RMagick image object
+disp.display!
+```
+
+They display can also be easily cleared:
+
+```ruby
+disp.clear
+disp.display!
+
+# Or more simply:
+disp.clear!
+```
+
+Check out the source code for additional information.  It's not very hard to read.
+
+## To-do
+
+* Currently only 1, 2, and 4 work as font sizes. In the meantime, to use other fonts or font sizes, I recommend using RMagick's `annotate` feature and passing in an image.
+* Implement SPI.  Only I2C is currently supported. (For v1.0)
 
 ## Development
 
@@ -40,4 +86,4 @@ This library is inspired by the Adafruit SSD1306 Python library, available here:
 
 ## License
 
-Copyright (c) 2016 Xavier Bick under the MIT License.  See LICENSE.txt for details.
+Copyright (c) 2016 Xavier Bick under the MIT License.  See the LICENSE file for details.

data/lib/SSD1306/cursor.rb

@@ -8,17 +8,31 @@ module SSD1306
       @y_pos = 0
     end
 
+    def reset
+      reset_pos
+      reset_size
+    end
+
+    def reset_pos
+      @x_pos = 0
+      @y_pos = 0
+    end
+
+    def reset_size
+      @size = 1
+    end
+
     def increment
-      if @x_pos >= (126 - 5*@size)
+      if @x_pos >= (127 - 6*@size)
         newline
       else
-        @x_pos += 5*size
+        @x_pos += (6*@size)
       end
     end
 
     def newline
       @x_pos = 0
-      @y_pos += 8*size
+      @y_pos += 8*@size
     end
 
     def set_pos(x, y)
@@ -26,9 +40,9 @@ module SSD1306
       @y_pos = y
     end
 
-    def buffer_index
+    def buffer_index(page_offset = 0)
       page = @y_pos / 8
-      index = (page*128) + @x_pos
+      index = (page*128 + page_offset*128) + @x_pos
     end
 
     def position_in_buffer

data/lib/SSD1306/display.rb

@@ -163,6 +163,7 @@ module SSD1306
 
     def clear
       @buffer = [0]*(@width*@pages)
+      @cursor.reset
     end
 
     def clear!
@@ -174,6 +175,7 @@ module SSD1306
       string.each_byte do |c|
         self.print_char c
       end
+      string
     end
 
     def println(string)
@@ -181,11 +183,11 @@ module SSD1306
         self.print_char c
       end
       self.print_char 10 # 10 is ASCII for \n
+      string
     end
 
-    #TODO Do font_size
     def font_size(new_size)
-      raise "font_size not yet implemented"
+      @cursor.size = new_size
     end
 
     #TODO Implement Contrast functionality
@@ -208,7 +210,23 @@ module SSD1306
         @cursor.newline
       elsif b > 31
         for i in 0...5
-          @buffer[@cursor.buffer_index + i] = FONT[(b*5) + i]
+          if @cursor.size == 1
+            @buffer[@cursor.buffer_index + i] = FONT[(b*5) + i]
+          else
+            byte = FONT[(b*5) + i].to_s(2).rjust(8, '0')
+            a = byte.chars.each_slice(8/@cursor.size).map(&:join)
+            bytes = []
+            a.each do |e|
+              bytes << e.chars.map {|c| c*(8/e.length)}.join
+            end
+            bytes = bytes.map {|b| b.to_i(2)}
+            bytes.reverse!
+            for page in 0...@cursor.size
+              for x_interval in 0...@cursor.size
+                @buffer[@cursor.buffer_index(page) + i*@cursor.size + x_interval] = bytes[page]
+              end
+            end
+          end
         end
         @cursor.increment
       end

data/lib/SSD1306/version.rb

@@ -1,3 +1,3 @@
 module SSD1306
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SSD1306
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Xavier Bick