brew.ino 47.4 KB
Newer Older
1
#define DEBUG
service-config's avatar
Mixer  
service-config committed
2

3 4 5
// ######################### CONSTANTS #########################

// ######################### SETTINGS #########################
6
// ++++++++++++++++++++++++ Heating Element Relay ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
7 8 9 10 11 12
#define HEATING_ELEMENT_DEFAULT_WINDOW_SIZE       1000
#define HEATING_ELEMENT_OUTPUT_PIN                24
#define HEATING_ELEMENT_MAX_HEAT_PWM_INTEGER      5
#define HEATING_ELEMENT_MAX_HEAT_PWM_FLOAT        5.0
#define HEATING_ELEMENT_MAX_WATTAGE               3000.0          // Minimum = 2000.0
#define HEATING_ELEMENT_AC_FREQUENCY_HZ           50.0
13

service-config's avatar
Mixer  
service-config committed
14
// ++++++++++++++++++++++++ Temperature ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
#define PT100_BASE_INPUT_PIN                      A4
#define PT100_BASE_OUTPUT_PIN                     30
#define PT100_BASE_TIME_BETWEEN_READINGS          100
#define PT100_UP_INPUT_PIN                        A5
#define PT100_UP_OUTPUT_PIN                       31
#define PT100_UP_TIME_BETWEEN_READINGS            100
#define PT100_DOWN_INPUT_PIN                      A6
#define PT100_DOWN_OUTPUT_PIN                     32
#define PT100_DOWN_TIME_BETWEEN_READINGS          100

#define PT100_BASE_DEFAULT_ADC_VMAX               1.081
#define PT100_BASE_DEFAULT_VS                     4.87
#define PT100_BASE_DEFAULT_R1_RESISTENCE          606.0
#define PT100_BASE_DEFAULT_LINE_RESISTENCE        0.7
#define PT100_BASE_DEFAULT_OPERATION_RESISTENCE   0.0
#define PT100_UP_DEFAULT_ADC_VMAX                 1.081
#define PT100_UP_DEFAULT_VS                       4.87
#define PT100_UP_DEFAULT_R1_RESISTENCE            606.0
#define PT100_UP_DEFAULT_LINE_RESISTENCE          0.7
#define PT100_UP_DEFAULT_OPERATION_RESISTENCE     0.0
#define PT100_DOWN_DEFAULT_ADC_VMAX               1.081
#define PT100_DOWN_DEFAULT_VS                     4.87
#define PT100_DOWN_DEFAULT_R1_RESISTENCE          606.0
#define PT100_DOWN_DEFAULT_LINE_RESISTENCE        0.7
#define PT100_DOWN_DEFAULT_OPERATION_RESISTENCE   0.0
40

service-config's avatar
Mixer  
service-config committed
41
// ++++++++++++++++++++++++ Mixer ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
42 43
//#define MIXER_PIN     12
//#define MIXER_MAX_POSITION   255
44

45 46 47 48 49 50 51 52
// ++++++++++++++++++++++++ Pump ++++++++++++++++++++++++
#define PUMP_PIN                                  6
#define PUMP_SPEED_STOP                           0
#define PUMP_SPEED_SLOW                           64
#define PUMP_SPEED_AVERAGE                        128
#define PUMP_SPEED_FAST                           192
#define PUMP_SPEED_MAX                            255

53
// ++++++++++++++++++++++++ Rotary Encoder ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
54 55 56 57
#define ROTARY_ENCODER_INTERRUPT_NUMBER           1    // On Mega2560 boards, interrupt 1 is on pin 3
#define ROTARY_ENCODER_CLK_PIN                    3    // Used for generating interrupts using CLK signal
#define ROTARY_ENCODER_DT_PIN                     22    // Used for reading DT signal
#define ROTARY_ENCODER_SW_PIN                     23    // Used for the push button switch
58
#define ROTARY_ENCODER_DEBOUNCE_TIME              20    // Number of miliseconds to ignore new signals a signal is received
59

60
// ++++++++++++++++++++++++ State Machine ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
61 62 63 64 65 66 67
#define SETTING_WELCOME_TIMEOUT                   100
#define SETTING_MAX_INACTIVITY_TIME               3000
#define MENU_MAX_DEPTH                            10
#define MENU_INIT_VALUES                          -1,-1,-1,-1,-1,-1,-1,-1,-1,-1
#define MENU_SIZE_MAIN_MENU                       17
#define SETTING_SERIAL_MONITOR_BAUD_RATE          9600
#define SETTING_SERIAL_MONITOR_WELCOME_MESSAGE    "Let's start Brewing!"
68

69 70 71 72 73
// ######################### LIBRARIES #########################
// ++++++++++++++++++++++++ LiquidCrystal_I2C ++++++++++++++++++++++++
#include <Wire.h>
#include <LCD.h>
#include <LiquidCrystal_I2C.h>
74

João Lino's avatar
João Lino committed
75 76 77 78 79 80 81 82 83 84 85
#define LCD_I2C_ADDR                              0x27    // <<----- Add your address here.  Find it from I2C Scanner
#define LCD_HORIZONTAL_RESOLUTION                 16
#define LCD_VERTICAL_RESOLUTION                   2
#define LCD_BACKLIGHT_PIN                         3
#define LCD_EN_PIN                                2
#define LCD_RW_PIN                                1
#define LCD_RS_PIN                                0
#define LCD_D4_PIN                                4
#define LCD_D5_PIN                                5
#define LCD_D6_PIN                                6
#define LCD_D7_PIN                                7
86 87 88 89

// ++++++++++++++++++++++++ PT100 +++++++++++++++++++++++++++++++++
#include <PT100.h>

90 91
// ++++++++++++++++++++++++ ENUM +++++++++++++++++++++++++++++++++
#include "CustomDataStructures.h"
service-config's avatar
Mixer  
service-config committed
92

93 94 95 96 97 98 99 100 101 102
// ######################### TEMPLATES #########################
// ++++++++++++++++++++++++ Debug ++++++++++++++++++++++++
template <class T> void debugPrintVar( char *name, const T& value );
template <class T> void debugPrintVar( char *name, const T& value ) {
  Serial.print("[");
  Serial.print(name);
  Serial.print(":");
  Serial.print(value);
  Serial.println("]");
}
103 104 105 106 107
void debugPrintFunction( char *name ) {
  Serial.print("++++++++++++++++++++++++ ");
  Serial.print(name);
  Serial.println("++++++++++++++++++++++++");
}
108

109
// ######################### VARIABLES #########################
110
// ++++++++++++++++++++++++ State Machine ++++++++++++++++++++++++
111 112 113 114 115 116 117
eRotaryEncoderMode      rotaryEncoderMode;
eMainMenuOptions        mainMenuOption;
ePresetsMenuOptions     presetsMenuOption;
eMaltMenuOptions        maltMenuOption;
eSettingsMenuOptions    settingsMenuOption;
eCookingStages          cookingStage;

