ssd1306-ruby's Introduction

SSD1306

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

Add this line to your application's Gemfile:

gem 'SSD1306'

And then execute:

$ bundle

Or install it yourself as:

$ gem install SSD1306

Usage

Using the library is simple. To start with, require the library and initialize the display:

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:

disp = SSD1306::Display.new(protocol: :i2c, path: '/dev/i2c-1', address: 0x3C, width: 128, height: 64)

Writing text on the display is simple:

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:

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!

The display can also be easily cleared:

disp.clear
disp.display!

# Or more simply:
disp.clear!

Check out the source code for additional information.

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

After checking out the repo, run bundle install to install dependencies. Then, run rake test to run the tests. 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.

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

ssd1306-ruby's People

Stargazers

Watchers

ssd1306-ruby's Issues

rmagick dependency

Any chance you could fork this project to use a more lightweight library than imagemagick via rmagick? It's just that imagemagick and libmagickwand-dev are a thousand times bigger than this actual gem. Lots of precious storage for what might perhaps be achieved using simpler packages. I don't need a million fonts and ghostscript and tiff support and exif and the whole of libcairo2 and and and...

I'd even take a version that's fed "hardcoded" bitmaps which I would pre-produce separately...

require 'SSD1306' fails

Running this on my raspberry pi with ruby 2.1.5p273 and the gems:
i2c (0.4.0)
rmagick (2.15.4)
SSD1306 (0.5.1)

Fails at runtime on line 1.

/usr/lib/ruby/2.1.0/rubygems/core_ext/kernel_require.rb:55:in 'require': cannot load such file --``SSD1306 (LoadError)
from /usr/lib/ruby/2.1.0/rubygems/core_ext/kernel_require.rb:55:in 'require'
from displaytest.rb:1:in <main>

error on raspbery pi

Hello,
I use 128x32 on Raspberry Pi , i get this error:

var/lib/gems/2.1.0/gems/SSD1306-0.6.1/lib/SSD1306/display.rb:144:in pack': no implicit conversion of nil into Integer (TypeError) from /var/lib/gems/2.1.0/gems/SSD1306-0.6.1/lib/SSD1306/display.rb:144:in display!'

I install without any error

gem install SSD1306

Fetching: SSD1306-0.6.1.gem (100%)
Successfully installed SSD1306-0.6.1
Parsing documentation for SSD1306-0.6.1
Installing ri documentation for SSD1306-0.6.1
Done installing documentation for SSD1306 after 17 seconds
1 gem installed

Device or resource busy (Beaglebone Black)

Hi,

I'm using a brand new BBB running Debian, and I'm trying to initialise the display thus:

disp = SSD1306::Display.new protocol: :i2c, path: '/dev/i2c-1', address: 0x7B
Errno::EBUSY: Device or resource busy @ rb_io_syswrite - /dev/i2c-1

The address I've got from the back of the OLED, it's one of two options (the other being 0x7A) and this one is jumper-set.

I don't know how to check the device tree, but this is the first I2C connection I'm making on this new board, so I wouldn't think it's already used by something else?

Recommend Projects

zeiv / ssd1306-ruby Goto Github PK