Repository files navigation

Python library to enable 128x32 pixel OLED for Raspberry Pi (both 32 and 64-bit) that utilize the SSD1306 chipset. This works as a standalone service and can run on a standard Raspberry Pi running Raspian.

This addon leverages the originalAdafruit Python SSD1306 andGPIO libraries, which have been deprecated. However, I have taken the nessassary parts out of this and bundled them into this I2C module avoiding the need for GPIO and relying on the Raspberry Pi's I2C setup.

Welcome	HA Splash	CPU	Memory	Storage	Network	Exit Screen

As well as the above screens, you can configure a static custom screen which can be fixed or animated.

If the configured text is greater than the screen size, it will scroll across the screen unless you configure it to display as lines.

Scrolling animations also supports configurable apmlitude enabling the text to wave up and down as it scrolls.

This screen can take variables to help personalise your view:

"Static_Screen_Text": "Today is {datetime}, running hassio verion {hassio.os.version} on {hostname} with IP {ip}"

The following variables are supported

This repository has been broken out to work as a standalone service and will work on a standard Raspberry Pi running Raspian. Any screens which are dependent on Home Assistant (e.g.Splash) will be automatically disabled.

The Home Assistant add-on that uses this can be accessed fromHomeAssistant_Addons

You can use 0.91 Inch 128x32 I2C module, as long as it is registered on /dev/i2c-1 which is the Rasperry Pi default.

I purchased thisMakerHawk I2C OLED Display Module I2C Screen Module 0.91" 128x32 I2C

sudo raspi-config# Interface Options > I2C

Those who want to get started quickly and conveniently may install the RPI_I2C_OLED using the following command:

curl -sSL https://raw.githubusercontent.com/crismc/rpi_i2c_oled/v1.0.4/basic-install.sh | sudo bash

This will download the latest release, and install it as a service. Once run, you can control theoled service by the following:

sudo service oled startsudo service oled stopsudo service oled restart

Initial apt-get installs:

sudo apt-get install i2c-tools git vim

Test I2C device is working:

$ i2cdetect -y 1

Install Python3 dependencies

sudo apt-get install python3-dev python3-smbus python3-pil

Checkout this code

git clone git@github.com:crismc/rpi_i2c_oled.gitcd rpi_i2c_oled

Test OLED

cd rpi_i2c_oledpython3 display.py

Copy the repo file to /etc:

sudo cp -ri ../rpi_i2c_oled /etc

Create a sym link of the service file in /etc/systemd/system, and reload it

sudo ln -s /etc/rpi_i2c_oled/oled.service /etc/systemd/system/oled.servicesudo systemctl daemon-reload

Test it out

sudo service oled startsudo service oled stopsudo service oled restart

Start on boot

sudo systemctl enable oled.service

You can modify the display of the content by editing theoptions.json file.

By default theoptions.json is loaded from the same directory as thedisplay.py.

Note: The keys are caseinsensitive

If you want to change this location, simply pass in the path to the desired config using the flags -c or --config:

python3 display.py -c /path/to/options.json

or

python3 display.py --config /path/to/options.json

As logging is initiated before the party begins, log levels are defined outside of theoptions.json.

Therefore, to enable debugging, when runningdisplay.py add-d or--debug to the command.

e.g.:

$python3 display.py -dINFO:Config:Loading config: /etc/rpi_i2c_oled/options.jsonINFO:Config:Home Assistant is not supported on this instanceINFO:Config:'welcome' limited to 5 iterationsINFO:__main__:'welcome' is being processedINFO:Screen:'WelcomeScreen' createdINFO:Screen:'WelcomeScreen' rendering

Several examples of SSD1306 driven I2C OLED hardware that should work. This was originally designed specifically to work with theAdafruit SSD1306-based OLED displays. Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

• Adafruit 128x32 I2C OLED
• Adafruit 0.91" 128x32 I2C OLED - STEMMA QT / Qwiic
• Adafruit PiOLED 128x32 OLED Add-on for Raspberry Pi
• MakerHawk I2C OLED Display Module I2C Screen Module 0.91" 128x32I2C
• UCTRONICS Raspberry Pi Rack

• Special thanks toGareth Cheyne for his initial version of this project.

• Tony DiCola (RIP) andAdafruit Industries for initial implementation details, see original repo:https://github.com/adafruit/Adafruit_Python_SSD1306

• crismc - After the removal of GPIO support from Home Assistant, the referenced addon no longer worked for me, so I took the initial project apart, and smashed it together with the Adafruit I2C libraries removing the GPIO requirements. Additionally, the original build didn't work on 64-bit versions of the Raspberry Pi, nor would it work as a stand alone service.

• Ultronics

• IC2 OLED Home Assistant Add-On
• Adafruit Python SSD1306 notice to comply with distribution requirement