UserInterfaceMenu.c

Go to the documentation of this file.

/*
    Copyright (C) 2007 Bernd Wisotzki

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
*/

/* -- System wide includes -------------------------------------------------- */
#include <stdint.h>         // typedef uint8_t

/* -- Special Includes e.g. Onboard or direct attached Equipment ------------ */
//TODO: cleanup of imports, add comments what is imported
#include <avr/io.h> // _BV()
#include "sysdef.h" // #define SERIAL_OUT_ON
#include "ClockKernel.h" // clock kernel
#include "PushButton.h"  // push buttons
#include "uart.h" // log_init(), #define LOG(), #define LOG_P()
#include "UserInterfaceCommonData.h" // init, shutdown
#include "UserInterfaceLcd.h" // LCD
#include "UserInterfaceMenuNormal.h"
#include "UserInterfaceMenuProgram.h"
#include "UserInterfaceMenu.h"

/* -- Standard functions ---------------------------------------------------- */

void UserInterfaceBasicInit(void)
{
    ClockKernelInit();      //Init pulse generator
    PushButtonInit();       //Init push buttons
    UserInterfaceLcdInit(); //Init LCD

    #if defined SERIAL_OUT_ON
        log_init();
    #endif
}

void UserInterfaceMenuWelcome(void)
{
    UserInterfaceLcdWelcome();

    LOG_P("\n\r***Welcome*********************************************************:\n\r");
    LOG_P("Start einer neuen Runde:\n\r");
    LOG_P("\n\r");

    // single shot enter
    for(;;)
    {
        if (PushButtonSingleShotEnter())
        {
            return;
        }
    }
}

menuResult_t UserInterfaceMenuStartup(void)
{
    menuStartup_t ucbut1 = MENU_STARTUP_NORMAL;
    uint8_t ucinitresult = 0;

    ucinitresult = UserInterfaceCommonDataInit(); //Get the EEPROM data
    if (ucinitresult != _BV(SYSTEM_STATUS_DIRTY)) //only dirty bit? -> normal
    {
        ucbut1 = MENU_STARTUP_PROG;               //                -> else
    }

    LOG_P("\n\rUserInterfaceMenuStartup ");
    LOG_P("\n\r");

    for(;;)
    {
        UserInterfaceLcdStartup(ucbut1, ucinitresult);
        ucbut1 = (menuStartup_t) PushButtonGetUpDownValue(ucbut1,
                                                          MENU_STARTUP_NORMAL,
                                                          MENU_STARTUP_PROG);

        // single shot enter
        if (PushButtonSingleShotEnter())
        {
            switch (ucbut1) {
                case MENU_STARTUP_NORMAL: return MENU_RES_NORMAL;
                case MENU_STARTUP_PROG  : return MENU_RES_PROG;
            }
        }
    }
}

menuResult_t UserInterfaceMenuNormal(void)
{
    menuNormal_t ucbut1 = MENUE_NORMAL_CLOCK_OPERATION;

    LOG_P("\n\rUserInterfaceMenuNormal");
    LOG_P("\n\r");

    for(;;)
    {
        UserInterfaceLcdNormal(ucbut1);
        ucbut1 = (menuNormal_t) PushButtonGetUpDownValue(ucbut1,
                                                   MENUE_NORMAL_CLOCK_OPERATION,
                                                   MENUE_NORMAL_SHUTDOWN);

        // single shot enter
        if (PushButtonSingleShotEnter())
        {
            switch (ucbut1)
            {
                case MENUE_NORMAL_CLOCK_OPERATION: UserInterfaceMenueNormalClock(); break;
                case MENUE_NORMAL_QUICK_OPERATION: UserInterfaceMenueNormalQuick(); break;
                case MENUE_NORMAL_TIME_FACTOR    : UserInterfaceMenueNormalTimeFactor(); break;
                case MENUE_NORMAL_START_TIME     : UserInterfaceMenueNormalStartTime(); break;
                case MENUE_NORMAL_CURRENT_TIME   : UserInterfaceMenueNormalCurrentTime(); break;
                case MENUE_NORMAL_TARGET_TIME    : UserInterfaceMenueNormalTargetTime(); break;
                case MENUE_NORMAL_PROG           : return MENU_RES_PROG; break;
                case MENUE_NORMAL_SHUTDOWN       : return MENU_RES_SHUTDOWN; break;
            }
        }
    }
}

menuResult_t UserInterfaceMenuProg(void)
{
    menuProg_t ucbut1 = MENUE_PROGRAM_PULSE_WIDTH;

    LOG_P("\n\rUserInterfaceMenuProg");
    LOG_P("\n\r");

    // single shot enter
    for(;;)
    {
        UserInterfaceLcdProg(ucbut1);
        ucbut1 = (menuProg_t) PushButtonGetUpDownValue(ucbut1,
                                                   MENUE_PROGRAM_PULSE_WIDTH,
                                                   MENUE_PROGRAM_SHUTDOWN);

        if (PushButtonSingleShotEnter())
        {
            switch (ucbut1)
            {
                case MENUE_PROGRAM_PULSE_WIDTH: UserInterfaceMenueProgramPulseWidth(); break;
                case MENUE_PROGRAM_SET0       : UserInterfaceMenuProgramSet0(); break;
                //case MENUE_NORMAL_START_TIME: UserInterfaceMenueNormalStartTime(); break;
                case MENUE_PROGRAM_NORMAL     : return MENU_RES_NORMAL; break;
                case MENUE_PROGRAM_SHUTDOWN   : return MENU_RES_SHUTDOWN; break;
            }
        }
    }
}

menuResult_t UserInterfaceMenuShutdown(void)
{
    menuShutdown_t ucbut1 = MENU_SHUTDOWN_BACK;

    LOG_P("\n\rAustieg mit: ");
    LOG_P("\n\r");

    for(;;)
    {
        UserInterfaceLcdShutdown(ucbut1);
        ucbut1 = (menuShutdown_t) PushButtonGetUpDownValue(ucbut1,
                                                     MENU_SHUTDOWN_BACK,
                                                     MENU_SHUTDOWN_SHUTDOWN);

        // single shot enter
        if (PushButtonSingleShotEnter())
        {
            switch(ucbut1)
            {
                case MENU_SHUTDOWN_BACK    : return MENU_RES_BACK;
                case MENU_SHUTDOWN_SHUTDOWN: return MENU_RES_SHUTDOWN;
            }
        }
        // single shot back
        if (PushButtonSingleShotBack())
        {
            return MENU_RES_BACK;
        }
    }
}

void UserInterfaceMenuEndOfSoap(void)
{
    ClockSetStatus(0);

    UserInterfaceCommonDataShutDown();

    LOG_P("\n\rEndOfSoap!!\n\r\n\r");

    UserInterfaceLcdEndOfSoap();
    // program will terminate by reaching end on main()
}