118
// ++++++++++++++++++++++++ Global Variables ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
boolean                 cooking;
boolean                 bStageFirstRun;

int                     clockStartTime;
int                     clockCounter;
int                     clockIgnore;
boolean                 clockStart;
boolean                 clockEnd;

int                     cookTime;
int                     cookTemperature;
//cook_mode_list        cookMode;
//int                   cookMixerSpeed;
int                     cookHeatPWM;
        
int                     startpointTime;
int                     betaGlucanaseTime;
int                     debranchingTime;
int                     proteolyticTime;
int                     betaAmylaseTime;
int                     alphaAmylaseTime;
int                     mashoutTime;
int                     recirculationTime;
int                     spargeTime;
int                     boilTime;
int                     coolingTime;
        
int                     startpointTemperature;
int                     betaGlucanaseTemperature;
int                     debranchingTemperature;
int                     proteolyticTemperature;
int                     betaAmylaseTemperature;
int                     alphaAmylaseTemperature;
int                     mashoutTemperature;
int                     recirculationTemperature;
int                     spargeTemperature;
int                     boilTemperature;
int                     coolingTemperature;

//int                   menuSize;
int                     menu_position[MENU_MAX_DEPTH] = {MENU_INIT_VALUES};

boolean                 refresh;
boolean                 repaint;
163 164

// ++++++++++++++++++++++++ Interrupts ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
165
static unsigned long    lastInterruptTime;
166

167
// ++++++++++++++++++++++++ Rotary Encoder ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
168 169 170 171 172
volatile int            rotaryEncoderVirtualPosition = 0;
volatile int            rotaryEncoderMaxPosition = 1;
volatile int            rotaryEncoderMinPosition = 0;
volatile int            rotaryEncoderSingleStep = 1;
volatile int            rotaryEncoderMultiStep = 1;
173

João Lino's avatar
João Lino committed
174 175
volatile boolean        onISR = false;

176
// ++++++++++++++++++++++++ Heating Element Relay ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
177 178 179
int                     iWindowSize;             // Time frame to operate in
unsigned long           windowStartTime;
double                  dWattPerPulse;
180

181 182 183
// ++++++++++++++++++++++++ Pump ++++++++++++++++++++++++
int                     iPumpSpeed;             // Time frame to operate in

184
// ######################### INITIALIZE #########################
185
// ++++++++++++++++++++++++ Library - LiquidCrystal_I2C ++++++++++++++++++++++++
João Lino's avatar
João Lino committed
186
LiquidCrystal_I2C       lcd(LCD_I2C_ADDR, LCD_EN_PIN, LCD_RW_PIN, LCD_RS_PIN, LCD_D4_PIN, LCD_D5_PIN, LCD_D6_PIN, LCD_D7_PIN);
187 188

// +++++++++++++++++++++++ PT100 +++++++++++++++++++++++
João Lino's avatar
João Lino committed
189 190 191
PT100                   basePT100(PT100_BASE_OUTPUT_PIN, PT100_BASE_INPUT_PIN, PT100_BASE_TIME_BETWEEN_READINGS, PT100_BASE_DEFAULT_ADC_VMAX, PT100_BASE_DEFAULT_VS, PT100_BASE_DEFAULT_R1_RESISTENCE, PT100_BASE_DEFAULT_LINE_RESISTENCE, PT100_BASE_DEFAULT_OPERATION_RESISTENCE);
PT100                   upPT100(PT100_UP_OUTPUT_PIN, PT100_UP_INPUT_PIN, PT100_UP_TIME_BETWEEN_READINGS, PT100_UP_DEFAULT_ADC_VMAX, PT100_UP_DEFAULT_VS, PT100_UP_DEFAULT_R1_RESISTENCE, PT100_UP_DEFAULT_LINE_RESISTENCE, PT100_UP_DEFAULT_OPERATION_RESISTENCE);
PT100                   downPT100(PT100_DOWN_OUTPUT_PIN, PT100_DOWN_INPUT_PIN, PT100_DOWN_TIME_BETWEEN_READINGS, PT100_DOWN_DEFAULT_ADC_VMAX, PT100_DOWN_DEFAULT_VS, PT100_DOWN_DEFAULT_R1_RESISTENCE, PT100_DOWN_DEFAULT_LINE_RESISTENCE, PT100_DOWN_DEFAULT_OPERATION_RESISTENCE);
192 193

// ######################### INTERRUPTS #########################
194
void xSetupRotaryEncoder( eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep ) {
João Lino's avatar
João Lino committed
195 196 197 198 199 200
  if( newMode >= 0 ) rotaryEncoderMode = newMode;
  if( newPosition >= 0 ) rotaryEncoderVirtualPosition = newPosition;
  if( newMaxPosition >= 0 ) rotaryEncoderMaxPosition = newMaxPosition;
  if( newMinPosition >= 0 ) rotaryEncoderMinPosition = newMinPosition;
  if( newSingleStep >= 0 ) rotaryEncoderSingleStep = newSingleStep;
  if( newMultiStep >= 0 ) rotaryEncoderMultiStep = newMultiStep;
201 202
}

João Lino's avatar
João Lino committed
203
void isr ()  {    // Interrupt service routine is executed when a HIGH to LOW transition is detected on CLK
204
  unsigned long interruptTime = millis();
João Lino's avatar
João Lino committed
205 206
  unsigned long diff = interruptTime - lastInterruptTime;
  lastInterruptTime = interruptTime;
207
  
208
  // If interrupts come faster than [ROTARY_ENCODER_DEBOUNCE_TIME]ms, assume it's a bounce and ignore
João Lino's avatar
João Lino committed
209
  if (diff > ROTARY_ENCODER_DEBOUNCE_TIME) {
210
    switch(rotaryEncoderMode) {
211
  
212 213 214 215
      // Input of rotary encoder controling menus
      case eRotaryEncoderMode_Menu: {
        if (!digitalRead(ROTARY_ENCODER_DT_PIN)) {
            rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition + rotaryEncoderSingleStep);
216 217
        }
        else {
218
            rotaryEncoderVirtualPosition = rotaryEncoderVirtualPosition - rotaryEncoderSingleStep;
219
        }
220 221
        if (rotaryEncoderVirtualPosition > rotaryEncoderMaxPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMinPosition;
222
        }
223 224
        if (rotaryEncoderVirtualPosition < rotaryEncoderMinPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMaxPosition;
225 226 227 228
        }
        
        break;
      }
service-config's avatar
Mixer  
service-config committed
229
      
230 231
      // Input of rotary encoder controling time variables
      case eRotaryEncoderMode_Time: {
João Lino's avatar
João Lino committed
232
        if (!digitalRead(ROTARY_ENCODER_DT_PIN)) {
service-config's avatar
Mixer  
service-config committed
233
          if(rotaryEncoderVirtualPosition >= 60) {
234
            rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition + rotaryEncoderMultiStep);
235 236
          }
          else {
237
            rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition + rotaryEncoderSingleStep);
238 239 240
          }
        }
        else {
241
          if(rotaryEncoderVirtualPosition == rotaryEncoderMinPosition) {
service-config's avatar
Mixer  
service-config committed
242
            rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition + 60);
243 244
          }
          else {
245 246
            if(rotaryEncoderVirtualPosition >= (60 + rotaryEncoderMultiStep)) {
              rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition - rotaryEncoderMultiStep);
247 248
            }
            else {
249
              rotaryEncoderVirtualPosition = rotaryEncoderVirtualPosition - rotaryEncoderSingleStep;
250 251 252
            }
          }
        }
