UserInterfaceMenu.h File Reference

Subroutines for UserInterfaceMenu. More...

Go to the source code of this file.

Enumerations
enum	menuResult_t { MENU_RES_NORMAL = 0, MENU_RES_PROG = 1, MENU_RES_SHUTDOWN = 2, MENU_RES_BACK = 3 }
	Enum used for return values from sub menus. More...
enum	menuStartup_t { MENU_STARTUP_NORMAL = 0, MENU_STARTUP_PROG = 1 }
	Enum used for startup menu. More...
enum	menuNormal_t {   MENUE_NORMAL_CLOCK_OPERATION = 0, MENUE_NORMAL_QUICK_OPERATION = 1, MENUE_NORMAL_TIME_FACTOR = 2, MENUE_NORMAL_START_TIME = 3,   MENUE_NORMAL_CURRENT_TIME = 4, MENUE_NORMAL_TARGET_TIME = 5, MENUE_NORMAL_PROG = 6, MENUE_NORMAL_SHUTDOWN = 7 }
	Enum used for Normal Menu (normal operation). More...
enum	menuProg_t { MENUE_PROGRAM_PULSE_WIDTH = 0, MENUE_PROGRAM_SET0 = 1, MENUE_PROGRAM_NORMAL = 2, MENUE_PROGRAM_SHUTDOWN = 3 }
	Enum used for Program Menu. More...
enum	menuShutdown_t { MENU_SHUTDOWN_BACK = 0, MENU_SHUTDOWN_SHUTDOWN = 1 }
	Enum used for Shutdown Menu. More...
enum	menuFastFwd_t { MENU_FASTFWD_START = 0, MENU_FASTFWD_NULL = 1, MENU_FASTFWD_BACK = 2 }
	Enum used for Fast Forward Menu to select between Start Time or 00:00. More...
enum	menuNormalClock_t { MENU_NORMAL_START = 0, MENU_NORMAL_BACK = 1, MENU_NORMAL_STOP = 2 }
	Enum used for Normal Clock Menu. More...
enum	menuSetTime_t { MENU_SET_MINUTE = 0, MENU_SET_HOUR = 1, MENU_SET_BACK = 2 }
	Enum used for Menus where Hour and Minute of a time value are modified. More...
enum	menuSet0_t { MENU_SET0_BACK = 0, MENU_SET0_SET0 = 1 }
	Enum used for Menu setting time to midnight. More...

Functions
void	UserInterfaceBasicInit (void)
	Init all the basic HW and. More...
void	UserInterfaceMenuWelcome (void)
	Send a welcome message to LCD. More...
menuResult_t	UserInterfaceMenuStartup (void)
	Display Startup Menu ("Init") and initialize from EEPROM. More...
menuResult_t	UserInterfaceMenuNormal (void)
	Normal operation. More...
menuResult_t	UserInterfaceMenuProg (void)
	Display Programming Menu ("Progr"). More...
menuResult_t	UserInterfaceMenuShutdown (void)
	Prepare shutdown. More...
void	UserInterfaceMenuEndOfSoap (void)
	Shutdown, write to EEPROM and display EndOfSoap. More...

Detailed Description

Subroutines for UserInterfaceMenu.

This includes:

• Init Clock from EEPROM and check
• Initmenu
• Handler

Target:

• AtMega128 on PROTO_128 and AtMega48/88/168

Software

• AVR-GCC

History:

• 070312 First implementation (R 0)
• 150427 StS: Refactoring (Push button functionality), code cleanup

Version

$Id: UserInterfaceMenu.h 159 2016-09-03 06:51:47Z pischky $

Author

Bernd Wisotzki [BA] wsb56.nosp@m.@use.nosp@m.rs.so.nosp@m.urce.nosp@m.forge.nosp@m..net

Date

11-Mar-2007

Copyright

Copyright (C) 2007 Bernd Wisotzki

Definition in file UserInterfaceMenu.h.

Enumeration Type Documentation

enum menuFastFwd_t

Enum used for Fast Forward Menu to select between Start Time or 00:00.

Enumerator
MENU_FASTFWD_START	"SvSrt" | Schneller Vorlauf bis Startzeit
MENU_FASTFWD_NULL	"SvNul" | Schneller Vorlauf bis 00:00
MENU_FASTFWD_BACK	"Zurck" | Zurueck

Definition at line 109 of file UserInterfaceMenu.h.

enum menuNormal_t

Enum used for Normal Menu (normal operation).

Enumerator
MENUE_NORMAL_CLOCK_OPERATION	"NmUhr" | Normaler Uhrbetrieb
MENUE_NORMAL_QUICK_OPERATION	"NmSvr" | Schneller Vorlauf bis __
MENUE_NORMAL_TIME_FACTOR	"NmVkz" | Zeitverkuerzung
MENUE_NORMAL_START_TIME	"NmSZt" | Startzeit
MENUE_NORMAL_CURRENT_TIME	"NmAZt" | Aktuelle Zeit einstellen
MENUE_NORMAL_TARGET_TIME	"NmZZt" | Zielzeit
MENUE_NORMAL_PROG	"Progr" | Programmierung
MENUE_NORMAL_SHUTDOWN	"Shutd" | Shutdown

