i2c-ss1602 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d9161bd943cd9df68f4959e5087ebffed8fb749
+  data.tar.gz: 9170d803a70d846ffb68f19e11d2ecb3675a23f6
+SHA512:
+  metadata.gz: 13b5ba4892663ae637fd95ca09f6f92b5748d8f2cea91f07ba8ebcc0b7080dfa287f88419e14c8f0d21459630ea9f08e87950c2a923d869bdb93dd22f39f66c5
+  data.tar.gz: bd99ac0f9c7615e9abed55a44c931ac8dd042407b34a5919fdf2ed8802f39ff5a5be5d67f816bff443adf721a4ed3f8d02763705e283e85ab5d9b6067a94cd1a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.1

data/CHANGELOG

@@ -0,0 +1,8 @@
+# Changelog for i2c-ss1602
+
+## v0.0.2
+* Update for Ruby 2.3
+* First release as Rubygem
+
+## v0.0.1
+* Initial revision

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# How to contribute
+
+I like to encourage you to contribute to the repository.
+This should be as easy as possible for you but there are a few things to consider when contributing.
+The following guidelines for contribution should be followed if you want to submit a pull request.
+
+## How to prepare
+
+* You need a [GitHub account](https://github.com/signup/free)
+* Submit an [issue ticket](https://github.com/anselmh/CONTRIBUTING.md/issues) for your issue if the is no one yet.
+  * Describe the issue and include steps to reproduce if it's a bug.
+  * Ensure to mention the earliest version that you know is affected.
+* If you are able and want to fix this, fork the repository on GitHub
+
+## Make Changes
+
+* In your forked repository, create a topic branch for your upcoming patch. (e.g. `feature--autoplay` or `bugfix--ios-crash`)
+  * Usually this is based on the master branch.
+  * Create a branch based on master; `git branch
+  fix/master/my_contribution master` then checkout the new branch with `git
+  checkout fix/master/my_contribution`.  Please avoid working directly on the `master` branch.
+* Make sure you stick to the coding style that is used already.
+* Make use of the `.editorconfig`-file if provided with the repository.
+* Make commits of logical units and describe them properly.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+
+* If possible, submit tests to your patch / new feature so it can be tested easily.
+* Assure nothing is broken by running all the tests.
+
+## Submit Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Open a pull request to the original repository and choose the right original branch you want to patch.
+  _Advanced users may install the `hub` gem and use the [`hub pull-request` command](https://github.com/defunkt/hub#git-pull-request)._
+* If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But _please do not close the issue yourself_.
+_Notice: You can [turn your previously filed issues into a pull-request here](http://issue2pr.herokuapp.com/)._
+* Even if you have write access to the repository, do not directly push or merge pull-requests. Let another team member review your pull request and approve.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) for more details

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i2c-SS1602.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(%r|^.*\.gemspec|)
+end
+
+guard 'minitest' do
+  watch(%r|^test/unit/test_(.*)\.rb|)
+  watch(%r|^lib/*\.rb|){'test/unit'}
+  watch(%r|^lib/.*/*\.rb|){'test/unit'}
+  watch(%r{^lib/.*/([^/]+)\.rb$}){|m| "test/unit/test_#{m[1]}.rb"}
+  watch(%r|^test/helper\.rb|){'test/unit'}
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicholas E. Rabenau
+
+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/README.markdown

@@ -0,0 +1,33 @@
+# SainSmart 1602 I2C driver
+
+This is a Ruby driver for the SainSmart 1602 LCD display with I2C adapter. The code was partially ported from [raspi-gpio](https://github.com/paulbarber/raspi-gpio/blob/master/lcd_display.py).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'i2c-ss1602'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install i2c-ss1602
+```
+
+## Usage
+
+```ruby
+require 'i2c/drivers/ss1602'
+display = I2C::Drivers::SS1602::Display.new('/dev/i2c-1', 0x27)
+display.clear
+display.text('Hello', 0)
+display.text('World', 1)
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/TODO.markdown

@@ -0,0 +1,2 @@
+* Figure out how to control the cursor
+* Create character set for German Umlauts and load it into the device on startup

data/bin/bargraph

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i2c/drivers/ss1602'
+
+display = I2C::Drivers::SS1602::Display.new('/dev/i2c-1', 0x27)
+
+x = ARGV[0].to_f
+r = (0..100)
+
+unless r.include?(x)
+  STDERR.puts "#{x} is not within the acceptable range of #{r}"
+  exit 1
+end
+
+char = ARGV[1] || '#'
+
+bar = char * (x / 100 * display.cols)
+clean_bar = sprintf('%-1$*2$s', bar, display.cols)
+display.text(clean_bar, 0)

data/bin/spritz

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i2c/drivers/ss1602'
+
+trap('INT'){
+  exit
+}
+
+ARGF.binmode
+
+begin
+  display = I2C::Drivers::SS1602::Display.new('/dev/i2c-1', 0x27)
+
+  ARGF.each do |line|
+    line.split.each do |arg|
+      display.off
+      display.text(arg, 0, true)
+      display.on
+      sleep 0.5
+    end
+  end
+ensure
+  display.clear if display
+end

data/bin/ss1602

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+#
+# Sample use:
+#
+# TZ='Europe/Berlin' date "+%d.%m.%Y      %H:%M Uhr   24'C" | bin/ss1602
+#
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'i2c/drivers/ss1602'
+
+trap('INT'){
+  exit
+}
+
+ARGF.binmode
+txt = ARGF.read
+
+d = I2C::Drivers::SS1602::Display.new('/dev/i2c-1', 0x27)
+
+# Spread text over lines
+(0..(d.rows - 1)).each do |row|
+  x0 = row * d.cols
+  x1 = x0 + d.cols - 1
+
+  output = (txt[x0..x1] || '').chomp
+  d.text(output, row, true)
+end

data/i2c-ss1602.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'i2c/drivers/ss1602/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'i2c-ss1602'
+  spec.version       = I2C::Drivers::SS1602::VERSION
+  spec.authors       = ['Nicholas E. Rabenau']
+  spec.email         = ['nerab@gmx.at']
+  spec.description   = %q{Ruby driver for the SainSmart 1602 LCD display with I2C adapter}
+  spec.summary       = %q{Driver for the SainSmart 1602 LCD display}
+  spec.homepage      = 'https://github.com/nerab/i2c-ss1602'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'i2c'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'fakefs'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry-byebug'
+end

data/lib/i2c/drivers/ss1602.rb

@@ -0,0 +1,10 @@
+require_relative 'ss1602/version'
+require_relative 'ss1602/display'
+
+module I2C
+  module Drivers
+    module SS1602
+      # Your code goes here...
+    end
+  end
+end

data/lib/i2c/drivers/ss1602/display.rb

@@ -0,0 +1,173 @@
+require 'i2c'
+
+module I2C
+  module Drivers
+    module SS1602
+      #
+      # Driver class for the SainSmart 1602 I2C LCD Display.
+      #
+      # see https://github.com/andec/i2c
+      #
+      # Parts copied from https://github.com/paulbarber/raspi-gpio/blob/master/lcd_display.py
+      #
+      class Display
+        attr_reader :rows, :cols, :cursor
+
+        def initialize(bus_or_bus_name, device_address)
+          if bus_or_bus_name.respond_to?(:write)
+            @device = BusDevice.new(bus_or_bus_name, device_address)
+          else
+            @device = BusDevice.new(I2C.create(bus_or_bus_name), device_address)
+          end
+
+          @rows = 2
+          @cols = 16
+
+          init_sequence
+
+          @cursor = Cursor.new(self)
+        end
+
+        def clear
+          write(COMMAND_CLEARDISPLAY)
+          write(COMMAND_RETURNHOME)
+        end
+
+        def text(string, row, pad = false)
+          case row
+          when 0
+            write(0x80)
+          when 1
+            write(0xC0)
+          else
+            raise "Only rows #{0..(@rows - 1)} are supported"
+          end
+
+          # Right-pad with spaces so that the line only shows string
+          string = sprintf('%-1$*2$s', string, @cols) if pad
+
+          string.each_char do |c|
+            write(c.ord, BIT_RS)
+          end
+        end
+
+        def on
+          write(COMMAND_DISPLAYCONTROL | FLAG_DISPLAYON)
+        end
+
+        def off
+          write(COMMAND_DISPLAYCONTROL | FLAG_DISPLAYOFF)
+        end
+
+        #
+        # Send a low-level command to the display
+        #
+        def write(cmd, mode = 0)
+          write_four_bits(mode | (cmd & 0xF0))
+          write_four_bits(mode | ((cmd << 4) & 0xF0))
+        end
+
+      private
+
+        # commands
+        COMMAND_CLEARDISPLAY   = 0x01
+        COMMAND_RETURNHOME     = 0x02
+        COMMAND_ENTRYMODESET   = 0x04
+        COMMAND_DISPLAYCONTROL = 0x08
+        COMMAND_CURSORSHIFT    = 0x10
+        COMMAND_FUNCTIONSET    = 0x20
+        COMMAND_SETCGRAMADDR   = 0x40
+        COMMAND_SETDDRAMADDR   = 0x80
+
+        # flags for display entry mode
+        FLAG_ENTRYRIGHT          = 0x00
+        FLAG_ENTRYLEFT           = 0x02
+        FLAG_ENTRYSHIFTINCREMENT = 0x01
+        FLAG_ENTRYSHIFTDECREMENT = 0x00
+
+        # flags for display on/off control
+        FLAG_DISPLAYON  = 0x04
+        FLAG_DISPLAYOFF = 0x00
+        FLAG_CURSORON   = 0x02
+        FLAG_CURSOROFF  = 0x00
+        FLAG_BLINKON    = 0x01
+        FLAG_BLINKOFF   = 0x00
+
+        # flags for display/cursor shift
+        FLAG_DISPLAYMOVE = 0x08
+        FLAG_CURSORMOVE  = 0x00
+        FLAG_MOVERIGHT   = 0x04
+        FLAG_MOVELEFT    = 0x00
+
+        # flags for function set
+        FLAG_8BITMODE = 0x10
+        FLAG_4BITMODE = 0x00
+        FLAG_2LINE    = 0x08
+        FLAG_1LINE    = 0x00
+        FLAG_5x10DOTS = 0x04
+        FLAG_5x8DOTS  = 0x00
+
+        # flags for backlight control
+        FLAG_BACKLIGHT   = 0x08
+        FLAG_NOBACKLIGHT = 0x00
+
+        BIT_EN = 0b00000100 # Enable bit
+        BIT_RW = 0b00000010 # Read/Write bit
+        BIT_RS = 0b00000001 # Register select bit
+
+        class BusDevice
+          def initialize(bus, address)
+            @bus, @address = bus, address
+          end
+
+          def write(data)
+            @bus.write(@address, data)
+          end
+        end
+
+        class Cursor
+          def initialize(display)
+            @display = display
+          end
+
+          def on
+            @display.write(COMMAND_DISPLAYCONTROL | FLAG_CURSORON)
+          end
+
+          def off
+            @display.write(COMMAND_DISPLAYCONTROL | FLAG_CURSOROFF)
+          end
+        end
+
+        def init_sequence
+          write(0x03)
+          write(0x03)
+          write(0x03)
+          write(0x02)
+
+          write(COMMAND_FUNCTIONSET | FLAG_2LINE | FLAG_5x8DOTS | FLAG_4BITMODE)
+
+          on
+          clear
+          write(COMMAND_ENTRYMODESET | FLAG_ENTRYLEFT)
+          sleep(0.2)
+        end
+
+        #
+        # Clocks EN to latch command
+        #
+        def strobe(data)
+          @device.write(data | BIT_EN | FLAG_BACKLIGHT)
+          sleep(0.0005)
+          @device.write(((data & ~BIT_EN) | FLAG_BACKLIGHT))
+          sleep(0.001)
+        end
+
+        def write_four_bits(data)
+          @device.write(data | FLAG_BACKLIGHT)
+          strobe(data)
+        end
+      end
+    end
+  end
+end

data/lib/i2c/drivers/ss1602/version.rb

@@ -0,0 +1,7 @@
+module I2C
+  module Drivers
+    module SS1602
+      VERSION = '0.0.2'
+    end
+  end
+end

data/test/extensions/fakefs.rb

@@ -0,0 +1,7 @@
+module FakeFS
+  class File < StringIO
+    def ioctl(integer_cmd, arg)
+      # do nothing
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require_relative '../lib/i2c/drivers/ss1602'
+
+class MiniTest::Test
+  def initialize(name = nil)
+    @test_name = name
+    super(name) unless name.nil?
+  end
+
+  def fixture(name = @test_name)
+    File.join(File.dirname(__FILE__), 'fixtures', name)
+  end
+end

data/test/unit/test_item.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require 'fakefs/safe'
+require_relative '../extensions/fakefs'
+require 'fileutils'
+
+class TestDisplay < MiniTest::Test
+  def setup
+    FakeFS.activate!
+
+    @io = fixture
+    FileUtils.mkdir_p(File.dirname(@io))
+    FileUtils.touch(@io)
+
+    @display = I2C::Drivers::SS1602::Display.new(@io, 0x42)
+  end
+
+  def teardown
+    FakeFS.deactivate!
+  end
+
+  def test_clear
+    @display.clear
+    s = File.read(@io).unpack('B*')
+
+    # Not sure why assert_equal chokes if FakeFs is still active
+    FakeFS.deactivate!
+    assert_equal('TBD', s)
+  end
+
+  def test_text_0
+    @display.text('FOOBAR', 0)
+    s = File.read(@io).unpack('B*')
+
+    FakeFS.deactivate!
+    assert_equal('TBD', s)
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: i2c-ss1602
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nicholas E. Rabenau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i2c
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: guard-bundler
+  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: guard-minitest
+  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: fakefs
+  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: pry
+  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: byebug
+  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: pry-byebug
+  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'
+description: Ruby driver for the SainSmart 1602 LCD display with I2C adapter
+email:
+- nerab@gmx.at
+executables:
+- bargraph
+- spritz
+- ss1602
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- TODO.markdown
+- bin/bargraph
+- bin/spritz
+- bin/ss1602
+- i2c-ss1602.gemspec
+- lib/i2c/drivers/ss1602.rb
+- lib/i2c/drivers/ss1602/display.rb
+- lib/i2c/drivers/ss1602/version.rb
+- test/extensions/fakefs.rb
+- test/helper.rb
+- test/unit/test_item.rb
+homepage: https://github.com/nerab/i2c-ss1602
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Driver for the SainSmart 1602 LCD display
+test_files:
+- test/extensions/fakefs.rb
+- test/helper.rb
+- test/unit/test_item.rb
+has_rdoc: