More example updates for 2.2 release

Author: dave

examples/colorTftEthernet32/ColorEtherenetCustomDraw.h

@@ -0,0 +1,53 @@
+/**
+ * This class implements CustomDrawing which means that it can be registered with the renderer
+ * to be told when the screen is about to reset (become idle basically). This callback will
+ * also be told when a takeOverDisplay call starts, and then the rendering function is called
+ * frequently, so you can update the display.
+ *
+ * Associated docs:
+ * https://www.thecoderscorner.com/products/arduino-libraries/tc-menu/renderer-take-over-display/
+ */
+
+#ifndef TCMENU_EXAMPLE_COLORETHERENETCUSTOMDRAW_H
+#define TCMENU_EXAMPLE_COLORETHERENETCUSTOMDRAW_H
+
+#include <BaseRenderers.h>
+#include "colorTftEthernet32_menu.h"
+
+class ColorEthernetCustomDraw : public CustomDrawing {
+public:
+    void reset() override {
+        // When the display becomes idle, we take over the display, the no-arg version is
+        // used to indicate you want the custom draw class to do the rendering.
+        renderer.takeOverDisplay();
+    }
+
+    void started(BaseMenuRenderer *currentRenderer) override {
+        // you need to handle the clearing and preparation of the display when first called.
+        switches.getEncoder()->changePrecision(1000, 500);
+        gfx.setCursor(0, 0);
+        gfx.fillRect(0, 0, gfx.width(), gfx.height(), BLACK);
+        gfx.setFont(nullptr);
+        gfx.setTextSize(2);
+        gfx.print("Encoder ");
+    }
+
+
+    void renderLoop(unsigned int currentValue, RenderPressMode pressType) override {
+        // if the encoder / select button is held, we go back to the menu.
+        if(pressType == RPRESS_HELD) {
+            renderer.giveBackDisplay();
+            return;
+        }
+
+        GFXcanvas1 canvas(100, 20);
+        canvas.fillScreen(BLACK);
+        canvas.setCursor(0,0);
+        canvas.print(currentValue);
+        canvas.setTextSize(2);
+        gfx.drawBitmap(0, 35, canvas.getBuffer(), 100, 20, WHITE, BLACK);
+
+    }
+};
+
+#endif //TCMENU_EXAMPLE_COLORETHERENETCUSTOMDRAW_H

examples/colorTftEthernet32/EthernetTransport.cpp

@@ -33,7 +33,8 @@ void EthernetTagValTransport::flush() {
         client.flush();
     }
     else {
-        client.stop();
+        writeBufferPos = 0;
+        close();
     }
 }
 

examples/colorTftEthernet32/ThemeCoolBlueTraditional.h

@@ -7,8 +7,8 @@
 
 // tcMenu drawing properties take a 4 color palette for items, titles and actions.
 // this renderer shares the color configuration for items and actions.
