Skip to content

Commit

Permalink
bring display settings onto the website
Browse files Browse the repository at this point in the history 
FEATURE_SHOT_TIMER
SHOT_TIMER_DISPLAY_DELAY
FEATURE_HEATING_LOGO
FEATURE_PID_OFF_LOGO

bump ESPAsyncWebServer:
another change in release structure -> new version -> broke build check
  • Loading branch information
@LoQue90
LoQue90 committed Oct 17, 2024
1 parent 15c469e commit 79b984f
Show file tree
Hide file tree
Showing 11 changed files with 173 additions and 78 deletions.
3 changes: 2 additions & 1 deletion data/js/app.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ const vueApp = Vue.createApp({
2: 'Brew PID Parameters',
3: 'Brew Control',
4: 'Scale Parameters',
5: 'Power Settings'
5: 'Display Settings',
6: 'Power Settings'
}

return sectionNames[sectionId]
Expand Down
2 changes: 1 addition & 1 deletion platformio.ini
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ lib_deps =
knolleary/PubSubClient @ 2.8.0
bblanchon/ArduinoJson @ 6.21.4
git+https://github.com/esphome/AsyncTCP @ 2.1.4
git+https://github.com/esphome/ESPAsyncWebServer @ 3.2.2
git+https://github.com/esphome/ESPAsyncWebServer @ 3.3.0
git+https://github.com/tzapu/WiFiManager @ 2.0.17
extra_scripts =
pre:auto_firmware_version.py
Expand Down
94 changes: 50 additions & 44 deletions src/defaults.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,48 +48,54 @@ int writeSysParamsToStorage(void);
#define BACKFLUSH_FILL_TIME 5 // time in seconds the pump is running during backflush
#define BACKFLUSH_FLUSH_TIME 10 // time in seconds the 3-way valve is open during backflush
#define FEATURE_BREW_CONTROL 0 // enables function to control pump and solenoid valve
#define FEATURE_SHOT_TIMER 0 // enables full screen shot timer
#define SHOT_TIMER_DISPLAY_DELAY 3 // time in seconds that shot timer will be shown after brew finished
#define FEATURE_HEATING_LOGO 1 // enables full screen logo if mashine is heating
#define FEATURE_PID_OFF_LOGO 1 // enables full screen logo if pid is switched off

#define PID_KP_START_MIN 0
#define PID_KP_START_MAX 999
#define PID_TN_START_MIN 0
#define PID_TN_START_MAX 999
#define PID_KP_REGULAR_MIN 0
#define PID_KP_REGULAR_MAX 999
#define PID_TN_REGULAR_MIN 0
#define PID_TN_REGULAR_MAX 999
#define PID_TV_REGULAR_MIN 0
#define PID_TV_REGULAR_MAX 999
#define PID_I_MAX_REGULAR_MIN 0
#define PID_I_MAX_REGULAR_MAX 999
#define PID_KP_BD_MIN 0
#define PID_KP_BD_MAX 999
#define PID_TN_BD_MIN 0
#define PID_TN_BD_MAX 999
#define PID_TV_BD_MIN 0
#define PID_TV_BD_MAX 999
#define BREW_SETPOINT_MIN 20
#define BREW_SETPOINT_MAX 110
#define STEAM_SETPOINT_MIN 100
#define STEAM_SETPOINT_MAX 140
#define BREW_TEMP_OFFSET_MIN 0
#define BREW_TEMP_OFFSET_MAX 20
#define BREW_TIME_MIN 0
#define BREW_TIME_MAX 180
#define BREW_PID_DELAY_MIN 0
#define BREW_PID_DELAY_MAX 60
#define PRE_INFUSION_TIME_MIN 0
#define PRE_INFUSION_TIME_MAX 60
#define PRE_INFUSION_PAUSE_MIN 0
#define PRE_INFUSION_PAUSE_MAX 60
#define WEIGHTSETPOINT_MIN 0
#define WEIGHTSETPOINT_MAX 500
#define PID_KP_STEAM_MIN 0
#define PID_KP_STEAM_MAX 500
#define STANDBY_MODE_TIME_MIN 30
#define STANDBY_MODE_TIME_MAX 120
#define BACKFLUSH_CYCLES_MIN 2
#define BACKFLUSH_CYCLES_MAX 20
#define BACKFLUSH_FILL_TIME_MIN 5
#define BACKFLUSH_FILL_TIME_MAX 20
#define BACKFLUSH_FLUSH_TIME_MIN 5
#define BACKFLUSH_FLUSH_TIME_MAX 20
#define PID_KP_START_MIN 0
#define PID_KP_START_MAX 999
#define PID_TN_START_MIN 0
#define PID_TN_START_MAX 999
#define PID_KP_REGULAR_MIN 0
#define PID_KP_REGULAR_MAX 999
#define PID_TN_REGULAR_MIN 0
#define PID_TN_REGULAR_MAX 999
#define PID_TV_REGULAR_MIN 0
#define PID_TV_REGULAR_MAX 999
#define PID_I_MAX_REGULAR_MIN 0
#define PID_I_MAX_REGULAR_MAX 999
#define PID_KP_BD_MIN 0
#define PID_KP_BD_MAX 999
#define PID_TN_BD_MIN 0
#define PID_TN_BD_MAX 999
#define PID_TV_BD_MIN 0
#define PID_TV_BD_MAX 999
#define BREW_SETPOINT_MIN 20
#define BREW_SETPOINT_MAX 110
#define STEAM_SETPOINT_MIN 100
#define STEAM_SETPOINT_MAX 140
#define BREW_TEMP_OFFSET_MIN 0
#define BREW_TEMP_OFFSET_MAX 20
#define BREW_TIME_MIN 0
#define BREW_TIME_MAX 180
#define BREW_PID_DELAY_MIN 0
#define BREW_PID_DELAY_MAX 60
#define PRE_INFUSION_TIME_MIN 0
#define PRE_INFUSION_TIME_MAX 60
#define PRE_INFUSION_PAUSE_MIN 0
#define PRE_INFUSION_PAUSE_MAX 60
#define WEIGHTSETPOINT_MIN 0
#define WEIGHTSETPOINT_MAX 500
#define PID_KP_STEAM_MIN 0
#define PID_KP_STEAM_MAX 500
#define STANDBY_MODE_TIME_MIN 30
#define STANDBY_MODE_TIME_MAX 120
#define BACKFLUSH_CYCLES_MIN 2
#define BACKFLUSH_CYCLES_MAX 20
#define BACKFLUSH_FILL_TIME_MIN 5
#define BACKFLUSH_FILL_TIME_MAX 20
#define BACKFLUSH_FLUSH_TIME_MIN 5
#define BACKFLUSH_FLUSH_TIME_MAX 20
#define SHOT_TIMER_DISPLAY_DELAY_MIN 0
#define SHOT_TIMER_DISPLAY_DELAY_MAX 60
10 changes: 5 additions & 5 deletions src/display/displayCommon.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,11 +237,11 @@ void displayLogo(String displaymessagetext, String displaymessagetext2) {
* @brief display shot and flush timer
*/
bool displayShottimer() {
if (FEATURE_SHOTTIMER == 0) {
if (featureShotTimer == 0) {
return false;
}

if (machineState == kBrew || (millis() - lastBrewTimeMillis) < SHOTTIMERDISPLAYDELAY || machineState == kManualFlush) {
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < (shotTimerDisplayDelay * 1000) || machineState == kManualFlush) {
u8g2.clearBuffer();

if (machineState != kManualFlush) {
Expand Down Expand Up @@ -277,7 +277,7 @@ bool displayShottimer() {
*/
bool displayMachineState() {
// Show the heating logo when we are in regular PID mode and more than 5degC below the set point
if (FEATURE_HEATINGLOGO > 0 && machineState == kPidNormal && (setpoint - temperature) > 5.) {
if (featureHeatingLogo > 0 && machineState == kPidNormal && (setpoint - temperature) > 5.) {
// For status info
u8g2.clearBuffer();

Expand All @@ -293,7 +293,7 @@ bool displayMachineState() {
return true;
}
// Offline logo
else if (FEATURE_PIDOFF_LOGO == 1 && machineState == kPidDisabled) {
else if (featurePidOffLogo == 1 && machineState == kPidDisabled) {
u8g2.clearBuffer();
u8g2.drawXBMP(38, 0, Off_Logo_width, Off_Logo_height, Off_Logo);
u8g2.setCursor(0, 55);
Expand All @@ -303,7 +303,7 @@ bool displayMachineState() {
u8g2.sendBuffer();
return true;
}
else if (FEATURE_PIDOFF_LOGO == 1 && machineState == kStandby) {
else if (featurePidOffLogo == 1 && machineState == kStandby) {
u8g2.clearBuffer();
u8g2.drawXBMP(38, 0, Off_Logo_width, Off_Logo_height, Off_Logo);
u8g2.setCursor(36, 55);
Expand Down
6 changes: 3 additions & 3 deletions src/display/displayRotateUpright.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ void displayEmergencyStop(void) {
* @brief display shot timer
*/
bool displayShottimer() {
if (((timeBrewed > 0 && featureBrewControl == 0) || (featureBrewControl > 0 && currBrewState > kBrewIdle && currBrewState <= kBrewFinished)) && FEATURE_SHOTTIMER == 1) {
if (((timeBrewed > 0 && featureBrewControl == 0) || (featureBrewControl > 0 && currBrewState > kBrewIdle && currBrewState <= kBrewFinished)) && featureShotTimer == 1) {
u8g2.clearBuffer();

// draw temp icon
Expand All @@ -100,8 +100,8 @@ bool displayShottimer() {
u8g2.sendBuffer();
return true;
}
else if (FEATURE_SHOTTIMER == 1 && millis() >= lastBrewTimeMillis && // directly after creating lastbrewTimeMillis (happens when turning off the brew switch, case 43 in the code) should be started
lastBrewTimeMillis + SHOTTIMERDISPLAYDELAY >= millis() && // should run until millis() has caught up with SHOTTIMERDISPLAYDELAY, this can be used to control the display duration
else if (featureShotTimer == 1 && millis() >= lastBrewTimeMillis && // directly after creating lastbrewTimeMillis (happens when turning off the brew switch, case 43 in the code) should be started
lastBrewTimeMillis + (shotTimerDisplayDelay * 1000) >= millis() && // should run until millis() has caught up with shotTimerDisplayDelay, this can be used to control the display duration
lastBrewTimeMillis < totalBrewTime) // if the totalBrewTime is reached automatically, nothing should be done, otherwise wrong time will be displayed because switch is pressed later than totalBrewTime
{
u8g2.clearBuffer();
Expand Down
8 changes: 4 additions & 4 deletions src/display/displayTemplateMinimal.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ void printScreen() {
// Brew time
#if (FEATURE_BREWSWITCH == 1)
if (featureBrewControl) {
// Shown brew time while machine is brewing and after the brewing during SHOTTIMERDISPLAYDELAY
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < SHOTTIMERDISPLAYDELAY) {
// Shown brew time while machine is brewing and after the brewing during shotTimerDisplayDelay
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < (shotTimerDisplayDelay * 1000)) {
u8g2.setCursor(34, 44);
u8g2.print(langstring_brew);
u8g2.print(timeBrewed / 1000, 0);
Expand All @@ -105,8 +105,8 @@ void printScreen() {

// Brew Timer with optocoupler
else {
// Shown brew time while machine is brewing and after the brewing during SHOTTIMERDISPLAYDELAY
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < SHOTTIMERDISPLAYDELAY) {
// Shown brew time while machine is brewing and after the brewing during shotTimerDisplayDelay
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < (shotTimerDisplayDelay * 1000)) {
u8g2.setCursor(34, 44);
u8g2.print(langstring_brew);
u8g2.print(timeBrewed / 1000, 0);
Expand Down
8 changes: 4 additions & 4 deletions src/display/displayTemplateStandard.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ void printScreen() {
#if (FEATURE_BREWSWITCH == 1)

if (featureBrewControl) {
// Shown brew time while machine is brewing and after the brewing during SHOTTIMERDISPLAYDELAY
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < SHOTTIMERDISPLAYDELAY) {
// Shown brew time while machine is brewing and after the brewing during shotTimerDisplayDelay
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < (shotTimerDisplayDelay * 1000)) {
u8g2.setFontMode(1);
u8g2.setCursor(34, 36);
u8g2.print(langstring_brew);
Expand Down Expand Up @@ -92,8 +92,8 @@ void printScreen() {
else {
// Brew Timer with optocoupler

// Shown brew time while machine is brewing and after the brewing during SHOTTIMERDISPLAYDELAY
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < SHOTTIMERDISPLAYDELAY) {
// Shown brew time while machine is brewing and after the brewing during shotTimerDisplayDelay
if (machineState == kBrew || (millis() - lastBrewTimeMillis) < (shotTimerDisplayDelay * 1000)) {
u8g2.setCursor(34, 36);
u8g2.print(langstring_brew);
u8g2.setCursor(84, 36);
Expand Down
2 changes: 1 addition & 1 deletion src/embeddedWebserver.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ void serverSetup();
void setEepromWriteFcn(int (*fcnPtr)(void));

// editable vars are specified in main.cpp
#define EDITABLE_VARS_LEN 37
#define EDITABLE_VARS_LEN 41
extern std::map<String, editable_t> editableVars;

// EEPROM
Expand Down
66 changes: 63 additions & 3 deletions src/main.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,10 @@ const boolean ota = OTA;

// Display
uint8_t oled_i2c = OLED_I2C;
uint8_t featureShotTimer = FEATURE_SHOT_TIMER;
double shotTimerDisplayDelay = SHOT_TIMER_DISPLAY_DELAY;
uint8_t featureHeatingLogo = FEATURE_HEATING_LOGO;
uint8_t featurePidOffLogo = FEATURE_PID_OFF_LOGO;

// WiFi
uint8_t wifiCredentialsSaved = 0;
Expand Down Expand Up @@ -269,6 +273,10 @@ SysPara<int> sysParaBackflushCycles(&backflushCycles, BACKFLUSH_CYCLES_MIN, BACK
SysPara<double> sysParaBackflushFillTime(&backflushFillTime, BACKFLUSH_FILL_TIME_MIN, BACKFLUSH_FILL_TIME_MAX, STO_ITEM_BACKFLUSH_FILL_TIME);
SysPara<double> sysParaBackflushFlushTime(&backflushFlushTime, BACKFLUSH_FLUSH_TIME_MIN, BACKFLUSH_FLUSH_TIME_MAX, STO_ITEM_BACKFLUSH_FLUSH_TIME);
SysPara<uint8_t> sysParaFeatureBrewControl(&featureBrewControl, 0, 1, STO_ITEM_FEATURE_BREW_CONTROL);
SysPara<uint8_t> sysParaFeatureShotTimer(&featureShotTimer, 0, 1, STO_ITEM_FEATURE_SHOT_TIMER);
SysPara<double> sysParaShotTimerDisplayDelay(&shotTimerDisplayDelay, SHOT_TIMER_DISPLAY_DELAY_MIN, SHOT_TIMER_DISPLAY_DELAY_MAX, STO_ITEM_SHOT_TIMER_DISPLAY_DELAY);
SysPara<uint8_t> sysParaFeatureHeatingLogo(&featureHeatingLogo, 0, 1, STO_ITEM_FEATURE_HEATING_LOGO);
SysPara<uint8_t> sysParaFeaturePidOffLogo(&featurePidOffLogo, 0, 1, STO_ITEM_FEATURE_PID_OFF_LOGO);

// Other variables
boolean emergencyStop = false; // Emergency stop if temperature is too high
Expand Down Expand Up @@ -297,6 +305,7 @@ enum SectionNames {
sBDSection,
sBrewSection,
sScaleSection,
sDisplaySection,
sPowerSection,
sOtherSection
};
Expand Down Expand Up @@ -1245,7 +1254,7 @@ void setup() {

editableVars["STANDBY_MODE_TIMER"] = {.displayName = F("Standby Time"),
.hasHelpText = true,
.helpText = F("Time in minutes until the heater is turned off. Timer is reset by brew detection."),
.helpText = F("Time in minutes until the heater is turned off. Timer is reset by brew, manual flush, backflush and steam."),
.type = kDouble,
.section = sPowerSection,
.position = 30,
Expand All @@ -1254,7 +1263,7 @@ void setup() {
.maxValue = STANDBY_MODE_TIME_MAX,
.ptr = (void*)&standbyModeTime};

editableVars["BREWCONTROL"] = {.displayName = F("Brew Control"),
editableVars["BREWCONTROL"] = {.displayName = F("Enable Brew Control"),
.hasHelpText = true,
.helpText = F("Enables brew-by-time or brew-by-weight"),
.type = kUInt8,
Expand Down Expand Up @@ -1314,8 +1323,51 @@ void setup() {
.ptr = (void*)&scale2Calibration};
#endif

editableVars["SHOT_TIMER"] = {.displayName = F("Enable Shot Timer"),
.hasHelpText = true,
.helpText = "Enables a full screen shot and flush timer",
.type = kUInt8,
.section = sDisplaySection,
.position = 37,
.show = [] { return true; },
.minValue = 0,
.maxValue = 1,
.ptr = (void*)&featureShotTimer};

editableVars["SHOT_TIMER_DISPLAY_DELAY"] = {.displayName = F("Shot Timer Display Delay (s)"),
.hasHelpText = true,
.helpText = "time in ms that shot timer will be shown after brew finished",
.type = kDouble,
.section = sDisplaySection,
.position = 38,
.show = [] { return true; },
.minValue = SHOT_TIMER_DISPLAY_DELAY_MIN,
.maxValue = SHOT_TIMER_DISPLAY_DELAY_MAX,
.ptr = (void*)&shotTimerDisplayDelay};

editableVars["HEATING_LOGO"] = {.displayName = F("Enable Heating Logo"),
.hasHelpText = true,
.helpText = "full screen logo will be shown if temperature is 5°C below setpoint",
.type = kUInt8,
.section = sDisplaySection,
.position = 39,
.show = [] { return true; },
.minValue = 0,
.maxValue = 1,
.ptr = (void*)&featureHeatingLogo};

editableVars["PID_OFF_LOGO"] = {.displayName = F("Enable ´PID Disabled´ Logo"),
.hasHelpText = true,
.helpText = "full screen logo will be shown if pid is disabled",
.type = kUInt8,
.section = sDisplaySection,
.position = 40,
.show = [] { return true; },
.minValue = 0,
.maxValue = 1,
.ptr = (void*)&featurePidOffLogo};
editableVars["VERSION"] = {
.displayName = F("Version"), .hasHelpText = false, .helpText = "", .type = kCString, .section = sOtherSection, .position = 37, .show = [] { return false; }, .minValue = 0, .maxValue = 1, .ptr = (void*)sysVersion};
.displayName = F("Version"), .hasHelpText = false, .helpText = "", .type = kCString, .section = sOtherSection, .position = 41, .show = [] { return false; }, .minValue = 0, .maxValue = 1, .ptr = (void*)sysVersion};
// when adding parameters, set EDITABLE_VARS_LEN to max of .position

#if (FEATURE_PRESSURESENSOR == 1)
Expand Down Expand Up @@ -1857,6 +1909,10 @@ int readSysParamsFromStorage(void) {
if (sysParaBackflushFillTime.getStorage() != 0) return -1;
if (sysParaBackflushFlushTime.getStorage() != 0) return -1;
if (sysParaFeatureBrewControl.getStorage() != 0) return -1;
if (sysParaFeatureShotTimer.getStorage() != 0) return -1;
if (sysParaShotTimerDisplayDelay.getStorage() != 0) return -1;
if (sysParaFeatureHeatingLogo.getStorage() != 0) return -1;
if (sysParaFeaturePidOffLogo.getStorage() != 0) return -1;

return 0;
}
Expand Down Expand Up @@ -1898,6 +1954,10 @@ int writeSysParamsToStorage(void) {
if (sysParaBackflushFillTime.setStorage() != 0) return -1;
if (sysParaBackflushFlushTime.setStorage() != 0) return -1;
if (sysParaFeatureBrewControl.setStorage() != 0) return -1;
if (sysParaFeatureShotTimer.setStorage() != 0) return -1;
if (sysParaShotTimerDisplayDelay.setStorage() != 0) return -1;
if (sysParaFeatureHeatingLogo.setStorage() != 0) return -1;
if (sysParaFeaturePidOffLogo.setStorage() != 0) return -1;

return storageCommit();
}
Expand Down
Loading

0 comments on commit 79b984f

Please sign in to comment.