Try adding translations to the screen

CONTRIBUTING.md

@@ -89,3 +89,9 @@ When building the firmware, the scripts/build_spiffs.sh script installs the web
 ## Reporting Issues
 
 If you encounter a problem, open an issue describing the steps to reproduce and any relevant logs.
+
+## Adding Translations
+
+### Controller
+
+### WebUI

src/display/core/Settings.cpp

@@ -66,6 +66,7 @@ Settings::Settings() {
     sunriseExtBrightness = preferences.getInt("sr_exb", 255);
     emptyTankDistance = preferences.getInt("sr_ed", 200);
     fullTankDistance = preferences.getInt("sr_fd", 50);
+    language = preferences.getInt("lang", DEFAULT_LANGUAGE);
 
     preferences.end();
 
@@ -379,6 +380,11 @@ void Settings::setFullTankDistance(int full_tank_distance) {
     save();
 }
 
+void Settings::setLanguage(int language) {
+    this->language = language;
+    save();
+}
+
 void Settings::doSave() {
     if (!dirty) {
         return;
@@ -448,6 +454,7 @@ void Settings::doSave() {
     preferences.putInt("sr_exb", sunriseExtBrightness);
     preferences.putInt("sr_ed", emptyTankDistance);
     preferences.putInt("sr_fd", fullTankDistance);
+    preferences.putInt("lang", language);
 
     preferences.end();
 }

src/display/core/Settings.h

@@ -77,6 +77,8 @@ class Settings {
     int getSunriseExtBrightness() const { return sunriseExtBrightness; }
     int getEmptyTankDistance() const { return emptyTankDistance; }
     int getFullTankDistance() const { return fullTankDistance; }
+    int getLanguage() const { return language; }
+    void setLanguage(int language);
     void setTargetBrewTemp(int target_brew_temp);
     void setTargetSteamTemp(int target_steam_temp);
     void setTargetWaterTemp(int target_water_temp);
@@ -205,6 +207,7 @@ class Settings {
     int sunriseExtBrightness = 255;
     int emptyTankDistance = 200;
     int fullTankDistance = 50;
+    int language = DEFAULT_LANGUAGE;
 
     void doSave();
     xTaskHandle taskHandle;

src/display/core/Translation.cpp

@@ -0,0 +1,56 @@
+#include "Translation.h"
+#include "TranslationStrings.h"
+#include <stdarg.h>
+
+Language Translation::currentLanguage = Language::ENGLISH;
+
+void Translation::setLanguage(Language lang) {
+    currentLanguage = lang;
+}
+
+Language Translation::getLanguage() {
+    return currentLanguage;
+}
+
+const char* Translation::get(TranslationKey key) {
+    int index = static_cast<int>(key);
+    if (index < 0 || index >= static_cast<int>(TranslationStrings::NUM_KEYS)) {
+        return "Unknown";
+    }
+
+    const char* const* strings = nullptr;
+    switch (currentLanguage) {
+        case Language::GERMAN:
+            strings = TranslationStrings::GERMAN;
+            break;
+        case Language::FRENCH:
+            strings = TranslationStrings::FRENCH;
+            break;
+        case Language::SPANISH:
+            strings = TranslationStrings::SPANISH;
+            break;
+        case Language::ENGLISH:
+        default:
+            strings = TranslationStrings::ENGLISH;
+            break;
+    }
+
+    const char* text = strings[index];
+    if (text != nullptr && text[0] != '\0') {
+        return text;
+    }
+
+    // Fallback to English
+    return TranslationStrings::ENGLISH[index];
+}
+
+String Translation::format(const char* format, ...) {
+    char buffer[256];
+    va_list args;
+    va_start(args, format);
+    vsnprintf(buffer, sizeof(buffer), format, args);
+    va_end(args);
+    return String(buffer);
+}
+
+

src/display/core/Translation.h

@@ -0,0 +1,47 @@
+#ifndef TRANSLATION_H
+#define TRANSLATION_H
+
+#include <Arduino.h>
+
+enum class Language {
+    ENGLISH,
+    GERMAN,
+    FRENCH,
+    SPANISH
+};
+
+enum class TranslationKey {
+    BREW,
+    STEAM,
+    WATER,
+    GRIND,
+    SELECT_PROFILE,
+    STARTING,
+    UPDATING,
+    TEMPERATURE_ERROR,
+    AUTOTUNING,
+    FINISHED,
+    INFUSION,
+    BREW_PHASE,
+    STEPS,
+    PHASES,
+    STEP,
+    PHASE,
+    SELECTED_PROFILE,
+    RESTART_REQUIRED
+};
+
+class Translation {
+public:
+    static void setLanguage(Language lang);
+    static Language getLanguage();
+    static const char* get(TranslationKey key);
+    static String format(const char* format, ...);
+
+    private:
+        static Language currentLanguage;
+};
+
+#define TR(key) Translation::get(TranslationKey::key)
+
+#endif // TRANSLATION_H

src/display/core/TranslationStrings.cpp

@@ -0,0 +1,91 @@
+#include "TranslationStrings.h"
+
+namespace TranslationStrings {
+    // English
+    const char* const ENGLISH[] = {
+        "Brew",                    // BREW
+        "Steam",                   // STEAM
+        "Water",                   // WATER
+        "Grind",                   // GRIND
+        "Select profile",          // SELECT_PROFILE
+        "Starting...",             // STARTING
+        "Updating...",             // UPDATING
+        "Temperature error, please restart", // TEMPERATURE_ERROR
+        "Autotuning...",           // AUTOTUNING
+        "Finished",                // FINISHED
+        "INFUSION",                // INFUSION
+        "BREW",                    // BREW_PHASE
+        "Steps",                   // STEPS
+        "Phases",                  // PHASES
+        "step",                    // STEP
+        "phase",                   // PHASE
+        "Selected profile",        // SELECTED_PROFILE
+        "Restart required"         // RESTART_REQUIRED
+    };
+
+    // German
+    const char* const GERMAN[] = {
+        "Kaffee",                  // BREW
+        "Dampf",                   // STEAM
+        "Wasser",                  // WATER
+        "Mahlen",                  // GRIND
+        "Profil auswählen",        // SELECT_PROFILE
+        "Starten...",              // STARTING
+        "Aktualisieren...",        // UPDATING
+        "Temperaturfehler, bitte neu starten", // TEMPERATURE_ERROR
+        "Autotune...",             // AUTOTUNING
+        "Fertig",                  // FINISHED
+        "INFUSION",                // INFUSION
+        "BEZUG",                   // BREW_PHASE
+        "Schritte",                // STEPS
+        "Phasen",                  // PHASES
+        "Schritt",                 // STEP
+        "Phase",                   // PHASE
+        "Gewähltes Profil",        // SELECTED_PROFILE
+        "Neustart benötigt"        // RESTART_REQUIRED
+    };
+
+    // French
+    const char* const FRENCH[] = {
+        "Brew",                    // BREW
+        "Steam",                   // STEAM
+        "Water",                   // WATER
+        "Grind",                   // GRIND
+        "Select profile",          // SELECT_PROFILE
+        "Starting...",             // STARTING
+        "Updating...",             // UPDATING
+        "Temperature error, please restart", // TEMPERATURE_ERROR
+        "Autotuning...",           // AUTOTUNING
+        "Finished",                // FINISHED
+        "INFUSION",                // INFUSION
+        "BREW",                    // BREW_PHASE
+        "Steps",                   // STEPS
+        "Phases",                  // PHASES
+        "step",                    // STEP
+        "phase",                   // PHASE
+        "Selected profile",        // SELECTED_PROFILE
+        "Restart required"         // RESTART_REQUIRED
+    };
+
+    // Spanish
+    const char* const SPANISH[] = {
+        "Elaborar",                     // BREW
+        "Vapor",                        // STEAM
+        "Agua",                         // WATER
+        "Moler",                        // GRIND
+        "Seleccionar perfil",           // SELECT_PROFILE
+        "Iniciando...",                 // STARTING
+        "Actualizando...",              // UPDATING
+        "Error de temperatura, favor de reiniciar", // TEMPERATURE_ERROR
+        "Autocalibrando...",            // AUTOTUNING
+        "Terminado",                    // FINISHED
+        "INFUSIÓN",                     // INFUSION
+        "ELABORAR",                     // BREW_PHASE
+        "Pasos",                        // STEPS
+        "Fases",                        // PHASES
+        "paso",                         // STEP
+        "fase",                         // PHASE
+        "Perfil seleccionado",          // SELECTED_PROFILE
+        "Reinicio requerido"            // RESTART_REQUIRED
+    };
+}

src/display/core/TranslationStrings.h

@@ -0,0 +1,15 @@
+#ifndef TRANSLATION_STRINGS_H
+#define TRANSLATION_STRINGS_H
+
+enum class TranslationKey;
+
+namespace TranslationStrings {
+    extern const char* const ENGLISH[];
+    extern const char* const GERMAN[];
+    extern const char* const FRENCH[];
+    extern const char* const SPANISH[];
+
+    static constexpr size_t NUM_KEYS = 18;
+}
+
+#endif // TRANSLATION_STRINGS_H

src/display/core/constants.h

@@ -23,7 +23,7 @@
 #define DEFAULT_TIMEZONE "Europe/Rome"
 #define DEFAULT_STEAM_PUMP_PERCENTAGE 4.f
 #define WIFI_CONNECT_ATTEMPTS 20
-
+#define DEFAULT_LANGUAGE 0
 #define MODE_STANDBY 0
 #define MODE_BREW 1
 #define MODE_STEAM 2

src/display/plugins/LanguagePlugin.cpp

@@ -0,0 +1,51 @@
+#include "LanguagePlugin.h"
+#include <display/core/Translation.h>
+
+LanguagePlugin::LanguagePlugin(Controller *controller) : Plugin(controller) {
+    controller->getPluginManager()->registerPlugin(this);
+}
+
+void LanguagePlugin::init() {
+    controller->getPluginManager()->on("language:change", [this](Event const &event) {
+        int language = event.getInt("language");
+        setLanguage(language);
+    });
+}
+
+void LanguagePlugin::setLanguage(int language) {
+    Translation::setLanguage(static_cast<Language>(language));
+    controller->getSettings().setLanguage(language);
+    controller->getPluginManager()->emit("ui:refresh", {});
+}
+
+const char* LanguagePlugin::getName() const {
+    return "Language";
+}
+
+const char* LanguagePlugin::getDescription() const {
+    return "Language settings for the display";
+}
+
+bool LanguagePlugin::isEnabled() const {
+    return true;
+}
+
+void LanguagePlugin::setEnabled(bool enabled) {
+}
+
+String LanguagePlugin::getConfig() const {
+    return "{\"language\":" + String(controller->getSettings().getLanguage()) + "}";
+}
+
+void LanguagePlugin::setConfig(const String &config) {
+    if (config.indexOf("\"language\":") != -1) {
+        int start = config.indexOf("\"language\":") + 11;
+        int end = config.indexOf(",", start);
+        if (end == -1) end = config.indexOf("}", start);
+        if (end != -1) {
+            String langStr = config.substring(start, end);
+            int language = langStr.toInt();
+            setLanguage(language);
+        }
+    }
+}

src/display/plugins/LanguagePlugin.h

@@ -0,0 +1,18 @@
+#ifndef LANGUAGE_PLUGIN_H
+#define LANGUAGE_PLUGIN_H
+
+class Controller;
+class PluginManager;
+
+class LanguagePlugin : public Plugin {
+public:
+    explicit LanguagePlugin(Controller *controller);
+
+    void setup(Controller* controller, PluginManager* pluginManager) override;
+    void loop() override;
+
+private:
+    void setLanguage(int language);
+};
+
+#endif // LANGUAGE_PLUGIN_H