Definition at line 77 of file UserInterfaceMenu.h.

enum menuNormalClock_t

Enum used for Normal Clock Menu.

Enumerator
MENU_NORMAL_START	"Start" | Uhr Start
MENU_NORMAL_BACK	"Zurck" | Zurueck
MENU_NORMAL_STOP	"Stop " | Uhr Stoppen

Definition at line 118 of file UserInterfaceMenu.h.

enum menuProg_t

Enum used for Program Menu.

Enumerator
MENUE_PROGRAM_PULSE_WIDTH	"PrPuB" | Einstellen Pulsbreite
MENUE_PROGRAM_SET0	"PrSe0" | Aktuelle Zeit auf 00:00
MENUE_PROGRAM_NORMAL	"Norml" | Normalbetrieb
MENUE_PROGRAM_SHUTDOWN	"Shutd" | Shutdown

Definition at line 91 of file UserInterfaceMenu.h.

enum menuResult_t

Enum used for return values from sub menus.

Enumerator
MENU_RES_NORMAL	User has selected "Norml" in sub menu.
MENU_RES_PROG	User has selected "Progr" in sub menu.
MENU_RES_SHUTDOWN	User has selected "Shutd" in sub menu.
MENU_RES_BACK	User has selected "Zurck" in sub menu.

Definition at line 58 of file UserInterfaceMenu.h.

enum menuSet0_t

Enum used for Menu setting time to midnight.

Enumerator
MENU_SET0_BACK	"Zurck" | Zurueck
MENU_SET0_SET0	"PrSe0" | Aktuelle Zeit auf 00:00

Definition at line 136 of file UserInterfaceMenu.h.

enum menuSetTime_t

Enum used for Menus where Hour and Minute of a time value are modified.

Enumerator
MENU_SET_MINUTE	"Minte" | Minute einstellen
MENU_SET_HOUR	"Stnde" | Stunde einstellen
MENU_SET_BACK	"Zurck" | Zurueck

Definition at line 127 of file UserInterfaceMenu.h.

enum menuShutdown_t

Enum used for Shutdown Menu.

Enumerator
MENU_SHUTDOWN_BACK	"Zurck" | Zurueck
MENU_SHUTDOWN_SHUTDOWN	"Shutd" | Shutdown

Definition at line 101 of file UserInterfaceMenu.h.

enum menuStartup_t

Enum used for startup menu.

Compatible to menuResult_t.

Enumerator
MENU_STARTUP_NORMAL	"Norml" | Normalbetrieb
MENU_STARTUP_PROG	"Progr" | Programmierung

Definition at line 69 of file UserInterfaceMenu.h.

Function Documentation

void UserInterfaceBasicInit

(

void

)

Init all the basic HW and.

Definition at line 71 of file UserInterfaceMenu.c.

Here is the call graph for this function:

void UserInterfaceMenuEndOfSoap

(

void

)

Shutdown, write to EEPROM and display EndOfSoap.

Definition at line 252 of file UserInterfaceMenu.c.

Here is the call graph for this function:

menuResult_t UserInterfaceMenuNormal

(

void

)

Normal operation.

Display Normal Operation Menu ("Norml").

Returns

user selection: MENU_RES_PROG or MENU_RES_SHUTDOWN

Definition at line 147 of file UserInterfaceMenu.c.

Here is the call graph for this function:

menuResult_t UserInterfaceMenuProg

(

void

)

Display Programming Menu ("Progr").

Returns

user selection: MENU_RES_NORMAL or MENU_RES_SHUTDOWN

Definition at line 184 of file UserInterfaceMenu.c.

Here is the call graph for this function:

menuResult_t UserInterfaceMenuShutdown

(

void

)

Prepare shutdown.

Display Shutdown Menu ("Shutd").

Returns

user selection: MENU_RES_BACK or MENU_RES_SHUTDOWN

Definition at line 218 of file UserInterfaceMenu.c.

Here is the call graph for this function:

menuResult_t UserInterfaceMenuStartup

(

void

)

Display Startup Menu ("Init") and initialize from EEPROM.

Reads EEPROM first and check for valid data. When data is valid NORMAL is preselected otherwise PROG is preselected.

Returns

user selection: MENU_RES_NORMAL or MENU_RES_PROG

Definition at line 110 of file UserInterfaceMenu.c.

Here is the call graph for this function:

void UserInterfaceMenuWelcome

(

void

)

Send a welcome message to LCD.

Definition at line 85 of file UserInterfaceMenu.c.

Here is the call graph for this function: