#176 move most core english language strings into language dependant header. #177 improvements to touch calibration.

Author: davetcc

src/BaseDialog.cpp

@@ -10,13 +10,14 @@
 #include <RemoteConnector.h>
 #include <BaseDialog.h>
 #include <SwitchInput.h>
+#include "lang/language_select.h"
 
 using namespace tcgfx;
 
-const char buttonOK[] PROGMEM = "ok";
-const char buttonCancel[] PROGMEM = "cancel";
-const char buttonClose[] PROGMEM = "close";
-const char buttonAccept[] PROGMEM = "accept";
+const char buttonOK[] PROGMEM = TXT_DIALOG_OK;
+const char buttonCancel[] PROGMEM = TXT_DIALOG_CANCEL;
+const char buttonClose[] PROGMEM = TXT_DIALOG_CLOSE;
+const char buttonAccept[] PROGMEM = TXT_DIALOG_ACCEPT;
 const char* standardDialogButton[] = { buttonOK, buttonAccept, buttonCancel, buttonClose };
 
 BaseDialog::BaseDialog() : header{0}, headerPgm(nullptr) {

src/BaseRenderers.cpp

@@ -40,13 +40,11 @@ BaseMenuRenderer::BaseMenuRenderer(int bufferSize, RendererType rType) : MenuRen
     lastOffset = 0;
     resetValInTicks = 30 * TC_DISPLAY_UPDATES_PER_SECOND;
 	renderCallback = nullptr;
-    resetCallback = nullptr;
     renderFnPressType = RPRESS_NONE;
 	redrawMode = MENUDRAW_COMPLETE_REDRAW;
 	this->lastOffset = 0;
     this->firstWidget = nullptr;
     this->dialog = nullptr;
-    isCustomDrawing = false;
     displayTakenMode = NOT_TAKEN_OVER;
     updatesPerSecond = TC_DISPLAY_UPDATES_PER_SECOND;
     MenuRenderer::theInstance = this;
@@ -112,14 +110,9 @@ void BaseMenuRenderer::resetToDefault() {
 
     // once the menu has been reset, if the reset callback is present
     // then we call it.
-    if(resetCallback) {
-        if(isCustomDrawing) {
-            customDrawing->reset();
-        }
-        else {
-            resetCallback();
-        }
-    };
+    if(customDrawing) {
+        customDrawing->reset();
+    }
 }
 
 void BaseMenuRenderer::countdownToDefaulting() {
@@ -137,7 +130,7 @@ void BaseMenuRenderer::countdownToDefaulting() {
 }
 
 void BaseMenuRenderer::takeOverDisplay(RendererCallbackFn displayFn) {
-    if(displayFn == nullptr && isCustomDrawing == false) return;
+    if(displayFn == nullptr && customDrawing != nullptr) return;
 	// when we set this, we are stopping tcMenu rendering and letting this take over
 	renderFnPressType = RPRESS_NONE;
     displayTakenMode = displayFn ? TAKEN_OVER_FN : START_CUSTOM_DRAW;

src/BaseRenderers.h

@@ -99,6 +99,19 @@ class CustomDrawing {
  */
 typedef void (*ResetCallbackFn)();
 
+/**
+ * This class provides the reset callback in a functional way without the need for custom drawing class.
+ * It simply calls the provided reset function on reset.
+ */
+class ResetCallbackFunctionCustomDraw : public CustomDrawing {
+    ResetCallbackFn resetFn;
+public:
+    ResetCallbackFunctionCustomDraw(ResetCallbackFn fn): resetFn(fn) {}
+    void started(BaseMenuRenderer *currentRenderer) override { }
+    void reset() override {resetFn();}
+    void renderLoop(unsigned int currentValue, RenderPressMode userClick) override {}
+};
+
 /**
  * Title widgets allow for drawing small graphics in the title area, for example connectivity status
  * of the wifi network, if a remote connection to the menu is active. They are in a linked list so
@@ -276,11 +289,7 @@ class BaseMenuRenderer : public MenuRenderer, Executable {
     uint16_t resetValInTicks;
 	MenuRedrawState redrawMode;
 	TitleWidget* firstWidget;
-	union {
-        ResetCallbackFn resetCallback;
-        CustomDrawing *customDrawing;
-    };
-    bool isCustomDrawing;
+    CustomDrawing *customDrawing;
 	DisplayTakeoverMode displayTakenMode;
     BaseDialog* dialog;
 
@@ -342,8 +351,7 @@ class BaseMenuRenderer : public MenuRenderer, Executable {
      * and that will be notified of both reset events and take over display events.
      */
     void setResetCallback(ResetCallbackFn resetFn) {
-        isCustomDrawing = false;
-        resetCallback = resetFn;
+        customDrawing = new ResetCallbackFunctionCustomDraw(resetFn);
     }
 
     /**
@@ -353,10 +361,16 @@ class BaseMenuRenderer : public MenuRenderer, Executable {
      * display is first taken over, followed by renderLoop until it's given back.
      */
     void setCustomDrawingHandler(CustomDrawing* customDrawingParam) {
-        isCustomDrawing= true;
         customDrawing = customDrawingParam;
     }
 
+    /**
+     * @return the current custom drawing set on this renderer, it could be nullptr if never set.
+     */
+    CustomDrawing* getCurrentCustomDrawing() {
+        return customDrawing;
+    }
+
     /**
      * Called by taskManager when we are scheduled
      */

src/MenuItems.cpp

@@ -6,6 +6,7 @@
 #include "tcMenu.h"
 #include "MenuItems.h"
 #include "RuntimeMenuItem.h"
+#include "lang/language_select.h"
 #include "graphics/RuntimeTitleMenuItem.h"
 
 MenuItem::MenuItem(MenuType menuType, const AnyMenuInfo* menuInfo, MenuItem* next, bool infoProgmem) {
@@ -297,12 +298,12 @@ void ValueMenuItem::setCurrentValue(uint16_t val, bool silent) {
 	changeOccurred(silent);
 }
 
-const char ON_STR[] PGM_TCM   = "ON";
-const char OFF_STR[] PGM_TCM  = "OFF";
-const char YES_STR[] PGM_TCM  = "YES";
-const char NO_STR[] PGM_TCM   = "NO";
-const char TRUE_STR[] PGM_TCM = "TRUE";
-const char FALSE_STR[] PGM_TCM= "FALSE";
+const char ON_STR[] PGM_TCM   = TXT_BOOL_ON_TEXT;
+const char OFF_STR[] PGM_TCM  = TXT_BOOL_OFF_TEXT;
+const char YES_STR[] PGM_TCM  = TXT_BOOL_YES_TEXT;
+const char NO_STR[] PGM_TCM   = TXT_BOOL_NO_TEXT;
+const char TRUE_STR[] PGM_TCM = TXT_BOOL_TRUE_TEXT;
+const char FALSE_STR[] PGM_TCM= TXT_BOOL_FALSE_TEXT;
 
 void copyMenuItemNameAndValue(const MenuItem* item, char* buffer, size_t bufferSize, char additionalSep) {
     item->copyNameToBuffer(buffer, bufferSize);

src/RemoteConnector.cpp

@@ -8,6 +8,7 @@
 
 #include <PlatformDetermination.h>
 #include "tcMenuVersion.h"
+#include "lang/language_select.h"
 #ifdef IOA_USE_MBED
 #include "tcUtil.h"
 #endif
@@ -101,8 +102,7 @@ void TagValueRemoteConnector::provideAuthentication(const char* auth) {
     }
 }
 
-const char headerPairingText[] PROGMEM = "Pairing waiting";
-const char headerPairingDone[] PROGMEM = "Pairing complete";
+const char headerPairingText[] PROGMEM = TXT_PAIRING_TEXT;
 const char* lastUuid;
 
 void onPairingFinished(ButtonType ty, void* voidConnector) {

src/RemoteMenuItem.cpp

@@ -9,8 +9,12 @@
 #include "RemoteConnector.h"
 #include "tcUtil.h"
 #include "BaseDialog.h"
+#include "lang/language_select.h"
 
-const char REMOVE_CONN_HDR_PGM[] PROGMEM = "Close Connection";
+const char REMOVE_CONN_HDR_PGM[] PROGMEM = TXT_CLOSE_CONNECTION;
+const char AUTH_REMOVE_KEY[] PROGMEM = TXT_AUTH_REMOVE;
+const char AUTH_REMOVE_ALL_KEYS[] PROGMEM = TXT_AUTH_REMOVE_ALL_KEYS;
+const char AUTH_EMPTY_KEY[] PROGMEM = TXT_AUTH_EMPTY_KEY;
 
 // called when the close connection dialog completes.
 void onRemoteInfoDialogComplete(ButtonType btn, void* data) {
@@ -112,10 +116,6 @@ EepromAuthenticatorManager *EepromAuthenticationInfoMenuItem::getAuthManager() {
     return nullptr;
 }
 
-const char AUTH_REMOVE_KEY[] PROGMEM = "Remove";
-const char AUTH_REMOVE_ALL_KEYS[] PROGMEM = "Remove ALL keys?";
-const char AUTH_EMPTY_KEY[] PROGMEM = "EmptyKey";
-
 void onAuthenticateRemoveKeysDlgComplete(ButtonType btn, void* data) {
     if (btn == BTNTYPE_OK) {
         auto* mgr = reinterpret_cast<EepromAuthenticatorManager*>(menuMgr.getAuthenticator());

src/SecuredMenuPopup.cpp

@@ -6,10 +6,11 @@
 #include "SecuredMenuPopup.h"
 #include "tcMenu.h"
 #include "BaseDialog.h"
+#include "lang/language_select.h"
 
-const char pgmProceedText[] PROGMEM = "Proceed";
-const char pgmCancelText[] PROGMEM = "Cancel";
-const char pgmHeaderNotAuth[] PROGMEM = "Pin incorrect";
+const char pgmProceedText[] PROGMEM = TXT_SECURE_MENU_PROCEED;
+const char pgmCancelText[] PROGMEM = TXT_SECURE_MENU_CANCEL;
+const char pgmHeaderNotAuth[] PROGMEM = TXT_SECURE_PIN_WRONG;
 
 RENDERING_CALLBACK_NAME_INVOKE(fnpopupPasswordRtCall, textItemRenderFn, "Password", -1, NULL)
 RENDERING_CALLBACK_NAME_INVOKE(fnpopupSubmenuSecured, backSubItemRenderFn, "Enter PIN", -1, NULL)

src/extras/DrawableTouchCalibrator.cpp

@@ -5,15 +5,17 @@
 
 #include "DrawableTouchCalibrator.h"
 #include <BaseDialog.h>
+#include "../lang/language_select.h"
 
 using namespace tcextras;
 using namespace tcgfx;
+using namespace iotouch;
 
 #define TOUCH_BLACK RGB(0,0,0)
 #define TOUCH_ORANGE RGB(255, 69, 0)
 #define TOUCH_YELLOW RGB(255, 255, 0)
 
-void TouchScreenCalibrator::started(BaseMenuRenderer *currentRenderer) {
+void IoaTouchScreenCalibrator::started(BaseMenuRenderer *currentRenderer) {
     if (currentRenderer->getRendererType() != RENDER_TYPE_CONFIGURABLE) {
         giveItBack();
     }
@@ -22,48 +24,118 @@ void TouchScreenCalibrator::started(BaseMenuRenderer *currentRenderer) {
     drawable->setDrawColor(TOUCH_BLACK);
     drawable->drawBox(Coord(0, 0), drawable->getDisplayDimensions(), true);
     drawable->endDraw();
-    takeOverCount = 0;
 }
 
-void TouchScreenCalibrator::renderLoop(unsigned int currentValue, RenderPressMode userClick) {
+void IoaTouchScreenCalibrator::renderLoop(unsigned int currentValue, RenderPressMode userClick) {
 
-    // If the dialog is in use then we leave this loop immediately to give it priority.
-    // As of 2.1 onwards this behaviour is up to you, you can choose to have higher priority than dialogs.
-    if (renderer->getDialog() != nullptr && renderer->getDialog()->isInUse()) {
-        giveItBack();
-        return;
-    }
+    iotouch::TouchState touchState = touchScreen->getLastTouchState();
+    if(touchState != iotouch::TOUCHED && touchState != iotouch::HELD) return;
 
     drawable->startDraw();
     drawable->setDrawColor(TOUCH_BLACK);
     drawable->drawCircle(Coord(oldX, oldY), 10, true);
 
-    drawable->drawBox(Coord(0, 0), Coord(drawable->getDisplayDimensions().x, 45), true);
+    Coord dims = drawable->getDisplayDimensions();
+    drawable->drawBox(Coord(0, 50), Coord(dims.x, 45), true);
     drawable->setColors(TOUCH_ORANGE, TOUCH_BLACK);
-    drawable->drawText(Coord(0, 2), nullptr, 0, "Calibrate screen");
-
     char sz[40];
+    strncpy_P(sz, TXT_TOUCH_CONFIGURE, sizeof(sz));
+    auto titleConfig = renderer->getGraphicsPropertiesFactory().configFor(nullptr, tcgfx::ItemDisplayProperties::COMPTYPE_TITLE);
+    drawable->drawText(Coord(0, 45), titleConfig->getFont(), titleConfig->getFontMagnification(), sz);
+
     strcpy(sz, "x: ");
     fastftoa(sz, touchScreen->getLastX(), 3, sizeof sz);
     strcat(sz, ", y: ");
     fastftoa(sz, touchScreen->getLastY(), 3, sizeof sz);
     strcat(sz, ", z: ");
-    fastltoa(sz, touchScreen->getLastTouchState(), 1, NOT_PADDED, sizeof sz);
+    fastltoa(sz, touchState, 1, NOT_PADDED, sizeof sz);
+
+    int buttonSize = 40;
+    int16_t rightCorner = dims.x - buttonSize;
+
+    drawable->setDrawColor(TOUCH_YELLOW);
+    drawable->drawBox(Coord(0, 0), Coord(buttonSize, buttonSize), true);
+    drawable->drawBox(Coord(dims.x - buttonSize, 0), Coord(buttonSize, buttonSize), true);
+    drawable->drawBox(Coord(dims.x - buttonSize, rightCorner), Coord(buttonSize, buttonSize), true);
+    drawable->setDrawColor(TOUCH_ORANGE);
+    drawable->drawBox(Coord(0, rightCorner), Coord(buttonSize, buttonSize), true);
+    drawable->drawText(Coord(0, dims.y - 5), titleConfig->getFont(), titleConfig->getFontMagnification(), "[X]");
 
     drawable->setColors(TOUCH_YELLOW, TOUCH_BLACK);
     drawable->drawText(Coord(0, 22), nullptr, 0, sz);
 
-    oldX = int(touchScreen->getLastX() * (float) drawable->getDisplayDimensions().x);
-    oldY = int(touchScreen->getLastY() * (float) drawable->getDisplayDimensions().y);
+    oldX = int(touchScreen->getLastX() * (float) dims.x);
+    oldY = int(touchScreen->getLastY() * (float) dims.y);
     drawable->setDrawColor(TOUCH_YELLOW);
     drawable->drawCircle(Coord(oldX, oldY), 10, true);
+    drawable->endDraw();
 
-    if (oldX < 40 && oldY < 40 && touchScreen->getLastTouchState() == iotouch::HELD) {
-        giveItBack();
+    if(oldY < buttonSize) {
+        // top
+        if(oldX < buttonSize) {
+            calibrationHandler.setCalibrationValues(touchScreen->getLastX(), calibrationHandler.getMaxX(),
+                                           touchScreen->getLastY(), calibrationHandler.getMaxY());
+        } else if(oldX > rightCorner) {
+            calibrationHandler.setCalibrationValues(calibrationHandler.getMinX(), touchScreen->getLastX(),
+                                           touchScreen->getLastY(), calibrationHandler.getMaxY());
+        }
+
+    } else if(oldY > (dims.y - buttonSize)) {
+        // bottom
+        if(oldX < buttonSize) {
+            // bottom left - exit
+            saveCalibration();
+            giveItBack();
+        }
+        else if(oldX > rightCorner) {
+            calibrationHandler.setCalibrationValues(calibrationHandler.getMinX(), touchScreen->getLastX(),
+                                           calibrationHandler.getMinY(), touchScreen->getLastY());
+        }
     }
+    
 }
 
-void TouchScreenCalibrator::giveItBack() {
+void IoaTouchScreenCalibrator::giveItBack() {
     renderer->giveBackDisplay();
-    if(calibrationCompletedHandler) calibrationCompletedHandler();
+    renderer->setCustomDrawingHandler(lastDrawing);
+    lastDrawing = nullptr;
+    if(screenPrep != nullptr) screenPrep(true);
+}
+
+void IoaTouchScreenCalibrator::reCalibrateNow() {
+    if(screenPrep != nullptr) screenPrep(true);
+    lastDrawing = renderer->getCurrentCustomDrawing();
+    renderer->setCustomDrawingHandler(this);
+    renderer->takeOverDisplay();
+}
+
+float fltFromU32(uint32_t val) {
+    return float(val) / 100000.0F;
+}
+
+uint32_t fltToU32(float val) {
+    return uint32_t(val * 100000.0F);
+}
+
+void IoaTouchScreenCalibrator::saveCalibration() {
+    serlogF2(SER_TCMENU_INFO, "Saving IOA touch calibration at ", romPos);
+    EepromAbstraction *rom = menuMgr.getEepromAbstraction();
+    rom->write16(romPos, calibrationMagicIoa);
+    rom->write32(romPos + 2, fltToU32(calibrationHandler.getMinX()));
+    rom->write32(romPos + 6, fltToU32(calibrationHandler.getMaxX()));
+    rom->write32(romPos + 10, fltToU32(calibrationHandler.getMinY()));
+    rom->write32(romPos + 14, fltToU32(calibrationHandler.getMaxY()));
+    serlogF2(SER_TCMENU_INFO, "Saved touch data ", rom->hasErrorOccurred());
+}
+
+bool IoaTouchScreenCalibrator::loadCalibration() {
+    serlogF2(SER_TCMENU_INFO, "Loading IOA touch calibration at ", romPos);
+    EepromAbstraction *rom = menuMgr.getEepromAbstraction();
+    if(rom->read16(romPos) != calibrationMagicIoa) return false;
+    calibrationHandler.setCalibrationValues(
+            fltFromU32(rom->read32(romPos + 2)), fltFromU32(rom->read32(romPos + 6)),
+            fltFromU32(rom->read32(romPos + 10)), fltFromU32(rom->read32(romPos + 14)));
+    if(rom->hasErrorOccurred()) return false;
+
+    serlogF(SER_TCMENU_INFO, "Loaded calibration OK");
 }