charlcd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cbc4292fd38b43c45cfb88b22055fc74d64de5a
+  data.tar.gz: f13e769873d974d025b28ec509a53a49a1218910
+SHA512:
+  metadata.gz: 9441545dfbc039f090819b2223ed93863e709104877c2d0e5cbca9ba460719fb1f0ec38223f7307bb677d21840a0053359cb6c4f8f3e6a6bce63d450f2e11f44
+  data.tar.gz: a1a0fc7cc7dda2db692981094045a9c7ee723c97cac5d5f29f53306b7cf9e9a70626104321068f6b1242ecbad552185d59029e3908e5daea98f43e8c9470113c

data/README.md

@@ -0,0 +1,31 @@
+CharLcd
+=======
+
+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
+
+install:
+```
+sudo gem install charlcd
+```
+
+usage:
+``` ruby
+require 'charlcd'
+
+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.

data/examples/charlcd_matrix_example.rb

@@ -0,0 +1,52 @@
+require 'charLcd'
+
+SLEEP_TIME = 0.005
+COLUMNS = 16
+LINES = 2
+
+lcd = CharLcd.new
+lcd.begin(COLUMNS, LINES)
+
+lcd.blink
+
+prng = Random.new
+
+def rand_matrix(prng)
+  prng.rand(2).zero? ? prng.rand(33..127) : prng.rand(161..253)
+end
+
+(0..100).each do
+  c = prng.rand(COLUMNS)
+  for l in 0...LINES
+
+      count = prng.rand(5)
+      i = 0
+      while i < count
+        lcd.set_cursor(c, l)
+        lcd.write_4_bits(rand_matrix(prng), true)
+        lcd.set_cursor(c, l)
+        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)
+          lcd.set_cursor(c1, l1)
+          sleep(SLEEP_TIME)
+          i += 1
+        end
+      end
+
+  end
+end
+
+lcd.no_blink
+lcd.clear

data/lib/charlcd.rb

@@ -0,0 +1,194 @@
+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
+  LCD_RETURNHOME = 0x02
+  LCD_ENTRYMODESET = 0x04
+  LCD_DISPLAYCONTROL = 0x08
+  LCD_CURSORSHIFT = 0x10
+  LCD_FUNCTIONSET = 0x20
+  LCD_SETCGRAMADDR = 0x40
+  LCD_SETDDRAMADDR = 0x80
+
+  # flags for display entry mode
+  LCD_ENTRYRIGHT = 0x00
+  LCD_ENTRYLEFT = 0x02
+  LCD_ENTRYSHIFTINCREMENT = 0x01
+  LCD_ENTRYSHIFTDECREMENT = 0x00
+
+  # flags for display on/off control
+  LCD_DISPLAYON = 0x04
+  LCD_DISPLAYOFF = 0x00
+  LCD_CURSORON = 0x02
+  LCD_CURSOROFF = 0x00
+  LCD_BLINKON = 0x01
+  LCD_BLINKOFF = 0x00
+
+  # flags for display/cursor shift
+  LCD_DISPLAYMOVE = 0x08
+  LCD_CURSORMOVE = 0x00
+  LCD_MOVERIGHT = 0x04
+  LCD_MOVELEFT = 0x00
+
+  # flags for function set
+  LCD_8BITMODE = 0x10
+  LCD_4BITMODE = 0x00
+  LCD_2LINE = 0x08
+  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_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)
+  end
+
+  def cursor
+    @display_control |= LCD_CURSORON
+    write_4_bits(LCD_DISPLAYCONTROL | @display_control)
+  end
+
+  def blink
+    @display_control |= LCD_BLINKON
+    write_4_bits(LCD_DISPLAYCONTROL | @display_control)
+  end
+
+  def no_blink
+    @display_control &= ~LCD_BLINKON
+    write_4_bits(LCD_DISPLAYCONTROL | @display_control)
+  end
+
+  def scroll_display_left
+    write_4_bits(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVELEFT)
+  end
+
+  def scroll_display_right
+    write_4_bits(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT)
+  end
+
+  def left_to_right
+    @display_mode |= LCD_ENTRYLEFT
+    write_4_bits(LCD_ENTRYMODESET | @display_mode)
+  end
+
+  def right_to_left
+    @display_mode &= ~LCD_ENTRYLEFT
+    write_4_bits(LCD_ENTRYMODESET | @display_mode)
+  end
+
+  def autoscroll
+    @display_mode |= LCD_ENTRYSHIFTINCREMENT
+    write_4_bits(LCD_ENTRYMODESET | @display_mode)
+  end
+
+  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")
+        write_4_bits(0xC0)
+      else
+        write_4_bits(char.ord, true)
+      end
+    end
+  end
+
+  def write_4_bits(bits, char_mode = false)
+    delay_microseconds(1000)
+
+    bits = bits.to_s(2).rjust(8, "0")
+
+    @pin_rs.update_value(char_mode)
+
+    @pins_db.each { |pin_db| pin_db.off }
+    (0..3).each { |i| @pins_db.reverse[i].on if bits[i].eql?("1") }
+
+    pulse_enable
+
+    @pins_db.each { |pin_db| pin_db.off }
+    (4..7).each { |i| @pins_db.reverse[i - 4].on if bits[i].eql?("1") }
+
+    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

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: charlcd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Fernando Fussuma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies: []
+description: A lcd display library compatible with the hd44780 controller on the raspberrypi
+email: fernandofussuma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/charlcd_matrix_example.rb
+- lib/charlcd.rb
+homepage: https://github.com/fernandofussuma/CharLcd-ruby-raspberry-pi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Lcd display raspberrypi library!
+test_files: []