menumanagement.cpp

/*
 * La Box Project
 * MenuManagement Class 
 * The purpose of this class is to organize the operation menu. 
 * This is where the actions or choices selected by the user are executed.
 * 
 * @Author : Cedric Bellec
 * @Organization : Locoduino.org
 */
#include "defines.h"
#include "DCC.h"
#include "TrackManager.h"

#ifdef USE_HMI
#include "hmi.h"
#include "LaboxModes.h"
#include "menumanagement.h"
#include "menuobject.h"
#include "menuinformation.h"
#include "menuTrainAddrRead.h"
#include "menuTrainCvRead.h"
#include "menuTrainCvWrite.h"
#include "menuDecoderIdentification.h"
#include "menuShuttleSample.h"
#include "menuDcDccMode.h"

extern enumHMIState  _HMIState ;
extern enumHMIState  _HMIState_prev;
extern enumEvent     _HMIEvent;

/*!
    @brief  Constructor
    @param  None
    @return None (void).
    @note
*/
MenuManagement::MenuManagement(hmi*  screen)
{
  display           = (Adafruit_SSD1306*) screen;

  baseMenu      = new menuObject(display, NULL, TXT_MenuParams, MENUTYPELIST);
  onOffLine     = new menuObject(display, baseMenu, TXT_MenuDCCOffLine, MENUTYPELIST);
    onOffLineOn = new menuObject(display, onOffLine, TXT_MenuOnLine,   0);
    onOffLineOff= new menuObject(display, onOffLine, TXT_MenuOffLine,  1);
  trainAddrRead = new menuTrainAddrRead(display, baseMenu, TXT_MenuAddrRead,  MENUTRAINADDRREAD);
  trainCVRead 	= new menuTrainCvRead(display, baseMenu, TXT_MenuCVRead,  MENUTRAINCVREAD);
  trainCVWrite 	= new menuTrainCvWrite(display, baseMenu, TXT_MenuCVWrite,  MENUTRAINCVWRITE);
  trainIdent	 	= new menuDecoderIdentification(display, baseMenu, TXT_MenuIdent,  MENUTRAINIDENT);
  shuttle	 			= new menuShuttleSample(display, baseMenu, TXT_MenuShuttle,  MENUSHUTTLESAMPLE);
  //dcMode	 			= new menuDcDccMode(display, baseMenu, TXT_DcDccMode,  MENUDCDCCMODE);
  TrainView     = new menuObject(display, baseMenu, TXT_TrainView, MENUTYPELIST);
    V1Train     = new menuObject(display, TrainView, TXT_V1Train,  1);
    V2Trains    = new menuObject(display, TrainView, TXT_V2Trains, 2);
    V3Trains    = new menuObject(display, TrainView, TXT_V3Trains, 3);
  physicalMes   = new menuInformation(display, baseMenu, TXT_PhysicalMes, MENUACTION);    // Classe à définir
  lstEvent      = new menuObject(display, baseMenu, TXT_LstEvent, MENUACTION);
  info					= new menuObject(display, baseMenu, TXT_MenuInfos, MENUTYPELIST);
  	about				= new menuInformation(display, info, TXT_MenuAbout, MENUINFORMATION_ABOUT);
    wifiInfo    = new menuInformation(display, info, TXT_MenuWifiInfo, MENUINFORMATION_WIFI);
#ifdef ENABLE_EXCOMM
    exCommInfo  = new menuInformation(display, info, TXT_MenuEXCOMMInfo, MENUINFORMATION_EXCOMM);
#endif
  reset         = new menuObject(display, baseMenu, TXT_MenuSoftReset, MENUTYPELIST);
    resetConfirm= new menuObject(display, reset, TXT_MenuResetConfirm, MENUACTION);
}
/*!
    @brief  begin
            i.e. Setup
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::begin()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::begin.. Begin"); 

  baseMenu->begin();    // Recursive call, all sub menu will execute this fonction

  resetMenu();
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::begin.. End");   
}
  
/*!
    @brief  update
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::update()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::update.. Begin"); 

  if(activeMenu == 0) activeMenu = baseMenu;
  
  activeMenu->update();

  _HMIDEBUG_FCT_PRINTLN("MenuManagement::update.. End");   
}
/*!
    @brief  BtnUpPressed
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::BtnUpPressed()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnUpPressed.. Begin"); 

  activeMenu->eventUp();
  // Return value is important to know witch action has been Selected


  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnUpPressed.. End"); 
}
/*!
    @brief  BtnDownPressed
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::BtnDownPressed()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnDownPressed.. Begin"); 

  activeMenu->eventDown();

  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnDownPressed.. End");   
}
/*!
    @brief  BtnSelectPressed
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::BtnSelectPressed()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnSelectPressed.. Begin"); 

  int status = activeMenu->eventSelect();
	
	if (LaboxModes::progMode) 
	{
		return;
	}

  switch(status)
  {
    case MENUEXIT:
      _HMIDEBUG_LEVEL1_PRINT("Exit menu ");_HMIDEBUG_LEVEL1_PRINTLN(activeMenu->caption);
      if(activeMenu->parent)
      {
        activeMenu->resetMenu();
        activeMenu = activeMenu->parent;
      }else
      {
        _HMIState = StateExitMenu;
      }
    	break;

    case MENUCHANGETOCHILD:
      _HMIDEBUG_LEVEL1_PRINT("Change menu from ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
      _HMIDEBUG_LEVEL1_PRINT(" to ");_HMIDEBUG_LEVEL1_PRINTLN(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
      activeMenu = activeMenu->subMenu[activeMenu->SelectListIndex];
      activeMenu->parent->resetMenu();
			break;

    case MENUTRAINADDRREAD:
    case MENUTRAINCVREAD:
    case MENUTRAINCVWRITE:
    case MENUTRAINIDENT:
    case MENUSHUTTLESAMPLE:
    case MENUDCDCCMODE:
      _HMIDEBUG_LEVEL1_PRINT("Change menu from ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
      _HMIDEBUG_LEVEL1_PRINT(" to ");_HMIDEBUG_LEVEL1_PRINTLN(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
      activeMenu = activeMenu->subMenu[activeMenu->SelectListIndex];
      activeMenu->start();
			break;

    case MENUCHOSEN :
      _HMIDEBUG_LEVEL1_PRINT("Menu choice ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);_HMIDEBUG_LEVEL1_PRINT(" has been made : ");
      _HMIDEBUG_LEVEL1_PRINTLN(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
      activeMenu = activeMenu->subMenu[activeMenu->SelectListIndex];

			bool found = false;
			switch(activeMenu->value)
			{
				case MENUINFORMATION_ABOUT:
				case MENUINFORMATION_WIFI:
				case MENUINFORMATION_EXCOMM:
					_HMIDEBUG_LEVEL1_PRINT("Change sub menu to ");_HMIDEBUG_LEVEL1_PRINTLN(activeMenu->caption);
					activeMenu->start();
					found = true;
					break;
			}

			if (found)
				break;

			if(activeMenu == onOffLine)
			{
				_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
				_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
				_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");        
			}else
			if(activeMenu == onOffLineOn)
			{
				_HMIDEBUG_LEVEL1_PRINT("Choice menu Line ON");
				if (LaboxModes::progMode == true)
					TrackManager::setProgPower(POWERMODE::ON);
				else
					TrackManager::setMainPower(POWERMODE::ON);
				_HMIState = StateExitMenu;
			}else
			if(activeMenu == onOffLineOff)
			{
				_HMIDEBUG_LEVEL1_PRINT("Choice menu Line OFF");
				if (LaboxModes::progMode == true)
					TrackManager::setProgPower(POWERMODE::OFF);
				else
					TrackManager::setMainPower(POWERMODE::OFF);
				_HMIState = StateExitMenu;
			}else
			{
				if(activeMenu == resetConfirm)
				{
					_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
					_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
					_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");
#ifdef ARDUINO_ARCH_ESP32
					// !! Only for ESP !!
					LaboxModes::Restart(MAIN);
#endif
				}else
        {
					if(activeMenu == lstEvent)
					{
						_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
						//_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
						//_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");
						// Restore default setting
						_HMIState = StateBrowseEventLst ;
						baseMenu->resetMenu();
					}else
					{
						if(activeMenu == V1Train)
						{
							_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
							//_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
							//_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");
							// Restore default setting
							((hmi*) display)->nbTrainToView = 1 ;
							_HMIState = StateExitMenu;
						}else
            {
							if(activeMenu == V2Trains)
							{
								_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
								//_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
								//_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");
								// Restore default setting
								((hmi*) display)->nbTrainToView = 2 ;
								_HMIState = StateExitMenu;
							}else
							{
								if(activeMenu == V3Trains)
								{
									_HMIDEBUG_LEVEL1_PRINT("Choice menu found for ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->caption);
									//_HMIDEBUG_LEVEL1_PRINT(": Choice is ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->caption);
									//_HMIDEBUG_LEVEL1_PRINT(" (value : ");_HMIDEBUG_LEVEL1_PRINT(activeMenu->subMenu[activeMenu->SelectListIndex]->value);_HMIDEBUG_LEVEL1_PRINTLN(")");
									// Restore default setting
									((hmi*) display)->nbTrainToView = 3 ;
									_HMIState = StateExitMenu;
								}else
								{
									_HMIDEBUG_CRITICAL_PRINT("Critical error, no choice menu found for ");_HMIDEBUG_CRITICAL_PRINTLN(activeMenu->caption);
								}
							}
						}
          }
        }
      }
      baseMenu->resetMenu();      
      activeMenu = activeMenu->parent;
      _HMIEvent = noEvent;
    	break;
  }
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::BtnSelectPressed.. End");   
}
/*!
    @brief  resetMenu
    @param  None
    @return None (void).
    @note
*/
void MenuManagement::resetMenu()
{
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::resetMenu.. Begin"); 
  _HMIDEBUG_LEVEL1_PRINTLN("Menu Reset");

  baseMenu->resetMenu();  // Recursive call, all sub menu will execute this fonction

  activeMenu = baseMenu;
  _HMIDEBUG_FCT_PRINTLN("MenuManagement::resetMenu.. End");   
}
#endif