MAXREFDES63# Code Documentation  V01.00
8-Channel Digital Output MicroPLC
 All Files Functions Variables Macros Pages
menu.h File Reference
#include "stm32f10x.h"
#include "stdio.h"

Go to the source code of this file.

Macros

#define MAIN_MENU   0
 // Menu state machine state
 
#define WAIT_KEYPRESS   1
 // Menu state machine state
 
#define SET_CONFIG   2
 // Menu state machine state
 
#define SET_OUTPUT   3
 // Menu state machine state
 
#define KEYPRESS_ARROW_UP   240
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_DOWN   241
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_LEFT   242
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_ARROW_RIGHT   243
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 
#define KEYPRESS_END   244
 Assign up-arrow an extended ascii code which won't be used elsewhere.
 

Functions

void maxim_menu_cls (void)
 Function to clear the screen via Hyperterminal.
 
void maxim_menu_print_maxim_banner (void)
 Print standard Maxim banner at top of Hyperterminal screen.
 
void maxim_menu_print_maxim_banner_big (void)
 Print large Maxim banner at top of Hyperterminal screen.
 
void maxim_menu_print_prompt (void)
 Print a standard prompt for keyboard input " > ".
 
uint8_t maxim_menu_retrieve_keypress (void)
 Get a single keypress via Hyperterminal.
 
void maxim_menu_print_main_menu (void)
 Print the main menu listing choice of module to test.
 
void maxim_menu_print_configuration_description (void)
 Print configuration byte description.
 
void maxim_menu_print_output_data_description (void)
 Print output data byte description.
 

Detailed Description

******************************************************

Project: MAXREFDES63# Filename: menu.h Description: This module contains all the functions used to generate the menus and menu options used to run the MAXREFDES63 example firmware.

Revision History:
09-16-14 Rev 01.00 GL Initial release.


This code follows the following naming conventions:


char ch_pmod_value
char (array) s_pmod_string[16]
float f_pmod_value
int n_pmod_value
int (array) an_pmod_value[16]
u16 u_pmod_value
u16 (array) au_pmod_value[16]
u8 uch_pmod_value
u8 (array) auch_pmod_buffer[16]
unsigned int un_pmod_value
int * pun_pmod_value


Definition in file menu.h.

Macro Definition Documentation

#define KEYPRESS_ARROW_DOWN   241

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 74 of file menu.h.

#define KEYPRESS_ARROW_LEFT   242

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 75 of file menu.h.

#define KEYPRESS_ARROW_RIGHT   243

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 76 of file menu.h.

#define KEYPRESS_ARROW_UP   240

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 73 of file menu.h.

#define KEYPRESS_END   244

Assign up-arrow an extended ascii code which won't be used elsewhere.

Definition at line 77 of file menu.h.

#define MAIN_MENU   0

// Menu state machine state

Definition at line 68 of file menu.h.

#define SET_CONFIG   2

// Menu state machine state

Definition at line 70 of file menu.h.

#define SET_OUTPUT   3

// Menu state machine state

Definition at line 71 of file menu.h.

#define WAIT_KEYPRESS   1

// Menu state machine state

Definition at line 69 of file menu.h.

Function Documentation

void maxim_menu_cls ( void  )

Function to clear the screen via Hyperterminal.

Parameters
None
Return values
None

Definition at line 65 of file menu.c.

void maxim_menu_print_configuration_description ( void  )

Print configuration byte description.

Details.
Return values
None

Definition at line 222 of file menu.c.

void maxim_menu_print_main_menu ( void  )

Print the main menu listing choice of module to test.

Details.
Return values
None

Definition at line 207 of file menu.c.

void maxim_menu_print_maxim_banner ( void  )

Print standard Maxim banner at top of Hyperterminal screen.

Parameters
None
Return values
None

Definition at line 79 of file menu.c.

void maxim_menu_print_maxim_banner_big ( void  )

Print large Maxim banner at top of Hyperterminal screen.

Parameters
None
Return values
None

Definition at line 103 of file menu.c.

void maxim_menu_print_output_data_description ( void  )

Print output data byte description.

Details.
Return values
None

Definition at line 240 of file menu.c.

void maxim_menu_print_prompt ( void  )

Print a standard prompt for keyboard input " > ".

Parameters
None
Return values
None

Definition at line 136 of file menu.c.

uint8_t maxim_menu_retrieve_keypress ( void  )

Get a single keypress via Hyperterminal.

Details
Returns ascii character corresponding to keypress with some preprocessing.
Escape sequences (Arrow keys and END) are mapped to decimal 240-244 (see defines)
Characters "0"-"9" converted to numbers 0-9
Lower case "a"-"z" converted to uppercase "A"-"Z"
Parameters
None
Return values
Character,partiallydecoded.

Definition at line 163 of file menu.c.