Display Functions

Functions
void	start_display ()
	Begins SPI communication with the display. More...
void	print_menu_6 (String title, String opt1, String opt2, String opt3, String opt4, String opt5, String opt6)
	Prints a formatted menu screen with a numbered 6-option list. More...
void	print_menu_5 (String title, String opt1, String opt2, String opt3, String opt4, String opt5)
	Prints a formatted menu screen with a numbered 5-option list. More...
void	print_menu_4 (String title, String opt1, String opt2, String opt3, String opt4)
	Prints a formatted menu screen with a numbered 4-option list. More...
void	print_menu_3 (String title, String opt1, String opt2, String opt3)
	Prints a formatted menu screen with a numbered 3-option list. More...
void	print_menu_2 (String title, String opt1, String opt2)
	Prints a formatted menu screen with a numbered 2-option list. More...
void	print_message_2 (String title, String opt1, String opt2)
	Print a titled screen with two lines of centered text. More...
void	print_message_3 (String title, String opt1, String opt2, String opt3)
	Print a titled screen with three lines of centered text. More...
void	print_menu_4_nobk (String title, String opt1, String opt2, String opt3, String opt4)
	Prints a formatted menu screen, numbered 4-option list, NO back option. More...
void	print_pause_screen (String d_string, String t_string, String h_string, String l_string)
	Print the standard pause screen. More...
void	print_confirm_screen (String title, String msg1, String msg2, String opt1)
	Prints a confirmation screen. More...
void	print_tuning (String title, String hi_note, String low_note, String drone_note, String tromp_note, String tpose_str, String capo_str)
	Print a full list of the given tuning with a confirmation option. More...
void	print_tuning_summary (int hi, int lo, int tromp, int drone)
	Print a string-only list of a given tuning with a confirmation option. More...
void	print_tuning_choice_3 (String title, int opt1, int opt2, int opt3)
	Print a 3-option tuning choice screen. More...
void	print_value_selection (String title, String value)
	Print a numerical value selection. More...
void	about_screen ()
	Draws the about screen. More...
void	startup_screen_sequence ()
	Draws the startup animation sequence. More...
#define	OLED_MOSI   43
	The MOSI/DATA pin to the screen. More...
#define	OLED_CLK   45
	The CLK/SCL/SCK pin to the screen. More...
#define	OLED_DC   46
	The DC pin to the screen. More...
#define	OLED_CS   44
	The CS pin to the screen. More...
#define	OLED_RESET   47
	The RESET pin to the screen. More...

Detailed Description

These functions concern controlling the display, and drawing formatted screens for use in menu screen fucntions elsewhere.

Macro Definition Documentation

OLED_CLK

#define OLED_CLK   45

The CLK/SCL/SCK pin to the screen.

OLED_CS

#define OLED_CS   44

The CS pin to the screen.

OLED_DC

#define OLED_DC   46

The DC pin to the screen.

OLED_MOSI

#define OLED_MOSI   43

The MOSI/DATA pin to the screen.

OLED_RESET

#define OLED_RESET   47

The RESET pin to the screen.

Function Documentation

about_screen()

void about_screen

(

)

Draws the about screen.

print_confirm_screen()

void print_confirm_screen	(	String	title,
		String	msg1,
		String	msg2,
		String	opt1
	)

Prints a confirmation screen.

Prints "X"/2 for back/done option, 1 to confirm

Parameters

title	Screen title
msg1	Message/question, line 1
msg2	Message, line 2
opt1	The affirmative option text (e.g. "Yes", "Continue", "Save")

print_menu_2()

void print_menu_2	(	String	title,
		String	opt1,
		String	opt2
	)

Prints a formatted menu screen with a numbered 2-option list.

Prints "X"/3 for back/done option, 1-2 for choices

Parameters

title	Menu title
opt1	First option text
opt2	Second option text

print_menu_3()

void print_menu_3	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3
	)

