Solo Controller Documentation 1.0
Documentation for the Solo Controller
 
Loading...
Searching...
No Matches
Menu.h File Reference
#include "Canvas.h"
#include "Button.h"
#include "Sensor.h"
#include "TextBox.h"

Go to the source code of this file.

Classes

class  SoloMenu
 
class  MainMenu
 Main menu for the SoloController application. More...
 
class  SetupVolMenu
 Setup menu for the SoloController application. More...
 
class  SetupTempMenu
 Setup menu for the SoloController application. Note that the callback functions used by SetupTempMenu are contained within the CB:::SETUP::TEMP namespace. More...
 
class  SetupPID_Menu
 Setup menu for the SoloController application. Note that the callback functions used by SetupTempMenu are contained within the CB:::SETUP::PID namespace. More...
 

Namespaces

namespace  CB
 Primary namespace for SoloMenu callback functions.
 
namespace  CB::MAIN
 Callback functions used by the MainMenu class.
 
namespace  CB::SETUP
 Callback functions used by the Setup Menus.
 
namespace  CB::SETUP::VOL
 Callback functions that are specific to the SetupVolMenu class.
 
namespace  CB::SETUP::TEMP
 Callback functions that are specific to the SetupTempMenu class.
 
namespace  CB::SETUP::PID
 Callback functions that are specific to the SetupPID_Menu class.
 

Macros

#define NUM_MAINMENU_BUTTONS   0
 Number of buttons managed by the MainMenu.
 
#define NUM_SETUPVOLMENU_BUTTONS   0
 
#define NUM_SETUPTEMPMENU_BUTTONS   0
 
#define NUM_SETUPPIDMENU_BUTTONS   0
 

Typedefs

using sensorVal_t = Sensor::sensorVal_t
 

Functions

void CB::SETUP::VOL::calPoint1 (void)
 Set Calibration Point 1.
 
void CB::SETUP::VOL::calPoint2 (void)
 Set Calibration Point 2.
 
void CB::SETUP::TEMP::kettleProbe (void)
 Calibrate Kettle Probe.
 
void CB::SETUP::TEMP::chillerProbe (void)
 Calibrate Chiller Probe.
 
void CB::SETUP::PID::autoTune (void)
 
Button Callbacks

These callback methods implement button behavior for MainMenu

Parameters
None.
void CB::MAIN::kettleTempAlarmOn (void)
 
void CB::MAIN::kettleTempAlarmOff (void)
 
void CB::MAIN::kettleVolAlarmOn (void)
 
void CB::MAIN::kettleVolAlarmOff (void)
 
void CB::MAIN::chillerTempAlarmOn (void)
 
void CB::MAIN::chillerTempAlarmOff (void)
 
void CB::MAIN::elementOn (void)
 
void CB::MAIN::elementOff (void)
 
void CB::MAIN::boilModeOn (void)
 
void CB::MAIN::mashModeOn (void)
 
void CB::MAIN::pumpOn (void)
 
void CB::MAIN::pumpOff (void)
 
void CB::MAIN::auxOn (void)
 
void CB::MAIN::auxOff (void)
 
void CB::MAIN::setupButtonPressed (void)
 
Label Callbacks

These callback methods are called whenever one of the labels is "pressed"

void CB::MAIN::setBoilRate (sensorVal_t boilRate)
 Initiate Data Entry for Boil Rate.
 
void CB::MAIN::setMashTemp (sensorVal_t mashTemp)
 Initiate Data Entry for Mash Temp.
 
void CB::MAIN::setKettleTempSV (sensorVal_t kettleTempSV)
 Initiate Data Entry for Kettle Temp Set Value.
 
void CB::MAIN::setKettleVolSV (sensorVal_t kettleVolSV)
 Initiate Data Entry for Kettle Volume Set Value.
 
void CB::MAIN::setChillerTempSV (sensorVal_t chillerTempSV)
 Initiate Data Entry for Chiller Temp Set Value.
 
Common Setup Button Callbacks.

These methods switch between setup menus and submenus.

void CB::SETUP::volSetup (void)
 Switch to Volume Setup Menu.
 
void CB::SETUP::tempSetup (void)
 Switch to Temperature Setup Menu.
 
void CB::SETUP::PID_Setup (void)
 Switch to PID Setup Menu.
 
void CB::SETUP::returnToMainMenu (void)
 Return to the Main Menu.
 

Variables

SoloMenumenu
 Pointer to the current, active menu used by the application.
 
SoloMenusetupMenu
 Pointer to the current setup menu.
 

Macro Definition Documentation

◆ NUM_MAINMENU_BUTTONS

#define NUM_MAINMENU_BUTTONS   0

Number of buttons managed by the MainMenu.

◆ NUM_SETUPPIDMENU_BUTTONS

#define NUM_SETUPPIDMENU_BUTTONS   0

◆ NUM_SETUPTEMPMENU_BUTTONS

#define NUM_SETUPTEMPMENU_BUTTONS   0

◆ NUM_SETUPVOLMENU_BUTTONS

#define NUM_SETUPVOLMENU_BUTTONS   0

Typedef Documentation

◆ sensorVal_t

Variable Documentation

◆ menu

SoloMenu* menu
extern

Pointer to the current, active menu used by the application.

Initially, menu points to a MainMenu object. Later, the application may elect to point menu at another menu, such as a SetupMenu object.

◆ setupMenu

SoloMenu* setupMenu
extern

Pointer to the current setup menu.

Initially, setupMenu points to the volume setup menu. Later on, this will be updated to keep track of which setup menu has been last selected by the user.