253 254
        if (rotaryEncoderVirtualPosition > rotaryEncoderMaxPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMaxPosition;
255
        }
256 257
        if (rotaryEncoderVirtualPosition < rotaryEncoderMinPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMinPosition;
258 259 260 261
        }
        
        break;
      }
service-config's avatar
Mixer  
service-config committed
262
      
263 264 265
      // Input of rotary encoder controling generic integer variables within a range between rotaryEncoderMinPosition and rotaryEncoderMaxPosition
      case eRotaryEncoderMode_Generic: {
        if (!digitalRead(ROTARY_ENCODER_DT_PIN)) {
266
          rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition + rotaryEncoderSingleStep);
267 268
        }
        else {
269
          rotaryEncoderVirtualPosition = (rotaryEncoderVirtualPosition - rotaryEncoderSingleStep);
270
        }
service-config's avatar
Mixer  
service-config committed
271 272
        if (rotaryEncoderVirtualPosition > rotaryEncoderMaxPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMaxPosition;
273
        }
274 275
        if (rotaryEncoderVirtualPosition < rotaryEncoderMinPosition) {
            rotaryEncoderVirtualPosition = rotaryEncoderMinPosition;
service-config's avatar
Mixer  
service-config committed
276 277 278 279
        }
       
        break;
      }
280 281 282 283 284 285
      default: {
        
      }
    }
  }
  
João Lino's avatar
João Lino committed
286 287
  repaint = true;
  refresh = true;
288 289 290
}

// ######################### START #########################
291
void xSafeHardwarePowerOff() {
João Lino's avatar
João Lino committed
292
//  analogWrite(MIXER_PIN, 0);        // Turn mixer OFF for safety
293
  analogWrite(PUMP_PIN, PUMP_SPEED_STOP);  // analogWrite values from 0 to 255
João Lino's avatar
João Lino committed
294 295
  digitalWrite(HEATING_ELEMENT_OUTPUT_PIN, LOW);  // Turn heading element OFF for safety
  //basePT100.xSafeHardwarePowerOff();                  // Turn temperature sensor OFF for safety
296 297 298
}

void displayWelcome() {
João Lino's avatar
João Lino committed
299 300
  lcdPrint("  Let's start", "    Brewing!");    // Write welcome
  delay(SETTING_WELCOME_TIMEOUT);      // pause for effect
301 302
}

