Data Structures
struct	menu_item
	Menu item struct. More...
struct	menu_cfg
	Menu configuration and state. More...

Enumerations
enum	page_id { PAGE_WELCOME , PAGE_PLAY_GAME , PAGE_HIGH_SCORES , PAGE_SETTINGS , PAGE_ADJUST_BRIGHTNESS , PAGE_CALIBRATE_JOYSTICK , PAGE_GAME_OVER }
	Menu page identifiers. More...

Functions
int	menu_init (struct menu_cfg *menu)
	Initializes menu and OLED display.
int	page_dispatch (struct menu_cfg *menu)
	Dispatches to the current page display function.
int	welcome_display (struct menu_cfg *menu)
	Displays the welcome page.
int	play_game_display (struct menu_cfg *menu)
	Displays the play game page.
int	high_scores_display (struct menu_cfg *menu)
	Displays the high scores page.
int	settings_display (struct menu_cfg *menu)
	Displays the settings page.
int	brightness_display (struct menu_cfg *menu)
int	calibrate_joystick_display (struct menu_cfg *menu)
int	game_over_display (struct menu_cfg *menu)
int	draw_cursor (struct menu_cfg *menu)
	Draws the cursor (">") at the current cursor position in the menu.
int	cursor_update (struct menu_cfg menu, struct io_avr_buttons btn)
	Updates the cursor position based on nav button from the IO board. Wraps around if going out of bounds.
int	page_select (struct menu_cfg menu, struct io_avr_buttons btn)
	Selects the current menu item based on nav button from the IO board.
int	set_page (struct menu_cfg *menu, enum page_id page)
	Sets the current page field in the menu struct to a specified page and calls the page_dispatch function.
int	page_back (struct menu_cfg menu, struct io_avr_buttons btn)
int	menu_handler (struct menu_cfg menu, struct io_avr_buttons btn)
	Handles menu logic (navigation, selection, page timers).

Detailed Description

Enumeration Type Documentation

◆ page_id

enum page_id

#include <menu.h>

Menu page identifiers.

Enumerator
PAGE_WELCOME
PAGE_PLAY_GAME
PAGE_HIGH_SCORES
PAGE_SETTINGS
PAGE_ADJUST_BRIGHTNESS
PAGE_CALIBRATE_JOYSTICK
PAGE_GAME_OVER

Definition at line 19 of file menu.h.

             {
  PAGE_WELCOME,
  PAGE_PLAY_GAME,
  PAGE_HIGH_SCORES,
  PAGE_SETTINGS,
  PAGE_ADJUST_BRIGHTNESS,
  PAGE_CALIBRATE_JOYSTICK,
  PAGE_GAME_OVER,
};

Function Documentation

◆ brightness_display()

int brightness_display ( struct menu_cfg * menu )

#include <menu.h>

Definition at line 114 of file menu.c.

                                             {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, SMALL_FONT, "Adjusting brightness..");
 
    return status;
}

Referenced by page_dispatch().

◆ calibrate_joystick_display()

int calibrate_joystick_display ( struct menu_cfg * menu )

#include <menu.h>

Definition at line 125 of file menu.c.

                                                      {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, SMALL_FONT, "Calibrating joystick..");
 
    return status;
}

Referenced by page_dispatch().

◆ cursor_update()

int cursor_update	(	struct menu_cfg *	menu,
		struct io_avr_buttons *	btn )

#include <menu.h>

Updates the cursor position based on nav button from the IO board. Wraps around if going out of bounds.

Parameters

[in]	menu	The menu configuration struct
[in]	btn	The button states struct

Returns: Errno.

Definition at line 178 of file menu.c.

                                                                     {
    int status = 0;
    
    static uint8_t prev_ND = 0;
    static uint8_t prev_NU = 0;
 
    // TODO: 
    // Implement modulus for wrapping around the cursor position
 
    // --- NAV DOWN ---
    if (btn->ND && !prev_ND) {
        menu->cursor_pos++;
        
        if (menu->cursor_pos >= menu->length) {
            menu->cursor_pos = 0;
        }
    }
    // --- NAV UP ---
    else if (btn->NU && !prev_NU) {
        menu->cursor_pos--;
 
        if (menu->cursor_pos < 0) {
            menu->cursor_pos = menu->length - 1;
        }
    }
 
    prev_ND = btn->ND;
    prev_NU = btn->NU;
 
    return 0;
}

Referenced by menu_handler().

◆ draw_cursor()

int draw_cursor ( struct menu_cfg * menu )

#include <menu.h>

