#215 ability to set heartbeat frequency at runtime

Author: davetcc

examples/esp/esp32Amplifier/esp32Amplifier.ino

@@ -62,8 +62,16 @@ void setup() {
         menuVolume.setCurrentValue(20, true);
         menuDirect.setBoolean(true, true);
     });
+
     prepareWifiForUse();
 
+    // option 1 globally set HB timeouts.
+    remoteServer.setHeartbeatIntervalAll(30000);
+
+    // option 2 selectively set HB timeouts.
+    //auto tvRemote = remoteServer.getRemoteConnector(0);
+    //if(tvRemote != nullptr) tvRemote->setHeartbeatTimeout(30000);
+
     controller.initialise();
 
 #if MENU_USING_CALIBRATION_MGR == true
@@ -101,19 +109,19 @@ void setup() {
     // use a 4BPP (16 color) icon bitmap by providing both the data and the palette.
     themeBuilder.menuItemOverride(menuSettings)
         .withImage4bpp(Coord(31, 40), statusBitmap_palette0, statusBitmap0)
-        .onRow(3).multiCol(1, 3)
+        .onRowCol(3, 1, 3)
         .apply();
 
     // Again we take a menu item override for the status submenu item, and this time it will render a single color bitmap
     themeBuilder.menuItemOverride(menuStatus)
         .withImageXbmp(iconSize, statusIcon40Bits)
-        .onRow(3).multiCol(2, 3)
+        .onRowCol(3, 2, 3)
         .apply();
 
     // Again we take a menu item override for the mute boolean menu, and this time it will render a single color bitmap
     themeBuilder.menuItemOverride(menuMute)
         .withImageXbmp(iconSize, muteOffIcon40Bits, muteOnIcon40Bits)
-        .onRow(3).multiCol(3, 3)
+        .onRowCol(3, 3, 3)
         .apply();
 
     /**
@@ -158,13 +166,13 @@ void prepareWifiForUse() {
     if(strlen(menuConnectivitySSID.getTextValue())==0) {
         // no SSID come up as an access point
         WiFi.mode(WIFI_AP);
-        WiFi.softAP("tcmenu", "secret");
+        WiFi.softAP("tcmenu", "secret1234");
         serdebugF("Started up in AP mode, connect with 'tcmenu' and 'secret'");
     }
     else {
-        WiFi.begin(menuConnectivitySSID.getTextValue(), menuConnectivityPasscode.getTextValue());
         WiFi.mode(WIFI_STA);
-        serdebugF("Connecting to Wifi using settings from connectivity menu");
+        WiFi.begin(menuConnectivitySSID.getTextValue(), menuConnectivityPasscode.getTextValue());
+        serdebugF2("Connecting to Wifi using settings for ", menuConnectivitySSID.getTextValue());
     }
 
     // now monitor the wifi level every few seconds and report it in a widget.

examples/esp/esp32Amplifier/esp32Amplifier_menu.cpp

@@ -24,7 +24,7 @@ iotouch::ResistiveTouchInterrogator touchInterrogator(2, 33, 32, 0);
 iotouch::TouchOrientationSettings touchOrientation(true, false, true);
 MenuTouchScreenManager touchScreen(&touchInterrogator, &renderer, touchOrientation);
 tcextras::IoaTouchScreenCalibrator touchCalibrator(&touchScreen, &renderer, 400);
-ClientEthernetInitialisation ethernetInitialisation("192.168.0.99", 3333);
+ClientEthernetInitialisation ethernetInitialisation("192.168.0.37", 3333);
 ClientEthernetTagValTransport ethernetTransport;
 TagValueRemoteServerConnection ethernetConnection(ethernetTransport, ethernetInitialisation);
 

examples/esp/esp32Amplifier/esp32Amplifier_menu.h

@@ -38,6 +38,11 @@ extern tcextras::IoaTouchScreenCalibrator touchCalibrator;
 extern WiFiServer server;
 extern ClientEthernetInitialisation ethernetInitialisation;
 
+
+extern EepromAuthenticatorManager authManager;
+
+
+
 // Any externals needed by IO expanders, EEPROMs etc
 
 

src/RemoteConnector.cpp

@@ -50,6 +50,7 @@ TagValueRemoteConnector::TagValueRemoteConnector(uint8_t remoteNo) :
 	this->flags = 0;
     this->commsCallback = nullptr;
     this->authManager = nullptr;
+    this->hbTimeoutTicks = HEARTBEAT_INTERVAL;
 }
 
 void TagValueRemoteConnector::initialise(TagValueTransport* transport_, CombinedMessageProcessor* processor_,
@@ -223,8 +224,8 @@ void TagValueRemoteConnector::dealWithHeartbeating() {
 	++ticksLastRead;
 	++ticksLastSend;
 
-    // pairing will not send heartbeats, so we wait about 10 seconds before closing out
-    unsigned int maximumWaitTime = isPairing() ? (PAIRING_TIMEOUT_TICKS) : (HEARTBEAT_INTERVAL_TICKS * 3);
+    // when pairing the timeout is hardwired to 15 seconds, otherwise we wait a multiplier of the heartbeat frequency
+    unsigned int maximumWaitTime = isPairing() ? (PAIRING_TIMEOUT_TICKS) : (hbTimeoutTicks > 10000) ? hbTimeoutTicks * 2U : hbTimeoutTicks * 3U;
 
 	if(ticksLastRead > maximumWaitTime && isConnected()) {
         serlogF3(SER_NETWORK_INFO, "Remote disconnected (rNo, ticks): ", remoteNo, ticksLastSend);
@@ -238,7 +239,7 @@ void TagValueRemoteConnector::dealWithHeartbeating() {
 		setConnected(true);
 	}
 
-	if(ticksLastSend > HEARTBEAT_INTERVAL_TICKS) {
+	if(ticksLastSend > hbTimeoutTicks) {
 		if(isConnectionFullyEstablished() && transport->available()) {
             serlogF3(SER_NETWORK_INFO, "Sending HB (rNo, ticks) : ", remoteNo, ticksLastSend);
             encodeHeartbeat(HBMODE_NORMAL);
@@ -383,7 +384,7 @@ void TagValueRemoteConnector::encodeBootstrap(bool isComplete) {
 
 void TagValueRemoteConnector::encodeHeartbeat(HeartbeatMode hbMode) {
 	if(!prepareWriteMsg(MSG_HEARTBEAT)) return;
-    transport->writeFieldInt(FIELD_HB_INTERVAL, HEARTBEAT_INTERVAL);
+    transport->writeFieldInt(FIELD_HB_INTERVAL, hbTimeoutTicks);
     transport->writeFieldLong(FIELD_HB_MILLISEC, millis());
     transport->writeFieldInt(FIELD_HB_MODE, hbMode);
     transport->endMsg();

src/RemoteConnector.h

@@ -25,13 +25,17 @@
 #define START_OF_MESSAGE 0x01
 #define TICK_INTERVAL 1
 
-// when debugging to reduce disconnects set the following (give 1 minute timeout): -DHEARTBEAT_INTERVAL=20000
+// This sets the DEFAULT heartbeat interval when no other interval has been set on a connection. IE if you create a
+// connection and do not call setHeartbeatInterval(millis), this is what you'll get.
 #ifndef HEARTBEAT_INTERVAL
 # define HEARTBEAT_INTERVAL 1500
 #endif
 
-#define HEARTBEAT_INTERVAL_TICKS (HEARTBEAT_INTERVAL / TICK_INTERVAL)
+// Pairing is different to a normal connection, in that we just need to provide the user with reasonable time to
+// accept the pairing request on a device, usually around 15 seconds is enough. You can redefine if needed.
+#ifndef PAIRING_TIMEOUT_TICKS
 #define PAIRING_TIMEOUT_TICKS (15000 / TICK_INTERVAL)
+#endif
 
 /**
  * @file RemoteConnector.h
@@ -185,7 +189,8 @@ class TagValueRemoteConnector {
 	const ConnectorLocalInfo* localInfoPgm;
 	uint16_t ticksLastSend;
 	uint16_t ticksLastRead;
-	CombinedMessageProcessor* processor;
+    uint16_t hbTimeoutTicks;
+    CombinedMessageProcessor* processor;
 	TagValueTransport* transport;	
     CommsCallbackFn commsCallback;
     AuthenticationManager* authManager;
@@ -480,6 +485,8 @@ class TagValueRemoteConnector {
     /** indicates if the connection is yet authenicated */
     bool isAuthenticated() { return bitRead(flags, FLAG_AUTHENTICATED); }
     AuthenticationManager* getAuthManager() { return authManager; }
+
+    void setHeartbeatTimeout(uint16_t milli) { hbTimeoutTicks = milli / TICK_INTERVAL; }
 private:
 	void encodeBaseMenuFields(int parentId, MenuItem* item);
     bool prepareWriteMsg(uint16_t msgType);

src/remote/BaseRemoteComponents.cpp

@@ -84,6 +84,16 @@ void TcMenuRemoteServer::exec() {
     }
 }
 
+void TcMenuRemoteServer::setHeartbeatIntervalAll(uint16_t milli) {
+    serlogF2(SER_NETWORK_INFO, "Heartbeats set globally: ", milli);
+    for (int i = 0; i < remotesAdded; i++) {
+        if(connections[i] && connections[i]->getRemoteServerType() == TAG_VAL_REMOTE_SERVER) {
+            auto tvCon = reinterpret_cast<TagValueRemoteServerConnection*>(connections[i]);
+            tvCon->connector()->setHeartbeatTimeout(milli);
+        }
+    }
+}
+
 int tcremote::fromWiFiRSSITo4StateIndicator(int strength) {
     int qualityIcon = 0;
     if(strength > -50) qualityIcon = 4;

src/remote/BaseRemoteComponents.h

@@ -180,6 +180,8 @@ namespace tcremote {
             if(num >= remotesAdded) return nullptr;
             return connections[num];
         }
+
+        void setHeartbeatIntervalAll(uint16_t milli);
     };
 
     /**