303
void setup() {
João Lino's avatar
João Lino committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  // ++++++++++++++++++++++++ Rotary Encoder ++++++++++++++++++++++++
  pinMode                         (ROTARY_ENCODER_CLK_PIN,INPUT);
  pinMode                         (ROTARY_ENCODER_DT_PIN, INPUT);
  pinMode                         (ROTARY_ENCODER_SW_PIN, INPUT);
  attachInterrupt                 (ROTARY_ENCODER_INTERRUPT_NUMBER, isr, FALLING);

  // ++++++++++++++++++++++++ Heating Element Relay ++++++++++++++++++++++++
  pinMode                         (HEATING_ELEMENT_OUTPUT_PIN, OUTPUT);
  digitalWrite                    (HEATING_ELEMENT_OUTPUT_PIN, LOW);
  windowStartTime             =   millis();
  dWattPerPulse               =   HEATING_ELEMENT_MAX_WATTAGE / HEATING_ELEMENT_AC_FREQUENCY_HZ;

  // ++++++++++++++++++++++++ Mixer ++++++++++++++++++++++++
  //  pinMode    (MIXER_PIN, OUTPUT);
  //  analogWrite    (MIXER_PIN, 0);

320 321 322 323 324
  // ++++++++++++++++++++++++ Pump ++++++++++++++++++++++++
  pinMode(PUMP_PIN, OUTPUT);   // sets the pin as output
  iPumpSpeed                  =   PUMP_SPEED_STOP;             // Time frame to operate in
  analogWrite(PUMP_PIN, iPumpSpeed);  // analogWrite values from 0 to 255

João Lino's avatar
João Lino committed
325 326
  // ++++++++++++++++++++++++ Temperature Sensor PT100 ++++++++++++++++++++++++
  //basePT100.setup();
327
/*
João Lino's avatar
João Lino committed
328 329 330
  analogReference  (INTERNAL1V1);          // EXTERNAL && INTERNAL2V56 && INTERNAL1V1
  pinMode    (PT100_OUTPUT_PIN, OUTPUT);  // setup temperature sensor input pin
  digitalWrite    (PT100_OUTPUT_PIN, LOW);    // initialize sensor off
331
*/
João Lino's avatar
João Lino committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
  // ++++++++++++++++++++++++ Serial Monitor ++++++++++++++++++++++++
  Serial.begin                    (SETTING_SERIAL_MONITOR_BAUD_RATE);    // setup terminal baud rate
  Serial.println                  (SETTING_SERIAL_MONITOR_WELCOME_MESSAGE);  // print a start message to the terminal

  // ++++++++++++++++++++++++ Library - LiquidCrystal_I2C ++++++++++++++++++++++++
  lcd.begin                       (LCD_HORIZONTAL_RESOLUTION,LCD_VERTICAL_RESOLUTION);    //  <<----- My LCD was 16x2
  lcd.setBacklightPin             (LCD_BACKLIGHT_PIN,POSITIVE);        // Setup backlight pin
  lcd.setBacklight                (HIGH);              // Switch on the backlight

  // ######################### INITIALIZE #########################
  // ++++++++++++++++++++++++ Rotary Encoder ++++++++++++++++++++++++
  // set operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
  xSetupRotaryEncoder             ( eRotaryEncoderMode_Disabled, 0, 0, 0, 0, 0 );

  // ++++++++++++++++++++++++ State Machine ++++++++++++++++++++++++
  presetsMenuOption           =   ePresetsMenu_Trigo;
  maltMenuOption              =   eMaltMenu_CastleMalting_Chteau_Pilsen_2RS;
  settingsMenuOption          =   eSettingsMenu_PT100_Element;
  cookingStage                =   eCookingStage_Startpoint;
  // ++++++++++++++++++++++++ Global Variables ++++++++++++++++++++++++
  cooking                     =   false;
353
  bStageFirstRun              =   true;
354

João Lino's avatar
João Lino committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  clockStartTime              =   0;
  clockCounter                =   0;
  clockIgnore                 =   0;
  clockStart                  =   false;
  clockEnd                    =   false;
                        
  cookTime                    =   3600;
  cookTemperature             =   25;
  //cookMode                  =   quick_start;
  //cookMixerSpeed            =   120;
  cookHeatPWM                 =   5;

  startpointTime              =   120;
  betaGlucanaseTime           =   0;
  debranchingTime             =   0;
  proteolyticTime             =   0;
  betaAmylaseTime             =   3600;
  alphaAmylaseTime            =   1800;
  mashoutTime                 =   300;
  recirculationTime           =   1200;
  spargeTime                  =   1200;
  boilTime                    =   5400;
  coolingTime                 =   120;

  startpointTemperature       =   45;
  betaGlucanaseTemperature    =   40;
  debranchingTemperature      =   40;
  proteolyticTemperature      =   50;
  betaAmylaseTemperature      =   60;
  alphaAmylaseTemperature     =   70;
  mashoutTemperature          =   80;
  recirculationTemperature    =   80;
  spargeTemperature           =   80;
  boilTemperature             =   100;
  coolingTemperature          =   25;

  refresh                     =   true;
  repaint                     =   true;

  // ++++++++++++++++++++++++ Interrupts ++++++++++++++++++++++++
  lastInterruptTime           =   0;

  // ++++++++++++++++++++++++ PID  ++++++++++++++++++++++++
  iWindowSize                 =   HEATING_ELEMENT_DEFAULT_WINDOW_SIZE;    // Time frame to operate in
399 400

// ######################### Code - Run Once #########################
João Lino's avatar
João Lino committed
401 402 403
  xSafeHardwarePowerOff           ();
  displayWelcome                  ();
  
404
  xSetupRotaryEncoder             ( eRotaryEncoderMode_Menu, eMainMenu_GO, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
405
}
406

407 408 409
// ######################### START #########################

void loop() {
410 411
  unsigned long inactivityTime = millis() - lastInterruptTime;

João Lino's avatar
João Lino committed
412
  if(inactivityTime > SETTING_MAX_INACTIVITY_TIME) {    // Inactivity check
413 414 415 416 417 418 419 420 421 422 423 424 425 426
    if(refresh) {
      repaint = true;
      refresh = false;
    }
    displayStatus();
  }
  else {
    displayMainMenu();
  }
  
  operateMachine();
}

void xPaintStatusTemplate() {
João Lino's avatar
João Lino committed
427 428
  // Clear LCD
  lcd.clear();        
429

João Lino's avatar
João Lino committed
430 431
  // Position the cursor at the begining of where the temperature template goes onto the screen
  lcd.home();    
432

João Lino's avatar
João Lino committed
433 434 435 436 437 438 439
  // Print the target and measured temperature template
  if(cooking) {
    lcd.print("ON : 000*C/000*C");
  }
  else {
    lcd.print("OFF: 000*C/000*C");
  }
440

João Lino's avatar
João Lino committed
441 442
  // Position the cursor at the begining of where the mode and time template goes onto the screen
  lcd.setCursor (0,LCD_VERTICAL_RESOLUTION-1);
443

João Lino's avatar
João Lino committed
444
  lcd.print("****       00:00");
445 446 447 448 449 450
}

void displayStatus() {

  // Check whether a template repaint is required
  if(repaint) {
João Lino's avatar
João Lino committed
451 452
    // Repaint the LCD template
    xPaintStatusTemplate();
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    
    // Reset the repaint flag after the repaint has been done
    repaint = false;
  }
  
  // Print positions with no numbers, before the measured temperature value
  lcd.setCursor (3,0);
  if (basePT100.getCurrentTemperature() < 10) {
    lcd.print("  ");
  }
  else {
    if (basePT100.getCurrentTemperature() < 100) {
      lcd.print(" ");
    }
  }

  // Print measured temperature value onto the LCD
  lcd.print(basePT100.getCurrentTemperature(), 1);

  // Print positions with no numbers, before the target temperature value
  lcd.setCursor (11,0);
  if (cookTemperature < 10) {
    lcd.print("  ");
  }
  else {
    if (cookTemperature < 100) {
      lcd.print(" ");
    }
  }

  // Print target temperature value onto the LCD
  lcd.print(cookTemperature);
  
  // Calculate the numbers on the timer clock
487 488
  int minutes = clockCounter / 60;
  int seconds = clockCounter - minutes * 60;
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

  // Position the cursor at the begining of where the timer goes onto the screen
  lcd.setCursor (10, 1);
  
  // Print the timer values onto the LCD
  if (minutes < 10) {
    lcd.print(" 0");
  }
  else {
    if (minutes < 100) {
      lcd.print(" ");
    }
  }
  lcd.print(minutes);
  lcd.print(":");
  if(seconds<10) {
    lcd.print("0");
  }
  lcd.print(seconds);
}

void displayMainMenu() {
  switch(menu_position[0]) {
    case eMainMenu_GO: {
      MainMenu_GO();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
516 517
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
518
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_GO, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
519 520 521
      
      break;
    }
522 523 524 525
    case eMainMenu_Presets: {
      MainMenu_Presets();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
526 527
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
528
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Presets, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
529 530 531
      
      break;
    }
532 533 534 535
    case eMainMenu_Malt: {
      MainMenu_Malt();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
536 537
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
538
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Malt, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
539 540 541
      
      break;
    }
542 543 544 545
    case eMainMenu_Startpoint: {
      MainMenu_Startpoint();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
546 547
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
548
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Startpoint, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
549 550 551
      
      break;
    }
552 553 554 555
    case eMainMenu_BetaGlucanase: {
      MainMenu_BetaGlucanase();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
556 557
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
558
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_BetaGlucanase, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
service-config's avatar
Mixer  
service-config committed
559 560
      
      break;
561 562 563 564 565
    }
    case eMainMenu_Debranching: {
      MainMenu_Debranching();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
566 567
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
568
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Settings, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
569 570 571
      
      break;
    }
572 573 574 575
    case eMainMenu_Proteolytic: {
      MainMenu_Proteolytic();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
576 577
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
578
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Proteolytic, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
579 580
      
      break;
581
    }
582 583 584 585
    case eMainMenu_BetaAmylase: {
      MainMenu_BetaAmylase();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
586 587
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
588
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_BetaAmylase, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
589
      
590 591
      break;
    }
592 593 594 595
    case eMainMenu_AlphaAmylase: {
      MainMenu_AlphaAmylase();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
596 597
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
598
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_AlphaAmylase, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
599
      
600 601
      break;
    }
602 603 604 605
    case eMainMenu_Mashout: {
      MainMenu_Mashout();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
606 607
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
608
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Mashout, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
609 610 611 612 613 614 615
      
      break;
    }
    case eMainMenu_Recirculation: {
      MainMenu_Recirculation();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
616 617
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
618
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Recirculation, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
619
      
620 621 622 623
      break;
    }
    case eMainMenu_Sparge: {
      MainMenu_Sparge();
624
      
625
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
626 627
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
628
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Sparge, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
629 630 631 632 633 634 635
      
      break;
    }
    case eMainMenu_Boil: {
      MainMenu_Boil();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
636 637
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
638
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Boil, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
639 640 641 642 643 644 645
      
      break;
    }
    case eMainMenu_Hops: {
      MainMenu_Hops();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
646 647
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
648
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Hops, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
649 650 651 652 653 654 655
      
      break;
    }
    case eMainMenu_Cooling: {
      MainMenu_Cooling();
      
      menu_position[0] = -1;
João Lino's avatar
João Lino committed
656 657
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
658
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Cooling, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
659 660 661 662 663 664 665
      
      break;
    }
    case eMainMenu_Settings: {
      MainMenu_Settings();
      
      menu_position[0] = -1;
666 667
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
668
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Settings, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
669 670 671 672 673 674 675 676 677
      
      break;
    }
    case eMainMenu_Back: {
      MainMenu_Back();
      
      menu_position[0] = -1;
      
      // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
678
      xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_Settings, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
679 680 681 682 683 684 685 686 687 688 689
      
      break;
    }
    default: {
      if(repaint) {

        // display menu
        lcd.clear();
        lcd.home (); // go home
        lcd.print("Brewery Menu");
        
service-config's avatar
Mixer  
service-config committed
690
        switch(rotaryEncoderVirtualPosition) {
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
          case eMainMenu_GO: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> GO           ");
            break;
          }
          case eMainMenu_Presets: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Presets      ");
            break;
          }
          case eMainMenu_Malt: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Malt         ");
            break;
          }
          case eMainMenu_Startpoint: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Startpoint   ");
            break;
          }
          case eMainMenu_BetaGlucanase: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> BetaGlucanase");
            break;
          }
          case eMainMenu_Debranching: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Debranching  ");
            break;
          }
          case eMainMenu_Proteolytic: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Proteolytic  ");
            break;
          }
          case eMainMenu_BetaAmylase: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Beta Amylase ");
            break;
          }
          case eMainMenu_AlphaAmylase: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Alpha Amylase");
            break;
          }
          case eMainMenu_Mashout: {
737
            lcd.setCursor (0,1);        // go to start of 2nd line
738
            lcd.print("-> Mashout      ");
739 740
            break;
          }
