Adafruit's LCD plate menu

A simple yet powerful library for bulding and displaying menus on Adafruit's LCD plates

Features

- Easy to use. Just 1 code lines to build and display your first menu!
- Sub-menus, any depth
- Autoscroll
- Easily run your code when a node is selected
- Dynamic menus. Build on the fly by using any data source you could imagine

Installation

pip install adafruit-lcd-plate-menu

Examples

Please take a look at the examples directory. You will find there ready-to-execute examples

Hello world

import Adafruit_CharLCD as LCD

from adafruit_lcd_plate_menu import MenuNode
from adafruit_lcd_plate_menu import CharMenuDisplay

MenuDisplay(LCD.Adafruit_CharLCDPlate(), [ MenuNode('Hello world') ]).display()

Sub-menus

import Adafruit_CharLCD as LCD

from adafruit_lcd_plate_menu import MenuNode
from adafruit_lcd_plate_menu import CharMenuDisplay

#  Instantiate and configure Adafruit's Char LCD Plate lib
adafruit_char_lcd_plate = LCD.Adafruit_CharLCDPlate()
adafruit_char_lcd_plate.set_color(0.0, 0.0, 1.0)
adafruit_char_lcd_plate.set_backlight(True)

#  Here we create ten menu nodes, each of them with ten childs
#  each of them, again, with ten sub-menus
menu_nodes = []
for x in range(1,11):
	menu = MenuNode('Menu %d' % (x))

	for y in range(1,11):
		sub_menu = MenuNode('Menu %d-%d' % (x, y))

		for z in range(1,11):
			sub_sub_menu = MenuNode('Menu %d-%d-%d' % (x,y,z))
			sub_menu.add_node(sub_sub_menu)

		menu.add_node(sub_menu)

	menu_nodes.append(menu)
		
#  This is our menu display
CharMenuDisplay(adafruit_char_lcd_plate, menu_nodes).display()

#  Enjoy trasversing the menu!

Code execution and dynamic menu building

import Adafruit_CharLCD as LCD
import requests

from adafruit_lcd_plate_menu import MenuNode
from adafruit_lcd_plate_menu import CharMenuDisplay

#  This is a payload function. When a menu node with a payload function
#  is selected, the function gets executed. This is done before rendering
#  the next menu tree, if any.
# 
#  Every payload function receives
# 
#    - menu_display: It lets you take the control of the LCD,
#      to draw, to access the underlying Adafruit library. Just return
#      when you want the main button loop to take the control back.
# 
#    - selected_node: It lets you traverse the menu and change it
#      dynamically.
# 
#    - *argvs: The *payloadFnArgvs* (if any) that you provided when creating
#      the node instance
# 
#  This payload function queries google's APIs for images matching a keyword,
#  then build a menu inside the selected_node and finally, by returning the
#  control to the menu display, that list of results is rendered.
#  
def google_menu_build(menu_display, selected_node, *argvs):
	r = requests.get('https://ajax.googleapis.com/ajax/services/search/images?v=1.0&q=' + argvs[0])
	data = r.json()

	for result in data['responseData']['results']:
		selected_node.add_node(MenuNode(result['titleNoFormatting']))

	return

#  Instantiate and configure Adafruit's Char LCD Plate lib
adafruit_char_lcd_plate = LCD.Adafruit_CharLCDPlate()
adafruit_char_lcd_plate.set_color(0.0, 0.0, 1.0)
adafruit_char_lcd_plate.set_backlight(True)

menu_nodes = []

#  This node, when rendered, will display 'Raspberry images' as its title.
#  When selected, 'google_menu_build' function will be executed and
#  'raspberry' will be provided as an argument to query google
menu_nodes.append(MenuNode('Raspberry images', None, google_menu_build, 'raspberry'))

#  Same as above, but using 'python' as query
menu_nodes.append(MenuNode('Python images', None, google_menu_build, 'python'))

#  Same as above, but using 'london' as query
menu_nodes.append(MenuNode('London images', None, google_menu_build, 'london'))

#  This is our menu display. It uses our previously defined menu as a data source and let us
#  operate with it
CharMenuDisplay(adafruit_char_lcd_plate, menu_nodes).display()

#  Enjoy adapting it!

Know issues

- This library is still under development and may be subject to change at any time. Use it at your own risk
- Currently only 16x2 char LCD is supported but that might change if people are interested