'gem version 0.0.1

Author: fernandofussuma

.gitignore

@@ -0,0 +1 @@
+*.gem

Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "pi_piper"
+
+gemspec

Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    charlcd (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.9.3)
+    pi_piper (1.3.2)
+      ffi
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  charlcd!
+  pi_piper

README.md

@@ -1,22 +1,24 @@
-Ruby library for lcd display compatible with the hd44780 controller on the raspberrypi.
+CharLcd
+=======
 
-code based on:
-https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code/blob/master/Adafruit_CharLCD/Adafruit_CharLCD.py
+Lcd display library compatible with the hd44780 controller on the raspberrypi.
 
 wiring instructions:
 http://learn.adafruit.com/drive-a-16x2-lcd-directly-with-a-raspberry-pi/overview
 
-pi_piper install instructions:
-https://github.com/jwhitehorn/pi_piper
-
-example:
-```
-sudo ruby CharLcd_matrix_example.rb
-```
-
 usage:
 ``` ruby
 char_lcd = CharLcd.new
 char_lcd.begin(16, 2)
 char_lcd.message("First Line\nSecond Line")
 ```
+
+License
+=======
+(The MIT License)
+
+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.

charlcd.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'charlcd'
+  s.version     = '0.0.1'
+  s.date        = '2014-11-25'
+  s.summary     = "Lcd display raspberrypi library!"
+  s.description = "A lcd display library compatible with the hd44780 controller on the raspberrypi"
+  s.authors     = ["Fernando Fussuma"]
+  s.email       = '[email protected]'
+  s.files       = [
+    "README.md",
+    "lib/charlcd.rb",
+    "examples/charlcd_matrix_example.rb"
+  ]
+  s.homepage    = 'https://github.com/fernandofussuma/CharLcd-ruby-raspberry-pi'
+  s.license     = 'MIT'
+end

CharLcd_matrix_example.rb renamed to examples/charlcd_matrix_example.rb

@@ -1,4 +1,4 @@
-require_relative 'CharLcd'
+require 'charLcd'
 
 SLEEP_TIME = 0.005
 COLUMNS = 16
@@ -18,7 +18,7 @@ def rand_matrix(prng)
 (0..100).each do
   c = prng.rand(COLUMNS)
   for l in 0...LINES
-    
+
       count = prng.rand(5)
       i = 0
       while i < count
@@ -28,14 +28,14 @@ def rand_matrix(prng)
         sleep(SLEEP_TIME)
         i += 1
       end
-      
+
       if prng.rand(10).zero?
         count = prng.rand(5)
         i = 0
-        
+
         c1 = prng.rand(COLUMNS)
         l1 = prng.rand(LINES)
-        
+
         while i < count do
           lcd.set_cursor(c1, l1)
           lcd.write_4_bits(rand_matrix(prng), true)
@@ -44,7 +44,7 @@ def rand_matrix(prng)
           i += 1
         end
       end
-      
+
   end
 end
 

CharLcd.rb renamed to lib/charlcd.rb

@@ -1,5 +1,8 @@
 require 'pi_piper'
 
+# code based on:
+# https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code/blob/master/Adafruit_CharLCD/Adafruit_CharLCD.py
+
 class CharLcd
   # commands
   LCD_CLEARDISPLAY = 0x01
@@ -38,67 +41,67 @@ class CharLcd
   LCD_1LINE = 0x00
   LCD_5x10DOTS = 0x04
   LCD_5x8DOTS = 0x00
-  
+
   def initialize(pin_rs = 25, pin_e = 24, pins_db = [23, 17, 27, 22])
     @pin_rs = PiPiper::Pin.new(:pin => pin_rs, :direction => :out)
     @pin_e = PiPiper::Pin.new(:pin => pin_e, :direction => :out)
     @pins_db = []
-    
+
     pins_db.each { |pin_db| @pins_db.push(PiPiper::Pin.new(:pin => pin_db, :direction => :out)) }
-    
+
     write_4_bits(0x33) # initialization
     write_4_bits(0x32) # initialization
     write_4_bits(0x28) # 2 line 5x7 matrix
     write_4_bits(0x0C) # turn cursor off 0x0E to enable cursor
     write_4_bits(0x06) # shift cursor right
-    
+
     @display_control = LCD_DISPLAYON | LCD_CURSOROFF | LCD_BLINKOFF
 
-    @display_function = LCD_4BITMODE | LCD_1LINE | LCD_5x8DOTS 
+    @display_function = LCD_4BITMODE | LCD_1LINE | LCD_5x8DOTS
     @display_function |= LCD_2LINE
 
     # Initialize to default text direction (for romance languages)
     @display_mode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDECREMENT
     write_4_bits(LCD_ENTRYMODESET | @display_mode) # set the entry mode
-    
+
     clear
   end
-  
+
   def begin(cols, lines)
     if lines > 1
       @number_lines = lines
       @display_function |= LCD_2LINE
     end
   end
-  
+
   def home
     write_4_bits(LCD_RETURNHOME)
     delay_microseconds(3000)
   end
-  
+
   def clear
     write_4_bits(LCD_CLEARDISPLAY) # command to clear display
     delay_microseconds(3000)	# 3000 microsecond sleep, clearing the display takes a long time
   end
-  
+
   def set_cursor(col, row)
     row_offsets = [0x00, 0x40, 0x14, 0x54]
-    
+
     row = @number_lines - 1 if (row > @number_lines)
-    
+
     write_4_bits(LCD_SETDDRAMADDR | col + row_offsets[row])
   end
-  
+
   def no_display
     @display_control &= ~LCD_DISPLAYON
     write_4_bits(LCD_DISPLAYCONTROL | @display_control)
   end
-  
+
   def display
     @display_control |= LCD_DISPLAYON
   	write_4_bits(LCD_DISPLAYCONTROL | @display_control)
   end
-  
+
   def no_cursor
     @display_control &= ~LCD_CURSORON
     write_4_bits(LCD_DISPLAYCONTROL | @display_control)
@@ -146,7 +149,7 @@ def no_autoscroll
     @display_mode &= ~LCD_ENTRYSHIFTINCREMENT
     write_4_bits(LCD_ENTRYMODESET | @display_mode)
   end
-  
+
   def message(text)
     text.each_char do |char|
       if char.eql?("\n")
@@ -156,7 +159,7 @@ def message(text)
       end
     end
   end
-  
+
   def write_4_bits(bits, char_mode = false)
     delay_microseconds(1000)
 
@@ -174,18 +177,18 @@ def write_4_bits(bits, char_mode = false)
 
     pulse_enable
   end
-  
+
   def pulse_enable
     @pin_e.off
     delay_microseconds(1)
     @pin_e.on
     delay_microseconds(1)
     @pin_e.off
   end
-  
+
   def delay_microseconds(microseconds)
     seconds = microseconds/1_000_000.0
     sleep(seconds)
   end
-  
-end
+
+end