741
          case eMainMenu_Recirculation: {
742
            lcd.setCursor (0,1);        // go to start of 2nd line
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
            lcd.print("-> Recirculation");
            break;
          }
          case eMainMenu_Sparge: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Sparge       ");
            break;
          }
          case eMainMenu_Boil: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Boil         ");
            break;
          }
          case eMainMenu_Hops: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Hops         ");
            break;
          }
          case eMainMenu_Cooling: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Cooling      ");
            break;
          }
          case eMainMenu_Settings: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Settings     ");
769 770
            break;
          }
771 772 773 774 775
          case eMainMenu_Back: {
            lcd.setCursor (0,1);        // go to start of 2nd line
            lcd.print("-> Back         ");
            break;
          }
776
          default: {
777
            // reset operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
778
            xSetupRotaryEncoder( eRotaryEncoderMode_Menu, eMainMenu_GO, MENU_SIZE_MAIN_MENU - 1, 0, 1, 0 );
779 780 781
          } 
        }
        
782 783 784
        repaint = false;
      }
      
João Lino's avatar
João Lino committed
785
      if ((digitalRead(ROTARY_ENCODER_SW_PIN))) {    // check if pushbutton is pressed
786
        menu_position[0] = rotaryEncoderVirtualPosition;
João Lino's avatar
João Lino committed
787 788
        while (digitalRead(ROTARY_ENCODER_SW_PIN)) {}    // wait til switch is released
        delay(10);                            // debounce
789
        break;
790 791 792 793 794
      }
    } 
  }
}

795
void MainMenu_GO() {
João Lino's avatar
João Lino committed
796
  startBrewing();
797 798 799 800 801

  backToStatus();
}

void MainMenu_Presets() {
802 803

  backToStatus();
João Lino's avatar
João Lino committed
804
  
805 806 807
}

void MainMenu_Malt() {
808 809

  backToStatus();
João Lino's avatar
João Lino committed
810
  
811 812 813
}

void MainMenu_Startpoint() {
João Lino's avatar
João Lino committed
814 815 816
  startpointTime = getTimer( startpointTime );
  
  startpointTemperature = xSetGenericValue( startpointTemperature, 0, 120, "temperature", "*C" );
817 818

  backToStatus();
819 820 821
}

void MainMenu_BetaGlucanase() {
João Lino's avatar
João Lino committed
822 823 824
  betaGlucanaseTime = getTimer( betaGlucanaseTime );
  
  betaGlucanaseTemperature = xSetGenericValue( betaGlucanaseTemperature, 0, 120, "temperature", "*C" );
825 826

  backToStatus();
827 828 829
}

void MainMenu_Debranching() {
João Lino's avatar
João Lino committed
830 831 832
  debranchingTime = getTimer( debranchingTime );
  
  debranchingTemperature = xSetGenericValue( debranchingTemperature, 0, 120, "temperature", "*C" );
833 834

  backToStatus();
835 836 837
}

void MainMenu_Proteolytic() {
João Lino's avatar
João Lino committed
838 839 840
  proteolyticTime = getTimer( proteolyticTime );
  
  proteolyticTemperature = xSetGenericValue( proteolyticTemperature, 0, 120, "temperature", "*C" );
841 842

  backToStatus();
843 844 845
}

void MainMenu_BetaAmylase() {
João Lino's avatar
João Lino committed
846 847 848
  betaAmylaseTime = getTimer( betaAmylaseTime );
  
  betaAmylaseTemperature = xSetGenericValue( betaAmylaseTemperature, 0, 120, "temperature", "*C" );
849 850

  backToStatus();
851 852 853
}

void MainMenu_AlphaAmylase() {
João Lino's avatar
João Lino committed
854 855 856
  alphaAmylaseTime = getTimer( alphaAmylaseTime );
  
  alphaAmylaseTemperature = xSetGenericValue( alphaAmylaseTemperature, 0, 120, "temperature", "*C" );
857 858

  backToStatus();
859 860 861
}

