# OrangePi-OLED

**Repository Path**: shandetr/OrangePi-OLED

## Basic Information

- **Project Name**: OrangePi-OLED
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-14
- **Last Updated**: 2025-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SH1106 / SSD1306 OLED Driver.

Based on Richard Hulls original repo (https://github.com/rm-hull) adapted to Orange Pi single board computers.

Interfacing OLED matrix displays with the SH1106 (or SSD1306) driver in Python using
I2C on Orange Pi SBCs. 

## Pre-requisites

This was tested with Armbian on an Orange Pi Zero, with Mainline Kernel .

Install some packages(most should be already installed):

    $ sudo apt-get install i2c-tools python-smbus python-pip python-dev python-imaging

Next check that the device is communicating properly:

    $ i2cdetect -y 0
         0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
    00:          -- -- -- -- -- -- -- -- -- -- -- -- --
    10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
    20: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
    30: -- -- -- -- -- -- -- -- -- -- -- -- 3c -- -- --
    40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
    50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
    60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
    70: -- -- -- -- -- -- -- --

# Installing the Python Package

From the bash prompt, enter:

    $ sudo python setup.py install

This will install the python files in `/usr/local/lib/python2.7`
making them ready for use in other programs.

# Software Display Driver

The screen can be driven with python using the _oled/device.py_ script.
There are two device classes and usage is very simple if you have ever
used [Pillow](http://pillow.readthedocs.org/en/latest/) or PIL.

First, import and initialise the device:

```python
from oled.device import ssd1306, sh1106
from oled.render import canvas
from PIL import ImageFont, ImageDraw

# substitute sh1106(...) below if using that device
device = ssd1306(port=1, address=0x3C)
```

The display device should now be configured for use. The specific `ssd1306` or 
`sh1106` classes both expose a `display()` method which takes a 1-bit depth image. 
However, for most cases, for drawing text and graphics primitives, the canvas class
should be used as follows:

```python
with canvas(device) as draw:
    font = ImageFont.load_default()
    draw.rectangle((0, 0, device.width, device.height), outline=0, fill=0)
    draw.text(30, 40, "Hello World", font=font, fill=255)
```

The `canvas` class automatically creates an [ImageDraw](http://pillow.readthedocs.org/en/latest/reference/ImageDraw.html) 
object of the correct dimensions and bit depth suitable for the device, so you
may then call the usual Pillow methods to draw onto the canvas.

As soon as the with scope is ended, the resultant image is automatically
flushed to the device's display memory and the ImageDraw object is
garbage collected.

Run the demos in the example directory:

    $ python examples/demo.py
    $ python examples/sys_info.py
    $ python examples/pi_logo.py
    $ python examples/maze.py

Note that `python-dev` (apt-get) and `psutil` (pip) are required to run the `sys_info.py`
example. See [install instructions](https://github.com/rm-hull/ssd1306/blob/master/examples/sys_info.py#L3-L7)
for the exact commands to use.

# References

* https://learn.adafruit.com/monochrome-oled-breakouts
* https://github.com/adafruit/Adafruit_Python_SSD1306
* http://www.dafont.com/bitmap.php
* http://raspberrypi.znix.com/hipidocs/topic_i2cbus_2.htm
* http://martin-jones.com/2013/08/20/how-to-get-the-second-raspberry-pi-i2c-bus-to-work/

# License

The MIT License (MIT)

Copyright (c) 2015 Richard Hull

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.