SSD1306 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3d5d18f7a2e5779d4012cf46d9b2fd360b50ace
+  data.tar.gz: eb30c0843ae433c37199fa7d65dd96cf1eb9cbde
+SHA512:
+  metadata.gz: 73e2bd0cb47e00b06f23518a077dea41d3ded2ce74a1df79969d1d6ff2325981706b9c4d5b45cacc9530963a76337740042bbe7ef57573366e806cf518ff1604
+  data.tar.gz: efd128641d18c0664b55d38027a7f527560590257add7ebbb9da3a55f8feb9b074d3c2367368f5764f97845b4d0865fab871663d31fbc431d963ff8b71b48932

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Xavier Bick
+
+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.md

@@ -0,0 +1,43 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'SSD1306'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install SSD1306
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec SSD1306` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zeiv/SSD1306-ruby.
+
+## Acknowledgements
+
+This library is inspired by the Adafruit SSD1306 Python library, available here: https://github.com/adafruit/Adafruit_Python_SSD1306
+
+## License
+
+Copyright (c) 2016 Xavier Bick under the MIT License.  See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/SSD1306.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'SSD1306/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "SSD1306"
+  spec.version       = SSD1306::VERSION
+  spec.authors       = ["Xavier Bick"]
+  spec.email         = ["fxb9500@gmail.com"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{A library for the SSD1306 OLED Display}
+  spec.description   = %q{Use this library to interface to an SSD1306 OLED via I2C or SPI.  It was developed with the Raspberry Pi in mind, but should work on any device with I2C or SPI.}
+  spec.homepage      = "https://github.com/zeiv/SSD1306-ruby"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "i2c", ">= 0.4.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "SSD1306"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/SSD1306

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "SSD1306"

data/lib/SSD1306.rb

@@ -0,0 +1,155 @@
+require "i2c"
+
+require "SSD1306/version"
+
+# Constants
+SSD1306_I2C_ADDRESS = 0x3C	# 011110+SA0+RW - 0x3C or 0x3D
+SSD1306_SETCONTRAST = 0x81
+SSD1306_DISPLAYALLON_RESUME = 0xA4
+SSD1306_DISPLAYALLON = 0xA5
+SSD1306_NORMALDISPLAY = 0xA6
+SSD1306_INVERTDISPLAY = 0xA7
+SSD1306_DISPLAYOFF = 0xAE
+SSD1306_DISPLAYON = 0xAF
+SSD1306_SETDISPLAYOFFSET = 0xD3
+SSD1306_SETCOMPINS = 0xDA
+SSD1306_SETVCOMDETECT = 0xDB
+SSD1306_SETDISPLAYCLOCKDIV = 0xD5
+SSD1306_SETPRECHARGE = 0xD9
+SSD1306_SETMULTIPLEX = 0xA8
+SSD1306_SETLOWCOLUMN = 0x00
+SSD1306_SETHIGHCOLUMN = 0x10
+SSD1306_SETSTARTLINE = 0x40
+SSD1306_MEMORYMODE = 0x20
+SSD1306_COLUMNADDR = 0x21
+SSD1306_PAGEADDR = 0x22
+SSD1306_COMSCANINC = 0xC0
+SSD1306_COMSCANDEC = 0xC8
+SSD1306_SEGREMAP = 0xA0
+SSD1306_CHARGEPUMP = 0x8D
+SSD1306_EXTERNALVCC = 0x1
+SSD1306_SWITCHCAPVCC = 0x2
+
+# Scrolling constants
+SSD1306_ACTIVATE_SCROLL = 0x2F
+SSD1306_DEACTIVATE_SCROLL = 0x2E
+SSD1306_SET_VERTICAL_SCROLL_AREA = 0xA3
+SSD1306_RIGHT_HORIZONTAL_SCROLL = 0x26
+SSD1306_LEFT_HORIZONTAL_SCROLL = 0x27
+SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL = 0x29
+SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL = 0x2A
+
+class SSD1306
+  attr_accessor :protocol, :path, :address, :width, :height
+
+  def initialize(opts = {})
+    default_options = {
+      protocol: :i2c,
+      path: '/dev/i2c-1',
+      address: 0x3C,
+      width: 128,
+      height: 64
+    }
+    options = default_options.merge(opts)
+
+    # Attributes for attr_accessor
+    @protocol = options[:protocol]
+    @path = options[:path]
+    @address = options[:address]
+    @width = options[:width]
+    @height = options[:height]
+
+    # Variables needed internally
+    @pages = @height / 8
+    @buffer = [0]*(@width*@pages)
+    if @protocol == :i2c
+      @interface = I2C.create(@path)
+    elsif @protocol == :spi
+      raise "SPI Not Supported Currently"
+    else
+      raise "Unrecognized protocol"
+    end
+
+    self.command SSD1306_DISPLAYON
+
+    # For 128 x 64 display
+    if @height == 64
+      self.command SSD1306_DISPLAYOFF
+      self.command SSD1306_SETDISPLAYCLOCKDIV
+      self.command 0x80
+      self.command SSD1306_SETMULTIPLEX
+      self.command 0x3F
+      self.command SSD1306_SETDISPLAYOFFSET
+      self.command 0x0
+      self.command(SSD1306_SETSTARTLINE | 0x0)
+      self.command SSD1306_CHARGEPUMP
+      self.command 0x10
+      #TODO VCCSTATE?
+      self.command SSD1306_MEMORYMODE
+      self.command 0x00
+      self.command(SSD1306_SEGREMAP | 0x1)
+      self.command SSD1306_COMSCANDEC
+      self.command SSD1306_SETCOMPINS
+      self.command 0x12
+      self.command SSD1306_SETCONTRAST
+      #TODO EXTERNAL VCC?
+      self.command 0x9F
+      self.command SSD1306_SETPRECHARGE
+      #TODO VCC?
+      self.command 0x22
+      self.command SSD1306_SETVCOMDETECT
+      self.command 0x40
+      self.command SSD1306_DISPLAYALLON_RESUME
+      self.command SSD1306_NORMALDISPLAY
+    end
+  end
+
+  def command(c)
+    control = 0x00
+    @interface.write @address, control, c
+  end
+
+  def data(d)
+    control = 0x40
+    @interface.write @address, control, c
+  end
+
+  def display!
+    self.command SSD1306_COLUMNADDR
+    self.command 0
+    self.command(@width - 1)
+    self.command SSD1306_PAGEADDR
+    self.command 0
+    self.command(@pages - 1)
+    # Write buffer data
+    # TODO: This works for I2C only
+    for i in range(0, @buffer.length, 16)
+      control = 0x40
+      @interface.write control, @buffer[i:i+16]
+    end
+  end
+
+  #TODO Complete image processing
+  def image(image)
+    raise "Image functionality not implemented yet"
+  end
+
+  def clear
+    @buffer = [0]*(@width*@pages)
+  end
+
+  def clear!
+    self.clear
+    self.display
+  end
+
+  #TODO Implement Contrast functionality
+  def set_contrast(contrast)
+    raise "Contrast not yet implemented"
+  end
+
+  #TODO Implement Dimming functionality
+  def dim(dim)
+    raise "Dim not implemented yet"
+  end
+end

data/lib/SSD1306/version.rb

@@ -0,0 +1,3 @@
+module SSD1306
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: SSD1306
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xavier Bick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i2c
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Use this library to interface to an SSD1306 OLED via I2C or SPI.  It
+  was developed with the Raspberry Pi in mind, but should work on any device with
+  I2C or SPI.
+email:
+- fxb9500@gmail.com
+executables:
+- SSD1306
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SSD1306.gemspec
+- bin/console
+- bin/setup
+- exe/SSD1306
+- lib/SSD1306.rb
+- lib/SSD1306/version.rb
+homepage: https://github.com/zeiv/SSD1306-ruby
+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.6.3
+signing_key: 
+specification_version: 4
+summary: A library for the SSD1306 OLED Display
+test_files: []