void MainMenu_Mashout() {
João Lino's avatar
João Lino committed
862 863 864
  mashoutTime = getTimer( mashoutTime );
  
  mashoutTemperature = xSetGenericValue( mashoutTemperature, 0, 120, "temperature", "*C" );
865 866

  backToStatus();
867 868 869
}

void MainMenu_Recirculation() {
João Lino's avatar
João Lino committed
870 871 872
  recirculationTime = getTimer( recirculationTime );
  
  recirculationTemperature = xSetGenericValue( recirculationTemperature, 0, 120, "temperature", "*C" );
873 874

  backToStatus();
875 876 877
}

void MainMenu_Sparge() {
João Lino's avatar
João Lino committed
878 879 880
  spargeTime = getTimer( spargeTime );
  
  spargeTemperature = xSetGenericValue( spargeTemperature, 0, 120, "temperature", "*C" );
881 882

  backToStatus();
883 884 885
}

void MainMenu_Boil() {
João Lino's avatar
João Lino committed
886 887 888
  boilTime = getTimer( boilTime );
  
  boilTemperature = xSetGenericValue( boilTemperature, 0, 120, "temperature", "*C" );
889 890

  backToStatus();
891 892 893
}

void MainMenu_Hops() {
894 895

  backToStatus();
João Lino's avatar
João Lino committed
896
  
897 898
}

899
void MainMenu_Cooling() {
João Lino's avatar
João Lino committed
900 901 902
  coolingTime = getTimer( coolingTime );
  
  coolingTemperature = xSetGenericValue( coolingTemperature, 0, 120, "temperature", "*C" );
903 904

  backToStatus();
905 906 907
}

void MainMenu_Settings() {
908
  iPumpSpeed = xSetGenericValue( iPumpSpeed, 0, 255, "Pump Speed", "PWM" );
909 910

  backToStatus();
911 912
}

913 914 915
void MainMenu_Back() {
  backToStatus();
}
916 917

void xCountTheTime( int temperatureRange ) {
918
  unsigned long now = millis();
João Lino's avatar
João Lino committed
919

João Lino's avatar
João Lino committed
920 921
  // Check if the machine is in the right temperature range, for the current mode,
  if(!(basePT100.getCurrentTemperature() > (cookTemperature - temperatureRange) && basePT100.getCurrentTemperature() < (cookTemperature + temperatureRange))) {
João Lino's avatar
João Lino committed
922
    clockIgnore += now - clockStartTime - clockIgnore;
João Lino's avatar
João Lino committed
923 924 925
  }
  
  // Calculate the remaining time on the clock
926
  clockCounter = cookTime - (now - clockStartTime - clockIgnore);
João Lino's avatar
João Lino committed
927 928

#ifdef DEBUG
929 930 931 932 933
  debugPrintFunction("xCountTheTime");
  debugPrintVar("millis()", now);
  debugPrintVar("clockStartTime", clockStartTime);
  debugPrintVar("clockIgnore", clockIgnore);
  debugPrintVar("clockCounter", clockCounter); 
934
#endif
935 936 937
}

bool isTimeLeft() {
938 939
  if( clockCounter > 0 ) {
    return true;
João Lino's avatar
João Lino committed
940
  }
941
  return false;
942 943
}

944 945
double ulWattToWindowTime( double ulAppliedWatts ) {
  double ulPulsesRequired = ulAppliedWatts / dWattPerPulse;
João Lino's avatar
João Lino committed
946
  return (double)iWindowSize / 1000.0 * ulPulsesRequired;
947 948 949
}

bool xRegulateTemperature() {
João Lino's avatar
João Lino committed
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
  double difference = basePT100.getCurrentTemperature() - cookTemperature;
  bool overTemperature = false;
  double wattage = 0.0;
  
  // Deviation between the cook temperature set and the cook temperature measured
  if( difference < 0.0 ) {
    difference = difference * (-1.0);
    overTemperature = true;
  }
  
  // Calculate applied wattage, based on the distance from the target temperature
  if( overTemperature ) {
    // turn it off
    wattage = 0.0;
  } else {
    if(difference <= 1) {
      // turn it off
      wattage = 0.0;
    } else {
      if(difference <= 3) {
        // pulse lightly at 500 watt
        wattage = 500.0;
      } else {
        if(difference <= 6) {
          // pulse moderately at 1000 watt
          wattage = 1000.0;
        } else {
          if(difference <= 9) {
            // pulse hardly at 2000 watt
          wattage = 2000.0;
          } else {
            //pulse constantly at HEATING_ELEMENT_MAX_WATTAGE watt
            wattage = HEATING_ELEMENT_MAX_WATTAGE;
          }
        }
      }
    }
  }
  
  // Update the recorded time for the begining of the window, if the previous window has passed
990 991
  while((millis() - windowStartTime) > iWindowSize) { // Check if it's time to vary the pulse width modulation and if so do it by shifting the "Relay in ON" Window
    windowStartTime += iWindowSize;
992
  }
João Lino's avatar
João Lino committed
993 994 995 996 997 998 999
  
  // Apply wattage to the element at the right time
  if( ulWattToWindowTime( wattage ) > (millis() - windowStartTime)) {
    digitalWrite(HEATING_ELEMENT_OUTPUT_PIN,HIGH);
  } else {
    digitalWrite(HEATING_ELEMENT_OUTPUT_PIN,LOW);
  }
1000 1001
}

1002 1003 1004 1005
bool xRegulatePumpSpeed() {
  analogWrite(PUMP_PIN, iPumpSpeed);  // analogWrite values from 0 to 255
}

1006 1007 1008 1009
void xWarnClockEnded() {
  /// TODO
}

1010
void xStageFirstRun( int stageTime, int stageTemperature, int stagePumpSpeed ) {
João Lino's avatar
João Lino committed
1011 1012 1013 1014 1015 1016 1017 1018 1019
  // Set the clock
  cookTime = stageTime;
  
  // Set the target temperature
  cookTemperature = stageTemperature;
  
  // Reset the clock
  clockStartTime = millis();
  clockIgnore = 0;
1020 1021 1022

  // Set the pump speed
  iPumpSpeed = stagePumpSpeed;
1023 1024 1025
}

void xTransitionIntoStage_GlobalVariables(eCookingStages nextStage) {
João Lino's avatar
João Lino committed
1026 1027 1028
  // Reset global stage variables
  bStageFirstRun = true;
  cookingStage = nextStage;
1029 1030 1031
}

void xTransitionIntoStage(eCookingStages nextStage) {
João Lino's avatar
João Lino committed
1032 1033 1034 1035 1036 1037 1038 1039 1040
  
  // Turn off all hardware that can damage itself if the machine is not cooking
  xSafeHardwarePowerOff();    
  
  // Warn the user a stage has ended
  xWarnClockEnded();
  
  // Reset global stage variables
  xTransitionIntoStage_GlobalVariables( nextStage );
1041 1042 1043
}