-color_t coolBlueTitlePalette[] = {RGB(0,0,0), RGB(20,132,255), RGB(192,192,192), RGB(0,133,255)};
-color_t coolBlueItemPalette[] = {RGB(255, 255, 255), RGB(0,64,135), RGB(20,133,255), RGB(31,100,178)};
+const color_t coolBlueTitlePalette[] = {RGB(0,0,0), RGB(20,132,255), RGB(192,192,192), RGB(64, 64, 64)};
+const color_t coolBlueItemPalette[] = {RGB(255, 255, 255), RGB(0,64,135), RGB(20,133,255), RGB(31,100,178)};
 
 void installCoolBlueTraditionalTheme(GraphicsDeviceRenderer& bgr, const MenuFontDef& itemFont, const MenuFontDef& titleFont, bool needEditingIcons) {
     // first we keep a reference to the screen size, and set the dimensions on the renderer.
@@ -25,7 +25,7 @@ void installCoolBlueTraditionalTheme(GraphicsDeviceRenderer& bgr, const MenuFont
     // here we calculate the item padding and row heights based on the resolution of the display
     bool medResOrBetter = width > 160;
     MenuPadding titlePadding(medResOrBetter ? 4 : 2);
-    MenuPadding itemPadding(2);
+    MenuPadding itemPadding(medResOrBetter ? 2 : 1);
     int titleHeight = bgr.heightForFontPadding(titleFont.fontData, titleFont.fontMag, titlePadding);
     int itemHeight = bgr.heightForFontPadding(itemFont.fontData, itemFont.fontMag, itemPadding);
 

examples/colorTftEthernet32/colorTftEthernet.emf

@@ -505,7 +505,7 @@
       },
       {
         "name": "TITLE_FONT",
-        "latestValue": "def:,1",
+        "latestValue": "ada:FreeSansBold9pt7b,1",
         "subsystem": "THEME"
       },
       {
@@ -533,6 +533,10 @@
     "saveToSrc": false,
     "useCppMain": false,
     "eepromDefinition": "at24:80:PAGESIZE_AT24C128",
-    "authenticatorDefinition": "rom:100:6"
+    "authenticatorDefinition": "rom:100:6",
+    "projectIoExpanders": [
+      "deviceIO:",
+      "pcf8574:io8574:32:0"
+    ]
   }
 }

examples/colorTftEthernet32/colorTftEthernet32.ino

@@ -7,6 +7,8 @@
 #include <Ethernet.h>
 #include <SPI.h>
 #include <IoLogging.h>
+#include "ColorEtherenetCustomDraw.h"
+#include <tcMenuVersion.h>
 
 // contains the graphical widget title components.
 #include "stockIcons/wifiAndConnectionIcons16x12.h"
@@ -25,16 +27,21 @@ byte mac[] = {
   0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
 };
 
-// then we setup the IO expander that the also set up in the designer for input.
-IoAbstractionRef io8574 = ioFrom8574(0x20, 0); // on addr 0x20 and interrupt pin 0
-
 // and we create an analog device with enhanced range because we are using a 32bit board.
 ArduinoAnalogDevice analogDevice(12, 10);
 
 // We add a title widget that shows when a user is connected to the device. Connection icons
 // are in the standard icon set we included at the top.
 TitleWidget connectedWidget(iconsConnection, 2, 16, 12);
 
+// We also want to take over the display whenever the screen becomes idle, here we use the CustomDrawing
+// technique described in the documentation. See ColorEthernetCustomDraw.h
+ColorEthernetCustomDraw myCustomDraw;
+
+// Here we declare a string in const/PROGMEM for use with a dialog later. Note that this works even on ARM
+// boards that don't have separated program memory.
+const char pgmHeaderSavedItem[] PROGMEM = "Rom Item Saved";
+
 // Start 2nd Encoder
 // Here, we use a second rotary encoder to adjust one of the menu items, the button toggles a boolean item
 // Here are the fields for the second rotary encoder
