OLEDMenuUI

📌 Introduction

OLEDMenuUI is a lightweight, highly customizable menu library for Arduino boards equipped with SSD1306 128x32 I2C OLED displays. Designed for microcontrollers with limited resources, it provides smooth navigation, dynamic submenus, EEPROM-based settings storage, and integrated sensor display support.

🧠 Features

• Clean menu UI with scrolling and rounded selector
• Navigation with 4 push buttons (UP, DOWN, SELECT, BACK)
• EEPROM storage for persistent settings (Sound & Brightness)
• Sensor integration support (DHT11, HC-SR04)
• Custom callbacks for menu items and submenus
• Adjustable brightness & buzzer feedback
• Modular and extensible code structure

🖥️ Compatible Boards

Board	Status
Arduino Uno	✅ Fully Supported
Arduino Nano	✅ Fully Supported
Arduino Mega	✅ Fully Supported
ESP8266 (NodeMCU)	✅ Tested & Supported
ESP32	🧪 Partial Support (Under Testing)

⚙️ Hardware Requirements

• SSD1306 128x32 OLED Display (I2C)
• 4 Push Buttons (UP, DOWN, SELECT, BACK)
• DHT11 Sensor (for Temp & Humidity - optional)
• HC-SR04 Ultrasonic Sensor (optional)
• Buzzer (optional, for click sound)

🔌 Pin Configuration (Example)

BUTTON_UP     → D2
BUTTON_DOWN   → D3
BUTTON_SELECT → D4
BUTTON_BACK   → D5
BUZZER_PIN    → D6
DHT11         → D7
HC-SR04 TRIG  → D8
HC-SR04 ECHO  → D9
OLED SDA/SCL  → A4/A5 (for Uno/Nano)
    

📦 Installation

1. Clone this repository into your Arduino libraries folder:
   git clone https://github.com/sudoyasir/OLEDMenuUI
2. Install dependencies via Library Manager:
   • Adafruit GFX Library
   • Adafruit SSD1306
   • DHT Sensor Library (by Adafruit)
3. Restart Arduino IDE.

🧪 Example

You can find full working demo in examples/. It includes:

• Real-time sensor reading display (temperature, humidity, distance)
• About screen
• Settings submenu with persistent toggles

📘 API Overview

• begin() – Initializes the menu
• setMenuItems(items[], count) – Sets menu options
• setCallback(func) – Called on selection
• setBackCallback(func) – Called on back button
• setBeepEnabled(bool) – Enable/disable buzzer
• setBrightnessLevel(uint8_t) – Adjust OLED brightness
• update() – Call in loop to render and detect input

📁 Repository

Visit the GitHub repo:
github.com/sudoyasir/OLEDMenuUI

📜 License

This project is licensed under the MIT License.

🙋‍♂️ Author

Developed by @sudoyasir. Contributions are welcome!