void xBasicStageOperation( int iStageTime, int iStageTemperature, int iStageTemperatureRange, eCookingStages nextStage ) {
João Lino's avatar
João Lino committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
  if(bStageFirstRun) {
    // Don't run this again
    bStageFirstRun = false;
    
    // When the stage should be skipped
    if( iStageTime == 0) {
      // Continue to the next stage
      xTransitionIntoStage_GlobalVariables( nextStage );
      
      // There is nothing to do, in this stage
      return;
    } else {
      // Set the clock, target temperature and Reset the clock
1057
      xStageFirstRun( iStageTime, iStageTemperature, PUMP_SPEED_SLOW );
João Lino's avatar
João Lino committed
1058 1059 1060 1061 1062 1063 1064 1065
    }
  } else {
    // Account for time spent at the target temperature | Input 1: range in ºC within which the target temperature is considered to be reached
    xCountTheTime( iStageTemperatureRange );
    
    if( isTimeLeft() ) {
      // Do temperature control
      xRegulateTemperature();
1066 1067 1068

      // Do flow control
      xRegulatePumpSpeed();
João Lino's avatar
João Lino committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
      
    } else {
      // Continue to the next stage
      xTransitionIntoStage( nextStage );
      
      // There is nothing to do, in this stage
      return;
    }
  }
  // There is nothing to do, in this iteration
  return;
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
}

void xWarnCookEnded() {
  /// TODO
}

