Arduino LCDMenuLib2 (LCDML)

A versatile menu library for Arduino, supporting various LCD types (row displays, graphic displays, console output).

Table of Contents

1. Features
2. Installation
3. Code reference
4. Forum Link
5. Images
6. License

Features

• Supports up to 254 menu elements per layer.
• Tree-based structure (parent, child, sibling).
• Requires a minimum of 3 buttons (up, down, enter).
• Supports 6 predefined buttons (up, down, left, right, back/quit, enter).
• Handles 64 custom events, such as button clicks or other triggers. This events could be combined with a special handling to open a defined menu function when the status is changed.
• Screensaver support after a configurable timeout.
• Displays a scrollbar when menu elements exceed display rows.
• Allows dynamic parameter changes directly from the menu.
• Separation of structural and functional level
• Setting of special conditions to diplay elements
• Can be used for statemashines with jumping function between menu elements
• Provides examples for various LCD libraries and functionalities.

Installation

Arduino IDE -> Library Installation

1. Search into the Arduino Library for "LCDMenuLib2".
2. Follow the installation instruction.

Arduino IDE -> Installation by ZIP file

1. Download the library from the GitHub repository.
2. Open the Arduino IDE.
3. Go to Sketch > Include Library > Add .ZIP Library.
4. Select the downloaded .zip file and click Open.

PlatformIO

1. Add the following to your platformio.ini file:

   lib_deps =
       Jomelo/LCDMenuLib2
   

LCDML Code Reference

• https://github.com/Jomelo/LCDMenuLib2/wiki/Code-Reference

Forum-Link

Description (German): http://forum.arduino.cc/index.php?topic=73816.0

Images

20x4 LCD

glcd with u8glib

serial monitor for testing or programming without a connected display

License

MIT License

Copyright (c) [2025] [Nils Feldkämper]

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.