Prints a formatted menu screen with a numbered 3-option list.

Prints "X"/4 for back/done option, 1-3 for choices

Parameters

title	Menu title
opt1	First option text
opt2	Second option text
opt3	Third option text

print_menu_4()

void print_menu_4	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3,
		String	opt4
	)

Prints a formatted menu screen with a numbered 4-option list.

Prints "X"/5 for back/done option, 1-4 for choices

Parameters

title	Menu title
opt1	First option text
opt2	Second option text
opt3	Third option text
opt4	Fourth option text

print_menu_4_nobk()

void print_menu_4_nobk	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3,
		String	opt4
	)

Prints a formatted menu screen, numbered 4-option list, NO back option.

Parameters

title	Menu title
opt1	First option text
opt2	Second option text
opt3	Third option text
opt4	Fourth option text

print_menu_5()

void print_menu_5	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3,
		String	opt4,
		String	opt5
	)

Prints a formatted menu screen with a numbered 5-option list.

Prints "X"/6 for back/done option, 1-5 for choices

Parameters

title	Menu title
opt1	First option text
opt2	Second option text
opt3	Third option text
opt4	Fourth option text
opt5	Fifth option text

print_menu_6()

void print_menu_6	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3,
		String	opt4,
		String	opt5,
		String	opt6
	)

Prints a formatted menu screen with a numbered 6-option list.

Prints "X" for back/done option, 1-6 for choices

Parameters

title	Menu title
opt1	First option text
opt2	Second option text
opt3	Third option text
opt4	Fourth option text
opt5	Fifth option text
opt6	Sixth option text

print_message_2()

void print_message_2	(	String	title,
		String	opt1,
		String	opt2
	)

Print a titled screen with two lines of centered text.

Parameters

title	Screen title
opt1	First line text
opt2	Second line text

print_message_3()

void print_message_3	(	String	title,
		String	opt1,
		String	opt2,
		String	opt3
	)

Print a titled screen with three lines of centered text.

Parameters

title	Screen title
opt1	First line text
opt2	Second line text
opt3	Third line text

print_pause_screen()

void print_pause_screen	(	String	d_string,
		String	t_string,
		String	h_string,
		String	l_string
	)

Print the standard pause screen.

Prints "X" for back/done option

Parameters

d_string	The drone note String
t_string	The trompette note String
h_string	The high melody note String
l_string	The low melody note String

print_tuning()

void print_tuning	(	String	title,
		String	hi_note,
		String	low_note,
		String	drone_note,
		String	tromp_note,
		String	tpose_str,
		String	capo_str
	)

Print a full list of the given tuning with a confirmation option.

Prints "X"/2 for back/done option, 1 to confirm

Parameters

title	Screen title
hi_note	High melody note
low_note	Low melody note
drone_note	Drone note
tromp_note	Trompette note
tpose_str	Transpose offset
capo_str	Capo offset

print_tuning_choice_3()

void print_tuning_choice_3	(	String	title,
		int	opt1,
		int	opt2,
		int	opt3
	)

Print a 3-option tuning choice screen.

Prints "A" for default choice

Parameters

title	Screen title
opt1	Default tuning note number choice
opt2	Tuning note number choice 2
opt3	Tuning note number choice 3

print_tuning_summary()

void print_tuning_summary	(	int	hi,
		int	lo,
		int	tromp,
		int	drone
	)

Print a string-only list of a given tuning with a confirmation option.

Prints "X"/2 for back/done option, "A"/1 to confirm

Parameters

hi	High melody note number
lo	Low melody note number
tromp	Trompette note number
drone	Drone note number

print_value_selection()

void print_value_selection	(	String	title,
		String	value
	)

Print a numerical value selection.

Prints "X" for back/done option

Parameters

title	Screen title
value	Value to display

start_display()

void start_display

(

)

Begins SPI communication with the display.

startup_screen_sequence()

void startup_screen_sequence

(

)

Draws the startup animation sequence.