Draws the cursor (">") at the current cursor position in the menu.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 154 of file menu.c.

                                       {
    int status = 0;
 
    for (uint8_t i = 0; i < menu->length; i++) {
        io_oled_pos(menu->oled, 2 + i, 0);
        if (i == menu->cursor_pos) {
            io_oled_print_with_font(menu->oled, SMALL_FONT, "> ");
        } else {
            // Clearing the cursor position
            for (uint8_t j = 0; j < 6; j++) {
                io_oled_write_data(menu->oled, 0x00);
            }
        }
    }
 
    return status;
}

Referenced by menu_handler(), settings_display(), and welcome_display().

◆ game_over_display()

int game_over_display ( struct menu_cfg * menu )

#include <menu.h>

Definition at line 136 of file menu.c.

                                             {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "GAME OVER");
 
    io_oled_pos(menu->oled, 2, 0);
    io_oled_print_with_font(menu->oled, SMALL_FONT, "Returning to main menu...");
 
    return status;
}

Referenced by page_dispatch().

◆ high_scores_display()

int high_scores_display ( struct menu_cfg * menu )

#include <menu.h>

Displays the high scores page.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 75 of file menu.c.

                                               {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "High scores");
 
    return status;
}

Referenced by page_dispatch().

◆ menu_handler()

int menu_handler	(	struct menu_cfg *	menu,
		struct io_avr_buttons *	btn )

#include <menu.h>

Handles menu logic (navigation, selection, page timers).

Parameters

menu	Pointer to menu configuration
btn	Pointer to button input struct

Returns: 0 on success

Handles menu logic (navigation, selection, page timers).

Parameters

[in]	menu	The menu configuration struct
[in]	btn	The button states struct

Returns: Errno.

Definition at line 340 of file menu.c.

                                                                    {
    int status = 0;
    static uint16_t game_over_timer = 0;
 
    if(menu->current_page == PAGE_GAME_OVER) {
        if(game_over_timer == 0) {
            page_dispatch(menu);
        }
        
        game_over_timer++;
 
        if(game_over_timer > 20) {
            game_over_timer = 0;
 
            // Reset to root menu
            menu->items = menu->root_items;
            menu->length = menu->root_length;
            menu->cursor_pos = 0;
 
            // Clear parent
            menu->parent_menu = TRASHCAN;
            menu->parent_length = 0;
 
            // Move back to welcome page
            menu->current_page = PAGE_WELCOME;
            page_dispatch(menu);
        }
    }
 
    // Only allow cursor movement and page selection if we're on welcome page or settings page
    if (menu->current_page == PAGE_WELCOME || menu->current_page == PAGE_SETTINGS) {
        cursor_update(menu, btn);
        draw_cursor(menu);
        page_select(menu, btn);
    }
 
    page_back(menu, btn);
 
    return status;
}

Referenced by main().

◆ menu_init()

int menu_init ( struct menu_cfg * menu )

#include <menu.h>

Initializes menu and OLED display.

Parameters

menu	Pointer to menu configuration struct

Returns: 0 on success

Initializes menu and OLED display.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 16 of file menu.c.

                                     {
    int status = 0;
 
    io_oled_init(menu->oled);
    page_dispatch(menu);
 
    return status;
}

Referenced by main().

◆ page_back()

int page_back	(	struct menu_cfg *	menu,
		struct io_avr_buttons *	btn )

#include <menu.h>

Definition at line 302 of file menu.c.

                                                                 {
    int status = 0;
    static uint8_t prev_NL = 0;
 
    if(btn->NL && !prev_NL) {
 
        // If we have a parent menu, go back to that
        if(menu->parent_menu != TRASHCAN) {
            // Restore parent
            menu->items = menu->parent_menu;
            menu->length = menu->parent_length;
            menu->cursor_pos = 0;
 
            // If we just went back to the root, clear parent pointers
            if(menu->items == menu->root_items) {
                menu->parent_menu = TRASHCAN;
                menu->parent_length = 0;
                return(set_page(menu, PAGE_WELCOME));
            }
 
            // Otherwise, go to parents page (e.g. Brightness -> Settings)
            menu->parent_menu = menu->root_items;
            menu->parent_length = menu->root_length;
            return(set_page(menu, PAGE_SETTINGS));
        }
    }
 
    prev_NL = btn->NL;
 
    return status;
}

Referenced by menu_handler().

◆ page_dispatch()

int page_dispatch ( struct menu_cfg * menu )

#include <menu.h>

Dispatches to the current page display function.

Parameters

menu	Pointer to menu configuration struct

Returns: 0 on success

