BlueFox/lcdMenu
1
0
Fork 0
Code Issues Pull Requests Releases 1 Activity
A micropython library, which supports vertical and horizontal scrolling through menu items on both 2x16 and 4x20 LCDs
40 Commits 1 Branch 1 Tag 22 MiB
Python 100%
4b7e5723ca
Go to file
BlueFox 4b7e5723ca
Fixed small issue in an old call to time.sleep() which has been replaced by sleep() since a long time
2024-11-15 22:28:35 +01:00
examples Restructured and added starter instructions 2024-11-13 23:00:29 +01:00
images Added a first attempt for documentation 2024-11-13 21:59:07 +01:00
__init__.py Fixed small issue in an old call to time.sleep() which has been replaced by sleep() since a long time 2024-11-15 22:28:35 +01:00
LICENSE Initial commit 2024-10-30 19:41:28 +00:00
README.md Finished last todos and cleaned up README.md (removed the Roadmap Section) 2024-11-13 23:03:37 +01:00
tests.py Update tests.py 2024-11-01 21:13:06 +00:00

README.md

lcdMenu

A micropython library, which supports vertical and horizontal scrolling through menu items on both 2x16 and 4x20 liquid crystal displays

This project is the completely rewritten successor of my old (and now archived) ProgramChooser library.

It is now production-ready (tested on 2x16 displays only at the moment.)

Installation

To "install" the library on your Pico, clone the repository first using git clone. Open Thonny. There, open a file from "This computer" (thonny asks for the location after clicking on "Open"), and select the __init__.py from this repository. To get this file to your Pico's storage, choose "Save as" and choose "Raspberry Pi Pico" as the location.

Now, create a new directory called lcdMenu in the root of the Pico's file system (you can do that in the "magic" /lib folder too, makes no difference), and after that save the file there (with __init__.py being the file name).

Now you can use the library using import lcdMenu in any of your scripts!

Usage

For basic usage, you just have to create an LCD object, use it to create a lcdMenu along with some other arguments. On this newly created object, run the setup() method with your menu item list. Then, start the menu by calling the (blocking) run() method on it.

To stop a running instance of lcdMenu (started by run()), call the method stop() on it!

For further usage, see the comments above the respective method definition in question in the init.py file. These try to describe the behaviour of each parameter pretty precise. Also, have a look into the examples which can be found in the examples folder.

Gallery

Here are some of examples of how a lcdMenu will look, showcasing the amount of options you have with lcdMenu. Currently, as the library is only tested with 2x16 displays, these are the only ones showing up below - but on 4x20, it should look the same except it's bigger!

Scroll direction Cycling Title shown Initial selection Result
horizontal yes yes first With title, middle item -> forward and backward, horizontal scrolling
vertical yes no first No title, first item & cycling on -> up & down, vertical scrolling
vertical no no first No title, first item & no cycling -> only down, vertical scrolling
vertical no no middle No title, middle item -> up & down, vertical scrolling
vertical no no last No title, last item & no cycling -> only up, vertical scrolling
vertical no yes no options (first and last) With title, only one option, vertical scrolling
vertical no yes first With title, first item & no cycling -> only down, vertical scrolling
vertical no yes middle With title, middle item -> up & down, vertical scrolling
vertical no yes last With title, last item & no cycling -> only up, vertical scrolling

License

This project is licensed under the GPL-v3-or-later. A copy can be found here.