@@ -49,7 +56,7 @@ const int ledPin = 1;
 // when there's a change in communication status (connection or disconnection for example) this gets called.
 // see further down in the code where we add this to the remote IoT monitor.
 void onCommsChange(CommunicationInfo info) {
-    if(info.remoteNo == 0) {
+    if(info.remoteNo == 0U) {
         connectedWidget.setCurrentState(info.connected ? 1 : 0);
     }
     // this relies on logging in IoAbstraction's ioLogging.h, to turn it on visit the file for instructions.
@@ -96,16 +103,29 @@ void setup() {
     menuIpAddress.copyValue(sz, sizeof(sz));
     Serial.print("Ethernet available on ");Serial.println(sz);
 
-    taskManager.scheduleFixedRate(2250, [] {
+    taskManager.scheduleFixedRate(250, [] {
         float a1Value = analogDevice.getCurrentFloat(A1);
-        menuVoltA1.setFloatValue(a1Value * 3.3);
+        menuVoltA1.setFloatValue(a1Value * 3.3F);
     });
 
-    // Start 2nd encoder
-    Serial.println("Setting up second encoder now");
+    // register the custom drawing handler
+    renderer.setCustomDrawingHandler(&myCustomDraw);
 
     ioDevicePinMode(switches.getIoAbstraction(), ledPin, OUTPUT);
 
+    setTitlePressedCallback([](int id) {
+        withMenuDialogIfAvailable([](MenuBasedDialog* dlg) {
+            dlg->setButtons(BTNTYPE_CLOSE, BTNTYPE_NONE);
+            dlg->showRam("ARM Example", false);
+            char menuVer[10];
+            tccore::copyTcMenuVersion(menuVer, sizeof menuVer);
+            dlg->copyIntoBuffer(menuVer);
+        });
+    });
+
+    // Start 2nd encoder
+    Serial.println("Setting up second encoder now");
+
     // here we want the encoder set to the range of values that menuCurrent takes, this is just for example,
     // and you could set the range to anything that is required. We use the callback to update the menu item.
     secondEncoder = new HardwareRotaryEncoder(encoder2APin, encoder2BPin, [](int encoderValue) {
@@ -131,8 +151,8 @@ void writeToDac() {
     float volts = menuVoltage.getAsFloatingPointValue();
     float curr = menuCurrent.getAsFloatingPointValue();
 
-    float total = (volts / 64.0) * (curr / 2.0);
-    analogDevice.setCurrentFloat(A0, (unsigned int)total);
+    float total = (volts / 64.0F) * (curr / 2.0F);
+    analogDevice.setCurrentFloat(A0, total);
     menuVoltA0.setFloatValue(total);
 }
 
@@ -153,42 +173,8 @@ void CALLBACK_FUNCTION onSaveRom(int /*id*/) {
     menuMgr.save();
 }
 
-bool starting = true;
-
-const char pgmHeaderSavedItem[] PROGMEM = "Rom Item Saved";
-
-void myRenderCallback(unsigned int encoderVal, RenderPressMode pressType) {
-    if(pressType == RPRESS_HELD)
-    {
-        // if the encoder / select button is held, we go back to the menu.
-        renderer.giveBackDisplay();
-    }
-    else if(starting)
-    {
-        // you need to handle the clearing and preparation of the display when you're first called.
-        // the easiest way is to set a flag such as this and then prepare the display.
-        starting = false;
-        switches.getEncoder()->changePrecision(1000, 500);
-        gfx.setCursor(0, 0);
-        gfx.fillRect(0, 0, gfx.width(), gfx.height(), BLACK);
-        gfx.setFont(nullptr);
-        gfx.setTextSize(2);
-        gfx.print("Encoder ");
-    }
-    else
-    {
-        GFXcanvas1 canvas(100, 20);
-        canvas.fillScreen(BLACK);
-        canvas.setCursor(0,0);
-        canvas.print(encoderVal);
-        canvas.setTextSize(2);
-        gfx.drawBitmap(0, 35, canvas.getBuffer(), 100, 20, WHITE, BLACK);
-    }
-}
-
 void CALLBACK_FUNCTION onTakeDisplay(int /*id*/) {
-    starting = true;
-    renderer.takeOverDisplay(myRenderCallback);
+    renderer.takeOverDisplay();
 }
 
 void CALLBACK_FUNCTION onRgbChanged(int /*id*/) {
@@ -225,7 +211,7 @@ void CALLBACK_FUNCTION onRomLocationChange(int /*id*/) {
 int CALLBACK_FUNCTION fnRomLocationRtCall(RuntimeMenuItem * item, uint8_t row, RenderFnMode mode, char * buffer, int bufferSize) {
    switch(mode) {
     case RENDERFN_INVOKE:
-        onRomLocationChange(item->getId());
+        onRomLocationChange(int(item->getId()));
         return true;
     case RENDERFN_NAME:
         // TODO - each row has it's own name - 0xff is the parent item

examples/colorTftEthernet32/colorTftEthernet32.ino.backup

@@ -7,6 +7,7 @@
 #include <Ethernet.h>
 #include <SPI.h>
 #include <IoLogging.h>
+#include "ColorEtherenetCustomDraw.h"
 
 // contains the graphical widget title components.
 #include "stockIcons/wifiAndConnectionIcons16x12.h"
@@ -25,16 +26,21 @@ byte mac[] = {
   0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
 };
 
-// then we setup the IO expander that the also set up in the designer for input.
-IoAbstractionRef io8574 = ioFrom8574(0x20, 0); // on addr 0x20 and interrupt pin 0
-
 // and we create an analog device with enhanced range because we are using a 32bit board.
 ArduinoAnalogDevice analogDevice(12, 10);
 
 // We add a title widget that shows when a user is connected to the device. Connection icons
 // are in the standard icon set we included at the top.
 TitleWidget connectedWidget(iconsConnection, 2, 16, 12);
 
+// We also want to take over the display whenever the screen becomes idle, here we use the CustomDrawing
+// technique described in the documentation. See ColorEthernetCustomDraw.h
+ColorEthernetCustomDraw myCustomDraw;
+
+// Here we declare a string in const/PROGMEM for use with a dialog later. Note that this works even on ARM
+// boards that don't have separated program memory.
+const char pgmHeaderSavedItem[] PROGMEM = "Rom Item Saved";
+
 // Start 2nd Encoder
 // Here, we use a second rotary encoder to adjust one of the menu items, the button toggles a boolean item
 // Here are the fields for the second rotary encoder
@@ -101,6 +107,9 @@ void setup() {
         menuVoltA1.setFloatValue(a1Value * 3.3);
     });
 
+    // register the custom drawing handler
+    renderer.setCustomDrawingHandler(&myCustomDraw);
+
     // Start 2nd encoder
     Serial.println("Setting up second encoder now");
 
@@ -131,8 +140,8 @@ void writeToDac() {
     float volts = menuVoltage.getAsFloatingPointValue();
     float curr = menuCurrent.getAsFloatingPointValue();
 
-    float total = (volts / 64.0) * (curr / 2.0);
-    analogDevice.setCurrentFloat(A0, (unsigned int)total);
+    float total = (volts / 64.0F) * (curr / 2.0F);
+    analogDevice.setCurrentFloat(A0, total);
     menuVoltA0.setFloatValue(total);
 }
 
@@ -153,42 +162,8 @@ void CALLBACK_FUNCTION onSaveRom(int /*id*/) {
     menuMgr.save();
 }
 
-bool starting = true;
-
-const char pgmHeaderSavedItem[] PROGMEM = "Rom Item Saved";
-
-void myRenderCallback(unsigned int encoderVal, RenderPressMode pressType) {
-    if(pressType == RPRESS_HELD)
-    {
-        // if the encoder / select button is held, we go back to the menu.
-        renderer.giveBackDisplay();
-    }
-    else if(starting)
-    {
-        // you need to handle the clearing and preparation of the display when you're first called.
-        // the easiest way is to set a flag such as this and then prepare the display.
-        starting = false;
-        switches.getEncoder()->changePrecision(1000, 500);
-        gfx.setCursor(0, 0);
-        gfx.fillRect(0, 0, gfx.width(), gfx.height(), BLACK);
-        gfx.setFont(nullptr);
-        gfx.setTextSize(2);
-        gfx.print("Encoder ");
-    }
-    else
-    {
-        GFXcanvas1 canvas(100, 20);
-        canvas.fillScreen(BLACK);
-        canvas.setCursor(0,0);
-        canvas.print(encoderVal);
-        canvas.setTextSize(2);
-        gfx.drawBitmap(0, 35, canvas.getBuffer(), 100, 20, WHITE, BLACK);
-    }
-}
-
 void CALLBACK_FUNCTION onTakeDisplay(int /*id*/) {
-    starting = true;
-    renderer.takeOverDisplay(myRenderCallback);
+    renderer.takeOverDisplay();
 }
 
 void CALLBACK_FUNCTION onRgbChanged(int /*id*/) {
@@ -200,7 +175,7 @@ void CALLBACK_FUNCTION onSaveItem(int /*id*/) {
     auto itemNo = menuRomLocation.getCurrentValue();
     auto itemSize = menuRomChoice.getItemWidth();
     auto position = menuRomChoice.getEepromStart() + (itemNo * itemSize);
-    eeprom.writeArrayToRom(position, (const uint8_t*)menuRomText.getTextValue(), 10);
+    menuMgr.getEepromAbstraction()->writeArrayToRom(position, (const uint8_t*)menuRomText.getTextValue(), 10);
 
     if(renderer.getDialog()->isInUse()) return;
     renderer.getDialog()->setButtons(BTNTYPE_NONE, BTNTYPE_OK);
@@ -212,7 +187,7 @@ void CALLBACK_FUNCTION onRomLocationChange(int /*id*/) {
     auto itemNo = menuRomLocation.getCurrentValue();
     char sz[12];
     auto itemSize = menuRomChoice.getItemWidth();
-    eeprom.readIntoMemArray((uint8_t*)sz, menuRomChoice.getEepromStart() + (itemNo * itemSize), 10);
+    menuMgr.getEepromAbstraction()->readIntoMemArray((uint8_t*)sz, menuRomChoice.getEepromStart() + (itemNo * itemSize), 10);
     menuRomText.setTextValue(sz);
     serdebugF2("Rom data was ", sz)
 }
@@ -225,7 +200,7 @@ void CALLBACK_FUNCTION onRomLocationChange(int /*id*/) {
 int CALLBACK_FUNCTION fnRomLocationRtCall(RuntimeMenuItem * item, uint8_t row, RenderFnMode mode, char * buffer, int bufferSize) {
    switch(mode) {
     case RENDERFN_INVOKE:
-        onRomLocationChange(item->getId());
+        onRomLocationChange(int(item->getId()));
         return true;
     case RENDERFN_NAME:
         // TODO - each row has it's own name - 0xff is the parent item

examples/colorTftEthernet32/colorTftEthernet32_menu.cpp

@@ -11,10 +11,12 @@
 #include <tcMenu.h>
 #include "colorTftEthernet32_menu.h"
 #include "ThemeCoolBlueTraditional.h"
+#include <Fonts/FreeSansBold9pt7b.h>
 
 // Global variable declarations
 const  ConnectorLocalInfo applicationInfo = { "Ada32 Ethernet", "22813e5e-88b1-42d5-9601-4831b2be369b" };
 TcMenuRemoteServer remoteServer(applicationInfo);
+IoAbstractionRef ioexp_io8574 = ioFrom8574(0x20, 0);
 I2cAt24Eeprom glI2cRom(0x50, PAGESIZE_AT24C128);
 EepromAuthenticatorManager authManager(6);
 Adafruit_ST7735 gfx(6, 7, 3);
@@ -99,12 +101,12 @@ void setupMenu() {
     gfx.initR(INITR_BLACKTAB);
     gfx.setRotation(1);
     renderer.setUpdatesPerSecond(5);
-    switches.initialiseInterrupt(io8574, true);
+    switches.initialiseInterrupt(ioexp_io8574, true);
     menuMgr.initForEncoder(&renderer, &menuVoltage, 7, 6, 5);
     remoteServer.addConnection(&ethernetConnection);
     renderer.setTitleMode(BaseGraphicalRenderer::TITLE_ALWAYS);
     renderer.setUseSliderForAnalog(true);
-    installCoolBlueTraditionalTheme(renderer, MenuFontDef(nullptr, 1), MenuFontDef(nullptr, 1), true);
+    installCoolBlueTraditionalTheme(renderer, MenuFontDef(nullptr, 1), MenuFontDef(&FreeSansBold9pt7b, 1), true);
 
     // We have an IoT monitor, register the server
     menuIoTMonitor.setRemoteServer(remoteServer);