Dispatches to the current page display function.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 276 of file menu.c.

                                         {
    int status = 0;
 
    switch (menu->current_page) {
    case PAGE_WELCOME:
        return welcome_display(menu);
    case PAGE_PLAY_GAME:
        return play_game_display(menu);
    case PAGE_HIGH_SCORES:
        return high_scores_display(menu);
    case PAGE_SETTINGS:
        return settings_display(menu);
    case PAGE_ADJUST_BRIGHTNESS:
        return brightness_display(menu);
    case PAGE_CALIBRATE_JOYSTICK:
        return calibrate_joystick_display(menu);
    case PAGE_GAME_OVER:
        return game_over_display(menu);
    default:
        menu->current_page = PAGE_WELCOME;
        return welcome_display(menu);
    }
 
    return status;
}

Referenced by menu_handler(), menu_init(), and set_page().

◆ page_select()

int page_select	(	struct menu_cfg *	menu,
		struct io_avr_buttons *	btn )

#include <menu.h>

Selects the current menu item based on nav button from the IO board.

Parameters

[in]	menu	The menu configuration struct
[in]	btn	The button states struct

Returns: Errno.

Definition at line 216 of file menu.c.

                                                                   {
    int status = 0;
    static uint8_t prev_NR = 0;
    
    if(btn->NR && !prev_NR) {
        // Get currently selected menu item
        // - Q: why do I need an ampersand here?
        struct menu_item *selected_item = &menu->items[menu->cursor_pos];
 
        // Save current menu as parent before moving anywhere
        menu->parent_menu = menu->items;
        menu->parent_length = menu->length;
 
        // --- Case 1: The selected item has a submenu ---
        if(selected_item->submenu != TRASHCAN) {
            // Set submenu info
            menu->items = selected_item->submenu;
            menu->length = selected_item->submenu_length;
            menu->cursor_pos = 0;
 
            // Go to the requested page
            return set_page(menu, selected_item->target_page);
        }
 
        // --- Case 2: Leaf page ---
        else {
            return set_page(menu, selected_item->target_page);
        }
    }
 
    prev_NR = btn->NR;
 
    return status;
}

Referenced by menu_handler().

◆ play_game_display()

int play_game_display ( struct menu_cfg * menu )

#include <menu.h>

Displays the play game page.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 59 of file menu.c.

                                             {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "Game in progress..");
 
    return status;
}

Referenced by page_dispatch().

◆ set_page()

int set_page	(	struct menu_cfg *	menu,
		enum page_id	page )

#include <menu.h>

Sets the current page field in the menu struct to a specified page and calls the page_dispatch function.

Parameters

[in]	menu	The menu configuration struct
[in]	page	The page to set

Returns: Errno.

Definition at line 257 of file menu.c.

                                                       {
    int status = 0;
 
    // Checking if the requested page is the current page. If so, do nothing.
    if (menu->current_page == page) {
        return status;
    }
 
    menu->current_page = page;
    page_dispatch(menu);
    
    return status;
}

Referenced by page_back(), and page_select().

◆ settings_display()

int settings_display ( struct menu_cfg * menu )

#include <menu.h>

Displays the settings page.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 91 of file menu.c.

                                            {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "Settings");
 
    io_oled_pos(menu->oled, 1, 0);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "-------------");
 
    draw_cursor(menu);
 
    // Printing menu items
    for (uint8_t i = 0; i < menu->length; i++) {
        io_oled_clear_line(menu->oled, 2 + i);
        io_oled_pos(menu->oled, 2 + i, 10);
        io_oled_print_with_font(menu->oled, SMALL_FONT, menu->items[i].name);
    }
 
    return status;
}

Referenced by page_dispatch().

◆ welcome_display()

int welcome_display ( struct menu_cfg * menu )

#include <menu.h>

Displays the welcome page.

Parameters

[in] menu The menu configuration struct

Returns: Errno.

Definition at line 30 of file menu.c.

                                           {
    int status = 0;
 
    io_oled_clear_all(menu->oled);
 
    io_oled_home(menu->oled);
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "Welcome");
 
    io_oled_pos(menu->oled, 1, 0);
    //io_oled_print_with_font(menu->oled, MEDIUM_FONT, "-------------");
    io_oled_print_with_font(menu->oled, MEDIUM_FONT, "---------");
 
    draw_cursor(menu);
 
    // Printing menu items
    for (uint8_t i = 0; i < menu->length; i++) {
        io_oled_clear_line(menu->oled, 2 + i);
        io_oled_pos(menu->oled, 2 + i, 10);
        io_oled_print_with_font(menu->oled, SMALL_FONT, menu->items[i].name);
    }
    
    return status;
}

Referenced by page_dispatch().

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ page_id

Function Documentation

◆ brightness_display()

◆ calibrate_joystick_display()

◆ cursor_update()

◆ draw_cursor()

◆ game_over_display()

◆ high_scores_display()

◆ menu_handler()

◆ menu_init()

◆ page_back()

◆ page_dispatch()

◆ page_select()

◆ play_game_display()

◆ set_page()

◆ settings_display()

◆ welcome_display()