void operateMachine() {

  // Measure temperature, for effect
  basePT100.measure();
João Lino's avatar
João Lino committed
1090 1091
  upPT100.measure();
  downPT100.measure();
1092 1093 1094

  // If cooking is done, return (this is a nice place to double check safety and ensure the cooking parts aren't on.
  if(!cooking) {
João Lino's avatar
João Lino committed
1095 1096
    xSafeHardwarePowerOff();
    
1097 1098
    return;
  }
João Lino's avatar
João Lino committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
  
  // Operate the machine according to the current mode
  switch(cookingStage) {
    case eCookingStage_Startpoint: {
      // A basic operation for a basic stage
      xBasicStageOperation( startpointTime, startpointTemperature, 1, eCookingStage_BetaGlucanase );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_BetaGlucanase: {
      // A basic operation for a basic stage
      xBasicStageOperation( betaGlucanaseTime, betaGlucanaseTemperature, 1, eCookingStage_Debranching );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Debranching: {
      // A basic operation for a basic stage
      xBasicStageOperation( debranchingTime, debranchingTemperature, 1, eCookingStage_Proteolytic );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Proteolytic: {
      // A basic operation for a basic stage
      xBasicStageOperation( proteolyticTime, proteolyticTemperature, 1, eCookingStage_BetaAmylase );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_BetaAmylase: {
      // A basic operation for a basic stage
      xBasicStageOperation( betaAmylaseTime, betaAmylaseTemperature, 1, eCookingStage_AlphaAmylase );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_AlphaAmylase: {
      // A basic operation for a basic stage
      xBasicStageOperation( alphaAmylaseTime, alphaAmylaseTemperature, 1, eCookingStage_Mashout );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Mashout: {
      // A basic operation for a basic stage
      xBasicStageOperation( mashoutTime, mashoutTemperature, 1, eCookingStage_Recirculation );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Recirculation: {
      // A basic operation for a basic stage
      xBasicStageOperation( recirculationTime, recirculationTemperature, 1, eCookingStage_Sparge );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Sparge: {
      // A basic operation for a basic stage
      xBasicStageOperation( spargeTime, spargeTemperature, 1, eCookingStage_Boil );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Boil: {
      // A basic operation for a basic stage
      xBasicStageOperation( boilTime, boilTemperature, 1, eCookingStage_Cooling );
      
      // There is nothing to do, in this iteration
      break;
    }
    case eCookingStage_Cooling: {
      // A basic operation for a basic stage
      xBasicStageOperation( coolingTime, coolingTemperature, 1, eCookingStage_Done );
      
      // There is nothing to do, in this iteration
      break;
    }
    default : {
      // Update state
      cooking = false;
      
      // Warn the user that the cooking is done
      xWarnCookEnded();
    }
  }
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
}

// #################################################### Helpers ##################################################################

void startBrewing() {
  cooking = true;
}

void stopBrewing() {
  cooking = false;
}

void backToStatus() {
  lastInterruptTime = millis() - SETTING_MAX_INACTIVITY_TIME - 1;
}
// #################################################### Helpers ##################################################################

// #################################################### Set Variables ##################################################################
1205
int getTimer(int init) {
João Lino's avatar
João Lino committed
1206 1207
  // set operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
  xSetupRotaryEncoder( eRotaryEncoderMode_Time, init, 7200, 0, 1, 30 );
1208 1209

  // initialize variables
service-config's avatar
Mixer  
service-config committed
1210
  int rotaryEncoderPreviousPosition = 0;
1211 1212 1213 1214 1215 1216 1217
  int minutes = 0;
  int seconds = 0;
  
  // Setup Screen
  lcd.clear();
  lcd.home();        
  lcd.print("Set Time");
1218
  lcd.setCursor (0,LCD_VERTICAL_RESOLUTION-1);
1219 1220 1221
  lcd.print("      0:00");
  
  while(true) {
1222
    // Check if pushbutton is pressed
João Lino's avatar
João Lino committed
1223
    if ((digitalRead(ROTARY_ENCODER_SW_PIN))) {  
1224
      // Wait until switch is released
João Lino's avatar
João Lino committed
1225
      while (digitalRead(ROTARY_ENCODER_SW_PIN)) {}  
1226
      
João Lino's avatar
João Lino committed
1227 1228
      // debounce
      delay(10);
1229

João Lino's avatar
João Lino committed
1230
      // Job is done, break the circle
1231
      break;
1232
    } else {
João Lino's avatar
João Lino committed
1233 1234 1235
      // Don't forget to keep an eye on the cooking
      operateMachine();
    }
1236 1237
    
    // display current timer
service-config's avatar
Mixer  
service-config committed
1238 1239 1240 1241
    if (rotaryEncoderVirtualPosition != rotaryEncoderPreviousPosition) {
      rotaryEncoderPreviousPosition = rotaryEncoderVirtualPosition;
      minutes = rotaryEncoderVirtualPosition/60;
      seconds = rotaryEncoderVirtualPosition-minutes*60;
1242
      
1243
      lcd.setCursor (0,LCD_VERTICAL_RESOLUTION-1);
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
      lcd.print("      ");
      lcd.print(minutes);
      lcd.print(":");
      if(seconds<10) {
        lcd.print("0");
      }
      lcd.print(seconds);
      lcd.println("                ");
    }
  }
  
service-config's avatar
Mixer  
service-config committed
1255
  return rotaryEncoderVirtualPosition;
1256 1257 1258 1259 1260
}

int getTemperature(int init) {
  
  // set operation state
1261
  rotaryEncoderMode = eRotaryEncoderMode_Generic;
service-config's avatar
Mixer  
service-config committed
1262
  rotaryEncoderVirtualPosition = init;  
1263 1264

  // initialize variables
service-config's avatar
Mixer  
service-config committed
1265
  int rotaryEncoderPreviousPosition = 0;
1266 1267 1268 1269 1270
  
  // Setup Screen
  lcd.clear();
  lcd.home();        
  lcd.print("Set Temperature");
1271
  lcd.setCursor (0,LCD_VERTICAL_RESOLUTION-1);
1272 1273
  lcd.print("       0 *C");
  
1274
  rotaryEncoderMaxPosition = TEMPERATURE_SETTING_MAX_VALUE;
service-config's avatar
Mixer  
service-config committed
1275
  
1276
  while(true) {
1277
    // Check if pushbutton is pressed
João Lino's avatar
João Lino committed
1278
    if ((digitalRead(ROTARY_ENCODER_SW_PIN))) {  
1279
      // Wait until switch is released
João Lino's avatar
João Lino committed
1280
      while (digitalRead(ROTARY_ENCODER_SW_PIN)) {}  
1281
      
João Lino's avatar
João Lino committed
1282 1283
      // debounce
      delay(10);
1284

João Lino's avatar
João Lino committed
1285
      // Job is done, break the circle
1286
      break;
1287
    } else {
João Lino's avatar
João Lino committed
1288 1289 1290
      // Don't forget to keep an eye on the cooking
      operateMachine();
    }
1291 1292
    
    // display current timer
service-config's avatar
Mixer  
service-config committed
1293 1294
    if (rotaryEncoderVirtualPosition != rotaryEncoderPreviousPosition) {
      rotaryEncoderPreviousPosition = rotaryEncoderVirtualPosition;
1295
      
1296
      lcd.setCursor (0,LCD_VERTICAL_RESOLUTION-1);
1297
      lcd.print("     ");
service-config's avatar
Mixer  
service-config committed
1298
      if(rotaryEncoderVirtualPosition<10) {
1299 1300 1301
        lcd.print("  ");
      }
      else {
service-config's avatar
Mixer  
service-config committed
1302
        if(rotaryEncoderVirtualPosition<100) {
1303 1304 1305
          lcd.print(" ");
        }
      }
service-config's avatar
Mixer  
service-config committed
1306
      lcd.print(rotaryEncoderVirtualPosition);
1307 1308 1309 1310 1311
      lcd.print(" *C");
      lcd.println("                ");
    }
  }
  
service-config's avatar
Mixer  
service-config committed
1312
  return rotaryEncoderVirtualPosition;
1313 1314
}

João Lino's avatar
João Lino committed
1315 1316 1317
int xSetGenericValue(int init, int min, int max, char *valueName, char *unit) {  
  // set operation state | INPUT : eRotaryEncoderMode newMode, int newPosition, int newMaxPosition, int newMinPosition, int newSingleStep, int newMultiStep
  xSetupRotaryEncoder( eRotaryEncoderMode_Generic, init, max, min, 1, 5 );
1318 1319

  // initialize variables
service-config's avatar
Mixer  
service-config committed
1320
  int rotaryEncoderPreviousPosition = 0;
1321 1322 1323
  
  // Setup Screen
  lcd.clear();
1324 1325 1326 1327 1328
  lcd.home();
  lcd.print( "Set " );
  lcd.print( valueName );
  lcd.setCursor ( 0 , LCD_VERTICAL_RESOLUTION - 1 );
  lcd.print( "       0 " );
João Lino's avatar
João Lino committed
1329
  lcd.print( unit );
1330 1331
  
  rotaryEncoderMaxPosition = TEMPERATURE_SETTING_MAX_VALUE;
1332 1333
  
  while(true) {
1334 1335 1336
    // Check if pushbutton is pressed
    if ( digitalRead(ROTARY_ENCODER_SW_PIN) ) {
      // Wait until switch is released
João Lino's avatar
João Lino committed
1337
      while ( digitalRead(ROTARY_ENCODER_SW_PIN) ) {}  
1338
      
João Lino's avatar
João Lino committed
1339 1340
      // debounce
      delay( 10 );
service-config's avatar
Mixer  
service-config committed
1341

João Lino's avatar
João Lino committed
1342
      // Job is done, break the circle
service-config's avatar
Mixer  
service-config committed
1343
      break;
1344
    } else {
João Lino's avatar
João Lino committed
1345 1346 1347
      // Don't forget to keep an eye on the cooking
      operateMachine();
    }
service-config's avatar
Mixer  
service-config committed
1348
    
1349 1350
    // Check if there was an update by the rotary encoder
    if( rotaryEncoderVirtualPosition != rotaryEncoderPreviousPosition ) {
service-config's avatar
Mixer  
service-config committed
1351 1352
      rotaryEncoderPreviousPosition = rotaryEncoderVirtualPosition;
      
1353 1354 1355 1356
      lcd.setCursor( 0, LCD_VERTICAL_RESOLUTION - 1 );
      lcd.print( "     " );
      if( rotaryEncoderVirtualPosition < 10 ) {
        lcd.print( "  " );
1357 1358
      }
      else {
1359 1360
        if( rotaryEncoderVirtualPosition < 100 ) {
          lcd.print( " " );
1361 1362
        }
      }
1363 1364 1365
      lcd.print( rotaryEncoderVirtualPosition );
      lcd.print( " *C" );
      lcd.println( "                " );
1366 1367
    }
  }
1368 1369
  
  return rotaryEncoderVirtualPosition;
1370 1371
}

1372
// ###################### Set Variables ##################################################
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383

void lcdPrint(String title, String message) {
  int messageLength = message.length();
  
  lcd.clear();
    
  // print title
  lcd.home();
  lcd.print(title);
    
  // print message
1384 1385
  if(messageLength <= LCD_HORIZONTAL_RESOLUTION) {
    lcd.setCursor(0,LCD_VERTICAL_RESOLUTION-1);
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
    lcd.print(message);
    delay(1000);
  }
  // print scrolling message
  else {
    String output_message = "                ";
    output_message += message;
    messageLength = output_message.length();
    
    // Adjust the message size for proper printing
    if ( messageLength & 1 == 1 ) {
      output_message+=" ";
      messageLength+=2;
    }
    
    // print scrolling message
1402 1403
    for (int cursor = 0; cursor < messageLength - LCD_HORIZONTAL_RESOLUTION; cursor+=2) {
      lcd.setCursor(0,LCD_VERTICAL_RESOLUTION-1);
1404 1405 1406 1407 1408 1409
      lcd.print(output_message.substring(cursor, cursor+16));
      delay(500);
    }
  }
}

1410