Skip to content

README.md

Latest commit

 

History

History
110 lines (92 loc) · 5.27 KB

README.md

File metadata and controls

110 lines (92 loc) · 5.27 KB

IrisOled Logo 3d

IrisOLED

Arduino library for robotic OLED eye expressions for SSD1306 / SH1106 and other Adafruit-GFX-compatible displays

IrisOLED provides a collection of monochrome bitmaps (robotic eye expressions and useful icons) plus a small non-blocking animation helper so you can make expressive robot eyes without blocking the rest of your code.

irisoled_all_expression

Table of contents

Features

  • 32 pre-made robotic eye expressions and icons.
  • IrisoledAnimation - a lightweight, non-blocking animation player compatible with multiple display drivers.

Install

  1. Download or clone this repository.
  2. Copy the Irisoled folder to your Arduino libraries/ directory, or use Sketch → Include Library → Add .ZIP Library... to install the ZIP.
  3. Restart the Arduino IDE.
  4. Examples will appear under File → Examples → Irisoled.

Quick Start

#include <Wire.h>
#include <Adafruit_GFX.h>
#include <Adafruit_SSD1306.h>
#include <Irisoled.h>

Adafruit_SSD1306 display(128, 64, &Wire, -1);

void setup() {
  display.begin(SSD1306_SWITCHCAPVCC, 0x3C);
  display.clearDisplay();
  // draw a full-screen bitmap stored in PROGMEM
  display.drawBitmap(0, 0, Irisoled::normal, 128, 64, WHITE);
  display.display();
}

void loop() {
}

IrisOLED Bitmaps

All bitmaps are declared under the Irisoled namespace in Irisoled.h and defined in Irisoled.cpp in PROGMEM.

Names Included

  • Irisoled::alert, Irisoled::angry, Irisoled::blink_down, Irisoled::blink_up, Irisoled::blink, Irisoled::bored, Irisoled::despair, Irisoled::disoriented,
  • Irisoled::excited, Irisoled::focused, Irisoled::furious, Irisoled::happy, Irisoled::look_down, Irisoled::look_left, Irisoled::look_right, Irisoled::look_up,
  • Irisoled::normal, Irisoled::sad, Irisoled::scared, Irisoled::sleepy, Irisoled::surprised, Irisoled::wink_left, Irisoled::wink_right, Irisoled::worried,
  • Irisoled::battery_full, Irisoled::battery_low, Irisoled::battery, Irisoled::left_signal, Irisoled::logo, Irisoled::mode, Irisoled::right_signal, Irisoled::warning.

Use display.drawBitmap(x, y, Irisoled::<name>, width, height, WHITE);

IrisOLED Animation

IrisoledAnimation is a non-blocking player that renders frames and advances on millis() without calling delay(). Its update() is templated so it works with any Adafruit-GFX-compatible display object.

Constructors

// RAM pointer array
IrisoledAnimation(const unsigned char* frames[],
                  uint8_t frameCount,
                  const uint16_t* delays = nullptr,
                  uint16_t frameDelay = 200,
                  bool loop = true);

// PROGMEM pointer-array variant (if frame-pointer array itself is in PROGMEM)
IrisoledAnimation(const unsigned char* const framesPROGMEM[],
                  uint8_t frameCount,
                  bool framesInPROGMEM,
                  const uint16_t* delays = nullptr,
                  uint16_t frameDelay = 200,
                  bool loop = true);

Public Methods

  • start(uint8_t startFrame = 0) - Start/restart from a frame.
  • stop() - Pause animation.
  • resume() - Resume if paused.
  • reset() - Reset to first frame without starting.
  • setLoop(bool loop) - Enable/disable looping.
  • setFrameDelay(uint16_t ms) - Set uniform frame delay used when no per-frame delays provided.
  • setDelays(const uint16_t* delays) - Provide array of per-frame delays (ms).
  • setFrameCallback(FrameCallback cb) - Register void cb(uint8_t newIndex) called on frame change.
  • update(display, x, y, w, h) - Call from loop(). Draws current frame to display and advances frames when their delay elapses. display can be an Adafruit_SSD1306, Adafruit_SH1106, or any driver with clearDisplay(), drawBitmap(), and display().
  • getCurrentFrame() - Get current frame index.
  • getFrameCount() - Get total number of frames.
  • isRunning() - Returns true if animation is currently playing.

Driver Compatibility and Required Libraries

The animation helper is driver-agnostic. In your sketch always include:

#include <Adafruit_GFX.h>
#include <Adafruit_SSD1306.h> // or <Adafruit_SH1106.h>

Required Libraries

These are the external libraries your sketches will depend on: